collectd.conf(5): Added a missing </RegEx> to the configuration example.
[collectd.git] / src / collectd.conf.pod
1 =head1 NAME
2
3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
4
5 =head1 SYNOPSIS
6
7   BaseDir "/path/to/data/"
8   PIDFile "/path/to/pidfile/collectd.pid"
9   Server  "123.123.123.123" 12345
10
11   LoadPlugin cpu
12   LoadPlugin load
13   LoadPlugin ping
14
15   <Plugin ping>
16     Host "example.org"
17     Host "provider.net"
18   </Plugin>
19
20 =head1 DESCRIPTION
21
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.
26
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.
38
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.
44
45 =head1 GLOBAL OPTIONS
46
47 =over 4
48
49 =item B<BaseDir> I<Directory>
50
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.
54
55 =item B<LoadPlugin> I<Plugin>
56
57 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
58 will be mostly useless.
59
60 =item B<Include> I<Path>
61
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:
67
68   Include "/etc/collectd.d/*.conf"
69
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.
74
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.
80
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.
83
84 =item B<PIDFile> I<File>
85
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.
89
90 =item B<PluginDir> I<Directory>
91
92 Path to the plugins (shared objects) of collectd.
93
94 =item B<TypesDB> I<File> [I<File> ...]
95
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.
98
99 =item B<Interval> I<Seconds>
100
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.
104
105 =item B<ReadThreads> I<Num>
106
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.
111
112 =item B<Hostname> I<Name>
113
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.
116
117 =item B<FQDNLookup> B<true|false>
118
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>.
122
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.
128
129 =back
130
131 =head1 PLUGIN OPTIONS
132
133 Some plugins may register own options. These options must be enclosed in a
134 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
135 require external configuration, too. The C<apache plugin>, for example,
136 required C<mod_status> to be configured in the webserver you're going to
137 collect data from. These plugins are listed below as well, even if they don't
138 require any configuration within collectd's configfile.
139
140 A list of all plugins and a short summary for each plugin can be found in the
141 F<README> file shipped with the sourcecode and hopefully binary packets as
142 well.
143
144 =head2 Plugin C<apache>
145
146 To configure the C<apache>-plugin you first need to configure the Apache
147 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
148 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
149 the following snipped to base your Apache config upon:
150
151   ExtendedStatus on
152   <IfModule mod_status.c>
153     <Location /mod_status>
154       SetHandler server-status
155     </Location>
156   </IfModule>
157
158 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
159 also supported. It introduces a new field, called C<BusyServers>, to count the
160 number of currently connected clients. This field is also supported.
161
162 The following options are accepted by the C<apache>-plugin:
163
164 =over 4
165
166 =item B<URL> I<http://host/mod_status?auto>
167
168 Sets the URL of the C<mod_status> output. This needs to be the output generated
169 by C<ExtendedStatus on> and it needs to be the machine readable output
170 generated by appending the C<?auto> argument.
171
172 =item B<User> I<Username>
173
174 Optional user name needed for authentication.
175
176 =item B<Password> I<Password>
177
178 Optional password needed for authentication.
179
180 =item B<VerifyPeer> B<true|false>
181
182 Enable or disable peer SSL certificate verification. See
183 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
184
185 =item B<VerifyHost> B<true|false>
186
187 Enable or disable peer host name verification. If enabled, the plugin checks
188 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
189 certificate matches the host name provided by the B<URL> option. If this
190 identity check fails, the connection is aborted. Obviously, only works when
191 connecting to a SSL enabled server. Enabled by default.
192
193 =item B<CACert> I<File>
194
195 File that holds one or more SSL certificates. If you want to use HTTPS you will
196 possibly need this option. What CA certificates come bundled with C<libcurl>
197 and are checked by default depends on the distribution you use.
198
199 =back
200
201 =head2 Plugin C<apcups>
202
203 =over 4
204
205 =item B<Host> I<Hostname>
206
207 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
208 that IPv6 support has been disabled unless someone can confirm or decline that
209 B<apcupsd> can handle it.
210
211 =item B<Port> I<Port>
212
213 TCP-Port to connect to. Defaults to B<3551>.
214
215 =back
216
217 =head2 Plugin C<ascent>
218
219 This plugin collects information about an Ascent server, a free server for the
220 "World of Warcraft" game. This plugin gathers the information by fetching the
221 XML status page using C<libcurl> and parses it using C<libxml2>.
222
223 The configuration options are the same as for the C<apache> plugin above:
224
225 =over 4
226
227 =item B<URL> I<http://localhost/ascent/status/>
228
229 Sets the URL of the XML status output.
230
231 =item B<User> I<Username>
232
233 Optional user name needed for authentication.
234
235 =item B<Password> I<Password>
236
237 Optional password needed for authentication.
238
239 =item B<VerifyPeer> B<true|false>
240
241 Enable or disable peer SSL certificate verification. See
242 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
243
244 =item B<VerifyHost> B<true|false>
245
246 Enable or disable peer host name verification. If enabled, the plugin checks
247 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
248 certificate matches the host name provided by the B<URL> option. If this
249 identity check fails, the connection is aborted. Obviously, only works when
250 connecting to a SSL enabled server. Enabled by default.
251
252 =item B<CACert> I<File>
253
254 File that holds one or more SSL certificates. If you want to use HTTPS you will
255 possibly need this option. What CA certificates come bundled with C<libcurl>
256 and are checked by default depends on the distribution you use.
257
258 =back
259
260 =head2 Plugin C<cpufreq>
261
262 This plugin doesn't have any options. It reads
263 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
264 installed) to get the current CPU frequency. If this file does not exist make
265 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
266 installed and an "cpu governor" (that's a kernel module) is loaded.
267
268 =head2 Plugin C<csv>
269
270 =over 4
271
272 =item B<DataDir> I<Directory>
273
274 Set the directory to store CSV-files under. Per default CSV-files are generated
275 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
276
277 =item B<StoreRates> B<true|false>
278
279 If set to B<true>, convert counter values to rates. If set to B<false> (the
280 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
281 number.
282
283 =back
284
285 =head2 Plugin C<dbi>
286
287 This plugin uses the "B<dbi>" library (L<http://libdbi.sourceforge.net/>) to
288 connect to various databases, execute SQL statements and read back the results.
289 You can configure how each column is to be interpreted and the plugin will
290 generate one data set from each row returned according to these rules.
291
292 Because the plugin is very generic, the configuration is a little more complex
293 than those of other plugins. It usually looks something like this:
294
295   <Plugin dbi>
296     <Query "out_of_stock">
297       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
298       Type "gauge"
299       InstancesFrom "category"
300       ValuesFrom "value"
301     </Query>
302     <Database "product_information">
303       Driver "mysql"
304       DriverOption "host" "localhost"
305       DriverOption "username" "collectd"
306       DriverOption "password" "aZo6daiw"
307       DriverOption "dbname" "prod_info"
308       SelectDB "prod_info"
309       Query "out_of_stock"
310     </Database>
311   </Plugin>
312
313 The configuration above defines one query and one database. The query is then
314 linked to the database with the B<Query> option I<within> the
315 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
316 and you can also use the B<Include> statement to split up the configuration
317 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
318 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
319 top to bottom!
320
321 The following is a complete list of options:
322
323 =head3 B<Query> blocks
324
325 Query blocks define SQL statements and how the returned data should be
326 interpreted. They are identified by the name that is given in the opening line
327 of the block. Thus the name needs to be unique. Other than that, the name is
328 not used in collectd.
329
330 =over 4
331
332 =item B<Statement> I<SQL>
333
334 Sets the statement that should be executed on the server. This is B<not>
335 interpreted by collectd, but simply passed to the database server. Therefore,
336 the SQL dialect that's used depends on the server collectd is connected to.
337
338 The query has to return at least two columns, one for the instance and one
339 value. You cannot omit the instance, even if the statement is guaranteed to
340 always return exactly one line. In that case, you can usually specify something
341 like this:
342
343   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
344
345 (That works with MySQL but may not be valid SQL according to the spec. If you
346 use a more strict database server, you may have to select from a dummy table or
347 something.)
348
349 =item B<Type> I<Type>
350
351 The B<type> that's used for each line returned. See L<types.db(5)> for more
352 details on how types are defined. In short: A type is a predefined layout of
353 data and the number of values and type of values has to match the type
354 definition.
355
356 If you specify "temperature" here, you need exactly one gauge column. If you
357 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
358 setting below.
359
360 =item B<InstancesFrom> I<column0> [I<column1> ...]
361
362 Specifies the columns whose values will be used to create the "TypeInstance"
363 for each row. You need to specify at least one column for each query. If you
364 specify more than one column, the value of all columns will be join together
365 with the hyphen as separation character.
366
367 The plugin itself does not check whether or not all built instances are
368 different. It's your responsibility to assure that each is unique.
369
370 =item B<ValuesFrom> I<column0> [I<column1> ...]
371
372 Names the columns whose content is used as the actual data for the data sets
373 that are dispatched to the daemon. How many such columns you need is determined
374 by the B<Type> setting above. If you specify too many or not enough columns,
375 the plugin will complain about that and no data will be submitted to the
376 daemon.
377
378 The actual data type in the columns is not that important. The plugin will
379 automatically cast the values to the right type if it know how to do that. So
380 it should be able to handle integer an floating point types, as well as strings
381 (if they include a number at the beginning).
382
383 =back
384
385 =head3 B<Database> blocks
386
387 Database blocks define a connection to a database and which queries should be
388 sent to that database. Since the used "dbi" library can handle a wide variety
389 of databases, the configuration is very generic. If in doubt, refer to libdbi's
390 documentationE<nbsp>- we stick as close to the terminology used there.
391
392 Each database needs a "name" as string argument in the starting tag of the
393 block. This name will be used as "PluginInstance" in the values submitted to
394 the daemon. Other than that, that name is not used.
395
396 =over 4
397
398 =item B<Driver> I<Driver>
399
400 Specifies the driver to use to connect to the database. In many cases those
401 drivers are named after the database they can connect to, but this is not a
402 technical necessity. These drivers are sometimes referred to as "DBD",
403 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
404 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
405 project at L<http://libdbi-drivers.sourceforge.net/>.
406
407 You need to give the driver name as expected by the "dbi" library here. You
408 should be able to find that in the documentation for each driver. If you
409 mistype the driver name, the plugin will dump a list of all known driver names
410 to the log.
411
412 =item B<DriverOption> I<Key> I<Value>
413
414 Sets driver-specific options. What option a driver supports can be found in the
415 documentation for each driver, somewhere at
416 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
417 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
418
419 Unfortunately, drivers are not too keen to report errors when an unknown option
420 is passed to them, so invalid settings here may go unnoticed. This is not the
421 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
422 the driver. If a driver complains about an option, the plugin will dump a
423 complete list of all options understood by that driver to the log.
424
425 =item B<SelectDB> I<Database>
426
427 In some cases, the database name you connect with is not the database name you
428 want to use for querying data. If this option is set, the plugin will "select"
429 (switch to) that database after the connection is established.
430
431 =item B<Query> I<QueryName>
432
433 Associates the query named I<QueryName> with this database connection. The
434 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
435 blocks you want to refer to must be placed above the database block you want to
436 refer to them from.
437
438 =back
439
440 =head2 Plugin C<df>
441
442 =over 4
443
444 =item B<Device> I<Device>
445
446 Select partitions based on the devicename.
447
448 =item B<MountPoint> I<Directory>
449
450 Select partitions based on the mountpoint.
451
452 =item B<FSType> I<FSType>
453
454 Select partitions based on the filesystem type.
455
456 =item B<IgnoreSelected> I<true>|I<false>
457
458 Invert the selection: If set to true, all partitions B<except> the ones that
459 match any one of the criteria are collected. By default only selected
460 partitions are collected if a selection is made. If no selection is configured
461 at all, B<all> partitions are selected.
462
463 =back
464
465 =head2 Plugin C<disk>
466
467 The C<disk> plugin collects information about the usage of physical disks and
468 logical disks (partitions). Values collected are the number of octets written
469 to and read from a disk or partition, the number of read/write operations
470 issued to the disk and a rather complex "time" it took for these commands to be
471 issued.
472
473 Using the following two options you can ignore some disks or configure the
474 collection only of specific disks.
475
476 =over 4
477
478 =item B<Disk> I<Name>
479
480 Select the disk I<Name>. Whether it is collected or ignored depends on the
481 B<IgnoreSelected> setting, see below. As with other plugins that use the
482 daemon's ignorelist functionality, a string that starts and ends with a slash
483 is interpreted as a regular expression. Examples:
484
485   Disk "sdd"
486   Disk "/hda[34]/"
487
488 =item B<IgnoreSelected> B<true>|B<false>
489
490 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
491 statements, are ignored or if all other disks are ignored. The behavior
492 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
493 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
494 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
495 is set to B<true>, all disks are collected B<except> the ones matched.
496
497 =back
498
499 =head2 Plugin C<dns>
500
501 =over 4
502
503 =item B<Interface> I<Interface>
504
505 The dns plugin uses B<libpcap> to capture dns traffic and analyses it. This
506 option sets the interface that should be used. If this option is not set, or
507 set to "any", the plugin will try to get packets from B<all> interfaces. This
508 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
509
510 =item B<IgnoreSource> I<IP-address>
511
512 Ignore packets that originate from this address.
513
514 =back
515
516 =head2 Plugin C<email>
517
518 =over 4
519
520 =item B<SocketFile> I<Path>
521
522 Sets the socket-file which is to be created.
523
524 =item B<SocketGroup> I<Group>
525
526 If running as root change the group of the UNIX-socket after it has been
527 created. Defaults to B<collectd>.
528
529 =item B<SocketPerms> I<Permissions>
530
531 Change the file permissions of the UNIX-socket after it has been created. The
532 permissions must be given as a numeric, octal value as you would pass to
533 L<chmod(1)>. Defaults to B<0770>.
534
535 =item B<MaxConns> I<Number>
536
537 Sets the maximum number of connections that can be handled in parallel. Since
538 this many threads will be started immediately setting this to a very high
539 value will waste valuable resources. Defaults to B<5> and will be forced to be
540 at most B<16384> to prevent typos and dumb mistakes.
541
542 =back
543
544 =head2 Plugin C<exec>
545
546 Please make sure to read L<collectd-exec(5)> before using this plugin. It
547 contains valuable information on when the executable is executed and the
548 output that is expected from it.
549
550 =over 4
551
552 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
553
554 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
555
556 Execute the executable I<Executable> as user I<User>. If the user name is
557 followed by a colon and a group name, the effective group is set to that group.
558 The real group and saved-set group will be set to the default group of that
559 user. If no group is given the effective group ID will be the same as the real
560 group ID.
561
562 Please note that in order to change the user and/or group the daemon needs
563 superuser privileges. If the daemon is run as an unprivileged user you must
564 specify the same user/group here. If the daemon is run with superuser
565 privileges, you must supply a non-root user here.
566
567 The executable may be followed by optional arguments that are passed to the
568 program. Please note that due to the configuration parsing numbers and boolean
569 values may be changed. If you want to be absolutely sure that something is
570 passed as-is please enclose it in quotes.
571
572 The B<Exec> and B<NotificationExec> statements change the semantics of the
573 programs executed, i.E<nbsp>e. the data passed to them and the response
574 expected from them. This is documented in great detail in L<collectd-exec(5)>.
575
576 =back
577
578 =head2 Plugin C<filecount>
579
580 The C<filecount> plugin counts the number of files in a certain directory (and
581 its subdirectories) and their combined size. The configuration is very straight
582 forward:
583
584   <Plugin "filecount">
585     <Directory "/var/qmail/queue/mess">
586       Instance "qmail-message"
587     </Directory>
588     <Directory "/var/qmail/queue/todo">
589       Instance "qmail-todo"
590     </Directory>
591     <Directory "/var/lib/php5">
592       Instance "php5-sessions"
593       Name "sess_*"
594     </Directory>
595   </Plugin>
596
597 The example above counts the number of files in QMail's queue directories and
598 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
599 QMail has not yet looked at, the "message" queue holds the messages that were
600 classified into "local" and "remote".
601
602 As you can see, the configuration consists of one or more C<Directory> blocks,
603 each of which specifies a directory in which to count the files. Within those
604 blocks, the following options are recognized:
605
606 =over 4
607
608 =item B<Instance> I<Instance>
609
610 Sets the plugin instance to I<Instance>. That instance name must be unique, but
611 it's your responsibility, the plugin doesn't check for that. If not given, the
612 instance is set to the directory name with all slashes replaced by underscores
613 and all leading underscores removed.
614
615 =item B<Name> I<Pattern>
616
617 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
618 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
619 against the pattern, not the entire path. In case this makes it easier for you:
620 This option has been named after the B<-name> parameter to L<find(1)>.
621
622 =item B<MTime> I<Age>
623
624 Count only files of a specific age: If I<Age> is greater than zero, only files
625 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
626 a negative number, this is inversed. For example, if B<-60> is specified, only
627 files that have been modified in the last minute will be counted.
628
629 The number can also be followed by a "multiplier" to easily specify a larger
630 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
631 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
632 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
633 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
634 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
635 B<"12h">.
636
637 =item B<Size> I<Size>
638
639 Count only files of a specific size. When I<Size> is a positive number, only
640 files that are at least this big are counted. If I<Size> is a negative number,
641 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
642 I<Size> are counted.
643
644 As with the B<MTime> option, a "multiplier" may be added. For a detailed
645 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
646 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
647 note that there are 1000 bytes in a kilobyte, not 1024.
648
649 =back
650
651 =head2 Plugin C<filter_pcre>
652
653 This plugin allows you to filter value lists based on Perl-compatible regular
654 expressions whose syntax and semantics are as close as possible to those of
655 the Perl 5 language. See L<pcre(3)> for details.
656
657   <Plugin filter_pcre>
658     <RegEx>
659       Host "^mail\d+$"
660       Plugin "^tcpconns$"
661       TypeInstance "^SYN_"
662
663       Action NoWrite
664     </RegEx>
665   </Plugin>
666
667 The configuration consists of one or more C<RegEx> blocks, each of which
668 specifies a regular expression identifying a set of value lists and how to
669 handle successful matches. A value list keeps the values of a single data-set
670 and is identified by the tuple (host, plugin, plugin instance, type, type
671 instance). The plugin and type instances are optional components. If they are
672 missing they are treated as empty strings. Within those blocks, the following
673 options are recognized:
674
675 =over 4
676
677 =item B<Host> I<regex>
678
679 =item B<Plugin> I<regex>
680
681 =item B<PluginInstance> I<regex>
682
683 =item B<Type> I<regex>
684
685 =item B<TypeInstance> I<regex>
686
687 Specifies the regular expression for each component of the identifier. If any
688 of these options is missing it is interpreted as a pattern which matches any
689 string. All five components of a value list have to match the appropriate
690 regular expression to trigger the specified action.
691
692 =item B<Action> I<NoWrite>|I<NoThresholdCheck>|I<Ignore>
693
694 Specify how to handle successful matches:
695
696 =over 4
697
698 =item B<NoWrite>
699
700 Do not send the value list to any output (a.k.a. write) plugins.
701
702 =item B<NoThresholdCheck>
703
704 Skip threshold checking for this value list.
705
706 =item B<Ignore>
707
708 Completely ignore this value list.
709
710 =back
711
712 Two or more actions may be combined by specifying multiple B<Action> options.
713
714 =back
715
716 =head2 Plugin C<hddtemp>
717
718 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
719 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
720 default values, see below. C<hddtemp> has to be running to work correctly. If
721 C<hddtemp> is not running timeouts may appear which may interfere with other
722 statistics..
723
724 The B<hddtemp> homepage can be found at
725 L<http://www.guzu.net/linux/hddtemp.php>.
726
727 =over 4
728
729 =item B<Host> I<Hostname>
730
731 Hostname to connect to. Defaults to B<127.0.0.1>.
732
733 =item B<Port> I<Port>
734
735 TCP-Port to connect to. Defaults to B<7634>.
736
737 =item B<TranslateDevicename> I<true>|I<false>
738
739 If enabled, translate the disk names to major/minor device numbers
740 (e.E<nbsp>g. "8-0" for /dev/sda). For backwards compatibility this defaults to
741 I<true> but it's recommended to disable it as it will probably be removed in
742 the next major version.
743
744 =back
745
746 =head2 Plugin C<interface>
747
748 =over 4
749
750 =item B<Interface> I<Interface>
751
752 Select this interface. By default these interfaces will then be collected. For
753 a more detailed description see B<IgnoreSelected> below.
754
755 =item B<IgnoreSelected> I<true>|I<false>
756
757 If no configuration if given, the B<traffic>-plugin will collect data from
758 all interfaces. This may not be practical, especially for loopback- and
759 similar interfaces. Thus, you can use the B<Interface>-option to pick the
760 interfaces you're interested in. Sometimes, however, it's easier/preferred
761 to collect all interfaces I<except> a few ones. This option enables you to
762 do that: By setting B<IgnoreSelected> to I<true> the effect of
763 B<Interface> is inverted: All selected interfaces are ignored and all
764 other interfaces are collected.
765
766 =back
767
768 =head2 Plugin C<ipmi>
769
770 =over 4
771
772 =item B<Sensor> I<Sensor>
773
774 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
775
776 =item B<IgnoreSelected> I<true>|I<false>
777
778 If no configuration if given, the B<ipmi> plugin will collect data from all
779 sensors found of type "temperature", "voltage", "current" and "fanspeed".
780 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
781 the effect of B<Sensor> is inverted: All selected sensors are ignored and
782 all other sensors are collected.
783
784 =item B<NotifySensorAdd> I<true>|I<false>
785
786 If a sensor appears after initialization time of a minute a notification
787 is sent.
788
789 =item B<NotifySensorRemove> I<true>|I<false>
790
791 If a sensor disappears a notification is sent.
792
793 =item B<NotifySensorNotPresent> I<true>|I<false>
794
795 If you have for example dual power supply and one of them is (un)plugged then
796 a notification is sent.
797
798 =back
799
800 =head2 Plugin C<iptables>
801
802 =over 4
803
804 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
805
806 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
807 will collect the counters of all rules which have a comment-match. The comment
808 is then used as type-instance.
809
810 If I<Comment> or I<Number> is given, only the rule with the matching comment or
811 the I<n>th rule will be collected. Again, the comment (or the number) will be
812 used as the type-instance.
813
814 If I<Name> is supplied, it will be used as the type-instance instead of the
815 comment or the number.
816
817 =back
818
819 =head2 Plugin C<irq>
820
821 =over 4
822
823 =item B<Irq> I<Irq>
824
825 Select this irq. By default these irqs will then be collected. For a more
826 detailed description see B<IgnoreSelected> below.
827
828 =item B<IgnoreSelected> I<true>|I<false>
829
830 If no configuration if given, the B<irq>-plugin will collect data from all
831 irqs. This may not be practical, especially if no interrupts happen. Thus, you
832 can use the B<Irq>-option to pick the interrupt you're interested in.
833 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
834 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
835 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
836 and all other interrupts are collected.
837
838 =back
839
840 =head2 Plugin C<libvirt>
841
842 This plugin allows CPU, disk and network load to be collected for virtualized
843 guests on the machine. This means that these characteristics can be collected
844 for guest systems without installing any software on them - collectd only runs
845 on the hosting system. The statistics are collected through libvirt
846 (L<http://libvirt.org/>).
847
848 Only I<Connection> is required.
849
850 =over 4
851
852 =item B<Connection> I<uri>
853
854 Connect to the hypervisor given by I<uri>. For example if using Xen use:
855
856  Connection "xen:///"
857
858 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
859
860 =item B<RefreshInterval> I<seconds>
861
862 Refresh the list of domains and devices every I<seconds>. The default is 60
863 seconds. Setting this to be the same or smaller than the I<Interval> will cause
864 the list of domains and devices to be refreshed on every iteration.
865
866 Refreshing the devices in particular is quite a costly operation, so if your
867 virtualization setup is static you might consider increasing this. If this
868 option is set to 0, refreshing is disabled completely.
869
870 =item B<Domain> I<name>
871
872 =item B<BlockDevice> I<name:dev>
873
874 =item B<InterfaceDevice> I<name:dev>
875
876 =item B<IgnoreSelected> I<true>|I<false>
877
878 Select which domains and devices are collected.
879
880 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
881 disk/network devices are collected.
882
883 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
884 domains and disk/network devices are ignored, while the rest are collected.
885
886 The domain name and device names may use a regular expression, if the name is
887 surrounded by I</.../> and collectd was compiled with support for regexps.
888
889 The default is to collect statistics for all domains and all their devices.
890
891 Example:
892
893  BlockDevice "/:hdb/"
894  IgnoreSelected "true"
895
896 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
897 will be collected.
898
899 =item B<HostnameFormat> B<name|uuid|hostname|...>
900
901 When the libvirt plugin logs data, it sets the hostname of the collected data
902 according to this setting. The default is to use the guest name as provided by
903 the hypervisor, which is equal to setting B<name>.
904
905 B<uuid> means use the guest's UUID. This is useful if you want to track the
906 same guest across migrations.
907
908 B<hostname> means to use the global B<Hostname> setting, which is probably not
909 useful on its own because all guests will appear to have the same name.
910
911 You can also specify combinations of these fields. For example B<name uuid>
912 means to concatenate the guest name and UUID (with a literal colon character
913 between, thus I<"foo:1234-1234-1234-1234">).
914
915 =back
916
917 =head2 Plugin C<logfile>
918
919 =over 4
920
921 =item B<LogLevel> B<debug|info|notice|warning|err>
922
923 Sets the log-level. If, for example, set to B<notice>, then all events with
924 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
925
926 Please note that B<debug> is only available if collectd has been compiled with
927 debugging support.
928
929 =item B<File> I<File>
930
931 Sets the file to write log messages to. The special strings B<stdout> and
932 B<stderr> can be used to write to the standard output and standard error
933 channels, respectively. This, of course, only makes much sense when collectd is
934 running in foreground- or non-daemon-mode.
935
936 =item B<Timestamp> B<true>|B<false>
937
938 Prefix all lines printed by the current time. Defaults to B<true>.
939
940 =back
941
942 =head2 Plugin C<mbmon>
943
944 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
945
946 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
947 B<Host> and B<Port> options can be used to change these values, see below.
948 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
949 timeouts may appear which may interfere with other statistics..
950
951 C<mbmon> must be run with the -r option ("print TAG and Value format");
952 Debian's F</etc/init.d/mbmon> script already does this, other people
953 will need to ensure that this is the case.
954
955 =over 4
956
957 =item B<Host> I<Hostname>
958
959 Hostname to connect to. Defaults to B<127.0.0.1>.
960
961 =item B<Port> I<Port>
962
963 TCP-Port to connect to. Defaults to B<411>.
964
965 =back
966
967 =head2 Plugin C<memcached>
968
969 The C<memcached plugin> connects to a memcached server and queries statistics
970 about cache utilization, memory and bandwidth used.
971 L<http://www.danga.com/memcached/>
972
973 =over 4
974
975 =item B<Host> I<Hostname>
976
977 Hostname to connect to. Defaults to B<127.0.0.1>.
978
979 =item B<Port> I<Port>
980
981 TCP-Port to connect to. Defaults to B<11211>.
982
983 =back
984
985 =head2 Plugin C<mysql>
986
987 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to the
988 database when started and keeps the connection up as long as possible. When the
989 connection is interrupted for whatever reason it will try to re-connect. The
990 plugin will complaint loudly in case anything goes wrong.
991
992 This plugin issues C<SHOW STATUS> and evaluates C<Bytes_{received,sent}>,
993 C<Com_*> and C<Handler_*> which correspond to F<mysql_octets.rrd>,
994 F<mysql_commands-*.rrd> and F<mysql_handler-*.rrd>. Also, the values of
995 C<Qcache_*> are put in F<mysql_qcache.rrd> and values of C<Threads_*> are put
996 in F<mysql_threads.rrd>. Please refer to the B<MySQL reference manual>,
997 I<5.2.4. Server Status Variables> for an explanation of these values.
998
999 Use the following options to configure the plugin:
1000
1001 =over 4
1002
1003 =item B<Host> I<Hostname>
1004
1005 Hostname of the database server. Defaults to B<localhost>.
1006
1007 =item B<User> I<Username>
1008
1009 Username to use when connecting to the database.
1010
1011 =item B<Password> I<Password>
1012
1013 Password needed to log into the database.
1014
1015 =item B<Database> I<Database>
1016
1017 Select this database. Defaults to I<no database> which is a perfectly reasonable
1018 option for what this plugin does.
1019
1020 =back
1021
1022 =head2 Plugin C<netlink>
1023
1024 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
1025 statistics of various interface and routing aspects.
1026
1027 =over 4
1028
1029 =item B<Interface> I<Interface>
1030
1031 =item B<VerboseInterface> I<Interface>
1032
1033 Instruct the plugin to collect interface statistics. This is basically the same
1034 as the statistics provided by the C<interface> plugin (see above) but
1035 potentially much more detailed.
1036
1037 When configuring with B<Interface> only the basic statistics will be collected,
1038 namely octets, packets, and errors. These statistics are collected by
1039 the C<interface> plugin, too, so using both at the same time is no benefit.
1040
1041 When configured with B<VerboseInterface> all counters B<except> the basic ones,
1042 so that no data needs to be collected twice if you use the C<interface> plugin.
1043 This includes dropped packets, received multicast packets, collisions and a
1044 whole zoo of differentiated RX and TX errors. You can try the following command
1045 to get an idea of what awaits you:
1046
1047   ip -s -s link list
1048
1049 If I<Interface> is B<All>, all interfaces will be selected.
1050
1051 =item B<QDisc> I<Interface> [I<QDisc>]
1052
1053 =item B<Class> I<Interface> [I<Class>]
1054
1055 =item B<Filter> I<Interface> [I<Filter>]
1056
1057 Collect the octets and packets that pass a certain qdisc, class or filter.
1058
1059 QDiscs and classes are identified by their type and handle (or classid).
1060 Filters don't necessarily have a handle, therefore the parent's handle is used.
1061 The notation used in collectd differs from that used in tc(1) in that it
1062 doesn't skip the major or minor number if it's zero and doesn't print special
1063 ids by their name. So, for example, a qdisc may be identified by
1064 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
1065 thus not displayed by tc(1).
1066
1067 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
1068 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
1069 associated with that interface will be collected.
1070
1071 Since a filter itself doesn't necessarily have a handle, the parent's handle is
1072 used. This may lead to problems when more than one filter is attached to a
1073 qdisc or class. This isn't nice, but we don't know how this could be done any
1074 better. If you have a idea, please don't hesitate to tell us.
1075
1076 As with the B<Interface> option you can specify B<All> as the interface,
1077 meaning all interfaces.
1078
1079 Here are some examples to help you understand the above text more easily:
1080
1081   <Plugin netlink>
1082     VerboseInterface "All"
1083     QDisc "eth0" "pfifo_fast-1:0"
1084     QDisc "ppp0"
1085     Class "ppp0" "htb-1:10"
1086     Filter "ppp0" "u32-1:0"
1087   </Plugin>
1088
1089 =item B<IgnoreSelected>
1090
1091 The behaviour is the same as with all other similar plugins: If nothing is
1092 selected at all, everything is collected. If some things are selected using the
1093 options described above, only these statistics are collected. If you set
1094 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
1095 specified statistics will not be collected.
1096
1097 =back
1098
1099 =head2 Plugin C<network>
1100
1101 =over 4
1102
1103 =item B<Listen> I<Host> [I<Port>]
1104
1105 =item B<Server> I<Host> [I<Port>]
1106
1107 The B<Server> statement sets the server to send datagrams B<to>.  The statement
1108 may occur multiple times to send each datagram to multiple destinations.
1109
1110 The B<Listen> statement sets the interfaces to bind to. When multiple
1111 statements are found the daemon will bind to multiple interfaces.
1112
1113 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
1114 the argument is a multicast address the daemon will join that multicast group.
1115
1116 If no B<Listen> statement is found the server tries join both, the default IPv6
1117 multicast group and the default IPv4 multicast group. If no B<Server> statement
1118 is found the client will try to send data to the IPv6 multicast group first. If
1119 that fails the client will try the IPv4 multicast group.
1120
1121 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
1122 multicast group is C<239.192.74.66>.
1123
1124 The optional I<Port> argument sets the port to use. It can either be given
1125 using a numeric port number or a service name. If the argument is omitted the
1126 default port B<25826> is assumed.
1127
1128 =item B<TimeToLive> I<1-255>
1129
1130 Set the time-to-live of sent packets. This applies to all, unicast and
1131 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
1132 That means that multicast packets will be sent with a TTL of C<1> (one) on most
1133 operating systems.
1134
1135 =item B<Forward> I<true|false>
1136
1137 If set to I<true>, write packets that were received via the network plugin to
1138 the sending sockets. This should only be activated when the B<Listen>- and
1139 B<Server>-statements differ. Otherwise packets may be send multiple times to
1140 the same multicast group. While this results in more network traffic than
1141 necessary it's not a huge problem since the plugin has a duplicate detection,
1142 so the values will not loop.
1143
1144 =item B<CacheFlush> I<Seconds>
1145
1146 For each host/plugin/type combination the C<network plugin> caches the time of
1147 the last value being sent or received. Every I<Seconds> seconds the plugin
1148 searches and removes all entries that are older than I<Seconds> seconds, thus
1149 freeing the unused memory again. Since this process is somewhat expensive and
1150 normally doesn't do much, this value should not be too small. The default is
1151 1800 seconds, but setting this to 86400 seconds (one day) will not do much harm
1152 either.
1153
1154 =back
1155
1156 =head2 Plugin C<nginx>
1157
1158 This plugin collects the number of connections and requests handled by the
1159 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
1160 queries the page provided by the C<ngx_http_stub_status_module> module, which
1161 isn't compiled by default. Please refer to
1162 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
1163 how to compile and configure nginx and this module.
1164
1165 The following options are accepted by the C<nginx plugin>:
1166
1167 =over 4
1168
1169 =item B<URL> I<http://host/nginx_status>
1170
1171 Sets the URL of the C<ngx_http_stub_status_module> output.
1172
1173 =item B<User> I<Username>
1174
1175 Optional user name needed for authentication.
1176
1177 =item B<Password> I<Password>
1178
1179 Optional password needed for authentication.
1180
1181 =item B<VerifyPeer> B<true|false>
1182
1183 Enable or disable peer SSL certificate verification. See
1184 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1185
1186 =item B<VerifyHost> B<true|false>
1187
1188 Enable or disable peer host name verification. If enabled, the plugin checks
1189 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1190 certificate matches the host name provided by the B<URL> option. If this
1191 identity check fails, the connection is aborted. Obviously, only works when
1192 connecting to a SSL enabled server. Enabled by default.
1193
1194 =item B<CACert> I<File>
1195
1196 File that holds one or more SSL certificates. If you want to use HTTPS you will
1197 possibly need this option. What CA certificates come bundled with C<libcurl>
1198 and are checked by default depends on the distribution you use.
1199
1200 =back
1201
1202 =head2 Plugin C<notify_desktop>
1203
1204 This plugin sends a desktop notification to a notification daemon, as defined
1205 in the Desktop Notification Specification. To actually display the
1206 notifications, B<notification-daemon> is required and B<collectd> has to be
1207 able to access the X server.
1208
1209 The Desktop Notification Specification can be found at
1210 L<http://www.galago-project.org/specs/notification/>.
1211
1212 =over 4
1213
1214 =item B<OkayTimeout> I<timeout>
1215
1216 =item B<WarningTimeout> I<timeout>
1217
1218 =item B<FailureTimeout> I<timeout>
1219
1220 Set the I<timeout>, in milliseconds, after which to expire the notification
1221 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
1222 been specified, the displayed notification will not be closed at all - the
1223 user has to do so herself. These options default to 5000. If a negative number
1224 has been specified, the default is used as well.
1225
1226 =back
1227
1228 =head2 Plugin C<ntpd>
1229
1230 =over 4
1231
1232 =item B<Host> I<Hostname>
1233
1234 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
1235
1236 =item B<Port> I<Port>
1237
1238 UDP-Port to connect to. Defaults to B<123>.
1239
1240 =item B<ReverseLookups> B<true>|B<false>
1241
1242 Sets wether or not to perform reverse lookups on peers. Since the name or
1243 IP-address may be used in a filename it is recommended to disable reverse
1244 lookups. The default is to do reverse lookups to preserve backwards
1245 compatibility, though.
1246
1247 =back
1248
1249 =head2 Plugin C<nut>
1250
1251 =over 4
1252
1253 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
1254
1255 Add a UPS to collect data from. The format is identical to the one accepted by
1256 L<upsc(8)>.
1257
1258 =back
1259
1260 =head2 Plugin C<onewire>
1261
1262 B<EXPERIMENTAL!> See notes below.
1263
1264 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
1265 L<http://owfs.org/> to read sensors connected via the onewire bus.
1266
1267 Currently only temperature sensors (sensors with the family code C<10>,
1268 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
1269 would like to have included, please send a sort request to the mailing list.
1270
1271 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
1272 experimental, below.
1273
1274 =over 4
1275
1276 =item B<Device> I<Device>
1277
1278 Sets the device to read the values from. This can either be a "real" hardware
1279 device, such as a serial port or an USB port, or the address of the
1280 L<owserver(1)> socket, usually B<localhost:4304>.
1281
1282 Though the documentation claims to automatically recognize the given address
1283 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
1284 with that version, the following configuration worked for us:
1285
1286   <Plugin onewire>
1287     Device "-s localhost:4304"
1288   </Plugin>
1289
1290 This directive is B<required> and does not have a default value.
1291
1292 =item B<Sensor> I<Sensor>
1293
1294 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
1295 below. Sensors are specified without the family byte at the beginning, to you'd
1296 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
1297 point.
1298
1299 =item B<IgnoreSelected> I<true>|I<false>
1300
1301 If no configuration if given, the B<onewire> plugin will collect data from all
1302 sensors found. This may not be practical, especially if sensors are added and
1303 removed regularly. Sometimes, however, it's easier/preferred to collect only
1304 specific sensors or all sensors I<except> a few specified ones. This option
1305 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
1306 B<Sensor> is inverted: All selected interfaces are ignored and all other
1307 interfaces are collected.
1308
1309 =back
1310
1311 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
1312 work with big setups. It works with one sensor being attached to one
1313 controller, but as soon as you throw in a couple more senors and maybe a hub
1314 or two, reading all values will take more than ten seconds (the default
1315 interval). We will probably add some separate thread for reading the sensors
1316 and some cache or something like that, but it's not done yet. We will try to
1317 maintain backwards compatibility in the future, but we can't probmise. So in
1318 short: If it works for you: Great! But kaap in mind that the config I<might>
1319 change, though this is unlikely. Oh, and if you want to help improving this
1320 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
1321
1322 =head2 Plugin C<oracle>
1323
1324 The "oracle" plugin uses the Oracle® Call Interface (OCI) to connect to an
1325 Oracle® Database and lets you execute SQL statements there. It is very similar
1326 to the "dbi" plugin, because it was written around the same time. See the "dbi"
1327 plugin's documentation above for details.
1328
1329   <Plugin oracle>
1330     <Query "out_of_stock">
1331       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1332       Type "gauge"
1333       InstancesFrom "category"
1334       ValuesFrom "value"
1335     </Query>
1336     <Database "product_information">
1337       ConnectID "db01"
1338       Username "oracle"
1339       Password "secret"
1340       Query "out_of_stock"
1341     </Database>
1342   </Plugin>
1343
1344 =head3 B<Query> blocks
1345
1346 The Query blocks are handled identically to the Query blocks of the "dbi"
1347 plugin. Please see its documentation above for details on how to specify
1348 queries.
1349
1350 =head3 B<Database> blocks
1351
1352 Database blocks define a connection to a database and which queries should be
1353 sent to that database. Each database needs a "name" as string argument in the
1354 starting tag of the block. This name will be used as "PluginInstance" in the
1355 values submitted to the daemon. Other than that, that name is not used.
1356
1357 =over 4
1358
1359 =item B<ConnectID> I<ID>
1360
1361 Defines the "database alias" or "service name" to connect to. Usually, these
1362 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
1363
1364 =item B<Username> I<Username>
1365
1366 Username used for authentication.
1367
1368 =item B<Password> I<Password>
1369
1370 Password used for authentication.
1371
1372 =item B<Query> I<QueryName>
1373
1374 Associates the query named I<QueryName> with this database connection. The
1375 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1376 blocks you want to refer to must be placed above the database block you want to
1377 refer to them from.
1378
1379 =back
1380
1381 =head2 Plugin C<perl>
1382
1383 This plugin embeds a Perl-interpreter into collectd and provides an interface
1384 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
1385
1386 =head2 Plugin C<ping>
1387
1388 =over 4
1389
1390 =item B<Host> I<IP-address>
1391
1392 Host to ping periodically. This option may be repeated several times to ping
1393 multiple hosts.
1394
1395 =item B<TTL> I<0-255>
1396
1397 Sets the Time-To-Live of generated ICMP packets.
1398
1399 =back
1400
1401 =head2 Plugin C<postgresql>
1402
1403 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
1404 keeps a persistent connection to all configured databases and tries to
1405 reconnect if the connection has been interrupted. A database is configured by
1406 specifying a B<Database> block as described below. The default statistics are
1407 collected from PostgreSQL's B<statistics collector> which thus has to be
1408 enabled for this plugin to work correctly. This should usually be the case by
1409 default. See the section "The Statistics Collector" of the B<PostgreSQL
1410 Documentation> for details.
1411
1412 By specifying custom database queries using a B<Query> block as described
1413 below, you may collect any data that is available from some PostgreSQL
1414 database. This way, you are able to access statistics of external daemons
1415 which are available in a PostgreSQL database or use future or special
1416 statistics provided by PostgreSQL without the need to upgrade your collectd
1417 installation.
1418
1419 The B<PostgreSQL Documentation> manual can be found at
1420 L<http://www.postgresql.org/docs/manuals/>.
1421
1422   <Plugin postgresql>
1423     <Query magic>
1424       Query "SELECT magic, spells FROM wizard WHERE host = $1;"
1425       Param hostname
1426       Column gauge magic
1427       Column counter spells
1428     </Query>
1429
1430     <Database foo>
1431       Host "hostname"
1432       Port "5432"
1433       User "username"
1434       Password "secret"
1435       SSLMode "prefer"
1436       KRBSrvName "kerberos_service_name"
1437       Query magic
1438     </Database>
1439     <Database bar>
1440       Service "service_name"
1441     </Database>
1442   </Plugin>
1443
1444 The B<Query> block defines one database query which may later be used by a
1445 database definition. It accepts a single mandatory argument which specifies
1446 the name of the query. The names of all queries have to be unique. The
1447 following configuration options are available to define the query:
1448
1449 =over 4
1450
1451 =item B<Query> I<sql query>
1452
1453 Specify the I<sql query> which the plugin should execute. The string may
1454 contain the tokens B<$1>, B<$2>, etc. which are used to reference the first,
1455 second, etc. parameter. The value of the parameters is specified by the
1456 B<Param> configuration option - see below for details. To include a literal
1457 B<$> character followed by a number, surround it with single quotes (B<'>).
1458
1459 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
1460 allowed. Note, however, that only a single command may be used. Semicolons are
1461 allowed as long as a single non-empty command has been specified only.
1462
1463 =item B<Param> I<hostname>|I<database>|I<username>
1464
1465 Specify the parameters which should be passed to the SQL query. The parameters
1466 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
1467 they appear in the configuration file. The value of the parameter is
1468 determined depending on the value of the B<Param> option as follows:
1469
1470 =over 4
1471
1472 =item I<hostname>
1473
1474 The configured hostname of the database connection. If a UNIX domain socket is
1475 used, the parameter expands to "localhost".
1476
1477 =item I<database>
1478
1479 The name of the database of the current connection.
1480
1481 =item I<username>
1482
1483 The username used to connect to the database.
1484
1485 =back
1486
1487 Please note that parameters are only supported by PostgreSQL's protocol
1488 version 3 and above which was introduced in version 7.4 of PostgreSQL.
1489
1490 =item B<Column> I<type> [I<type instance>]
1491
1492 Specify the I<type> and optional I<type instance> used to dispatch the value
1493 of each result column. Detailed information about types and their
1494 configuration can be found in L<types.db(5)>. The number and order of the
1495 B<Column> options has to match the columns of the query result.
1496
1497 =item B<MinPGVersion> I<version>
1498
1499 =item B<MaxPGVersion> I<version>
1500
1501 Specify the minimum or maximum version of PostgreSQL that this query should be
1502 used with. Some statistics might only be available with certain versions of
1503 PostgreSQL. This allows you to specify multiple queries with the same name but
1504 which apply to different versions, thus allowing you to use the same
1505 configuration in a heterogeneous environment.
1506
1507 The I<version> has to be specified as the concatenation of the major, minor
1508 and patch-level versions, each represented as two-decimal-digit numbers. For
1509 example, version 8.2.3 will become 80203.
1510
1511 =back
1512
1513 The following predefined queries are available (the definitions can be found
1514 in the F<postgresql_default.conf> file which, by default, is available at
1515 C<I<prefix>/share/collectd/>):
1516
1517 =over 4
1518
1519 =item B<backends>
1520
1521 This query collects the number of backends, i.E<nbsp>e. the number of
1522 connected clients.
1523
1524 =item B<transactions>
1525
1526 This query collects the numbers of committed and rolled-back transactions of
1527 the user tables.
1528
1529 =item B<queries>
1530
1531 This query collects the numbers of various table modifications (i.E<nbsp>e.
1532 insertions, updates, deletions) of the user tables.
1533
1534 =item B<query_plans>
1535
1536 This query collects the numbers of various table scans and returned tuples of
1537 the user tables.
1538
1539 =item B<table_states>
1540
1541 This query collects the numbers of live and dead rows in the user tables.
1542
1543 =item B<disk_io>
1544
1545 This query collects disk block access counts for user tables.
1546
1547 =item B<disk_usage>
1548
1549 This query collects the on-disk size of the database in bytes.
1550
1551 =back
1552
1553 The B<Database> block defines one PostgreSQL database for which to collect
1554 statistics. It accepts a single mandatory argument which specifies the
1555 database name. None of the other options are required. PostgreSQL will use
1556 default values as documented in the section "CONNECTING TO A DATABASE" in the
1557 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
1558 the user collectd is run as and special environment variables. See the manpage
1559 for details.
1560
1561 =over 4
1562
1563 =item B<Host> I<hostname>
1564
1565 Specify the hostname or IP of the PostgreSQL server to connect to. If the
1566 value begins with a slash, it is interpreted as the directory name in which to
1567 look for the UNIX domain socket.
1568
1569 This option is also used to determine the hostname that is associated with a
1570 collected data set. If it has been omitted or either begins with with a slash
1571 or equals B<localhost> it will be replaced with the global hostname definition
1572 of collectd. Any other value will be passed literally to collectd when
1573 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
1574
1575 =item B<Port> I<port>
1576
1577 Specify the TCP port or the local UNIX domain socket file extension of the
1578 server.
1579
1580 =item B<User> I<username>
1581
1582 Specify the username to be used when connecting to the server.
1583
1584 =item B<Password> I<password>
1585
1586 Specify the password to be used when connecting to the server.
1587
1588 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
1589
1590 Specify whether to use an SSL connection when contacting the server. The
1591 following modes are supported:
1592
1593 =over 4
1594
1595 =item I<disable>
1596
1597 Do not use SSL at all.
1598
1599 =item I<allow>
1600
1601 First, try to connect without using SSL. If that fails, try using SSL.
1602
1603 =item I<prefer> (default)
1604
1605 First, try to connect using SSL. If that fails, try without using SSL.
1606
1607 =item I<require>
1608
1609 Use SSL only.
1610
1611 =back
1612
1613 =item B<KRBSrvName> I<kerberos_service_name>
1614
1615 Specify the Kerberos service name to use when authenticating with Kerberos 5
1616 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
1617 B<PostgreSQL Documentation> for details.
1618
1619 =item B<Service> I<service_name>
1620
1621 Specify the PostgreSQL service name to use for additional parameters. That
1622 service has to be defined in F<pg_service.conf> and holds additional
1623 connection parameters. See the section "The Connection Service File" in the
1624 B<PostgreSQL Documentation> for details.
1625
1626 =item B<Query> I<query>
1627
1628 Specify a I<query> which should be executed for the database connection. This
1629 may be any of the predefined or user-defined queries. If no such option is
1630 given, it defaults to "backends", "transactions", "queries", "query_plans",
1631 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
1632 used only.
1633
1634 =back
1635
1636 =head2 Plugin C<powerdns>
1637
1638 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
1639 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
1640 values, many of which are probably meaningless to most users, but may be useful
1641 for some. So you may chose which values to collect, but if you don't, some
1642 reasonable defaults will be collected.
1643
1644   <Plugin "powerdns">
1645     <Server "server_name">
1646       Collect "latency"
1647       Collect "udp-answers" "udp-queries"
1648       Socket "/var/run/pdns.controlsocket"
1649     </Server>
1650     <Recursor "recursor_name">
1651       Collect "questions"
1652       Collect "cache-hits" "cache-misses"
1653       Socket "/var/run/pdns_recursor.controlsocket"
1654     </Recursor>
1655     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
1656   </Plugin>
1657
1658 =over 4
1659
1660 =item B<Server> and B<Recursor> block
1661
1662 The B<Server> block defines one authoritative server to query, the B<Recursor>
1663 does the same for an recursing server. The possible options in both blocks are
1664 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
1665 and is required.
1666
1667 =over 4
1668
1669 =item B<Collect> I<Field>
1670
1671 Using the B<Collect> statement you can select which values to collect. Here,
1672 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
1673 C<dlg-only-drops>, C<answers10-100>.
1674
1675 The method of getting the values differs for B<Server> and B<Recursor> blocks:
1676 When querying the server a C<SHOW *> command is issued in any case, because
1677 that's the only way of getting multiple values out of the server at once.
1678 collectd then picks out the values you have selected. When querying the
1679 recursor, a command is generated to query exactly these values. So if you
1680 specify invalid fields when querying the recursor, a syntax error may be
1681 returned by the daemon and collectd may not collect any values at all.
1682
1683 If no B<Collect> statement is given, the following B<Server> values will be
1684 collected:
1685
1686 =over 4
1687
1688 =item latency
1689
1690 =item packetcache-hit
1691
1692 =item packetcache-miss
1693
1694 =item packetcache-size
1695
1696 =item query-cache-hit
1697
1698 =item query-cache-miss
1699
1700 =item recursing-answers
1701
1702 =item recursing-questions
1703
1704 =item tcp-answers
1705
1706 =item tcp-queries
1707
1708 =item udp-answers
1709
1710 =item udp-queries
1711
1712 =back
1713
1714 The following B<Recursor> values will be collected by default:
1715
1716 =over 4
1717
1718 =item noerror-answers
1719
1720 =item nxdomain-answers
1721
1722 =item servfail-answers
1723
1724 =item sys-msec
1725
1726 =item user-msec
1727
1728 =item qa-latency
1729
1730 =item cache-entries
1731
1732 =item cache-hits
1733
1734 =item cache-misses
1735
1736 =item questions
1737
1738 =back
1739
1740 Please note that up to that point collectd doesn't know what values are
1741 available on the server and values that are added do not need a change of the
1742 mechanism so far. However, the values must be mapped to collectd's naming
1743 scheme, which is done using a lookup table that lists all known values. If
1744 values are added in the future and collectd does not know about them, you will
1745 get an error much like this:
1746
1747   powerdns plugin: submit: Not found in lookup table: foobar = 42
1748
1749 In this case please file a bug report with the collectd team.
1750
1751 =item B<Socket> I<Path>
1752
1753 Configures the path to the UNIX domain socket to be used when connecting to the
1754 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
1755 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
1756 will be used for the recursor.
1757
1758 =back
1759
1760 =item B<LocalSocket> I<Path>
1761
1762 Querying the recursor is done using UDP. When using UDP over UNIX domain
1763 sockets, the client socket needs a name in the file system, too. You can set
1764 this local name to I<Path> using the B<LocalSocket> option. The default is
1765 C<I<prefix>/var/run/collectd-powerdns>.
1766
1767 =back
1768
1769 =head2 Plugin C<processes>
1770
1771 =over 4
1772
1773 =item B<Process> I<Name>
1774
1775 Select more detailed statistics of processes matching this name. The statistics
1776 collected for these selected processes are size of the resident segment size
1777 (RSS), user- and system-time used, number of processes and number of threads,
1778 and minor and major pagefaults.
1779
1780 =back
1781
1782 =head2 Plugin C<rrdcached>
1783
1784 The C<rrdcached> plugin uses the RRDTool accelerator daemon, L<rrdcached(1)>,
1785 to store values to RRD files in an efficient manner. The combination of the
1786 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
1787 way the C<rrdtool> plugin works (see below). The added abstraction layer
1788 provides a number of benefits, though: Because the cache is not within
1789 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
1790 restarted. This results in much shorter (if any) gaps in graphs, especially
1791 under heavy load. Also, the C<rrdtool> command line utility is aware of the
1792 daemon so that it can flush values to disk automatically when needed. This
1793 allows to integrate automated flushing of values into graphing solutions much
1794 more easily.
1795
1796 There are disadvantages, though: The daemon may reside on a different host, so
1797 it may not be possible for C<collectd> to create the appropriate RRD files
1798 anymore. And even if C<rrdcached> runs on the same host, it may run in a
1799 different base directory, so relative paths may do weird stuff if you're not
1800 careful.
1801
1802 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
1803 on the same host, communicating via a UNIX domain socket. The B<DataDir>
1804 setting should be set to an absolute path, so that a changed base directory
1805 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
1806
1807 =over 4
1808
1809 =item B<DaemonAddress> I<Address>
1810
1811 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
1812 library. See L<rrdcached(1)> for details. Example:
1813
1814   <Plugin "rrdcached">
1815     DaemonAddress "unix:/var/run/rrdcached.sock"
1816   </Plugin>
1817
1818 =item B<DataDir> I<Directory>
1819
1820 Set the base directory in which the RRD files reside. If this is a relative
1821 path, it is relative to the working base directory of the C<rrdcached> daemon!
1822 Use of an absolute path is recommended.
1823
1824 =item B<CreateFiles> B<true>|B<false>
1825
1826 Enables or disables the creation of RRD files. If the daemon is not running
1827 locally, or B<DataDir> is set to a relative path, this will not work as
1828 expected. Default is B<true>.
1829
1830 =back
1831
1832 =head2 Plugin C<rrdtool>
1833
1834 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
1835 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
1836 using these settings. If you don't want to dive into the depths of RRDTool, you
1837 can safely ignore these settings.
1838
1839 =over 4
1840
1841 =item B<DataDir> I<Directory>
1842
1843 Set the directory to store RRD-files under. Per default RRD-files are generated
1844 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1845
1846 =item B<StepSize> I<Seconds>
1847
1848 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
1849 this setting is unset and the stepsize is set to the interval in which the data
1850 is collected. Do not use this option unless you absolutely have to for some
1851 reason. Setting this option may cause problems with the C<snmp plugin>, the
1852 C<exec plugin> or when the daemon is set up to receive data from other hosts.
1853
1854 =item B<HeartBeat> I<Seconds>
1855
1856 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
1857 in which case the heartbeat is set to twice the B<StepSize> which should equal
1858 the interval in which data is collected. Do not set this option unless you have
1859 a very good reason to do so.
1860
1861 =item B<RRARows> I<NumRows>
1862
1863 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
1864 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
1865 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
1866 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
1867 week, one month, and one year.
1868
1869 So for each timespan, it calculates how many PDPs need to be consolidated into
1870 one CDP by calculating:
1871   number of PDPs = timespan / (stepsize * rrarows)
1872
1873 Bottom line is, set this no smaller than the width of you graphs in pixels. The
1874 default is 1200.
1875
1876 =item B<RRATimespan> I<Seconds>
1877
1878 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
1879 more then one RRA. If this option is never used, the built-in default of (3600,
1880 86400, 604800, 2678400, 31622400) is used.
1881
1882 For more information on how RRA-sizes are calculated see B<RRARows> above.
1883
1884 =item B<XFF> I<Factor>
1885
1886 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
1887
1888 =item B<CacheFlush> I<Seconds>
1889
1890 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
1891 it writes all values for a certain RRD-file if the oldest value is older than
1892 (or equal to) the number of seconds specified. If some RRD-file is not updated
1893 anymore for some reason (the computer was shut down, the network is broken,
1894 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
1895 entire cache is searched for entries older than B<CacheTimeout> seconds and
1896 written to disk every I<Seconds> seconds. Since this is kind of expensive and
1897 does nothing under normal circumstances, this value should not be too small.
1898 900 seconds might be a good value, though setting this to 7200 seconds doesn't
1899 normally do much harm either.
1900
1901 =item B<CacheTimeout> I<Seconds>
1902
1903 If this option is set to a value greater than zero, the C<rrdtool plugin> will
1904 save values in a cache, as described above. Writing multiple values at once
1905 reduces IO-operations and thus lessens the load produced by updating the files.
1906 The trade off is that the graphs kind of "drag behind" and that more memory is
1907 used.
1908
1909 =item B<WritesPerSecond> B<Updates>
1910
1911 When collecting many statistics with collectd and the C<rrdtool> plugin, you
1912 will run serious performance problems. The B<CacheFlush> setting and the
1913 internal update queue assert that collectd continues to work just fine even
1914 under heavy load, but the system may become very unresponsive and slow. This is
1915 a problem especially if you create graphs from the RRD files on the same
1916 machine, for example using the C<graph.cgi> script included in the
1917 C<contrib/collection3/> directory.
1918
1919 This setting is designed for very large setups. Setting this option to a value
1920 between 25 and 80 updates per second, depending on your hardware, will leave
1921 the server responsive enough to draw graphs even while all the cached values
1922 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
1923 by the B<FLUSH> command, are B<not> effected by this limit. They are still
1924 written as fast as possible, so that web frontends have up to date data when
1925 generating graphs.
1926
1927 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
1928 updates per second, writing all values to disk will take approximately
1929 56E<nbsp>minutes. Together with the flushing ability that's integrated into
1930 "collection3" you'll end up with a responsive and fast system, up to date
1931 graphs and basically a "backup" of your values every hour.
1932
1933 =back
1934
1935 =head2 Plugin C<sensors>
1936
1937 The C<sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
1938 that all the needed modules have to be loaded and lm_sensors has to be
1939 configured (most likely by editing F</etc/sensors.conf>. Read
1940 L<sensors.conf(5)> for details.
1941
1942 The B<lm_sensors> homepage can be found at
1943 L<http://secure.netroedge.com/~lm78/>.
1944
1945 =over 4
1946
1947 =item B<Sensor> I<chip-bus-address/type-feature>
1948
1949 Selects the name of the sensor which you want to collect or ignore, depending
1950 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
1951 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
1952 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
1953
1954 =item B<IgnoreSelected> I<true>|I<false>
1955
1956 If no configuration if given, the B<sensors>-plugin will collect data from all
1957 sensors. This may not be practical, especially for uninteresting sensors.
1958 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
1959 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
1960 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1961 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
1962 and all other sensors are collected.
1963
1964 =back
1965
1966 =head2 Plugin C<snmp>
1967
1968 Since the configuration of the C<snmp plugin> is a little more complicated than
1969 other plugins, its documentation has been moved to an own manpage,
1970 L<collectd-snmp(5)>. Please see there for details.
1971
1972 =head2 Plugin C<syslog>
1973
1974 =over 4
1975
1976 =item B<LogLevel> B<debug|info|notice|warning|err>
1977
1978 Sets the log-level. If, for example, set to B<notice>, then all events with
1979 severity B<notice>, B<warning>, or B<err> will be submitted to the
1980 syslog-daemon.
1981
1982 Please note that B<debug> is only available if collectd has been compiled with
1983 debugging support.
1984
1985 =back
1986
1987 =head2 Plugin C<tail>
1988
1989 The C<tail plugin> plugins follows logfiles, just like L<tail(1)> does, parses
1990 each line and dispatches found values. What is matched can be configured by the
1991 user using (extended) regular expressions, as described in L<regex(7)>.
1992
1993   <Plugin "tail">
1994     <File "/var/log/exim4/mainlog">
1995       Instance "exim"
1996       <Match>
1997         Regex "S=([1-9][0-9]*)"
1998         DSType "CounterAdd"
1999         Type "ipt_bytes"
2000         Instance "total"
2001       </Match>
2002       <Match>
2003         Regex "\\<R=local_user\\>"
2004         DSType "CounterInc"
2005         Type "counter"
2006         Instance "local_user"
2007       </Match>
2008     </File>
2009   </Plugin>
2010
2011 The config consists of one or more B<File> blocks, each of which configures one
2012 logfile to parse. Within each B<File> block, there are one or more B<Match>
2013 blocks, which configure a regular expression to search for.
2014
2015 The B<Instance> option in the B<File> block may be used to set the plugin
2016 instance. So in the above example the plugin name C<tail-foo> would be used.
2017 This plugin instance is for all B<Match> blocks that B<follow> it, until the
2018 next B<Instance> option. This way you can extract several plugin instances from
2019 one logfile, handy when parsing syslog and the like.
2020
2021 Each B<Match> block has the following options to describe how the match should
2022 be performed:
2023
2024 =over 4
2025
2026 =item B<Regex> I<regex>
2027
2028 Sets the regular expression to use for matching against a line. The first
2029 subexpression has to match something that can be turned into a number by
2030 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
2031 below. Because B<extended> regular expressions are used, you do not need to use
2032 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
2033 collectd's config parsing you need to escape backslashes, though. So if you
2034 want to match literal parentheses you need to do the following:
2035
2036   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
2037
2038 =item B<DSType> I<Type>
2039
2040 Sets how the values are cumulated. I<Type> is one of:
2041
2042 =over 4
2043
2044 =item B<GaugeAverage>
2045
2046 Calculate the average.
2047
2048 =item B<GaugeMin>
2049
2050 Use the smallest number only.
2051
2052 =item B<GaugeMax>
2053
2054 Use the greatest number only.
2055
2056 =item B<GaugeLast>
2057
2058 Use the last number found.
2059
2060 =item B<CounterSet>
2061
2062 The matched number is a counter. Simply sets the internal counter to this
2063 value.
2064
2065 =item B<CounterAdd>
2066
2067 Add the matched value to the internal counter.
2068
2069 =item B<CounterInc>
2070
2071 Increase the internal counter by one. This B<DSType> is the only one that does
2072 not use the matched subexpression, but simply counts the number of matched
2073 lines. Thus, you may use a regular expression without submatch in this case.
2074
2075 =back
2076
2077 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
2078 number, using L<strtod(3)>. The B<CounterSet> and B<CounterAdd> interpret the
2079 submatch as an integer using L<strtoll(3)>. B<CounterInc> does not use the
2080 submatch at all and it may be omitted in this case.
2081
2082 =item B<Type> I<Type>
2083
2084 Sets the type used to dispatch this value. Detailed information about types and
2085 their configuration can be found in L<types.db(5)>.
2086
2087 =item B<Instance> I<TypeInstance>
2088
2089 This optional setting sets the type instance to use.
2090
2091 =back
2092
2093 =head2 Plugin C<teamspeak2>
2094
2095 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
2096 polls interesting global and virtual server data. The plugin can query only one
2097 physical server but unlimited virtual servers. You can use the following
2098 options to configure it:
2099
2100 =over 4
2101
2102 =item B<Host> I<hostname/ip>
2103
2104 The hostname or ip which identifies the physical server.
2105 Default: 127.0.0.1
2106
2107 =item B<Port> I<port>
2108
2109 The query port of the physical server. This needs to be a string.
2110 Default: "51234"
2111
2112 =item B<Server> I<port>
2113
2114 This option has to be added once for every virtual server the plugin should
2115 query. If you want to query the virtual server on port 8767 this is what the
2116 option would look like:
2117
2118   Server "8767"
2119
2120 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
2121 use quotes around it! If no such statement is given only global information
2122 will be collected.
2123
2124 =back
2125
2126 =head2 Plugin C<tcpconns>
2127
2128 The C<tcpconns plugin> counts the number of currently established TCP
2129 connections based on the local port and/or the remote port. Since there may be
2130 a lot of connections the default if to count all connections with a local port,
2131 for which a listening socket is opened. You can use the following options to
2132 fine-tune the ports you are interested in:
2133
2134 =over 4
2135
2136 =item B<ListeningPorts> I<true>|I<false>
2137
2138 If this option is set to I<true>, statistics for all local ports for which a
2139 listening socket exists are collected. The default depends on B<LocalPort> and
2140 B<RemotePort> (see below): If no port at all is specifically selected, the
2141 default is to collect listening ports. If specific ports (no matter if local or
2142 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
2143 the selected ports will be collected unless this option is set to I<true>
2144 specifically.
2145
2146 =item B<LocalPort> I<Port>
2147
2148 Count the connections to a specific local port. This can be used to see how
2149 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
2150 You have to specify the port in numeric form, so for the mailserver example
2151 you'd need to set B<25>.
2152
2153 =item B<RemotePort> I<Port>
2154
2155 Count the connections to a specific remote port. This is useful to see how
2156 much a remote service is used. This is most useful if you want to know how many
2157 connections a local service has opened to remote services, e.E<nbsp>g. how many
2158 connections a mail server or news server has to other mail or news servers, or
2159 how many connections a web proxy holds to web servers. You have to give the
2160 port in numeric form.
2161
2162 =back
2163
2164 =head2 Plugin C<thermal>
2165
2166 =over 4
2167
2168 =item B<ForceUseProcfs> I<true>|I<false>
2169
2170 By default, the C<thermal> plugin tries to read the statistics from the Linux
2171 C<sysfs> interface. If that is not available, the plugin falls back to the
2172 C<procfs> interface. By setting this option to I<true>, you can force the
2173 plugin to use the latter. This option defaults to I<false>.
2174
2175 =item B<Device> I<Device>
2176
2177 Selects the name of the thermal device that you want to collect or ignore,
2178 depending on the value of the B<IgnoreSelected> option. This option may be
2179 used multiple times to specify a list of devices.
2180
2181 =item B<IgnoreSelected> I<true>|I<false>
2182
2183 Invert the selection: If set to true, all devices B<except> the ones that
2184 match the device names specified by the B<Device> option are collected. By
2185 default only selected devices are collected if a selection is made. If no
2186 selection is configured at all, B<all> devices are selected.
2187
2188 =back
2189
2190 =head2 Plugin C<unixsock>
2191
2192 =over 4
2193
2194 =item B<SocketFile> I<Path>
2195
2196 Sets the socket-file which is to be created.
2197
2198 =item B<SocketGroup> I<Group>
2199
2200 If running as root change the group of the UNIX-socket after it has been
2201 created. Defaults to B<collectd>.
2202
2203 =item B<SocketPerms> I<Permissions>
2204
2205 Change the file permissions of the UNIX-socket after it has been created. The
2206 permissions must be given as a numeric, octal value as you would pass to
2207 L<chmod(1)>. Defaults to B<0770>.
2208
2209 =back
2210
2211 =head2 Plugin C<uuid>
2212
2213 This plugin, if loaded, causes the Hostname to be taken from the machine's
2214 UUID. The UUID is a universally unique designation for the machine, usually
2215 taken from the machine's BIOS. This is most useful if the machine is running in
2216 a virtual environment such as Xen, in which case the UUID is preserved across
2217 shutdowns and migration.
2218
2219 The following methods are used to find the machine's UUID, in order:
2220
2221 =over 4
2222
2223 =item
2224
2225 Check I</etc/uuid> (or I<UUIDFile>).
2226
2227 =item
2228
2229 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
2230 present.
2231
2232 =item
2233
2234 Check for UUID from C<dmidecode> / SMBIOS.
2235
2236 =item
2237
2238 Check for UUID from Xen hypervisor.
2239
2240 =back
2241
2242 If no UUID can be found then the hostname is not modified.
2243
2244 =over 4
2245
2246 =item B<UUIDFile> I<Path>
2247
2248 Take the UUID from the given file (default I</etc/uuid>).
2249
2250 =back
2251
2252 =head2 Plugin C<vmem>
2253
2254 The C<vmem> plugin collects information about the usage of virtual memory.
2255 Since the statistics provided by the Linux kernel are very detailed, they are
2256 collected very detailed. However, to get all the details, you have to switch
2257 them on manually. Most people just want an overview over, such as the number of
2258 pages read from swap space.
2259
2260 =over 4
2261
2262 =item B<Verbose> B<true>|B<false>
2263
2264 Enables verbose collection of information. This will start collecting page
2265 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
2266 Part of these statistics are collected on a "per zone" basis.
2267
2268 =back
2269
2270 =head2 Plugin C<vserver>
2271
2272 This plugin doesn't have any options. B<VServer> support is only available for
2273 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
2274 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
2275 need to apply the patches and compile your own kernel, which will then provide
2276 the F</proc/virtual> filesystem that is required by this plugin.
2277
2278 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
2279
2280 =head1 THRESHOLD CONFIGURATION
2281
2282 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
2283 we mean that the values are not only stored or sent somewhere, but that they
2284 are judged and, if a problem is recognized, acted upon. The only action
2285 collectd takes itself is to generate and dispatch a "notification". Plugins can
2286 register to receive notifications and perform appropriate further actions.
2287
2288 Since systems and what you expect them to do differ a lot, you can configure
2289 B<thresholds> for your values freely. This gives you a lot of flexibility but
2290 also a lot of responsibility.
2291
2292 Every time a value is out of range a notification is dispatched. This means
2293 that the idle percentage of your CPU needs to be less then the configured
2294 threshold only once for a notification to be generated. There's no such thing
2295 as a moving average or similar - at least not now.
2296
2297 Also, all values that match a threshold are considered to be relevant or
2298 "interesting". As a consequence collectd will issue a notification if they are
2299 not received for twice the last timeout of the values. If, for example, some
2300 hosts sends it's CPU statistics to the server every 60 seconds, a notification
2301 will be dispatched after about 120 seconds. It may take a little longer because
2302 the timeout is checked only once each B<Interval> on the server.
2303
2304 When a value comes within range again or is received after it was missing, an
2305 "OKAY-notification" is dispatched.
2306
2307 Here is a configuration example to get you started. Read below for more
2308 information.
2309
2310  <Threshold>
2311    <Type "foo">
2312      WarningMin    0.00
2313      WarningMax 1000.00
2314      FailureMin    0.00
2315      FailureMax 1200.00
2316      Invert false
2317      Instance "bar"
2318    </Type>
2319
2320    <Plugin "interface">
2321      Instance "eth0"
2322      <Type "if_octets">
2323        FailureMax 10000000
2324        DataSource "rx"
2325      </Type>
2326    </Plugin>
2327
2328    <Host "hostname">
2329      <Type "cpu">
2330        Instance "idle"
2331        FailureMin 10
2332      </Type>
2333
2334      <Plugin "memory">
2335        <Type "memory">
2336          Instance "cached"
2337          WarningMin 100000000
2338        </Type>
2339      </Plugin>
2340    </Host>
2341  </Threshold>
2342
2343 There are basically two types of configuration statements: The C<Host>,
2344 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
2345 configured. The C<Plugin> and C<Type> blocks may be specified further using the
2346 C<Instance> option. You can combine the block by nesting the blocks, though
2347 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
2348 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
2349 C<Type> may not contain other blocks. If multiple blocks apply to the same
2350 value the most specific block is used.
2351
2352 The other statements specify the threshold to configure. They B<must> be
2353 included in a C<Type> block. Currently the following statements are recognized:
2354
2355 =over 4
2356
2357 =item B<FailureMax> I<Value>
2358
2359 =item B<WarningMax> I<Value>
2360
2361 Sets the upper bound of acceptable values. If unset defaults to positive
2362 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
2363 will be created. If the value is greater than B<WarningMax> but less than (or
2364 equal to) B<FailureMax> a B<WARNING> notification will be created.
2365
2366 =item B<FailureMin> I<Value>
2367
2368 =item B<WarningMin> I<Value>
2369
2370 Sets the lower bound of acceptable values. If unset defaults to negative
2371 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
2372 be created. If the value is less than B<WarningMin> but greater than (or equal
2373 to) B<FailureMin> a B<WARNING> notification will be created.
2374
2375 =item B<DataSource> I<DSName>
2376
2377 Some data sets have more than one "data source". Interesting examples are the
2378 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
2379 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
2380 system load data set, C<load>, even has three data sources: C<shortterm>,
2381 C<midterm>, and C<longterm>.
2382
2383 Normally, all data sources are checked against a configured threshold. If this
2384 is undesirable, or if you want to specify different limits for each data
2385 source, you can use the B<DataSource> option to have a threshold apply only to
2386 one data source.
2387
2388 =item B<Invert> B<true>|B<false>
2389
2390 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
2391 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
2392 B<WarningMax>) are not okay. Defaults to B<false>.
2393
2394 =item B<Persist> B<true>|B<false>
2395
2396 Sets how often notifications are generated. If set to B<true> one notification
2397 will be generated for each value that is out of the acceptable range. If set to
2398 B<false> (the default) then a notification is only generated if a value is out
2399 of range but the previous value was okay.
2400
2401 This applies to missing values, too: If set to B<true> a notification about a
2402 missing value is generated once every B<Interval> seconds. If set to B<false>
2403 only one such notification is generated until the value appears again.
2404
2405 =back
2406
2407 =head1 SEE ALSO
2408
2409 L<collectd(1)>,
2410 L<collectd-exec(5)>,
2411 L<collectd-perl(5)>,
2412 L<collectd-unixsock(5)>,
2413 L<types.db(5)>,
2414 L<hddtemp(8)>,
2415 L<kstat(3KSTAT)>,
2416 L<mbmon(1)>,
2417 L<pcre(3)>,
2418 L<psql(1)>,
2419 L<rrdtool(1)>,
2420 L<sensors(1)>
2421
2422 =head1 AUTHOR
2423
2424 Florian Forster E<lt>octo@verplant.orgE<gt>
2425
2426 =cut