swap plugin: Deactivate the kstat-based code.
[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 Starting with collectd 4.9, this may also be a block in which further options
61 affecting the behavior of B<LoadPlugin> may be specified. The following
62 options are allowed inside a B<LoadPlugin> block:
63
64   <LoadPlugin perl>
65     Globals true
66   </LoadPlugin>
67
68 =over 4
69
70 =item B<Globals> B<true|false>
71
72 If enabled, collectd will export all global symbols of the plugin (and of all
73 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
74 available for resolving unresolved symbols in subsequently loaded plugins if
75 that is supported by your system.
76
77 This is useful (or possibly even required), e.g., when loading a plugin that
78 embeds some scripting language into the daemon (e.g. the I<Perl> and
79 I<Python plugins>). Scripting languages usually provide means to load
80 extensions written in C. Those extensions require symbols provided by the
81 interpreter, which is loaded as a dependency of the respective collectd plugin.
82 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
83 L<collectd-python(5)>) for details.
84
85 By default, this is disabled. As a special exception, if the plugin name is
86 either C<perl> or C<python>, the default is changed to enabled in order to keep
87 the average user from ever having to deal with this low level linking stuff.
88
89 =back
90
91 =item B<Include> I<Path>
92
93 If I<Path> points to a file, includes that file. If I<Path> points to a
94 directory, recursively includes all files within that directory and its
95 subdirectories. If the C<wordexp> function is available on your system,
96 shell-like wildcards are expanded before files are included. This means you can
97 use statements like the following:
98
99   Include "/etc/collectd.d/*.conf"
100
101 If more than one files are included by a single B<Include> option, the files
102 will be included in lexicographical order (as defined by the C<strcmp>
103 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
104 order in which the files are loaded.
105
106 To prevent loops and shooting yourself in the foot in interesting ways the
107 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
108 most uses. Since symlinks are followed it is still possible to crash the daemon
109 by looping symlinks. In our opinion significant stupidity should result in an
110 appropriate amount of pain.
111
112 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
113 file, but you cannot include files from within blocks.
114
115 =item B<PIDFile> I<File>
116
117 Sets where to write the PID file to. This file is overwritten when it exists
118 and deleted when the program is stopped. Some init-scripts might override this
119 setting using the B<-P> command-line option.
120
121 =item B<PluginDir> I<Directory>
122
123 Path to the plugins (shared objects) of collectd.
124
125 =item B<TypesDB> I<File> [I<File> ...]
126
127 Set one or more files that contain the data-set descriptions. See
128 L<types.db(5)> for a description of the format of this file.
129
130 =item B<Interval> I<Seconds>
131
132 Configures the interval in which to query the read plugins. Obviously smaller
133 values lead to a higher system load produced by collectd, while higher values
134 lead to more coarse statistics.
135
136 B<Warning:> You should set this once and then never touch it again. If you do,
137 I<you will have to delete all your RRD files> or know some serious RRDtool
138 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
139
140 =item B<Timeout> I<Iterations>
141
142 Consider a value list "missing" when no update has been read or received for
143 I<Iterations> iterations. By default, I<collectd> considers a value list
144 missing when no update has been received for twice the update interval. Since
145 this setting uses iterations, the maximum allowed time without update depends
146 on the I<Interval> information contained in each value list. This is used in
147 the I<Threshold> configuration to dispatch notifications about missing values,
148 see L<collectd-threshold(5)> for details.
149
150 =item B<ReadThreads> I<Num>
151
152 Number of threads to start for reading plugins. The default value is B<5>, but
153 you may want to increase this if you have more than five plugins that take a
154 long time to read. Mostly those are plugin that do network-IO. Setting this to
155 a value higher than the number of plugins you've loaded is totally useless.
156
157 =item B<Hostname> I<Name>
158
159 Sets the hostname that identifies a host. If you omit this setting, the
160 hostname will be determined using the L<gethostname(2)> system call.
161
162 =item B<FQDNLookup> B<true|false>
163
164 If B<Hostname> is determined automatically this setting controls whether or not
165 the daemon should try to figure out the "fully qualified domain name", FQDN.
166 This is done using a lookup of the name returned by C<gethostname>. This option
167 is enabled by default.
168
169 =item B<PreCacheChain> I<ChainName>
170
171 =item B<PostCacheChain> I<ChainName>
172
173 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
174 see L<FILTER CONFIGURATION> below on information on chains and how these
175 setting change the daemon's behavior.
176
177 =back
178
179 =head1 PLUGIN OPTIONS
180
181 Some plugins may register own options. These options must be enclosed in a
182 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
183 require external configuration, too. The C<apache plugin>, for example,
184 required C<mod_status> to be configured in the webserver you're going to
185 collect data from. These plugins are listed below as well, even if they don't
186 require any configuration within collectd's configfile.
187
188 A list of all plugins and a short summary for each plugin can be found in the
189 F<README> file shipped with the sourcecode and hopefully binary packets as
190 well.
191
192 =head2 Plugin C<amqp>
193
194 The I<AMQMP plugin> can be used to communicate with other instances of
195 I<collectd> or third party applications using an AMQP message broker. Values
196 are sent to or received from the broker, which handles routing, queueing and
197 possibly filtering or messages.
198
199  <Plugin "amqp">
200    # Send values to an AMQP broker
201    <Publish "some_name">
202      Host "localhost"
203      Port "5672"
204      VHost "/"
205      User "guest"
206      Password "guest"
207      Exchange "amq.fanout"
208  #   ExchangeType "fanout"
209  #   RoutingKey "collectd"
210  #   Persistent false
211  #   Format "command"
212  #   StoreRates false
213    </Publish>
214    
215    # Receive values from an AMQP broker
216    <Subscribe "some_name">
217      Host "localhost"
218      Port "5672"
219      VHost "/"
220      User "guest"
221      Password "guest"
222      Exchange "amq.fanout"
223  #   ExchangeType "fanout"
224  #   Queue "queue_name"
225  #   RoutingKey "collectd.#"
226    </Subscribe>
227  </Plugin>
228
229 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
230 blocks, which configure sending and receiving of values respectively. The two
231 blocks are very similar, so unless otherwise noted, an option can be used in
232 either block. The name given in the blocks starting tag is only used for
233 reporting messages, but may be used to support I<flushing> of certain
234 I<Publish> blocks in the future.
235
236 =over 4
237
238 =item B<Host> I<Host>
239
240 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
241 the underlying communications library, I<rabbitmq-c>, which is "localhost".
242
243 =item B<Port> I<Port>
244
245 Service name or port number on which the AMQP broker accepts connections. This
246 argument must be a string, even if the numeric form is used. Defaults to
247 "5672".
248
249 =item B<VHost> I<VHost>
250
251 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
252
253 =item B<User> I<User>
254
255 =item B<Password> I<Password>
256
257 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
258 is used.
259
260 =item B<Exchange> I<Exchange>
261
262 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
263 By default, "amq.fanout" will be used.
264
265 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
266 the given exchange and the I<queue> is created, using the I<routing key> if
267 configured. See the B<Queue> and B<RoutingKey> options below.
268
269 =item B<ExchangeType> I<Type>
270
271 If given, the plugin will try to create the configured I<exchange> with this
272 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
273 be bound to this exchange.
274
275 =item B<Queue> I<Queue> (Subscribe only)
276
277 Configures the I<queue> name to subscribe to. If no queue name was configures
278 explicitly, a unique queue name will be created by the broker.
279
280 =item B<RoutingKey> I<Key>
281
282 In I<Publish> blocks, this configures the routing key to set on all outgoing
283 messages. If not given, the routing key will be computed from the I<identifier>
284 of the value. The host, plugin, type and the two instances are concatenated
285 together using dots as the separator and all containing dots replaced with
286 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
287 possible to receive only specific values using a "topic" exchange.
288
289 In I<Subscribe> blocks, configures the I<routing key> used when creating a
290 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
291 used to filter messages when using a "topic" exchange. If you're only
292 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
293 for example.
294
295 =item B<Persistent> B<true>|B<false> (Publish only)
296
297 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
298 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
299 default), the I<transient> delivery mode will be used, i.e. messages may be
300 lost due to high load, overflowing queues or similar issues.
301
302 =item B<Format> B<Command>|B<JSON> (Publish only)
303
304 Selects the format in which messages are sent to the broker. If set to
305 B<Command> (the default), values are sent as C<PUTVAL> commands which are
306 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
307 case, the C<Content-Type> header field will be set to C<text/collectd>.
308
309 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
310 an easy and straight forward exchange format. The C<Content-Type> header field
311 will be set to C<application/json>.
312
313 A subscribing client I<should> use the C<Content-Type> header field to
314 determine how to decode the values. Currently, the I<AMQP plugin> itself can
315 only decode the B<Command> format.
316
317 =item B<StoreRates> B<true>|B<false> (Publish only)
318
319 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
320 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
321 default), no conversion is performed. Otherwise the conversion is performed
322 using the internal value cache.
323
324 Please note that currently this option is only used if the B<Format> option has
325 been set to B<JSON>.
326
327 =back
328
329 =head2 Plugin C<apache>
330
331 To configure the C<apache>-plugin you first need to configure the Apache
332 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
333 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
334 the following snipped to base your Apache config upon:
335
336   ExtendedStatus on
337   <IfModule mod_status.c>
338     <Location /mod_status>
339       SetHandler server-status
340     </Location>
341   </IfModule>
342
343 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
344 also supported. It introduces a new field, called C<BusyServers>, to count the
345 number of currently connected clients. This field is also supported.
346
347 The configuration of the I<Apache> plugin consists of one or more
348 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
349 as the instance name. For example:
350
351  <Plugin "apache">
352    <Instance "www1">
353      URL "http://www1.example.com/mod_status?auto"
354    </Instance>
355    <Instance "www2">
356      URL "http://www2.example.com/mod_status?auto"
357    </Instance>
358  </Plugin>
359
360 The instance name will be used as the I<plugin instance>. To emulate the old
361 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
362 plugin to work correctly, each instance name must be unique. This is not
363 enforced by the plugin and it is your responsibility to ensure it.
364
365 The following options are accepted within each I<Instance> block:
366
367 =over 4
368
369 =item B<URL> I<http://host/mod_status?auto>
370
371 Sets the URL of the C<mod_status> output. This needs to be the output generated
372 by C<ExtendedStatus on> and it needs to be the machine readable output
373 generated by appending the C<?auto> argument. This option is I<mandatory>.
374
375 =item B<User> I<Username>
376
377 Optional user name needed for authentication.
378
379 =item B<Password> I<Password>
380
381 Optional password needed for authentication.
382
383 =item B<VerifyPeer> B<true|false>
384
385 Enable or disable peer SSL certificate verification. See
386 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
387
388 =item B<VerifyHost> B<true|false>
389
390 Enable or disable peer host name verification. If enabled, the plugin checks
391 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
392 certificate matches the host name provided by the B<URL> option. If this
393 identity check fails, the connection is aborted. Obviously, only works when
394 connecting to a SSL enabled server. Enabled by default.
395
396 =item B<CACert> I<File>
397
398 File that holds one or more SSL certificates. If you want to use HTTPS you will
399 possibly need this option. What CA certificates come bundled with C<libcurl>
400 and are checked by default depends on the distribution you use.
401
402 =back
403
404 =head2 Plugin C<apcups>
405
406 =over 4
407
408 =item B<Host> I<Hostname>
409
410 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
411 that IPv6 support has been disabled unless someone can confirm or decline that
412 B<apcupsd> can handle it.
413
414 =item B<Port> I<Port>
415
416 TCP-Port to connect to. Defaults to B<3551>.
417
418 =back
419
420 =head2 Plugin C<ascent>
421
422 This plugin collects information about an Ascent server, a free server for the
423 "World of Warcraft" game. This plugin gathers the information by fetching the
424 XML status page using C<libcurl> and parses it using C<libxml2>.
425
426 The configuration options are the same as for the C<apache> plugin above:
427
428 =over 4
429
430 =item B<URL> I<http://localhost/ascent/status/>
431
432 Sets the URL of the XML status output.
433
434 =item B<User> I<Username>
435
436 Optional user name needed for authentication.
437
438 =item B<Password> I<Password>
439
440 Optional password needed for authentication.
441
442 =item B<VerifyPeer> B<true|false>
443
444 Enable or disable peer SSL certificate verification. See
445 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
446
447 =item B<VerifyHost> B<true|false>
448
449 Enable or disable peer host name verification. If enabled, the plugin checks
450 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
451 certificate matches the host name provided by the B<URL> option. If this
452 identity check fails, the connection is aborted. Obviously, only works when
453 connecting to a SSL enabled server. Enabled by default.
454
455 =item B<CACert> I<File>
456
457 File that holds one or more SSL certificates. If you want to use HTTPS you will
458 possibly need this option. What CA certificates come bundled with C<libcurl>
459 and are checked by default depends on the distribution you use.
460
461 =back
462
463 =head2 Plugin C<bind>
464
465 Starting with BIND 9.5.0, the most widely used DNS server software provides
466 extensive statistics about queries, responses and lots of other information.
467 The bind plugin retrieves this information that's encoded in XML and provided
468 via HTTP and submits the values to collectd.
469
470 To use this plugin, you first need to tell BIND to make this information
471 available. This is done with the C<statistics-channels> configuration option:
472
473  statistics-channels {
474    inet localhost port 8053;
475  };
476
477 The configuration follows the grouping that can be seen when looking at the
478 data with an XSLT compatible viewer, such as a modern web browser. It's
479 probably a good idea to make yourself familiar with the provided values, so you
480 can understand what the collected statistics actually mean.
481
482 Synopsis:
483
484  <Plugin "bind">
485    URL "http://localhost:8053/"
486    OpCodes         true
487    QTypes          true
488  
489    ServerStats     true
490    ZoneMaintStats  true
491    ResolverStats   false
492    MemoryStats     true
493  
494    <View "_default">
495      QTypes        true
496      ResolverStats true
497      CacheRRSets   true
498  
499      Zone "127.in-addr.arpa/IN"
500    </View>
501  </Plugin>
502
503 The bind plugin accepts the following configuration options:
504
505 =over 4
506
507 =item B<URL> I<URL>
508
509 URL from which to retrieve the XML data. If not specified,
510 C<http://localhost:8053/> will be used.
511
512 =item B<OpCodes> I<true>|I<false>
513
514 When enabled, statistics about the I<"OpCodes">, for example the number of
515 C<QUERY> packets, are collected.
516
517 Default: Enabled.
518
519 =item B<QTypes> I<true>|I<false>
520
521 When enabled, the number of I<incoming> queries by query types (for example
522 C<A>, C<MX>, C<AAAA>) is collected.
523
524 Default: Enabled.
525
526 =item B<ServerStats> I<true>|I<false>
527
528 Collect global server statistics, such as requests received over IPv4 and IPv6,
529 successful queries, and failed updates.
530
531 Default: Enabled.
532
533 =item B<ZoneMaintStats> I<true>|I<false>
534
535 Collect zone maintenance statistics, mostly information about notifications
536 (zone updates) and zone transfers.
537
538 Default: Enabled.
539
540 =item B<ResolverStats> I<true>|I<false>
541
542 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
543 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
544 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
545 default. Use the B<ResolverStats> option within a B<View "_default"> block
546 instead for the same functionality.
547
548 Default: Disabled.
549
550 =item B<MemoryStats>
551
552 Collect global memory statistics.
553
554 Default: Enabled.
555
556 =item B<View> I<Name>
557
558 Collect statistics about a specific I<"view">. BIND can behave different,
559 mostly depending on the source IP-address of the request. These different
560 configurations are called "views". If you don't use this feature, you most
561 likely are only interested in the C<_default> view.
562
563 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
564 information you want to collect about a view. If no B<View> block is
565 configured, no detailed view statistics will be collected.
566
567 =over 4
568
569 =item B<QTypes> I<true>|I<false>
570
571 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
572 C<MX>) is collected.
573
574 Default: Enabled.
575
576 =item B<ResolverStats> I<true>|I<false>
577
578 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
579 (e.E<nbsp>g. queries over IPv4, lame servers).
580
581 Default: Enabled.
582
583 =item B<CacheRRSets> I<true>|I<false>
584
585 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
586 type is collected. Negative entries (queries which resulted in an error, for
587 example names that do not exist) are reported with a leading exclamation mark,
588 e.E<nbsp>g. "!A".
589
590 Default: Enabled.
591
592 =item B<Zone> I<Name>
593
594 When given, collect detailed information about the given zone in the view. The
595 information collected if very similar to the global B<ServerStats> information
596 (see above).
597
598 You can repeat this option to collect detailed information about multiple
599 zones.
600
601 By default no detailed zone information is collected.
602
603 =back
604
605 =back
606
607 =head2 Plugin C<cpufreq>
608
609 This plugin doesn't have any options. It reads
610 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
611 installed) to get the current CPU frequency. If this file does not exist make
612 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
613 installed and an "cpu governor" (that's a kernel module) is loaded.
614
615 =head2 Plugin C<csv>
616
617 =over 4
618
619 =item B<DataDir> I<Directory>
620
621 Set the directory to store CSV-files under. Per default CSV-files are generated
622 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
623 The special strings B<stdout> and B<stderr> can be used to write to the standard
624 output and standard error channels, respectively. This, of course, only makes
625 much sense when collectd is running in foreground- or non-daemon-mode.
626
627 =item B<StoreRates> B<true|false>
628
629 If set to B<true>, convert counter values to rates. If set to B<false> (the
630 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
631 number.
632
633 =back
634
635 =head2 Plugin C<curl>
636
637 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
638 and the match infrastructure (the same code used by the tail plugin) to use
639 regular expressions with the received data.
640
641 The following example will read the current value of AMD stock from Google's
642 finance page and dispatch the value to collectd.
643
644   <Plugin curl>
645     <Page "stock_quotes">
646       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
647       User "foo"
648       Password "bar"
649       <Match>
650         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
651         DSType "GaugeAverage"
652         # Note: `stock_value' is not a standard type.
653         Type "stock_value"
654         Instance "AMD"
655       </Match>
656     </Page>
657   </Plugin>
658
659 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
660 a web page and one or more "matches" to be performed on the returned data. The
661 string argument to the B<Page> block is used as plugin instance.
662
663 The following options are valid within B<Page> blocks:
664
665 =over 4
666
667 =item B<URL> I<URL>
668
669 URL of the web site to retrieve. Since a regular expression will be used to
670 extract information from this data, non-binary data is a big plus here ;)
671
672 =item B<User> I<Name>
673
674 Username to use if authorization is required to read the page.
675
676 =item B<Password> I<Password>
677
678 Password to use if authorization is required to read the page.
679
680 =item B<VerifyPeer> B<true>|B<false>
681
682 Enable or disable peer SSL certificate verification. See
683 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
684
685 =item B<VerifyHost> B<true>|B<false>
686
687 Enable or disable peer host name verification. If enabled, the plugin checks if
688 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
689 matches the host name provided by the B<URL> option. If this identity check
690 fails, the connection is aborted. Obviously, only works when connecting to a
691 SSL enabled server. Enabled by default.
692
693 =item B<CACert> I<file>
694
695 File that holds one or more SSL certificates. If you want to use HTTPS you will
696 possibly need this option. What CA certificates come bundled with C<libcurl>
697 and are checked by default depends on the distribution you use.
698
699 =item B<MeasureResponseTime> B<true>|B<false>
700
701 Measure response time for the request. If this setting is enabled, B<Match>
702 blocks (see below) are optional. Disabled by default.
703
704 =item B<E<lt>MatchE<gt>>
705
706 One or more B<Match> blocks that define how to match information in the data
707 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
708 used by the C<tail> plugin, so please see the documentation of the C<tail>
709 plugin below on how matches are defined. If the B<MeasureResponseTime> option
710 is set to B<true>, B<Match> blocks are optional.
711
712 =back
713
714 =head2 Plugin C<curl_json>
715
716 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
717 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
718 via cURL. This can be used to collect values from CouchDB documents (which are
719 stored JSON notation), for example.
720
721 The following example will collect several values from the built-in `_stats'
722 runtime statistics module of CouchDB
723 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
724
725   <Plugin curl_json>
726     <URL "http://localhost:5984/_stats">
727       Instance "httpd"
728       <Key "httpd/requests/count">
729         Type "http_requests"
730       </Key>
731
732       <Key "httpd_request_methods/*/count">
733         Type "http_request_methods"
734       </Key>
735
736       <Key "httpd_status_codes/*/count">
737         Type "http_response_codes"
738       </Key>
739     </URL>
740   </Plugin>
741
742 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
743 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
744 The B<Key> string argument must be in a path format, which is used to collect a
745 value from a JSON map object. If a path element of B<Key> is the
746 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
747
748 The following options are valid within B<URL> blocks:
749
750 =over 4
751
752 =item B<Instance> I<Instance>
753
754 Sets the plugin instance to I<Instance>.
755
756 =item B<User> I<Name>
757
758 Username to use if authorization is required to read the page.
759
760 =item B<Password> I<Password>
761
762 Password to use if authorization is required to read the page.
763
764 =item B<VerifyPeer> B<true>|B<false>
765
766 Enable or disable peer SSL certificate verification. See
767 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
768
769 =item B<VerifyHost> B<true>|B<false>
770
771 Enable or disable peer host name verification. If enabled, the plugin checks if
772 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
773 matches the host name provided by the B<URL> option. If this identity check
774 fails, the connection is aborted. Obviously, only works when connecting to a
775 SSL enabled server. Enabled by default.
776
777 =item B<CACert> I<file>
778
779 File that holds one or more SSL certificates. If you want to use HTTPS you will
780 possibly need this option. What CA certificates come bundled with C<libcurl>
781 and are checked by default depends on the distribution you use.
782
783 =back
784
785 The following options are valid within B<Key> blocks:
786
787 =over 4
788
789 =item B<Type> I<Type>
790
791 Sets the type used to dispatch the values to the daemon. Detailed information
792 about types and their configuration can be found in L<types.db(5)>. This
793 option is mandatory.
794
795 =item B<Instance> I<Instance>
796
797 Type-instance to use. Defaults to the current map key or current string array element value.
798
799 =back
800
801 =head2 Plugin C<curl_xml>
802
803 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
804 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
805
806  <Plugin "curl_xml">
807    <URL "http://localhost/stats.xml">
808      Host "my_host"
809      Instance "some_instance"
810      User "collectd"
811      Password "thaiNg0I"
812      VerifyPeer true
813      VerifyHost true
814      CACert "/path/to/ca.crt"
815
816      <XPath "table[@id=\"magic_level\"]/tr">
817        Type "magic_level"
818        #InstancePrefix "prefix-"
819        InstanceFrom "td[1]"
820        ValuesFrom "td[2]/span[@class=\"level\"]"
821      </XPath>
822    </URL>
823  </Plugin>
824
825 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
826 URL to be fetched via HTTP (using libcurl). Within each B<URL> block there are
827 options which specify the connection parameters, for example authentication
828 information, and one or more B<XPath> blocks.
829
830 Each B<XPath> block specifies how to get one type of information. The
831 string argument must be a valid XPath expression which returns a list
832 of "base elements". One value is dispatched for each "base element". The
833 I<type instance> and values are looked up using further I<XPath> expressions
834 that should be relative to the base element.
835
836 Within the B<URL> block the following options are accepted:
837
838 =over 4
839
840 =item B<Host> I<Name>
841
842 Use I<Name> as the host name when submitting values. Defaults to the global
843 host name setting.
844
845 =item B<Instance> I<Instance>
846
847 Use I<Instance> as the plugin instance when submitting values. Defaults to an
848 empty string (no plugin instance).
849
850 =item B<User> I<User>
851 =item B<Password> I<Password>
852 =item B<VerifyPeer> B<true>|B<false>
853 =item B<VerifyHost> B<true>|B<false>
854 =item B<CACert> I<CA Cert File>
855
856 These options behave exactly equivalent to the appropriate options of the
857 I<cURL> and I<cURL-JSON> plugins. Please see there for a detailed description.
858
859 =item E<lt>B<XPath> I<XPath-expression>E<gt>
860
861 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
862 B<XPath> block specifies how to get one type of information. The string
863 argument must be a valid XPath expression which returns a list of "base
864 elements". One value is dispatched for each "base element".
865
866 Within the B<XPath> block the following options are accepted:
867
868 =over 4
869
870 =item B<Type> I<Type>
871
872 Specifies the I<Type> used for submitting patches. This determines the number
873 of values that are required / expected and whether the strings are parsed as
874 signed or unsigned integer or as double values. See L<types.db(5)> for details.
875 This option is required.
876
877 =item B<InstancePrefix> I<InstancePrefix>
878
879 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
880 concatenated together without any separator.
881 This option is optional.
882
883 =item B<InstanceFrom> I<InstanceFrom>
884
885 Specifies a XPath expression to use for determining the I<type instance>. The
886 XPath expression must return exactly one element. The element's value is then
887 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
888
889 This value is required. As a special exception, if the "base XPath expression"
890 (the argument to the B<XPath> block) returns exactly one argument, then this
891 option may be omitted.
892
893 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
894
895 Specifies one or more XPath expression to use for reading the values. The
896 number of XPath expressions must match the number of data sources in the
897 I<type> specified with B<Type> (see above). Each XPath expression must return
898 exactly one element. The element's value is then parsed as a number and used as
899 value for the appropriate value in the value list dispatched to the daemon.
900
901 =back
902
903 =back
904
905 =head2 Plugin C<dbi>
906
907 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
908 connect to various databases, execute I<SQL> statements and read back the
909 results. I<dbi> is an acronym for "database interface" in case you were
910 wondering about the name. You can configure how each column is to be
911 interpreted and the plugin will generate one or more data sets from each row
912 returned according to these rules.
913
914 Because the plugin is very generic, the configuration is a little more complex
915 than those of other plugins. It usually looks something like this:
916
917   <Plugin dbi>
918     <Query "out_of_stock">
919       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
920       # Use with MySQL 5.0.0 or later
921       MinVersion 50000
922       <Result>
923         Type "gauge"
924         InstancePrefix "out_of_stock"
925         InstancesFrom "category"
926         ValuesFrom "value"
927       </Result>
928     </Query>
929     <Database "product_information">
930       Driver "mysql"
931       DriverOption "host" "localhost"
932       DriverOption "username" "collectd"
933       DriverOption "password" "aZo6daiw"
934       DriverOption "dbname" "prod_info"
935       SelectDB "prod_info"
936       Query "out_of_stock"
937     </Database>
938   </Plugin>
939
940 The configuration above defines one query with one result and one database. The
941 query is then linked to the database with the B<Query> option I<within> the
942 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
943 and you can also use the B<Include> statement to split up the configuration
944 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
945 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
946 top to bottom!
947
948 The following is a complete list of options:
949
950 =head3 B<Query> blocks
951
952 Query blocks define I<SQL> statements and how the returned data should be
953 interpreted. They are identified by the name that is given in the opening line
954 of the block. Thus the name needs to be unique. Other than that, the name is
955 not used in collectd.
956
957 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
958 define which column holds which value or instance information. You can use
959 multiple B<Result> blocks to create multiple values from one returned row. This
960 is especially useful, when queries take a long time and sending almost the same
961 query again and again is not desirable.
962
963 Example:
964
965   <Query "environment">
966     Statement "select station, temperature, humidity from environment"
967     <Result>
968       Type "temperature"
969       # InstancePrefix "foo"
970       InstancesFrom "station"
971       ValuesFrom "temperature"
972     </Result>
973     <Result>
974       Type "humidity"
975       InstancesFrom "station"
976       ValuesFrom "humidity"
977     </Result>
978   </Query>
979
980 The following options are accepted:
981
982 =over 4
983
984 =item B<Statement> I<SQL>
985
986 Sets the statement that should be executed on the server. This is B<not>
987 interpreted by collectd, but simply passed to the database server. Therefore,
988 the SQL dialect that's used depends on the server collectd is connected to.
989
990 The query has to return at least two columns, one for the instance and one
991 value. You cannot omit the instance, even if the statement is guaranteed to
992 always return exactly one line. In that case, you can usually specify something
993 like this:
994
995   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
996
997 (That works with MySQL but may not be valid SQL according to the spec. If you
998 use a more strict database server, you may have to select from a dummy table or
999 something.)
1000
1001 Please note that some databases, for example B<Oracle>, will fail if you
1002 include a semicolon at the end of the statement.
1003
1004 =item B<MinVersion> I<Version>
1005
1006 =item B<MaxVersion> I<Value>
1007
1008 Only use this query for the specified database version. You can use these
1009 options to provide multiple queries with the same name but with a slightly
1010 different syntax. The plugin will use only those queries, where the specified
1011 minimum and maximum versions fit the version of the database in use.
1012
1013 The database version is determined by C<dbi_conn_get_engine_version>, see the
1014 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1015 for details. Basically, each part of the version is assumed to be in the range
1016 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1017 "40102", version "5.0.42" becomes "50042".
1018
1019 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1020 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1021 happen. Don't to it! A valid example would be something along these lines:
1022
1023   MinVersion 40000
1024   MaxVersion 49999
1025   ...
1026   MinVersion 50000
1027   MaxVersion 50099
1028   ...
1029   MinVersion 50100
1030   # No maximum
1031
1032 In the above example, there are three ranges that don't overlap. The last one
1033 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1034 before "4.0.0" are not specified.
1035
1036 =item B<Type> I<Type>
1037
1038 The B<type> that's used for each line returned. See L<types.db(5)> for more
1039 details on how types are defined. In short: A type is a predefined layout of
1040 data and the number of values and type of values has to match the type
1041 definition.
1042
1043 If you specify "temperature" here, you need exactly one gauge column. If you
1044 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1045 setting below.
1046
1047 There must be exactly one B<Type> option inside each B<Result> block.
1048
1049 =item B<InstancePrefix> I<prefix>
1050
1051 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1052 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1053 all strings returned in the appropriate columns are concatenated together,
1054 separated by dashes I<("-")>.
1055
1056 =item B<InstancesFrom> I<column0> [I<column1> ...]
1057
1058 Specifies the columns whose values will be used to create the "type-instance"
1059 for each row. If you specify more than one column, the value of all columns
1060 will be joined together with dashes I<("-")> as separation characters.
1061
1062 The plugin itself does not check whether or not all built instances are
1063 different. It's your responsibility to assure that each is unique. This is
1064 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1065 sure that only one row is returned in this case.
1066
1067 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1068 will be empty.
1069
1070 =item B<ValuesFrom> I<column0> [I<column1> ...]
1071
1072 Names the columns whose content is used as the actual data for the data sets
1073 that are dispatched to the daemon. How many such columns you need is determined
1074 by the B<Type> setting above. If you specify too many or not enough columns,
1075 the plugin will complain about that and no data will be submitted to the
1076 daemon.
1077
1078 The actual data type in the columns is not that important. The plugin will
1079 automatically cast the values to the right type if it know how to do that. So
1080 it should be able to handle integer an floating point types, as well as strings
1081 (if they include a number at the beginning).
1082
1083 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1084
1085 =back
1086
1087 =head3 B<Database> blocks
1088
1089 Database blocks define a connection to a database and which queries should be
1090 sent to that database. Since the used "dbi" library can handle a wide variety
1091 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1092 documentationE<nbsp>- we stick as close to the terminology used there.
1093
1094 Each database needs a "name" as string argument in the starting tag of the
1095 block. This name will be used as "PluginInstance" in the values submitted to
1096 the daemon. Other than that, that name is not used.
1097
1098 =over 4
1099
1100 =item B<Driver> I<Driver>
1101
1102 Specifies the driver to use to connect to the database. In many cases those
1103 drivers are named after the database they can connect to, but this is not a
1104 technical necessity. These drivers are sometimes referred to as "DBD",
1105 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1106 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1107 project at L<http://libdbi-drivers.sourceforge.net/>.
1108
1109 You need to give the driver name as expected by the "dbi" library here. You
1110 should be able to find that in the documentation for each driver. If you
1111 mistype the driver name, the plugin will dump a list of all known driver names
1112 to the log.
1113
1114 =item B<DriverOption> I<Key> I<Value>
1115
1116 Sets driver-specific options. What option a driver supports can be found in the
1117 documentation for each driver, somewhere at
1118 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1119 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1120
1121 Unfortunately, drivers are not too keen to report errors when an unknown option
1122 is passed to them, so invalid settings here may go unnoticed. This is not the
1123 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1124 the driver. If a driver complains about an option, the plugin will dump a
1125 complete list of all options understood by that driver to the log.
1126
1127 =item B<SelectDB> I<Database>
1128
1129 In some cases, the database name you connect with is not the database name you
1130 want to use for querying data. If this option is set, the plugin will "select"
1131 (switch to) that database after the connection is established.
1132
1133 =item B<Query> I<QueryName>
1134
1135 Associates the query named I<QueryName> with this database connection. The
1136 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1137 blocks you want to refer to must be placed above the database block you want to
1138 refer to them from.
1139
1140 =back
1141
1142 =head2 Plugin C<df>
1143
1144 =over 4
1145
1146 =item B<Device> I<Device>
1147
1148 Select partitions based on the devicename.
1149
1150 =item B<MountPoint> I<Directory>
1151
1152 Select partitions based on the mountpoint.
1153
1154 =item B<FSType> I<FSType>
1155
1156 Select partitions based on the filesystem type.
1157
1158 =item B<IgnoreSelected> B<true>|B<false>
1159
1160 Invert the selection: If set to true, all partitions B<except> the ones that
1161 match any one of the criteria are collected. By default only selected
1162 partitions are collected if a selection is made. If no selection is configured
1163 at all, B<all> partitions are selected.
1164
1165 =item B<ReportByDevice> B<true>|B<false>
1166
1167 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1168 (the default), it will report a disk as "root", but with it I<true>, it will be
1169 "sda1" (or whichever).
1170
1171 =item B<ReportInodes> B<true>|B<false>
1172
1173 Enables or disables reporting of free, reserved and used inodes. Defaults to
1174 inode collection being disabled.
1175
1176 Enable this option if inodes are a scarce resource for you, usually because
1177 many small files are stored on the disk. This is a usual scenario for mail
1178 transfer agents and web caches.
1179
1180 =back
1181
1182 =head2 Plugin C<disk>
1183
1184 The C<disk> plugin collects information about the usage of physical disks and
1185 logical disks (partitions). Values collected are the number of octets written
1186 to and read from a disk or partition, the number of read/write operations
1187 issued to the disk and a rather complex "time" it took for these commands to be
1188 issued.
1189
1190 Using the following two options you can ignore some disks or configure the
1191 collection only of specific disks.
1192
1193 =over 4
1194
1195 =item B<Disk> I<Name>
1196
1197 Select the disk I<Name>. Whether it is collected or ignored depends on the
1198 B<IgnoreSelected> setting, see below. As with other plugins that use the
1199 daemon's ignorelist functionality, a string that starts and ends with a slash
1200 is interpreted as a regular expression. Examples:
1201
1202   Disk "sdd"
1203   Disk "/hda[34]/"
1204
1205 =item B<IgnoreSelected> B<true>|B<false>
1206
1207 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1208 statements, are ignored or if all other disks are ignored. The behavior
1209 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1210 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1211 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1212 is set to B<true>, all disks are collected B<except> the ones matched.
1213
1214 =back
1215
1216 =head2 Plugin C<dns>
1217
1218 =over 4
1219
1220 =item B<Interface> I<Interface>
1221
1222 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1223 option sets the interface that should be used. If this option is not set, or
1224 set to "any", the plugin will try to get packets from B<all> interfaces. This
1225 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1226
1227 =item B<IgnoreSource> I<IP-address>
1228
1229 Ignore packets that originate from this address.
1230
1231 =item B<SelectNumericQueryTypes> B<true>|B<false>
1232
1233 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1234
1235 =back
1236
1237 =head2 Plugin C<email>
1238
1239 =over 4
1240
1241 =item B<SocketFile> I<Path>
1242
1243 Sets the socket-file which is to be created.
1244
1245 =item B<SocketGroup> I<Group>
1246
1247 If running as root change the group of the UNIX-socket after it has been
1248 created. Defaults to B<collectd>.
1249
1250 =item B<SocketPerms> I<Permissions>
1251
1252 Change the file permissions of the UNIX-socket after it has been created. The
1253 permissions must be given as a numeric, octal value as you would pass to
1254 L<chmod(1)>. Defaults to B<0770>.
1255
1256 =item B<MaxConns> I<Number>
1257
1258 Sets the maximum number of connections that can be handled in parallel. Since
1259 this many threads will be started immediately setting this to a very high
1260 value will waste valuable resources. Defaults to B<5> and will be forced to be
1261 at most B<16384> to prevent typos and dumb mistakes.
1262
1263 =back
1264
1265 =head2 Plugin C<exec>
1266
1267 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1268 contains valuable information on when the executable is executed and the
1269 output that is expected from it.
1270
1271 =over 4
1272
1273 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1274
1275 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1276
1277 Execute the executable I<Executable> as user I<User>. If the user name is
1278 followed by a colon and a group name, the effective group is set to that group.
1279 The real group and saved-set group will be set to the default group of that
1280 user. If no group is given the effective group ID will be the same as the real
1281 group ID.
1282
1283 Please note that in order to change the user and/or group the daemon needs
1284 superuser privileges. If the daemon is run as an unprivileged user you must
1285 specify the same user/group here. If the daemon is run with superuser
1286 privileges, you must supply a non-root user here.
1287
1288 The executable may be followed by optional arguments that are passed to the
1289 program. Please note that due to the configuration parsing numbers and boolean
1290 values may be changed. If you want to be absolutely sure that something is
1291 passed as-is please enclose it in quotes.
1292
1293 The B<Exec> and B<NotificationExec> statements change the semantics of the
1294 programs executed, i.E<nbsp>e. the data passed to them and the response
1295 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1296
1297 =back
1298
1299 =head2 Plugin C<filecount>
1300
1301 The C<filecount> plugin counts the number of files in a certain directory (and
1302 its subdirectories) and their combined size. The configuration is very straight
1303 forward:
1304
1305   <Plugin "filecount">
1306     <Directory "/var/qmail/queue/mess">
1307       Instance "qmail-message"
1308     </Directory>
1309     <Directory "/var/qmail/queue/todo">
1310       Instance "qmail-todo"
1311     </Directory>
1312     <Directory "/var/lib/php5">
1313       Instance "php5-sessions"
1314       Name "sess_*"
1315     </Directory>
1316   </Plugin>
1317
1318 The example above counts the number of files in QMail's queue directories and
1319 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1320 QMail has not yet looked at, the "message" queue holds the messages that were
1321 classified into "local" and "remote".
1322
1323 As you can see, the configuration consists of one or more C<Directory> blocks,
1324 each of which specifies a directory in which to count the files. Within those
1325 blocks, the following options are recognized:
1326
1327 =over 4
1328
1329 =item B<Instance> I<Instance>
1330
1331 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1332 it's your responsibility, the plugin doesn't check for that. If not given, the
1333 instance is set to the directory name with all slashes replaced by underscores
1334 and all leading underscores removed.
1335
1336 =item B<Name> I<Pattern>
1337
1338 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1339 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1340 against the pattern, not the entire path. In case this makes it easier for you:
1341 This option has been named after the B<-name> parameter to L<find(1)>.
1342
1343 =item B<MTime> I<Age>
1344
1345 Count only files of a specific age: If I<Age> is greater than zero, only files
1346 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1347 a negative number, this is inversed. For example, if B<-60> is specified, only
1348 files that have been modified in the last minute will be counted.
1349
1350 The number can also be followed by a "multiplier" to easily specify a larger
1351 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1352 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1353 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1354 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1355 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1356 B<"12h">.
1357
1358 =item B<Size> I<Size>
1359
1360 Count only files of a specific size. When I<Size> is a positive number, only
1361 files that are at least this big are counted. If I<Size> is a negative number,
1362 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1363 I<Size> are counted.
1364
1365 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1366 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1367 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1368 note that there are 1000 bytes in a kilobyte, not 1024.
1369
1370 =item B<Recursive> I<true>|I<false>
1371
1372 Controls whether or not to recurse into subdirectories. Enabled by default.
1373
1374 =item B<IncludeHidden> I<true>|I<false>
1375
1376 Controls whether or not to include "hidden" files and directories in the count.
1377 "Hidden" files and directories are those, whose name begins with a dot.
1378 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1379
1380 =back
1381
1382 =head2 Plugin C<GenericJMX>
1383
1384 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1385 L<collectd-java(5)>.
1386
1387 =head2 Plugin C<gmond>
1388
1389 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1390 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1391 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1392
1393 Synopsis:
1394
1395  <Plugin "gmond">
1396    MCReceiveFrom "239.2.11.71" "8649"
1397    <Metric "swap_total">
1398      Type "swap"
1399      TypeInstance "total"
1400      DataSource "value"
1401    </Metric>
1402    <Metric "swap_free">
1403      Type "swap"
1404      TypeInstance "free"
1405      DataSource "value"
1406    </Metric>
1407  </Plugin>
1408
1409 The following metrics are built-in:
1410
1411 =over 4
1412
1413 =item *
1414
1415 load_one, load_five, load_fifteen
1416
1417 =item *
1418
1419 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1420
1421 =item *
1422
1423 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1424
1425 =item *
1426
1427 bytes_in, bytes_out
1428
1429 =item *
1430
1431 pkts_in, pkts_out
1432
1433 =back
1434
1435 Available configuration options:
1436
1437 =over 4
1438
1439 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1440
1441 Sets sets the multicast group and UDP port to which to subscribe.
1442
1443 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1444
1445 =item E<lt>B<Metric> I<Name>E<gt>
1446
1447 These blocks add a new metric conversion to the internal table. I<Name>, the
1448 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1449
1450 =over 4
1451
1452 =item B<Type> I<Type>
1453
1454 Type to map this metric to. Required.
1455
1456 =item B<TypeInstance> I<Instance>
1457
1458 Type-instance to use. Optional.
1459
1460 =item B<DataSource> I<Name>
1461
1462 Data source to map this metric to. If the configured type has exactly one data
1463 source, this is optional. Otherwise the option is required.
1464
1465 =back
1466
1467 =back
1468
1469 =head2 Plugin C<hddtemp>
1470
1471 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1472 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1473 default values, see below. C<hddtemp> has to be running to work correctly. If
1474 C<hddtemp> is not running timeouts may appear which may interfere with other
1475 statistics..
1476
1477 The B<hddtemp> homepage can be found at
1478 L<http://www.guzu.net/linux/hddtemp.php>.
1479
1480 =over 4
1481
1482 =item B<Host> I<Hostname>
1483
1484 Hostname to connect to. Defaults to B<127.0.0.1>.
1485
1486 =item B<Port> I<Port>
1487
1488 TCP-Port to connect to. Defaults to B<7634>.
1489
1490 =back
1491
1492 =head2 Plugin C<interface>
1493
1494 =over 4
1495
1496 =item B<Interface> I<Interface>
1497
1498 Select this interface. By default these interfaces will then be collected. For
1499 a more detailed description see B<IgnoreSelected> below.
1500
1501 =item B<IgnoreSelected> I<true>|I<false>
1502
1503 If no configuration if given, the B<traffic>-plugin will collect data from
1504 all interfaces. This may not be practical, especially for loopback- and
1505 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1506 interfaces you're interested in. Sometimes, however, it's easier/preferred
1507 to collect all interfaces I<except> a few ones. This option enables you to
1508 do that: By setting B<IgnoreSelected> to I<true> the effect of
1509 B<Interface> is inverted: All selected interfaces are ignored and all
1510 other interfaces are collected.
1511
1512 =back
1513
1514 =head2 Plugin C<ipmi>
1515
1516 =over 4
1517
1518 =item B<Sensor> I<Sensor>
1519
1520 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1521
1522 =item B<IgnoreSelected> I<true>|I<false>
1523
1524 If no configuration if given, the B<ipmi> plugin will collect data from all
1525 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1526 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1527 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1528 all other sensors are collected.
1529
1530 =item B<NotifySensorAdd> I<true>|I<false>
1531
1532 If a sensor appears after initialization time of a minute a notification
1533 is sent.
1534
1535 =item B<NotifySensorRemove> I<true>|I<false>
1536
1537 If a sensor disappears a notification is sent.
1538
1539 =item B<NotifySensorNotPresent> I<true>|I<false>
1540
1541 If you have for example dual power supply and one of them is (un)plugged then
1542 a notification is sent.
1543
1544 =back
1545
1546 =head2 Plugin C<iptables>
1547
1548 =over 4
1549
1550 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1551
1552 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1553 will collect the counters of all rules which have a comment-match. The comment
1554 is then used as type-instance.
1555
1556 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1557 the I<n>th rule will be collected. Again, the comment (or the number) will be
1558 used as the type-instance.
1559
1560 If I<Name> is supplied, it will be used as the type-instance instead of the
1561 comment or the number.
1562
1563 =back
1564
1565 =head2 Plugin C<irq>
1566
1567 =over 4
1568
1569 =item B<Irq> I<Irq>
1570
1571 Select this irq. By default these irqs will then be collected. For a more
1572 detailed description see B<IgnoreSelected> below.
1573
1574 =item B<IgnoreSelected> I<true>|I<false>
1575
1576 If no configuration if given, the B<irq>-plugin will collect data from all
1577 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1578 can use the B<Irq>-option to pick the interrupt you're interested in.
1579 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1580 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1581 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1582 and all other interrupts are collected.
1583
1584 =back
1585
1586 =head2 Plugin C<java>
1587
1588 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1589 This section only discusses the syntax and semantic of the configuration
1590 options. For more in-depth information on the I<Java> plugin, please read
1591 L<collectd-java(5)>.
1592
1593 Synopsis:
1594
1595  <Plugin "java">
1596    JVMArg "-verbose:jni"
1597    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1598    LoadPlugin "org.collectd.java.Foobar"
1599    <Plugin "org.collectd.java.Foobar">
1600      # To be parsed by the plugin
1601    </Plugin>
1602  </Plugin>
1603
1604 Available configuration options:
1605
1606 =over 4
1607
1608 =item B<JVMArg> I<Argument>
1609
1610 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1611 exactly the way the arguments to the I<java> binary on the command line work.
1612 Execute C<javaE<nbsp>--help> for details.
1613
1614 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1615 any other options! When another option is found, the JVM will be started and
1616 later options will have to be ignored!
1617
1618 =item B<LoadPlugin> I<JavaClass>
1619
1620 Instantiates a new I<JavaClass> object. The constructor of this object very
1621 likely then registers one or more callback methods with the server.
1622
1623 See L<collectd-java(5)> for details.
1624
1625 When the first such option is found, the virtual machine (JVM) is created. This
1626 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1627 B<LoadPlugin> options!
1628
1629 =item B<Plugin> I<Name>
1630
1631 The entire block is passed to the Java plugin as an
1632 I<org.collectd.api.OConfigItem> object.
1633
1634 For this to work, the plugin has to register a configuration callback first,
1635 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1636 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1637 depends on the (Java) plugin registering the callback and is completely
1638 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1639
1640 =back
1641
1642 =head2 Plugin C<libvirt>
1643
1644 This plugin allows CPU, disk and network load to be collected for virtualized
1645 guests on the machine. This means that these characteristics can be collected
1646 for guest systems without installing any software on them - collectd only runs
1647 on the hosting system. The statistics are collected through libvirt
1648 (L<http://libvirt.org/>).
1649
1650 Only I<Connection> is required.
1651
1652 =over 4
1653
1654 =item B<Connection> I<uri>
1655
1656 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1657
1658  Connection "xen:///"
1659
1660 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1661
1662 =item B<RefreshInterval> I<seconds>
1663
1664 Refresh the list of domains and devices every I<seconds>. The default is 60
1665 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1666 the list of domains and devices to be refreshed on every iteration.
1667
1668 Refreshing the devices in particular is quite a costly operation, so if your
1669 virtualization setup is static you might consider increasing this. If this
1670 option is set to 0, refreshing is disabled completely.
1671
1672 =item B<Domain> I<name>
1673
1674 =item B<BlockDevice> I<name:dev>
1675
1676 =item B<InterfaceDevice> I<name:dev>
1677
1678 =item B<IgnoreSelected> I<true>|I<false>
1679
1680 Select which domains and devices are collected.
1681
1682 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
1683 disk/network devices are collected.
1684
1685 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
1686 domains and disk/network devices are ignored, while the rest are collected.
1687
1688 The domain name and device names may use a regular expression, if the name is
1689 surrounded by I</.../> and collectd was compiled with support for regexps.
1690
1691 The default is to collect statistics for all domains and all their devices.
1692
1693 Example:
1694
1695  BlockDevice "/:hdb/"
1696  IgnoreSelected "true"
1697
1698 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
1699 will be collected.
1700
1701 =item B<HostnameFormat> B<name|uuid|hostname|...>
1702
1703 When the libvirt plugin logs data, it sets the hostname of the collected data
1704 according to this setting. The default is to use the guest name as provided by
1705 the hypervisor, which is equal to setting B<name>.
1706
1707 B<uuid> means use the guest's UUID. This is useful if you want to track the
1708 same guest across migrations.
1709
1710 B<hostname> means to use the global B<Hostname> setting, which is probably not
1711 useful on its own because all guests will appear to have the same name.
1712
1713 You can also specify combinations of these fields. For example B<name uuid>
1714 means to concatenate the guest name and UUID (with a literal colon character
1715 between, thus I<"foo:1234-1234-1234-1234">).
1716
1717 =item B<InterfaceFormat> B<name>|B<address>
1718
1719 When the libvirt plugin logs interface data, it sets the name of the collected
1720 data according to this setting. The default is to use the path as provided by
1721 the hypervisor (the "dev" property of the target node), which is equal to
1722 setting B<name>.
1723
1724 B<address> means use the interface's mac address. This is useful since the
1725 interface path might change between reboots of a guest or across migrations.
1726
1727 =back
1728
1729 =head2 Plugin C<logfile>
1730
1731 =over 4
1732
1733 =item B<LogLevel> B<debug|info|notice|warning|err>
1734
1735 Sets the log-level. If, for example, set to B<notice>, then all events with
1736 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
1737
1738 Please note that B<debug> is only available if collectd has been compiled with
1739 debugging support.
1740
1741 =item B<File> I<File>
1742
1743 Sets the file to write log messages to. The special strings B<stdout> and
1744 B<stderr> can be used to write to the standard output and standard error
1745 channels, respectively. This, of course, only makes much sense when I<collectd>
1746 is running in foreground- or non-daemon-mode.
1747
1748 =item B<Timestamp> B<true>|B<false>
1749
1750 Prefix all lines printed by the current time. Defaults to B<true>.
1751
1752 =item B<PrintSeverity> B<true>|B<false>
1753
1754 When enabled, all lines are prefixed by the severity of the log message, for
1755 example "warning". Defaults to B<false>.
1756
1757 =back
1758
1759 B<Note>: There is no need to notify the daemon after moving or removing the
1760 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
1761 for each line it writes.
1762
1763 =head2 Plugin C<lpar>
1764
1765 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
1766 virtualization technique for IBM POWER processors. It takes into account CPU
1767 time stolen from or donated to a partition, in addition to the usual user,
1768 system, I/O statistics.
1769
1770 The following configuration options are available:
1771
1772 =over 4
1773
1774 =item B<CpuPoolStats> B<false>|B<true>
1775
1776 When enabled, statistics about the processor pool are read, too. The partition
1777 needs to have pool authority in order to be able to acquire this information.
1778 Defaults to false.
1779
1780 =item B<ReportBySerial> B<false>|B<true>
1781
1782 If enabled, the serial of the physical machine the partition is currently
1783 running on is reported as I<hostname> and the logical hostname of the machine
1784 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
1785 used (just like other plugins) and the I<plugin instance> will be empty.
1786 Defaults to false.
1787
1788 =back
1789
1790 =head2 Plugin C<mbmon>
1791
1792 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
1793
1794 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
1795 B<Host> and B<Port> options can be used to change these values, see below.
1796 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
1797 timeouts may appear which may interfere with other statistics..
1798
1799 C<mbmon> must be run with the -r option ("print TAG and Value format");
1800 Debian's F</etc/init.d/mbmon> script already does this, other people
1801 will need to ensure that this is the case.
1802
1803 =over 4
1804
1805 =item B<Host> I<Hostname>
1806
1807 Hostname to connect to. Defaults to B<127.0.0.1>.
1808
1809 =item B<Port> I<Port>
1810
1811 TCP-Port to connect to. Defaults to B<411>.
1812
1813 =back
1814
1815 =head2 Plugin C<memcachec>
1816
1817 The C<memcachec plugin> connects to a memcached server, queries one or more
1818 given I<pages> and parses the returned data according to user specification.
1819 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
1820 plugins.
1821
1822 In order to talk to the memcached server, this plugin uses the I<libmemcached>
1823 library. Please note that there is another library with a very similar name,
1824 libmemcache (notice the missing `d'), which is not applicable.
1825
1826 Synopsis of the configuration:
1827
1828  <Plugin "memcachec">
1829    <Page "plugin_instance">
1830      Server "localhost"
1831      Key "page_key"
1832      <Match>
1833        Regex "(\\d+) bytes sent"
1834        DSType CounterAdd
1835        Type "ipt_octets"
1836        Instance "type_instance"
1837      </Match>
1838    </Page>
1839  </Plugin>
1840
1841 The configuration options are:
1842
1843 =over 4
1844
1845 =item E<lt>B<Page> I<Name>E<gt>
1846
1847 Each B<Page> block defines one I<page> to be queried from the memcached server.
1848 The block requires one string argument which is used as I<plugin instance>.
1849
1850 =item B<Server> I<Address>
1851
1852 Sets the server address to connect to when querying the page. Must be inside a
1853 B<Page> block.
1854
1855 =item B<Key> I<Key>
1856
1857 When connected to the memcached server, asks for the page I<Key>.
1858
1859 =item E<lt>B<Match>E<gt>
1860
1861 Match blocks define which strings to look for and how matches substrings are
1862 interpreted. For a description of match blocks, please see L<"Plugin tail">.
1863
1864 =back
1865
1866 =head2 Plugin C<memcached>
1867
1868 The C<memcached plugin> connects to a memcached server and queries statistics
1869 about cache utilization, memory and bandwidth used.
1870 L<http://www.danga.com/memcached/>
1871
1872 =over 4
1873
1874 =item B<Host> I<Hostname>
1875
1876 Hostname to connect to. Defaults to B<127.0.0.1>.
1877
1878 =item B<Port> I<Port>
1879
1880 TCP-Port to connect to. Defaults to B<11211>.
1881
1882 =back
1883
1884 =head2 Plugin C<modbus>
1885
1886 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
1887 register values. It supports reading single registers (unsigned 16E<nbsp>bit
1888 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
1889 values (two registers interpreted as IEEE floats in big endian notation).
1890
1891 Synopsis:
1892
1893  <Data "voltage-input-1">
1894    RegisterBase 0
1895    RegisterType float
1896    Type voltage
1897    Instance "input-1"
1898  </Data>
1899  
1900  <Data "voltage-input-2">
1901    RegisterBase 2
1902    RegisterType float
1903    Type voltage
1904    Instance "input-2"
1905  </Data>
1906  
1907  <Host "modbus.example.com">
1908    Address "192.168.0.42"
1909    Port    "502"
1910    Interval 60
1911    
1912    <Slave 1>
1913      Instance "power-supply"
1914      Collect  "voltage-input-1"
1915      Collect  "voltage-input-2"
1916    </Slave>
1917  </Host>
1918
1919 =over 4
1920
1921 =item E<lt>B<Data> I<Name>E<gt> blocks
1922
1923 Data blocks define a mapping between register numbers and the "types" used by
1924 I<collectd>.
1925
1926 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
1927
1928 =over 4
1929
1930 =item B<RegisterBase> I<Number>
1931
1932 Configures the base register to read from the device. If the option
1933 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
1934 register will be read (the register number is increased by one).
1935
1936 =item B<RegisterType> B<Uint16>|B<Uint32>|B<Float>
1937
1938 Specifies what kind of data is returned by the device. If the type is B<Uint32>
1939 or B<Float>, two 16E<nbsp>bit registers will be read and the data is combined
1940 into one value. Defaults to B<Uint16>.
1941
1942 =item B<Type> I<Type>
1943
1944 Specifies the "type" (data set) to use when dispatching the value to
1945 I<collectd>. Currently, only data sets with exactly one data source are
1946 supported.
1947
1948 =item B<Instance> I<Instance>
1949
1950 Sets the type instance to use when dispatching the value to I<collectd>. If
1951 unset, an empty string (no type instance) is used.
1952
1953 =back
1954
1955 =item E<lt>B<Host> I<Name>E<gt> blocks
1956
1957 Host blocks are used to specify to which hosts to connect and what data to read
1958 from their "slaves". The string argument I<Name> is used as hostname when
1959 dispatching the values to I<collectd>.
1960
1961 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
1962
1963 =over 4
1964
1965 =item B<Address> I<Hostname>
1966
1967 Specifies the node name (the actual network address) used to connect to the
1968 host. This may be an IP address or a hostname. Please note that the used
1969 I<libmodbus> library only supports IPv4 at the moment.
1970
1971 =item B<Port> I<Service>
1972
1973 Specifies the port used to connect to the host. The port can either be given as
1974 a number or as a service name. Please note that the I<Service> argument must be
1975 a string, even if ports are given in their numerical form. Defaults to "502".
1976
1977 =item B<Interval> I<Interval>
1978
1979 Sets the interval (in seconds) in which the values will be collected from this
1980 host. By default the global B<Interval> setting will be used.
1981
1982 =item E<lt>B<Slave> I<ID>E<gt>
1983
1984 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
1985 is used to specify which device should be addressed. For each device you want
1986 to query, one B<Slave> block must be given.
1987
1988 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
1989
1990 =over 4
1991
1992 =item B<Instance> I<Instance>
1993
1994 Specify the plugin instance to use when dispatching the values to I<collectd>.
1995 By default "slave_I<ID>" is used.
1996
1997 =item B<Collect> I<DataName>
1998
1999 Specifies which data to retrieve from the device. I<DataName> must be the same
2000 string as the I<Name> argument passed to a B<Data> block. You can specify this
2001 option multiple times to collect more than one value from a slave. At least one
2002 B<Collect> option is mandatory.
2003
2004 =back
2005
2006 =back
2007
2008 =back
2009
2010 =head2 Plugin C<mysql>
2011
2012 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2013 one or more databases when started and keeps the connection up as long as
2014 possible. When the connection is interrupted for whatever reason it will try
2015 to re-connect. The plugin will complain loudly in case anything goes wrong.
2016
2017 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2018 and collects information about MySQL network traffic, executed statements,
2019 requests, the query cache and threads by evaluating the
2020 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2021 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2022 Status Variables> for an explanation of these values.
2023
2024 Optionally, master and slave statistics may be collected in a MySQL
2025 replication setup. In that case, information about the synchronization state
2026 of the nodes are collected by evaluating the C<Position> return value of the
2027 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2028 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2029 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2030 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2031 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2032
2033 Synopsis:
2034
2035   <Plugin mysql>
2036     <Database foo>
2037       Host "hostname"
2038       User "username"
2039       Password "password"
2040       Port "3306"
2041       MasterStats true
2042     </Database>
2043
2044     <Database bar>
2045       Host "localhost"
2046       Socket "/var/run/mysql/mysqld.sock"
2047       SlaveStats true
2048       SlaveNotifications true
2049     </Database>
2050   </Plugin>
2051
2052 A B<Database> block defines one connection to a MySQL database. It accepts a
2053 single argument which specifies the name of the database. None of the other
2054 options are required. MySQL will use default values as documented in the
2055 section "mysql_real_connect()" in the B<MySQL reference manual>.
2056
2057 =over 4
2058
2059 =item B<Host> I<Hostname>
2060
2061 Hostname of the database server. Defaults to B<localhost>.
2062
2063 =item B<User> I<Username>
2064
2065 Username to use when connecting to the database. The user does not have to be
2066 granted any privileges (which is synonym to granting the C<USAGE> privilege).
2067 Any existing MySQL user will do.
2068
2069 =item B<Password> I<Password>
2070
2071 Password needed to log into the database.
2072
2073 =item B<Database> I<Database>
2074
2075 Select this database. Defaults to I<no database> which is a perfectly reasonable
2076 option for what this plugin does.
2077
2078 =item B<Port> I<Port>
2079
2080 TCP-port to connect to. The port must be specified in its numeric form, but it
2081 must be passed as a string nonetheless. For example:
2082
2083   Port "3306"
2084
2085 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2086 See the documentation for the C<mysql_real_connect> function for details.
2087
2088 =item B<Socket> I<Socket>
2089
2090 Specifies the path to the UNIX domain socket of the MySQL server. This option
2091 only has any effect, if B<Host> is set to B<localhost> (the default).
2092 Otherwise, use the B<Port> option above. See the documentation for the
2093 C<mysql_real_connect> function for details.
2094
2095 =item B<MasterStats> I<true|false>
2096
2097 =item B<SlaveStats> I<true|false>
2098
2099 Enable the collection of master / slave statistics in a replication setup.
2100
2101 =item B<SlaveNotifications> I<true|false>
2102
2103 If enabled, the plugin sends a notification if the replication slave I/O and /
2104 or SQL threads are not running.
2105
2106 =back
2107
2108 =head2 Plugin C<netapp>
2109
2110 The netapp plugin can collect various performance and capacity information
2111 from a NetApp filer using the NetApp API.
2112
2113 Please note that NetApp has a wide line of products and a lot of different
2114 software versions for each of these products. This plugin was developed for a
2115 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2116 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2117 model and software version but it is very hard to test this.
2118 If you have used this plugin with other models and/or software version, feel
2119 free to send us a mail to tell us about the results, even if it's just a short
2120 "It works".
2121
2122 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2123 basic authentication.
2124
2125 B<Do not use a regular user for this!> Create a special collectd user with just
2126 the minimum of capabilities needed. The user only needs the "login-http-admin"
2127 capability as well as a few more depending on which data will be collected.
2128 Required capabilities are documented below.
2129
2130 =head3 Synopsis
2131
2132  <Plugin "netapp">
2133    <Host "netapp1.example.com">
2134     Protocol      "https"
2135     Address       "10.0.0.1"
2136     Port          443
2137     User          "username"
2138     Password      "aef4Aebe"
2139     Interval      30
2140     
2141     <WAFL>
2142       Interval 30
2143       GetNameCache   true
2144       GetDirCache    true
2145       GetBufferCache true
2146       GetInodeCache  true
2147     </WAFL>
2148     
2149     <Disks>
2150       Interval 30
2151       GetBusy true
2152     </Disks>
2153     
2154     <VolumePerf>
2155       Interval 30
2156       GetIO      "volume0"
2157       IgnoreSelectedIO      false
2158       GetOps     "volume0"
2159       IgnoreSelectedOps     false
2160       GetLatency "volume0"
2161       IgnoreSelectedLatency false
2162     </VolumePerf>
2163     
2164     <VolumeUsage>
2165       Interval 30
2166       GetCapacity "vol0"
2167       GetCapacity "vol1"
2168       IgnoreSelectedCapacity false
2169       GetSnapshot "vol1"
2170       GetSnapshot "vol3"
2171       IgnoreSelectedSnapshot false
2172     </VolumeUsage>
2173     
2174     <System>
2175       Interval 30
2176       GetCPULoad     true
2177       GetInterfaces  true
2178       GetDiskOps     true
2179       GetDiskIO      true
2180     </System>
2181    </Host>
2182  </Plugin>
2183
2184 The netapp plugin accepts the following configuration options:
2185
2186 =over 4
2187
2188 =item B<Host> I<Name>
2189
2190 A host block defines one NetApp filer. It will appear in collectd with the name
2191 you specify here which does not have to be its real name nor its hostname.
2192
2193 =item B<Protocol> B<httpd>|B<http>
2194
2195 The protocol collectd will use to query this host.
2196
2197 Optional
2198
2199 Type: string
2200
2201 Default: https
2202
2203 Valid options: http, https
2204
2205 =item B<Address> I<Address>
2206
2207 The hostname or IP address of the host.
2208
2209 Optional
2210
2211 Type: string
2212
2213 Default: The "host" block's name.
2214
2215 =item B<Port> I<Port>
2216
2217 The TCP port to connect to on the host.
2218
2219 Optional
2220
2221 Type: integer
2222
2223 Default: 80 for protocol "http", 443 for protocol "https"
2224
2225 =item B<User> I<User>
2226
2227 =item B<Password> I<Password>
2228
2229 The username and password to use to login to the NetApp.
2230
2231 Mandatory
2232
2233 Type: string
2234
2235 =item B<Interval> I<Interval>
2236
2237 B<TODO>
2238
2239 =back
2240
2241 The following options decide what kind of data will be collected. You can
2242 either use them as a block and fine tune various parameters inside this block,
2243 use them as a single statement to just accept all default values, or omit it to
2244 not collect any data.
2245
2246 The following options are valid inside all blocks:
2247
2248 =over 4
2249
2250 =item B<Interval> I<Seconds>
2251
2252 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2253 host specific setting.
2254
2255 =back
2256
2257 =head3 The System block
2258
2259 This will collect various performance data about the whole system.
2260
2261 B<Note:> To get this data the collectd user needs the
2262 "api-perf-object-get-instances" capability.
2263
2264 =over 4
2265
2266 =item B<Interval> I<Seconds>
2267
2268 Collect disk statistics every I<Seconds> seconds.
2269
2270 =item B<GetCPULoad> B<true>|B<false>
2271
2272 If you set this option to true the current CPU usage will be read. This will be
2273 the average usage between all CPUs in your NetApp without any information about
2274 individual CPUs.
2275
2276 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2277 returns in the "CPU" field.
2278
2279 Optional
2280
2281 Type: boolean
2282
2283 Default: true
2284
2285 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2286
2287 =item B<GetInterfaces> B<true>|B<false>
2288
2289 If you set this option to true the current traffic of the network interfaces
2290 will be read. This will be the total traffic over all interfaces of your NetApp
2291 without any information about individual interfaces.
2292
2293 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2294 in the "Net kB/s" field.
2295
2296 B<Or is it?>
2297
2298 Optional
2299
2300 Type: boolean
2301
2302 Default: true
2303
2304 Result: One value list of type "if_octects".
2305
2306 =item B<GetDiskIO> B<true>|B<false>
2307
2308 If you set this option to true the current IO throughput will be read. This
2309 will be the total IO of your NetApp without any information about individual
2310 disks, volumes or aggregates.
2311
2312 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2313 in the "DiskE<nbsp>kB/s" field.
2314
2315 Optional
2316
2317 Type: boolean
2318
2319 Default: true
2320
2321 Result: One value list of type "disk_octets".
2322
2323 =item B<GetDiskOps> B<true>|B<false>
2324
2325 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2326 iSCSI, etc. operations will be read. This will be the total number of
2327 operations on your NetApp without any information about individual volumes or
2328 aggregates.
2329
2330 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2331 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2332
2333 Optional
2334
2335 Type: boolean
2336
2337 Default: true
2338
2339 Result: A variable number of value lists of type "disk_ops_complex". Each type
2340 of operation will result in one value list with the name of the operation as
2341 type instance.
2342
2343 =back
2344
2345 =head3 The WAFL block
2346
2347 This will collect various performance data about the WAFL file system. At the
2348 moment this just means cache performance.
2349
2350 B<Note:> To get this data the collectd user needs the
2351 "api-perf-object-get-instances" capability.
2352
2353 B<Note:> The interface to get these values is classified as "Diagnostics" by
2354 NetApp. This means that it is not guaranteed to be stable even between minor
2355 releases.
2356
2357 =over 4
2358
2359 =item B<Interval> I<Seconds>
2360
2361 Collect disk statistics every I<Seconds> seconds.
2362
2363 =item B<GetNameCache> B<true>|B<false>
2364
2365 Optional
2366
2367 Type: boolean
2368
2369 Default: true
2370
2371 Result: One value list of type "cache_ratio" and type instance
2372 "name_cache_hit".
2373
2374 =item B<GetDirCache> B<true>|B<false>
2375
2376 Optional
2377
2378 Type: boolean
2379
2380 Default: true
2381
2382 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2383
2384 =item B<GetInodeCache> B<true>|B<false>
2385
2386 Optional
2387
2388 Type: boolean
2389
2390 Default: true
2391
2392 Result: One value list of type "cache_ratio" and type instance
2393 "inode_cache_hit".
2394
2395 =item B<GetBufferCache> B<true>|B<false>
2396
2397 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2398 in the "Cache hit" field.
2399
2400 Optional
2401
2402 Type: boolean
2403
2404 Default: true
2405
2406 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2407
2408 =back
2409
2410 =head3 The Disks block
2411
2412 This will collect performance data about the individual disks in the NetApp.
2413
2414 B<Note:> To get this data the collectd user needs the
2415 "api-perf-object-get-instances" capability.
2416
2417 =over 4
2418
2419 =item B<Interval> I<Seconds>
2420
2421 Collect disk statistics every I<Seconds> seconds.
2422
2423 =item B<GetBusy> B<true>|B<false>
2424
2425 If you set this option to true the busy time of all disks will be calculated
2426 and the value of the busiest disk in the system will be written.
2427
2428 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2429 in the "Disk util" field. Probably.
2430
2431 Optional
2432
2433 Type: boolean
2434
2435 Default: true
2436
2437 Result: One value list of type "percent" and type instance "disk_busy".
2438
2439 =back
2440
2441 =head3 The VolumePerf block
2442
2443 This will collect various performance data about the individual volumes.
2444
2445 You can select which data to collect about which volume using the following
2446 options. They follow the standard ignorelist semantic.
2447
2448 B<Note:> To get this data the collectd user needs the
2449 I<api-perf-object-get-instances> capability.
2450
2451 =over 4
2452
2453 =item B<Interval> I<Seconds>
2454
2455 Collect volume performance data every I<Seconds> seconds.
2456
2457 =item B<GetIO> I<Volume>
2458
2459 =item B<GetOps> I<Volume>
2460
2461 =item B<GetLatency> I<Volume>
2462
2463 Select the given volume for IO, operations or latency statistics collection.
2464 The argument is the name of the volume without the C</vol/> prefix.
2465
2466 Since the standard ignorelist functionality is used here, you can use a string
2467 starting and ending with a slash to specify regular expression matching: To
2468 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2469 expression:
2470
2471   GetIO "/^vol[027]$/"
2472
2473 If no regular expression is specified, an exact match is required. Both,
2474 regular and exact matching are case sensitive.
2475
2476 If no volume was specified at all for either of the three options, that data
2477 will be collected for all available volumes.
2478
2479 =item B<IgnoreSelectedIO> B<true>|B<false>
2480
2481 =item B<IgnoreSelectedOps> B<true>|B<false>
2482
2483 =item B<IgnoreSelectedLatency> B<true>|B<false>
2484
2485 When set to B<true>, the volumes selected for IO, operations or latency
2486 statistics collection will be ignored and the data will be collected for all
2487 other volumes.
2488
2489 When set to B<false>, data will only be collected for the specified volumes and
2490 all other volumes will be ignored.
2491
2492 If no volumes have been specified with the above B<Get*> options, all volumes
2493 will be collected regardless of the B<IgnoreSelected*> option.
2494
2495 Defaults to B<false>
2496
2497 =back
2498
2499 =head3 The VolumeUsage block
2500
2501 This will collect capacity data about the individual volumes.
2502
2503 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2504 capability.
2505
2506 =over 4
2507
2508 =item B<Interval> I<Seconds>
2509
2510 Collect volume usage statistics every I<Seconds> seconds.
2511
2512 =item B<GetCapacity> I<VolumeName>
2513
2514 The current capacity of the volume will be collected. This will result in two
2515 to four value lists, depending on the configuration of the volume. All data
2516 sources are of type "df_complex" with the name of the volume as
2517 plugin_instance.
2518
2519 There will be type_instances "used" and "free" for the number of used and
2520 available bytes on the volume.  If the volume has some space reserved for
2521 snapshots, a type_instance "snap_reserved" will be available.  If the volume
2522 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2523 number of bytes saved by the SIS feature.
2524
2525 B<Note:> The current NetApp API has a bug that results in this value being
2526 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2527 number which works most of the time.  If you see strange values here, bug
2528 NetApp support to fix this.
2529
2530 Repeat this option to specify multiple volumes.
2531
2532 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2533
2534 Specify whether to collect only the volumes selected by the B<GetCapacity>
2535 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2536 B<false>. However, if no B<GetCapacity> option is specified at all, all
2537 capacities will be selected anyway.
2538
2539 =item B<GetSnapshot> I<VolumeName>
2540
2541 Select volumes from which to collect snapshot information.
2542
2543 Usually, the space used for snapshots is included in the space reported as
2544 "used". If snapshot information is collected as well, the space used for
2545 snapshots is subtracted from the used space.
2546
2547 To make things even more interesting, it is possible to reserve space to be
2548 used for snapshots. If the space required for snapshots is less than that
2549 reserved space, there is "reserved free" and "reserved used" space in addition
2550 to "free" and "used". If the space required for snapshots exceeds the reserved
2551 space, that part allocated in the normal space is subtracted from the "used"
2552 space again.
2553
2554 Repeat this option to specify multiple volumes.
2555
2556 =item B<IgnoreSelectedSnapshot>
2557
2558 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2559 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2560 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2561 capacities will be selected anyway.
2562
2563 =back
2564
2565 =head2 Plugin C<netlink>
2566
2567 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
2568 statistics of various interface and routing aspects.
2569
2570 =over 4
2571
2572 =item B<Interface> I<Interface>
2573
2574 =item B<VerboseInterface> I<Interface>
2575
2576 Instruct the plugin to collect interface statistics. This is basically the same
2577 as the statistics provided by the C<interface> plugin (see above) but
2578 potentially much more detailed.
2579
2580 When configuring with B<Interface> only the basic statistics will be collected,
2581 namely octets, packets, and errors. These statistics are collected by
2582 the C<interface> plugin, too, so using both at the same time is no benefit.
2583
2584 When configured with B<VerboseInterface> all counters B<except> the basic ones,
2585 so that no data needs to be collected twice if you use the C<interface> plugin.
2586 This includes dropped packets, received multicast packets, collisions and a
2587 whole zoo of differentiated RX and TX errors. You can try the following command
2588 to get an idea of what awaits you:
2589
2590   ip -s -s link list
2591
2592 If I<Interface> is B<All>, all interfaces will be selected.
2593
2594 =item B<QDisc> I<Interface> [I<QDisc>]
2595
2596 =item B<Class> I<Interface> [I<Class>]
2597
2598 =item B<Filter> I<Interface> [I<Filter>]
2599
2600 Collect the octets and packets that pass a certain qdisc, class or filter.
2601
2602 QDiscs and classes are identified by their type and handle (or classid).
2603 Filters don't necessarily have a handle, therefore the parent's handle is used.
2604 The notation used in collectd differs from that used in tc(1) in that it
2605 doesn't skip the major or minor number if it's zero and doesn't print special
2606 ids by their name. So, for example, a qdisc may be identified by
2607 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
2608 thus not displayed by tc(1).
2609
2610 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
2611 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
2612 associated with that interface will be collected.
2613
2614 Since a filter itself doesn't necessarily have a handle, the parent's handle is
2615 used. This may lead to problems when more than one filter is attached to a
2616 qdisc or class. This isn't nice, but we don't know how this could be done any
2617 better. If you have a idea, please don't hesitate to tell us.
2618
2619 As with the B<Interface> option you can specify B<All> as the interface,
2620 meaning all interfaces.
2621
2622 Here are some examples to help you understand the above text more easily:
2623
2624   <Plugin netlink>
2625     VerboseInterface "All"
2626     QDisc "eth0" "pfifo_fast-1:0"
2627     QDisc "ppp0"
2628     Class "ppp0" "htb-1:10"
2629     Filter "ppp0" "u32-1:0"
2630   </Plugin>
2631
2632 =item B<IgnoreSelected>
2633
2634 The behavior is the same as with all other similar plugins: If nothing is
2635 selected at all, everything is collected. If some things are selected using the
2636 options described above, only these statistics are collected. If you set
2637 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
2638 specified statistics will not be collected.
2639
2640 =back
2641
2642 =head2 Plugin C<network>
2643
2644 The Network plugin sends data to a remote instance of collectd, receives data
2645 from a remote instance, or both at the same time. Data which has been received
2646 from the network is usually not transmitted again, but this can be activated, see
2647 the B<Forward> option below.
2648
2649 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
2650 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
2651
2652 Both, B<Server> and B<Listen> can be used as single option or as block. When
2653 used as block, given options are valid for this socket only. For example:
2654
2655  <Plugin "network">
2656    Server "collectd.internal.tld"
2657    <Server "collectd.external.tld">
2658      SecurityLevel "sign"
2659      Username "myhostname"
2660      Password "ohl0eQue"
2661    </Server>
2662  </Plugin>
2663
2664 =over 4
2665
2666 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
2667
2668 The B<Server> statement/block sets the server to send datagrams to. The
2669 statement may occur multiple times to send each datagram to multiple
2670 destinations.
2671
2672 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
2673 optional second argument specifies a port number or a service name. If not
2674 given, the default, B<25826>, is used.
2675
2676 The following options are recognized within B<Server> blocks:
2677
2678 =over 4
2679
2680 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2681
2682 Set the security you require for network communication. When the security level
2683 has been set to B<Encrypt>, data sent over the network will be encrypted using
2684 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
2685 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
2686 authentication code. When set to B<None>, data is sent without any security.
2687
2688 This feature is only available if the I<network> plugin was linked with
2689 I<libgcrypt>.
2690
2691 =item B<Username> I<Username>
2692
2693 Sets the username to transmit. This is used by the server to lookup the
2694 password. See B<AuthFile> below. All security levels except B<None> require
2695 this setting.
2696
2697 This feature is only available if the I<network> plugin was linked with
2698 I<libgcrypt>.
2699
2700 =item B<Password> I<Password>
2701
2702 Sets a password (shared secret) for this socket. All security levels except
2703 B<None> require this setting.
2704
2705 This feature is only available if the I<network> plugin was linked with
2706 I<libgcrypt>.
2707
2708 =item B<Interface> I<Interface name>
2709
2710 Set the outgoing interface for IP packets. This applies at least
2711 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2712 undefined or a non-existent interface name is specified, the default
2713 behavior is to let the kernel choose the appropriate interface. Be warned
2714 that the manual selection of an interface for unicast traffic is only
2715 necessary in rare cases.
2716
2717 =back
2718
2719 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
2720
2721 The B<Listen> statement sets the interfaces to bind to. When multiple
2722 statements are found the daemon will bind to multiple interfaces.
2723
2724 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
2725 the argument is a multicast address the daemon will join that multicast group.
2726 The optional second argument specifies a port number or a service name. If not
2727 given, the default, B<25826>, is used.
2728
2729 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
2730
2731 =over 4
2732
2733 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
2734
2735 Set the security you require for network communication. When the security level
2736 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
2737 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
2738 signed and encrypted data is accepted. When set to B<None>, all data will be
2739 accepted. If an B<AuthFile> option was given (see below), encrypted data is
2740 decrypted if possible.
2741
2742 This feature is only available if the I<network> plugin was linked with
2743 I<libgcrypt>.
2744
2745 =item B<AuthFile> I<Filename>
2746
2747 Sets a file in which usernames are mapped to passwords. These passwords are
2748 used to verify signatures and to decrypt encrypted network packets. If
2749 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
2750 verified and encrypted packets are decrypted. Otherwise, signed data is
2751 accepted without checking the signature and encrypted data cannot be decrypted.
2752 For the other security levels this option is mandatory.
2753
2754 The file format is very simple: Each line consists of a username followed by a
2755 colon and any number of spaces followed by the password. To demonstrate, an
2756 example file could look like this:
2757
2758   user0: foo
2759   user1: bar
2760
2761 Each time a packet is received, the modification time of the file is checked
2762 using L<stat(2)>. If the file has been changed, the contents is re-read. While
2763 the file is being read, it is locked using L<fcntl(2)>.
2764
2765 =item B<Interface> I<Interface name>
2766
2767 Set the incoming interface for IP packets explicitly. This applies at least
2768 to IPv6 packets and if possible to IPv4. If this option is not applicable,
2769 undefined or a non-existent interface name is specified, the default
2770 behavior is, to let the kernel choose the appropriate interface. Thus incoming
2771 traffic gets only accepted, if it arrives on the given interface.
2772
2773 =back
2774
2775 =item B<TimeToLive> I<1-255>
2776
2777 Set the time-to-live of sent packets. This applies to all, unicast and
2778 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
2779 That means that multicast packets will be sent with a TTL of C<1> (one) on most
2780 operating systems.
2781
2782 =item B<MaxPacketSize> I<1024-65535>
2783
2784 Set the maximum size for datagrams received over the network. Packets larger
2785 than this will be truncated. Defaults to 1452E<nbsp>bytes.
2786
2787 =item B<Forward> I<true|false>
2788
2789 If set to I<true>, write packets that were received via the network plugin to
2790 the sending sockets. This should only be activated when the B<Listen>- and
2791 B<Server>-statements differ. Otherwise packets may be send multiple times to
2792 the same multicast group. While this results in more network traffic than
2793 necessary it's not a huge problem since the plugin has a duplicate detection,
2794 so the values will not loop.
2795
2796 =item B<ReportStats> B<true>|B<false>
2797
2798 The network plugin cannot only receive and send statistics, it can also create
2799 statistics about itself. Collected data included the number of received and
2800 sent octets and packets, the length of the receive queue and the number of
2801 values handled. When set to B<true>, the I<Network plugin> will make these
2802 statistics available. Defaults to B<false>.
2803
2804 =back
2805
2806 =head2 Plugin C<nginx>
2807
2808 This plugin collects the number of connections and requests handled by the
2809 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
2810 queries the page provided by the C<ngx_http_stub_status_module> module, which
2811 isn't compiled by default. Please refer to
2812 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
2813 how to compile and configure nginx and this module.
2814
2815 The following options are accepted by the C<nginx plugin>:
2816
2817 =over 4
2818
2819 =item B<URL> I<http://host/nginx_status>
2820
2821 Sets the URL of the C<ngx_http_stub_status_module> output.
2822
2823 =item B<User> I<Username>
2824
2825 Optional user name needed for authentication.
2826
2827 =item B<Password> I<Password>
2828
2829 Optional password needed for authentication.
2830
2831 =item B<VerifyPeer> B<true|false>
2832
2833 Enable or disable peer SSL certificate verification. See
2834 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
2835
2836 =item B<VerifyHost> B<true|false>
2837
2838 Enable or disable peer host name verification. If enabled, the plugin checks
2839 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
2840 certificate matches the host name provided by the B<URL> option. If this
2841 identity check fails, the connection is aborted. Obviously, only works when
2842 connecting to a SSL enabled server. Enabled by default.
2843
2844 =item B<CACert> I<File>
2845
2846 File that holds one or more SSL certificates. If you want to use HTTPS you will
2847 possibly need this option. What CA certificates come bundled with C<libcurl>
2848 and are checked by default depends on the distribution you use.
2849
2850 =back
2851
2852 =head2 Plugin C<notify_desktop>
2853
2854 This plugin sends a desktop notification to a notification daemon, as defined
2855 in the Desktop Notification Specification. To actually display the
2856 notifications, B<notification-daemon> is required and B<collectd> has to be
2857 able to access the X server.
2858
2859 The Desktop Notification Specification can be found at
2860 L<http://www.galago-project.org/specs/notification/>.
2861
2862 =over 4
2863
2864 =item B<OkayTimeout> I<timeout>
2865
2866 =item B<WarningTimeout> I<timeout>
2867
2868 =item B<FailureTimeout> I<timeout>
2869
2870 Set the I<timeout>, in milliseconds, after which to expire the notification
2871 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
2872 been specified, the displayed notification will not be closed at all - the
2873 user has to do so herself. These options default to 5000. If a negative number
2874 has been specified, the default is used as well.
2875
2876 =back
2877
2878 =head2 Plugin C<notify_email>
2879
2880 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
2881 configured email address.
2882
2883 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
2884
2885 Available configuration options:
2886
2887 =over 4
2888
2889 =item B<From> I<Address>
2890
2891 Email address from which the emails should appear to come from.
2892
2893 Default: C<root@localhost>
2894
2895 =item B<Recipient> I<Address>
2896
2897 Configures the email address(es) to which the notifications should be mailed.
2898 May be repeated to send notifications to multiple addresses.
2899
2900 At least one B<Recipient> must be present for the plugin to work correctly.
2901
2902 =item B<SMTPServer> I<Hostname>
2903
2904 Hostname of the SMTP server to connect to.
2905
2906 Default: C<localhost>
2907
2908 =item B<SMTPPort> I<Port>
2909
2910 TCP port to connect to.
2911
2912 Default: C<25>
2913
2914 =item B<SMTPUser> I<Username>
2915
2916 Username for ASMTP authentication. Optional.
2917
2918 =item B<SMTPPassword> I<Password>
2919
2920 Password for ASMTP authentication. Optional.
2921
2922 =item B<Subject> I<Subject>
2923
2924 Subject-template to use when sending emails. There must be exactly two
2925 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
2926 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
2927 with the hostname.
2928
2929 Default: C<Collectd notify: %s@%s>
2930
2931 =back
2932
2933 =head2 Plugin C<ntpd>
2934
2935 =over 4
2936
2937 =item B<Host> I<Hostname>
2938
2939 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
2940
2941 =item B<Port> I<Port>
2942
2943 UDP-Port to connect to. Defaults to B<123>.
2944
2945 =item B<ReverseLookups> B<true>|B<false>
2946
2947 Sets whether or not to perform reverse lookups on peers. Since the name or
2948 IP-address may be used in a filename it is recommended to disable reverse
2949 lookups. The default is to do reverse lookups to preserve backwards
2950 compatibility, though.
2951
2952 =back
2953
2954 =head2 Plugin C<nut>
2955
2956 =over 4
2957
2958 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
2959
2960 Add a UPS to collect data from. The format is identical to the one accepted by
2961 L<upsc(8)>.
2962
2963 =back
2964
2965 =head2 Plugin C<olsrd>
2966
2967 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
2968 the Optimized Link State Routing daemon and reads information about the current
2969 state of the meshed network.
2970
2971 The following configuration options are understood:
2972
2973 =over 4
2974
2975 =item B<Host> I<Host>
2976
2977 Connect to I<Host>. Defaults to B<"localhost">.
2978
2979 =item B<Port> I<Port>
2980
2981 Specifies the port to connect to. This must be a string, even if you give the
2982 port as a number rather than a service name. Defaults to B<"2006">.
2983
2984 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
2985
2986 Specifies what information to collect about links, i.E<nbsp>e. direct
2987 connections of the daemon queried. If set to B<No>, no information is
2988 collected. If set to B<Summary>, the number of links and the average of all
2989 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
2990 If set to B<Detail> LQ and NLQ are collected per link.
2991
2992 Defaults to B<Detail>.
2993
2994 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
2995
2996 Specifies what information to collect about routes of the daemon queried. If
2997 set to B<No>, no information is collected. If set to B<Summary>, the number of
2998 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
2999 metric and ETX are collected per route.
3000
3001 Defaults to B<Summary>.
3002
3003 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3004
3005 Specifies what information to collect about the global topology. If set to
3006 B<No>, no information is collected. If set to B<Summary>, the number of links
3007 in the entire topology and the average I<link quality> (LQ) is calculated.
3008 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3009
3010 Defaults to B<Summary>.
3011
3012 =back
3013
3014 =head2 Plugin C<onewire>
3015
3016 B<EXPERIMENTAL!> See notes below.
3017
3018 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3019 L<http://owfs.org/> to read sensors connected via the onewire bus.
3020
3021 Currently only temperature sensors (sensors with the family code C<10>,
3022 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3023 would like to have included, please send a sort request to the mailing list.
3024
3025 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3026 experimental, below.
3027
3028 =over 4
3029
3030 =item B<Device> I<Device>
3031
3032 Sets the device to read the values from. This can either be a "real" hardware
3033 device, such as a serial port or an USB port, or the address of the
3034 L<owserver(1)> socket, usually B<localhost:4304>.
3035
3036 Though the documentation claims to automatically recognize the given address
3037 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3038 with that version, the following configuration worked for us:
3039
3040   <Plugin onewire>
3041     Device "-s localhost:4304"
3042   </Plugin>
3043
3044 This directive is B<required> and does not have a default value.
3045
3046 =item B<Sensor> I<Sensor>
3047
3048 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3049 below. Sensors are specified without the family byte at the beginning, to you'd
3050 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3051 point.
3052
3053 =item B<IgnoreSelected> I<true>|I<false>
3054
3055 If no configuration if given, the B<onewire> plugin will collect data from all
3056 sensors found. This may not be practical, especially if sensors are added and
3057 removed regularly. Sometimes, however, it's easier/preferred to collect only
3058 specific sensors or all sensors I<except> a few specified ones. This option
3059 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3060 B<Sensor> is inverted: All selected interfaces are ignored and all other
3061 interfaces are collected.
3062
3063 =item B<Interval> I<Seconds>
3064
3065 Sets the interval in which all sensors should be read. If not specified, the
3066 global B<Interval> setting is used.
3067
3068 =back
3069
3070 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3071 work with big setups. It works with one sensor being attached to one
3072 controller, but as soon as you throw in a couple more senors and maybe a hub
3073 or two, reading all values will take more than ten seconds (the default
3074 interval). We will probably add some separate thread for reading the sensors
3075 and some cache or something like that, but it's not done yet. We will try to
3076 maintain backwards compatibility in the future, but we can't promise. So in
3077 short: If it works for you: Great! But keep in mind that the config I<might>
3078 change, though this is unlikely. Oh, and if you want to help improving this
3079 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3080
3081 =head2 Plugin C<openvpn>
3082
3083 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3084 traffic statistics about connected clients.
3085
3086 To set up OpenVPN to write to the status file periodically, use the
3087 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3088 you need to set the required format, too. This is done by setting
3089 B<--status-version> to B<2>.
3090
3091 So, in a nutshell you need:
3092
3093   openvpn $OTHER_OPTIONS \
3094     --status "/var/run/openvpn-status" 10 \
3095     --status-version 2
3096
3097 Available options:
3098
3099 =over 4
3100
3101 =item B<StatusFile> I<File>
3102
3103 Specifies the location of the status file.
3104
3105 =item B<ImprovedNamingSchema> B<true>|B<false>
3106
3107 When enabled, the filename of the status file will be used as plugin instance
3108 and the client's "common name" will be used as type instance. This is required
3109 when reading multiple status files. Enabling this option is recommended, but to
3110 maintain backwards compatibility this option is disabled by default.
3111
3112 =item B<CollectCompression> B<true>|B<false>
3113
3114 Sets whether or not statistics about the compression used by OpenVPN should be
3115 collected. This information is only available in I<single> mode. Enabled by
3116 default.
3117
3118 =item B<CollectIndividualUsers> B<true>|B<false>
3119
3120 Sets whether or not traffic information is collected for each connected client
3121 individually. If set to false, currently no traffic data is collected at all
3122 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3123
3124 =item B<CollectUserCount> B<true>|B<false>
3125
3126 When enabled, the number of currently connected clients or users is collected.
3127 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3128 can be configured independently from that option. Defaults to B<false>.
3129
3130 =back
3131
3132 =head2 Plugin C<oracle>
3133
3134 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3135 Oracle® Database and lets you execute SQL statements there. It is very similar
3136 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3137 plugin's documentation above for details.
3138
3139   <Plugin oracle>
3140     <Query "out_of_stock">
3141       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3142       <Result>
3143         Type "gauge"
3144         # InstancePrefix "foo"
3145         InstancesFrom "category"
3146         ValuesFrom "value"
3147       </Result>
3148     </Query>
3149     <Database "product_information">
3150       ConnectID "db01"
3151       Username "oracle"
3152       Password "secret"
3153       Query "out_of_stock"
3154     </Database>
3155   </Plugin>
3156
3157 =head3 B<Query> blocks
3158
3159 The Query blocks are handled identically to the Query blocks of the "dbi"
3160 plugin. Please see its documentation above for details on how to specify
3161 queries.
3162
3163 =head3 B<Database> blocks
3164
3165 Database blocks define a connection to a database and which queries should be
3166 sent to that database. Each database needs a "name" as string argument in the
3167 starting tag of the block. This name will be used as "PluginInstance" in the
3168 values submitted to the daemon. Other than that, that name is not used.
3169
3170 =over 4
3171
3172 =item B<ConnectID> I<ID>
3173
3174 Defines the "database alias" or "service name" to connect to. Usually, these
3175 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3176
3177 =item B<Username> I<Username>
3178
3179 Username used for authentication.
3180
3181 =item B<Password> I<Password>
3182
3183 Password used for authentication.
3184
3185 =item B<Query> I<QueryName>
3186
3187 Associates the query named I<QueryName> with this database connection. The
3188 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3189 blocks you want to refer to must be placed above the database block you want to
3190 refer to them from.
3191
3192 =back
3193
3194 =head2 Plugin C<perl>
3195
3196 This plugin embeds a Perl-interpreter into collectd and provides an interface
3197 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3198
3199 =head2 Plugin C<pinba>
3200
3201 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3202 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3203 PHP-based webpage has been delivered, the extension will send a UDP packet
3204 containing timing information, peak memory usage and so on. The plugin will
3205 wait for such packets, parse them and account the provided information, which
3206 is then dispatched to the daemon once per interval.
3207
3208 Synopsis:
3209
3210  <Plugin pinba>
3211    Address "::0"
3212    Port "30002"
3213    # Overall statistics for the website.
3214    <View "www-total">
3215      Server "www.example.com"
3216    </View>
3217    # Statistics for www-a only
3218    <View "www-a">
3219      Host "www-a.example.com"
3220      Server "www.example.com"
3221    </View>
3222    # Statistics for www-b only
3223    <View "www-b">
3224      Host "www-b.example.com"
3225      Server "www.example.com"
3226    </View>
3227  </Plugin>
3228
3229 The plugin provides the following configuration options:
3230
3231 =over 4
3232
3233 =item B<Address> I<Node>
3234
3235 Configures the address used to open a listening socket. By default, plugin will
3236 bind to the I<any> address C<::0>.
3237
3238 =item B<Port> I<Service>
3239
3240 Configures the port (service) to bind to. By default the default Pinba port
3241 "30002" will be used. The option accepts service names in addition to port
3242 numbers and thus requires a I<string> argument.
3243
3244 =item E<lt>B<View> I<Name>E<gt> block
3245
3246 The packets sent by the Pinba extension include the hostname of the server, the
3247 server name (the name of the virtual host) and the script that was executed.
3248 Using B<View> blocks it is possible to separate the data into multiple groups
3249 to get more meaningful statistics. Each packet is added to all matching groups,
3250 so that a packet may be accounted for more than once.
3251
3252 =over 4
3253
3254 =item B<Host> I<Host>
3255
3256 Matches the hostname of the system the webserver / script is running on. This
3257 will contain the result of the L<gethostname(2)> system call. If not
3258 configured, all hostnames will be accepted.
3259
3260 =item B<Server> I<Server>
3261
3262 Matches the name of the I<virtual host>, i.e. the contents of the
3263 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3264 server names will be accepted.
3265
3266 =item B<Script> I<Script>
3267
3268 Matches the name of the I<script name>, i.e. the contents of the
3269 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3270 script names will be accepted.
3271
3272 =back
3273
3274 =back
3275
3276 =head2 Plugin C<ping>
3277
3278 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3279 configured hosts periodically and measures the network latency. Whenever the
3280 C<read> function of the plugin is called, it submits the average latency, the
3281 standard deviation and the drop rate for each host.
3282
3283 Available configuration options:
3284
3285 =over 4
3286
3287 =item B<Host> I<IP-address>
3288
3289 Host to ping periodically. This option may be repeated several times to ping
3290 multiple hosts.
3291
3292 =item B<Interval> I<Seconds>
3293
3294 Sets the interval in which to send ICMP echo packets to the configured hosts.
3295 This is B<not> the interval in which statistics are queries from the plugin but
3296 the interval in which the hosts are "pinged". Therefore, the setting here
3297 should be smaller than or equal to the global B<Interval> setting. Fractional
3298 times, such as "1.24" are allowed.
3299
3300 Default: B<1.0>
3301
3302 =item B<Timeout> I<Seconds>
3303
3304 Time to wait for a response from the host to which an ICMP packet had been
3305 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3306 to be down or the packet to be dropped. This setting must be smaller than the
3307 B<Interval> setting above for the plugin to work correctly. Fractional
3308 arguments are accepted.
3309
3310 Default: B<0.9>
3311
3312 =item B<TTL> I<0-255>
3313
3314 Sets the Time-To-Live of generated ICMP packets.
3315
3316 =item B<SourceAddress> I<host>
3317
3318 Sets the source address to use. I<host> may either be a numerical network
3319 address or a network hostname.
3320
3321 =item B<Device> I<name>
3322
3323 Sets the outgoing network device to be used. I<name> has to specify an
3324 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3325 operating systems.
3326
3327 =item B<MaxMissed> I<Packets>
3328
3329 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3330 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3331
3332 Default: B<-1> (disabled)
3333
3334 =back
3335
3336 =head2 Plugin C<postgresql>
3337
3338 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3339 keeps a persistent connection to all configured databases and tries to
3340 reconnect if the connection has been interrupted. A database is configured by
3341 specifying a B<Database> block as described below. The default statistics are
3342 collected from PostgreSQL's B<statistics collector> which thus has to be
3343 enabled for this plugin to work correctly. This should usually be the case by
3344 default. See the section "The Statistics Collector" of the B<PostgreSQL
3345 Documentation> for details.
3346
3347 By specifying custom database queries using a B<Query> block as described
3348 below, you may collect any data that is available from some PostgreSQL
3349 database. This way, you are able to access statistics of external daemons
3350 which are available in a PostgreSQL database or use future or special
3351 statistics provided by PostgreSQL without the need to upgrade your collectd
3352 installation.
3353
3354 The B<PostgreSQL Documentation> manual can be found at
3355 L<http://www.postgresql.org/docs/manuals/>.
3356
3357   <Plugin postgresql>
3358     <Query magic>
3359       Statement "SELECT magic FROM wizard WHERE host = $1;"
3360       Param hostname
3361       <Result>
3362         Type gauge
3363         InstancePrefix "magic"
3364         ValuesFrom magic
3365       </Result>
3366     </Query>
3367
3368     <Query rt36_tickets>
3369       Statement "SELECT COUNT(type) AS count, type \
3370                         FROM (SELECT CASE \
3371                                      WHEN resolved = 'epoch' THEN 'open' \
3372                                      ELSE 'resolved' END AS type \
3373                                      FROM tickets) type \
3374                         GROUP BY type;"
3375       <Result>
3376         Type counter
3377         InstancePrefix "rt36_tickets"
3378         InstancesFrom "type"
3379         ValuesFrom "count"
3380       </Result>
3381     </Query>
3382
3383     <Database foo>
3384       Host "hostname"
3385       Port "5432"
3386       User "username"
3387       Password "secret"
3388       SSLMode "prefer"
3389       KRBSrvName "kerberos_service_name"
3390       Query magic
3391     </Database>
3392
3393     <Database bar>
3394       Interval 300
3395       Service "service_name"
3396       Query backend # predefined
3397       Query rt36_tickets
3398     </Database>
3399   </Plugin>
3400
3401 The B<Query> block defines one database query which may later be used by a
3402 database definition. It accepts a single mandatory argument which specifies
3403 the name of the query. The names of all queries have to be unique (see the
3404 B<MinVersion> and B<MaxVersion> options below for an exception to this
3405 rule). The following configuration options are available to define the query:
3406
3407 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3408 blocks define how to handle the values returned from the query. They define
3409 which column holds which value and how to dispatch that value to the daemon.
3410 Multiple B<Result> blocks may be used to extract multiple values from a single
3411 query.
3412
3413 =over 4
3414
3415 =item B<Statement> I<sql query statement>
3416
3417 Specify the I<sql query statement> which the plugin should execute. The string
3418 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3419 first, second, etc. parameter. The value of the parameters is specified by the
3420 B<Param> configuration option - see below for details. To include a literal
3421 B<$> character followed by a number, surround it with single quotes (B<'>).
3422
3423 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3424 allowed. Note, however, that only a single command may be used. Semicolons are
3425 allowed as long as a single non-empty command has been specified only.
3426
3427 The returned lines will be handled separately one after another.
3428
3429 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3430
3431 Specify the parameters which should be passed to the SQL query. The parameters
3432 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3433 they appear in the configuration file. The value of the parameter is
3434 determined depending on the value of the B<Param> option as follows:
3435
3436 =over 4
3437
3438 =item I<hostname>
3439
3440 The configured hostname of the database connection. If a UNIX domain socket is
3441 used, the parameter expands to "localhost".
3442
3443 =item I<database>
3444
3445 The name of the database of the current connection.
3446
3447 =item I<username>
3448
3449 The username used to connect to the database.
3450
3451 =item I<interval>
3452
3453 The interval with which this database is queried (as specified by the database
3454 specific or global B<Interval> options).
3455
3456 =back
3457
3458 Please note that parameters are only supported by PostgreSQL's protocol
3459 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3460
3461 =item B<Type> I<type>
3462
3463 The I<type> name to be used when dispatching the values. The type describes
3464 how to handle the data and where to store it. See L<types.db(5)> for more
3465 details on types and their configuration. The number and type of values (as
3466 selected by the B<ValuesFrom> option) has to match the type of the given name.
3467
3468 This option is required inside a B<Result> block.
3469
3470 =item B<InstancePrefix> I<prefix>
3471
3472 =item B<InstancesFrom> I<column0> [I<column1> ...]
3473
3474 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3475 B<InstancePrefix> defines a static prefix that will be prepended to all type
3476 instances. B<InstancesFrom> defines the column names whose values will be used
3477 to create the type instance. Multiple values will be joined together using the
3478 hyphen (C<->) as separation character.
3479
3480 The plugin itself does not check whether or not all built instances are
3481 different. It is your responsibility to assure that each is unique.
3482
3483 Both options are optional. If none is specified, the type instance will be
3484 empty.
3485
3486 =item B<ValuesFrom> I<column0> [I<column1> ...]
3487
3488 Names the columns whose content is used as the actual data for the data sets
3489 that are dispatched to the daemon. How many such columns you need is
3490 determined by the B<Type> setting as explained above. If you specify too many
3491 or not enough columns, the plugin will complain about that and no data will be
3492 submitted to the daemon.
3493
3494 The actual data type, as seen by PostgreSQL, is not that important as long as
3495 it represents numbers. The plugin will automatically cast the values to the
3496 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3497 L<strtod(3)> functions, so anything supported by those functions is supported
3498 by the plugin as well.
3499
3500 This option is required inside a B<Result> block and may be specified multiple
3501 times. If multiple B<ValuesFrom> options are specified, the columns are read
3502 in the given order.
3503
3504 =item B<MinVersion> I<version>
3505
3506 =item B<MaxVersion> I<version>
3507
3508 Specify the minimum or maximum version of PostgreSQL that this query should be
3509 used with. Some statistics might only be available with certain versions of
3510 PostgreSQL. This allows you to specify multiple queries with the same name but
3511 which apply to different versions, thus allowing you to use the same
3512 configuration in a heterogeneous environment.
3513
3514 The I<version> has to be specified as the concatenation of the major, minor
3515 and patch-level versions, each represented as two-decimal-digit numbers. For
3516 example, version 8.2.3 will become 80203.
3517
3518 =back
3519
3520 The following predefined queries are available (the definitions can be found
3521 in the F<postgresql_default.conf> file which, by default, is available at
3522 C<I<prefix>/share/collectd/>):
3523
3524 =over 4
3525
3526 =item B<backends>
3527
3528 This query collects the number of backends, i.E<nbsp>e. the number of
3529 connected clients.
3530
3531 =item B<transactions>
3532
3533 This query collects the numbers of committed and rolled-back transactions of
3534 the user tables.
3535
3536 =item B<queries>
3537
3538 This query collects the numbers of various table modifications (i.E<nbsp>e.
3539 insertions, updates, deletions) of the user tables.
3540
3541 =item B<query_plans>
3542
3543 This query collects the numbers of various table scans and returned tuples of
3544 the user tables.
3545
3546 =item B<table_states>
3547
3548 This query collects the numbers of live and dead rows in the user tables.
3549
3550 =item B<disk_io>
3551
3552 This query collects disk block access counts for user tables.
3553
3554 =item B<disk_usage>
3555
3556 This query collects the on-disk size of the database in bytes.
3557
3558 =back
3559
3560 The B<Database> block defines one PostgreSQL database for which to collect
3561 statistics. It accepts a single mandatory argument which specifies the
3562 database name. None of the other options are required. PostgreSQL will use
3563 default values as documented in the section "CONNECTING TO A DATABASE" in the
3564 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
3565 the user collectd is run as and special environment variables. See the manpage
3566 for details.
3567
3568 =over 4
3569
3570 =item B<Interval> I<seconds>
3571
3572 Specify the interval with which the database should be queried. The default is
3573 to use the global B<Interval> setting.
3574
3575 =item B<Host> I<hostname>
3576
3577 Specify the hostname or IP of the PostgreSQL server to connect to. If the
3578 value begins with a slash, it is interpreted as the directory name in which to
3579 look for the UNIX domain socket.
3580
3581 This option is also used to determine the hostname that is associated with a
3582 collected data set. If it has been omitted or either begins with with a slash
3583 or equals B<localhost> it will be replaced with the global hostname definition
3584 of collectd. Any other value will be passed literally to collectd when
3585 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
3586
3587 =item B<Port> I<port>
3588
3589 Specify the TCP port or the local UNIX domain socket file extension of the
3590 server.
3591
3592 =item B<User> I<username>
3593
3594 Specify the username to be used when connecting to the server.
3595
3596 =item B<Password> I<password>
3597
3598 Specify the password to be used when connecting to the server.
3599
3600 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
3601
3602 Specify whether to use an SSL connection when contacting the server. The
3603 following modes are supported:
3604
3605 =over 4
3606
3607 =item I<disable>
3608
3609 Do not use SSL at all.
3610
3611 =item I<allow>
3612
3613 First, try to connect without using SSL. If that fails, try using SSL.
3614
3615 =item I<prefer> (default)
3616
3617 First, try to connect using SSL. If that fails, try without using SSL.
3618
3619 =item I<require>
3620
3621 Use SSL only.
3622
3623 =back
3624
3625 =item B<KRBSrvName> I<kerberos_service_name>
3626
3627 Specify the Kerberos service name to use when authenticating with Kerberos 5
3628 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
3629 B<PostgreSQL Documentation> for details.
3630
3631 =item B<Service> I<service_name>
3632
3633 Specify the PostgreSQL service name to use for additional parameters. That
3634 service has to be defined in F<pg_service.conf> and holds additional
3635 connection parameters. See the section "The Connection Service File" in the
3636 B<PostgreSQL Documentation> for details.
3637
3638 =item B<Query> I<query>
3639
3640 Specify a I<query> which should be executed for the database connection. This
3641 may be any of the predefined or user-defined queries. If no such option is
3642 given, it defaults to "backends", "transactions", "queries", "query_plans",
3643 "table_states", "disk_io" and "disk_usage". Else, the specified queries are
3644 used only.
3645
3646 =back
3647
3648 =head2 Plugin C<powerdns>
3649
3650 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
3651 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
3652 values, many of which are probably meaningless to most users, but may be useful
3653 for some. So you may chose which values to collect, but if you don't, some
3654 reasonable defaults will be collected.
3655
3656   <Plugin "powerdns">
3657     <Server "server_name">
3658       Collect "latency"
3659       Collect "udp-answers" "udp-queries"
3660       Socket "/var/run/pdns.controlsocket"
3661     </Server>
3662     <Recursor "recursor_name">
3663       Collect "questions"
3664       Collect "cache-hits" "cache-misses"
3665       Socket "/var/run/pdns_recursor.controlsocket"
3666     </Recursor>
3667     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
3668   </Plugin>
3669
3670 =over 4
3671
3672 =item B<Server> and B<Recursor> block
3673
3674 The B<Server> block defines one authoritative server to query, the B<Recursor>
3675 does the same for an recursing server. The possible options in both blocks are
3676 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
3677 and is required.
3678
3679 =over 4
3680
3681 =item B<Collect> I<Field>
3682
3683 Using the B<Collect> statement you can select which values to collect. Here,
3684 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
3685 C<dlg-only-drops>, C<answers10-100>.
3686
3687 The method of getting the values differs for B<Server> and B<Recursor> blocks:
3688 When querying the server a C<SHOW *> command is issued in any case, because
3689 that's the only way of getting multiple values out of the server at once.
3690 collectd then picks out the values you have selected. When querying the
3691 recursor, a command is generated to query exactly these values. So if you
3692 specify invalid fields when querying the recursor, a syntax error may be
3693 returned by the daemon and collectd may not collect any values at all.
3694
3695 If no B<Collect> statement is given, the following B<Server> values will be
3696 collected:
3697
3698 =over 4
3699
3700 =item latency
3701
3702 =item packetcache-hit
3703
3704 =item packetcache-miss
3705
3706 =item packetcache-size
3707
3708 =item query-cache-hit
3709
3710 =item query-cache-miss
3711
3712 =item recursing-answers
3713
3714 =item recursing-questions
3715
3716 =item tcp-answers
3717
3718 =item tcp-queries
3719
3720 =item udp-answers
3721
3722 =item udp-queries
3723
3724 =back
3725
3726 The following B<Recursor> values will be collected by default:
3727
3728 =over 4
3729
3730 =item noerror-answers
3731
3732 =item nxdomain-answers
3733
3734 =item servfail-answers
3735
3736 =item sys-msec
3737
3738 =item user-msec
3739
3740 =item qa-latency
3741
3742 =item cache-entries
3743
3744 =item cache-hits
3745
3746 =item cache-misses
3747
3748 =item questions
3749
3750 =back
3751
3752 Please note that up to that point collectd doesn't know what values are
3753 available on the server and values that are added do not need a change of the
3754 mechanism so far. However, the values must be mapped to collectd's naming
3755 scheme, which is done using a lookup table that lists all known values. If
3756 values are added in the future and collectd does not know about them, you will
3757 get an error much like this:
3758
3759   powerdns plugin: submit: Not found in lookup table: foobar = 42
3760
3761 In this case please file a bug report with the collectd team.
3762
3763 =item B<Socket> I<Path>
3764
3765 Configures the path to the UNIX domain socket to be used when connecting to the
3766 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
3767 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
3768 will be used for the recursor.
3769
3770 =back
3771
3772 =item B<LocalSocket> I<Path>
3773
3774 Querying the recursor is done using UDP. When using UDP over UNIX domain
3775 sockets, the client socket needs a name in the file system, too. You can set
3776 this local name to I<Path> using the B<LocalSocket> option. The default is
3777 C<I<prefix>/var/run/collectd-powerdns>.
3778
3779 =back
3780
3781 =head2 Plugin C<processes>
3782
3783 =over 4
3784
3785 =item B<Process> I<Name>
3786
3787 Select more detailed statistics of processes matching this name. The statistics
3788 collected for these selected processes are size of the resident segment size
3789 (RSS), user- and system-time used, number of processes and number of threads,
3790 io data (where available) and minor and major pagefaults.
3791
3792 =item B<ProcessMatch> I<name> I<regex>
3793
3794 Similar to the B<Process> option this allows to select more detailed
3795 statistics of processes matching the specified I<regex> (see L<regex(7)> for
3796 details). The statistics of all matching processes are summed up and
3797 dispatched to the daemon using the specified I<name> as an identifier. This
3798 allows to "group" several processes together. I<name> must not contain
3799 slashes.
3800
3801 =back
3802
3803 =head2 Plugin C<protocols>
3804
3805 Collects a lot of information about various network protocols, such as I<IP>,
3806 I<TCP>, I<UDP>, etc.
3807
3808 Available configuration options:
3809
3810 =over 4
3811
3812 =item B<Value> I<Selector>
3813
3814 Selects whether or not to select a specific value. The string being matched is
3815 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
3816 plugin instance and I<ValueName> will be used as type instance. An example of
3817 the string being used would be C<Tcp:RetransSegs>.
3818
3819 You can use regular expressions to match a large number of values with just one
3820 configuration option. To select all "extended" I<TCP> values, you could use the
3821 following statement:
3822
3823   Value "/^TcpExt:/"
3824
3825 Whether only matched values are selected or all matched values are ignored
3826 depends on the B<IgnoreSelected>. By default, only matched values are selected.
3827 If no value is configured at all, all values will be selected.
3828
3829 =item B<IgnoreSelected> B<true>|B<false>
3830
3831 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
3832 matching values will be ignored.
3833
3834 =back
3835
3836 =head2 Plugin C<python>
3837
3838 This plugin embeds a Python-interpreter into collectd and provides an interface
3839 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
3840
3841 =head2 Plugin C<routeros>
3842
3843 The C<routeros> plugin connects to a device running I<RouterOS>, the
3844 Linux-based operating system for routers by I<MikroTik>. The plugin uses
3845 I<librouteros> to connect and reads information about the interfaces and
3846 wireless connections of the device. The configuration supports querying
3847 multiple routers:
3848
3849   <Plugin "routeros">
3850     <Router>
3851       Host "router0.example.com"
3852       User "collectd"
3853       Password "secr3t"
3854       CollectInterface true
3855       CollectCPULoad true
3856       CollectMemory true
3857     </Router>
3858     <Router>
3859       Host "router1.example.com"
3860       User "collectd"
3861       Password "5ecret"
3862       CollectInterface true
3863       CollectRegistrationTable true
3864       CollectDF true
3865       CollectDisk true
3866     </Router>
3867   </Plugin>
3868
3869 As you can see above, the configuration of the I<routeros> plugin consists of
3870 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
3871 options are understood:
3872
3873 =over 4
3874
3875 =item B<Host> I<Host>
3876
3877 Hostname or IP-address of the router to connect to.
3878
3879 =item B<Port> I<Port>
3880
3881 Port name or port number used when connecting. If left unspecified, the default
3882 will be chosen by I<librouteros>, currently "8728". This option expects a
3883 string argument, even when a numeric port number is given.
3884
3885 =item B<User> I<User>
3886
3887 Use the user name I<User> to authenticate. Defaults to "admin".
3888
3889 =item B<Password> I<Password>
3890
3891 Set the password used to authenticate.
3892
3893 =item B<CollectInterface> B<true>|B<false>
3894
3895 When set to B<true>, interface statistics will be collected for all interfaces
3896 present on the device. Defaults to B<false>.
3897
3898 =item B<CollectRegistrationTable> B<true>|B<false>
3899
3900 When set to B<true>, information about wireless LAN connections will be
3901 collected. Defaults to B<false>.
3902
3903 =item B<CollectCPULoad> B<true>|B<false>
3904
3905 When set to B<true>, information about the CPU usage will be collected. The
3906 number is a dimensionless value where zero indicates no CPU usage at all.
3907 Defaults to B<false>.
3908
3909 =item B<CollectMemory> B<true>|B<false>
3910
3911 When enabled, the amount of used and free memory will be collected. How used
3912 memory is calculated is unknown, for example whether or not caches are counted
3913 as used space.
3914 Defaults to B<false>.
3915
3916 =item B<CollectDF> B<true>|B<false>
3917
3918 When enabled, the amount of used and free disk space will be collected.
3919 Defaults to B<false>.
3920
3921 =item B<CollectDisk> B<true>|B<false>
3922
3923 When enabled, the number of sectors written and bad blocks will be collected.
3924 Defaults to B<false>.
3925
3926 =back
3927
3928 =head2 Plugin C<redis>
3929
3930 The I<Redis plugin> connects to one or more Redis servers and gathers
3931 information about each server's state. For each server there is a I<Node> block
3932 which configures the connection parameters for this node.
3933
3934   <Plugin redis>
3935     <Node "example">
3936         Host "localhost"
3937         Port "6379"
3938         Timeout 2000
3939     </Node>
3940   </Plugin>
3941
3942 The information shown in the synopsis above is the I<default configuration>
3943 which is used by the plugin if no configuration is present.
3944
3945 =over 4
3946
3947 =item B<Node> I<Nodename>
3948
3949 The B<Node> block identifies a new Redis node, that is a new Redis instance
3950 running in an specified host and port. The name for node is a canonical
3951 identifier which is used as I<plugin instance>. It is limited to
3952 64E<nbsp>characters in length.
3953
3954 =item B<Host> I<Hostname>
3955
3956 The B<Host> option is the hostname or IP-address where the Redis instance is
3957 running on.
3958
3959 =item B<Port> I<Port>
3960
3961 The B<Port> option is the TCP port on which the Redis instance accepts
3962 connections. Either a service name of a port number may be given. Please note
3963 that numerical port numbers must be given as a string, too.
3964
3965 =item B<Timeout> I<Timeout in miliseconds>
3966
3967 The B<Timeout> option set the socket timeout for node response. Since the Redis
3968 read function is blocking, you should keep this value as low as possible. Keep
3969 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
3970 than B<Interval> defined globally.
3971
3972 =back
3973
3974 =head2 Plugin C<rrdcached>
3975
3976 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
3977 to store values to RRD files in an efficient manner. The combination of the
3978 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
3979 way the C<rrdtool> plugin works (see below). The added abstraction layer
3980 provides a number of benefits, though: Because the cache is not within
3981 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
3982 restarted. This results in much shorter (if any) gaps in graphs, especially
3983 under heavy load. Also, the C<rrdtool> command line utility is aware of the
3984 daemon so that it can flush values to disk automatically when needed. This
3985 allows to integrate automated flushing of values into graphing solutions much
3986 more easily.
3987
3988 There are disadvantages, though: The daemon may reside on a different host, so
3989 it may not be possible for C<collectd> to create the appropriate RRD files
3990 anymore. And even if C<rrdcached> runs on the same host, it may run in a
3991 different base directory, so relative paths may do weird stuff if you're not
3992 careful.
3993
3994 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
3995 on the same host, communicating via a UNIX domain socket. The B<DataDir>
3996 setting should be set to an absolute path, so that a changed base directory
3997 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
3998
3999 =over 4
4000
4001 =item B<DaemonAddress> I<Address>
4002
4003 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4004 library. See L<rrdcached(1)> for details. Example:
4005
4006   <Plugin "rrdcached">
4007     DaemonAddress "unix:/var/run/rrdcached.sock"
4008   </Plugin>
4009
4010 =item B<DataDir> I<Directory>
4011
4012 Set the base directory in which the RRD files reside. If this is a relative
4013 path, it is relative to the working base directory of the C<rrdcached> daemon!
4014 Use of an absolute path is recommended.
4015
4016 =item B<CreateFiles> B<true>|B<false>
4017
4018 Enables or disables the creation of RRD files. If the daemon is not running
4019 locally, or B<DataDir> is set to a relative path, this will not work as
4020 expected. Default is B<true>.
4021
4022 =back
4023
4024 =head2 Plugin C<rrdtool>
4025
4026 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4027 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4028 using these settings. If you don't want to dive into the depths of RRDtool, you
4029 can safely ignore these settings.
4030
4031 =over 4
4032
4033 =item B<DataDir> I<Directory>
4034
4035 Set the directory to store RRD-files under. Per default RRD-files are generated
4036 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
4037
4038 =item B<StepSize> I<Seconds>
4039
4040 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4041 this setting is unset and the stepsize is set to the interval in which the data
4042 is collected. Do not use this option unless you absolutely have to for some
4043 reason. Setting this option may cause problems with the C<snmp plugin>, the
4044 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4045
4046 =item B<HeartBeat> I<Seconds>
4047
4048 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4049 in which case the heartbeat is set to twice the B<StepSize> which should equal
4050 the interval in which data is collected. Do not set this option unless you have
4051 a very good reason to do so.
4052
4053 =item B<RRARows> I<NumRows>
4054
4055 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4056 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4057 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4058 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4059 week, one month, and one year.
4060
4061 So for each timespan, it calculates how many PDPs need to be consolidated into
4062 one CDP by calculating:
4063   number of PDPs = timespan / (stepsize * rrarows)
4064
4065 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4066 default is 1200.
4067
4068 =item B<RRATimespan> I<Seconds>
4069
4070 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4071 more then one RRA. If this option is never used, the built-in default of (3600,
4072 86400, 604800, 2678400, 31622400) is used.
4073
4074 For more information on how RRA-sizes are calculated see B<RRARows> above.
4075
4076 =item B<XFF> I<Factor>
4077
4078 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4079
4080 =item B<CacheFlush> I<Seconds>
4081
4082 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4083 it writes all values for a certain RRD-file if the oldest value is older than
4084 (or equal to) the number of seconds specified. If some RRD-file is not updated
4085 anymore for some reason (the computer was shut down, the network is broken,
4086 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4087 entire cache is searched for entries older than B<CacheTimeout> seconds and
4088 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4089 does nothing under normal circumstances, this value should not be too small.
4090 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4091 normally do much harm either.
4092
4093 =item B<CacheTimeout> I<Seconds>
4094
4095 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4096 save values in a cache, as described above. Writing multiple values at once
4097 reduces IO-operations and thus lessens the load produced by updating the files.
4098 The trade off is that the graphs kind of "drag behind" and that more memory is
4099 used.
4100
4101 =item B<WritesPerSecond> I<Updates>
4102
4103 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4104 will run serious performance problems. The B<CacheFlush> setting and the
4105 internal update queue assert that collectd continues to work just fine even
4106 under heavy load, but the system may become very unresponsive and slow. This is
4107 a problem especially if you create graphs from the RRD files on the same
4108 machine, for example using the C<graph.cgi> script included in the
4109 C<contrib/collection3/> directory.
4110
4111 This setting is designed for very large setups. Setting this option to a value
4112 between 25 and 80 updates per second, depending on your hardware, will leave
4113 the server responsive enough to draw graphs even while all the cached values
4114 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4115 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4116 written as fast as possible, so that web frontends have up to date data when
4117 generating graphs.
4118
4119 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4120 updates per second, writing all values to disk will take approximately
4121 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4122 "collection3" you'll end up with a responsive and fast system, up to date
4123 graphs and basically a "backup" of your values every hour.
4124
4125 =item B<RandomTimeout> I<Seconds>
4126
4127 When set, the actual timeout for each value is chosen randomly between
4128 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4129 intention is to avoid high load situations that appear when many values timeout
4130 at the same time. This is especially a problem shortly after the daemon starts,
4131 because all values were added to the internal cache at roughly the same time.
4132
4133 =back
4134
4135 =head2 Plugin C<sensors>
4136
4137 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4138 that all the needed modules have to be loaded and lm_sensors has to be
4139 configured (most likely by editing F</etc/sensors.conf>. Read
4140 L<sensors.conf(5)> for details.
4141
4142 The B<lm_sensors> homepage can be found at
4143 L<http://secure.netroedge.com/~lm78/>.
4144
4145 =over 4
4146
4147 =item B<Sensor> I<chip-bus-address/type-feature>
4148
4149 Selects the name of the sensor which you want to collect or ignore, depending
4150 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4151 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4152 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4153
4154 =item B<IgnoreSelected> I<true>|I<false>
4155
4156 If no configuration if given, the B<sensors>-plugin will collect data from all
4157 sensors. This may not be practical, especially for uninteresting sensors.
4158 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4159 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4160 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4161 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4162 and all other sensors are collected.
4163
4164 =back
4165
4166 =head2 Plugin C<snmp>
4167
4168 Since the configuration of the C<snmp plugin> is a little more complicated than
4169 other plugins, its documentation has been moved to an own manpage,
4170 L<collectd-snmp(5)>. Please see there for details.
4171
4172 =head2 Plugin C<swap>
4173
4174 The I<Swap plugin> collects information about used and available swap space. On
4175 I<Solaris>, the following options are available:
4176
4177 =over 4
4178
4179 =item B<ReportByDevice> B<false>|B<true>
4180
4181 Configures how to report physical swap devices. If set to B<false> is used (the
4182 default), the summary over all swap devices is reported only, i.e. the globally
4183 used and available space over all devices. If B<true> is configured, the used
4184 and available space of each device will be reported separately.
4185
4186 This option is only available if the I<Swap plugin> can use the L<swapctl(2)>
4187 mechanism under I<Solaris>.
4188
4189 =back
4190
4191 =head2 Plugin C<syslog>
4192
4193 =over 4
4194
4195 =item B<LogLevel> B<debug|info|notice|warning|err>
4196
4197 Sets the log-level. If, for example, set to B<notice>, then all events with
4198 severity B<notice>, B<warning>, or B<err> will be submitted to the
4199 syslog-daemon.
4200
4201 Please note that B<debug> is only available if collectd has been compiled with
4202 debugging support.
4203
4204 =back
4205
4206 =head2 Plugin C<table>
4207
4208 The C<table plugin> provides generic means to parse tabular data and dispatch
4209 user specified values. Values are selected based on column numbers. For
4210 example, this plugin may be used to get values from the Linux L<proc(5)>
4211 filesystem or CSV (comma separated values) files.
4212
4213   <Plugin table>
4214     <Table "/proc/slabinfo">
4215       Instance "slabinfo"
4216       Separator " "
4217       <Result>
4218         Type gauge
4219         InstancePrefix "active_objs"
4220         InstancesFrom 0
4221         ValuesFrom 1
4222       </Result>
4223       <Result>
4224         Type gauge
4225         InstancePrefix "objperslab"
4226         InstancesFrom 0
4227         ValuesFrom 4
4228       </Result>
4229     </Table>
4230   </Plugin>
4231
4232 The configuration consists of one or more B<Table> blocks, each of which
4233 configures one file to parse. Within each B<Table> block, there are one or
4234 more B<Result> blocks, which configure which data to select and how to
4235 interpret it.
4236
4237 The following options are available inside a B<Table> block:
4238
4239 =over 4
4240
4241 =item B<Instance> I<instance>
4242
4243 If specified, I<instance> is used as the plugin instance. So, in the above
4244 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4245 filename of the table is used instead, with all special characters replaced
4246 with an underscore (C<_>).
4247
4248 =item B<Separator> I<string>
4249
4250 Any character of I<string> is interpreted as a delimiter between the different
4251 columns of the table. A sequence of two or more contiguous delimiters in the
4252 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4253 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4254 of a table - see its documentation for more details. This option is mandatory.
4255
4256 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4257 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4258 required because of collectd's config parsing.
4259
4260 =back
4261
4262 The following options are available inside a B<Result> block:
4263
4264 =over 4
4265
4266 =item B<Type> I<type>
4267
4268 Sets the type used to dispatch the values to the daemon. Detailed information
4269 about types and their configuration can be found in L<types.db(5)>. This
4270 option is mandatory.
4271
4272 =item B<InstancePrefix> I<prefix>
4273
4274 If specified, prepend I<prefix> to the type instance. If omitted, only the
4275 B<InstancesFrom> option is considered for the type instance.
4276
4277 =item B<InstancesFrom> I<column0> [I<column1> ...]
4278
4279 If specified, the content of the given columns (identified by the column
4280 number starting at zero) will be used to create the type instance for each
4281 row. Multiple values (and the instance prefix) will be joined together with
4282 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
4283 option is considered for the type instance.
4284
4285 The plugin itself does not check whether or not all built instances are
4286 different. It’s your responsibility to assure that each is unique. This is
4287 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
4288 sure that the table only contains one row.
4289
4290 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
4291 will be empty.
4292
4293 =item B<ValuesFrom> I<column0> [I<column1> ...]
4294
4295 Specifies the columns (identified by the column numbers starting at zero)
4296 whose content is used as the actual data for the data sets that are dispatched
4297 to the daemon. How many such columns you need is determined by the B<Type>
4298 setting above. If you specify too many or not enough columns, the plugin will
4299 complain about that and no data will be submitted to the daemon. The plugin
4300 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
4301 respectively, so anything supported by those functions is supported by the
4302 plugin as well. This option is mandatory.
4303
4304 =back
4305
4306 =head2 Plugin C<tail>
4307
4308 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
4309 each line and dispatches found values. What is matched can be configured by the
4310 user using (extended) regular expressions, as described in L<regex(7)>.
4311
4312   <Plugin "tail">
4313     <File "/var/log/exim4/mainlog">
4314       Instance "exim"
4315       <Match>
4316         Regex "S=([1-9][0-9]*)"
4317         DSType "CounterAdd"
4318         Type "ipt_bytes"
4319         Instance "total"
4320       </Match>
4321       <Match>
4322         Regex "\\<R=local_user\\>"
4323         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
4324         DSType "CounterInc"
4325         Type "counter"
4326         Instance "local_user"
4327       </Match>
4328     </File>
4329   </Plugin>
4330
4331 The config consists of one or more B<File> blocks, each of which configures one
4332 logfile to parse. Within each B<File> block, there are one or more B<Match>
4333 blocks, which configure a regular expression to search for.
4334
4335 The B<Instance> option in the B<File> block may be used to set the plugin
4336 instance. So in the above example the plugin name C<tail-foo> would be used.
4337 This plugin instance is for all B<Match> blocks that B<follow> it, until the
4338 next B<Instance> option. This way you can extract several plugin instances from
4339 one logfile, handy when parsing syslog and the like.
4340
4341 Each B<Match> block has the following options to describe how the match should
4342 be performed:
4343
4344 =over 4
4345
4346 =item B<Regex> I<regex>
4347
4348 Sets the regular expression to use for matching against a line. The first
4349 subexpression has to match something that can be turned into a number by
4350 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
4351 below. Because B<extended> regular expressions are used, you do not need to use
4352 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
4353 collectd's config parsing you need to escape backslashes, though. So if you
4354 want to match literal parentheses you need to do the following:
4355
4356   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
4357
4358 =item B<ExcludeRegex> I<regex>
4359
4360 Sets an optional regular expression to use for excluding lines from the match.
4361 An example which excludes all connections from localhost from the match:
4362
4363   ExcludeRegex "127\\.0\\.0\\.1"
4364
4365 =item B<DSType> I<Type>
4366
4367 Sets how the values are cumulated. I<Type> is one of:
4368
4369 =over 4
4370
4371 =item B<GaugeAverage>
4372
4373 Calculate the average.
4374
4375 =item B<GaugeMin>
4376
4377 Use the smallest number only.
4378
4379 =item B<GaugeMax>
4380
4381 Use the greatest number only.
4382
4383 =item B<GaugeLast>
4384
4385 Use the last number found.
4386
4387 =item B<CounterSet>
4388
4389 =item B<DeriveSet>
4390
4391 =item B<AbsoluteSet>
4392
4393 The matched number is a counter. Simply I<sets> the internal counter to this
4394 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
4395
4396 =item B<CounterAdd>
4397
4398 =item B<DeriveAdd>
4399
4400 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
4401 matched number may be negative, which will effectively subtract from the
4402 internal counter.
4403
4404 =item B<CounterInc>
4405
4406 =item B<DeriveInc>
4407
4408 Increase the internal counter by one. These B<DSType> are the only ones that do
4409 not use the matched subexpression, but simply count the number of matched
4410 lines. Thus, you may use a regular expression without submatch in this case.
4411
4412 =back
4413
4414 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
4415 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
4416 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
4417 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
4418 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
4419 case.
4420
4421 =item B<Type> I<Type>
4422
4423 Sets the type used to dispatch this value. Detailed information about types and
4424 their configuration can be found in L<types.db(5)>.
4425
4426 =item B<Instance> I<TypeInstance>
4427
4428 This optional setting sets the type instance to use.
4429
4430 =back
4431
4432 =head2 Plugin C<teamspeak2>
4433
4434 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
4435 polls interesting global and virtual server data. The plugin can query only one
4436 physical server but unlimited virtual servers. You can use the following
4437 options to configure it:
4438
4439 =over 4
4440
4441 =item B<Host> I<hostname/ip>
4442
4443 The hostname or ip which identifies the physical server.
4444 Default: 127.0.0.1
4445
4446 =item B<Port> I<port>
4447
4448 The query port of the physical server. This needs to be a string.
4449 Default: "51234"
4450
4451 =item B<Server> I<port>
4452
4453 This option has to be added once for every virtual server the plugin should
4454 query. If you want to query the virtual server on port 8767 this is what the
4455 option would look like:
4456
4457   Server "8767"
4458
4459 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
4460 use quotes around it! If no such statement is given only global information
4461 will be collected.
4462
4463 =back
4464
4465 =head2 Plugin C<ted>
4466
4467 The I<TED> plugin connects to a device of "The Energy Detective", a device to
4468 measure power consumption. These devices are usually connected to a serial
4469 (RS232) or USB port. The plugin opens a configured device and tries to read the
4470 current energy readings. For more information on TED, visit
4471 L<http://www.theenergydetective.com/>.
4472
4473 Available configuration options:
4474
4475 =over 4
4476
4477 =item B<Device> I<Path>
4478
4479 Path to the device on which TED is connected. collectd will need read and write
4480 permissions on that file.
4481
4482 Default: B</dev/ttyUSB0>
4483
4484 =item B<Retries> I<Num>
4485
4486 Apparently reading from TED is not that reliable. You can therefore configure a
4487 number of retries here. You only configure the I<retries> here, to if you
4488 specify zero, one reading will be performed (but no retries if that fails); if
4489 you specify three, a maximum of four readings are performed. Negative values
4490 are illegal.
4491
4492 Default: B<0>
4493
4494 =back
4495
4496 =head2 Plugin C<tcpconns>
4497
4498 The C<tcpconns plugin> counts the number of currently established TCP
4499 connections based on the local port and/or the remote port. Since there may be
4500 a lot of connections the default if to count all connections with a local port,
4501 for which a listening socket is opened. You can use the following options to
4502 fine-tune the ports you are interested in:
4503
4504 =over 4
4505
4506 =item B<ListeningPorts> I<true>|I<false>
4507
4508 If this option is set to I<true>, statistics for all local ports for which a
4509 listening socket exists are collected. The default depends on B<LocalPort> and
4510 B<RemotePort> (see below): If no port at all is specifically selected, the
4511 default is to collect listening ports. If specific ports (no matter if local or
4512 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
4513 the selected ports will be collected unless this option is set to I<true>
4514 specifically.
4515
4516 =item B<LocalPort> I<Port>
4517
4518 Count the connections to a specific local port. This can be used to see how
4519 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
4520 You have to specify the port in numeric form, so for the mailserver example
4521 you'd need to set B<25>.
4522
4523 =item B<RemotePort> I<Port>
4524
4525 Count the connections to a specific remote port. This is useful to see how
4526 much a remote service is used. This is most useful if you want to know how many
4527 connections a local service has opened to remote services, e.E<nbsp>g. how many
4528 connections a mail server or news server has to other mail or news servers, or
4529 how many connections a web proxy holds to web servers. You have to give the
4530 port in numeric form.
4531
4532 =back
4533
4534 =head2 Plugin C<thermal>
4535
4536 =over 4
4537
4538 =item B<ForceUseProcfs> I<true>|I<false>
4539
4540 By default, the I<Thermal plugin> tries to read the statistics from the Linux
4541 C<sysfs> interface. If that is not available, the plugin falls back to the
4542 C<procfs> interface. By setting this option to I<true>, you can force the
4543 plugin to use the latter. This option defaults to I<false>.
4544
4545 =item B<Device> I<Device>
4546
4547 Selects the name of the thermal device that you want to collect or ignore,
4548 depending on the value of the B<IgnoreSelected> option. This option may be
4549 used multiple times to specify a list of devices.
4550
4551 =item B<IgnoreSelected> I<true>|I<false>
4552
4553 Invert the selection: If set to true, all devices B<except> the ones that
4554 match the device names specified by the B<Device> option are collected. By
4555 default only selected devices are collected if a selection is made. If no
4556 selection is configured at all, B<all> devices are selected.
4557
4558 =back
4559
4560 =head2 Plugin C<threshold>
4561
4562 The I<Threshold plugin> checks values collected or received by I<collectd>
4563 against a configurable I<threshold> and issues I<notifications> if values are
4564 out of bounds.
4565
4566 Documentation for this plugin is available in the L<collectd-threshold(5)>
4567 manual page.
4568
4569 =head2 Plugin C<tokyotyrant>
4570
4571 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
4572 couple metrics: number of records, and database size on disk.
4573
4574 =over 4
4575
4576 =item B<Host> I<Hostname/IP>
4577
4578 The hostname or ip which identifies the server.
4579 Default: B<127.0.0.1>
4580
4581 =item B<Port> I<Service/Port>
4582
4583 The query port of the server. This needs to be a string, even if the port is
4584 given in its numeric form.
4585 Default: B<1978>
4586
4587 =back
4588
4589 =head2 Plugin C<unixsock>
4590
4591 =over 4
4592
4593 =item B<SocketFile> I<Path>
4594
4595 Sets the socket-file which is to be created.
4596
4597 =item B<SocketGroup> I<Group>
4598
4599 If running as root change the group of the UNIX-socket after it has been
4600 created. Defaults to B<collectd>.
4601
4602 =item B<SocketPerms> I<Permissions>
4603
4604 Change the file permissions of the UNIX-socket after it has been created. The
4605 permissions must be given as a numeric, octal value as you would pass to
4606 L<chmod(1)>. Defaults to B<0770>.
4607
4608 =item B<DeleteSocket> B<false>|B<true>
4609
4610 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
4611 with the given name already exists. If I<collectd> crashes a socket file may be
4612 left over, preventing the daemon from opening a new socket when restarted.
4613 Since this is potentially dangerous, this defaults to B<false>.
4614
4615 =back
4616
4617 =head2 Plugin C<uuid>
4618
4619 This plugin, if loaded, causes the Hostname to be taken from the machine's
4620 UUID. The UUID is a universally unique designation for the machine, usually
4621 taken from the machine's BIOS. This is most useful if the machine is running in
4622 a virtual environment such as Xen, in which case the UUID is preserved across
4623 shutdowns and migration.
4624
4625 The following methods are used to find the machine's UUID, in order:
4626
4627 =over 4
4628
4629 =item
4630
4631 Check I</etc/uuid> (or I<UUIDFile>).
4632
4633 =item
4634
4635 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
4636 present.
4637
4638 =item
4639
4640 Check for UUID from C<dmidecode> / SMBIOS.
4641
4642 =item
4643
4644 Check for UUID from Xen hypervisor.
4645
4646 =back
4647
4648 If no UUID can be found then the hostname is not modified.
4649
4650 =over 4
4651
4652 =item B<UUIDFile> I<Path>
4653
4654 Take the UUID from the given file (default I</etc/uuid>).
4655
4656 =back
4657
4658 =head2 Plugin C<varnish>
4659
4660 The Varnish plugin collects information about Varnish, an HTTP accelerator.
4661
4662 =over 4
4663
4664 =item B<CollectCache> B<true>|B<false>
4665
4666 Cache hits and misses. True by default.
4667
4668 =item B<CollectConnections> B<true>|B<false>
4669
4670 Number of client connections received, accepted and dropped. True by default.
4671
4672 =item B<CollectBackend> B<true>|B<false>
4673
4674 Back-end connection statistics, such as successful, reused,
4675 and closed connections. True by default.
4676
4677 =item B<CollectSHM> B<true>|B<false>
4678
4679 Statistics about the shared memory log, a memory region to store
4680 log messages which is flushed to disk when full. True by default.
4681
4682 =item B<CollectESI> B<true>|B<false>
4683
4684 Edge Side Includes (ESI) parse statistics. False by default.
4685
4686 =item B<CollectFetch> B<true>|B<false>
4687
4688 Statistics about fetches (HTTP requests sent to the backend). False by default.
4689
4690 =item B<CollectHCB> B<true>|B<false>
4691
4692 Inserts and look-ups in the crit bit tree based hash. Look-ups are
4693 divided into locked and unlocked look-ups. False by default.
4694
4695 =item B<CollectSMA> B<true>|B<false>
4696
4697 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
4698 The umem storage component is Solaris specific. False by default.
4699
4700 =item B<CollectSMS> B<true>|B<false>
4701
4702 synth (synthetic content) storage statistics. This storage
4703 component is used internally only. False by default.
4704
4705 =item B<CollectSM> B<true>|B<false>
4706
4707 file (memory mapped file) storage statistics. False by default.
4708
4709 =item B<CollectTotals> B<true>|B<false>
4710
4711 Collects overview counters, such as the number of sessions created,
4712 the number of requests and bytes transferred. False by default.
4713
4714 =item B<CollectWorkers> B<true>|B<false>
4715
4716 Collect statistics about worker threads. False by default.
4717
4718 =back
4719
4720 =head2 Plugin C<vmem>
4721
4722 The C<vmem> plugin collects information about the usage of virtual memory.
4723 Since the statistics provided by the Linux kernel are very detailed, they are
4724 collected very detailed. However, to get all the details, you have to switch
4725 them on manually. Most people just want an overview over, such as the number of
4726 pages read from swap space.
4727
4728 =over 4
4729
4730 =item B<Verbose> B<true>|B<false>
4731
4732 Enables verbose collection of information. This will start collecting page
4733 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
4734 Part of these statistics are collected on a "per zone" basis.
4735
4736 =back
4737
4738 =head2 Plugin C<vserver>
4739
4740 This plugin doesn't have any options. B<VServer> support is only available for
4741 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
4742 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
4743 need to apply the patches and compile your own kernel, which will then provide
4744 the F</proc/virtual> filesystem that is required by this plugin.
4745
4746 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
4747
4748 B<Note>: The traffic collected by this plugin accounts for the amount of
4749 traffic passing a socket which might be a lot less than the actual on-wire
4750 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
4751 collect on-wire traffic you could, for example, use the logging facilities of
4752 iptables to feed data for the guest IPs into the iptables plugin.
4753
4754 =head2 Plugin C<write_http>
4755
4756 This output plugin submits values to an http server by POST them using the
4757 PUTVAL plain-text protocol. Each destination you want to post data to needs to
4758 have one B<URL> block, within which the destination can be configured further,
4759 for example by specifying authentication data.
4760
4761 Synopsis:
4762
4763  <Plugin "write_http">
4764    <URL "http://example.com/post-collectd">
4765      User "collectd"
4766      Password "weCh3ik0"
4767    </URL>
4768  </Plugin>
4769
4770 B<URL> blocks need one string argument which is used as the URL to which data
4771 is posted. The following options are understood within B<URL> blocks.
4772
4773 =over 4
4774
4775 =item B<User> I<Username>
4776
4777 Optional user name needed for authentication.
4778
4779 =item B<Password> I<Password>
4780
4781 Optional password needed for authentication.
4782
4783 =item B<VerifyPeer> B<true>|B<false>
4784
4785 Enable or disable peer SSL certificate verification. See
4786 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4787
4788 =item B<VerifyHost> B<true|false>
4789
4790 Enable or disable peer host name verification. If enabled, the plugin checks if
4791 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
4792 matches the host name provided by the B<URL> option. If this identity check
4793 fails, the connection is aborted. Obviously, only works when connecting to a
4794 SSL enabled server. Enabled by default.
4795
4796 =item B<CACert> I<File>
4797
4798 File that holds one or more SSL certificates. If you want to use HTTPS you will
4799 possibly need this option. What CA certificates come bundled with C<libcurl>
4800 and are checked by default depends on the distribution you use.
4801
4802 =item B<Format> B<Command>|B<JSON>
4803
4804 Format of the output to generate. If set to B<Command>, will create output that
4805 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
4806 create output in the I<JavaScript Object Notation> (JSON).
4807
4808 Defaults to B<Command>.
4809
4810 =item B<StoreRates> B<true|false>
4811
4812 If set to B<true>, convert counter values to rates. If set to B<false> (the
4813 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
4814 number.
4815
4816 =back
4817
4818 =head1 FILTER CONFIGURATION
4819
4820 Starting with collectd 4.6 there is a powerful filtering infrastructure
4821 implemented in the daemon. The concept has mostly been copied from
4822 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
4823 terminology, so that users that are familiar with iptables feel right at home.
4824
4825 =head2 Terminology
4826
4827 The following are the terms used in the remainder of the filter configuration
4828 documentation. For an ASCII-art schema of the mechanism, see
4829 L<"General structure"> below.
4830
4831 =over 4
4832
4833 =item B<Match>
4834
4835 A I<match> is a criteria to select specific values. Examples are, of course, the
4836 name of the value or it's current value.
4837
4838 Matches are implemented in plugins which you have to load prior to using the
4839 match. The name of such plugins starts with the "match_" prefix.
4840
4841 =item B<Target>
4842
4843 A I<target> is some action that is to be performed with data. Such actions
4844 could, for example, be to change part of the value's identifier or to ignore
4845 the value completely.
4846
4847 Some of these targets are built into the daemon, see L<"Built-in targets">
4848 below. Other targets are implemented in plugins which you have to load prior to
4849 using the target. The name of such plugins starts with the "target_" prefix.
4850
4851 =item B<Rule>
4852
4853 The combination of any number of matches and at least one target is called a
4854 I<rule>. The target actions will be performed for all values for which B<all>
4855 matches apply. If the rule does not have any matches associated with it, the
4856 target action will be performed for all values.
4857
4858 =item B<Chain>
4859
4860 A I<chain> is a list of rules and possibly default targets. The rules are tried
4861 in order and if one matches, the associated target will be called. If a value
4862 is handled by a rule, it depends on the target whether or not any subsequent
4863 rules are considered or if traversal of the chain is aborted, see
4864 L<"Flow control"> below. After all rules have been checked, the default targets
4865 will be executed.
4866
4867 =back
4868
4869 =head2 General structure
4870
4871 The following shows the resulting structure:
4872
4873  +---------+
4874  ! Chain   !
4875  +---------+
4876       !
4877       V
4878  +---------+  +---------+  +---------+  +---------+
4879  ! Rule    !->! Match   !->! Match   !->! Target  !
4880  +---------+  +---------+  +---------+  +---------+
4881       !
4882       V
4883  +---------+  +---------+  +---------+
4884  ! Rule    !->! Target  !->! Target  !
4885  +---------+  +---------+  +---------+
4886       !
4887       V
4888       :
4889       :
4890       !
4891       V
4892  +---------+  +---------+  +---------+
4893  ! Rule    !->! Match   !->! Target  !
4894  +---------+  +---------+  +---------+
4895       !
4896       V
4897  +---------+
4898  ! Default !
4899  ! Target  !
4900  +---------+
4901
4902 =head2 Flow control
4903
4904 There are four ways to control which way a value takes through the filter
4905 mechanism:
4906
4907 =over 4
4908
4909 =item B<jump>
4910
4911 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
4912 process the value with another chain. When the called chain finishes, usually
4913 the next target or rule after the jump is executed.
4914
4915 =item B<stop>
4916
4917 The stop condition, signaled for example by the built-in target B<stop>, causes
4918 all processing of the value to be stopped immediately.
4919
4920 =item B<return>
4921
4922 Causes processing in the current chain to be aborted, but processing of the
4923 value generally will continue. This means that if the chain was called via
4924 B<Jump>, the next target or rule after the jump will be executed. If the chain
4925 was not called by another chain, control will be returned to the daemon and it
4926 may pass the value to another chain.
4927
4928 =item B<continue>
4929
4930 Most targets will signal the B<continue> condition, meaning that processing
4931 should continue normally. There is no special built-in target for this
4932 condition.
4933
4934 =back
4935
4936 =head2 Synopsis
4937
4938 The configuration reflects this structure directly:
4939
4940  PostCacheChain "PostCache"
4941  <Chain "PostCache">
4942    <Rule "ignore_mysql_show">
4943      <Match "regex">
4944        Plugin "^mysql$"
4945        Type "^mysql_command$"
4946        TypeInstance "^show_"
4947      </Match>
4948      <Target "stop">
4949      </Target>
4950    </Rule>
4951    <Target "write">
4952      Plugin "rrdtool"
4953    </Target>
4954  </Chain>
4955
4956 The above configuration example will ignore all values where the plugin field
4957 is "mysql", the type is "mysql_command" and the type instance begins with
4958 "show_". All other values will be sent to the C<rrdtool> write plugin via the
4959 default target of the chain. Since this chain is run after the value has been
4960 added to the cache, the MySQL C<show_*> command statistics will be available
4961 via the C<unixsock> plugin.
4962
4963 =head2 List of configuration options
4964
4965 =over 4
4966
4967 =item B<PreCacheChain> I<ChainName>
4968
4969 =item B<PostCacheChain> I<ChainName>
4970
4971 Configure the name of the "pre-cache chain" and the "post-cache chain". The
4972 argument is the name of a I<chain> that should be executed before and/or after
4973 the values have been added to the cache.
4974
4975 To understand the implications, it's important you know what is going on inside
4976 I<collectd>. The following diagram shows how values are passed from the
4977 read-plugins to the write-plugins:
4978
4979    +---------------+
4980    !  Read-Plugin  !
4981    +-------+-------+
4982            !
4983  + - - - - V - - - - +
4984  : +---------------+ :
4985  : !   Pre-Cache   ! :
4986  : !     Chain     ! :
4987  : +-------+-------+ :
4988  :         !         :
4989  :         V         :
4990  : +-------+-------+ :  +---------------+
4991  : !     Cache     !--->!  Value Cache  !
4992  : !     insert    ! :  +---+---+-------+
4993  : +-------+-------+ :      !   !
4994  :         !   ,------------'   !
4995  :         V   V     :          V
4996  : +-------+---+---+ :  +-------+-------+
4997  : !  Post-Cache   +--->! Write-Plugins !
4998  : !     Chain     ! :  +---------------+
4999  : +---------------+ :
5000  :                   :
5001  :  dispatch values  :
5002  + - - - - - - - - - +
5003
5004 After the values are passed from the "read" plugins to the dispatch functions,
5005 the pre-cache chain is run first. The values are added to the internal cache
5006 afterwards. The post-cache chain is run after the values have been added to the
5007 cache. So why is it such a huge deal if chains are run before or after the
5008 values have been added to this cache?
5009
5010 Targets that change the identifier of a value list should be executed before
5011 the values are added to the cache, so that the name in the cache matches the
5012 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
5013 this cache to receive a list of all available values. If you change the
5014 identifier after the value list has been added to the cache, this may easily
5015 lead to confusion, but it's not forbidden of course.
5016
5017 The cache is also used to convert counter values to rates. These rates are, for
5018 example, used by the C<value> match (see below). If you use the rate stored in
5019 the cache B<before> the new value is added, you will use the old, B<previous>
5020 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
5021 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
5022 command.
5023
5024 Last but not last, the B<stop> target makes a difference: If the pre-cache
5025 chain returns the stop condition, the value will not be added to the cache and
5026 the post-cache chain will not be run.
5027
5028 =item B<Chain> I<Name>
5029
5030 Adds a new chain with a certain name. This name can be used to refer to a
5031 specific chain, for example to jump to it.
5032
5033 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
5034
5035 =item B<Rule> [I<Name>]
5036
5037 Adds a new rule to the current chain. The name of the rule is optional and
5038 currently has no meaning for the daemon.
5039
5040 Within the B<Rule> block, there may be any number of B<Match> blocks and there
5041 must be at least one B<Target> block.
5042
5043 =item B<Match> I<Name>
5044
5045 Adds a match to a B<Rule> block. The name specifies what kind of match should
5046 be performed. Available matches depend on the plugins that have been loaded.
5047
5048 The arguments inside the B<Match> block are passed to the plugin implementing
5049 the match, so which arguments are valid here depends on the plugin being used.
5050 If you do not need any to pass any arguments to a match, you can use the
5051 shorter syntax:
5052
5053  Match "foobar"
5054
5055 Which is equivalent to:
5056
5057  <Match "foobar">
5058  </Match>
5059
5060 =item B<Target> I<Name>
5061
5062 Add a target to a rule or a default target to a chain. The name specifies what
5063 kind of target is to be added. Which targets are available depends on the
5064 plugins being loaded.
5065
5066 The arguments inside the B<Target> block are passed to the plugin implementing
5067 the target, so which arguments are valid here depends on the plugin being used.
5068 If you do not need any to pass any arguments to a target, you can use the
5069 shorter syntax:
5070
5071  Target "stop"
5072
5073 This is the same as writing:
5074
5075  <Target "stop">
5076  </Target>
5077
5078 =back
5079
5080 =head2 Built-in targets
5081
5082 The following targets are built into the core daemon and therefore need no
5083 plugins to be loaded:
5084
5085 =over 4
5086
5087 =item B<return>
5088
5089 Signals the "return" condition, see the L<"Flow control"> section above. This
5090 causes the current chain to stop processing the value and returns control to
5091 the calling chain. The calling chain will continue processing targets and rules
5092 just after the B<jump> target (see below). This is very similar to the
5093 B<RETURN> target of iptables, see L<iptables(8)>.
5094
5095 This target does not have any options.
5096
5097 Example:
5098
5099  Target "return"
5100
5101 =item B<stop>
5102
5103 Signals the "stop" condition, see the L<"Flow control"> section above. This
5104 causes processing of the value to be aborted immediately. This is similar to
5105 the B<DROP> target of iptables, see L<iptables(8)>.
5106
5107 This target does not have any options.
5108
5109 Example:
5110
5111  Target "stop"
5112
5113 =item B<write>
5114
5115 Sends the value to "write" plugins.
5116
5117 Available options:
5118
5119 =over 4
5120
5121 =item B<Plugin> I<Name>
5122
5123 Name of the write plugin to which the data should be sent. This option may be
5124 given multiple times to send the data to more than one write plugin.
5125
5126 =back
5127
5128 If no plugin is explicitly specified, the values will be sent to all available
5129 write plugins.
5130
5131 Example:
5132
5133  <Target "write">
5134    Plugin "rrdtool"
5135  </Target>
5136
5137 =item B<jump>
5138
5139 Starts processing the rules of another chain, see L<"Flow control"> above. If
5140 the end of that chain is reached, or a stop condition is encountered,
5141 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
5142 next target or the next rule. This is similar to the B<-j> command line option
5143 of iptables, see L<iptables(8)>.
5144
5145 Available options:
5146
5147 =over 4
5148
5149 =item B<Chain> I<Name>
5150
5151 Jumps to the chain I<Name>. This argument is required and may appear only once.
5152
5153 =back
5154
5155 Example:
5156
5157  <Target "jump">
5158    Chain "foobar"
5159  </Target>
5160
5161 =back
5162
5163 =head2 Available matches
5164
5165 =over 4
5166
5167 =item B<regex>
5168
5169 Matches a value using regular expressions.
5170
5171 Available options:
5172
5173 =over 4
5174
5175 =item B<Host> I<Regex>
5176
5177 =item B<Plugin> I<Regex>
5178
5179 =item B<PluginInstance> I<Regex>
5180
5181 =item B<Type> I<Regex>
5182
5183 =item B<TypeInstance> I<Regex>
5184
5185 Match values where the given regular expressions match the various fields of
5186 the identifier of a value. If multiple regular expressions are given, B<all>
5187 regexen must match for a value to match.
5188
5189 =item B<Invert> B<false>|B<true>
5190
5191 When set to B<true>, the result of the match is inverted, i.e. all value lists
5192 where all regular expressions apply are not matched, all other value lists are
5193 matched. Defaults to B<false>.
5194
5195 =back
5196
5197 Example:
5198
5199  <Match "regex">
5200    Host "customer[0-9]+"
5201    Plugin "^foobar$"
5202  </Match>
5203
5204 =item B<timediff>
5205
5206 Matches values that have a time which differs from the time on the server.
5207
5208 This match is mainly intended for servers that receive values over the
5209 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
5210 is very sensitive to the timestamp used when updating the RRD files. In
5211 particular, the time must be ever increasing. If a misbehaving client sends one
5212 packet with a timestamp far in the future, all further packets with a correct
5213 time will be ignored because of that one packet. What's worse, such corrupted
5214 RRD files are hard to fix.
5215
5216 This match lets one match all values B<outside> a specified time range
5217 (relative to the server's time), so you can use the B<stop> target (see below)
5218 to ignore the value, for example.
5219
5220 Available options:
5221
5222 =over 4
5223
5224 =item B<Future> I<Seconds>
5225
5226 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
5227 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5228 non-zero.
5229
5230 =item B<Past> I<Seconds>
5231
5232 Matches all values that are I<behind> of the server's time by I<Seconds> or
5233 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
5234 non-zero.
5235
5236 =back
5237
5238 Example:
5239
5240  <Match "timediff">
5241    Future  300
5242    Past   3600
5243  </Match>
5244
5245 This example matches all values that are five minutes or more ahead of the
5246 server or one hour (or more) lagging behind.
5247
5248 =item B<value>
5249
5250 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
5251 values. If a data-set consists of more than one data-source, all data-sources
5252 must match the specified ranges for a positive match.
5253
5254 Available options:
5255
5256 =over 4
5257
5258 =item B<Min> I<Value>
5259
5260 Sets the smallest value which still results in a match. If unset, behaves like
5261 negative infinity.
5262
5263 =item B<Max> I<Value>
5264
5265 Sets the largest value which still results in a match. If unset, behaves like
5266 positive infinity.
5267
5268 =item B<Invert> B<true>|B<false>
5269
5270 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
5271 no-match is returned and vice versa. Please note that the B<Invert> setting
5272 only effects how B<Min> and B<Max> are applied to a specific value. Especially
5273 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
5274
5275 =item B<DataSource> I<DSName> [I<DSName> ...]
5276
5277 Select one or more of the data sources. If no data source is configured, all
5278 data sources will be checked. If the type handled by the match does not have a
5279 data source of the specified name(s), this will always result in no match
5280 (independent of the B<Invert> setting).
5281
5282 =item B<Satisfy> B<Any>|B<All>
5283
5284 Specifies how checking with several data sources is performed. If set to
5285 B<Any>, the match succeeds if one of the data sources is in the configured
5286 range. If set to B<All> the match only succeeds if all data sources are within
5287 the configured range. Default is B<All>.
5288
5289 Usually B<All> is used for positive matches, B<Any> is used for negative
5290 matches. This means that with B<All> you usually check that all values are in a
5291 "good" range, while with B<Any> you check if any value is within a "bad" range
5292 (or outside the "good" range).
5293
5294 =back
5295
5296 Either B<Min> or B<Max>, but not both, may be unset.
5297
5298 Example:
5299
5300  # Match all values smaller than or equal to 100. Matches only if all data
5301  # sources are below 100.
5302  <Match "value">
5303    Max 100
5304    Satisfy "All"
5305  </Match>
5306  
5307  # Match if the value of any data source is outside the range of 0 - 100.
5308  <Match "value">
5309    Min   0
5310    Max 100
5311    Invert true
5312    Satisfy "Any"
5313  </Match>
5314
5315 =item B<empty_counter>
5316
5317 Matches all values with one or more data sources of type B<COUNTER> and where
5318 all counter values are zero. These counters usually I<never> increased since
5319 they started existing (and are therefore uninteresting), or got reset recently
5320 or overflowed and you had really, I<really> bad luck.
5321
5322 Please keep in mind that ignoring such counters can result in confusing
5323 behavior: Counters which hardly ever increase will be zero for long periods of
5324 time. If the counter is reset for some reason (machine or service restarted,
5325 usually), the graph will be empty (NAN) for a long time. People may not
5326 understand why.
5327
5328 =item B<hashed>
5329
5330 Calculates a hash value of the host name and matches values according to that
5331 hash value. This makes it possible to divide all hosts into groups and match
5332 only values that are in a specific group. The intended use is in load
5333 balancing, where you want to handle only part of all data and leave the rest
5334 for other servers.
5335
5336 The hashing function used tries to distribute the hosts evenly. First, it
5337 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
5338
5339   hash_value = 0;
5340   for (i = 0; host[i] != 0; i++)
5341     hash_value = (hash_value * 251) + host[i];
5342
5343 The constant 251 is a prime number which is supposed to make this hash value
5344 more random. The code then checks the group for this host according to the
5345 I<Total> and I<Match> arguments:
5346
5347   if ((hash_value % Total) == Match)
5348     matches;
5349   else
5350     does not match;
5351
5352 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
5353 groups), then the least significant bit of the hash value will be the XOR of
5354 all least significant bits in the host name. One consequence is that when you
5355 have two hosts, "server0.example.com" and "server1.example.com", where the host
5356 name differs in one digit only and the digits differ by one, those hosts will
5357 never end up in the same group.
5358
5359 Available options:
5360
5361 =over 4
5362
5363 =item B<Match> I<Match> I<Total>
5364
5365 Divide the data into I<Total> groups and match all hosts in group I<Match> as
5366 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
5367 be smaller than I<Total>. I<Total> must be at least one, although only values
5368 greater than one really do make any sense.
5369
5370 You can repeat this option to match multiple groups, for example:
5371
5372   Match 3 7
5373   Match 5 7
5374
5375 The above config will divide the data into seven groups and match groups three
5376 and five. One use would be to keep every value on two hosts so that if one
5377 fails the missing data can later be reconstructed from the second host.
5378
5379 =back
5380
5381 Example:
5382
5383  # Operate on the pre-cache chain, so that ignored values are not even in the
5384  # global cache.
5385  <Chain "PreCache">
5386    <Rule>
5387      <Match "hashed">
5388        # Divide all received hosts in seven groups and accept all hosts in
5389        # group three.
5390        Match 3 7
5391      </Match>
5392      # If matched: Return and continue.
5393      Target "return"
5394    </Rule>
5395    # If not matched: Return and stop.
5396    Target "stop"
5397  </Chain>
5398
5399 =back
5400
5401 =head2 Available targets
5402
5403 =over 4
5404
5405 =item B<notification>
5406
5407 Creates and dispatches a notification.
5408
5409 Available options:
5410
5411 =over 4
5412
5413 =item B<Message> I<String>
5414
5415 This required option sets the message of the notification. The following
5416 placeholders will be replaced by an appropriate value:
5417
5418 =over 4
5419
5420 =item B<%{host}>
5421
5422 =item B<%{plugin}>
5423
5424 =item B<%{plugin_instance}>
5425
5426 =item B<%{type}>
5427
5428 =item B<%{type_instance}>
5429
5430 These placeholders are replaced by the identifier field of the same name.
5431
5432 =item B<%{ds:>I<name>B<}>
5433
5434 These placeholders are replaced by a (hopefully) human readable representation
5435 of the current rate of this data source. If you changed the instance name
5436 (using the B<set> or B<replace> targets, see below), it may not be possible to
5437 convert counter values to rates.
5438
5439 =back
5440
5441 Please note that these placeholders are B<case sensitive>!
5442
5443 =item B<Severity> B<"FATAL">|B<"WARNING">|B<"OKAY">
5444
5445 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
5446 used.
5447
5448 =back
5449
5450 Example:
5451
5452   <Target "notification">
5453     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
5454     Severity "WARNING"
5455   </Target>
5456
5457 =item B<replace>
5458
5459 Replaces parts of the identifier using regular expressions.
5460
5461 Available options:
5462
5463 =over 4
5464
5465 =item B<Host> I<Regex> I<Replacement>
5466
5467 =item B<Plugin> I<Regex> I<Replacement>
5468
5469 =item B<PluginInstance> I<Regex> I<Replacement>
5470
5471 =item B<TypeInstance> I<Regex> I<Replacement>
5472
5473 Match the appropriate field with the given regular expression I<Regex>. If the
5474 regular expression matches, that part that matches is replaced with
5475 I<Replacement>. If multiple places of the input buffer match a given regular
5476 expression, only the first occurrence will be replaced.
5477
5478 You can specify each option multiple times to use multiple regular expressions
5479 one after another.
5480
5481 =back
5482
5483 Example:
5484
5485  <Target "replace">
5486    # Replace "example.net" with "example.com"
5487    Host "\\<example.net\\>" "example.com"
5488  
5489    # Strip "www." from hostnames
5490    Host "\\<www\\." ""
5491  </Target>
5492
5493 =item B<set>
5494
5495 Sets part of the identifier of a value to a given string.
5496
5497 Available options:
5498
5499 =over 4
5500
5501 =item B<Host> I<String>
5502
5503 =item B<Plugin> I<String>
5504
5505 =item B<PluginInstance> I<String>
5506
5507 =item B<TypeInstance> I<String>
5508
5509 Set the appropriate field to the given string. The strings for plugin instance
5510 and type instance may be empty, the strings for host and plugin may not be
5511 empty. It's currently not possible to set the type of a value this way.
5512
5513 =back
5514
5515 Example:
5516
5517  <Target "set">
5518    PluginInstance "coretemp"
5519    TypeInstance "core3"
5520  </Target>
5521
5522 =back
5523
5524 =head2 Backwards compatibility
5525
5526 If you use collectd with an old configuration, i.E<nbsp>e. one without a
5527 B<Chain> block, it will behave as it used to. This is equivalent to the
5528 following configuration:
5529
5530  <Chain "PostCache">
5531    Target "write"
5532  </Chain>
5533
5534 If you specify a B<PostCacheChain>, the B<write> target will not be added
5535 anywhere and you will have to make sure that it is called where appropriate. We
5536 suggest to add the above snippet as default target to your "PostCache" chain.
5537
5538 =head2 Examples
5539
5540 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
5541 be an FQDN.
5542
5543  <Chain "PreCache">
5544    <Rule "no_fqdn">
5545      <Match "regex">
5546        Host "^[^\.]*$"
5547      </Match>
5548      Target "stop"
5549    </Rule>
5550    Target "write"
5551  </Chain>
5552
5553 =head1 SEE ALSO
5554
5555 L<collectd(1)>,
5556 L<collectd-exec(5)>,
5557 L<collectd-perl(5)>,
5558 L<collectd-unixsock(5)>,
5559 L<types.db(5)>,
5560 L<hddtemp(8)>,
5561 L<iptables(8)>,
5562 L<kstat(3KSTAT)>,
5563 L<mbmon(1)>,
5564 L<psql(1)>,
5565 L<regex(7)>,
5566 L<rrdtool(1)>,
5567 L<sensors(1)>
5568
5569 =head1 AUTHOR
5570
5571 Florian Forster E<lt>octo@verplant.orgE<gt>
5572
5573 =cut