Code

collectd.conf(5): Add markup to the NetApp plugin documentation.
[collectd.git] / src / collectd.conf.pod
1 =head1 NAME
3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
5 =head1 SYNOPSIS
7   BaseDir "/path/to/data/"
8   PIDFile "/path/to/pidfile/collectd.pid"
9   Server  "123.123.123.123" 12345
11   LoadPlugin cpu
12   LoadPlugin load
13   LoadPlugin ping
15   <Plugin ping>
16     Host "example.org"
17     Host "provider.net"
18   </Plugin>
20 =head1 DESCRIPTION
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
25 behavior.
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.
45 =head1 GLOBAL OPTIONS
47 =over 4
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.
137 =back
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
150 well.
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:
159   ExtendedStatus on
160   <IfModule mod_status.c>
161     <Location /mod_status>
162       SetHandler server-status
163     </Location>
164   </IfModule>
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:
172 =over 4
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.
207 =back
209 =head2 Plugin C<apcups>
211 =over 4
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>.
223 =back
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:
233 =over 4
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.
266 =back
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;
280  };
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.
287 Synopsis:
289  <Plugin "bind">
290    URL "http://localhost:8053/"
291    OpCodes         true
292    QTypes          true
293  
294    ServerStats     true
295    ZoneMaintStats  true
296    ResolverStats   false
297    MemoryStats     true
298  
299    <View "_default">
300      QTypes        true
301      ResolverStats true
302      CacheRRSets   true
303  
304      Zone "127.in-addr.arpa/IN"
305    </View>
306  </Plugin>
308 The bind plugin accepts the following configuration options:
310 =over 4
312 =item B<URL> I<URL>
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.
322 Default: Enabled.
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.
329 Default: Enabled.
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.
336 Default: Enabled.
338 =item B<ZoneMaintStats> I<true>|I<false>
340 Collect zone maintenance statistics, mostly information about notifications
341 (zone updates) and zone transfers.
343 Default: Enabled.
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.
353 Default: Disabled.
355 =item B<MemoryStats>
357 Collect global memory statistics.
359 Default: Enabled.
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.
372 =over 4
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>,
377 C<MX>) is collected.
379 Default: Enabled.
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).
386 Default: Enabled.
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,
393 e.E<nbsp>g. "!A".
395 Default: Enabled.
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
401 (see above).
403 You can repeat this option to collect detailed information about multiple
404 zones.
406 By default no detailed zone information is collected.
408 =back
410 =back
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.
420 =head2 Plugin C<csv>
422 =over 4
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
436 number.
438 =back
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.
449   <Plugin curl>
450     <Page "stock_quotes">
451       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
452       User "foo"
453       Password "bar"
454       <Match>
455         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
456         DSType "GaugeAverage"
457         # Note: `stock_value' is not a standard type.
458         Type "stock_value"
459         Instance "AMD"
460       </Match>
461     </Page>
462   </Plugin>
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:
470 =over 4
472 =item B<URL> I<URL>
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.
515 =back
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>).
528   <Plugin curl_json>
529     <URL "http://localhost:5984/_stats">
530       Instance "httpd"
531       <Key "httpd/requests/count">
532         Type "http_requests"
533       </Key>
535       <Key "httpd_request_methods/*/count">
536         Type "http_request_methods"
537       </Key>
539       <Key "httpd_status_codes/*/count">
540         Type "http_response_codes"
541       </Key>
542     </URL>
543   </Plugin>
545 Another CouchDB example:
546 The following example will collect the status values from each database:
548   <URL "http://localhost:5984/_all_dbs">
549     Instance "dbs"
550     <Key "*/doc_count">
551       Type "gauge"
552     </Key>
553     <Key "*/doc_del_count">
554       Type "counter"
555     </Key>
556     <Key "*/disk_size">
557       Type "bytes"
558     </Key>
559   </URL>
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:
569 =over 4
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.
602 =back
604 The following options are valid within B<Key> blocks:
606 =over 4
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
612 option is mandatory.
614 =item B<Instance> I<Instance>
616 Type-instance to use. Defaults to the current map key or current string array element value.
618 =back
620 =head2 Plugin C<dbi>
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:
632   <Plugin dbi>
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
636       MinVersion 50000
637       <Result>
638         Type "gauge"
639         InstancePrefix "out_of_stock"
640         InstancesFrom "category"
641         ValuesFrom "value"
642       </Result>
643     </Query>
644     <Database "product_information">
645       Driver "mysql"
646       DriverOption "host" "localhost"
647       DriverOption "username" "collectd"
648       DriverOption "password" "aZo6daiw"
649       DriverOption "dbname" "prod_info"
650       SelectDB "prod_info"
651       Query "out_of_stock"
652     </Database>
653   </Plugin>
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
661 top to bottom!
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.
678 Example:
680   <Query "environment">
681     Statement "select station, temperature, humidity from environment"
682     <Result>
683       Type "temperature"
684       # InstancePrefix "foo"
685       InstancesFrom "station"
686       ValuesFrom "temperature"
687     </Result>
688     <Result>
689       Type "humidity"
690       InstancesFrom "station"
691       ValuesFrom "humidity"
692     </Result>
693   </Query>
695 The following options are accepted:
697 =over 4
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
708 like this:
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
714 something.)
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:
738   MinVersion 40000
739   MaxVersion 49999
740   ...
741   MinVersion 50000
742   MaxVersion 50099
743   ...
744   MinVersion 50100
745   # No maximum
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
756 definition.
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>
760 setting below.
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
783 will be empty.
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
791 daemon.
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.
800 =back
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.
813 =over 4
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
827 to the log.
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
853 refer to them from.
855 =back
857 =head2 Plugin C<df>
859 =over 4
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).
886 =back
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
894 issued.
896 Using the following two options you can ignore some disks or configure the
897 collection only of specific disks.
899 =over 4
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:
908   Disk "sdd"
909   Disk "/hda[34]/"
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.
920 =back
922 =head2 Plugin C<dns>
924 =over 4
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.
941 =back
943 =head2 Plugin C<email>
945 =over 4
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.
969 =back
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.
977 =over 4
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
987 group ID.
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)>.
1003 =back
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
1009 forward:
1011   <Plugin "filecount">
1012     <Directory "/var/qmail/queue/mess">
1013       Instance "qmail-message"
1014     </Directory>
1015     <Directory "/var/qmail/queue/todo">
1016       Instance "qmail-todo"
1017     </Directory>
1018     <Directory "/var/lib/php5">
1019       Instance "php5-sessions"
1020       Name "sess_*"
1021     </Directory>
1022   </Plugin>
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:
1033 =over 4
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
1062 B<"12h">.
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.
1080 =back
1082 =head2 Plugin C<GenericJMX>
1084 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1085 L<collectd-java(5)>.
1087 =head2 Plugin C<gmond>
1089 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1090 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1091 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1093 Synopsis:
1095  <Plugin "gmond">
1096    MCReceiveFrom "239.2.11.71" "8649"
1097    <Metric "swap_total">
1098      Type "swap"
1099      TypeInstance "total"
1100      DataSource "value"
1101    </Metric>
1102    <Metric "swap_free">
1103      Type "swap"
1104      TypeInstance "free"
1105      DataSource "value"
1106    </Metric>
1107  </Plugin>
1109 The following metrics are built-in:
1111 =over 4
1113 =item *
1115 load_one, load_five, load_fifteen
1117 =item *
1119 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1121 =item *
1123 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1125 =item *
1127 bytes_in, bytes_out
1129 =item *
1131 pkts_in, pkts_out
1133 =back
1135 Available configuration options:
1137 =over 4
1139 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1141 Sets sets the multicast group and UDP port to which to subscribe.
1143 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1145 =item E<lt>B<Metric> I<Name>E<gt>
1147 These blocks add a new metric conversion to the internal table. I<Name>, the
1148 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1150 =over 4
1152 =item B<Type> I<Type>
1154 Type to map this metric to. Required.
1156 =item B<TypeInstance> I<Instance>
1158 Type-instance to use. Optional.
1160 =item B<DataSource> I<Name>
1162 Data source to map this metric to. If the configured type has exactly one data
1163 source, this is optional. Otherwise the option is required.
1165 =back
1167 =back
1169 =head2 Plugin C<hddtemp>
1171 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1172 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1173 default values, see below. C<hddtemp> has to be running to work correctly. If
1174 C<hddtemp> is not running timeouts may appear which may interfere with other
1175 statistics..
1177 The B<hddtemp> homepage can be found at
1178 L<http://www.guzu.net/linux/hddtemp.php>.
1180 =over 4
1182 =item B<Host> I<Hostname>
1184 Hostname to connect to. Defaults to B<127.0.0.1>.
1186 =item B<Port> I<Port>
1188 TCP-Port to connect to. Defaults to B<7634>.
1190 =item B<TranslateDevicename> I<true>|I<false>
1192 If enabled, translate the disk names to major/minor device numbers
1193 (e.E<nbsp>g. "8-0" for /dev/sda). For backwards compatibility this defaults to
1194 I<true> but it's recommended to disable it as it will probably be removed in
1195 the next major version.
1197 =back
1199 =head2 Plugin C<interface>
1201 =over 4
1203 =item B<Interface> I<Interface>
1205 Select this interface. By default these interfaces will then be collected. For
1206 a more detailed description see B<IgnoreSelected> below.
1208 =item B<IgnoreSelected> I<true>|I<false>
1210 If no configuration if given, the B<traffic>-plugin will collect data from
1211 all interfaces. This may not be practical, especially for loopback- and
1212 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1213 interfaces you're interested in. Sometimes, however, it's easier/preferred
1214 to collect all interfaces I<except> a few ones. This option enables you to
1215 do that: By setting B<IgnoreSelected> to I<true> the effect of
1216 B<Interface> is inverted: All selected interfaces are ignored and all
1217 other interfaces are collected.
1219 =back
1221 =head2 Plugin C<ipmi>
1223 =over 4
1225 =item B<Sensor> I<Sensor>
1227 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1229 =item B<IgnoreSelected> I<true>|I<false>
1231 If no configuration if given, the B<ipmi> plugin will collect data from all
1232 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1233 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1234 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1235 all other sensors are collected.
1237 =item B<NotifySensorAdd> I<true>|I<false>
1239 If a sensor appears after initialization time of a minute a notification
1240 is sent.
1242 =item B<NotifySensorRemove> I<true>|I<false>
1244 If a sensor disappears a notification is sent.
1246 =item B<NotifySensorNotPresent> I<true>|I<false>
1248 If you have for example dual power supply and one of them is (un)plugged then
1249 a notification is sent.
1251 =back
1253 =head2 Plugin C<iptables>
1255 =over 4
1257 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1259 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1260 will collect the counters of all rules which have a comment-match. The comment
1261 is then used as type-instance.
1263 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1264 the I<n>th rule will be collected. Again, the comment (or the number) will be
1265 used as the type-instance.
1267 If I<Name> is supplied, it will be used as the type-instance instead of the
1268 comment or the number.
1270 =back
1272 =head2 Plugin C<irq>
1274 =over 4
1276 =item B<Irq> I<Irq>
1278 Select this irq. By default these irqs will then be collected. For a more
1279 detailed description see B<IgnoreSelected> below.
1281 =item B<IgnoreSelected> I<true>|I<false>
1283 If no configuration if given, the B<irq>-plugin will collect data from all
1284 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1285 can use the B<Irq>-option to pick the interrupt you're interested in.
1286 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1287 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1288 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1289 and all other interrupts are collected.
1291 =back
1293 =head2 Plugin C<java>
1295 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1296 This section only discusses the syntax and semantic of the configuration
1297 options. For more in-depth information on the I<Java> plugin, please read
1298 L<collectd-java(5)>.
1300 Synopsis:
1302  <Plugin "java">
1303    JVMArg "-verbose:jni"
1304    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1305    LoadPlugin "org.collectd.java.Foobar"
1306    <Plugin "org.collectd.java.Foobar">
1307      # To be parsed by the plugin
1308    </Plugin>
1309  </Plugin>
1311 Available configuration options:
1313 =over 4
1315 =item B<JVMArg> I<Argument>
1317 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1318 exactly the way the arguments to the I<java> binary on the command line work.
1319 Execute C<javaE<nbsp>--help> for details.
1321 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1322 any other options! When another option is found, the JVM will be started and
1323 later options will have to be ignored!
1325 =item B<LoadPlugin> I<JavaClass>
1327 Instantiates a new I<JavaClass> object. The constructor of this object very
1328 likely then registers one or more callback methods with the server.
1330 See L<collectd-java(5)> for details.
1332 When the first such option is found, the virtual machine (JVM) is created. This
1333 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1334 B<LoadPlugin> options!
1336 =item B<Plugin> I<Name>
1338 The entire block is passed to the Java plugin as an
1339 I<org.collectd.api.OConfigItem> object.
1341 For this to work, the plugin has to register a configuration callback first,
1342 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1343 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1344 depends on the (Java) plugin registering the callback and is completely
1345 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1347 =back
1349 =head2 Plugin C<libvirt>
1351 This plugin allows CPU, disk and network load to be collected for virtualized
1352 guests on the machine. This means that these characteristics can be collected
1353 for guest systems without installing any software on them - collectd only runs
1354 on the hosting system. The statistics are collected through libvirt
1355 (L<http://libvirt.org/>).
1357 Only I<Connection> is required.
1359 =over 4
1361 =item B<Connection> I<uri>
1363 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1365  Connection "xen:///"
1367 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1369 =item B<RefreshInterval> I<seconds>
1371 Refresh the list of domains and devices every I<seconds>. The default is 60
1372 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1373 the list of domains and devices to be refreshed on every iteration.
1375 Refreshing the devices in particular is quite a costly operation, so if your
1376 virtualization setup is static you might consider increasing this. If this
1377 option is set to 0, refreshing is disabled completely.
1379 =item B<Domain> I<name>
1381 =item B<BlockDevice> I<name:dev>
1383 =item B<InterfaceDevice> I<name:dev>
1385 =item B<IgnoreSelected> I<true>|I<false>
1387 Select which domains and devices are collected.
1389 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1390 disk/network devices are collected.
1392 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1393 domains and disk/network devices are ignored, while the rest are collected.
1395 The domain name and device names may use a regular expression, if the name is
1396 surrounded by I</.../> and collectd was compiled with support for regexps.
1398 The default is to collect statistics for all domains and all their devices.
1400 Example:
1402  BlockDevice "/:hdb/"
1403  IgnoreSelected "true"
1405 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1406 will be collected.
1408 =item B<HostnameFormat> B<name|uuid|hostname|...>
1410 When the libvirt plugin logs data, it sets the hostname of the collected data
1411 according to this setting. The default is to use the guest name as provided by
1412 the hypervisor, which is equal to setting B<name>.
1414 B<uuid> means use the guest's UUID. This is useful if you want to track the
1415 same guest across migrations.
1417 B<hostname> means to use the global B<Hostname> setting, which is probably not
1418 useful on its own because all guests will appear to have the same name.
1420 You can also specify combinations of these fields. For example B<name uuid>
1421 means to concatenate the guest name and UUID (with a literal colon character
1422 between, thus I<"foo:1234-1234-1234-1234">).
1424 =back
1426 =head2 Plugin C<logfile>
1428 =over 4
1430 =item B<LogLevel> B<debug|info|notice|warning|err>
1432 Sets the log-level. If, for example, set to B<notice>, then all events with
1433 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1435 Please note that B<debug> is only available if collectd has been compiled with
1436 debugging support.
1438 =item B<File> I<File>
1440 Sets the file to write log messages to. The special strings B<stdout> and
1441 B<stderr> can be used to write to the standard output and standard error
1442 channels, respectively. This, of course, only makes much sense when collectd is
1443 running in foreground- or non-daemon-mode.
1445 =item B<Timestamp> B<true>|B<false>
1447 Prefix all lines printed by the current time. Defaults to B<true>.
1449 =back
1451 B<Note>: There is no need to notify the daemon after moving or removing the
1452 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1453 for each line it writes.
1455 =head2 Plugin C<mbmon>
1457 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1459 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1460 B<Host> and B<Port> options can be used to change these values, see below.
1461 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1462 timeouts may appear which may interfere with other statistics..
1464 C<mbmon> must be run with the -r option ("print TAG and Value format");
1465 Debian's F</etc/init.d/mbmon> script already does this, other people
1466 will need to ensure that this is the case.
1468 =over 4
1470 =item B<Host> I<Hostname>
1472 Hostname to connect to. Defaults to B<127.0.0.1>.
1474 =item B<Port> I<Port>
1476 TCP-Port to connect to. Defaults to B<411>.
1478 =back
1480 =head2 Plugin C<memcachec>
1482 The C<memcachec plugin> connects to a memcached server, queries one or more
1483 given I<pages> and parses the returned data according to user specification.
1484 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1485 plugins.
1487 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1488 library. Please note that there is another library with a very similar name,
1489 libmemcache (notice the missing `d'), which is not applicable.
1491 Synopsis of the configuration:
1493  <Plugin "memcachec">
1494    <Page "plugin_instance">
1495      Server "localhost"
1496      Key "page_key"
1497      <Match>
1498        Regex "(\\d+) bytes sent"
1499        DSType CounterAdd
1500        Type "ipt_octets"
1501        Instance "type_instance"
1502      </Match>
1503    </Page>
1504  </Plugin>
1506 The configuration options are:
1508 =over 4
1510 =item E<lt>B<Page> I<Name>E<gt>
1512 Each B<Page> block defines one I<page> to be queried from the memcached server.
1513 The block requires one string argument which is used as I<plugin instance>.
1515 =item B<Server> I<Address>
1517 Sets the server address to connect to when querying the page. Must be inside a
1518 B<Page> block.
1520 =item B<Key> I<Key>
1522 When connected to the memcached server, asks for the page I<Key>.
1524 =item E<lt>B<Match>E<gt>
1526 Match blocks define which strings to look for and how matches substrings are
1527 interpreted. For a description of match blocks, please see L<"Plugin tail">.
1529 =back
1531 =head2 Plugin C<memcached>
1533 The C<memcached plugin> connects to a memcached server and queries statistics
1534 about cache utilization, memory and bandwidth used.
1535 L<http://www.danga.com/memcached/>
1537 =over 4
1539 =item B<Host> I<Hostname>
1541 Hostname to connect to. Defaults to B<127.0.0.1>.
1543 =item B<Port> I<Port>
1545 TCP-Port to connect to. Defaults to B<11211>.
1547 =back
1549 =head2 Plugin C<mysql>
1551 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
1552 one or more databases when started and keeps the connection up as long as
1553 possible. When the connection is interrupted for whatever reason it will try
1554 to re-connect. The plugin will complaint loudly in case anything goes wrong.
1556 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
1557 and collects information about MySQL network traffic, executed statements,
1558 requests, the query cache and threads by evaluating the
1559 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
1560 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
1561 Status Variables> for an explanation of these values.
1563 Optionally, master and slave statistics may be collected in a MySQL
1564 replication setup. In that case, information about the synchronization state
1565 of the nodes are collected by evaluating the C<Position> return value of the
1566 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
1567 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
1568 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
1569 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
1570 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
1572 Synopsis:
1574   <Plugin mysql>
1575     <Database foo>
1576       Host "hostname"
1577       User "username"
1578       Password "password"
1579       Port "3306"
1580       MasterStats true
1581     </Database>
1583     <Database bar>
1584       Host "localhost"
1585       Socket "/var/run/mysql/mysqld.sock"
1586       SlaveStats true
1587       SlaveNotifications true
1588     </Database>
1589   </Plugin>
1591 A B<Database> block defines one connection to a MySQL database. It accepts a
1592 single argument which specifies the name of the database. None of the other
1593 options are required. MySQL will use default values as documented in the
1594 section "mysql_real_connect()" in the B<MySQL reference manual>.
1596 =over 4
1598 =item B<Host> I<Hostname>
1600 Hostname of the database server. Defaults to B<localhost>.
1602 =item B<User> I<Username>
1604 Username to use when connecting to the database. The user does not have to be
1605 granted any privileges (which is synonym to granting the C<USAGE> privilege).
1606 Any existing MySQL user will do.
1608 =item B<Password> I<Password>
1610 Password needed to log into the database.
1612 =item B<Database> I<Database>
1614 Select this database. Defaults to I<no database> which is a perfectly reasonable
1615 option for what this plugin does.
1617 =item B<Port> I<Port>
1619 TCP-port to connect to. The port must be specified in its numeric form, but it
1620 must be passed as a string nonetheless. For example:
1622   Port "3306"
1624 If B<Host> is set to B<localhost> (the default), this setting has no effect.
1625 See the documentation for the C<mysql_real_connect> function for details.
1627 =item B<Socket> I<Socket>
1629 Specifies the path to the UNIX domain socket of the MySQL server. This option
1630 only has any effect, if B<Host> is set to B<localhost> (the default).
1631 Otherwise, use the B<Port> option above. See the documentation for the
1632 C<mysql_real_connect> function for details.
1634 =item B<MasterStats> I<true|false>
1636 =item B<SlaveStats> I<true|false>
1638 Enable the collection of master / slave statistics in a replication setup.
1640 =item B<SlaveNotifications> I<true|false>
1642 If enabled, the plugin sends a notification if the replication slave I/O and /
1643 or SQL threads are not running.
1645 =back
1647 =head2 Plugin C<netapp>
1649 The netapp plugin can collect various performance and capacity informations
1650 from a NetApp filer using the NetApp API.
1652 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
1653 basic authentication.
1655 B<Do not use a regular user for this!> Create a special collectd user with just
1656 the minimum of capabilities needed. The user only needs the "login-http-admin"
1657 capability as well as a few more depending on which data will be collected.
1658 Required capabilities are documented below.
1660 =head3 Synopsis
1662  <Plugin "netapp">
1663    <Host "netapp1.example.com">
1664     Protocol      "https"
1665     Address       "10.0.0.1"
1666     Port          443
1667     Login         "username" "password"
1668     Interval      30
1669     <GetSystemPerfData>
1670     </GetSystemPerfData>
1671     <GetWaflPerfData>
1672     </GetWaflPerfData>
1673     <GetDiskPerfData>
1674     </GetDiskPerfData>
1675     <GetVolumePerfData>
1676     </GetVolumePerfData>
1677     <GetVolumeData>
1678     </GetVolumeData>
1679    </Host>
1680  </Plugin>
1682 The netapp plugin accepts the following configuration options:
1684 =over 4
1686 =item B<Host> I<Name>
1688 A host block defines one NetApp filer. It will appear in collectd with the name
1689 you specify here which does not have to be its real name nor its hostname.
1691 =item B<Protocol> B<httpd>|B<http>
1693 The protocol collectd will use to query this host.
1695 Optional
1697 Type: string
1699 Default: https
1701 Valid options: http, https
1703 =item B<Address> I<Address>
1705 The hostname or IP address of the host.
1707 Optional
1709 Type: string
1711 Default: The "host" block's name.
1713 =item B<Port> I<Port>
1715 The TCP port to connect to on the host.
1717 Optional
1719 Type: integer
1721 Default: 80 for protocol "http", 443 for protocol "https"
1723 =item B<Login> I<User> I<Password>
1725 The username and password to use to login to the NetApp.
1727 Mandatory
1729 Type: 2 strings
1731 =item B<Interval> I<Interval>
1733 B<TODO>
1735 =back
1737 The following options decide what kind of data will be collected. You can
1738 either use them as a block and fine tune various parameters inside this block,
1739 use them as a single statement to just accept all default values, or omit it to
1740 not collect any data.
1742 The following options are valid inside all blocks:
1744 =over 4
1746 =item B<Multiplier> I<Multiplier>
1748 The host specific interval between data collections is multiplied by this value
1749 for collecting these data.
1751 Optional
1753 Type: integer
1755 Default: 1
1757 =back
1759 =head3 The GetSystemPerfData block
1761 This will collect various performance data about the whole system.
1763 B<Note:> To get this data the collectd user needs the
1764 "api-perf-object-get-instances" capability.
1766 =over 4
1768 =item B<GetCPULoad> B<true>|B<false>
1770 If you set this option to true the current CPU usage will be read. This will be
1771 the average usage between all CPUs in your NetApp without any information about
1772 individual CPUs.
1774 B<Note:> These are the same values that the NetApp CLI command "sysstat"
1775 returns in the "CPU" field.
1777 Optional
1779 Type: boolean
1781 Default: true
1783 Result: Two value lists of type "cpu", and type instances "idle" and "system".
1785 =item B<GetInterfaces> B<true>|B<false>
1787 If you set this option to true the current traffic of the network interfaces
1788 will be read. This will be the total traffic over all interfaces of your NetApp
1789 without any information about individual interfaces.
1791 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
1792 in the "Net kB/s" field.
1794 B<Or is it?>
1796 Optional
1798 Type: boolean
1800 Default: true
1802 Result: One value list of type "if_octects".
1804 =item B<GetDiskIO> B<true>|B<false>
1806 If you set this option to true the current IO throughput will be read. This
1807 will be the total IO of your NetApp without any information about individual
1808 disks, volumes or aggregates.
1810 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
1811 in the "DiskE<nbsp>kB/s" field.
1813 Optional
1815 Type: boolean
1817 Default: true
1819 Result: One value list of type "disk_octets".
1821 =item B<GetDiskOps> B<true>|B<false>
1823 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
1824 iSCSI, etc. operations will be read. This will be the total number of
1825 operations on your NetApp without any information about individual volumes or
1826 aggregates.
1828 B<Note:> These are the same values that the NetApp CLI command "sysstat"
1829 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
1831 Optional
1833 Type: boolean
1835 Default: true
1837 Result: A variable number of value lists of type "disk_ops_complex". Each type
1838 of operation will result in one value list with the name of the operation as
1839 type instance.
1841 =back
1843 =head3 The GetWaflPerfData block
1845 This will collect various performance data about the WAFL file system. At the
1846 moment this just means cache performance.
1848 B<Note:> To get this data the collectd user needs the
1849 "api-perf-object-get-instances" capability.
1851 B<Note:> The interface to get these values is classified as "Diagnostics" by
1852 NetApp. This means that it is not guaranteed to be stable even between minor
1853 releases.
1855 =over 4
1857 =item B<GetNameCache> B<true>|B<false>
1859 Optional
1861 Type: boolean
1863 Default: true
1865 Result: One value list of type "cache_ratio" and type instance
1866 "name_cache_hit".
1868 =item B<GetDirCache> B<true>|B<false>
1870 Optional
1872 Type: boolean
1874 Default: true
1876 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
1878 =item B<GetInodeCache> B<true>|B<false>
1880 Optional
1882 Type: boolean
1884 Default: true
1886 Result: One value list of type "cache_ratio" and type instance
1887 "inode_cache_hit".
1889 =item B<GetBufCache> B<true>|B<false>
1891 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
1892 in the "Cache hit" field.
1894 Optional
1896 Type: boolean
1898 Default: true
1900 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
1902 =back
1904 =head3 The GetDiskPerfData block
1906 This will collect performance data about the individual disks in the NetApp.
1908 B<Note:> To get this data the collectd user needs the
1909 "api-perf-object-get-instances" capability.
1911 =over 4
1913 =item B<GetBusy> B<true>|B<false>
1915 If you set this option to true the busy time of all disks will be calculated
1916 and the value of the busiest disk in the system will be written.
1918 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
1919 in the "Disk util" field. Probably.
1921 Optional
1923 Type: boolean
1925 Default: true
1927 Result: One value list of type "percent" and type instance "disk_busy".
1929 =back
1931 =head3 The GetVolumePerfData block
1933 This will collect various performance data about the individual volumes.
1935 All of these options take a list of volumes as parameters. In this case
1936 "volume" means just the name of the volume, without the "/vol/" prefix or
1937 anything like that.
1939 The special values "-" and "+" are supported. "-" means "don't collect values
1940 for any volumes". "+" means "collect values for all volumes, even volumes that
1941 are created after collectd was started." Additionally you can prefix a volume
1942 name with a "-" sign to exclude this one volume. Eg '"+" "-vol0"' collectes
1943 values for all volumes except vol0.  The order of the parameters is important.
1944 '"-vol0" "+"' doesn't make sense because the "+" overrides the earlier "-vol0".
1946 B<Note:> To get this data the collectd user needs the
1947 "api-perf-object-get-instances" capability.
1949 =over 4
1951 =item B<GetIO> I<Volume> [I<Volume> ...]
1952 The current IO throughput will be read for every volume specified here.
1954 Optional
1956 Type: list of strings
1958 Default: "+"
1960 Result: Data sources of type "disk_octets" and the name of the volume as
1961 plugin_instance.
1963 =item B<GetOps> I<Volume> [I<Volume> ...]
1965 The current number of operation will be read for every volume specified here. 
1967 Optional
1969 Type: list of strings
1971 Default: "+"
1973 Result: Data sources of type "disk_ops" and the name of the volume as
1974 plugin_instance.
1976 =item B<GetLatency> I<Volume> [I<Volume> ...]
1978 The current latency for volume access in microseconds will be read for every
1979 volume specified here. 
1981 Optional
1983 Type: list of strings
1985 Default: "+"
1987 Result: Data sources of type "disk_latency" and the name of the volume as
1988 plugin_instance.
1990 =back
1992 =head3 The GetVolumeData block
1994 This will collect capacity data about the individual volumes.
1996 All of these options take a list of volumes as parameters, just like the
1997 GetVolumePerfData options.
1999 B<Note:> To get this data the collectd user needs the "api-volume-list-info"
2000 capability.
2002 =over 4
2004 =item B<GetDiskUtil>
2006 The current capacity of the volume will be collected. This will result in two
2007 to four value lists, depending on the configuration of the volume. All data
2008 sources are of type "df_complex" with the name of the volume as
2009 plugin_instance.
2011 There will be type_instances "used" and "free" for the number of used and
2012 available bytes on the volume.  If the volume has some space reserved for
2013 snapshots, a type_instance "snap_reserved" will be available.  If the volume
2014 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2015 number of bytes saved by the SIS feature.
2017 B<Note:> The current NetApp API has a bug that results in this value being
2018 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2019 number which works most of the time.  If you see strange values here, bug
2020 NetApp support to fix this.
2022 Optional
2024 Type: list of strings
2026 Default: "+"
2028 =item B<GetSnapData>
2030 B<TODO>
2032 =back
2034 =head2 Plugin C<netlink>
2036 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2037 statistics of various interface and routing aspects.
2039 =over 4
2041 =item B<Interface> I<Interface>
2043 =item B<VerboseInterface> I<Interface>
2045 Instruct the plugin to collect interface statistics. This is basically the same
2046 as the statistics provided by the C<interface> plugin (see above) but
2047 potentially much more detailed.
2049 When configuring with B<Interface> only the basic statistics will be collected,
2050 namely octets, packets, and errors. These statistics are collected by
2051 the C<interface> plugin, too, so using both at the same time is no benefit.
2053 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2054 so that no data needs to be collected twice if you use the C<interface> plugin.
2055 This includes dropped packets, received multicast packets, collisions and a
2056 whole zoo of differentiated RX and TX errors. You can try the following command
2057 to get an idea of what awaits you:
2059   ip -s -s link list
2061 If I<Interface> is B<All>, all interfaces will be selected.
2063 =item B<QDisc> I<Interface> [I<QDisc>]
2065 =item B<Class> I<Interface> [I<Class>]
2067 =item B<Filter> I<Interface> [I<Filter>]
2069 Collect the octets and packets that pass a certain qdisc, class or filter.
2071 QDiscs and classes are identified by their type and handle (or classid).
2072 Filters don't necessarily have a handle, therefore the parent's handle is used.
2073 The notation used in collectd differs from that used in tc(1) in that it
2074 doesn't skip the major or minor number if it's zero and doesn't print special
2075 ids by their name. So, for example, a qdisc may be identified by
2076 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2077 thus not displayed by tc(1).
2079 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2080 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2081 associated with that interface will be collected.
2083 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2084 used. This may lead to problems when more than one filter is attached to a
2085 qdisc or class. This isn't nice, but we don't know how this could be done any
2086 better. If you have a idea, please don't hesitate to tell us.
2088 As with the B<Interface> option you can specify B<All> as the interface,
2089 meaning all interfaces.
2091 Here are some examples to help you understand the above text more easily:
2093   <Plugin netlink>
2094     VerboseInterface "All"
2095     QDisc "eth0" "pfifo_fast-1:0"
2096     QDisc "ppp0"
2097     Class "ppp0" "htb-1:10"
2098     Filter "ppp0" "u32-1:0"
2099   </Plugin>
2101 =item B<IgnoreSelected>
2103 The behaviour is the same as with all other similar plugins: If nothing is
2104 selected at all, everything is collected. If some things are selected using the
2105 options described above, only these statistics are collected. If you set
2106 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2107 specified statistics will not be collected.
2109 =back
2111 =head2 Plugin C<network>
2113 The Network plugin sends data to a remote instance of collectd, receives data
2114 from a remote instance, or both at the same time. Data which has been received
2115 from the network is usually not transmitted again, but this can be actived, see
2116 the B<Forward> option below.
2118 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2119 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2121 Both, B<Server> and B<Listen> can be used as single option or as block. When
2122 used as block, given options are valid for this socket only. For example:
2124  <Plugin "network">
2125    Server "collectd.internal.tld"
2126    <Server "collectd.external.tld">
2127      SecurityLevel "sign"
2128      Username "myhostname"
2129      Password "ohl0eQue"
2130    </Server>
2131  </Plugin>
2133 =over 4
2135 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2137 The B<Server> statement/block sets the server to send datagrams to. The
2138 statement may occur multiple times to send each datagram to multiple
2139 destinations.
2141 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2142 optional second argument specifies a port number or a service name. If not
2143 given, the default, B<25826>, is used.
2145 The following options are recognized within B<Server> blocks:
2147 =over 4
2149 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2151 Set the security you require for network communication. When the security level
2152 has been set to B<Encrypt>, data sent over the network will be encrypted using
2153 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2154 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2155 authentication code. When set to B<None>, data is sent without any security.
2157 This feature is only available if the I<network> plugin was linked with
2158 I<libgcrypt>.
2160 =item B<Username> I<Username>
2162 Sets the username to transmit. This is used by the server to lookup the
2163 password. See B<AuthFile> below. All security levels except B<None> require
2164 this setting.
2166 This feature is only available if the I<network> plugin was linked with
2167 I<libgcrypt>.
2169 =item B<Password> I<Password>
2171 Sets a password (shared secret) for this socket. All security levels except
2172 B<None> require this setting.
2174 This feature is only available if the I<network> plugin was linked with
2175 I<libgcrypt>.
2177 =back
2179 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2181 The B<Listen> statement sets the interfaces to bind to. When multiple
2182 statements are found the daemon will bind to multiple interfaces.
2184 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2185 the argument is a multicast address the daemon will join that multicast group.
2186 The optional second argument specifies a port number or a service name. If not
2187 given, the default, B<25826>, is used.
2189 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2191 =over 4
2193 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2195 Set the security you require for network communication. When the security level
2196 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2197 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2198 signed and encrypted data is accepted. When set to B<None>, all data will be
2199 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2200 decrypted if possible.
2202 This feature is only available if the I<network> plugin was linked with
2203 I<libgcrypt>.
2205 =item B<AuthFile> I<Filename>
2207 Sets a file in which usernames are mapped to passwords. These passwords are
2208 used to verify signatures and to decrypt encrypted network packets. If
2209 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
2210 verified and encrypted packets are decrypted. Otherwise, signed data is
2211 accepted without checking the signature and encrypted data cannot be decrypted.
2212 For the other security levels this option is mandatory.
2214 The file format is very simple: Each line consists of a username followed by a
2215 colon and any number of spaces followed by the password. To demonstrate, an
2216 example file could look like this:
2218   user0: foo
2219   user1: bar
2221 Each time a packet is received, the modification time of the file is checked
2222 using L<stat(2)>. If the file has been changed, the contents is re-read. While
2223 the file is being read, it is locked using L<fcntl(2)>.
2225 =back
2227 =item B<TimeToLive> I<1-255>
2229 Set the time-to-live of sent packets. This applies to all, unicast and
2230 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
2231 That means that multicast packets will be sent with a TTL of C<1> (one) on most
2232 operating systems.
2234 =item B<MaxPacketSize> I<1024-65535>
2236 Set the maximum size for datagrams received over the network. Packets larger
2237 than this will be truncated.
2239 =item B<Forward> I<true|false>
2241 If set to I<true>, write packets that were received via the network plugin to
2242 the sending sockets. This should only be activated when the B<Listen>- and
2243 B<Server>-statements differ. Otherwise packets may be send multiple times to
2244 the same multicast group. While this results in more network traffic than
2245 necessary it's not a huge problem since the plugin has a duplicate detection,
2246 so the values will not loop.
2248 =item B<CacheFlush> I<Seconds>
2250 For each host/plugin/type combination the C<network plugin> caches the time of
2251 the last value being sent or received. Every I<Seconds> seconds the plugin
2252 searches and removes all entries that are older than I<Seconds> seconds, thus
2253 freeing the unused memory again. Since this process is somewhat expensive and
2254 normally doesn't do much, this value should not be too small. The default is
2255 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
2256 either.
2258 =back
2260 =head2 Plugin C<nginx>
2262 This plugin collects the number of connections and requests handled by the
2263 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
2264 queries the page provided by the C<ngx_http_stub_status_module> module, which
2265 isn't compiled by default. Please refer to
2266 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
2267 how to compile and configure nginx and this module.
2269 The following options are accepted by the C<nginx plugin>:
2271 =over 4
2273 =item B<URL> I<http://host/nginx_status>
2275 Sets the URL of the C<ngx_http_stub_status_module> output.
2277 =item B<User> I<Username>
2279 Optional user name needed for authentication.
2281 =item B<Password> I<Password>
2283 Optional password needed for authentication.
2285 =item B<VerifyPeer> B<true|false>
2287 Enable or disable peer SSL certificate verification. See
2288 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
2290 =item B<VerifyHost> B<true|false>
2292 Enable or disable peer host name verification. If enabled, the plugin checks
2293 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
2294 certificate matches the host name provided by the B<URL> option. If this
2295 identity check fails, the connection is aborted. Obviously, only works when
2296 connecting to a SSL enabled server. Enabled by default.
2298 =item B<CACert> I<File>
2300 File that holds one or more SSL certificates. If you want to use HTTPS you will
2301 possibly need this option. What CA certificates come bundled with C<libcurl>
2302 and are checked by default depends on the distribution you use.
2304 =back
2306 =head2 Plugin C<notify_desktop>
2308 This plugin sends a desktop notification to a notification daemon, as defined
2309 in the Desktop Notification Specification. To actually display the
2310 notifications, B<notification-daemon> is required and B<collectd> has to be
2311 able to access the X server.
2313 The Desktop Notification Specification can be found at
2314 L<http://www.galago-project.org/specs/notification/>.
2316 =over 4
2318 =item B<OkayTimeout> I<timeout>
2320 =item B<WarningTimeout> I<timeout>
2322 =item B<FailureTimeout> I<timeout>
2324 Set the I<timeout>, in milliseconds, after which to expire the notification
2325 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
2326 been specified, the displayed notification will not be closed at all - the
2327 user has to do so herself. These options default to 5000. If a negative number
2328 has been specified, the default is used as well.
2330 =back
2332 =head2 Plugin C<notify_email>
2334 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
2335 configured email address.
2337 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
2339 Available configuration options:
2341 =over 4
2343 =item B<From> I<Address>
2345 Email address from which the emails should appear to come from.
2347 Default: C<root@localhost>
2349 =item B<Recipient> I<Address>
2351 Configures the email address(es) to which the notifications should be mailed.
2352 May be repeated to send notifications to multiple addresses.
2354 At least one B<Recipient> must be present for the plugin to work correctly.
2356 =item B<SMTPServer> I<Hostname>
2358 Hostname of the SMTP server to connect to.
2360 Default: C<localhost>
2362 =item B<SMTPPort> I<Port>
2364 TCP port to connect to.
2366 Default: C<25>
2368 =item B<SMTPUser> I<Username>
2370 Username for ASMTP authentication. Optional.
2372 =item B<SMTPPassword> I<Password>
2374 Password for ASMTP authentication. Optional.
2376 =item B<Subject> I<Subject>
2378 Subject-template to use when sending emails. There must be exactly two
2379 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
2380 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
2381 with the hostname.
2383 Default: C<Collectd notify: %s@%s>
2385 =back
2387 =head2 Plugin C<ntpd>
2389 =over 4
2391 =item B<Host> I<Hostname>
2393 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
2395 =item B<Port> I<Port>
2397 UDP-Port to connect to. Defaults to B<123>.
2399 =item B<ReverseLookups> B<true>|B<false>
2401 Sets wether or not to perform reverse lookups on peers. Since the name or
2402 IP-address may be used in a filename it is recommended to disable reverse
2403 lookups. The default is to do reverse lookups to preserve backwards
2404 compatibility, though.
2406 =back
2408 =head2 Plugin C<nut>
2410 =over 4
2412 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
2414 Add a UPS to collect data from. The format is identical to the one accepted by
2415 L<upsc(8)>.
2417 =back
2419 =head2 Plugin C<olsrd>
2421 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
2422 the Optimized Link State Routing daemon and reads information about the current
2423 state of the meshed network.
2425 The following configuration options are understood:
2427 =over 4
2429 =item B<Host> I<Host>
2431 Connect to I<Host>. Defaults to B<"localhost">.
2433 =item B<Port> I<Port>
2435 Specifies the port to connect to. This must be a string, even if you give the
2436 port as a number rather than a service name. Defaults to B<"2006">.
2438 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
2440 Specifies what information to collect about links, i.E<nbsp>e. direct
2441 connections of the daemon queried. If set to B<No>, no information is
2442 collected. If set to B<Summary>, the number of links and the average of all
2443 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
2444 If set to B<Detail> LQ and NLQ are collected per link.
2446 Defaults to B<Detail>.
2448 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
2450 Specifies what information to collect about routes of the daemon queried. If
2451 set to B<No>, no information is collected. If set to B<Summary>, the number of
2452 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
2453 metric and ETX are collected per route.
2455 Defaults to B<Summary>.
2457 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
2459 Specifies what information to collect about the global topology. If set to
2460 B<No>, no information is collected. If set to B<Summary>, the number of links
2461 in the entire topology and the average I<link quality> (LQ) is calculated.
2462 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
2464 Defaults to B<Summary>.
2466 =back
2468 =head2 Plugin C<onewire>
2470 B<EXPERIMENTAL!> See notes below.
2472 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
2473 L<http://owfs.org/> to read sensors connected via the onewire bus.
2475 Currently only temperature sensors (sensors with the family code C<10>,
2476 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
2477 would like to have included, please send a sort request to the mailing list.
2479 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
2480 experimental, below.
2482 =over 4
2484 =item B<Device> I<Device>
2486 Sets the device to read the values from. This can either be a "real" hardware
2487 device, such as a serial port or an USB port, or the address of the
2488 L<owserver(1)> socket, usually B<localhost:4304>.
2490 Though the documentation claims to automatically recognize the given address
2491 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
2492 with that version, the following configuration worked for us:
2494   <Plugin onewire>
2495     Device "-s localhost:4304"
2496   </Plugin>
2498 This directive is B<required> and does not have a default value.
2500 =item B<Sensor> I<Sensor>
2502 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
2503 below. Sensors are specified without the family byte at the beginning, to you'd
2504 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
2505 point.
2507 =item B<IgnoreSelected> I<true>|I<false>
2509 If no configuration if given, the B<onewire> plugin will collect data from all
2510 sensors found. This may not be practical, especially if sensors are added and
2511 removed regularly. Sometimes, however, it's easier/preferred to collect only
2512 specific sensors or all sensors I<except> a few specified ones. This option
2513 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
2514 B<Sensor> is inverted: All selected interfaces are ignored and all other
2515 interfaces are collected.
2517 =item B<Interval> I<Seconds>
2519 Sets the interval in which all sensors should be read. If not specified, the
2520 global B<Interval> setting is used.
2522 =back
2524 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
2525 work with big setups. It works with one sensor being attached to one
2526 controller, but as soon as you throw in a couple more senors and maybe a hub
2527 or two, reading all values will take more than ten seconds (the default
2528 interval). We will probably add some separate thread for reading the sensors
2529 and some cache or something like that, but it's not done yet. We will try to
2530 maintain backwards compatibility in the future, but we can't promise. So in
2531 short: If it works for you: Great! But keep in mind that the config I<might>
2532 change, though this is unlikely. Oh, and if you want to help improving this
2533 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
2535 =head2 Plugin C<openvpn>
2537 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
2538 traffic statistics about connected clients.
2540 To set up OpenVPN to write to the status file periodically, use the
2541 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
2542 you need to set the required format, too. This is done by setting
2543 B<--status-version> to B<2>.
2545 So, in a nutshell you need:
2547   openvpn $OTHER_OPTIONS \
2548     --status "/var/run/openvpn-status" 10 \
2549     --status-version 2
2551 Available options:
2553 =over 4
2555 =item B<StatusFile> I<File>
2557 Specifies the location of the status file.
2559 =back
2561 =head2 Plugin C<oracle>
2563 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
2564 Oracle® Database and lets you execute SQL statements there. It is very similar
2565 to the "dbi" plugin, because it was written around the same time. See the "dbi"
2566 plugin's documentation above for details.
2568   <Plugin oracle>
2569     <Query "out_of_stock">
2570       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2571       <Result>
2572         Type "gauge"
2573         # InstancePrefix "foo"
2574         InstancesFrom "category"
2575         ValuesFrom "value"
2576       </Result>
2577     </Query>
2578     <Database "product_information">
2579       ConnectID "db01"
2580       Username "oracle"
2581       Password "secret"
2582       Query "out_of_stock"
2583     </Database>
2584   </Plugin>
2586 =head3 B<Query> blocks
2588 The Query blocks are handled identically to the Query blocks of the "dbi"
2589 plugin. Please see its documentation above for details on how to specify
2590 queries.
2592 =head3 B<Database> blocks
2594 Database blocks define a connection to a database and which queries should be
2595 sent to that database. Each database needs a "name" as string argument in the
2596 starting tag of the block. This name will be used as "PluginInstance" in the
2597 values submitted to the daemon. Other than that, that name is not used.
2599 =over 4
2601 =item B<ConnectID> I<ID>
2603 Defines the "database alias" or "service name" to connect to. Usually, these
2604 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
2606 =item B<Username> I<Username>
2608 Username used for authentication.
2610 =item B<Password> I<Password>
2612 Password used for authentication.
2614 =item B<Query> I<QueryName>
2616 Associates the query named I<QueryName> with this database connection. The
2617 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2618 blocks you want to refer to must be placed above the database block you want to
2619 refer to them from.
2621 =back
2623 =head2 Plugin C<perl>
2625 This plugin embeds a Perl-interpreter into collectd and provides an interface
2626 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
2628 =head2 Plugin C<ping>
2630 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
2631 configured hosts periodically and measures the network latency. Whenever the
2632 C<read> function of the plugin is called, it submits the average latency, the
2633 standard deviation and the drop rate for each host.
2635 Available configuration options:
2637 =over 4
2639 =item B<Host> I<IP-address>
2641 Host to ping periodically. This option may be repeated several times to ping
2642 multiple hosts.
2644 =item B<Interval> I<Seconds>
2646 Sets the interval in which to send ICMP echo packets to the configured hosts.
2647 This is B<not> the interval in which statistics are queries from the plugin but
2648 the interval in which the hosts are "pinged". Therefore, the setting here
2649 should be smaller than or equal to the global B<Interval> setting. Fractional
2650 times, such as "1.24" are allowed.
2652 Default: B<1.0>
2654 =item B<Timeout> I<Seconds>
2656 Time to wait for a response from the host to which an ICMP packet had been
2657 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
2658 to be down or the packet to be dropped. This setting must be smaller than the
2659 B<Interval> setting above for the plugin to work correctly. Fractional
2660 arguments are accepted.
2662 Default: B<0.9>
2664 =item B<TTL> I<0-255>
2666 Sets the Time-To-Live of generated ICMP packets.
2668 =back
2670 =head2 Plugin C<postgresql>
2672 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
2673 keeps a persistent connection to all configured databases and tries to
2674 reconnect if the connection has been interrupted. A database is configured by
2675 specifying a B<Database> block as described below. The default statistics are
2676 collected from PostgreSQL's B<statistics collector> which thus has to be
2677 enabled for this plugin to work correctly. This should usually be the case by
2678 default. See the section "The Statistics Collector" of the B<PostgreSQL
2679 Documentation> for details.
2681 By specifying custom database queries using a B<Query> block as described
2682 below, you may collect any data that is available from some PostgreSQL
2683 database. This way, you are able to access statistics of external daemons
2684 which are available in a PostgreSQL database or use future or special
2685 statistics provided by PostgreSQL without the need to upgrade your collectd
2686 installation.
2688 The B<PostgreSQL Documentation> manual can be found at
2689 L<http://www.postgresql.org/docs/manuals/>.
2691   <Plugin postgresql>
2692     <Query magic>
2693       Statement "SELECT magic FROM wizard WHERE host = $1;"
2694       Param hostname
2695       <Result>
2696         Type gauge
2697         InstancePrefix "magic"
2698         ValuesFrom magic
2699       </Result>
2700     </Query>
2702     <Query rt36_tickets>
2703       Statement "SELECT COUNT(type) AS count, type \
2704                         FROM (SELECT CASE \
2705                                      WHEN resolved = 'epoch' THEN 'open' \
2706                                      ELSE 'resolved' END AS type \
2707                                      FROM tickets) type \
2708                         GROUP BY type;"
2709       <Result>
2710         Type counter
2711         InstancePrefix "rt36_tickets"
2712         InstancesFrom "type"
2713         ValuesFrom "count"
2714       </Result>
2715     </Query>
2717     <Database foo>
2718       Host "hostname"
2719       Port "5432"
2720       User "username"
2721       Password "secret"
2722       SSLMode "prefer"
2723       KRBSrvName "kerberos_service_name"
2724       Query magic
2725     </Database>
2727     <Database bar>
2728       Service "service_name"
2729       Query backend # predefined
2730       Query rt36_tickets
2731     </Database>
2732   </Plugin>
2734 The B<Query> block defines one database query which may later be used by a
2735 database definition. It accepts a single mandatory argument which specifies
2736 the name of the query. The names of all queries have to be unique (see the
2737 B<MinVersion> and B<MaxVersion> options below for an exception to this
2738 rule). The following configuration options are available to define the query:
2740 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
2741 blocks define how to handle the values returned from the query. They define
2742 which column holds which value and how to dispatch that value to the daemon.
2743 Multiple B<Result> blocks may be used to extract multiple values from a single
2744 query.
2746 =over 4
2748 =item B<Statement> I<sql query statement>
2750 Specify the I<sql query statement> which the plugin should execute. The string
2751 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
2752 first, second, etc. parameter. The value of the parameters is specified by the
2753 B<Param> configuration option - see below for details. To include a literal
2754 B<$> character followed by a number, surround it with single quotes (B<'>).
2756 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
2757 allowed. Note, however, that only a single command may be used. Semicolons are
2758 allowed as long as a single non-empty command has been specified only.
2760 The returned lines will be handled separately one after another.
2762 =item B<Query> I<sql query statement>
2764 This is a deprecated synonym for B<Statement>. It will be removed in version 5
2765 of collectd.
2767 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
2769 Specify the parameters which should be passed to the SQL query. The parameters
2770 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
2771 they appear in the configuration file. The value of the parameter is
2772 determined depending on the value of the B<Param> option as follows:
2774 =over 4
2776 =item I<hostname>
2778 The configured hostname of the database connection. If a UNIX domain socket is
2779 used, the parameter expands to "localhost".
2781 =item I<database>
2783 The name of the database of the current connection.
2785 =item I<username>
2787 The username used to connect to the database.
2789 =item I<interval>
2791 The interval collectd is using (as specified by the B<Interval> option).
2793 =back
2795 Please note that parameters are only supported by PostgreSQL's protocol
2796 version 3 and above which was introduced in version 7.4 of PostgreSQL.
2798 =item B<Type> I<type>
2800 The I<type> name to be used when dispatching the values. The type describes
2801 how to handle the data and where to store it. See L<types.db(5)> for more
2802 details on types and their configuration. The number and type of values (as
2803 selected by the B<ValuesFrom> option) has to match the type of the given name.
2805 This option is required inside a B<Result> block.
2807 =item B<InstancePrefix> I<prefix>
2809 =item B<InstancesFrom> I<column0> [I<column1> ...]
2811 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
2812 B<InstancePrefix> defines a static prefix that will be prepended to all type
2813 instances. B<InstancesFrom> defines the column names whose values will be used
2814 to create the type instance. Multiple values will be joined together using the
2815 hyphen (C<->) as separation character.
2817 The plugin itself does not check whether or not all built instances are
2818 different. It is your responsibility to assure that each is unique.
2820 Both options are optional. If none is specified, the type instance will be
2821 empty.
2823 =item B<ValuesFrom> I<column0> [I<column1> ...]
2825 Names the columns whose content is used as the actual data for the data sets
2826 that are dispatched to the daemon. How many such columns you need is
2827 determined by the B<Type> setting as explained above. If you specify too many
2828 or not enough columns, the plugin will complain about that and no data will be
2829 submitted to the daemon.
2831 The actual data type, as seen by PostgreSQL, is not that important as long as
2832 it represents numbers. The plugin will automatically cast the values to the
2833 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
2834 L<strtod(3)> functions, so anything supported by those functions is supported
2835 by the plugin as well.
2837 This option is required inside a B<Result> block and may be specified multiple
2838 times. If multiple B<ValuesFrom> options are specified, the columns are read
2839 in the given order.
2841 =item B<Column> I<type> [I<type instance>]
2843 This is a deprecated alternative to a B<Result> block. It will be removed in
2844 version 5 of collectd. It is equivalent to the following B<Result> block:
2846   <Result>
2847     Type I<type>
2848     InstancePrefix I<type instance>
2849     ValuesFrom I<name of the x. column>
2850   </Result>
2852 The order of the B<Column> options defines which columns of the query result
2853 should be used. The first option specifies the data found in the first column,
2854 the second option that of the second column, and so on.
2856 =item B<MinVersion> I<version>
2858 =item B<MaxVersion> I<version>
2860 Specify the minimum or maximum version of PostgreSQL that this query should be
2861 used with. Some statistics might only be available with certain versions of
2862 PostgreSQL. This allows you to specify multiple queries with the same name but
2863 which apply to different versions, thus allowing you to use the same
2864 configuration in a heterogeneous environment.
2866 The I<version> has to be specified as the concatenation of the major, minor
2867 and patch-level versions, each represented as two-decimal-digit numbers. For
2868 example, version 8.2.3 will become 80203.
2870 =item B<MinPGVersion> I<version>
2872 =item B<MaxPGVersion> I<version>
2874 These are deprecated synonyms for B<MinVersion> and B<MaxVersion>
2875 respectively. They will be removed in version 5 of collectd.
2877 =back
2879 The following predefined queries are available (the definitions can be found
2880 in the F<postgresql_default.conf> file which, by default, is available at
2881 C<I<prefix>/share/collectd/>):
2883 =over 4
2885 =item B<backends>
2887 This query collects the number of backends, i.E<nbsp>e. the number of
2888 connected clients.
2890 =item B<transactions>
2892 This query collects the numbers of committed and rolled-back transactions of
2893 the user tables.
2895 =item B<queries>
2897 This query collects the numbers of various table modifications (i.E<nbsp>e.
2898 insertions, updates, deletions) of the user tables.
2900 =item B<query_plans>
2902 This query collects the numbers of various table scans and returned tuples of
2903 the user tables.
2905 =item B<table_states>
2907 This query collects the numbers of live and dead rows in the user tables.
2909 =item B<disk_io>
2911 This query collects disk block access counts for user tables.
2913 =item B<disk_usage>
2915 This query collects the on-disk size of the database in bytes.
2917 =back
2919 The B<Database> block defines one PostgreSQL database for which to collect
2920 statistics. It accepts a single mandatory argument which specifies the
2921 database name. None of the other options are required. PostgreSQL will use
2922 default values as documented in the section "CONNECTING TO A DATABASE" in the
2923 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
2924 the user collectd is run as and special environment variables. See the manpage
2925 for details.
2927 =over 4
2929 =item B<Host> I<hostname>
2931 Specify the hostname or IP of the PostgreSQL server to connect to. If the
2932 value begins with a slash, it is interpreted as the directory name in which to
2933 look for the UNIX domain socket.
2935 This option is also used to determine the hostname that is associated with a
2936 collected data set. If it has been omitted or either begins with with a slash
2937 or equals B<localhost> it will be replaced with the global hostname definition
2938 of collectd. Any other value will be passed literally to collectd when
2939 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
2941 =item B<Port> I<port>
2943 Specify the TCP port or the local UNIX domain socket file extension of the
2944 server.
2946 =item B<User> I<username>
2948 Specify the username to be used when connecting to the server.
2950 =item B<Password> I<password>
2952 Specify the password to be used when connecting to the server.
2954 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
2956 Specify whether to use an SSL connection when contacting the server. The
2957 following modes are supported:
2959 =over 4
2961 =item I<disable>
2963 Do not use SSL at all.
2965 =item I<allow>
2967 First, try to connect without using SSL. If that fails, try using SSL.
2969 =item I<prefer> (default)
2971 First, try to connect using SSL. If that fails, try without using SSL.
2973 =item I<require>
2975 Use SSL only.
2977 =back
2979 =item B<KRBSrvName> I<kerberos_service_name>
2981 Specify the Kerberos service name to use when authenticating with Kerberos 5
2982 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
2983 B<PostgreSQL Documentation> for details.
2985 =item B<Service> I<service_name>
2987 Specify the PostgreSQL service name to use for additional parameters. That
2988 service has to be defined in F<pg_service.conf> and holds additional
2989 connection parameters. See the section "The Connection Service File" in the
2990 B<PostgreSQL Documentation> for details.
2992 =item B<Query> I<query>
2994 Specify a I<query> which should be executed for the database connection. This
2995 may be any of the predefined or user-defined queries. If no such option is
2996 given, it defaults to "backends", "transactions", "queries", "query_plans",
2997 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
2998 used only.
3000 =back
3002 =head2 Plugin C<powerdns>
3004 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
3005 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
3006 values, many of which are probably meaningless to most users, but may be useful
3007 for some. So you may chose which values to collect, but if you don't, some
3008 reasonable defaults will be collected.
3010   <Plugin "powerdns">
3011     <Server "server_name">
3012       Collect "latency"
3013       Collect "udp-answers" "udp-queries"
3014       Socket "/var/run/pdns.controlsocket"
3015     </Server>
3016     <Recursor "recursor_name">
3017       Collect "questions"
3018       Collect "cache-hits" "cache-misses"
3019       Socket "/var/run/pdns_recursor.controlsocket"
3020     </Recursor>
3021     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
3022   </Plugin>
3024 =over 4
3026 =item B<Server> and B<Recursor> block
3028 The B<Server> block defines one authoritative server to query, the B<Recursor>
3029 does the same for an recursing server. The possible options in both blocks are
3030 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
3031 and is required.
3033 =over 4
3035 =item B<Collect> I<Field>
3037 Using the B<Collect> statement you can select which values to collect. Here,
3038 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
3039 C<dlg-only-drops>, C<answers10-100>.
3041 The method of getting the values differs for B<Server> and B<Recursor> blocks:
3042 When querying the server a C<SHOW *> command is issued in any case, because
3043 that's the only way of getting multiple values out of the server at once.
3044 collectd then picks out the values you have selected. When querying the
3045 recursor, a command is generated to query exactly these values. So if you
3046 specify invalid fields when querying the recursor, a syntax error may be
3047 returned by the daemon and collectd may not collect any values at all.
3049 If no B<Collect> statement is given, the following B<Server> values will be
3050 collected:
3052 =over 4
3054 =item latency
3056 =item packetcache-hit
3058 =item packetcache-miss
3060 =item packetcache-size
3062 =item query-cache-hit
3064 =item query-cache-miss
3066 =item recursing-answers
3068 =item recursing-questions
3070 =item tcp-answers
3072 =item tcp-queries
3074 =item udp-answers
3076 =item udp-queries
3078 =back
3080 The following B<Recursor> values will be collected by default:
3082 =over 4
3084 =item noerror-answers
3086 =item nxdomain-answers
3088 =item servfail-answers
3090 =item sys-msec
3092 =item user-msec
3094 =item qa-latency
3096 =item cache-entries
3098 =item cache-hits
3100 =item cache-misses
3102 =item questions
3104 =back
3106 Please note that up to that point collectd doesn't know what values are
3107 available on the server and values that are added do not need a change of the
3108 mechanism so far. However, the values must be mapped to collectd's naming
3109 scheme, which is done using a lookup table that lists all known values. If
3110 values are added in the future and collectd does not know about them, you will
3111 get an error much like this:
3113   powerdns plugin: submit: Not found in lookup table: foobar = 42
3115 In this case please file a bug report with the collectd team.
3117 =item B<Socket> I<Path>
3119 Configures the path to the UNIX domain socket to be used when connecting to the
3120 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
3121 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
3122 will be used for the recursor.
3124 =back
3126 =item B<LocalSocket> I<Path>
3128 Querying the recursor is done using UDP. When using UDP over UNIX domain
3129 sockets, the client socket needs a name in the file system, too. You can set
3130 this local name to I<Path> using the B<LocalSocket> option. The default is
3131 C<I<prefix>/var/run/collectd-powerdns>.
3133 =back
3135 =head2 Plugin C<processes>
3137 =over 4
3139 =item B<Process> I<Name>
3141 Select more detailed statistics of processes matching this name. The statistics
3142 collected for these selected processes are size of the resident segment size
3143 (RSS), user- and system-time used, number of processes and number of threads,
3144 and minor and major pagefaults.
3146 =item B<ProcessMatch> I<name> I<regex>
3148 Similar to the B<Process> option this allows to select more detailed
3149 statistics of processes matching the specified I<regex> (see L<regex(7)> for
3150 details). The statistics of all matching processes are summed up and
3151 dispatched to the daemon using the specified I<name> as an identifier. This
3152 allows to "group" several processes together. I<name> must not contain
3153 slashes.
3155 =back
3157 =head2 Plugin C<protocols>
3159 Collects a lot of information about various network protocols, such as I<IP>,
3160 I<TCP>, I<UDP>, etc.
3162 Available configuration options:
3164 =over 4
3166 =item B<Value> I<Selector>
3168 Selects whether or not to select a specific value. The string being matched is
3169 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
3170 plugin instance and I<ValueName> will be used as type instance. An example of
3171 the string being used would be C<Tcp:RetransSegs>.
3173 You can use regular expressions to match a large number of values with just one
3174 configuration option. To select all "extended" I<TCP> values, you could use the
3175 following statement:
3177   Value "/^TcpExt:/"
3179 Whether only matched values are selected or all matched values are ignored
3180 depends on the B<IgnoreSelected>. By default, only matched values are selected.
3181 If no value is configured at all, all values will be selected.
3183 =item B<IgnoreSelected> B<true>|B<false>
3185 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
3186 matching values will be ignored.
3188 =back
3190 =head2 Plugin C<rrdcached>
3192 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
3193 to store values to RRD files in an efficient manner. The combination of the
3194 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
3195 way the C<rrdtool> plugin works (see below). The added abstraction layer
3196 provides a number of benefits, though: Because the cache is not within
3197 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
3198 restarted. This results in much shorter (if any) gaps in graphs, especially
3199 under heavy load. Also, the C<rrdtool> command line utility is aware of the
3200 daemon so that it can flush values to disk automatically when needed. This
3201 allows to integrate automated flushing of values into graphing solutions much
3202 more easily.
3204 There are disadvantages, though: The daemon may reside on a different host, so
3205 it may not be possible for C<collectd> to create the appropriate RRD files
3206 anymore. And even if C<rrdcached> runs on the same host, it may run in a
3207 different base directory, so relative paths may do weird stuff if you're not
3208 careful.
3210 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
3211 on the same host, communicating via a UNIX domain socket. The B<DataDir>
3212 setting should be set to an absolute path, so that a changed base directory
3213 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
3215 =over 4
3217 =item B<DaemonAddress> I<Address>
3219 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
3220 library. See L<rrdcached(1)> for details. Example:
3222   <Plugin "rrdcached">
3223     DaemonAddress "unix:/var/run/rrdcached.sock"
3224   </Plugin>
3226 =item B<DataDir> I<Directory>
3228 Set the base directory in which the RRD files reside. If this is a relative
3229 path, it is relative to the working base directory of the C<rrdcached> daemon!
3230 Use of an absolute path is recommended.
3232 =item B<CreateFiles> B<true>|B<false>
3234 Enables or disables the creation of RRD files. If the daemon is not running
3235 locally, or B<DataDir> is set to a relative path, this will not work as
3236 expected. Default is B<true>.
3238 =back
3240 =head2 Plugin C<rrdtool>
3242 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
3243 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
3244 using these settings. If you don't want to dive into the depths of RRDtool, you
3245 can safely ignore these settings.
3247 =over 4
3249 =item B<DataDir> I<Directory>
3251 Set the directory to store RRD-files under. Per default RRD-files are generated
3252 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
3254 =item B<StepSize> I<Seconds>
3256 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
3257 this setting is unset and the stepsize is set to the interval in which the data
3258 is collected. Do not use this option unless you absolutely have to for some
3259 reason. Setting this option may cause problems with the C<snmp plugin>, the
3260 C<exec plugin> or when the daemon is set up to receive data from other hosts.
3262 =item B<HeartBeat> I<Seconds>
3264 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
3265 in which case the heartbeat is set to twice the B<StepSize> which should equal
3266 the interval in which data is collected. Do not set this option unless you have
3267 a very good reason to do so.
3269 =item B<RRARows> I<NumRows>
3271 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
3272 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
3273 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
3274 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
3275 week, one month, and one year.
3277 So for each timespan, it calculates how many PDPs need to be consolidated into
3278 one CDP by calculating:
3279   number of PDPs = timespan / (stepsize * rrarows)
3281 Bottom line is, set this no smaller than the width of you graphs in pixels. The
3282 default is 1200.
3284 =item B<RRATimespan> I<Seconds>
3286 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
3287 more then one RRA. If this option is never used, the built-in default of (3600,
3288 86400, 604800, 2678400, 31622400) is used.
3290 For more information on how RRA-sizes are calculated see B<RRARows> above.
3292 =item B<XFF> I<Factor>
3294 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
3296 =item B<CacheFlush> I<Seconds>
3298 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
3299 it writes all values for a certain RRD-file if the oldest value is older than
3300 (or equal to) the number of seconds specified. If some RRD-file is not updated
3301 anymore for some reason (the computer was shut down, the network is broken,
3302 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
3303 entire cache is searched for entries older than B<CacheTimeout> seconds and
3304 written to disk every I<Seconds> seconds. Since this is kind of expensive and
3305 does nothing under normal circumstances, this value should not be too small.
3306 900 seconds might be a good value, though setting this to 7200 seconds doesn't
3307 normally do much harm either.
3309 =item B<CacheTimeout> I<Seconds>
3311 If this option is set to a value greater than zero, the C<rrdtool plugin> will
3312 save values in a cache, as described above. Writing multiple values at once
3313 reduces IO-operations and thus lessens the load produced by updating the files.
3314 The trade off is that the graphs kind of "drag behind" and that more memory is
3315 used.
3317 =item B<WritesPerSecond> I<Updates>
3319 When collecting many statistics with collectd and the C<rrdtool> plugin, you
3320 will run serious performance problems. The B<CacheFlush> setting and the
3321 internal update queue assert that collectd continues to work just fine even
3322 under heavy load, but the system may become very unresponsive and slow. This is
3323 a problem especially if you create graphs from the RRD files on the same
3324 machine, for example using the C<graph.cgi> script included in the
3325 C<contrib/collection3/> directory.
3327 This setting is designed for very large setups. Setting this option to a value
3328 between 25 and 80 updates per second, depending on your hardware, will leave
3329 the server responsive enough to draw graphs even while all the cached values
3330 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
3331 by the B<FLUSH> command, are B<not> effected by this limit. They are still
3332 written as fast as possible, so that web frontends have up to date data when
3333 generating graphs.
3335 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
3336 updates per second, writing all values to disk will take approximately
3337 56E<nbsp>minutes. Together with the flushing ability that's integrated into
3338 "collection3" you'll end up with a responsive and fast system, up to date
3339 graphs and basically a "backup" of your values every hour.
3341 =item B<RandomTimeout> I<Seconds>
3343 When set, the actual timeout for each value is chosen randomly between
3344 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
3345 intention is to avoid high load situations that appear when many values timeout
3346 at the same time. This is especially a problem shortly after the daemon starts,
3347 because all values were added to the internal cache at roughly the same time.
3349 =back
3351 =head2 Plugin C<sensors>
3353 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
3354 that all the needed modules have to be loaded and lm_sensors has to be
3355 configured (most likely by editing F</etc/sensors.conf>. Read
3356 L<sensors.conf(5)> for details.
3358 The B<lm_sensors> homepage can be found at
3359 L<http://secure.netroedge.com/~lm78/>.
3361 =over 4
3363 =item B<Sensor> I<chip-bus-address/type-feature>
3365 Selects the name of the sensor which you want to collect or ignore, depending
3366 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
3367 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
3368 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
3370 =item B<IgnoreSelected> I<true>|I<false>
3372 If no configuration if given, the B<sensors>-plugin will collect data from all
3373 sensors. This may not be practical, especially for uninteresting sensors.
3374 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
3375 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
3376 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3377 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
3378 and all other sensors are collected.
3380 =back
3382 =head2 Plugin C<snmp>
3384 Since the configuration of the C<snmp plugin> is a little more complicated than
3385 other plugins, its documentation has been moved to an own manpage,
3386 L<collectd-snmp(5)>. Please see there for details.
3388 =head2 Plugin C<syslog>
3390 =over 4
3392 =item B<LogLevel> B<debug|info|notice|warning|err>
3394 Sets the log-level. If, for example, set to B<notice>, then all events with
3395 severity B<notice>, B<warning>, or B<err> will be submitted to the
3396 syslog-daemon.
3398 Please note that B<debug> is only available if collectd has been compiled with
3399 debugging support.
3401 =back
3403 =head2 Plugin C<table>
3405 The C<table plugin> provides generic means to parse tabular data and dispatch
3406 user specified values. Values are selected based on column numbers. For
3407 example, this plugin may be used to get values from the Linux L<proc(5)>
3408 filesystem or CSV (comma separated values) files.
3410   <Plugin table>
3411     <Table "/proc/slabinfo">
3412       Instance "slabinfo"
3413       Separator " "
3414       <Result>
3415         Type gauge
3416         InstancePrefix "active_objs"
3417         InstancesFrom 0
3418         ValuesFrom 1
3419       </Result>
3420       <Result>
3421         Type gauge
3422         InstancePrefix "objperslab"
3423         InstancesFrom 0
3424         ValuesFrom 4
3425       </Result>
3426     </Table>
3427   </Plugin>
3429 The configuration consists of one or more B<Table> blocks, each of which
3430 configures one file to parse. Within each B<Table> block, there are one or
3431 more B<Result> blocks, which configure which data to select and how to
3432 interpret it.
3434 The following options are available inside a B<Table> block:
3436 =over 4
3438 =item B<Instance> I<instance>
3440 If specified, I<instance> is used as the plugin instance. So, in the above
3441 example, the plugin name C<table-slabinfo> would be used. If omitted, the
3442 filename of the table is used instead, with all special characters replaced
3443 with an underscore (C<_>).
3445 =item B<Separator> I<string>
3447 Any character of I<string> is interpreted as a delimiter between the different
3448 columns of the table. A sequence of two or more contiguous delimiters in the
3449 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
3450 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
3451 of a table - see its documentation for more details. This option is mandatory.
3453 A horizontal tab, newline and carriage return may be specified by C<\\t>,
3454 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
3455 required because of collectd's config parsing.
3457 =back
3459 The following options are available inside a B<Result> block:
3461 =over 4
3463 =item B<Type> I<type>
3465 Sets the type used to dispatch the values to the daemon. Detailed information
3466 about types and their configuration can be found in L<types.db(5)>. This
3467 option is mandatory.
3469 =item B<InstancePrefix> I<prefix>
3471 If specified, prepend I<prefix> to the type instance. If omitted, only the
3472 B<InstancesFrom> option is considered for the type instance.
3474 =item B<InstancesFrom> I<column0> [I<column1> ...]
3476 If specified, the content of the given columns (identified by the column
3477 number starting at zero) will be used to create the type instance for each
3478 row. Multiple values (and the instance prefix) will be joined together with
3479 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
3480 option is considered for the type instance.
3482 The plugin itself does not check whether or not all built instances are
3483 different. It’s your responsibility to assure that each is unique. This is
3484 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
3485 sure that the table only contains one row.
3487 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
3488 will be empty.
3490 =item B<ValuesFrom> I<column0> [I<column1> ...]
3492 Specifies the columns (identified by the column numbers starting at zero)
3493 whose content is used as the actual data for the data sets that are dispatched
3494 to the daemon. How many such columns you need is determined by the B<Type>
3495 setting above. If you specify too many or not enough columns, the plugin will
3496 complain about that and no data will be submitted to the daemon. The plugin
3497 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
3498 respectively, so anything supported by those functions is supported by the
3499 plugin as well. This option is mandatory.
3501 =back
3503 =head2 Plugin C<tail>
3505 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
3506 each line and dispatches found values. What is matched can be configured by the
3507 user using (extended) regular expressions, as described in L<regex(7)>.
3509   <Plugin "tail">
3510     <File "/var/log/exim4/mainlog">
3511       Instance "exim"
3512       <Match>
3513         Regex "S=([1-9][0-9]*)"
3514         DSType "CounterAdd"
3515         Type "ipt_bytes"
3516         Instance "total"
3517       </Match>
3518       <Match>
3519         Regex "\\<R=local_user\\>"
3520         DSType "CounterInc"
3521         Type "counter"
3522         Instance "local_user"
3523       </Match>
3524     </File>
3525   </Plugin>
3527 The config consists of one or more B<File> blocks, each of which configures one
3528 logfile to parse. Within each B<File> block, there are one or more B<Match>
3529 blocks, which configure a regular expression to search for.
3531 The B<Instance> option in the B<File> block may be used to set the plugin
3532 instance. So in the above example the plugin name C<tail-foo> would be used.
3533 This plugin instance is for all B<Match> blocks that B<follow> it, until the
3534 next B<Instance> option. This way you can extract several plugin instances from
3535 one logfile, handy when parsing syslog and the like.
3537 Each B<Match> block has the following options to describe how the match should
3538 be performed:
3540 =over 4
3542 =item B<Regex> I<regex>
3544 Sets the regular expression to use for matching against a line. The first
3545 subexpression has to match something that can be turned into a number by
3546 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
3547 below. Because B<extended> regular expressions are used, you do not need to use
3548 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
3549 collectd's config parsing you need to escape backslashes, though. So if you
3550 want to match literal parentheses you need to do the following:
3552   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
3554 =item B<DSType> I<Type>
3556 Sets how the values are cumulated. I<Type> is one of:
3558 =over 4
3560 =item B<GaugeAverage>
3562 Calculate the average.
3564 =item B<GaugeMin>
3566 Use the smallest number only.
3568 =item B<GaugeMax>
3570 Use the greatest number only.
3572 =item B<GaugeLast>
3574 Use the last number found.
3576 =item B<CounterSet>
3578 The matched number is a counter. Simply sets the internal counter to this
3579 value.
3581 =item B<CounterAdd>
3583 Add the matched value to the internal counter.
3585 =item B<CounterInc>
3587 Increase the internal counter by one. This B<DSType> is the only one that does
3588 not use the matched subexpression, but simply counts the number of matched
3589 lines. Thus, you may use a regular expression without submatch in this case.
3591 =back
3593 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
3594 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
3595 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
3596 submatch at all and it may be omitted in this case.
3598 =item B<Type> I<Type>
3600 Sets the type used to dispatch this value. Detailed information about types and
3601 their configuration can be found in L<types.db(5)>.
3603 =item B<Instance> I<TypeInstance>
3605 This optional setting sets the type instance to use.
3607 =back
3609 =head2 Plugin C<teamspeak2>
3611 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
3612 polls interesting global and virtual server data. The plugin can query only one
3613 physical server but unlimited virtual servers. You can use the following
3614 options to configure it:
3616 =over 4
3618 =item B<Host> I<hostname/ip>
3620 The hostname or ip which identifies the physical server.
3621 Default: 127.0.0.1
3623 =item B<Port> I<port>
3625 The query port of the physical server. This needs to be a string.
3626 Default: "51234"
3628 =item B<Server> I<port>
3630 This option has to be added once for every virtual server the plugin should
3631 query. If you want to query the virtual server on port 8767 this is what the
3632 option would look like:
3634   Server "8767"
3636 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
3637 use quotes around it! If no such statement is given only global information
3638 will be collected.
3640 =back
3642 =head2 Plugin C<ted>
3644 The I<TED> plugin connects to a device of "The Energy Detective", a device to
3645 measure power consumption. These devices are usually connected to a serial
3646 (RS232) or USB port. The plugin opens a configured device and tries to read the
3647 current energy readings. For more information on TED, visit
3648 L<http://www.theenergydetective.com/>.
3650 Available configuration options:
3652 =over 4
3654 =item B<Device> I<Path>
3656 Path to the device on which TED is connected. collectd will need read and write
3657 permissions on that file.
3659 Default: B</dev/ttyUSB0>
3661 =item B<Retries> I<Num>
3663 Apparently reading from TED is not that reliable. You can therefore configure a
3664 number of retries here. You only configure the I<retries> here, to if you
3665 specify zero, one reading will be performed (but no retries if that fails); if
3666 you specify three, a maximum of four readings are performed. Negative values
3667 are illegal.
3669 Default: B<0>
3671 =back
3673 =head2 Plugin C<tcpconns>
3675 The C<tcpconns plugin> counts the number of currently established TCP
3676 connections based on the local port and/or the remote port. Since there may be
3677 a lot of connections the default if to count all connections with a local port,
3678 for which a listening socket is opened. You can use the following options to
3679 fine-tune the ports you are interested in:
3681 =over 4
3683 =item B<ListeningPorts> I<true>|I<false>
3685 If this option is set to I<true>, statistics for all local ports for which a
3686 listening socket exists are collected. The default depends on B<LocalPort> and
3687 B<RemotePort> (see below): If no port at all is specifically selected, the
3688 default is to collect listening ports. If specific ports (no matter if local or
3689 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
3690 the selected ports will be collected unless this option is set to I<true>
3691 specifically.
3693 =item B<LocalPort> I<Port>
3695 Count the connections to a specific local port. This can be used to see how
3696 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
3697 You have to specify the port in numeric form, so for the mailserver example
3698 you'd need to set B<25>.
3700 =item B<RemotePort> I<Port>
3702 Count the connections to a specific remote port. This is useful to see how
3703 much a remote service is used. This is most useful if you want to know how many
3704 connections a local service has opened to remote services, e.E<nbsp>g. how many
3705 connections a mail server or news server has to other mail or news servers, or
3706 how many connections a web proxy holds to web servers. You have to give the
3707 port in numeric form.
3709 =back
3711 =head2 Plugin C<thermal>
3713 =over 4
3715 =item B<ForceUseProcfs> I<true>|I<false>
3717 By default, the C<thermal> plugin tries to read the statistics from the Linux
3718 C<sysfs> interface. If that is not available, the plugin falls back to the
3719 C<procfs> interface. By setting this option to I<true>, you can force the
3720 plugin to use the latter. This option defaults to I<false>.
3722 =item B<Device> I<Device>
3724 Selects the name of the thermal device that you want to collect or ignore,
3725 depending on the value of the B<IgnoreSelected> option. This option may be
3726 used multiple times to specify a list of devices.
3728 =item B<IgnoreSelected> I<true>|I<false>
3730 Invert the selection: If set to true, all devices B<except> the ones that
3731 match the device names specified by the B<Device> option are collected. By
3732 default only selected devices are collected if a selection is made. If no
3733 selection is configured at all, B<all> devices are selected.
3735 =back
3737 =head2 Plugin C<tokyotyrant>
3739 The C<tokyotyrant plugin> connects to a TokyoTyrant server and collects a 
3740 couple metrics: number of records, and database size on disk.
3742 =over 4
3744 =item B<Host> I<Hostname/IP>
3746 The hostname or ip which identifies the server.
3747 Default: B<127.0.0.1>
3749 =item B<Port> I<Service/Port>
3751 The query port of the server. This needs to be a string, even if the port is
3752 given in its numeric form.
3753 Default: B<1978>
3755 =back
3757 =head2 Plugin C<unixsock>
3759 =over 4
3761 =item B<SocketFile> I<Path>
3763 Sets the socket-file which is to be created.
3765 =item B<SocketGroup> I<Group>
3767 If running as root change the group of the UNIX-socket after it has been
3768 created. Defaults to B<collectd>.
3770 =item B<SocketPerms> I<Permissions>
3772 Change the file permissions of the UNIX-socket after it has been created. The
3773 permissions must be given as a numeric, octal value as you would pass to
3774 L<chmod(1)>. Defaults to B<0770>.
3776 =back
3778 =head2 Plugin C<uuid>
3780 This plugin, if loaded, causes the Hostname to be taken from the machine's
3781 UUID. The UUID is a universally unique designation for the machine, usually
3782 taken from the machine's BIOS. This is most useful if the machine is running in
3783 a virtual environment such as Xen, in which case the UUID is preserved across
3784 shutdowns and migration.
3786 The following methods are used to find the machine's UUID, in order:
3788 =over 4
3790 =item
3792 Check I</etc/uuid> (or I<UUIDFile>).
3794 =item
3796 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
3797 present.
3799 =item
3801 Check for UUID from C<dmidecode> / SMBIOS.
3803 =item
3805 Check for UUID from Xen hypervisor.
3807 =back
3809 If no UUID can be found then the hostname is not modified.
3811 =over 4
3813 =item B<UUIDFile> I<Path>
3815 Take the UUID from the given file (default I</etc/uuid>).
3817 =back
3819 =head2 Plugin C<vmem>
3821 The C<vmem> plugin collects information about the usage of virtual memory.
3822 Since the statistics provided by the Linux kernel are very detailed, they are
3823 collected very detailed. However, to get all the details, you have to switch
3824 them on manually. Most people just want an overview over, such as the number of
3825 pages read from swap space.
3827 =over 4
3829 =item B<Verbose> B<true>|B<false>
3831 Enables verbose collection of information. This will start collecting page
3832 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
3833 Part of these statistics are collected on a "per zone" basis.
3835 =back
3837 =head2 Plugin C<vserver>
3839 This plugin doesn't have any options. B<VServer> support is only available for
3840 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
3841 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
3842 need to apply the patches and compile your own kernel, which will then provide
3843 the F</proc/virtual> filesystem that is required by this plugin.
3845 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
3847 B<Note>: The traffic collected by this plugin accounts for the amount of
3848 traffic passing a socket which might be a lot less than the actual on-wire
3849 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
3850 collect on-wire traffic you could, for example, use the logging facilities of
3851 iptables to feed data for the guest IPs into the iptables plugin.
3853 =head2 Plugin C<write_http>
3855 This output plugin submits values to an http server by POST them using the
3856 PUTVAL plain-text protocol. Each destination you want to post data to needs to
3857 have one B<URL> block, within which the destination can be configured further,
3858 for example by specifying authentication data.
3860 Synopsis:
3862  <Plugin "write_http">
3863    <URL "http://example.com/post-collectd">
3864      User "collectd"
3865      Password "weCh3ik0"
3866    </URL>
3867  </Plugin>
3869 B<URL> blocks need one string argument which is used as the URL to which data
3870 is posted. The following options are understood within B<URL> blocks.
3872 =over 4
3874 =item B<User> I<Username>
3876 Optional user name needed for authentication.
3878 =item B<Password> I<Password>
3880 Optional password needed for authentication.
3882 =item B<VerifyPeer> B<true>|B<false>
3884 Enable or disable peer SSL certificate verification. See
3885 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3887 =item B<VerifyHost> B<true|false>
3889 Enable or disable peer host name verification. If enabled, the plugin checks if
3890 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
3891 matches the host name provided by the B<URL> option. If this identity check
3892 fails, the connection is aborted. Obviously, only works when connecting to a
3893 SSL enabled server. Enabled by default.
3895 =item B<CACert> I<File>
3897 File that holds one or more SSL certificates. If you want to use HTTPS you will
3898 possibly need this option. What CA certificates come bundled with C<libcurl>
3899 and are checked by default depends on the distribution you use.
3901 =item B<Format> B<Command>|B<JSON>
3903 Format of the output to generate. If set to B<Command>, will create output that
3904 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
3905 create output in the I<JavaScript Object Notation> (JSON).
3907 Defaults to B<Command>.
3909 =back
3911 =head1 THRESHOLD CONFIGURATION
3913 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
3914 we mean that the values are not only stored or sent somewhere, but that they
3915 are judged and, if a problem is recognized, acted upon. The only action
3916 collectd takes itself is to generate and dispatch a "notification". Plugins can
3917 register to receive notifications and perform appropriate further actions.
3919 Since systems and what you expect them to do differ a lot, you can configure
3920 B<thresholds> for your values freely. This gives you a lot of flexibility but
3921 also a lot of responsibility.
3923 Every time a value is out of range a notification is dispatched. This means
3924 that the idle percentage of your CPU needs to be less then the configured
3925 threshold only once for a notification to be generated. There's no such thing
3926 as a moving average or similar - at least not now.
3928 Also, all values that match a threshold are considered to be relevant or
3929 "interesting". As a consequence collectd will issue a notification if they are
3930 not received for twice the last timeout of the values. If, for example, some
3931 hosts sends it's CPU statistics to the server every 60 seconds, a notification
3932 will be dispatched after about 120 seconds. It may take a little longer because
3933 the timeout is checked only once each B<Interval> on the server.
3935 When a value comes within range again or is received after it was missing, an
3936 "OKAY-notification" is dispatched.
3938 Here is a configuration example to get you started. Read below for more
3939 information.
3941  <Threshold>
3942    <Type "foo">
3943      WarningMin    0.00
3944      WarningMax 1000.00
3945      FailureMin    0.00
3946      FailureMax 1200.00
3947      Invert false
3948      Instance "bar"
3949    </Type>
3951    <Plugin "interface">
3952      Instance "eth0"
3953      <Type "if_octets">
3954        FailureMax 10000000
3955        DataSource "rx"
3956      </Type>
3957    </Plugin>
3959    <Host "hostname">
3960      <Type "cpu">
3961        Instance "idle"
3962        FailureMin 10
3963      </Type>
3965      <Plugin "memory">
3966        <Type "memory">
3967          Instance "cached"
3968          WarningMin 100000000
3969        </Type>
3970      </Plugin>
3971    </Host>
3972  </Threshold>
3974 There are basically two types of configuration statements: The C<Host>,
3975 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
3976 configured. The C<Plugin> and C<Type> blocks may be specified further using the
3977 C<Instance> option. You can combine the block by nesting the blocks, though
3978 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
3979 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
3980 C<Type> may not contain other blocks. If multiple blocks apply to the same
3981 value the most specific block is used.
3983 The other statements specify the threshold to configure. They B<must> be
3984 included in a C<Type> block. Currently the following statements are recognized:
3986 =over 4
3988 =item B<FailureMax> I<Value>
3990 =item B<WarningMax> I<Value>
3992 Sets the upper bound of acceptable values. If unset defaults to positive
3993 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
3994 will be created. If the value is greater than B<WarningMax> but less than (or
3995 equal to) B<FailureMax> a B<WARNING> notification will be created.
3997 =item B<FailureMin> I<Value>
3999 =item B<WarningMin> I<Value>
4001 Sets the lower bound of acceptable values. If unset defaults to negative
4002 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
4003 be created. If the value is less than B<WarningMin> but greater than (or equal
4004 to) B<FailureMin> a B<WARNING> notification will be created.
4006 =item B<DataSource> I<DSName>
4008 Some data sets have more than one "data source". Interesting examples are the
4009 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
4010 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
4011 system load data set, C<load>, even has three data sources: C<shortterm>,
4012 C<midterm>, and C<longterm>.
4014 Normally, all data sources are checked against a configured threshold. If this
4015 is undesirable, or if you want to specify different limits for each data
4016 source, you can use the B<DataSource> option to have a threshold apply only to
4017 one data source.
4019 =item B<Invert> B<true>|B<false>
4021 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
4022 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
4023 B<WarningMax>) are not okay. Defaults to B<false>.
4025 =item B<Persist> B<true>|B<false>
4027 Sets how often notifications are generated. If set to B<true> one notification
4028 will be generated for each value that is out of the acceptable range. If set to
4029 B<false> (the default) then a notification is only generated if a value is out
4030 of range but the previous value was okay.
4032 This applies to missing values, too: If set to B<true> a notification about a
4033 missing value is generated once every B<Interval> seconds. If set to B<false>
4034 only one such notification is generated until the value appears again.
4036 =item B<Percentage> B<true>|B<false>
4038 If set to B<true>, the minimum and maximum values given are interpreted as
4039 percentage value, relative to the other data sources. This is helpful for
4040 example for the "df" type, where you may want to issue a warning when less than
4041 5E<nbsp>% of the total space is available. Defaults to B<false>.
4043 =back
4045 =head1 FILTER CONFIGURATION
4047 Starting with collectd 4.6 there is a powerful filtering infrastructure
4048 implemented in the daemon. The concept has mostly been copied from
4049 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
4050 terminology, so that users that are familiar with iptables feel right at home.
4052 =head2 Terminology
4054 The following are the terms used in the remainder of the filter configuration
4055 documentation. For an ASCII-art schema of the mechanism, see
4056 L<"General structure"> below.
4058 =over 4
4060 =item B<Match>
4062 A I<match> is a criteria to select specific values. Examples are, of course, the
4063 name of the value or it's current value.
4065 Matches are implemented in plugins which you have to load prior to using the
4066 match. The name of such plugins starts with the "match_" prefix.
4068 =item B<Target>
4070 A I<target> is some action that is to be performed with data. Such actions
4071 could, for example, be to change part of the value's identifier or to ignore
4072 the value completely.
4074 Some of these targets are built into the daemon, see L<"Built-in targets">
4075 below. Other targets are implemented in plugins which you have to load prior to
4076 using the target. The name of such plugins starts with the "target_" prefix.
4078 =item B<Rule>
4080 The combination of any number of matches and at least one target is called a
4081 I<rule>. The target actions will be performed for all values for which B<all>
4082 matches apply. If the rule does not have any matches associated with it, the
4083 target action will be performed for all values.
4085 =item B<Chain>
4087 A I<chain> is a list of rules and possibly default targets. The rules are tried
4088 in order and if one matches, the associated target will be called. If a value
4089 is handled by a rule, it depends on the target whether or not any subsequent
4090 rules are considered or if traversal of the chain is aborted, see
4091 L<"Flow control"> below. After all rules have been checked, the default targets
4092 will be executed.
4094 =back
4096 =head2 General structure
4098 The following shows the resulting structure:
4100  +---------+
4101  ! Chain   !
4102  +---------+
4103       !
4104       V
4105  +---------+  +---------+  +---------+  +---------+
4106  ! Rule    !->! Match   !->! Match   !->! Target  !
4107  +---------+  +---------+  +---------+  +---------+
4108       !
4109       V
4110  +---------+  +---------+  +---------+
4111  ! Rule    !->! Target  !->! Target  !
4112  +---------+  +---------+  +---------+
4113       !
4114       V
4115       :
4116       :
4117       !
4118       V
4119  +---------+  +---------+  +---------+
4120  ! Rule    !->! Match   !->! Target  !
4121  +---------+  +---------+  +---------+
4122       !
4123       V
4124  +---------+
4125  ! Default !
4126  ! Target  !
4127  +---------+
4129 =head2 Flow control
4131 There are four ways to control which way a value takes through the filter
4132 mechanism:
4134 =over 4
4136 =item B<jump>
4138 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
4139 process the value with another chain. When the called chain finishes, usually
4140 the next target or rule after the jump is executed.
4142 =item B<stop>
4144 The stop condition, signaled for example by the built-in target B<stop>, causes
4145 all processing of the value to be stopped immediately.
4147 =item B<return>
4149 Causes processing in the current chain to be aborted, but processing of the
4150 value generally will continue. This means that if the chain was called via
4151 B<Jump>, the next target or rule after the jump will be executed. If the chain
4152 was not called by another chain, control will be returned to the daemon and it
4153 may pass the value to another chain.
4155 =item B<continue>
4157 Most targets will signal the B<continue> condition, meaning that processing
4158 should continue normally. There is no special built-in target for this
4159 condition.
4161 =back
4163 =head2 Synopsis
4165 The configuration reflects this structure directly:
4167  PostCacheChain "PostCache"
4168  <Chain "PostCache">
4169    <Rule "ignore_mysql_show">
4170      <Match "regex">
4171        Plugin "^mysql$"
4172        Type "^mysql_command$"
4173        TypeInstance "^show_"
4174      </Match>
4175      <Target "stop">
4176      </Target>
4177    </Rule>
4178    <Target "write">
4179      Plugin "rrdtool"
4180    </Target>
4181  </Chain>
4183 The above configuration example will ignore all values where the plugin field
4184 is "mysql", the type is "mysql_command" and the type instance begins with
4185 "show_". All other values will be sent to the C<rrdtool> write plugin via the
4186 default target of the chain. Since this chain is run after the value has been
4187 added to the cache, the MySQL C<show_*> command statistics will be available
4188 via the C<unixsock> plugin.
4190 =head2 List of configuration options
4192 =over 4
4194 =item B<PreCacheChain> I<ChainName>
4196 =item B<PostCacheChain> I<ChainName>
4198 Configure the name of the "pre-cache chain" and the "post-cache chain". The
4199 argument is the name of a I<chain> that should be executed before and/or after
4200 the values have been added to the cache.
4202 To understand the implications, it's important you know what is going on inside
4203 I<collectd>. The following diagram shows how values are passed from the
4204 read-plugins to the write-plugins:
4206    +---------------+
4207    !  Read-Plugin  !
4208    +-------+-------+
4209            !
4210  + - - - - V - - - - +
4211  : +---------------+ :
4212  : !   Pre-Cache   ! :
4213  : !     Chain     ! :
4214  : +-------+-------+ :
4215  :         !         :
4216  :         V         :
4217  : +-------+-------+ :  +---------------+
4218  : !     Cache     !--->!  Value Cache  !
4219  : !     insert    ! :  +---+---+-------+
4220  : +-------+-------+ :      !   !
4221  :         !   ,------------'   !
4222  :         V   V     :          V
4223  : +-------+---+---+ :  +-------+-------+
4224  : !  Post-Cache   +--->! Write-Plugins !
4225  : !     Chain     ! :  +---------------+
4226  : +---------------+ :
4227  :                   :
4228  :  dispatch values  :
4229  + - - - - - - - - - +
4231 After the values are passed from the "read" plugins to the dispatch functions,
4232 the pre-cache chain is run first. The values are added to the internal cache
4233 afterwards. The post-cache chain is run after the values have been added to the
4234 cache. So why is it such a huge deal if chains are run before or after the
4235 values have been added to this cache?
4237 Targets that change the identifier of a value list should be executed before
4238 the values are added to the cache, so that the name in the cache matches the
4239 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
4240 this cache to receive a list of all available values. If you change the
4241 identifier after the value list has been added to the cache, this may easily
4242 lead to confusion, but it's not forbidden of course.
4244 The cache is also used to convert counter values to rates. These rates are, for
4245 example, used by the C<value> match (see below). If you use the rate stored in
4246 the cache B<before> the new value is added, you will use the old, B<previous>
4247 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
4248 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
4249 command.
4251 Last but not last, the B<stop> target makes a difference: If the pre-cache
4252 chain returns the stop condition, the value will not be added to the cache and
4253 the post-cache chain will not be run.
4255 =item B<Chain> I<Name>
4257 Adds a new chain with a certain name. This name can be used to refer to a
4258 specific chain, for example to jump to it.
4260 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
4262 =item B<Rule> [I<Name>]
4264 Adds a new rule to the current chain. The name of the rule is optional and
4265 currently has no meaning for the daemon.
4267 Within the B<Rule> block, there may be any number of B<Match> blocks and there
4268 must be at least one B<Target> block.
4270 =item B<Match> I<Name>
4272 Adds a match to a B<Rule> block. The name specifies what kind of match should
4273 be performed. Available matches depend on the plugins that have been loaded.
4275 The arguments inside the B<Match> block are passed to the plugin implementing
4276 the match, so which arguments are valid here depends on the plugin being used.
4277 If you do not need any to pass any arguments to a match, you can use the
4278 shorter syntax:
4280  Match "foobar"
4282 Which is equivalent to:
4284  <Match "foobar">
4285  </Match>
4287 =item B<Target> I<Name>
4289 Add a target to a rule or a default target to a chain. The name specifies what
4290 kind of target is to be added. Which targets are available depends on the
4291 plugins being loaded.
4293 The arguments inside the B<Target> block are passed to the plugin implementing
4294 the target, so which arguments are valid here depends on the plugin being used.
4295 If you do not need any to pass any arguments to a target, you can use the
4296 shorter syntax:
4298  Target "stop"
4300 This is the same as writing:
4302  <Target "stop">
4303  </Target>
4305 =back
4307 =head2 Built-in targets 
4309 The following targets are built into the core daemon and therefore need no
4310 plugins to be loaded:
4312 =over 4
4314 =item B<return>
4316 Signals the "return" condition, see the L<"Flow control"> section above. This
4317 causes the current chain to stop processing the value and returns control to
4318 the calling chain. The calling chain will continue processing targets and rules
4319 just after the B<jump> target (see below). This is very similar to the
4320 B<RETURN> target of iptables, see L<iptables(8)>.
4322 This target does not have any options.
4324 Example:
4326  Target "return"
4328 =item B<stop>
4330 Signals the "stop" condition, see the L<"Flow control"> section above. This
4331 causes processing of the value to be aborted immediately. This is similar to
4332 the B<DROP> target of iptables, see L<iptables(8)>.
4334 This target does not have any options.
4336 Example:
4338  Target "stop"
4340 =item B<write>
4342 Sends the value to "write" plugins.
4344 Available options:
4346 =over 4
4348 =item B<Plugin> I<Name>
4350 Name of the write plugin to which the data should be sent. This option may be
4351 given multiple times to send the data to more than one write plugin.
4353 =back
4355 If no plugin is explicitly specified, the values will be sent to all available
4356 write plugins.
4358 Example:
4360  <Target "write">
4361    Plugin "rrdtool"
4362  </Target>
4364 =item B<jump>
4366 Starts processing the rules of another chain, see L<"Flow control"> above. If
4367 the end of that chain is reached, or a stop condition is encountered,
4368 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
4369 next target or the next rule. This is similar to the B<-j> command line option
4370 of iptables, see L<iptables(8)>.
4372 Available options:
4374 =over 4
4376 =item B<Chain> I<Name>
4378 Jumps to the chain I<Name>. This argument is required and may appear only once.
4380 =back
4382 Example:
4384  <Target "jump">
4385    Chain "foobar"
4386  </Target>
4388 =back
4390 =head2 Available matches
4392 =over 4
4394 =item B<regex>
4396 Matches a value using regular expressions.
4398 Available options:
4400 =over 4
4402 =item B<Host> I<Regex>
4404 =item B<Plugin> I<Regex>
4406 =item B<PluginInstance> I<Regex>
4408 =item B<Type> I<Regex>
4410 =item B<TypeInstance> I<Regex>
4412 Match values where the given regular expressions match the various fields of
4413 the identifier of a value. If multiple regular expressions are given, B<all>
4414 regexen must match for a value to match.
4416 =back
4418 Example:
4420  <Match "regex">
4421    Host "customer[0-9]+"
4422    Plugin "^foobar$"
4423  </Match>
4425 =item B<timediff>
4427 Matches values that have a time which differs from the time on the server.
4429 This match is mainly intended for servers that receive values over the
4430 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
4431 is very sensitive to the timestamp used when updating the RRD files. In
4432 particular, the time must be ever increasing. If a misbehaving client sends one
4433 packet with a timestamp far in the future, all further packets with a correct
4434 time will be ignored because of that one packet. What's worse, such corrupted
4435 RRD files are hard to fix.
4437 This match lets one match all values B<outside> a specified time range
4438 (relative to the server's time), so you can use the B<stop> target (see below)
4439 to ignore the value, for example.
4441 Available options:
4443 =over 4
4445 =item B<Future> I<Seconds>
4447 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
4448 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
4449 non-zero.
4451 =item B<Past> I<Seconds>
4453 Matches all values that are I<behind> of the server's time by I<Seconds> or
4454 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
4455 non-zero.
4457 =back
4459 Example:
4461  <Match "timediff">
4462    Future  300
4463    Past   3600
4464  </Match>
4466 This example matches all values that are five minutes or more ahead of the
4467 server or one hour (or more) lagging behind.
4469 =item B<value>
4471 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
4472 values. If a data-set consists of more than one data-source, all data-sources
4473 must match the specified ranges for a positive match.
4475 Available options:
4477 =over 4
4479 =item B<Min> I<Value>
4481 Sets the smallest value which still results in a match. If unset, behaves like
4482 negative infinity.
4484 =item B<Max> I<Value>
4486 Sets the largest value which still results in a match. If unset, behaves like
4487 positive infinity.
4489 =item B<Invert> B<true>|B<false>
4491 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
4492 no-match is returned and vice versa. Please note that the B<Invert> setting
4493 only effects how B<Min> and B<Max> are applied to a specific value. Especially
4494 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
4496 =item B<DataSource> I<DSName> [I<DSName> ...]
4498 Select one or more of the data sources. If no data source is configured, all
4499 data sources will be checked. If the type handled by the match does not have a
4500 data source of the specified name(s), this will always result in no match
4501 (independent of the B<Invert> setting).
4503 =item B<Satisfy> B<Any>|B<All>
4505 Specifies how checking with several data sources is performed. If set to
4506 B<Any>, the match succeeds if one of the data sources is in the configured
4507 range. If set to B<All> the match only succeeds if all data sources are within
4508 the configured range. Default is B<All>.
4510 Usually B<All> is used for positive matches, B<Any> is used for negative
4511 matches. This means that with B<All> you usually check that all values are in a
4512 "good" range, while with B<Any> you check if any value is within a "bad" range
4513 (or outside the "good" range).
4515 =back
4517 Either B<Min> or B<Max>, but not both, may be unset.
4519 Example:
4521  # Match all values smaller than or equal to 100. Matches only if all data
4522  # sources are below 100.
4523  <Match "value">
4524    Max 100
4525    Satisfy "All"
4526  </Match>
4527  
4528  # Match if the value of any data source is outside the range of 0 - 100.
4529  <Match "value">
4530    Min   0
4531    Max 100
4532    Invert true
4533    Satisfy "Any"
4534  </Match>
4536 =item B<empty_counter>
4538 Matches all values with one or more data sources of type B<COUNTER> and where
4539 all counter values are zero. These counters usually I<never> increased since
4540 they started existing (and are therefore uninteresting), or got reset recently
4541 or overflowed and you had really, I<really> bad luck.
4543 Please keep in mind that ignoring such counters can result in confusing
4544 behavior: Counters which hardly ever increase will be zero for long periods of
4545 time. If the counter is reset for some reason (machine or service restarted,
4546 usually), the graph will be empty (NAN) for a long time. People may not
4547 understand why.
4549 =back
4551 =head2 Available targets
4553 =over 4
4555 =item B<notification>
4557 Creates and dispatches a notification.
4559 Available options:
4561 =over 4
4563 =item B<Message> I<String>
4565 This required option sets the message of the notification. The following
4566 placeholders will be replaced by an appropriate value:
4568 =over 4
4570 =item B<%{host}>
4572 =item B<%{plugin}>
4574 =item B<%{plugin_instance}>
4576 =item B<%{type}>
4578 =item B<%{type_instance}>
4580 These placeholders are replaced by the identifier field of the same name.
4582 =item B<%{ds:>I<name>B<}>
4584 These placeholders are replaced by a (hopefully) human readable representation
4585 of the current rate of this data source. If you changed the instance name
4586 (using the B<set> or B<replace> targets, see below), it may not be possible to
4587 convert counter values to rates.
4589 =back
4591 Please note that these placeholders are B<case sensitive>!
4593 =item B<Severity> B<"FATAL">|B<"WARNING">|B<"OKAY">
4595 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
4596 used.
4598 =back
4600 Example:
4602   <Target "notification">
4603     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
4604     Severity "WARNING"
4605   </Target>
4607 =item B<replace>
4609 Replaces parts of the identifier using regular expressions.
4611 Available options:
4613 =over 4
4615 =item B<Host> I<Regex> I<Replacement>
4617 =item B<Plugin> I<Regex> I<Replacement>
4619 =item B<PluginInstance> I<Regex> I<Replacement>
4621 =item B<TypeInstance> I<Regex> I<Replacement>
4623 Match the appropriate field with the given regular expression I<Regex>. If the
4624 regular expression matches, that part that matches is replaced with
4625 I<Replacement>. If multiple places of the input buffer match a given regular
4626 expression, only the first occurrence will be replaced.
4628 You can specify each option multiple times to use multiple regular expressions
4629 one after another.
4631 =back
4633 Example:
4635  <Target "replace">
4636    # Replace "example.net" with "example.com"
4637    Host "\\<example.net\\>" "example.com"
4638  
4639    # Strip "www." from hostnames
4640    Host "\\<www\\." ""
4641  </Target>
4643 =item B<set>
4645 Sets part of the identifier of a value to a given string.
4647 Available options:
4649 =over 4
4651 =item B<Host> I<String>
4653 =item B<Plugin> I<String>
4655 =item B<PluginInstance> I<String>
4657 =item B<TypeInstance> I<String>
4659 Set the appropriate field to the given string. The strings for plugin instance
4660 and type instance may be empty, the strings for host and plugin may not be
4661 empty. It's currently not possible to set the type of a value this way.
4663 =back
4665 Example:
4667  <Target "set">
4668    PluginInstance "coretemp"
4669    TypeInstance "core3"
4670  </Target>
4672 =back
4674 =head2 Backwards compatibility
4676 If you use collectd with an old configuration, i.E<nbsp>e. one without a
4677 B<Chain> block, it will behave as it used to. This is equivalent to the
4678 following configuration:
4680  <Chain "PostCache">
4681    Target "write"
4682  </Chain>
4684 If you specify a B<PostCacheChain>, the B<write> target will not be added
4685 anywhere and you will have to make sure that it is called where appropriate. We
4686 suggest to add the above snippet as default target to your "PostCache" chain.
4688 =head2 Examples
4690 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
4691 be an FQDN.
4693  <Chain "PreCache">
4694    <Rule "no_fqdn">
4695      <Match "regex">
4696        Host "^[^\.]*$"
4697      </Match>
4698      Target "stop"
4699    </Rule>
4700    Target "write"
4701  </Chain>
4703 =head1 SEE ALSO
4705 L<collectd(1)>,
4706 L<collectd-exec(5)>,
4707 L<collectd-perl(5)>,
4708 L<collectd-unixsock(5)>,
4709 L<types.db(5)>,
4710 L<hddtemp(8)>,
4711 L<iptables(8)>,
4712 L<kstat(3KSTAT)>,
4713 L<mbmon(1)>,
4714 L<psql(1)>,
4715 L<regex(7)>,
4716 L<rrdtool(1)>,
4717 L<sensors(1)>
4719 =head1 AUTHOR
4721 Florian Forster E<lt>octo@verplant.orgE<gt>
4723 =cut