Code

rrdtool plugin: Use cdrand_range() for the random variation.
[collectd.git] / src / collectd.conf.pod
1 =head1 NAME
3 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
5 =head1 SYNOPSIS
7   BaseDir "/path/to/data/"
8   PIDFile "/path/to/pidfile/collectd.pid"
9   Server  "123.123.123.123" 12345
10   
11   LoadPlugin cpu
12   LoadPlugin load
13   
14   <LoadPlugin df>
15     Interval 3600
16   </LoadPlugin>
17   
18   LoadPlugin ping
19   <Plugin ping>
20     Host "example.org"
21     Host "provider.net"
22   </Plugin>
24 =head1 DESCRIPTION
26 This config file controls how the system statistics collection daemon
27 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
28 controls which plugins to load. These plugins ultimately define collectd's
29 behavior.
31 The syntax of this config file is similar to the config file of the famous
32 I<Apache> webserver. Each line contains either an option (a key and a list of
33 one or more values) or a section-start or -end. Empty lines and everything
34 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
35 strings, consisting only of alphanumeric characters and the underscore (C<_>)
36 character. Keys are handled case insensitive by I<collectd> itself and all
37 plugins included with it. I<Values> can either be an I<unquoted string>, a
38 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
39 expression. I<Unquoted strings> consist of only alphanumeric characters and
40 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
41 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
42 to include double quotes as part of the string. I<Numbers> can be specified in
43 decimal and floating point format (using a dot C<.> as decimal separator),
44 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
45 I<Boolean> values are either B<true> or B<false>.
47 Lines may be wrapped by using C<\> as the last character before the newline.
48 This allows long lines to be split into multiple lines. Quoted strings may be
49 wrapped as well. However, those are treated special in that whitespace at the
50 beginning of the following lines will be ignored, which allows for nicely
51 indenting the wrapped lines.
53 The configuration is read and processed in order, i.e. from top to bottom. So
54 the plugins are loaded in the order listed in this config file. It is a good
55 idea to load any logging plugins first in order to catch messages from plugins
56 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
57 the appropriate C<E<lt>Plugin ...E<gt>> block.
59 =head1 GLOBAL OPTIONS
61 =over 4
63 =item B<BaseDir> I<Directory>
65 Sets the base directory. This is the directory beneath all RRD-files are
66 created. Possibly more subdirectories are created. This is also the working
67 directory for the daemon.
69 =item B<LoadPlugin> I<Plugin>
71 Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
72 will be mostly useless.
74 Starting with collectd 4.9, this may also be a block in which further options
75 affecting the behavior of B<LoadPlugin> may be specified. The following
76 options are allowed inside a B<LoadPlugin> block:
78   <LoadPlugin perl>
79     Globals true
80     Interval 10
81   </LoadPlugin>
83 =over 4
85 =item B<Globals> B<true|false>
87 If enabled, collectd will export all global symbols of the plugin (and of all
88 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
89 available for resolving unresolved symbols in subsequently loaded plugins if
90 that is supported by your system.
92 This is useful (or possibly even required), e.g., when loading a plugin that
93 embeds some scripting language into the daemon (e.g. the I<Perl> and
94 I<Python plugins>). Scripting languages usually provide means to load
95 extensions written in C. Those extensions require symbols provided by the
96 interpreter, which is loaded as a dependency of the respective collectd plugin.
97 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
98 L<collectd-python(5)>) for details.
100 By default, this is disabled. As a special exception, if the plugin name is
101 either C<perl> or C<python>, the default is changed to enabled in order to keep
102 the average user from ever having to deal with this low level linking stuff.
104 =item B<Interval> I<Seconds>
106 Sets a plugin-specific interval for collecting metrics. This overrides the
107 global B<Interval> setting. If a plugin provides own support for specifying an
108 interval, that setting will take precedence.
110 =back
112 =item B<Include> I<Path> [I<pattern>]
114 If I<Path> points to a file, includes that file. If I<Path> points to a
115 directory, recursively includes all files within that directory and its
116 subdirectories. If the C<wordexp> function is available on your system,
117 shell-like wildcards are expanded before files are included. This means you can
118 use statements like the following:
120   Include "/etc/collectd.d/*.conf"
122 If the C<fnmatch> function is available on your system, a shell-like wildcard
123 I<pattern> may be specified to filter which files to include. This may be used
124 in combination with recursively including a directory to easily be able to
125 arbitrarily mix configuration files and other documents (e.g. README files).
126 The following statement is similar to the example above but includes all files
127 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
129   Include "/etc/collectd.d" "*.conf"
131 If more than one files are included by a single B<Include> option, the files
132 will be included in lexicographical order (as defined by the C<strcmp>
133 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
134 order in which the files are loaded.
136 To prevent loops and shooting yourself in the foot in interesting ways the
137 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
138 most uses. Since symlinks are followed it is still possible to crash the daemon
139 by looping symlinks. In our opinion significant stupidity should result in an
140 appropriate amount of pain.
142 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
143 file, but you cannot include files from within blocks.
145 =item B<PIDFile> I<File>
147 Sets where to write the PID file to. This file is overwritten when it exists
148 and deleted when the program is stopped. Some init-scripts might override this
149 setting using the B<-P> command-line option.
151 =item B<PluginDir> I<Directory>
153 Path to the plugins (shared objects) of collectd.
155 =item B<TypesDB> I<File> [I<File> ...]
157 Set one or more files that contain the data-set descriptions. See
158 L<types.db(5)> for a description of the format of this file.
160 =item B<Interval> I<Seconds>
162 Configures the interval in which to query the read plugins. Obviously smaller
163 values lead to a higher system load produced by collectd, while higher values
164 lead to more coarse statistics.
166 B<Warning:> You should set this once and then never touch it again. If you do,
167 I<you will have to delete all your RRD files> or know some serious RRDtool
168 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
170 =item B<Timeout> I<Iterations>
172 Consider a value list "missing" when no update has been read or received for
173 I<Iterations> iterations. By default, I<collectd> considers a value list
174 missing when no update has been received for twice the update interval. Since
175 this setting uses iterations, the maximum allowed time without update depends
176 on the I<Interval> information contained in each value list. This is used in
177 the I<Threshold> configuration to dispatch notifications about missing values,
178 see L<collectd-threshold(5)> for details.
180 =item B<ReadThreads> I<Num>
182 Number of threads to start for reading plugins. The default value is B<5>, but
183 you may want to increase this if you have more than five plugins that take a
184 long time to read. Mostly those are plugins that do network-IO. Setting this to
185 a value higher than the number of registered read callbacks is not recommended.
187 =item B<WriteThreads> I<Num>
189 Number of threads to start for dispatching value lists to write plugins. The
190 default value is B<5>, but you may want to increase this if you have more than
191 five plugins that may take relatively long to write to.
193 =item B<Hostname> I<Name>
195 Sets the hostname that identifies a host. If you omit this setting, the
196 hostname will be determined using the L<gethostname(2)> system call.
198 =item B<FQDNLookup> B<true|false>
200 If B<Hostname> is determined automatically this setting controls whether or not
201 the daemon should try to figure out the "fully qualified domain name", FQDN.
202 This is done using a lookup of the name returned by C<gethostname>. This option
203 is enabled by default.
205 =item B<PreCacheChain> I<ChainName>
207 =item B<PostCacheChain> I<ChainName>
209 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
210 see L<FILTER CONFIGURATION> below on information on chains and how these
211 setting change the daemon's behavior.
213 =back
215 =head1 PLUGIN OPTIONS
217 Some plugins may register own options. These options must be enclosed in a
218 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
219 require external configuration, too. The C<apache plugin>, for example,
220 required C<mod_status> to be configured in the webserver you're going to
221 collect data from. These plugins are listed below as well, even if they don't
222 require any configuration within collectd's configuration file.
224 A list of all plugins and a short summary for each plugin can be found in the
225 F<README> file shipped with the sourcecode and hopefully binary packets as
226 well.
228 =head2 Plugin C<aggregation>
230 The I<Aggregation plugin> makes it possible to aggregate several values into
231 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
232 This can be put to a wide variety of uses, e.g. average and total CPU
233 statistics for your entire fleet.
235 The grouping is powerful but, as with many powerful tools, may be a bit
236 difficult to wrap your head around. The grouping will therefore be
237 demonstrated using an example: The average and sum of the CPU usage across
238 all CPUs of each host is to be calculated.
240 To select all the affected values for our example, set C<Plugin cpu> and
241 C<Type cpu>. The other values are left unspecified, meaning "all values". The
242 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
243 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
244 statement.
246   Plugin "cpu"
247   Type "cpu"
249 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...)  and
250 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
251 example, the intention is to have a new value for each host / type instance
252 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
253 It can be specified multiple times to group by more than one field.
255   GroupBy "Host"
256   GroupBy "TypeInstance"
258 We do neither specify nor group by I<plugin instance> (the CPU number), so all
259 metrics that differ in the CPU number only will be aggregated. Each
260 aggregation needs I<at least one> such field, otherwise no aggregation would
261 take place.
263 The full example configuration looks like this:
265  <Plugin "aggregation">
266    <Aggregation>
267      Plugin "cpu"
268      Type "cpu"
269      
270      GroupBy "Host"
271      GroupBy "TypeInstance"
272      
273      CalculateSum true
274      CalculateAverage true
275    </Aggregation>
276  </Plugin>
278 There are a couple of limitations you should be aware of:
280 =over 4
282 =item
284 The I<Type> cannot be left unspecified, because it is not reasonable to add
285 apples to oranges. Also, the internal lookup structure won't work if you try
286 to group by type.
288 =item
290 There must be at least one unspecified, ungrouped field. Otherwise nothing
291 will be aggregated.
293 =back
295 As you can see in the example above, each aggregation has its own
296 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
297 blocks may match the same values, i.e. one value list can update multiple
298 aggregations. The following options are valid inside B<Aggregation> blocks:
300 =over 4
302 =item B<Host> I<Host>
304 =item B<Plugin> I<Plugin>
306 =item B<PluginInstance> I<PluginInstance>
308 =item B<Type> I<Type>
310 =item B<TypeInstance> I<TypeInstance>
312 Selects the value lists to be added to this aggregation. B<Type> must be a
313 valid data set name, see L<types.db(5)> for details.
315 If the string starts with and ends with a slash (C</>), the string is
316 interpreted as a I<regular expression>. The regex flavor used are POSIX
317 extended regular expressions as described in L<regex(7)>. Example usage:
319  Host "/^db[0-9]\\.example\\.com$/"
321 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
323 Group valued by the specified field. The B<GroupBy> option may be repeated to
324 group by multiple fields.
326 =item B<SetHost> I<Host>
328 =item B<SetPlugin> I<Plugin>
330 =item B<SetPluginInstance> I<PluginInstance>
332 =item B<SetTypeInstance> I<TypeInstance>
334 Sets the appropriate part of the identifier to the provided string.
336 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
337 will be replaced with the aggregation function, e.g. "average". Not including
338 the placeholder will result in duplication warnings and/or messed up values if
339 more than one aggregation function are enabled.
341 The following example calculates the average usage of all "even" CPUs:
343  <Plugin "aggregation">
344    <Aggregation>
345      Plugin "cpu"
346      PluginInstance "/[0,2,4,6,8]$/"
347      Type "cpu"
348      
349      SetPlugin "cpu"
350      SetPluginInstance "even-%{aggregation}"
351      
352      GroupBy "Host"
353      GroupBy "TypeInstance"
354      
355      CalculateAverage true
356    </Aggregation>
357  </Plugin>
359 This will create the files:
361 =over 4
363 =item
365 foo.example.com/cpu-even-average/cpu-idle
367 =item
369 foo.example.com/cpu-even-average/cpu-system
371 =item
373 foo.example.com/cpu-even-average/cpu-user
375 =item
377 ...
379 =back
381 =item B<CalculateNum> B<true>|B<false>
383 =item B<CalculateSum> B<true>|B<false>
385 =item B<CalculateAverage> B<true>|B<false>
387 =item B<CalculateMinimum> B<true>|B<false>
389 =item B<CalculateMaximum> B<true>|B<false>
391 =item B<CalculateStddev> B<true>|B<false>
393 Boolean options for enabling calculation of the number of value lists, their
394 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
395 are disabled by default.
397 =back
399 =head2 Plugin C<amqp>
401 The I<AMQMP plugin> can be used to communicate with other instances of
402 I<collectd> or third party applications using an AMQP message broker. Values
403 are sent to or received from the broker, which handles routing, queueing and
404 possibly filtering or messages.
406  <Plugin "amqp">
407    # Send values to an AMQP broker
408    <Publish "some_name">
409      Host "localhost"
410      Port "5672"
411      VHost "/"
412      User "guest"
413      Password "guest"
414      Exchange "amq.fanout"
415  #   ExchangeType "fanout"
416  #   RoutingKey "collectd"
417  #   Persistent false
418  #   Format "command"
419  #   StoreRates false
420  #   GraphitePrefix "collectd."
421  #   GraphiteEscapeChar "_"
422    </Publish>
423    
424    # Receive values from an AMQP broker
425    <Subscribe "some_name">
426      Host "localhost"
427      Port "5672"
428      VHost "/"
429      User "guest"
430      Password "guest"
431      Exchange "amq.fanout"
432  #   ExchangeType "fanout"
433  #   Queue "queue_name"
434  #   RoutingKey "collectd.#"
435    </Subscribe>
436  </Plugin>
438 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
439 blocks, which configure sending and receiving of values respectively. The two
440 blocks are very similar, so unless otherwise noted, an option can be used in
441 either block. The name given in the blocks starting tag is only used for
442 reporting messages, but may be used to support I<flushing> of certain
443 I<Publish> blocks in the future.
445 =over 4
447 =item B<Host> I<Host>
449 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
450 the underlying communications library, I<rabbitmq-c>, which is "localhost".
452 =item B<Port> I<Port>
454 Service name or port number on which the AMQP broker accepts connections. This
455 argument must be a string, even if the numeric form is used. Defaults to
456 "5672".
458 =item B<VHost> I<VHost>
460 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
462 =item B<User> I<User>
464 =item B<Password> I<Password>
466 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
467 is used.
469 =item B<Exchange> I<Exchange>
471 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
472 By default, "amq.fanout" will be used.
474 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
475 the given exchange and the I<queue> is created, using the I<routing key> if
476 configured. See the B<Queue> and B<RoutingKey> options below.
478 =item B<ExchangeType> I<Type>
480 If given, the plugin will try to create the configured I<exchange> with this
481 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
482 be bound to this exchange.
484 =item B<Queue> I<Queue> (Subscribe only)
486 Configures the I<queue> name to subscribe to. If no queue name was configures
487 explicitly, a unique queue name will be created by the broker.
489 =item B<RoutingKey> I<Key>
491 In I<Publish> blocks, this configures the routing key to set on all outgoing
492 messages. If not given, the routing key will be computed from the I<identifier>
493 of the value. The host, plugin, type and the two instances are concatenated
494 together using dots as the separator and all containing dots replaced with
495 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
496 possible to receive only specific values using a "topic" exchange.
498 In I<Subscribe> blocks, configures the I<routing key> used when creating a
499 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
500 used to filter messages when using a "topic" exchange. If you're only
501 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
502 for example.
504 =item B<Persistent> B<true>|B<false> (Publish only)
506 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
507 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
508 default), the I<transient> delivery mode will be used, i.e. messages may be
509 lost due to high load, overflowing queues or similar issues.
511 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
513 Selects the format in which messages are sent to the broker. If set to
514 B<Command> (the default), values are sent as C<PUTVAL> commands which are
515 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
516 case, the C<Content-Type> header field will be set to C<text/collectd>.
518 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
519 an easy and straight forward exchange format. The C<Content-Type> header field
520 will be set to C<application/json>.
522 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
523 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
524 C<text/graphite>.
526 A subscribing client I<should> use the C<Content-Type> header field to
527 determine how to decode the values. Currently, the I<AMQP plugin> itself can
528 only decode the B<Command> format.
530 =item B<StoreRates> B<true>|B<false> (Publish only)
532 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
533 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
534 default), no conversion is performed. Otherwise the conversion is performed
535 using the internal value cache.
537 Please note that currently this option is only used if the B<Format> option has
538 been set to B<JSON>.
540 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
542 A prefix can be added in the metric name when outputting in the I<Graphite> format.
543 It's added before the I<Host> name.
544 Metric name will be "<prefix><host><postfix><plugin><type><name>"
546 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
548 A postfix can be added in the metric name when outputting in the I<Graphite> format.
549 It's added after the I<Host> name.
550 Metric name will be "<prefix><host><postfix><plugin><type><name>"
552 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
554 Specify a character to replace dots (.) in the host part of the metric name.
555 In I<Graphite> metric name, dots are used as separators between different
556 metric parts (host, plugin, type).
557 Default is "_" (I<Underscore>).
559 =back
561 =head2 Plugin C<apache>
563 To configure the C<apache>-plugin you first need to configure the Apache
564 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
565 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
566 the following snipped to base your Apache config upon:
568   ExtendedStatus on
569   <IfModule mod_status.c>
570     <Location /mod_status>
571       SetHandler server-status
572     </Location>
573   </IfModule>
575 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
576 also supported. It introduces a new field, called C<BusyServers>, to count the
577 number of currently connected clients. This field is also supported.
579 The configuration of the I<Apache> plugin consists of one or more
580 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
581 as the instance name. For example:
583  <Plugin "apache">
584    <Instance "www1">
585      URL "http://www1.example.com/mod_status?auto"
586    </Instance>
587    <Instance "www2">
588      URL "http://www2.example.com/mod_status?auto"
589    </Instance>
590  </Plugin>
592 The instance name will be used as the I<plugin instance>. To emulate the old
593 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
594 plugin to work correctly, each instance name must be unique. This is not
595 enforced by the plugin and it is your responsibility to ensure it.
597 The following options are accepted within each I<Instance> block:
599 =over 4
601 =item B<URL> I<http://host/mod_status?auto>
603 Sets the URL of the C<mod_status> output. This needs to be the output generated
604 by C<ExtendedStatus on> and it needs to be the machine readable output
605 generated by appending the C<?auto> argument. This option is I<mandatory>.
607 =item B<User> I<Username>
609 Optional user name needed for authentication.
611 =item B<Password> I<Password>
613 Optional password needed for authentication.
615 =item B<VerifyPeer> B<true|false>
617 Enable or disable peer SSL certificate verification. See
618 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
620 =item B<VerifyHost> B<true|false>
622 Enable or disable peer host name verification. If enabled, the plugin checks
623 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
624 certificate matches the host name provided by the B<URL> option. If this
625 identity check fails, the connection is aborted. Obviously, only works when
626 connecting to a SSL enabled server. Enabled by default.
628 =item B<CACert> I<File>
630 File that holds one or more SSL certificates. If you want to use HTTPS you will
631 possibly need this option. What CA certificates come bundled with C<libcurl>
632 and are checked by default depends on the distribution you use.
634 =back
636 =head2 Plugin C<apcups>
638 =over 4
640 =item B<Host> I<Hostname>
642 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
643 that IPv6 support has been disabled unless someone can confirm or decline that
644 B<apcupsd> can handle it.
646 =item B<Port> I<Port>
648 TCP-Port to connect to. Defaults to B<3551>.
650 =item B<ReportSeconds> B<true|false>
652 If set to B<true>, the time reported in the C<timeleft> metric will be
653 converted to seconds. This is the recommended setting. If set to B<false>, the
654 default for backwards compatibility, the time will be reported in minutes.
656 =back
658 =head2 Plugin C<ascent>
660 This plugin collects information about an Ascent server, a free server for the
661 "World of Warcraft" game. This plugin gathers the information by fetching the
662 XML status page using C<libcurl> and parses it using C<libxml2>.
664 The configuration options are the same as for the C<apache> plugin above:
666 =over 4
668 =item B<URL> I<http://localhost/ascent/status/>
670 Sets the URL of the XML status output.
672 =item B<User> I<Username>
674 Optional user name needed for authentication.
676 =item B<Password> I<Password>
678 Optional password needed for authentication.
680 =item B<VerifyPeer> B<true|false>
682 Enable or disable peer SSL certificate verification. See
683 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
685 =item B<VerifyHost> B<true|false>
687 Enable or disable peer host name verification. If enabled, the plugin checks
688 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
689 certificate matches the host name provided by the B<URL> option. If this
690 identity check fails, the connection is aborted. Obviously, only works when
691 connecting to a SSL enabled server. Enabled by default.
693 =item B<CACert> I<File>
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.
699 =back
701 =head2 Plugin C<bind>
703 Starting with BIND 9.5.0, the most widely used DNS server software provides
704 extensive statistics about queries, responses and lots of other information.
705 The bind plugin retrieves this information that's encoded in XML and provided
706 via HTTP and submits the values to collectd.
708 To use this plugin, you first need to tell BIND to make this information
709 available. This is done with the C<statistics-channels> configuration option:
711  statistics-channels {
712    inet localhost port 8053;
713  };
715 The configuration follows the grouping that can be seen when looking at the
716 data with an XSLT compatible viewer, such as a modern web browser. It's
717 probably a good idea to make yourself familiar with the provided values, so you
718 can understand what the collected statistics actually mean.
720 Synopsis:
722  <Plugin "bind">
723    URL "http://localhost:8053/"
724    ParseTime       false
725    OpCodes         true
726    QTypes          true
727  
728    ServerStats     true
729    ZoneMaintStats  true
730    ResolverStats   false
731    MemoryStats     true
732  
733    <View "_default">
734      QTypes        true
735      ResolverStats true
736      CacheRRSets   true
737  
738      Zone "127.in-addr.arpa/IN"
739    </View>
740  </Plugin>
742 The bind plugin accepts the following configuration options:
744 =over 4
746 =item B<URL> I<URL>
748 URL from which to retrieve the XML data. If not specified,
749 C<http://localhost:8053/> will be used.
751 =item B<ParseTime> B<true>|B<false>
753 When set to B<true>, the time provided by BIND will be parsed and used to
754 dispatch the values. When set to B<false>, the local time source is queried.
756 This setting is set to B<true> by default for backwards compatibility; setting
757 this to B<false> is I<recommended> to avoid problems with timezones and
758 localization.
760 =item B<OpCodes> B<true>|B<false>
762 When enabled, statistics about the I<"OpCodes">, for example the number of
763 C<QUERY> packets, are collected.
765 Default: Enabled.
767 =item B<QTypes> B<true>|B<false>
769 When enabled, the number of I<incoming> queries by query types (for example
770 C<A>, C<MX>, C<AAAA>) is collected.
772 Default: Enabled.
774 =item B<ServerStats> B<true>|B<false>
776 Collect global server statistics, such as requests received over IPv4 and IPv6,
777 successful queries, and failed updates.
779 Default: Enabled.
781 =item B<ZoneMaintStats> B<true>|B<false>
783 Collect zone maintenance statistics, mostly information about notifications
784 (zone updates) and zone transfers.
786 Default: Enabled.
788 =item B<ResolverStats> B<true>|B<false>
790 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
791 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
792 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
793 default. Use the B<ResolverStats> option within a B<View "_default"> block
794 instead for the same functionality.
796 Default: Disabled.
798 =item B<MemoryStats>
800 Collect global memory statistics.
802 Default: Enabled.
804 =item B<View> I<Name>
806 Collect statistics about a specific I<"view">. BIND can behave different,
807 mostly depending on the source IP-address of the request. These different
808 configurations are called "views". If you don't use this feature, you most
809 likely are only interested in the C<_default> view.
811 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
812 information you want to collect about a view. If no B<View> block is
813 configured, no detailed view statistics will be collected.
815 =over 4
817 =item B<QTypes> B<true>|B<false>
819 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
820 C<MX>) is collected.
822 Default: Enabled.
824 =item B<ResolverStats> B<true>|B<false>
826 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
827 (e.E<nbsp>g. queries over IPv4, lame servers).
829 Default: Enabled.
831 =item B<CacheRRSets> B<true>|B<false>
833 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
834 type is collected. Negative entries (queries which resulted in an error, for
835 example names that do not exist) are reported with a leading exclamation mark,
836 e.E<nbsp>g. "!A".
838 Default: Enabled.
840 =item B<Zone> I<Name>
842 When given, collect detailed information about the given zone in the view. The
843 information collected if very similar to the global B<ServerStats> information
844 (see above).
846 You can repeat this option to collect detailed information about multiple
847 zones.
849 By default no detailed zone information is collected.
851 =back
853 =back
855 =head2 Plugin C<cpufreq>
857 This plugin doesn't have any options. It reads
858 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
859 installed) to get the current CPU frequency. If this file does not exist make
860 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
861 installed and an "cpu governor" (that's a kernel module) is loaded.
863 =head2 Plugin C<csv>
865 =over 4
867 =item B<DataDir> I<Directory>
869 Set the directory to store CSV-files under. Per default CSV-files are generated
870 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
871 The special strings B<stdout> and B<stderr> can be used to write to the standard
872 output and standard error channels, respectively. This, of course, only makes
873 much sense when collectd is running in foreground- or non-daemon-mode.
875 =item B<StoreRates> B<true|false>
877 If set to B<true>, convert counter values to rates. If set to B<false> (the
878 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
879 number.
881 =back
883 =head2 Plugin C<curl>
885 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
886 and the match infrastructure (the same code used by the tail plugin) to use
887 regular expressions with the received data.
889 The following example will read the current value of AMD stock from Google's
890 finance page and dispatch the value to collectd.
892   <Plugin curl>
893     <Page "stock_quotes">
894       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
895       User "foo"
896       Password "bar"
897       <Match>
898         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
899         DSType "GaugeAverage"
900         # Note: `stock_value' is not a standard type.
901         Type "stock_value"
902         Instance "AMD"
903       </Match>
904     </Page>
905   </Plugin>
907 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
908 a web page and one or more "matches" to be performed on the returned data. The
909 string argument to the B<Page> block is used as plugin instance.
911 The following options are valid within B<Page> blocks:
913 =over 4
915 =item B<URL> I<URL>
917 URL of the web site to retrieve. Since a regular expression will be used to
918 extract information from this data, non-binary data is a big plus here ;)
920 =item B<User> I<Name>
922 Username to use if authorization is required to read the page.
924 =item B<Password> I<Password>
926 Password to use if authorization is required to read the page.
928 =item B<VerifyPeer> B<true>|B<false>
930 Enable or disable peer SSL certificate verification. See
931 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
933 =item B<VerifyHost> B<true>|B<false>
935 Enable or disable peer host name verification. If enabled, the plugin checks if
936 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
937 matches the host name provided by the B<URL> option. If this identity check
938 fails, the connection is aborted. Obviously, only works when connecting to a
939 SSL enabled server. Enabled by default.
941 =item B<CACert> I<file>
943 File that holds one or more SSL certificates. If you want to use HTTPS you will
944 possibly need this option. What CA certificates come bundled with C<libcurl>
945 and are checked by default depends on the distribution you use.
947 =item B<Header> I<Header>
949 A HTTP header to add to the request. Multiple headers are added if this option
950 is specified more than once.
952 =item B<Post> I<Body>
954 Specifies that the HTTP operation should be a POST instead of a GET. The
955 complete data to be posted is given as the argument.  This option will usually
956 need to be accompanied by a B<Header> option to set an appropriate
957 C<Content-Type> for the post body (e.g. to
958 C<application/x-www-form-urlencoded>).
960 =item B<MeasureResponseTime> B<true>|B<false>
962 Measure response time for the request. If this setting is enabled, B<Match>
963 blocks (see below) are optional. Disabled by default.
965 =item B<E<lt>MatchE<gt>>
967 One or more B<Match> blocks that define how to match information in the data
968 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
969 used by the C<tail> plugin, so please see the documentation of the C<tail>
970 plugin below on how matches are defined. If the B<MeasureResponseTime> option
971 is set to B<true>, B<Match> blocks are optional.
973 =back
975 =head2 Plugin C<curl_json>
977 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
978 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
979 via cURL. This can be used to collect values from CouchDB documents (which are
980 stored JSON notation), for example.
982 The following example will collect several values from the built-in `_stats'
983 runtime statistics module of CouchDB
984 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
986   <Plugin curl_json>
987     <URL "http://localhost:5984/_stats">
988       Instance "httpd"
989       <Key "httpd/requests/count">
990         Type "http_requests"
991       </Key>
993       <Key "httpd_request_methods/*/count">
994         Type "http_request_methods"
995       </Key>
997       <Key "httpd_status_codes/*/count">
998         Type "http_response_codes"
999       </Key>
1000     </URL>
1001   </Plugin>
1003 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
1004 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
1005 The B<Key> string argument must be in a path format, which is used to collect a
1006 value from a JSON map object. If a path element of B<Key> is the
1007 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
1009 The following options are valid within B<URL> blocks:
1011 =over 4
1013 =item B<Instance> I<Instance>
1015 Sets the plugin instance to I<Instance>.
1017 =item B<User> I<Name>
1018 =item B<Password> I<Password>
1019 =item B<VerifyPeer> B<true>|B<false>
1020 =item B<VerifyHost> B<true>|B<false>
1021 =item B<CACert> I<file>
1022 =item B<Header> I<Header>
1023 =item B<Post> I<Body>
1025 These options behave exactly equivalent to the appropriate options of the
1026 I<cURL> plugin. Please see there for a detailed description.
1028 =back
1030 The following options are valid within B<Key> blocks:
1032 =over 4
1034 =item B<Type> I<Type>
1036 Sets the type used to dispatch the values to the daemon. Detailed information
1037 about types and their configuration can be found in L<types.db(5)>. This
1038 option is mandatory.
1040 =item B<Instance> I<Instance>
1042 Type-instance to use. Defaults to the current map key or current string array element value.
1044 =back
1046 =head2 Plugin C<curl_xml>
1048 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1049 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1051  <Plugin "curl_xml">
1052    <URL "http://localhost/stats.xml">
1053      Host "my_host"
1054      Instance "some_instance"
1055      User "collectd"
1056      Password "thaiNg0I"
1057      VerifyPeer true
1058      VerifyHost true
1059      CACert "/path/to/ca.crt"
1061      <XPath "table[@id=\"magic_level\"]/tr">
1062        Type "magic_level"
1063        #InstancePrefix "prefix-"
1064        InstanceFrom "td[1]"
1065        ValuesFrom "td[2]/span[@class=\"level\"]"
1066      </XPath>
1067    </URL>
1068  </Plugin>
1070 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1071 URL to be fetched using libcurl. Within each B<URL> block there are
1072 options which specify the connection parameters, for example authentication
1073 information, and one or more B<XPath> blocks.
1075 Each B<XPath> block specifies how to get one type of information. The
1076 string argument must be a valid XPath expression which returns a list
1077 of "base elements". One value is dispatched for each "base element". The
1078 I<type instance> and values are looked up using further I<XPath> expressions
1079 that should be relative to the base element.
1081 Within the B<URL> block the following options are accepted:
1083 =over 4
1085 =item B<Host> I<Name>
1087 Use I<Name> as the host name when submitting values. Defaults to the global
1088 host name setting.
1090 =item B<Instance> I<Instance>
1092 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1093 empty string (no plugin instance).
1095 =item B<Namespace> I<Prefix> I<URL>
1097 If an XPath expression references namespaces, they must be specified
1098 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1099 I<URL> is the "namespace name", an URI reference uniquely identifying the
1100 namespace. The option can be repeated to register multiple namespaces.
1102 Examples:
1104   Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1105   Namespace "m" "http://www.w3.org/1998/Math/MathML"
1107 =item B<User> I<User>
1109 =item B<Password> I<Password>
1111 =item B<VerifyPeer> B<true>|B<false>
1113 =item B<VerifyHost> B<true>|B<false>
1115 =item B<CACert> I<CA Cert File>
1117 =item B<Header> I<Header>
1119 =item B<Post> I<Body>
1121 These options behave exactly equivalent to the appropriate options of the
1122 I<cURL plugin>. Please see there for a detailed description.
1124 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1126 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1127 B<XPath> block specifies how to get one type of information. The string
1128 argument must be a valid XPath expression which returns a list of "base
1129 elements". One value is dispatched for each "base element".
1131 Within the B<XPath> block the following options are accepted:
1133 =over 4
1135 =item B<Type> I<Type>
1137 Specifies the I<Type> used for submitting patches. This determines the number
1138 of values that are required / expected and whether the strings are parsed as
1139 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1140 This option is required.
1142 =item B<InstancePrefix> I<InstancePrefix>
1144 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1145 concatenated together without any separator.
1146 This option is optional.
1148 =item B<InstanceFrom> I<InstanceFrom>
1150 Specifies a XPath expression to use for determining the I<type instance>. The
1151 XPath expression must return exactly one element. The element's value is then
1152 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1154 This value is required. As a special exception, if the "base XPath expression"
1155 (the argument to the B<XPath> block) returns exactly one argument, then this
1156 option may be omitted.
1158 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1160 Specifies one or more XPath expression to use for reading the values. The
1161 number of XPath expressions must match the number of data sources in the
1162 I<type> specified with B<Type> (see above). Each XPath expression must return
1163 exactly one element. The element's value is then parsed as a number and used as
1164 value for the appropriate value in the value list dispatched to the daemon.
1166 =back
1168 =back
1170 =head2 Plugin C<dbi>
1172 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1173 connect to various databases, execute I<SQL> statements and read back the
1174 results. I<dbi> is an acronym for "database interface" in case you were
1175 wondering about the name. You can configure how each column is to be
1176 interpreted and the plugin will generate one or more data sets from each row
1177 returned according to these rules.
1179 Because the plugin is very generic, the configuration is a little more complex
1180 than those of other plugins. It usually looks something like this:
1182   <Plugin dbi>
1183     <Query "out_of_stock">
1184       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1185       # Use with MySQL 5.0.0 or later
1186       MinVersion 50000
1187       <Result>
1188         Type "gauge"
1189         InstancePrefix "out_of_stock"
1190         InstancesFrom "category"
1191         ValuesFrom "value"
1192       </Result>
1193     </Query>
1194     <Database "product_information">
1195       Driver "mysql"
1196       DriverOption "host" "localhost"
1197       DriverOption "username" "collectd"
1198       DriverOption "password" "aZo6daiw"
1199       DriverOption "dbname" "prod_info"
1200       SelectDB "prod_info"
1201       Query "out_of_stock"
1202     </Database>
1203   </Plugin>
1205 The configuration above defines one query with one result and one database. The
1206 query is then linked to the database with the B<Query> option I<within> the
1207 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1208 and you can also use the B<Include> statement to split up the configuration
1209 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1210 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1211 top to bottom!
1213 The following is a complete list of options:
1215 =head3 B<Query> blocks
1217 Query blocks define I<SQL> statements and how the returned data should be
1218 interpreted. They are identified by the name that is given in the opening line
1219 of the block. Thus the name needs to be unique. Other than that, the name is
1220 not used in collectd.
1222 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1223 define which column holds which value or instance information. You can use
1224 multiple B<Result> blocks to create multiple values from one returned row. This
1225 is especially useful, when queries take a long time and sending almost the same
1226 query again and again is not desirable.
1228 Example:
1230   <Query "environment">
1231     Statement "select station, temperature, humidity from environment"
1232     <Result>
1233       Type "temperature"
1234       # InstancePrefix "foo"
1235       InstancesFrom "station"
1236       ValuesFrom "temperature"
1237     </Result>
1238     <Result>
1239       Type "humidity"
1240       InstancesFrom "station"
1241       ValuesFrom "humidity"
1242     </Result>
1243   </Query>
1245 The following options are accepted:
1247 =over 4
1249 =item B<Statement> I<SQL>
1251 Sets the statement that should be executed on the server. This is B<not>
1252 interpreted by collectd, but simply passed to the database server. Therefore,
1253 the SQL dialect that's used depends on the server collectd is connected to.
1255 The query has to return at least two columns, one for the instance and one
1256 value. You cannot omit the instance, even if the statement is guaranteed to
1257 always return exactly one line. In that case, you can usually specify something
1258 like this:
1260   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1262 (That works with MySQL but may not be valid SQL according to the spec. If you
1263 use a more strict database server, you may have to select from a dummy table or
1264 something.)
1266 Please note that some databases, for example B<Oracle>, will fail if you
1267 include a semicolon at the end of the statement.
1269 =item B<MinVersion> I<Version>
1271 =item B<MaxVersion> I<Value>
1273 Only use this query for the specified database version. You can use these
1274 options to provide multiple queries with the same name but with a slightly
1275 different syntax. The plugin will use only those queries, where the specified
1276 minimum and maximum versions fit the version of the database in use.
1278 The database version is determined by C<dbi_conn_get_engine_version>, see the
1279 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1280 for details. Basically, each part of the version is assumed to be in the range
1281 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1282 "40102", version "5.0.42" becomes "50042".
1284 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1285 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1286 happen. Don't to it! A valid example would be something along these lines:
1288   MinVersion 40000
1289   MaxVersion 49999
1290   ...
1291   MinVersion 50000
1292   MaxVersion 50099
1293   ...
1294   MinVersion 50100
1295   # No maximum
1297 In the above example, there are three ranges that don't overlap. The last one
1298 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1299 before "4.0.0" are not specified.
1301 =item B<Type> I<Type>
1303 The B<type> that's used for each line returned. See L<types.db(5)> for more
1304 details on how types are defined. In short: A type is a predefined layout of
1305 data and the number of values and type of values has to match the type
1306 definition.
1308 If you specify "temperature" here, you need exactly one gauge column. If you
1309 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1310 setting below.
1312 There must be exactly one B<Type> option inside each B<Result> block.
1314 =item B<InstancePrefix> I<prefix>
1316 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1317 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1318 all strings returned in the appropriate columns are concatenated together,
1319 separated by dashes I<("-")>.
1321 =item B<InstancesFrom> I<column0> [I<column1> ...]
1323 Specifies the columns whose values will be used to create the "type-instance"
1324 for each row. If you specify more than one column, the value of all columns
1325 will be joined together with dashes I<("-")> as separation characters.
1327 The plugin itself does not check whether or not all built instances are
1328 different. It's your responsibility to assure that each is unique. This is
1329 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1330 sure that only one row is returned in this case.
1332 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1333 will be empty.
1335 =item B<ValuesFrom> I<column0> [I<column1> ...]
1337 Names the columns whose content is used as the actual data for the data sets
1338 that are dispatched to the daemon. How many such columns you need is determined
1339 by the B<Type> setting above. If you specify too many or not enough columns,
1340 the plugin will complain about that and no data will be submitted to the
1341 daemon.
1343 The actual data type in the columns is not that important. The plugin will
1344 automatically cast the values to the right type if it know how to do that. So
1345 it should be able to handle integer an floating point types, as well as strings
1346 (if they include a number at the beginning).
1348 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1350 =back
1352 =head3 B<Database> blocks
1354 Database blocks define a connection to a database and which queries should be
1355 sent to that database. Since the used "dbi" library can handle a wide variety
1356 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1357 documentationE<nbsp>- we stick as close to the terminology used there.
1359 Each database needs a "name" as string argument in the starting tag of the
1360 block. This name will be used as "PluginInstance" in the values submitted to
1361 the daemon. Other than that, that name is not used.
1363 =over 4
1365 =item B<Driver> I<Driver>
1367 Specifies the driver to use to connect to the database. In many cases those
1368 drivers are named after the database they can connect to, but this is not a
1369 technical necessity. These drivers are sometimes referred to as "DBD",
1370 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1371 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1372 project at L<http://libdbi-drivers.sourceforge.net/>.
1374 You need to give the driver name as expected by the "dbi" library here. You
1375 should be able to find that in the documentation for each driver. If you
1376 mistype the driver name, the plugin will dump a list of all known driver names
1377 to the log.
1379 =item B<DriverOption> I<Key> I<Value>
1381 Sets driver-specific options. What option a driver supports can be found in the
1382 documentation for each driver, somewhere at
1383 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1384 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1386 DBDs can register two types of options: String options and numeric options. The
1387 plugin will use the C<dbi_conn_set_option> function when the configuration
1388 provides a string and the C<dbi_conn_require_option_numeric> function when the
1389 configuration provides a number. So these two lines will actually result in
1390 different calls being used:
1392   DriverOption "Port" 1234      # numeric
1393   DriverOption "Port" "1234"    # string
1395 Unfortunately, drivers are not too keen to report errors when an unknown option
1396 is passed to them, so invalid settings here may go unnoticed. This is not the
1397 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1398 the driver. If a driver complains about an option, the plugin will dump a
1399 complete list of all options understood by that driver to the log. There is no
1400 way to programatically find out if an option expects a string or a numeric
1401 argument, so you will have to refer to the appropriate DBD's documentation to
1402 find this out. Sorry.
1404 =item B<SelectDB> I<Database>
1406 In some cases, the database name you connect with is not the database name you
1407 want to use for querying data. If this option is set, the plugin will "select"
1408 (switch to) that database after the connection is established.
1410 =item B<Query> I<QueryName>
1412 Associates the query named I<QueryName> with this database connection. The
1413 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1414 blocks you want to refer to must be placed above the database block you want to
1415 refer to them from.
1417 =item B<Host> I<Hostname>
1419 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1420 values. Defaults to the global hostname setting.
1422 =back
1424 =head2 Plugin C<df>
1426 =over 4
1428 =item B<Device> I<Device>
1430 Select partitions based on the devicename.
1432 =item B<MountPoint> I<Directory>
1434 Select partitions based on the mountpoint.
1436 =item B<FSType> I<FSType>
1438 Select partitions based on the filesystem type.
1440 =item B<IgnoreSelected> B<true>|B<false>
1442 Invert the selection: If set to true, all partitions B<except> the ones that
1443 match any one of the criteria are collected. By default only selected
1444 partitions are collected if a selection is made. If no selection is configured
1445 at all, B<all> partitions are selected.
1447 =item B<ReportByDevice> B<true>|B<false>
1449 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1450 (the default), it will report a disk as "root", but with it I<true>, it will be
1451 "sda1" (or whichever).
1453 =item B<ReportInodes> B<true>|B<false>
1455 Enables or disables reporting of free, reserved and used inodes. Defaults to
1456 inode collection being disabled.
1458 Enable this option if inodes are a scarce resource for you, usually because
1459 many small files are stored on the disk. This is a usual scenario for mail
1460 transfer agents and web caches.
1462 =back
1464 =head2 Plugin C<disk>
1466 The C<disk> plugin collects information about the usage of physical disks and
1467 logical disks (partitions). Values collected are the number of octets written
1468 to and read from a disk or partition, the number of read/write operations
1469 issued to the disk and a rather complex "time" it took for these commands to be
1470 issued.
1472 Using the following two options you can ignore some disks or configure the
1473 collection only of specific disks.
1475 =over 4
1477 =item B<Disk> I<Name>
1479 Select the disk I<Name>. Whether it is collected or ignored depends on the
1480 B<IgnoreSelected> setting, see below. As with other plugins that use the
1481 daemon's ignorelist functionality, a string that starts and ends with a slash
1482 is interpreted as a regular expression. Examples:
1484   Disk "sdd"
1485   Disk "/hda[34]/"
1487 =item B<IgnoreSelected> B<true>|B<false>
1489 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1490 statements, are ignored or if all other disks are ignored. The behavior
1491 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1492 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1493 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1494 is set to B<true>, all disks are collected B<except> the ones matched.
1496 =back
1498 =head2 Plugin C<dns>
1500 =over 4
1502 =item B<Interface> I<Interface>
1504 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1505 option sets the interface that should be used. If this option is not set, or
1506 set to "any", the plugin will try to get packets from B<all> interfaces. This
1507 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1509 =item B<IgnoreSource> I<IP-address>
1511 Ignore packets that originate from this address.
1513 =item B<SelectNumericQueryTypes> B<true>|B<false>
1515 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1517 =back
1519 =head2 Plugin C<email>
1521 =over 4
1523 =item B<SocketFile> I<Path>
1525 Sets the socket-file which is to be created.
1527 =item B<SocketGroup> I<Group>
1529 If running as root change the group of the UNIX-socket after it has been
1530 created. Defaults to B<collectd>.
1532 =item B<SocketPerms> I<Permissions>
1534 Change the file permissions of the UNIX-socket after it has been created. The
1535 permissions must be given as a numeric, octal value as you would pass to
1536 L<chmod(1)>. Defaults to B<0770>.
1538 =item B<MaxConns> I<Number>
1540 Sets the maximum number of connections that can be handled in parallel. Since
1541 this many threads will be started immediately setting this to a very high
1542 value will waste valuable resources. Defaults to B<5> and will be forced to be
1543 at most B<16384> to prevent typos and dumb mistakes.
1545 =back
1547 =head2 Plugin C<ethstat>
1549 The I<ethstat plugin> collects information about network interface cards (NICs)
1550 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1552 B<Synopsis:>
1554  <Plugin "ethstat">
1555    Interface "eth0"
1556    Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1557    Map "multicast" "if_multicast"
1558  </Plugin>
1560 B<Options:>
1562 =over 4
1564 =item B<Interface> I<Name>
1566 Collect statistical information about interface I<Name>.
1568 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1570 By default, the plugin will submit values as type C<derive> and I<type
1571 instance> set to I<Name>, the name of the metric as reported by the driver. If
1572 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1573 I<TypeInstance> will be used.
1575 =item B<MappedOnly> B<true>|B<false>
1577 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1578 collected, all other metrics will be ignored. Defaults to B<false>.
1580 =back
1582 =head2 Plugin C<exec>
1584 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1585 contains valuable information on when the executable is executed and the
1586 output that is expected from it.
1588 =over 4
1590 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1592 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1594 Execute the executable I<Executable> as user I<User>. If the user name is
1595 followed by a colon and a group name, the effective group is set to that group.
1596 The real group and saved-set group will be set to the default group of that
1597 user. If no group is given the effective group ID will be the same as the real
1598 group ID.
1600 Please note that in order to change the user and/or group the daemon needs
1601 superuser privileges. If the daemon is run as an unprivileged user you must
1602 specify the same user/group here. If the daemon is run with superuser
1603 privileges, you must supply a non-root user here.
1605 The executable may be followed by optional arguments that are passed to the
1606 program. Please note that due to the configuration parsing numbers and boolean
1607 values may be changed. If you want to be absolutely sure that something is
1608 passed as-is please enclose it in quotes.
1610 The B<Exec> and B<NotificationExec> statements change the semantics of the
1611 programs executed, i.E<nbsp>e. the data passed to them and the response
1612 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1614 =back
1616 =head2 Plugin C<filecount>
1618 The C<filecount> plugin counts the number of files in a certain directory (and
1619 its subdirectories) and their combined size. The configuration is very straight
1620 forward:
1622   <Plugin "filecount">
1623     <Directory "/var/qmail/queue/mess">
1624       Instance "qmail-message"
1625     </Directory>
1626     <Directory "/var/qmail/queue/todo">
1627       Instance "qmail-todo"
1628     </Directory>
1629     <Directory "/var/lib/php5">
1630       Instance "php5-sessions"
1631       Name "sess_*"
1632     </Directory>
1633   </Plugin>
1635 The example above counts the number of files in QMail's queue directories and
1636 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1637 QMail has not yet looked at, the "message" queue holds the messages that were
1638 classified into "local" and "remote".
1640 As you can see, the configuration consists of one or more C<Directory> blocks,
1641 each of which specifies a directory in which to count the files. Within those
1642 blocks, the following options are recognized:
1644 =over 4
1646 =item B<Instance> I<Instance>
1648 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1649 it's your responsibility, the plugin doesn't check for that. If not given, the
1650 instance is set to the directory name with all slashes replaced by underscores
1651 and all leading underscores removed.
1653 =item B<Name> I<Pattern>
1655 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1656 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1657 against the pattern, not the entire path. In case this makes it easier for you:
1658 This option has been named after the B<-name> parameter to L<find(1)>.
1660 =item B<MTime> I<Age>
1662 Count only files of a specific age: If I<Age> is greater than zero, only files
1663 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1664 a negative number, this is inversed. For example, if B<-60> is specified, only
1665 files that have been modified in the last minute will be counted.
1667 The number can also be followed by a "multiplier" to easily specify a larger
1668 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1669 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1670 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1671 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1672 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1673 B<"12h">.
1675 =item B<Size> I<Size>
1677 Count only files of a specific size. When I<Size> is a positive number, only
1678 files that are at least this big are counted. If I<Size> is a negative number,
1679 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1680 I<Size> are counted.
1682 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1683 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1684 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1685 note that there are 1000 bytes in a kilobyte, not 1024.
1687 =item B<Recursive> I<true>|I<false>
1689 Controls whether or not to recurse into subdirectories. Enabled by default.
1691 =item B<IncludeHidden> I<true>|I<false>
1693 Controls whether or not to include "hidden" files and directories in the count.
1694 "Hidden" files and directories are those, whose name begins with a dot.
1695 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1697 =back
1699 =head2 Plugin C<GenericJMX>
1701 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1702 L<collectd-java(5)>.
1704 =head2 Plugin C<gmond>
1706 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1707 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1708 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1710 Synopsis:
1712  <Plugin "gmond">
1713    MCReceiveFrom "239.2.11.71" "8649"
1714    <Metric "swap_total">
1715      Type "swap"
1716      TypeInstance "total"
1717      DataSource "value"
1718    </Metric>
1719    <Metric "swap_free">
1720      Type "swap"
1721      TypeInstance "free"
1722      DataSource "value"
1723    </Metric>
1724  </Plugin>
1726 The following metrics are built-in:
1728 =over 4
1730 =item *
1732 load_one, load_five, load_fifteen
1734 =item *
1736 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1738 =item *
1740 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1742 =item *
1744 bytes_in, bytes_out
1746 =item *
1748 pkts_in, pkts_out
1750 =back
1752 Available configuration options:
1754 =over 4
1756 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1758 Sets sets the multicast group and UDP port to which to subscribe.
1760 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1762 =item E<lt>B<Metric> I<Name>E<gt>
1764 These blocks add a new metric conversion to the internal table. I<Name>, the
1765 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1767 =over 4
1769 =item B<Type> I<Type>
1771 Type to map this metric to. Required.
1773 =item B<TypeInstance> I<Instance>
1775 Type-instance to use. Optional.
1777 =item B<DataSource> I<Name>
1779 Data source to map this metric to. If the configured type has exactly one data
1780 source, this is optional. Otherwise the option is required.
1782 =back
1784 =back
1786 =head2 Plugin C<hddtemp>
1788 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1789 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1790 default values, see below. C<hddtemp> has to be running to work correctly. If
1791 C<hddtemp> is not running timeouts may appear which may interfere with other
1792 statistics..
1794 The B<hddtemp> homepage can be found at
1795 L<http://www.guzu.net/linux/hddtemp.php>.
1797 =over 4
1799 =item B<Host> I<Hostname>
1801 Hostname to connect to. Defaults to B<127.0.0.1>.
1803 =item B<Port> I<Port>
1805 TCP-Port to connect to. Defaults to B<7634>.
1807 =back
1809 =head2 Plugin C<interface>
1811 =over 4
1813 =item B<Interface> I<Interface>
1815 Select this interface. By default these interfaces will then be collected. For
1816 a more detailed description see B<IgnoreSelected> below.
1818 =item B<IgnoreSelected> I<true>|I<false>
1820 If no configuration if given, the B<traffic>-plugin will collect data from
1821 all interfaces. This may not be practical, especially for loopback- and
1822 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1823 interfaces you're interested in. Sometimes, however, it's easier/preferred
1824 to collect all interfaces I<except> a few ones. This option enables you to
1825 do that: By setting B<IgnoreSelected> to I<true> the effect of
1826 B<Interface> is inverted: All selected interfaces are ignored and all
1827 other interfaces are collected.
1829 =back
1831 =head2 Plugin C<ipmi>
1833 =over 4
1835 =item B<Sensor> I<Sensor>
1837 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1839 =item B<IgnoreSelected> I<true>|I<false>
1841 If no configuration if given, the B<ipmi> plugin will collect data from all
1842 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1843 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1844 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1845 all other sensors are collected.
1847 =item B<NotifySensorAdd> I<true>|I<false>
1849 If a sensor appears after initialization time of a minute a notification
1850 is sent.
1852 =item B<NotifySensorRemove> I<true>|I<false>
1854 If a sensor disappears a notification is sent.
1856 =item B<NotifySensorNotPresent> I<true>|I<false>
1858 If you have for example dual power supply and one of them is (un)plugged then
1859 a notification is sent.
1861 =back
1863 =head2 Plugin C<iptables>
1865 =over 4
1867 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1869 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1870 will collect the counters of all rules which have a comment-match. The comment
1871 is then used as type-instance.
1873 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1874 the I<n>th rule will be collected. Again, the comment (or the number) will be
1875 used as the type-instance.
1877 If I<Name> is supplied, it will be used as the type-instance instead of the
1878 comment or the number.
1880 =back
1882 =head2 Plugin C<irq>
1884 =over 4
1886 =item B<Irq> I<Irq>
1888 Select this irq. By default these irqs will then be collected. For a more
1889 detailed description see B<IgnoreSelected> below.
1891 =item B<IgnoreSelected> I<true>|I<false>
1893 If no configuration if given, the B<irq>-plugin will collect data from all
1894 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1895 can use the B<Irq>-option to pick the interrupt you're interested in.
1896 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1897 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1898 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1899 and all other interrupts are collected.
1901 =back
1903 =head2 Plugin C<java>
1905 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1906 This section only discusses the syntax and semantic of the configuration
1907 options. For more in-depth information on the I<Java> plugin, please read
1908 L<collectd-java(5)>.
1910 Synopsis:
1912  <Plugin "java">
1913    JVMArg "-verbose:jni"
1914    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1915    LoadPlugin "org.collectd.java.Foobar"
1916    <Plugin "org.collectd.java.Foobar">
1917      # To be parsed by the plugin
1918    </Plugin>
1919  </Plugin>
1921 Available configuration options:
1923 =over 4
1925 =item B<JVMArg> I<Argument>
1927 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1928 exactly the way the arguments to the I<java> binary on the command line work.
1929 Execute C<javaE<nbsp>--help> for details.
1931 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1932 any other options! When another option is found, the JVM will be started and
1933 later options will have to be ignored!
1935 =item B<LoadPlugin> I<JavaClass>
1937 Instantiates a new I<JavaClass> object. The constructor of this object very
1938 likely then registers one or more callback methods with the server.
1940 See L<collectd-java(5)> for details.
1942 When the first such option is found, the virtual machine (JVM) is created. This
1943 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
1944 B<LoadPlugin> options!
1946 =item B<Plugin> I<Name>
1948 The entire block is passed to the Java plugin as an
1949 I<org.collectd.api.OConfigItem> object.
1951 For this to work, the plugin has to register a configuration callback first,
1952 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
1953 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
1954 depends on the (Java) plugin registering the callback and is completely
1955 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
1957 =back
1959 =head2 Plugin C<libvirt>
1961 This plugin allows CPU, disk and network load to be collected for virtualized
1962 guests on the machine. This means that these characteristics can be collected
1963 for guest systems without installing any software on them - collectd only runs
1964 on the hosting system. The statistics are collected through libvirt
1965 (L<http://libvirt.org/>).
1967 Only I<Connection> is required.
1969 =over 4
1971 =item B<Connection> I<uri>
1973 Connect to the hypervisor given by I<uri>. For example if using Xen use:
1975  Connection "xen:///"
1977 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
1979 =item B<RefreshInterval> I<seconds>
1981 Refresh the list of domains and devices every I<seconds>. The default is 60
1982 seconds. Setting this to be the same or smaller than the I<Interval> will cause
1983 the list of domains and devices to be refreshed on every iteration.
1985 Refreshing the devices in particular is quite a costly operation, so if your
1986 virtualization setup is static you might consider increasing this. If this
1987 option is set to 0, refreshing is disabled completely.
1989 =item B<Domain> I<name>
1991 =item B<BlockDevice> I<name:dev>
1993 =item B<InterfaceDevice> I<name:dev>
1995 =item B<IgnoreSelected> I<true>|I<false>
1997 Select which domains and devices are collected.
1999 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2000 disk/network devices are collected.
2002 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2003 domains and disk/network devices are ignored, while the rest are collected.
2005 The domain name and device names may use a regular expression, if the name is
2006 surrounded by I</.../> and collectd was compiled with support for regexps.
2008 The default is to collect statistics for all domains and all their devices.
2010 Example:
2012  BlockDevice "/:hdb/"
2013  IgnoreSelected "true"
2015 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2016 will be collected.
2018 =item B<HostnameFormat> B<name|uuid|hostname|...>
2020 When the libvirt plugin logs data, it sets the hostname of the collected data
2021 according to this setting. The default is to use the guest name as provided by
2022 the hypervisor, which is equal to setting B<name>.
2024 B<uuid> means use the guest's UUID. This is useful if you want to track the
2025 same guest across migrations.
2027 B<hostname> means to use the global B<Hostname> setting, which is probably not
2028 useful on its own because all guests will appear to have the same name.
2030 You can also specify combinations of these fields. For example B<name uuid>
2031 means to concatenate the guest name and UUID (with a literal colon character
2032 between, thus I<"foo:1234-1234-1234-1234">).
2034 =item B<InterfaceFormat> B<name>|B<address>
2036 When the libvirt plugin logs interface data, it sets the name of the collected
2037 data according to this setting. The default is to use the path as provided by
2038 the hypervisor (the "dev" property of the target node), which is equal to
2039 setting B<name>.
2041 B<address> means use the interface's mac address. This is useful since the
2042 interface path might change between reboots of a guest or across migrations.
2044 =back
2046 =head2 Plugin C<logfile>
2048 =over 4
2050 =item B<LogLevel> B<debug|info|notice|warning|err>
2052 Sets the log-level. If, for example, set to B<notice>, then all events with
2053 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2055 Please note that B<debug> is only available if collectd has been compiled with
2056 debugging support.
2058 =item B<File> I<File>
2060 Sets the file to write log messages to. The special strings B<stdout> and
2061 B<stderr> can be used to write to the standard output and standard error
2062 channels, respectively. This, of course, only makes much sense when I<collectd>
2063 is running in foreground- or non-daemon-mode.
2065 =item B<Timestamp> B<true>|B<false>
2067 Prefix all lines printed by the current time. Defaults to B<true>.
2069 =item B<PrintSeverity> B<true>|B<false>
2071 When enabled, all lines are prefixed by the severity of the log message, for
2072 example "warning". Defaults to B<false>.
2074 =back
2076 B<Note>: There is no need to notify the daemon after moving or removing the
2077 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2078 for each line it writes.
2080 =head2 Plugin C<lpar>
2082 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2083 virtualization technique for IBM POWER processors. It takes into account CPU
2084 time stolen from or donated to a partition, in addition to the usual user,
2085 system, I/O statistics.
2087 The following configuration options are available:
2089 =over 4
2091 =item B<CpuPoolStats> B<false>|B<true>
2093 When enabled, statistics about the processor pool are read, too. The partition
2094 needs to have pool authority in order to be able to acquire this information.
2095 Defaults to false.
2097 =item B<ReportBySerial> B<false>|B<true>
2099 If enabled, the serial of the physical machine the partition is currently
2100 running on is reported as I<hostname> and the logical hostname of the machine
2101 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2102 used (just like other plugins) and the I<plugin instance> will be empty.
2103 Defaults to false.
2105 =back
2107 =head2 Plugin C<mbmon>
2109 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2111 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2112 B<Host> and B<Port> options can be used to change these values, see below.
2113 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2114 timeouts may appear which may interfere with other statistics..
2116 C<mbmon> must be run with the -r option ("print TAG and Value format");
2117 Debian's F</etc/init.d/mbmon> script already does this, other people
2118 will need to ensure that this is the case.
2120 =over 4
2122 =item B<Host> I<Hostname>
2124 Hostname to connect to. Defaults to B<127.0.0.1>.
2126 =item B<Port> I<Port>
2128 TCP-Port to connect to. Defaults to B<411>.
2130 =back
2132 =head2 Plugin C<md>
2134 The C<md plugin> collects information from Linux Software-RAID devices (md).
2136 All reported values are of the type C<md_disks>. Reported type instances are
2137 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2138 I<missing> (physically absent) disks.
2140 =over 4
2142 =item B<Device> I<Device>
2144 Select md devices based on device name. The I<device name> is the basename of
2145 the device, i.e. the name of the block device without the leading C</dev/>.
2146 See B<IgnoreSelected> for more details.
2148 =item B<IgnoreSelected> B<true>|B<false>
2150 Invert device selection: If set to B<true>, all md devices B<except> those
2151 listed using B<Device> are collected. If B<false> (the default), only those
2152 listed are collected. If no configuration is given, the B<md> plugin will
2153 collect data from all md devices.
2155 =back
2157 =head2 Plugin C<memcachec>
2159 The C<memcachec plugin> connects to a memcached server, queries one or more
2160 given I<pages> and parses the returned data according to user specification.
2161 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2162 plugins.
2164 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2165 library. Please note that there is another library with a very similar name,
2166 libmemcache (notice the missing `d'), which is not applicable.
2168 Synopsis of the configuration:
2170  <Plugin "memcachec">
2171    <Page "plugin_instance">
2172      Server "localhost"
2173      Key "page_key"
2174      <Match>
2175        Regex "(\\d+) bytes sent"
2176        DSType CounterAdd
2177        Type "ipt_octets"
2178        Instance "type_instance"
2179      </Match>
2180    </Page>
2181  </Plugin>
2183 The configuration options are:
2185 =over 4
2187 =item E<lt>B<Page> I<Name>E<gt>
2189 Each B<Page> block defines one I<page> to be queried from the memcached server.
2190 The block requires one string argument which is used as I<plugin instance>.
2192 =item B<Server> I<Address>
2194 Sets the server address to connect to when querying the page. Must be inside a
2195 B<Page> block.
2197 =item B<Key> I<Key>
2199 When connected to the memcached server, asks for the page I<Key>.
2201 =item E<lt>B<Match>E<gt>
2203 Match blocks define which strings to look for and how matches substrings are
2204 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2206 =back
2208 =head2 Plugin C<memcached>
2210 The C<memcached plugin> connects to a memcached server and queries statistics
2211 about cache utilization, memory and bandwidth used.
2212 L<http://www.danga.com/memcached/>
2214  <Plugin "memcached">
2215    <Instance "name">
2216      Host "memcache.example.com"
2217      Port 11211
2218    </Instance>
2219  </Plugin>
2221 The plugin configuration consists of one or more B<Instance> blocks which
2222 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2223 following options are allowed:
2225 =over 4
2227 =item B<Host> I<Hostname>
2229 Hostname to connect to. Defaults to B<127.0.0.1>.
2231 =item B<Port> I<Port>
2233 TCP-Port to connect to. Defaults to B<11211>.
2235 =item B<Socket> I<Path>
2237 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2238 setting is given, the B<Host> and B<Port> settings are ignored.
2240 =back
2242 =head2 Plugin C<modbus>
2244 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2245 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2246 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2247 values (two registers interpreted as IEEE floats in big endian notation).
2249 Synopsis:
2251  <Data "voltage-input-1">
2252    RegisterBase 0
2253    RegisterType float
2254    Type voltage
2255    Instance "input-1"
2256  </Data>
2257  
2258  <Data "voltage-input-2">
2259    RegisterBase 2
2260    RegisterType float
2261    Type voltage
2262    Instance "input-2"
2263  </Data>
2264  
2265  <Host "modbus.example.com">
2266    Address "192.168.0.42"
2267    Port    "502"
2268    Interval 60
2269    
2270    <Slave 1>
2271      Instance "power-supply"
2272      Collect  "voltage-input-1"
2273      Collect  "voltage-input-2"
2274    </Slave>
2275  </Host>
2277 =over 4
2279 =item E<lt>B<Data> I<Name>E<gt> blocks
2281 Data blocks define a mapping between register numbers and the "types" used by
2282 I<collectd>.
2284 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2286 =over 4
2288 =item B<RegisterBase> I<Number>
2290 Configures the base register to read from the device. If the option
2291 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2292 register will be read (the register number is increased by one).
2294 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2296 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2297 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2298 combined into one value. Defaults to B<Uint16>.
2300 =item B<Type> I<Type>
2302 Specifies the "type" (data set) to use when dispatching the value to
2303 I<collectd>. Currently, only data sets with exactly one data source are
2304 supported.
2306 =item B<Instance> I<Instance>
2308 Sets the type instance to use when dispatching the value to I<collectd>. If
2309 unset, an empty string (no type instance) is used.
2311 =back
2313 =item E<lt>B<Host> I<Name>E<gt> blocks
2315 Host blocks are used to specify to which hosts to connect and what data to read
2316 from their "slaves". The string argument I<Name> is used as hostname when
2317 dispatching the values to I<collectd>.
2319 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2321 =over 4
2323 =item B<Address> I<Hostname>
2325 Specifies the node name (the actual network address) used to connect to the
2326 host. This may be an IP address or a hostname. Please note that the used
2327 I<libmodbus> library only supports IPv4 at the moment.
2329 =item B<Port> I<Service>
2331 Specifies the port used to connect to the host. The port can either be given as
2332 a number or as a service name. Please note that the I<Service> argument must be
2333 a string, even if ports are given in their numerical form. Defaults to "502".
2335 =item B<Interval> I<Interval>
2337 Sets the interval (in seconds) in which the values will be collected from this
2338 host. By default the global B<Interval> setting will be used.
2340 =item E<lt>B<Slave> I<ID>E<gt>
2342 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2343 is used to specify which device should be addressed. For each device you want
2344 to query, one B<Slave> block must be given.
2346 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2348 =over 4
2350 =item B<Instance> I<Instance>
2352 Specify the plugin instance to use when dispatching the values to I<collectd>.
2353 By default "slave_I<ID>" is used.
2355 =item B<Collect> I<DataName>
2357 Specifies which data to retrieve from the device. I<DataName> must be the same
2358 string as the I<Name> argument passed to a B<Data> block. You can specify this
2359 option multiple times to collect more than one value from a slave. At least one
2360 B<Collect> option is mandatory.
2362 =back
2364 =back
2366 =back
2368 =head2 Plugin C<mysql>
2370 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2371 one or more databases when started and keeps the connection up as long as
2372 possible. When the connection is interrupted for whatever reason it will try
2373 to re-connect. The plugin will complain loudly in case anything goes wrong.
2375 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2376 and collects information about MySQL network traffic, executed statements,
2377 requests, the query cache and threads by evaluating the
2378 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2379 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2380 Status Variables> for an explanation of these values.
2382 Optionally, master and slave statistics may be collected in a MySQL
2383 replication setup. In that case, information about the synchronization state
2384 of the nodes are collected by evaluating the C<Position> return value of the
2385 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2386 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2387 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2388 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2389 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2391 Synopsis:
2393   <Plugin mysql>
2394     <Database foo>
2395       Host "hostname"
2396       User "username"
2397       Password "password"
2398       Port "3306"
2399       MasterStats true
2400     </Database>
2402     <Database bar>
2403       Host "localhost"
2404       Socket "/var/run/mysql/mysqld.sock"
2405       SlaveStats true
2406       SlaveNotifications true
2407     </Database>
2408   </Plugin>
2410 A B<Database> block defines one connection to a MySQL database. It accepts a
2411 single argument which specifies the name of the database. None of the other
2412 options are required. MySQL will use default values as documented in the
2413 section "mysql_real_connect()" in the B<MySQL reference manual>.
2415 =over 4
2417 =item B<Host> I<Hostname>
2419 Hostname of the database server. Defaults to B<localhost>.
2421 =item B<User> I<Username>
2423 Username to use when connecting to the database. The user does not have to be
2424 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2425 unless you want to collectd replication statistics (see B<MasterStats> and
2426 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2427 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2429 =item B<Password> I<Password>
2431 Password needed to log into the database.
2433 =item B<Database> I<Database>
2435 Select this database. Defaults to I<no database> which is a perfectly reasonable
2436 option for what this plugin does.
2438 =item B<Port> I<Port>
2440 TCP-port to connect to. The port must be specified in its numeric form, but it
2441 must be passed as a string nonetheless. For example:
2443   Port "3306"
2445 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2446 See the documentation for the C<mysql_real_connect> function for details.
2448 =item B<Socket> I<Socket>
2450 Specifies the path to the UNIX domain socket of the MySQL server. This option
2451 only has any effect, if B<Host> is set to B<localhost> (the default).
2452 Otherwise, use the B<Port> option above. See the documentation for the
2453 C<mysql_real_connect> function for details.
2455 =item B<MasterStats> I<true|false>
2457 =item B<SlaveStats> I<true|false>
2459 Enable the collection of master / slave statistics in a replication setup. In
2460 order to be able to get access to these statistics, the user needs special
2461 privileges. See the B<User> documentation above.
2463 =item B<SlaveNotifications> I<true|false>
2465 If enabled, the plugin sends a notification if the replication slave I/O and /
2466 or SQL threads are not running.
2468 =back
2470 =head2 Plugin C<netapp>
2472 The netapp plugin can collect various performance and capacity information
2473 from a NetApp filer using the NetApp API.
2475 Please note that NetApp has a wide line of products and a lot of different
2476 software versions for each of these products. This plugin was developed for a
2477 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2478 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2479 model and software version but it is very hard to test this.
2480 If you have used this plugin with other models and/or software version, feel
2481 free to send us a mail to tell us about the results, even if it's just a short
2482 "It works".
2484 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2485 basic authentication.
2487 B<Do not use a regular user for this!> Create a special collectd user with just
2488 the minimum of capabilities needed. The user only needs the "login-http-admin"
2489 capability as well as a few more depending on which data will be collected.
2490 Required capabilities are documented below.
2492 =head3 Synopsis
2494  <Plugin "netapp">
2495    <Host "netapp1.example.com">
2496     Protocol      "https"
2497     Address       "10.0.0.1"
2498     Port          443
2499     User          "username"
2500     Password      "aef4Aebe"
2501     Interval      30
2502     
2503     <WAFL>
2504       Interval 30
2505       GetNameCache   true
2506       GetDirCache    true
2507       GetBufferCache true
2508       GetInodeCache  true
2509     </WAFL>
2510     
2511     <Disks>
2512       Interval 30
2513       GetBusy true
2514     </Disks>
2515     
2516     <VolumePerf>
2517       Interval 30
2518       GetIO      "volume0"
2519       IgnoreSelectedIO      false
2520       GetOps     "volume0"
2521       IgnoreSelectedOps     false
2522       GetLatency "volume0"
2523       IgnoreSelectedLatency false
2524     </VolumePerf>
2525     
2526     <VolumeUsage>
2527       Interval 30
2528       GetCapacity "vol0"
2529       GetCapacity "vol1"
2530       IgnoreSelectedCapacity false
2531       GetSnapshot "vol1"
2532       GetSnapshot "vol3"
2533       IgnoreSelectedSnapshot false
2534     </VolumeUsage>
2535     
2536     <Quota>
2537       Interval 60
2538     </Quota>
2539     
2540     <Snapvault>
2541       Interval 30
2542     </Snapvault>
2543     
2544     <System>
2545       Interval 30
2546       GetCPULoad     true
2547       GetInterfaces  true
2548       GetDiskOps     true
2549       GetDiskIO      true
2550     </System>
2552     <VFiler vfilerA>
2553       Interval 60
2555       SnapVault true
2556       # ...
2557     </VFiler>
2558    </Host>
2559  </Plugin>
2561 The netapp plugin accepts the following configuration options:
2563 =over 4
2565 =item B<Host> I<Name>
2567 A host block defines one NetApp filer. It will appear in collectd with the name
2568 you specify here which does not have to be its real name nor its hostname (see
2569 the B<Address> option below).
2571 =item B<VFiler> I<Name>
2573 A B<VFiler> block may only be used inside a host block. It accepts all the
2574 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2575 will execute all NetApp API commands in the context of the specified
2576 VFiler(R). It will appear in collectd with the name you specify here which
2577 does not have to be its real name. The VFiler name may be specified using the
2578 B<VFilerName> option. If this is not specified, it will default to the name
2579 you specify here.
2581 The VFiler block inherits all connection related settings from the surrounding
2582 B<Host> block (which appear before the B<VFiler> block) but they may be
2583 overwritten inside the B<VFiler> block.
2585 This feature is useful, for example, when using a VFiler as SnapVault target
2586 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2587 available in the host filer (vfiler0) but only in the respective VFiler
2588 context.
2590 =item B<Protocol> B<httpd>|B<http>
2592 The protocol collectd will use to query this host.
2594 Optional
2596 Type: string
2598 Default: https
2600 Valid options: http, https
2602 =item B<Address> I<Address>
2604 The hostname or IP address of the host.
2606 Optional
2608 Type: string
2610 Default: The "host" block's name.
2612 =item B<Port> I<Port>
2614 The TCP port to connect to on the host.
2616 Optional
2618 Type: integer
2620 Default: 80 for protocol "http", 443 for protocol "https"
2622 =item B<User> I<User>
2624 =item B<Password> I<Password>
2626 The username and password to use to login to the NetApp.
2628 Mandatory
2630 Type: string
2632 =item B<VFilerName> I<Name>
2634 The name of the VFiler in which context to execute API commands. If not
2635 specified, the name provided to the B<VFiler> block will be used instead.
2637 Optional
2639 Type: string
2641 Default: name of the B<VFiler> block
2643 B<Note:> This option may only be used inside B<VFiler> blocks.
2645 =item B<Interval> I<Interval>
2647 B<TODO>
2649 =back
2651 The following options decide what kind of data will be collected. You can
2652 either use them as a block and fine tune various parameters inside this block,
2653 use them as a single statement to just accept all default values, or omit it to
2654 not collect any data.
2656 The following options are valid inside all blocks:
2658 =over 4
2660 =item B<Interval> I<Seconds>
2662 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2663 host specific setting.
2665 =back
2667 =head3 The System block
2669 This will collect various performance data about the whole system.
2671 B<Note:> To get this data the collectd user needs the
2672 "api-perf-object-get-instances" capability.
2674 =over 4
2676 =item B<Interval> I<Seconds>
2678 Collect disk statistics every I<Seconds> seconds.
2680 =item B<GetCPULoad> B<true>|B<false>
2682 If you set this option to true the current CPU usage will be read. This will be
2683 the average usage between all CPUs in your NetApp without any information about
2684 individual CPUs.
2686 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2687 returns in the "CPU" field.
2689 Optional
2691 Type: boolean
2693 Default: true
2695 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2697 =item B<GetInterfaces> B<true>|B<false>
2699 If you set this option to true the current traffic of the network interfaces
2700 will be read. This will be the total traffic over all interfaces of your NetApp
2701 without any information about individual interfaces.
2703 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2704 in the "Net kB/s" field.
2706 B<Or is it?>
2708 Optional
2710 Type: boolean
2712 Default: true
2714 Result: One value list of type "if_octects".
2716 =item B<GetDiskIO> B<true>|B<false>
2718 If you set this option to true the current IO throughput will be read. This
2719 will be the total IO of your NetApp without any information about individual
2720 disks, volumes or aggregates.
2722 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2723 in the "DiskE<nbsp>kB/s" field.
2725 Optional
2727 Type: boolean
2729 Default: true
2731 Result: One value list of type "disk_octets".
2733 =item B<GetDiskOps> B<true>|B<false>
2735 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2736 iSCSI, etc. operations will be read. This will be the total number of
2737 operations on your NetApp without any information about individual volumes or
2738 aggregates.
2740 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2741 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2743 Optional
2745 Type: boolean
2747 Default: true
2749 Result: A variable number of value lists of type "disk_ops_complex". Each type
2750 of operation will result in one value list with the name of the operation as
2751 type instance.
2753 =back
2755 =head3 The WAFL block
2757 This will collect various performance data about the WAFL file system. At the
2758 moment this just means cache performance.
2760 B<Note:> To get this data the collectd user needs the
2761 "api-perf-object-get-instances" capability.
2763 B<Note:> The interface to get these values is classified as "Diagnostics" by
2764 NetApp. This means that it is not guaranteed to be stable even between minor
2765 releases.
2767 =over 4
2769 =item B<Interval> I<Seconds>
2771 Collect disk statistics every I<Seconds> seconds.
2773 =item B<GetNameCache> B<true>|B<false>
2775 Optional
2777 Type: boolean
2779 Default: true
2781 Result: One value list of type "cache_ratio" and type instance
2782 "name_cache_hit".
2784 =item B<GetDirCache> B<true>|B<false>
2786 Optional
2788 Type: boolean
2790 Default: true
2792 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
2794 =item B<GetInodeCache> B<true>|B<false>
2796 Optional
2798 Type: boolean
2800 Default: true
2802 Result: One value list of type "cache_ratio" and type instance
2803 "inode_cache_hit".
2805 =item B<GetBufferCache> B<true>|B<false>
2807 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
2808 in the "Cache hit" field.
2810 Optional
2812 Type: boolean
2814 Default: true
2816 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
2818 =back
2820 =head3 The Disks block
2822 This will collect performance data about the individual disks in the NetApp.
2824 B<Note:> To get this data the collectd user needs the
2825 "api-perf-object-get-instances" capability.
2827 =over 4
2829 =item B<Interval> I<Seconds>
2831 Collect disk statistics every I<Seconds> seconds.
2833 =item B<GetBusy> B<true>|B<false>
2835 If you set this option to true the busy time of all disks will be calculated
2836 and the value of the busiest disk in the system will be written.
2838 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2839 in the "Disk util" field. Probably.
2841 Optional
2843 Type: boolean
2845 Default: true
2847 Result: One value list of type "percent" and type instance "disk_busy".
2849 =back
2851 =head3 The VolumePerf block
2853 This will collect various performance data about the individual volumes.
2855 You can select which data to collect about which volume using the following
2856 options. They follow the standard ignorelist semantic.
2858 B<Note:> To get this data the collectd user needs the
2859 I<api-perf-object-get-instances> capability.
2861 =over 4
2863 =item B<Interval> I<Seconds>
2865 Collect volume performance data every I<Seconds> seconds.
2867 =item B<GetIO> I<Volume>
2869 =item B<GetOps> I<Volume>
2871 =item B<GetLatency> I<Volume>
2873 Select the given volume for IO, operations or latency statistics collection.
2874 The argument is the name of the volume without the C</vol/> prefix.
2876 Since the standard ignorelist functionality is used here, you can use a string
2877 starting and ending with a slash to specify regular expression matching: To
2878 match the volumes "vol0", "vol2" and "vol7", you can use this regular
2879 expression:
2881   GetIO "/^vol[027]$/"
2883 If no regular expression is specified, an exact match is required. Both,
2884 regular and exact matching are case sensitive.
2886 If no volume was specified at all for either of the three options, that data
2887 will be collected for all available volumes.
2889 =item B<IgnoreSelectedIO> B<true>|B<false>
2891 =item B<IgnoreSelectedOps> B<true>|B<false>
2893 =item B<IgnoreSelectedLatency> B<true>|B<false>
2895 When set to B<true>, the volumes selected for IO, operations or latency
2896 statistics collection will be ignored and the data will be collected for all
2897 other volumes.
2899 When set to B<false>, data will only be collected for the specified volumes and
2900 all other volumes will be ignored.
2902 If no volumes have been specified with the above B<Get*> options, all volumes
2903 will be collected regardless of the B<IgnoreSelected*> option.
2905 Defaults to B<false>
2907 =back
2909 =head3 The VolumeUsage block
2911 This will collect capacity data about the individual volumes.
2913 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
2914 capability.
2916 =over 4
2918 =item B<Interval> I<Seconds>
2920 Collect volume usage statistics every I<Seconds> seconds.
2922 =item B<GetCapacity> I<VolumeName>
2924 The current capacity of the volume will be collected. This will result in two
2925 to four value lists, depending on the configuration of the volume. All data
2926 sources are of type "df_complex" with the name of the volume as
2927 plugin_instance.
2929 There will be type_instances "used" and "free" for the number of used and
2930 available bytes on the volume.  If the volume has some space reserved for
2931 snapshots, a type_instance "snap_reserved" will be available.  If the volume
2932 has SIS enabled, a type_instance "sis_saved" will be available. This is the
2933 number of bytes saved by the SIS feature.
2935 B<Note:> The current NetApp API has a bug that results in this value being
2936 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
2937 number which works most of the time.  If you see strange values here, bug
2938 NetApp support to fix this.
2940 Repeat this option to specify multiple volumes.
2942 =item B<IgnoreSelectedCapacity> B<true>|B<false>
2944 Specify whether to collect only the volumes selected by the B<GetCapacity>
2945 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
2946 B<false>. However, if no B<GetCapacity> option is specified at all, all
2947 capacities will be selected anyway.
2949 =item B<GetSnapshot> I<VolumeName>
2951 Select volumes from which to collect snapshot information.
2953 Usually, the space used for snapshots is included in the space reported as
2954 "used". If snapshot information is collected as well, the space used for
2955 snapshots is subtracted from the used space.
2957 To make things even more interesting, it is possible to reserve space to be
2958 used for snapshots. If the space required for snapshots is less than that
2959 reserved space, there is "reserved free" and "reserved used" space in addition
2960 to "free" and "used". If the space required for snapshots exceeds the reserved
2961 space, that part allocated in the normal space is subtracted from the "used"
2962 space again.
2964 Repeat this option to specify multiple volumes.
2966 =item B<IgnoreSelectedSnapshot>
2968 Specify whether to collect only the volumes selected by the B<GetSnapshot>
2969 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
2970 B<false>. However, if no B<GetSnapshot> option is specified at all, all
2971 capacities will be selected anyway.
2973 =back
2975 =head3 The Quota block
2977 This will collect (tree) quota statistics (used disk space and number of used
2978 files). This mechanism is useful to get usage information for single qtrees.
2979 In case the quotas are not used for any other purpose, an entry similar to the
2980 following in C</etc/quotas> would be sufficient:
2982   /vol/volA/some_qtree tree - - - - -
2984 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
2986 =over 4
2988 =item B<Interval> I<Seconds>
2990 Collect SnapVault(R) statistics every I<Seconds> seconds.
2992 =back
2994 =head3 The SnapVault block
2996 This will collect statistics about the time and traffic of SnapVault(R)
2997 transfers.
2999 =over 4
3001 =item B<Interval> I<Seconds>
3003 Collect SnapVault(R) statistics every I<Seconds> seconds.
3005 =back
3007 =head2 Plugin C<netlink>
3009 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3010 statistics of various interface and routing aspects.
3012 =over 4
3014 =item B<Interface> I<Interface>
3016 =item B<VerboseInterface> I<Interface>
3018 Instruct the plugin to collect interface statistics. This is basically the same
3019 as the statistics provided by the C<interface> plugin (see above) but
3020 potentially much more detailed.
3022 When configuring with B<Interface> only the basic statistics will be collected,
3023 namely octets, packets, and errors. These statistics are collected by
3024 the C<interface> plugin, too, so using both at the same time is no benefit.
3026 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3027 so that no data needs to be collected twice if you use the C<interface> plugin.
3028 This includes dropped packets, received multicast packets, collisions and a
3029 whole zoo of differentiated RX and TX errors. You can try the following command
3030 to get an idea of what awaits you:
3032   ip -s -s link list
3034 If I<Interface> is B<All>, all interfaces will be selected.
3036 =item B<QDisc> I<Interface> [I<QDisc>]
3038 =item B<Class> I<Interface> [I<Class>]
3040 =item B<Filter> I<Interface> [I<Filter>]
3042 Collect the octets and packets that pass a certain qdisc, class or filter.
3044 QDiscs and classes are identified by their type and handle (or classid).
3045 Filters don't necessarily have a handle, therefore the parent's handle is used.
3046 The notation used in collectd differs from that used in tc(1) in that it
3047 doesn't skip the major or minor number if it's zero and doesn't print special
3048 ids by their name. So, for example, a qdisc may be identified by
3049 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3050 thus not displayed by tc(1).
3052 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3053 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3054 associated with that interface will be collected.
3056 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3057 used. This may lead to problems when more than one filter is attached to a
3058 qdisc or class. This isn't nice, but we don't know how this could be done any
3059 better. If you have a idea, please don't hesitate to tell us.
3061 As with the B<Interface> option you can specify B<All> as the interface,
3062 meaning all interfaces.
3064 Here are some examples to help you understand the above text more easily:
3066   <Plugin netlink>
3067     VerboseInterface "All"
3068     QDisc "eth0" "pfifo_fast-1:0"
3069     QDisc "ppp0"
3070     Class "ppp0" "htb-1:10"
3071     Filter "ppp0" "u32-1:0"
3072   </Plugin>
3074 =item B<IgnoreSelected>
3076 The behavior is the same as with all other similar plugins: If nothing is
3077 selected at all, everything is collected. If some things are selected using the
3078 options described above, only these statistics are collected. If you set
3079 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3080 specified statistics will not be collected.
3082 =back
3084 =head2 Plugin C<network>
3086 The Network plugin sends data to a remote instance of collectd, receives data
3087 from a remote instance, or both at the same time. Data which has been received
3088 from the network is usually not transmitted again, but this can be activated, see
3089 the B<Forward> option below.
3091 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3092 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3094 Both, B<Server> and B<Listen> can be used as single option or as block. When
3095 used as block, given options are valid for this socket only. The following
3096 example will export the metrics twice: Once to an "internal" server (without
3097 encryption and signing) and one to an external server (with cryptographic
3098 signature):
3100  <Plugin "network">
3101    # Export to an internal server
3102    # (demonstrates usage without additional options)
3103    Server "collectd.internal.tld"
3104    
3105    # Export to an external server
3106    # (demonstrates usage with signature options)
3107    <Server "collectd.external.tld">
3108      SecurityLevel "sign"
3109      Username "myhostname"
3110      Password "ohl0eQue"
3111    </Server>
3112  </Plugin>
3114 =over 4
3116 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3118 The B<Server> statement/block sets the server to send datagrams to. The
3119 statement may occur multiple times to send each datagram to multiple
3120 destinations.
3122 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3123 optional second argument specifies a port number or a service name. If not
3124 given, the default, B<25826>, is used.
3126 The following options are recognized within B<Server> blocks:
3128 =over 4
3130 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3132 Set the security you require for network communication. When the security level
3133 has been set to B<Encrypt>, data sent over the network will be encrypted using
3134 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3135 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3136 authentication code. When set to B<None>, data is sent without any security.
3138 This feature is only available if the I<network> plugin was linked with
3139 I<libgcrypt>.
3141 =item B<Username> I<Username>
3143 Sets the username to transmit. This is used by the server to lookup the
3144 password. See B<AuthFile> below. All security levels except B<None> require
3145 this setting.
3147 This feature is only available if the I<network> plugin was linked with
3148 I<libgcrypt>.
3150 =item B<Password> I<Password>
3152 Sets a password (shared secret) for this socket. All security levels except
3153 B<None> require this setting.
3155 This feature is only available if the I<network> plugin was linked with
3156 I<libgcrypt>.
3158 =item B<Interface> I<Interface name>
3160 Set the outgoing interface for IP packets. This applies at least
3161 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3162 undefined or a non-existent interface name is specified, the default
3163 behavior is to let the kernel choose the appropriate interface. Be warned
3164 that the manual selection of an interface for unicast traffic is only
3165 necessary in rare cases.
3167 =back
3169 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3171 The B<Listen> statement sets the interfaces to bind to. When multiple
3172 statements are found the daemon will bind to multiple interfaces.
3174 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3175 the argument is a multicast address the daemon will join that multicast group.
3176 The optional second argument specifies a port number or a service name. If not
3177 given, the default, B<25826>, is used.
3179 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3181 =over 4
3183 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3185 Set the security you require for network communication. When the security level
3186 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3187 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3188 signed and encrypted data is accepted. When set to B<None>, all data will be
3189 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3190 decrypted if possible.
3192 This feature is only available if the I<network> plugin was linked with
3193 I<libgcrypt>.
3195 =item B<AuthFile> I<Filename>
3197 Sets a file in which usernames are mapped to passwords. These passwords are
3198 used to verify signatures and to decrypt encrypted network packets. If
3199 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3200 verified and encrypted packets are decrypted. Otherwise, signed data is
3201 accepted without checking the signature and encrypted data cannot be decrypted.
3202 For the other security levels this option is mandatory.
3204 The file format is very simple: Each line consists of a username followed by a
3205 colon and any number of spaces followed by the password. To demonstrate, an
3206 example file could look like this:
3208   user0: foo
3209   user1: bar
3211 Each time a packet is received, the modification time of the file is checked
3212 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3213 the file is being read, it is locked using L<fcntl(2)>.
3215 =item B<Interface> I<Interface name>
3217 Set the incoming interface for IP packets explicitly. This applies at least
3218 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3219 undefined or a non-existent interface name is specified, the default
3220 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3221 traffic gets only accepted, if it arrives on the given interface.
3223 =back
3225 =item B<TimeToLive> I<1-255>
3227 Set the time-to-live of sent packets. This applies to all, unicast and
3228 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3229 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3230 operating systems.
3232 =item B<MaxPacketSize> I<1024-65535>
3234 Set the maximum size for datagrams received over the network. Packets larger
3235 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3236 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3237 UDP.
3239 On the server side, this limit should be set to the largest value used on
3240 I<any> client. Likewise, the value on the client must not be larger than the
3241 value on the server, or data will be lost.
3243 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3244 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3245 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3246 server.
3248 =item B<Forward> I<true|false>
3250 If set to I<true>, write packets that were received via the network plugin to
3251 the sending sockets. This should only be activated when the B<Listen>- and
3252 B<Server>-statements differ. Otherwise packets may be send multiple times to
3253 the same multicast group. While this results in more network traffic than
3254 necessary it's not a huge problem since the plugin has a duplicate detection,
3255 so the values will not loop.
3257 =item B<ReportStats> B<true>|B<false>
3259 The network plugin cannot only receive and send statistics, it can also create
3260 statistics about itself. Collected data included the number of received and
3261 sent octets and packets, the length of the receive queue and the number of
3262 values handled. When set to B<true>, the I<Network plugin> will make these
3263 statistics available. Defaults to B<false>.
3265 =back
3267 =head2 Plugin C<nginx>
3269 This plugin collects the number of connections and requests handled by the
3270 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3271 queries the page provided by the C<ngx_http_stub_status_module> module, which
3272 isn't compiled by default. Please refer to
3273 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3274 how to compile and configure nginx and this module.
3276 The following options are accepted by the C<nginx plugin>:
3278 =over 4
3280 =item B<URL> I<http://host/nginx_status>
3282 Sets the URL of the C<ngx_http_stub_status_module> output.
3284 =item B<User> I<Username>
3286 Optional user name needed for authentication.
3288 =item B<Password> I<Password>
3290 Optional password needed for authentication.
3292 =item B<VerifyPeer> B<true|false>
3294 Enable or disable peer SSL certificate verification. See
3295 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3297 =item B<VerifyHost> B<true|false>
3299 Enable or disable peer host name verification. If enabled, the plugin checks
3300 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3301 certificate matches the host name provided by the B<URL> option. If this
3302 identity check fails, the connection is aborted. Obviously, only works when
3303 connecting to a SSL enabled server. Enabled by default.
3305 =item B<CACert> I<File>
3307 File that holds one or more SSL certificates. If you want to use HTTPS you will
3308 possibly need this option. What CA certificates come bundled with C<libcurl>
3309 and are checked by default depends on the distribution you use.
3311 =back
3313 =head2 Plugin C<notify_desktop>
3315 This plugin sends a desktop notification to a notification daemon, as defined
3316 in the Desktop Notification Specification. To actually display the
3317 notifications, B<notification-daemon> is required and B<collectd> has to be
3318 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3319 environment variables have to be set correctly) and the D-Bus message bus.
3321 The Desktop Notification Specification can be found at
3322 L<http://www.galago-project.org/specs/notification/>.
3324 =over 4
3326 =item B<OkayTimeout> I<timeout>
3328 =item B<WarningTimeout> I<timeout>
3330 =item B<FailureTimeout> I<timeout>
3332 Set the I<timeout>, in milliseconds, after which to expire the notification
3333 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3334 been specified, the displayed notification will not be closed at all - the
3335 user has to do so herself. These options default to 5000. If a negative number
3336 has been specified, the default is used as well.
3338 =back
3340 =head2 Plugin C<notify_email>
3342 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3343 configured email address.
3345 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3347 Available configuration options:
3349 =over 4
3351 =item B<From> I<Address>
3353 Email address from which the emails should appear to come from.
3355 Default: C<root@localhost>
3357 =item B<Recipient> I<Address>
3359 Configures the email address(es) to which the notifications should be mailed.
3360 May be repeated to send notifications to multiple addresses.
3362 At least one B<Recipient> must be present for the plugin to work correctly.
3364 =item B<SMTPServer> I<Hostname>
3366 Hostname of the SMTP server to connect to.
3368 Default: C<localhost>
3370 =item B<SMTPPort> I<Port>
3372 TCP port to connect to.
3374 Default: C<25>
3376 =item B<SMTPUser> I<Username>
3378 Username for ASMTP authentication. Optional.
3380 =item B<SMTPPassword> I<Password>
3382 Password for ASMTP authentication. Optional.
3384 =item B<Subject> I<Subject>
3386 Subject-template to use when sending emails. There must be exactly two
3387 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3388 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3389 with the hostname.
3391 Default: C<Collectd notify: %s@%s>
3393 =back
3395 =head2 Plugin C<ntpd>
3397 =over 4
3399 =item B<Host> I<Hostname>
3401 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3403 =item B<Port> I<Port>
3405 UDP-Port to connect to. Defaults to B<123>.
3407 =item B<ReverseLookups> B<true>|B<false>
3409 Sets whether or not to perform reverse lookups on peers. Since the name or
3410 IP-address may be used in a filename it is recommended to disable reverse
3411 lookups. The default is to do reverse lookups to preserve backwards
3412 compatibility, though.
3414 =item B<IncludeUnitID> B<true>|B<false>
3416 When a peer is a refclock, include the unit ID in the I<type instance>.
3417 Defaults to B<false> for backward compatibility.
3419 If two refclock peers use the same driver and this is B<false>, the plugin will
3420 try to write simultaneous measurements from both to the same type instance.
3421 This will result in error messages in the log and only one set of measurements
3422 making it through.
3424 =back
3426 =head2 Plugin C<nut>
3428 =over 4
3430 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3432 Add a UPS to collect data from. The format is identical to the one accepted by
3433 L<upsc(8)>.
3435 =back
3437 =head2 Plugin C<olsrd>
3439 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3440 the Optimized Link State Routing daemon and reads information about the current
3441 state of the meshed network.
3443 The following configuration options are understood:
3445 =over 4
3447 =item B<Host> I<Host>
3449 Connect to I<Host>. Defaults to B<"localhost">.
3451 =item B<Port> I<Port>
3453 Specifies the port to connect to. This must be a string, even if you give the
3454 port as a number rather than a service name. Defaults to B<"2006">.
3456 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3458 Specifies what information to collect about links, i.E<nbsp>e. direct
3459 connections of the daemon queried. If set to B<No>, no information is
3460 collected. If set to B<Summary>, the number of links and the average of all
3461 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3462 If set to B<Detail> LQ and NLQ are collected per link.
3464 Defaults to B<Detail>.
3466 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3468 Specifies what information to collect about routes of the daemon queried. If
3469 set to B<No>, no information is collected. If set to B<Summary>, the number of
3470 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3471 metric and ETX are collected per route.
3473 Defaults to B<Summary>.
3475 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3477 Specifies what information to collect about the global topology. If set to
3478 B<No>, no information is collected. If set to B<Summary>, the number of links
3479 in the entire topology and the average I<link quality> (LQ) is calculated.
3480 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3482 Defaults to B<Summary>.
3484 =back
3486 =head2 Plugin C<onewire>
3488 B<EXPERIMENTAL!> See notes below.
3490 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3491 L<http://owfs.org/> to read sensors connected via the onewire bus.
3493 Currently only temperature sensors (sensors with the family code C<10>,
3494 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3495 would like to have included, please send a sort request to the mailing list.
3497 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3498 experimental, below.
3500 =over 4
3502 =item B<Device> I<Device>
3504 Sets the device to read the values from. This can either be a "real" hardware
3505 device, such as a serial port or an USB port, or the address of the
3506 L<owserver(1)> socket, usually B<localhost:4304>.
3508 Though the documentation claims to automatically recognize the given address
3509 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3510 with that version, the following configuration worked for us:
3512   <Plugin onewire>
3513     Device "-s localhost:4304"
3514   </Plugin>
3516 This directive is B<required> and does not have a default value.
3518 =item B<Sensor> I<Sensor>
3520 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3521 below. Sensors are specified without the family byte at the beginning, to you'd
3522 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3523 point.
3525 =item B<IgnoreSelected> I<true>|I<false>
3527 If no configuration if given, the B<onewire> plugin will collect data from all
3528 sensors found. This may not be practical, especially if sensors are added and
3529 removed regularly. Sometimes, however, it's easier/preferred to collect only
3530 specific sensors or all sensors I<except> a few specified ones. This option
3531 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3532 B<Sensor> is inverted: All selected interfaces are ignored and all other
3533 interfaces are collected.
3535 =item B<Interval> I<Seconds>
3537 Sets the interval in which all sensors should be read. If not specified, the
3538 global B<Interval> setting is used.
3540 =back
3542 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3543 work with big setups. It works with one sensor being attached to one
3544 controller, but as soon as you throw in a couple more senors and maybe a hub
3545 or two, reading all values will take more than ten seconds (the default
3546 interval). We will probably add some separate thread for reading the sensors
3547 and some cache or something like that, but it's not done yet. We will try to
3548 maintain backwards compatibility in the future, but we can't promise. So in
3549 short: If it works for you: Great! But keep in mind that the config I<might>
3550 change, though this is unlikely. Oh, and if you want to help improving this
3551 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3553 =head2 Plugin C<openvpn>
3555 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3556 traffic statistics about connected clients.
3558 To set up OpenVPN to write to the status file periodically, use the
3559 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3560 you need to set the required format, too. This is done by setting
3561 B<--status-version> to B<2>.
3563 So, in a nutshell you need:
3565   openvpn $OTHER_OPTIONS \
3566     --status "/var/run/openvpn-status" 10 \
3567     --status-version 2
3569 Available options:
3571 =over 4
3573 =item B<StatusFile> I<File>
3575 Specifies the location of the status file.
3577 =item B<ImprovedNamingSchema> B<true>|B<false>
3579 When enabled, the filename of the status file will be used as plugin instance
3580 and the client's "common name" will be used as type instance. This is required
3581 when reading multiple status files. Enabling this option is recommended, but to
3582 maintain backwards compatibility this option is disabled by default.
3584 =item B<CollectCompression> B<true>|B<false>
3586 Sets whether or not statistics about the compression used by OpenVPN should be
3587 collected. This information is only available in I<single> mode. Enabled by
3588 default.
3590 =item B<CollectIndividualUsers> B<true>|B<false>
3592 Sets whether or not traffic information is collected for each connected client
3593 individually. If set to false, currently no traffic data is collected at all
3594 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3596 =item B<CollectUserCount> B<true>|B<false>
3598 When enabled, the number of currently connected clients or users is collected.
3599 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3600 can be configured independently from that option. Defaults to B<false>.
3602 =back
3604 =head2 Plugin C<oracle>
3606 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3607 Oracle® Database and lets you execute SQL statements there. It is very similar
3608 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3609 plugin's documentation above for details.
3611   <Plugin oracle>
3612     <Query "out_of_stock">
3613       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3614       <Result>
3615         Type "gauge"
3616         # InstancePrefix "foo"
3617         InstancesFrom "category"
3618         ValuesFrom "value"
3619       </Result>
3620     </Query>
3621     <Database "product_information">
3622       ConnectID "db01"
3623       Username "oracle"
3624       Password "secret"
3625       Query "out_of_stock"
3626     </Database>
3627   </Plugin>
3629 =head3 B<Query> blocks
3631 The Query blocks are handled identically to the Query blocks of the "dbi"
3632 plugin. Please see its documentation above for details on how to specify
3633 queries.
3635 =head3 B<Database> blocks
3637 Database blocks define a connection to a database and which queries should be
3638 sent to that database. Each database needs a "name" as string argument in the
3639 starting tag of the block. This name will be used as "PluginInstance" in the
3640 values submitted to the daemon. Other than that, that name is not used.
3642 =over 4
3644 =item B<ConnectID> I<ID>
3646 Defines the "database alias" or "service name" to connect to. Usually, these
3647 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3649 =item B<Host> I<Host>
3651 Hostname to use when dispatching values for this database. Defaults to using
3652 the global hostname of the I<collectd> instance.
3654 =item B<Username> I<Username>
3656 Username used for authentication.
3658 =item B<Password> I<Password>
3660 Password used for authentication.
3662 =item B<Query> I<QueryName>
3664 Associates the query named I<QueryName> with this database connection. The
3665 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3666 blocks you want to refer to must be placed above the database block you want to
3667 refer to them from.
3669 =back
3671 =head2 Plugin C<perl>
3673 This plugin embeds a Perl-interpreter into collectd and provides an interface
3674 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3676 =head2 Plugin C<pinba>
3678 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3679 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3680 PHP-based webpage has been delivered, the extension will send a UDP packet
3681 containing timing information, peak memory usage and so on. The plugin will
3682 wait for such packets, parse them and account the provided information, which
3683 is then dispatched to the daemon once per interval.
3685 Synopsis:
3687  <Plugin pinba>
3688    Address "::0"
3689    Port "30002"
3690    # Overall statistics for the website.
3691    <View "www-total">
3692      Server "www.example.com"
3693    </View>
3694    # Statistics for www-a only
3695    <View "www-a">
3696      Host "www-a.example.com"
3697      Server "www.example.com"
3698    </View>
3699    # Statistics for www-b only
3700    <View "www-b">
3701      Host "www-b.example.com"
3702      Server "www.example.com"
3703    </View>
3704  </Plugin>
3706 The plugin provides the following configuration options:
3708 =over 4
3710 =item B<Address> I<Node>
3712 Configures the address used to open a listening socket. By default, plugin will
3713 bind to the I<any> address C<::0>.
3715 =item B<Port> I<Service>
3717 Configures the port (service) to bind to. By default the default Pinba port
3718 "30002" will be used. The option accepts service names in addition to port
3719 numbers and thus requires a I<string> argument.
3721 =item E<lt>B<View> I<Name>E<gt> block
3723 The packets sent by the Pinba extension include the hostname of the server, the
3724 server name (the name of the virtual host) and the script that was executed.
3725 Using B<View> blocks it is possible to separate the data into multiple groups
3726 to get more meaningful statistics. Each packet is added to all matching groups,
3727 so that a packet may be accounted for more than once.
3729 =over 4
3731 =item B<Host> I<Host>
3733 Matches the hostname of the system the webserver / script is running on. This
3734 will contain the result of the L<gethostname(2)> system call. If not
3735 configured, all hostnames will be accepted.
3737 =item B<Server> I<Server>
3739 Matches the name of the I<virtual host>, i.e. the contents of the
3740 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3741 server names will be accepted.
3743 =item B<Script> I<Script>
3745 Matches the name of the I<script name>, i.e. the contents of the
3746 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3747 script names will be accepted.
3749 =back
3751 =back
3753 =head2 Plugin C<ping>
3755 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3756 configured hosts periodically and measures the network latency. Whenever the
3757 C<read> function of the plugin is called, it submits the average latency, the
3758 standard deviation and the drop rate for each host.
3760 Available configuration options:
3762 =over 4
3764 =item B<Host> I<IP-address>
3766 Host to ping periodically. This option may be repeated several times to ping
3767 multiple hosts.
3769 =item B<Interval> I<Seconds>
3771 Sets the interval in which to send ICMP echo packets to the configured hosts.
3772 This is B<not> the interval in which statistics are queries from the plugin but
3773 the interval in which the hosts are "pinged". Therefore, the setting here
3774 should be smaller than or equal to the global B<Interval> setting. Fractional
3775 times, such as "1.24" are allowed.
3777 Default: B<1.0>
3779 =item B<Timeout> I<Seconds>
3781 Time to wait for a response from the host to which an ICMP packet had been
3782 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
3783 to be down or the packet to be dropped. This setting must be smaller than the
3784 B<Interval> setting above for the plugin to work correctly. Fractional
3785 arguments are accepted.
3787 Default: B<0.9>
3789 =item B<TTL> I<0-255>
3791 Sets the Time-To-Live of generated ICMP packets.
3793 =item B<SourceAddress> I<host>
3795 Sets the source address to use. I<host> may either be a numerical network
3796 address or a network hostname.
3798 =item B<Device> I<name>
3800 Sets the outgoing network device to be used. I<name> has to specify an
3801 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
3802 operating systems.
3804 =item B<MaxMissed> I<Packets>
3806 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
3807 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
3809 Default: B<-1> (disabled)
3811 =back
3813 =head2 Plugin C<postgresql>
3815 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
3816 keeps a persistent connection to all configured databases and tries to
3817 reconnect if the connection has been interrupted. A database is configured by
3818 specifying a B<Database> block as described below. The default statistics are
3819 collected from PostgreSQL's B<statistics collector> which thus has to be
3820 enabled for this plugin to work correctly. This should usually be the case by
3821 default. See the section "The Statistics Collector" of the B<PostgreSQL
3822 Documentation> for details.
3824 By specifying custom database queries using a B<Query> block as described
3825 below, you may collect any data that is available from some PostgreSQL
3826 database. This way, you are able to access statistics of external daemons
3827 which are available in a PostgreSQL database or use future or special
3828 statistics provided by PostgreSQL without the need to upgrade your collectd
3829 installation.
3831 Starting with version 5.2, the C<postgresql> plugin supports writing data to
3832 PostgreSQL databases as well. This has been implemented in a generic way. You
3833 need to specify an SQL statement which will then be executed by collectd in
3834 order to write the data (see below for details). The benefit of that approach
3835 is that there is no fixed database layout. Rather, the layout may be optimized
3836 for the current setup.
3838 The B<PostgreSQL Documentation> manual can be found at
3839 L<http://www.postgresql.org/docs/manuals/>.
3841   <Plugin postgresql>
3842     <Query magic>
3843       Statement "SELECT magic FROM wizard WHERE host = $1;"
3844       Param hostname
3845       <Result>
3846         Type gauge
3847         InstancePrefix "magic"
3848         ValuesFrom magic
3849       </Result>
3850     </Query>
3852     <Query rt36_tickets>
3853       Statement "SELECT COUNT(type) AS count, type \
3854                         FROM (SELECT CASE \
3855                                      WHEN resolved = 'epoch' THEN 'open' \
3856                                      ELSE 'resolved' END AS type \
3857                                      FROM tickets) type \
3858                         GROUP BY type;"
3859       <Result>
3860         Type counter
3861         InstancePrefix "rt36_tickets"
3862         InstancesFrom "type"
3863         ValuesFrom "count"
3864       </Result>
3865     </Query>
3867     <Writer sqlstore>
3868       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
3869       StoreRates true
3870     </Writer>
3872     <Database foo>
3873       Host "hostname"
3874       Port "5432"
3875       User "username"
3876       Password "secret"
3877       SSLMode "prefer"
3878       KRBSrvName "kerberos_service_name"
3879       Query magic
3880     </Database>
3882     <Database bar>
3883       Interval 300
3884       Service "service_name"
3885       Query backend # predefined
3886       Query rt36_tickets
3887     </Database>
3889     <Database qux>
3890       # ...
3891       Writer sqlstore
3892       CommitInterval 10
3893     </Database>
3894   </Plugin>
3896 The B<Query> block defines one database query which may later be used by a
3897 database definition. It accepts a single mandatory argument which specifies
3898 the name of the query. The names of all queries have to be unique (see the
3899 B<MinVersion> and B<MaxVersion> options below for an exception to this
3900 rule). The following configuration options are available to define the query:
3902 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
3903 blocks define how to handle the values returned from the query. They define
3904 which column holds which value and how to dispatch that value to the daemon.
3905 Multiple B<Result> blocks may be used to extract multiple values from a single
3906 query.
3908 =over 4
3910 =item B<Statement> I<sql query statement>
3912 Specify the I<sql query statement> which the plugin should execute. The string
3913 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
3914 first, second, etc. parameter. The value of the parameters is specified by the
3915 B<Param> configuration option - see below for details. To include a literal
3916 B<$> character followed by a number, surround it with single quotes (B<'>).
3918 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
3919 allowed. Note, however, that only a single command may be used. Semicolons are
3920 allowed as long as a single non-empty command has been specified only.
3922 The returned lines will be handled separately one after another.
3924 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
3926 Specify the parameters which should be passed to the SQL query. The parameters
3927 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
3928 they appear in the configuration file. The value of the parameter is
3929 determined depending on the value of the B<Param> option as follows:
3931 =over 4
3933 =item I<hostname>
3935 The configured hostname of the database connection. If a UNIX domain socket is
3936 used, the parameter expands to "localhost".
3938 =item I<database>
3940 The name of the database of the current connection.
3942 =item I<instance>
3944 The name of the database plugin instance. See the B<Instance> option of the
3945 database specification below for details.
3947 =item I<username>
3949 The username used to connect to the database.
3951 =item I<interval>
3953 The interval with which this database is queried (as specified by the database
3954 specific or global B<Interval> options).
3956 =back
3958 Please note that parameters are only supported by PostgreSQL's protocol
3959 version 3 and above which was introduced in version 7.4 of PostgreSQL.
3961 =item B<Type> I<type>
3963 The I<type> name to be used when dispatching the values. The type describes
3964 how to handle the data and where to store it. See L<types.db(5)> for more
3965 details on types and their configuration. The number and type of values (as
3966 selected by the B<ValuesFrom> option) has to match the type of the given name.
3968 This option is required inside a B<Result> block.
3970 =item B<InstancePrefix> I<prefix>
3972 =item B<InstancesFrom> I<column0> [I<column1> ...]
3974 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
3975 B<InstancePrefix> defines a static prefix that will be prepended to all type
3976 instances. B<InstancesFrom> defines the column names whose values will be used
3977 to create the type instance. Multiple values will be joined together using the
3978 hyphen (C<->) as separation character.
3980 The plugin itself does not check whether or not all built instances are
3981 different. It is your responsibility to assure that each is unique.
3983 Both options are optional. If none is specified, the type instance will be
3984 empty.
3986 =item B<ValuesFrom> I<column0> [I<column1> ...]
3988 Names the columns whose content is used as the actual data for the data sets
3989 that are dispatched to the daemon. How many such columns you need is
3990 determined by the B<Type> setting as explained above. If you specify too many
3991 or not enough columns, the plugin will complain about that and no data will be
3992 submitted to the daemon.
3994 The actual data type, as seen by PostgreSQL, is not that important as long as
3995 it represents numbers. The plugin will automatically cast the values to the
3996 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
3997 L<strtod(3)> functions, so anything supported by those functions is supported
3998 by the plugin as well.
4000 This option is required inside a B<Result> block and may be specified multiple
4001 times. If multiple B<ValuesFrom> options are specified, the columns are read
4002 in the given order.
4004 =item B<MinVersion> I<version>
4006 =item B<MaxVersion> I<version>
4008 Specify the minimum or maximum version of PostgreSQL that this query should be
4009 used with. Some statistics might only be available with certain versions of
4010 PostgreSQL. This allows you to specify multiple queries with the same name but
4011 which apply to different versions, thus allowing you to use the same
4012 configuration in a heterogeneous environment.
4014 The I<version> has to be specified as the concatenation of the major, minor
4015 and patch-level versions, each represented as two-decimal-digit numbers. For
4016 example, version 8.2.3 will become 80203.
4018 =back
4020 The following predefined queries are available (the definitions can be found
4021 in the F<postgresql_default.conf> file which, by default, is available at
4022 C<I<prefix>/share/collectd/>):
4024 =over 4
4026 =item B<backends>
4028 This query collects the number of backends, i.E<nbsp>e. the number of
4029 connected clients.
4031 =item B<transactions>
4033 This query collects the numbers of committed and rolled-back transactions of
4034 the user tables.
4036 =item B<queries>
4038 This query collects the numbers of various table modifications (i.E<nbsp>e.
4039 insertions, updates, deletions) of the user tables.
4041 =item B<query_plans>
4043 This query collects the numbers of various table scans and returned tuples of
4044 the user tables.
4046 =item B<table_states>
4048 This query collects the numbers of live and dead rows in the user tables.
4050 =item B<disk_io>
4052 This query collects disk block access counts for user tables.
4054 =item B<disk_usage>
4056 This query collects the on-disk size of the database in bytes.
4058 =back
4060 In addition, the following detailed queries are available by default. Please
4061 note that each of those queries collects information B<by table>, thus,
4062 potentially producing B<a lot> of data. For details see the description of the
4063 non-by_table queries above.
4065 =over 4
4067 =item B<queries_by_table>
4069 =item B<query_plans_by_table>
4071 =item B<table_states_by_table>
4073 =item B<disk_io_by_table>
4075 =back
4077 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4078 mandatory argument specifying the name of the writer. This will then be used
4079 in the B<Database> specification in order to activate the writer instance. The
4080 names of all writers have to be unique. The following options may be
4081 specified:
4083 =over 4
4085 =item B<Statement> I<sql statement>
4087 This mandatory option specifies the SQL statement that will be executed for
4088 each submitted value. A single SQL statement is allowed only. Anything after
4089 the first semicolon will be ignored.
4091 Nine parameters will be passed to the statement and should be specified as
4092 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4093 values are made available through those parameters:
4095 =over 4
4097 =item B<$1>
4099 The timestamp of the queried value as a floating point number.
4101 =item B<$2>
4103 The hostname of the queried value.
4105 =item B<$3>
4107 The plugin name of the queried value.
4109 =item B<$4>
4111 The plugin instance of the queried value. This value may be B<NULL> if there
4112 is no plugin instance.
4114 =item B<$5>
4116 The type of the queried value (cf. L<types.db(5)>).
4118 =item B<$6>
4120 The type instance of the queried value. This value may be B<NULL> if there is
4121 no type instance.
4123 =item B<$7>
4125 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4126 sources of the submitted value-list).
4128 =item B<$8>
4130 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4131 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4132 B<StoreRates> is enabled (which is the default, see below), all types will be
4133 C<gauge>.
4135 =item B<$9>
4137 An array of the submitted values. The dimensions of the value name and value
4138 arrays match.
4140 =back
4142 In general, it is advisable to create and call a custom function in the
4143 PostgreSQL database for this purpose. Any procedural language supported by
4144 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4145 for details).
4147 =item B<StoreRates> B<false>|B<true>
4149 If set to B<true> (the default), convert counter values to rates. If set to
4150 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4151 number.
4153 =back
4155 The B<Database> block defines one PostgreSQL database for which to collect
4156 statistics. It accepts a single mandatory argument which specifies the
4157 database name. None of the other options are required. PostgreSQL will use
4158 default values as documented in the section "CONNECTING TO A DATABASE" in the
4159 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4160 the user collectd is run as and special environment variables. See the manpage
4161 for details.
4163 =over 4
4165 =item B<Interval> I<seconds>
4167 Specify the interval with which the database should be queried. The default is
4168 to use the global B<Interval> setting.
4170 =item B<CommitInterval> I<seconds>
4172 This option may be used for database connections which have "writers" assigned
4173 (see above). If specified, it causes a writer to put several updates into a
4174 single transaction. This transaction will last for the specified amount of
4175 time. By default, each update will be executed in a separate transaction. Each
4176 transaction generates a fair amount of overhead which can, thus, be reduced by
4177 activating this option. The draw-back is, that data covering the specified
4178 amount of time will be lost, for example, if a single statement within the
4179 transaction fails or if the database server crashes.
4181 =item B<Host> I<hostname>
4183 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4184 value begins with a slash, it is interpreted as the directory name in which to
4185 look for the UNIX domain socket.
4187 This option is also used to determine the hostname that is associated with a
4188 collected data set. If it has been omitted or either begins with with a slash
4189 or equals B<localhost> it will be replaced with the global hostname definition
4190 of collectd. Any other value will be passed literally to collectd when
4191 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4193 =item B<Port> I<port>
4195 Specify the TCP port or the local UNIX domain socket file extension of the
4196 server.
4198 =item B<User> I<username>
4200 Specify the username to be used when connecting to the server.
4202 =item B<Password> I<password>
4204 Specify the password to be used when connecting to the server.
4206 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4208 Specify whether to use an SSL connection when contacting the server. The
4209 following modes are supported:
4211 =item B<Instance> I<name>
4213 Specify the plugin instance name that should be used instead of the database
4214 name (which is the default, if this option has not been specified). This
4215 allows to query multiple databases of the same name on the same host (e.g.
4216 when running multiple database server versions in parallel).
4218 =over 4
4220 =item I<disable>
4222 Do not use SSL at all.
4224 =item I<allow>
4226 First, try to connect without using SSL. If that fails, try using SSL.
4228 =item I<prefer> (default)
4230 First, try to connect using SSL. If that fails, try without using SSL.
4232 =item I<require>
4234 Use SSL only.
4236 =back
4238 =item B<KRBSrvName> I<kerberos_service_name>
4240 Specify the Kerberos service name to use when authenticating with Kerberos 5
4241 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4242 B<PostgreSQL Documentation> for details.
4244 =item B<Service> I<service_name>
4246 Specify the PostgreSQL service name to use for additional parameters. That
4247 service has to be defined in F<pg_service.conf> and holds additional
4248 connection parameters. See the section "The Connection Service File" in the
4249 B<PostgreSQL Documentation> for details.
4251 =item B<Query> I<query>
4253 Specifies a I<query> which should be executed in the context of the database
4254 connection. This may be any of the predefined or user-defined queries. If no
4255 such option is given, it defaults to "backends", "transactions", "queries",
4256 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4257 has been specified). Else, the specified queries are used only.
4259 =item B<Writer> I<writer>
4261 Assigns the specified I<writer> backend to the database connection. This
4262 causes all collected data to be send to the database using the settings
4263 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4264 below for details on how to selectively send data to certain plugins).
4266 Each writer will register a flush callback which may be used when having long
4267 transactions enabled (see the B<CommitInterval> option above). When issuing
4268 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4269 transaction will be committed right away. Two different kinds of flush
4270 callbacks are available with the C<postgresql> plugin:
4272 =over 4
4274 =item B<postgresql>
4276 Flush all writer backends.
4278 =item B<postgresql->I<database>
4280 Flush all writers of the specified I<database> only.
4282 =back
4284 =back
4286 =head2 Plugin C<powerdns>
4288 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4289 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4290 values, many of which are probably meaningless to most users, but may be useful
4291 for some. So you may chose which values to collect, but if you don't, some
4292 reasonable defaults will be collected.
4294   <Plugin "powerdns">
4295     <Server "server_name">
4296       Collect "latency"
4297       Collect "udp-answers" "udp-queries"
4298       Socket "/var/run/pdns.controlsocket"
4299     </Server>
4300     <Recursor "recursor_name">
4301       Collect "questions"
4302       Collect "cache-hits" "cache-misses"
4303       Socket "/var/run/pdns_recursor.controlsocket"
4304     </Recursor>
4305     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4306   </Plugin>
4308 =over 4
4310 =item B<Server> and B<Recursor> block
4312 The B<Server> block defines one authoritative server to query, the B<Recursor>
4313 does the same for an recursing server. The possible options in both blocks are
4314 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4315 and is required.
4317 =over 4
4319 =item B<Collect> I<Field>
4321 Using the B<Collect> statement you can select which values to collect. Here,
4322 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4323 C<dlg-only-drops>, C<answers10-100>.
4325 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4326 When querying the server a C<SHOW *> command is issued in any case, because
4327 that's the only way of getting multiple values out of the server at once.
4328 collectd then picks out the values you have selected. When querying the
4329 recursor, a command is generated to query exactly these values. So if you
4330 specify invalid fields when querying the recursor, a syntax error may be
4331 returned by the daemon and collectd may not collect any values at all.
4333 If no B<Collect> statement is given, the following B<Server> values will be
4334 collected:
4336 =over 4
4338 =item latency
4340 =item packetcache-hit
4342 =item packetcache-miss
4344 =item packetcache-size
4346 =item query-cache-hit
4348 =item query-cache-miss
4350 =item recursing-answers
4352 =item recursing-questions
4354 =item tcp-answers
4356 =item tcp-queries
4358 =item udp-answers
4360 =item udp-queries
4362 =back
4364 The following B<Recursor> values will be collected by default:
4366 =over 4
4368 =item noerror-answers
4370 =item nxdomain-answers
4372 =item servfail-answers
4374 =item sys-msec
4376 =item user-msec
4378 =item qa-latency
4380 =item cache-entries
4382 =item cache-hits
4384 =item cache-misses
4386 =item questions
4388 =back
4390 Please note that up to that point collectd doesn't know what values are
4391 available on the server and values that are added do not need a change of the
4392 mechanism so far. However, the values must be mapped to collectd's naming
4393 scheme, which is done using a lookup table that lists all known values. If
4394 values are added in the future and collectd does not know about them, you will
4395 get an error much like this:
4397   powerdns plugin: submit: Not found in lookup table: foobar = 42
4399 In this case please file a bug report with the collectd team.
4401 =item B<Socket> I<Path>
4403 Configures the path to the UNIX domain socket to be used when connecting to the
4404 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4405 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4406 will be used for the recursor.
4408 =back
4410 =item B<LocalSocket> I<Path>
4412 Querying the recursor is done using UDP. When using UDP over UNIX domain
4413 sockets, the client socket needs a name in the file system, too. You can set
4414 this local name to I<Path> using the B<LocalSocket> option. The default is
4415 C<I<prefix>/var/run/collectd-powerdns>.
4417 =back
4419 =head2 Plugin C<processes>
4421 =over 4
4423 =item B<Process> I<Name>
4425 Select more detailed statistics of processes matching this name. The statistics
4426 collected for these selected processes are size of the resident segment size
4427 (RSS), user- and system-time used, number of processes and number of threads,
4428 io data (where available) and minor and major pagefaults.
4430 =item B<ProcessMatch> I<name> I<regex>
4432 Similar to the B<Process> option this allows to select more detailed
4433 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4434 details). The statistics of all matching processes are summed up and
4435 dispatched to the daemon using the specified I<name> as an identifier. This
4436 allows to "group" several processes together. I<name> must not contain
4437 slashes.
4439 =back
4441 =head2 Plugin C<protocols>
4443 Collects a lot of information about various network protocols, such as I<IP>,
4444 I<TCP>, I<UDP>, etc.
4446 Available configuration options:
4448 =over 4
4450 =item B<Value> I<Selector>
4452 Selects whether or not to select a specific value. The string being matched is
4453 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4454 plugin instance and I<ValueName> will be used as type instance. An example of
4455 the string being used would be C<Tcp:RetransSegs>.
4457 You can use regular expressions to match a large number of values with just one
4458 configuration option. To select all "extended" I<TCP> values, you could use the
4459 following statement:
4461   Value "/^TcpExt:/"
4463 Whether only matched values are selected or all matched values are ignored
4464 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4465 If no value is configured at all, all values will be selected.
4467 =item B<IgnoreSelected> B<true>|B<false>
4469 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4470 matching values will be ignored.
4472 =back
4474 =head2 Plugin C<python>
4476 This plugin embeds a Python-interpreter into collectd and provides an interface
4477 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4479 =head2 Plugin C<routeros>
4481 The C<routeros> plugin connects to a device running I<RouterOS>, the
4482 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4483 I<librouteros> to connect and reads information about the interfaces and
4484 wireless connections of the device. The configuration supports querying
4485 multiple routers:
4487   <Plugin "routeros">
4488     <Router>
4489       Host "router0.example.com"
4490       User "collectd"
4491       Password "secr3t"
4492       CollectInterface true
4493       CollectCPULoad true
4494       CollectMemory true
4495     </Router>
4496     <Router>
4497       Host "router1.example.com"
4498       User "collectd"
4499       Password "5ecret"
4500       CollectInterface true
4501       CollectRegistrationTable true
4502       CollectDF true
4503       CollectDisk true
4504     </Router>
4505   </Plugin>
4507 As you can see above, the configuration of the I<routeros> plugin consists of
4508 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4509 options are understood:
4511 =over 4
4513 =item B<Host> I<Host>
4515 Hostname or IP-address of the router to connect to.
4517 =item B<Port> I<Port>
4519 Port name or port number used when connecting. If left unspecified, the default
4520 will be chosen by I<librouteros>, currently "8728". This option expects a
4521 string argument, even when a numeric port number is given.
4523 =item B<User> I<User>
4525 Use the user name I<User> to authenticate. Defaults to "admin".
4527 =item B<Password> I<Password>
4529 Set the password used to authenticate.
4531 =item B<CollectInterface> B<true>|B<false>
4533 When set to B<true>, interface statistics will be collected for all interfaces
4534 present on the device. Defaults to B<false>.
4536 =item B<CollectRegistrationTable> B<true>|B<false>
4538 When set to B<true>, information about wireless LAN connections will be
4539 collected. Defaults to B<false>.
4541 =item B<CollectCPULoad> B<true>|B<false>
4543 When set to B<true>, information about the CPU usage will be collected. The
4544 number is a dimensionless value where zero indicates no CPU usage at all.
4545 Defaults to B<false>.
4547 =item B<CollectMemory> B<true>|B<false>
4549 When enabled, the amount of used and free memory will be collected. How used
4550 memory is calculated is unknown, for example whether or not caches are counted
4551 as used space.
4552 Defaults to B<false>.
4554 =item B<CollectDF> B<true>|B<false>
4556 When enabled, the amount of used and free disk space will be collected.
4557 Defaults to B<false>.
4559 =item B<CollectDisk> B<true>|B<false>
4561 When enabled, the number of sectors written and bad blocks will be collected.
4562 Defaults to B<false>.
4564 =back
4566 =head2 Plugin C<redis>
4568 The I<Redis plugin> connects to one or more Redis servers and gathers
4569 information about each server's state. For each server there is a I<Node> block
4570 which configures the connection parameters for this node.
4572   <Plugin redis>
4573     <Node "example">
4574         Host "localhost"
4575         Port "6379"
4576         Timeout 2000
4577     </Node>
4578   </Plugin>
4580 The information shown in the synopsis above is the I<default configuration>
4581 which is used by the plugin if no configuration is present.
4583 =over 4
4585 =item B<Node> I<Nodename>
4587 The B<Node> block identifies a new Redis node, that is a new Redis instance
4588 running in an specified host and port. The name for node is a canonical
4589 identifier which is used as I<plugin instance>. It is limited to
4590 64E<nbsp>characters in length.
4592 =item B<Host> I<Hostname>
4594 The B<Host> option is the hostname or IP-address where the Redis instance is
4595 running on.
4597 =item B<Port> I<Port>
4599 The B<Port> option is the TCP port on which the Redis instance accepts
4600 connections. Either a service name of a port number may be given. Please note
4601 that numerical port numbers must be given as a string, too.
4603 =item B<Password> I<Password>
4605 Use I<Password> to authenticate when connecting to I<Redis>.
4607 =item B<Timeout> I<Timeout in miliseconds>
4609 The B<Timeout> option set the socket timeout for node response. Since the Redis
4610 read function is blocking, you should keep this value as low as possible. Keep
4611 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4612 than B<Interval> defined globally.
4614 =back
4616 =head2 Plugin C<rrdcached>
4618 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4619 to store values to RRD files in an efficient manner. The combination of the
4620 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4621 way the C<rrdtool> plugin works (see below). The added abstraction layer
4622 provides a number of benefits, though: Because the cache is not within
4623 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4624 restarted. This results in much shorter (if any) gaps in graphs, especially
4625 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4626 daemon so that it can flush values to disk automatically when needed. This
4627 allows to integrate automated flushing of values into graphing solutions much
4628 more easily.
4630 There are disadvantages, though: The daemon may reside on a different host, so
4631 it may not be possible for C<collectd> to create the appropriate RRD files
4632 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4633 different base directory, so relative paths may do weird stuff if you're not
4634 careful.
4636 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4637 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4638 setting should be set to an absolute path, so that a changed base directory
4639 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4641 =over 4
4643 =item B<DaemonAddress> I<Address>
4645 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4646 library. See L<rrdcached(1)> for details. Example:
4648   <Plugin "rrdcached">
4649     DaemonAddress "unix:/var/run/rrdcached.sock"
4650   </Plugin>
4652 =item B<DataDir> I<Directory>
4654 Set the base directory in which the RRD files reside. If this is a relative
4655 path, it is relative to the working base directory of the C<rrdcached> daemon!
4656 Use of an absolute path is recommended.
4658 =item B<CreateFiles> B<true>|B<false>
4660 Enables or disables the creation of RRD files. If the daemon is not running
4661 locally, or B<DataDir> is set to a relative path, this will not work as
4662 expected. Default is B<true>.
4664 =item B<CreateFilesAsync> B<false>|B<true>
4666 When enabled, new RRD files are enabled asynchronously, using a separate thread
4667 that runs in the background. This prevents writes to block, which is a problem
4668 especially when many hundreds of files need to be created at once. However,
4669 since the purpose of creating the files asynchronously is I<not> to block until
4670 the file is available, values before the file is available will be discarded.
4671 When disabled (the default) files are created synchronously, blocking for a
4672 short while, while the file is being written.
4674 =item B<StepSize> I<Seconds>
4676 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4677 this setting is unset and the stepsize is set to the interval in which the data
4678 is collected. Do not use this option unless you absolutely have to for some
4679 reason. Setting this option may cause problems with the C<snmp plugin>, the
4680 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4682 =item B<HeartBeat> I<Seconds>
4684 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4685 in which case the heartbeat is set to twice the B<StepSize> which should equal
4686 the interval in which data is collected. Do not set this option unless you have
4687 a very good reason to do so.
4689 =item B<RRARows> I<NumRows>
4691 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4692 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4693 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4694 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4695 week, one month, and one year.
4697 So for each timespan, it calculates how many PDPs need to be consolidated into
4698 one CDP by calculating:
4699   number of PDPs = timespan / (stepsize * rrarows)
4701 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4702 default is 1200.
4704 =item B<RRATimespan> I<Seconds>
4706 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4707 more then one RRA. If this option is never used, the built-in default of (3600,
4708 86400, 604800, 2678400, 31622400) is used.
4710 For more information on how RRA-sizes are calculated see B<RRARows> above.
4712 =item B<XFF> I<Factor>
4714 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4715 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4716 one (exclusive).
4718 =back
4720 =head2 Plugin C<rrdtool>
4722 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4723 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4724 using these settings. If you don't want to dive into the depths of RRDtool, you
4725 can safely ignore these settings.
4727 =over 4
4729 =item B<DataDir> I<Directory>
4731 Set the directory to store RRD files under. By default RRD files are generated
4732 beneath the daemon's working directory, i.e. the B<BaseDir>.
4734 =item B<CreateFilesAsync> B<false>|B<true>
4736 When enabled, new RRD files are enabled asynchronously, using a separate thread
4737 that runs in the background. This prevents writes to block, which is a problem
4738 especially when many hundreds of files need to be created at once. However,
4739 since the purpose of creating the files asynchronously is I<not> to block until
4740 the file is available, values before the file is available will be discarded.
4741 When disabled (the default) files are created synchronously, blocking for a
4742 short while, while the file is being written.
4744 =item B<StepSize> I<Seconds>
4746 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4747 this setting is unset and the stepsize is set to the interval in which the data
4748 is collected. Do not use this option unless you absolutely have to for some
4749 reason. Setting this option may cause problems with the C<snmp plugin>, the
4750 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4752 =item B<HeartBeat> I<Seconds>
4754 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4755 in which case the heartbeat is set to twice the B<StepSize> which should equal
4756 the interval in which data is collected. Do not set this option unless you have
4757 a very good reason to do so.
4759 =item B<RRARows> I<NumRows>
4761 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4762 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4763 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4764 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4765 week, one month, and one year.
4767 So for each timespan, it calculates how many PDPs need to be consolidated into
4768 one CDP by calculating:
4769   number of PDPs = timespan / (stepsize * rrarows)
4771 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4772 default is 1200.
4774 =item B<RRATimespan> I<Seconds>
4776 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4777 more then one RRA. If this option is never used, the built-in default of (3600,
4778 86400, 604800, 2678400, 31622400) is used.
4780 For more information on how RRA-sizes are calculated see B<RRARows> above.
4782 =item B<XFF> I<Factor>
4784 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4785 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4786 one (exclusive).
4788 =item B<CacheFlush> I<Seconds>
4790 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
4791 it writes all values for a certain RRD-file if the oldest value is older than
4792 (or equal to) the number of seconds specified. If some RRD-file is not updated
4793 anymore for some reason (the computer was shut down, the network is broken,
4794 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
4795 entire cache is searched for entries older than B<CacheTimeout> seconds and
4796 written to disk every I<Seconds> seconds. Since this is kind of expensive and
4797 does nothing under normal circumstances, this value should not be too small.
4798 900 seconds might be a good value, though setting this to 7200 seconds doesn't
4799 normally do much harm either.
4801 =item B<CacheTimeout> I<Seconds>
4803 If this option is set to a value greater than zero, the C<rrdtool plugin> will
4804 save values in a cache, as described above. Writing multiple values at once
4805 reduces IO-operations and thus lessens the load produced by updating the files.
4806 The trade off is that the graphs kind of "drag behind" and that more memory is
4807 used.
4809 =item B<WritesPerSecond> I<Updates>
4811 When collecting many statistics with collectd and the C<rrdtool> plugin, you
4812 will run serious performance problems. The B<CacheFlush> setting and the
4813 internal update queue assert that collectd continues to work just fine even
4814 under heavy load, but the system may become very unresponsive and slow. This is
4815 a problem especially if you create graphs from the RRD files on the same
4816 machine, for example using the C<graph.cgi> script included in the
4817 C<contrib/collection3/> directory.
4819 This setting is designed for very large setups. Setting this option to a value
4820 between 25 and 80 updates per second, depending on your hardware, will leave
4821 the server responsive enough to draw graphs even while all the cached values
4822 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
4823 by the B<FLUSH> command, are B<not> effected by this limit. They are still
4824 written as fast as possible, so that web frontends have up to date data when
4825 generating graphs.
4827 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
4828 updates per second, writing all values to disk will take approximately
4829 56E<nbsp>minutes. Together with the flushing ability that's integrated into
4830 "collection3" you'll end up with a responsive and fast system, up to date
4831 graphs and basically a "backup" of your values every hour.
4833 =item B<RandomTimeout> I<Seconds>
4835 When set, the actual timeout for each value is chosen randomly between
4836 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
4837 intention is to avoid high load situations that appear when many values timeout
4838 at the same time. This is especially a problem shortly after the daemon starts,
4839 because all values were added to the internal cache at roughly the same time.
4841 =back
4843 =head2 Plugin C<sensors>
4845 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
4846 that all the needed modules have to be loaded and lm_sensors has to be
4847 configured (most likely by editing F</etc/sensors.conf>. Read
4848 L<sensors.conf(5)> for details.
4850 The B<lm_sensors> homepage can be found at
4851 L<http://secure.netroedge.com/~lm78/>.
4853 =over 4
4855 =item B<SensorConfigFile> I<File>
4857 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
4858 the library's default will be used.
4860 =item B<Sensor> I<chip-bus-address/type-feature>
4862 Selects the name of the sensor which you want to collect or ignore, depending
4863 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
4864 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
4865 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
4867 =item B<IgnoreSelected> I<true>|I<false>
4869 If no configuration if given, the B<sensors>-plugin will collect data from all
4870 sensors. This may not be practical, especially for uninteresting sensors.
4871 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
4872 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
4873 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
4874 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
4875 and all other sensors are collected.
4877 =back
4879 =head2 Plugin C<snmp>
4881 Since the configuration of the C<snmp plugin> is a little more complicated than
4882 other plugins, its documentation has been moved to an own manpage,
4883 L<collectd-snmp(5)>. Please see there for details.
4885 =head2 Plugin C<swap>
4887 The I<Swap plugin> collects information about used and available swap space. On
4888 I<Linux> and I<Solaris>, the following options are available:
4890 =over 4
4892 =item B<ReportByDevice> B<false>|B<true>
4894 Configures how to report physical swap devices. If set to B<false> (the
4895 default), the summary over all swap devices is reported only, i.e. the globally
4896 used and available space over all devices. If B<true> is configured, the used
4897 and available space of each device will be reported separately.
4899 This option is only available if the I<Swap plugin> can read C</proc/swaps>
4900 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
4902 =item B<ReportBytes> B<false>|B<true>
4904 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
4905 I<swap I/O> is reported in pages. This option is available under Linux only.
4907 =back
4909 =head2 Plugin C<syslog>
4911 =over 4
4913 =item B<LogLevel> B<debug|info|notice|warning|err>
4915 Sets the log-level. If, for example, set to B<notice>, then all events with
4916 severity B<notice>, B<warning>, or B<err> will be submitted to the
4917 syslog-daemon.
4919 Please note that B<debug> is only available if collectd has been compiled with
4920 debugging support.
4922 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
4924 Controls which notifications should be sent to syslog. The default behaviour is
4925 not to send any. Less severe notifications always imply logging more severe
4926 notifications: Setting this to B<OKAY> means all notifications will be sent to
4927 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
4928 notifications but will dismiss B<OKAY> notifications. Setting this option to
4929 B<FAILURE> will only send failures to syslog.
4931 =back
4933 =head2 Plugin C<table>
4935 The C<table plugin> provides generic means to parse tabular data and dispatch
4936 user specified values. Values are selected based on column numbers. For
4937 example, this plugin may be used to get values from the Linux L<proc(5)>
4938 filesystem or CSV (comma separated values) files.
4940   <Plugin table>
4941     <Table "/proc/slabinfo">
4942       Instance "slabinfo"
4943       Separator " "
4944       <Result>
4945         Type gauge
4946         InstancePrefix "active_objs"
4947         InstancesFrom 0
4948         ValuesFrom 1
4949       </Result>
4950       <Result>
4951         Type gauge
4952         InstancePrefix "objperslab"
4953         InstancesFrom 0
4954         ValuesFrom 4
4955       </Result>
4956     </Table>
4957   </Plugin>
4959 The configuration consists of one or more B<Table> blocks, each of which
4960 configures one file to parse. Within each B<Table> block, there are one or
4961 more B<Result> blocks, which configure which data to select and how to
4962 interpret it.
4964 The following options are available inside a B<Table> block:
4966 =over 4
4968 =item B<Instance> I<instance>
4970 If specified, I<instance> is used as the plugin instance. So, in the above
4971 example, the plugin name C<table-slabinfo> would be used. If omitted, the
4972 filename of the table is used instead, with all special characters replaced
4973 with an underscore (C<_>).
4975 =item B<Separator> I<string>
4977 Any character of I<string> is interpreted as a delimiter between the different
4978 columns of the table. A sequence of two or more contiguous delimiters in the
4979 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
4980 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
4981 of a table - see its documentation for more details. This option is mandatory.
4983 A horizontal tab, newline and carriage return may be specified by C<\\t>,
4984 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
4985 required because of collectd's config parsing.
4987 =back
4989 The following options are available inside a B<Result> block:
4991 =over 4
4993 =item B<Type> I<type>
4995 Sets the type used to dispatch the values to the daemon. Detailed information
4996 about types and their configuration can be found in L<types.db(5)>. This
4997 option is mandatory.
4999 =item B<InstancePrefix> I<prefix>
5001 If specified, prepend I<prefix> to the type instance. If omitted, only the
5002 B<InstancesFrom> option is considered for the type instance.
5004 =item B<InstancesFrom> I<column0> [I<column1> ...]
5006 If specified, the content of the given columns (identified by the column
5007 number starting at zero) will be used to create the type instance for each
5008 row. Multiple values (and the instance prefix) will be joined together with
5009 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5010 option is considered for the type instance.
5012 The plugin itself does not check whether or not all built instances are
5013 different. It’s your responsibility to assure that each is unique. This is
5014 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5015 sure that the table only contains one row.
5017 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5018 will be empty.
5020 =item B<ValuesFrom> I<column0> [I<column1> ...]
5022 Specifies the columns (identified by the column numbers starting at zero)
5023 whose content is used as the actual data for the data sets that are dispatched
5024 to the daemon. How many such columns you need is determined by the B<Type>
5025 setting above. If you specify too many or not enough columns, the plugin will
5026 complain about that and no data will be submitted to the daemon. The plugin
5027 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5028 respectively, so anything supported by those functions is supported by the
5029 plugin as well. This option is mandatory.
5031 =back
5033 =head2 Plugin C<tail>
5035 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5036 each line and dispatches found values. What is matched can be configured by the
5037 user using (extended) regular expressions, as described in L<regex(7)>.
5039   <Plugin "tail">
5040     <File "/var/log/exim4/mainlog">
5041       Instance "exim"
5042       <Match>
5043         Regex "S=([1-9][0-9]*)"
5044         DSType "CounterAdd"
5045         Type "ipt_bytes"
5046         Instance "total"
5047       </Match>
5048       <Match>
5049         Regex "\\<R=local_user\\>"
5050         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5051         DSType "CounterInc"
5052         Type "counter"
5053         Instance "local_user"
5054       </Match>
5055     </File>
5056   </Plugin>
5058 The config consists of one or more B<File> blocks, each of which configures one
5059 logfile to parse. Within each B<File> block, there are one or more B<Match>
5060 blocks, which configure a regular expression to search for.
5062 The B<Instance> option in the B<File> block may be used to set the plugin
5063 instance. So in the above example the plugin name C<tail-foo> would be used.
5064 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5065 next B<Instance> option. This way you can extract several plugin instances from
5066 one logfile, handy when parsing syslog and the like.
5068 Each B<Match> block has the following options to describe how the match should
5069 be performed:
5071 =over 4
5073 =item B<Regex> I<regex>
5075 Sets the regular expression to use for matching against a line. The first
5076 subexpression has to match something that can be turned into a number by
5077 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5078 below. Because B<extended> regular expressions are used, you do not need to use
5079 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5080 collectd's config parsing you need to escape backslashes, though. So if you
5081 want to match literal parentheses you need to do the following:
5083   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5085 =item B<ExcludeRegex> I<regex>
5087 Sets an optional regular expression to use for excluding lines from the match.
5088 An example which excludes all connections from localhost from the match:
5090   ExcludeRegex "127\\.0\\.0\\.1"
5092 =item B<DSType> I<Type>
5094 Sets how the values are cumulated. I<Type> is one of:
5096 =over 4
5098 =item B<GaugeAverage>
5100 Calculate the average.
5102 =item B<GaugeMin>
5104 Use the smallest number only.
5106 =item B<GaugeMax>
5108 Use the greatest number only.
5110 =item B<GaugeLast>
5112 Use the last number found.
5114 =item B<CounterSet>
5116 =item B<DeriveSet>
5118 =item B<AbsoluteSet>
5120 The matched number is a counter. Simply I<sets> the internal counter to this
5121 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5123 =item B<CounterAdd>
5125 =item B<DeriveAdd>
5127 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5128 matched number may be negative, which will effectively subtract from the
5129 internal counter.
5131 =item B<CounterInc>
5133 =item B<DeriveInc>
5135 Increase the internal counter by one. These B<DSType> are the only ones that do
5136 not use the matched subexpression, but simply count the number of matched
5137 lines. Thus, you may use a regular expression without submatch in this case.
5139 =back
5141 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5142 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5143 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5144 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5145 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5146 case.
5148 =item B<Type> I<Type>
5150 Sets the type used to dispatch this value. Detailed information about types and
5151 their configuration can be found in L<types.db(5)>.
5153 =item B<Instance> I<TypeInstance>
5155 This optional setting sets the type instance to use.
5157 =back
5159 =head2 Plugin C<tail_csv>
5161 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5162 written by I<Snort>.
5164 B<Synopsis:>
5166  <Plugin "tail_csv">
5167    <Metric "snort-dropped">
5168        Type "percent"
5169        Instance "dropped"
5170        Index 1
5171    </Metric>
5172    <File "/var/log/snort/snort.stats">
5173        Instance "snort-eth0"
5174        Interval 600
5175        Collect "snort-dropped"
5176    </File>
5177  </Plugin>
5179 The configuration consists of one or more B<Metric> blocks that define an index
5180 into the line of the CSV file and how this value is mapped to I<collectd's>
5181 internal representation. These are followed by one or more B<Instance> blocks
5182 which configure which file to read, in which interval and which metrics to
5183 extract.
5185 =over 4
5187 =item E<lt>B<Metric> I<Name>E<gt>
5189 The B<Metric> block configures a new metric to be extracted from the statistics
5190 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5191 only used inside the B<Instance> blocks to refer to this block, so you can use
5192 one B<Metric> block for multiple CSV files.
5194 =over 4
5196 =item B<Type> I<Type>
5198 Configures which I<Type> to use when dispatching this metric. Types are defined
5199 in the L<types.db(5)> file, see the appropriate manual page for more
5200 information on specifying types. Only types with a single I<data source> are
5201 supported by the I<tail_csv plugin>. The information whether the value is an
5202 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5203 I<Type's> definition.
5205 =item B<Instance> I<TypeInstance>
5207 If set, I<TypeInstance> is used to populate the type instance field of the
5208 created value lists. Otherwise, no type instance is used.
5210 =item B<ValueFrom> I<Index>
5212 Configure to read the value from the field with the zero-based index I<Index>.
5213 If the value is parsed as signed integer, unsigned integer or double depends on
5214 the B<Type> setting, see above.
5216 =back
5218 =item E<lt>B<File> I<Path>E<gt>
5220 Each B<File> block represents one CSV file to read. There must be at least one
5221 I<File> block but there can be multiple if you have multiple CSV files.
5223 =over 4
5225 =item B<Instance> I<PluginInstance>
5227 Sets the I<plugin instance> used when dispatching the values.
5229 =item B<Collect> I<Metric>
5231 Specifies which I<Metric> to collect. This option must be specified at least
5232 once, and you can use this option multiple times to specify more than one
5233 metric to be extracted from this statistic file.
5235 =item B<Interval> I<Seconds>
5237 Configures the interval in which to read values from this instance / file.
5238 Defaults to the plugin's default interval.
5240 =item B<TimeFrom> I<Index>
5242 Rather than using the local time when dispatching a value, read the timestamp
5243 from the field with the zero-based index I<Index>. The value is interpreted as
5244 seconds since epoch. The value is parsed as a double and may be factional.
5246 =back
5248 =back
5250 =head2 Plugin C<teamspeak2>
5252 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5253 polls interesting global and virtual server data. The plugin can query only one
5254 physical server but unlimited virtual servers. You can use the following
5255 options to configure it:
5257 =over 4
5259 =item B<Host> I<hostname/ip>
5261 The hostname or ip which identifies the physical server.
5262 Default: 127.0.0.1
5264 =item B<Port> I<port>
5266 The query port of the physical server. This needs to be a string.
5267 Default: "51234"
5269 =item B<Server> I<port>
5271 This option has to be added once for every virtual server the plugin should
5272 query. If you want to query the virtual server on port 8767 this is what the
5273 option would look like:
5275   Server "8767"
5277 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5278 use quotes around it! If no such statement is given only global information
5279 will be collected.
5281 =back
5283 =head2 Plugin C<ted>
5285 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5286 measure power consumption. These devices are usually connected to a serial
5287 (RS232) or USB port. The plugin opens a configured device and tries to read the
5288 current energy readings. For more information on TED, visit
5289 L<http://www.theenergydetective.com/>.
5291 Available configuration options:
5293 =over 4
5295 =item B<Device> I<Path>
5297 Path to the device on which TED is connected. collectd will need read and write
5298 permissions on that file.
5300 Default: B</dev/ttyUSB0>
5302 =item B<Retries> I<Num>
5304 Apparently reading from TED is not that reliable. You can therefore configure a
5305 number of retries here. You only configure the I<retries> here, to if you
5306 specify zero, one reading will be performed (but no retries if that fails); if
5307 you specify three, a maximum of four readings are performed. Negative values
5308 are illegal.
5310 Default: B<0>
5312 =back
5314 =head2 Plugin C<tcpconns>
5316 The C<tcpconns plugin> counts the number of currently established TCP
5317 connections based on the local port and/or the remote port. Since there may be
5318 a lot of connections the default if to count all connections with a local port,
5319 for which a listening socket is opened. You can use the following options to
5320 fine-tune the ports you are interested in:
5322 =over 4
5324 =item B<ListeningPorts> I<true>|I<false>
5326 If this option is set to I<true>, statistics for all local ports for which a
5327 listening socket exists are collected. The default depends on B<LocalPort> and
5328 B<RemotePort> (see below): If no port at all is specifically selected, the
5329 default is to collect listening ports. If specific ports (no matter if local or
5330 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5331 the selected ports will be collected unless this option is set to I<true>
5332 specifically.
5334 =item B<LocalPort> I<Port>
5336 Count the connections to a specific local port. This can be used to see how
5337 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5338 You have to specify the port in numeric form, so for the mailserver example
5339 you'd need to set B<25>.
5341 =item B<RemotePort> I<Port>
5343 Count the connections to a specific remote port. This is useful to see how
5344 much a remote service is used. This is most useful if you want to know how many
5345 connections a local service has opened to remote services, e.E<nbsp>g. how many
5346 connections a mail server or news server has to other mail or news servers, or
5347 how many connections a web proxy holds to web servers. You have to give the
5348 port in numeric form.
5350 =back
5352 =head2 Plugin C<thermal>
5354 =over 4
5356 =item B<ForceUseProcfs> I<true>|I<false>
5358 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5359 C<sysfs> interface. If that is not available, the plugin falls back to the
5360 C<procfs> interface. By setting this option to I<true>, you can force the
5361 plugin to use the latter. This option defaults to I<false>.
5363 =item B<Device> I<Device>
5365 Selects the name of the thermal device that you want to collect or ignore,
5366 depending on the value of the B<IgnoreSelected> option. This option may be
5367 used multiple times to specify a list of devices.
5369 =item B<IgnoreSelected> I<true>|I<false>
5371 Invert the selection: If set to true, all devices B<except> the ones that
5372 match the device names specified by the B<Device> option are collected. By
5373 default only selected devices are collected if a selection is made. If no
5374 selection is configured at all, B<all> devices are selected.
5376 =back
5378 =head2 Plugin C<threshold>
5380 The I<Threshold plugin> checks values collected or received by I<collectd>
5381 against a configurable I<threshold> and issues I<notifications> if values are
5382 out of bounds.
5384 Documentation for this plugin is available in the L<collectd-threshold(5)>
5385 manual page.
5387 =head2 Plugin C<tokyotyrant>
5389 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5390 couple metrics: number of records, and database size on disk.
5392 =over 4
5394 =item B<Host> I<Hostname/IP>
5396 The hostname or ip which identifies the server.
5397 Default: B<127.0.0.1>
5399 =item B<Port> I<Service/Port>
5401 The query port of the server. This needs to be a string, even if the port is
5402 given in its numeric form.
5403 Default: B<1978>
5405 =back
5407 =head2 Plugin C<unixsock>
5409 =over 4
5411 =item B<SocketFile> I<Path>
5413 Sets the socket-file which is to be created.
5415 =item B<SocketGroup> I<Group>
5417 If running as root change the group of the UNIX-socket after it has been
5418 created. Defaults to B<collectd>.
5420 =item B<SocketPerms> I<Permissions>
5422 Change the file permissions of the UNIX-socket after it has been created. The
5423 permissions must be given as a numeric, octal value as you would pass to
5424 L<chmod(1)>. Defaults to B<0770>.
5426 =item B<DeleteSocket> B<false>|B<true>
5428 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5429 with the given name already exists. If I<collectd> crashes a socket file may be
5430 left over, preventing the daemon from opening a new socket when restarted.
5431 Since this is potentially dangerous, this defaults to B<false>.
5433 =back
5435 =head2 Plugin C<uuid>
5437 This plugin, if loaded, causes the Hostname to be taken from the machine's
5438 UUID. The UUID is a universally unique designation for the machine, usually
5439 taken from the machine's BIOS. This is most useful if the machine is running in
5440 a virtual environment such as Xen, in which case the UUID is preserved across
5441 shutdowns and migration.
5443 The following methods are used to find the machine's UUID, in order:
5445 =over 4
5447 =item
5449 Check I</etc/uuid> (or I<UUIDFile>).
5451 =item
5453 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5454 present.
5456 =item
5458 Check for UUID from C<dmidecode> / SMBIOS.
5460 =item
5462 Check for UUID from Xen hypervisor.
5464 =back
5466 If no UUID can be found then the hostname is not modified.
5468 =over 4
5470 =item B<UUIDFile> I<Path>
5472 Take the UUID from the given file (default I</etc/uuid>).
5474 =back
5476 =head2 Plugin C<varnish>
5478 The Varnish plugin collects information about Varnish, an HTTP accelerator.
5480 =over 4
5482 =item B<CollectCache> B<true>|B<false>
5484 Cache hits and misses. True by default.
5486 =item B<CollectConnections> B<true>|B<false>
5488 Number of client connections received, accepted and dropped. True by default.
5490 =item B<CollectBackend> B<true>|B<false>
5492 Back-end connection statistics, such as successful, reused,
5493 and closed connections. True by default.
5495 =item B<CollectSHM> B<true>|B<false>
5497 Statistics about the shared memory log, a memory region to store
5498 log messages which is flushed to disk when full. True by default.
5500 =item B<CollectESI> B<true>|B<false>
5502 Edge Side Includes (ESI) parse statistics. False by default.
5504 =item B<CollectFetch> B<true>|B<false>
5506 Statistics about fetches (HTTP requests sent to the backend). False by default.
5508 =item B<CollectHCB> B<true>|B<false>
5510 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5511 divided into locked and unlocked look-ups. False by default.
5513 =item B<CollectSMA> B<true>|B<false>
5515 malloc or umem (umem_alloc(3MALLOC) based) storage statistics.
5516 The umem storage component is Solaris specific. False by default.
5518 =item B<CollectSMS> B<true>|B<false>
5520 synth (synthetic content) storage statistics. This storage
5521 component is used internally only. False by default.
5523 =item B<CollectSM> B<true>|B<false>
5525 file (memory mapped file) storage statistics. False by default.
5527 =item B<CollectTotals> B<true>|B<false>
5529 Collects overview counters, such as the number of sessions created,
5530 the number of requests and bytes transferred. False by default.
5532 =item B<CollectWorkers> B<true>|B<false>
5534 Collect statistics about worker threads. False by default.
5536 =back
5538 =head2 Plugin C<vmem>
5540 The C<vmem> plugin collects information about the usage of virtual memory.
5541 Since the statistics provided by the Linux kernel are very detailed, they are
5542 collected very detailed. However, to get all the details, you have to switch
5543 them on manually. Most people just want an overview over, such as the number of
5544 pages read from swap space.
5546 =over 4
5548 =item B<Verbose> B<true>|B<false>
5550 Enables verbose collection of information. This will start collecting page
5551 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
5552 Part of these statistics are collected on a "per zone" basis.
5554 =back
5556 =head2 Plugin C<vserver>
5558 This plugin doesn't have any options. B<VServer> support is only available for
5559 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
5560 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
5561 need to apply the patches and compile your own kernel, which will then provide
5562 the F</proc/virtual> filesystem that is required by this plugin.
5564 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
5566 B<Note>: The traffic collected by this plugin accounts for the amount of
5567 traffic passing a socket which might be a lot less than the actual on-wire
5568 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
5569 collect on-wire traffic you could, for example, use the logging facilities of
5570 iptables to feed data for the guest IPs into the iptables plugin.
5572 =head2 Plugin C<write_graphite>
5574 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
5575 storage and graphing project. The plugin connects to I<Carbon>, the data layer
5576 of I<Graphite>, and sends data via the "line based" protocol (per default using
5577 portE<nbsp>2003). The data will be sent in blocks of at most 1428 bytes to
5578 minimize the number of network packets.
5580 Synopsis:
5582  <Plugin write_graphite>
5583    <Node "example">
5584      Host "localhost"
5585      Port "2003"
5586      Prefix "collectd"
5587    </Node>
5588  </Plugin>
5590 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
5591 blocks. Inside the B<Node> blocks, the following options are recognized:
5593 =over 4
5595 =item B<Host> I<Address>
5597 Hostname or address to connect to. Defaults to C<localhost>.
5599 =item B<Port> I<Service>
5601 Service name or port number to connect to. Defaults to C<2003>.
5603 =item B<Prefix> I<String>
5605 When set, I<String> is added in front of the host name. Dots and whitespace are
5606 I<not> escaped in this string (see B<EscapeCharacter> below).
5608 =item B<Postfix> I<String>
5610 When set, I<String> is appended to the host name. Dots and whitespace are
5611 I<not> escaped in this string (see B<EscapeCharacter> below).
5613 =item B<EscapeCharacter> I<Char>
5615 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
5616 in the identifier. The B<EscapeCharacter> option determines which character
5617 dots, whitespace and control characters are replaced with. Defaults to
5618 underscore (C<_>).
5620 =item B<StoreRates> B<false>|B<true>
5622 If set to B<true> (the default), convert counter values to rates. If set to
5623 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5624 number.
5626 =item B<SeparateInstances> B<false>|B<true>
5628 If set to B<true>, the plugin instance and type instance will be in their own
5629 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5630 default), the plugin and plugin instance (and likewise the type and type
5631 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
5633 =item B<AlwaysAppendDS> B<false>|B<true>
5635 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5636 identifier. If set to B<false> (the default), this is only done when there is
5637 more than one DS.
5639 =back
5641 =head2 Plugin C<write_mongodb>
5643 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5644 NoSQL database.
5646 B<Synopsis:>
5648  <Plugin "write_mongodb">
5649    <Node "default">
5650      Host "localhost"
5651      Port "27017"
5652      Timeout 1000
5653      StoreRates true
5654    </Node>
5655  </Plugin>
5657 The plugin can send values to multiple instances of I<MongoDB> by specifying
5658 one B<Node> block for each instance. Within the B<Node> blocks, the following
5659 options are available:
5661 =over 4
5663 =item B<Host> I<Address>
5665 Hostname or address to connect to. Defaults to C<localhost>.
5667 =item B<Port> I<Service>
5669 Service name or port number to connect to. Defaults to C<27017>.
5671 =item B<Timeout> I<Timeout>
5673 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5674 Setting this option to zero means no timeout, which is the default.
5676 =item B<StoreRates> B<false>|B<true>
5678 If set to B<true> (the default), convert counter values to rates. If set to
5679 B<false> counter values are stored as is, i.e. as an increasing integer
5680 number.
5682 =item B<Database> I<Database>
5684 =item B<User> I<User>
5686 =item B<Password> I<Password>
5688 Sets the information used when authenticating to a I<MongoDB> database. The
5689 fields are optional (in which case no authentication is attempted), but if you
5690 want to use authentication all three fields must be set.
5692 =back
5694 =head2 Plugin C<write_http>
5696 This output plugin submits values to an http server by POST them using the
5697 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5698 have one B<URL> block, within which the destination can be configured further,
5699 for example by specifying authentication data.
5701 Synopsis:
5703  <Plugin "write_http">
5704    <URL "http://example.com/post-collectd">
5705      User "collectd"
5706      Password "weCh3ik0"
5707    </URL>
5708  </Plugin>
5710 B<URL> blocks need one string argument which is used as the URL to which data
5711 is posted. The following options are understood within B<URL> blocks.
5713 =over 4
5715 =item B<User> I<Username>
5717 Optional user name needed for authentication.
5719 =item B<Password> I<Password>
5721 Optional password needed for authentication.
5723 =item B<VerifyPeer> B<true>|B<false>
5725 Enable or disable peer SSL certificate verification. See
5726 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5728 =item B<VerifyHost> B<true|false>
5730 Enable or disable peer host name verification. If enabled, the plugin checks if
5731 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
5732 matches the host name provided by the B<URL> option. If this identity check
5733 fails, the connection is aborted. Obviously, only works when connecting to a
5734 SSL enabled server. Enabled by default.
5736 =item B<CACert> I<File>
5738 File that holds one or more SSL certificates. If you want to use HTTPS you will
5739 possibly need this option. What CA certificates come bundled with C<libcurl>
5740 and are checked by default depends on the distribution you use.
5742 =item B<Format> B<Command>|B<JSON>
5744 Format of the output to generate. If set to B<Command>, will create output that
5745 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
5746 create output in the I<JavaScript Object Notation> (JSON).
5748 Defaults to B<Command>.
5750 =item B<StoreRates> B<true|false>
5752 If set to B<true>, convert counter values to rates. If set to B<false> (the
5753 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
5754 number.
5756 =back
5758 =head2 Plugin C<write_riemann>
5760 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
5761 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
5762 I<Riemann> using UDP packets.
5764 Synopsis:
5766  <Plugin "write_riemann">
5767    <Node "example">
5768      Host "localhost"
5769      Port "5555"
5770      Protocol UDP
5771      StoreRates true
5772      AlwaysAppendDS false
5773      Delay 10
5774    </Node>
5775    Tag "foobar"
5776  </Plugin>
5778 The following options are understood by the I<write_riemann plugin>:
5780 =over 4
5782 =item E<lt>B<Node> I<Name>E<gt>
5784 The plugin's configuration consists of one or more B<Node> blocks. Each block
5785 is given a unique I<Name> and specifies one connection to an instance of
5786 I<Riemann>. Indise the B<Node> block, the following per-connection options are
5787 understood:
5789 =over 4
5791 =item B<Host> I<Address>
5793 Hostname or address to connect to. Defaults to C<localhost>.
5795 =item B<Port> I<Service>
5797 Service name or port number to connect to. Defaults to C<5555>.
5799 =item B<Protocol> B<UDP>|B<TCP>
5801 Specify the protocol to use when communicating with I<Riemann>. Defaults to
5802 B<UDP>.
5804 =item B<StoreRates> B<true>|B<false>
5806 If set to B<true> (the default), convert counter values to rates. If set to
5807 B<false> counter values are stored as is, i.e. as an increasing integer number.
5809 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
5810 converted values will have "rate" appended to the data source type, e.g.
5811 C<ds_type:derive:rate>.
5813 =item B<AlwaysAppendDS> B<false>|B<true>
5815 If set the B<true>, append the name of the I<Data Source> (DS) to the
5816 "service", i.e. the field that, together with the "host" field, uniquely
5817 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
5818 only done when there is more than one DS.
5820 =back
5822 =item B<Tag> I<String>
5824 Add the given string as an additional tag to the metric being sent to
5825 I<Riemann>.
5827 =back
5829 =head1 THRESHOLD CONFIGURATION
5831 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
5832 we mean that the values are not only stored or sent somewhere, but that they
5833 are judged and, if a problem is recognized, acted upon. The only action
5834 collectd takes itself is to generate and dispatch a "notification". Plugins can
5835 register to receive notifications and perform appropriate further actions.
5837 Since systems and what you expect them to do differ a lot, you can configure
5838 B<thresholds> for your values freely. This gives you a lot of flexibility but
5839 also a lot of responsibility.
5841 Every time a value is out of range a notification is dispatched. This means
5842 that the idle percentage of your CPU needs to be less then the configured
5843 threshold only once for a notification to be generated. There's no such thing
5844 as a moving average or similar - at least not now.
5846 Also, all values that match a threshold are considered to be relevant or
5847 "interesting". As a consequence collectd will issue a notification if they are
5848 not received for B<Timeout> iterations. The B<Timeout> configuration option is
5849 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
5850 "2" (the default) and some hosts sends it's CPU statistics to the server every
5851 60 seconds, a notification will be dispatched after about 120 seconds. It may
5852 take a little longer because the timeout is checked only once each B<Interval>
5853 on the server.
5855 When a value comes within range again or is received after it was missing, an
5856 "OKAY-notification" is dispatched.
5858 Here is a configuration example to get you started. Read below for more
5859 information.
5861  <Threshold>
5862    <Type "foo">
5863      WarningMin    0.00
5864      WarningMax 1000.00
5865      FailureMin    0.00
5866      FailureMax 1200.00
5867      Invert false
5868      Instance "bar"
5869    </Type>
5871    <Plugin "interface">
5872      Instance "eth0"
5873      <Type "if_octets">
5874        FailureMax 10000000
5875        DataSource "rx"
5876      </Type>
5877    </Plugin>
5879    <Host "hostname">
5880      <Type "cpu">
5881        Instance "idle"
5882        FailureMin 10
5883      </Type>
5885      <Plugin "memory">
5886        <Type "memory">
5887          Instance "cached"
5888          WarningMin 100000000
5889        </Type>
5890      </Plugin>
5891    </Host>
5892  </Threshold>
5894 There are basically two types of configuration statements: The C<Host>,
5895 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
5896 configured. The C<Plugin> and C<Type> blocks may be specified further using the
5897 C<Instance> option. You can combine the block by nesting the blocks, though
5898 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
5899 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
5900 C<Type> may not contain other blocks. If multiple blocks apply to the same
5901 value the most specific block is used.
5903 The other statements specify the threshold to configure. They B<must> be
5904 included in a C<Type> block. Currently the following statements are recognized:
5906 =over 4
5908 =item B<FailureMax> I<Value>
5910 =item B<WarningMax> I<Value>
5912 Sets the upper bound of acceptable values. If unset defaults to positive
5913 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
5914 will be created. If the value is greater than B<WarningMax> but less than (or
5915 equal to) B<FailureMax> a B<WARNING> notification will be created.
5917 =item B<FailureMin> I<Value>
5919 =item B<WarningMin> I<Value>
5921 Sets the lower bound of acceptable values. If unset defaults to negative
5922 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
5923 be created. If the value is less than B<WarningMin> but greater than (or equal
5924 to) B<FailureMin> a B<WARNING> notification will be created.
5926 =item B<DataSource> I<DSName>
5928 Some data sets have more than one "data source". Interesting examples are the
5929 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
5930 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
5931 system load data set, C<load>, even has three data sources: C<shortterm>,
5932 C<midterm>, and C<longterm>.
5934 Normally, all data sources are checked against a configured threshold. If this
5935 is undesirable, or if you want to specify different limits for each data
5936 source, you can use the B<DataSource> option to have a threshold apply only to
5937 one data source.
5939 =item B<Invert> B<true>|B<false>
5941 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
5942 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
5943 B<WarningMax>) are not okay. Defaults to B<false>.
5945 =item B<Persist> B<true>|B<false>
5947 Sets how often notifications are generated. If set to B<true> one notification
5948 will be generated for each value that is out of the acceptable range. If set to
5949 B<false> (the default) then a notification is only generated if a value is out
5950 of range but the previous value was okay.
5952 This applies to missing values, too: If set to B<true> a notification about a
5953 missing value is generated once every B<Interval> seconds. If set to B<false>
5954 only one such notification is generated until the value appears again.
5956 =item B<Percentage> B<true>|B<false>
5958 If set to B<true>, the minimum and maximum values given are interpreted as
5959 percentage value, relative to the other data sources. This is helpful for
5960 example for the "df" type, where you may want to issue a warning when less than
5961 5E<nbsp>% of the total space is available. Defaults to B<false>.
5963 =item B<Hits> I<Number>
5965 Delay creating the notification until the threshold has been passed I<Number>
5966 times. When a notification has been generated, or when a subsequent value is
5967 inside the threshold, the counter is reset. If, for example, a value is
5968 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
5969 will be dispatched at most once every 30E<nbsp>seconds.
5971 This is useful when short bursts are not a problem. If, for example, 100% CPU
5972 usage for up to a minute is normal (and data is collected every
5973 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
5975 =item B<Hysteresis> I<Number>
5977 When set to non-zero, a hysteresis value is applied when checking minimum and
5978 maximum bounds. This is useful for values that increase slowly and fluctuate a
5979 bit while doing so. When these values come close to the threshold, they may
5980 "flap", i.e. switch between failure / warning case and okay case repeatedly.
5982 If, for example, the threshold is configures as
5984   WarningMax 100.0
5985   Hysteresis 1.0
5987 then a I<Warning> notification is created when the value exceeds I<101> and the
5988 corresponding I<Okay> notification is only created once the value falls below
5989 I<99>, thus avoiding the "flapping".
5991 =back
5993 =head1 FILTER CONFIGURATION
5995 Starting with collectd 4.6 there is a powerful filtering infrastructure
5996 implemented in the daemon. The concept has mostly been copied from
5997 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
5998 terminology, so that users that are familiar with iptables feel right at home.
6000 =head2 Terminology
6002 The following are the terms used in the remainder of the filter configuration
6003 documentation. For an ASCII-art schema of the mechanism, see
6004 L<"General structure"> below.
6006 =over 4
6008 =item B<Match>
6010 A I<match> is a criteria to select specific values. Examples are, of course, the
6011 name of the value or it's current value.
6013 Matches are implemented in plugins which you have to load prior to using the
6014 match. The name of such plugins starts with the "match_" prefix.
6016 =item B<Target>
6018 A I<target> is some action that is to be performed with data. Such actions
6019 could, for example, be to change part of the value's identifier or to ignore
6020 the value completely.
6022 Some of these targets are built into the daemon, see L<"Built-in targets">
6023 below. Other targets are implemented in plugins which you have to load prior to
6024 using the target. The name of such plugins starts with the "target_" prefix.
6026 =item B<Rule>
6028 The combination of any number of matches and at least one target is called a
6029 I<rule>. The target actions will be performed for all values for which B<all>
6030 matches apply. If the rule does not have any matches associated with it, the
6031 target action will be performed for all values.
6033 =item B<Chain>
6035 A I<chain> is a list of rules and possibly default targets. The rules are tried
6036 in order and if one matches, the associated target will be called. If a value
6037 is handled by a rule, it depends on the target whether or not any subsequent
6038 rules are considered or if traversal of the chain is aborted, see
6039 L<"Flow control"> below. After all rules have been checked, the default targets
6040 will be executed.
6042 =back
6044 =head2 General structure
6046 The following shows the resulting structure:
6048  +---------+
6049  ! Chain   !
6050  +---------+
6051       !
6052       V
6053  +---------+  +---------+  +---------+  +---------+
6054  ! Rule    !->! Match   !->! Match   !->! Target  !
6055  +---------+  +---------+  +---------+  +---------+
6056       !
6057       V
6058  +---------+  +---------+  +---------+
6059  ! Rule    !->! Target  !->! Target  !
6060  +---------+  +---------+  +---------+
6061       !
6062       V
6063       :
6064       :
6065       !
6066       V
6067  +---------+  +---------+  +---------+
6068  ! Rule    !->! Match   !->! Target  !
6069  +---------+  +---------+  +---------+
6070       !
6071       V
6072  +---------+
6073  ! Default !
6074  ! Target  !
6075  +---------+
6077 =head2 Flow control
6079 There are four ways to control which way a value takes through the filter
6080 mechanism:
6082 =over 4
6084 =item B<jump>
6086 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6087 process the value with another chain. When the called chain finishes, usually
6088 the next target or rule after the jump is executed.
6090 =item B<stop>
6092 The stop condition, signaled for example by the built-in target B<stop>, causes
6093 all processing of the value to be stopped immediately.
6095 =item B<return>
6097 Causes processing in the current chain to be aborted, but processing of the
6098 value generally will continue. This means that if the chain was called via
6099 B<Jump>, the next target or rule after the jump will be executed. If the chain
6100 was not called by another chain, control will be returned to the daemon and it
6101 may pass the value to another chain.
6103 =item B<continue>
6105 Most targets will signal the B<continue> condition, meaning that processing
6106 should continue normally. There is no special built-in target for this
6107 condition.
6109 =back
6111 =head2 Synopsis
6113 The configuration reflects this structure directly:
6115  PostCacheChain "PostCache"
6116  <Chain "PostCache">
6117    <Rule "ignore_mysql_show">
6118      <Match "regex">
6119        Plugin "^mysql$"
6120        Type "^mysql_command$"
6121        TypeInstance "^show_"
6122      </Match>
6123      <Target "stop">
6124      </Target>
6125    </Rule>
6126    <Target "write">
6127      Plugin "rrdtool"
6128    </Target>
6129  </Chain>
6131 The above configuration example will ignore all values where the plugin field
6132 is "mysql", the type is "mysql_command" and the type instance begins with
6133 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6134 default target of the chain. Since this chain is run after the value has been
6135 added to the cache, the MySQL C<show_*> command statistics will be available
6136 via the C<unixsock> plugin.
6138 =head2 List of configuration options
6140 =over 4
6142 =item B<PreCacheChain> I<ChainName>
6144 =item B<PostCacheChain> I<ChainName>
6146 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6147 argument is the name of a I<chain> that should be executed before and/or after
6148 the values have been added to the cache.
6150 To understand the implications, it's important you know what is going on inside
6151 I<collectd>. The following diagram shows how values are passed from the
6152 read-plugins to the write-plugins:
6154    +---------------+
6155    !  Read-Plugin  !
6156    +-------+-------+
6157            !
6158  + - - - - V - - - - +
6159  : +---------------+ :
6160  : !   Pre-Cache   ! :
6161  : !     Chain     ! :
6162  : +-------+-------+ :
6163  :         !         :
6164  :         V         :
6165  : +-------+-------+ :  +---------------+
6166  : !     Cache     !--->!  Value Cache  !
6167  : !     insert    ! :  +---+---+-------+
6168  : +-------+-------+ :      !   !
6169  :         !   ,------------'   !
6170  :         V   V     :          V
6171  : +-------+---+---+ :  +-------+-------+
6172  : !  Post-Cache   +--->! Write-Plugins !
6173  : !     Chain     ! :  +---------------+
6174  : +---------------+ :
6175  :                   :
6176  :  dispatch values  :
6177  + - - - - - - - - - +
6179 After the values are passed from the "read" plugins to the dispatch functions,
6180 the pre-cache chain is run first. The values are added to the internal cache
6181 afterwards. The post-cache chain is run after the values have been added to the
6182 cache. So why is it such a huge deal if chains are run before or after the
6183 values have been added to this cache?
6185 Targets that change the identifier of a value list should be executed before
6186 the values are added to the cache, so that the name in the cache matches the
6187 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6188 this cache to receive a list of all available values. If you change the
6189 identifier after the value list has been added to the cache, this may easily
6190 lead to confusion, but it's not forbidden of course.
6192 The cache is also used to convert counter values to rates. These rates are, for
6193 example, used by the C<value> match (see below). If you use the rate stored in
6194 the cache B<before> the new value is added, you will use the old, B<previous>
6195 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6196 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6197 command.
6199 Last but not last, the B<stop> target makes a difference: If the pre-cache
6200 chain returns the stop condition, the value will not be added to the cache and
6201 the post-cache chain will not be run.
6203 =item B<Chain> I<Name>
6205 Adds a new chain with a certain name. This name can be used to refer to a
6206 specific chain, for example to jump to it.
6208 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6210 =item B<Rule> [I<Name>]
6212 Adds a new rule to the current chain. The name of the rule is optional and
6213 currently has no meaning for the daemon.
6215 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6216 must be at least one B<Target> block.
6218 =item B<Match> I<Name>
6220 Adds a match to a B<Rule> block. The name specifies what kind of match should
6221 be performed. Available matches depend on the plugins that have been loaded.
6223 The arguments inside the B<Match> block are passed to the plugin implementing
6224 the match, so which arguments are valid here depends on the plugin being used.
6225 If you do not need any to pass any arguments to a match, you can use the
6226 shorter syntax:
6228  Match "foobar"
6230 Which is equivalent to:
6232  <Match "foobar">
6233  </Match>
6235 =item B<Target> I<Name>
6237 Add a target to a rule or a default target to a chain. The name specifies what
6238 kind of target is to be added. Which targets are available depends on the
6239 plugins being loaded.
6241 The arguments inside the B<Target> block are passed to the plugin implementing
6242 the target, so which arguments are valid here depends on the plugin being used.
6243 If you do not need any to pass any arguments to a target, you can use the
6244 shorter syntax:
6246  Target "stop"
6248 This is the same as writing:
6250  <Target "stop">
6251  </Target>
6253 =back
6255 =head2 Built-in targets
6257 The following targets are built into the core daemon and therefore need no
6258 plugins to be loaded:
6260 =over 4
6262 =item B<return>
6264 Signals the "return" condition, see the L<"Flow control"> section above. This
6265 causes the current chain to stop processing the value and returns control to
6266 the calling chain. The calling chain will continue processing targets and rules
6267 just after the B<jump> target (see below). This is very similar to the
6268 B<RETURN> target of iptables, see L<iptables(8)>.
6270 This target does not have any options.
6272 Example:
6274  Target "return"
6276 =item B<stop>
6278 Signals the "stop" condition, see the L<"Flow control"> section above. This
6279 causes processing of the value to be aborted immediately. This is similar to
6280 the B<DROP> target of iptables, see L<iptables(8)>.
6282 This target does not have any options.
6284 Example:
6286  Target "stop"
6288 =item B<write>
6290 Sends the value to "write" plugins.
6292 Available options:
6294 =over 4
6296 =item B<Plugin> I<Name>
6298 Name of the write plugin to which the data should be sent. This option may be
6299 given multiple times to send the data to more than one write plugin.
6301 =back
6303 If no plugin is explicitly specified, the values will be sent to all available
6304 write plugins.
6306 Example:
6308  <Target "write">
6309    Plugin "rrdtool"
6310  </Target>
6312 =item B<jump>
6314 Starts processing the rules of another chain, see L<"Flow control"> above. If
6315 the end of that chain is reached, or a stop condition is encountered,
6316 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6317 next target or the next rule. This is similar to the B<-j> command line option
6318 of iptables, see L<iptables(8)>.
6320 Available options:
6322 =over 4
6324 =item B<Chain> I<Name>
6326 Jumps to the chain I<Name>. This argument is required and may appear only once.
6328 =back
6330 Example:
6332  <Target "jump">
6333    Chain "foobar"
6334  </Target>
6336 =back
6338 =head2 Available matches
6340 =over 4
6342 =item B<regex>
6344 Matches a value using regular expressions.
6346 Available options:
6348 =over 4
6350 =item B<Host> I<Regex>
6352 =item B<Plugin> I<Regex>
6354 =item B<PluginInstance> I<Regex>
6356 =item B<Type> I<Regex>
6358 =item B<TypeInstance> I<Regex>
6360 Match values where the given regular expressions match the various fields of
6361 the identifier of a value. If multiple regular expressions are given, B<all>
6362 regexen must match for a value to match.
6364 =item B<Invert> B<false>|B<true>
6366 When set to B<true>, the result of the match is inverted, i.e. all value lists
6367 where all regular expressions apply are not matched, all other value lists are
6368 matched. Defaults to B<false>.
6370 =back
6372 Example:
6374  <Match "regex">
6375    Host "customer[0-9]+"
6376    Plugin "^foobar$"
6377  </Match>
6379 =item B<timediff>
6381 Matches values that have a time which differs from the time on the server.
6383 This match is mainly intended for servers that receive values over the
6384 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6385 is very sensitive to the timestamp used when updating the RRD files. In
6386 particular, the time must be ever increasing. If a misbehaving client sends one
6387 packet with a timestamp far in the future, all further packets with a correct
6388 time will be ignored because of that one packet. What's worse, such corrupted
6389 RRD files are hard to fix.
6391 This match lets one match all values B<outside> a specified time range
6392 (relative to the server's time), so you can use the B<stop> target (see below)
6393 to ignore the value, for example.
6395 Available options:
6397 =over 4
6399 =item B<Future> I<Seconds>
6401 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6402 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6403 non-zero.
6405 =item B<Past> I<Seconds>
6407 Matches all values that are I<behind> of the server's time by I<Seconds> or
6408 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6409 non-zero.
6411 =back
6413 Example:
6415  <Match "timediff">
6416    Future  300
6417    Past   3600
6418  </Match>
6420 This example matches all values that are five minutes or more ahead of the
6421 server or one hour (or more) lagging behind.
6423 =item B<value>
6425 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6426 values. If a data-set consists of more than one data-source, all data-sources
6427 must match the specified ranges for a positive match.
6429 Available options:
6431 =over 4
6433 =item B<Min> I<Value>
6435 Sets the smallest value which still results in a match. If unset, behaves like
6436 negative infinity.
6438 =item B<Max> I<Value>
6440 Sets the largest value which still results in a match. If unset, behaves like
6441 positive infinity.
6443 =item B<Invert> B<true>|B<false>
6445 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6446 no-match is returned and vice versa. Please note that the B<Invert> setting
6447 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6448 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6450 =item B<DataSource> I<DSName> [I<DSName> ...]
6452 Select one or more of the data sources. If no data source is configured, all
6453 data sources will be checked. If the type handled by the match does not have a
6454 data source of the specified name(s), this will always result in no match
6455 (independent of the B<Invert> setting).
6457 =item B<Satisfy> B<Any>|B<All>
6459 Specifies how checking with several data sources is performed. If set to
6460 B<Any>, the match succeeds if one of the data sources is in the configured
6461 range. If set to B<All> the match only succeeds if all data sources are within
6462 the configured range. Default is B<All>.
6464 Usually B<All> is used for positive matches, B<Any> is used for negative
6465 matches. This means that with B<All> you usually check that all values are in a
6466 "good" range, while with B<Any> you check if any value is within a "bad" range
6467 (or outside the "good" range).
6469 =back
6471 Either B<Min> or B<Max>, but not both, may be unset.
6473 Example:
6475  # Match all values smaller than or equal to 100. Matches only if all data
6476  # sources are below 100.
6477  <Match "value">
6478    Max 100
6479    Satisfy "All"
6480  </Match>
6481  
6482  # Match if the value of any data source is outside the range of 0 - 100.
6483  <Match "value">
6484    Min   0
6485    Max 100
6486    Invert true
6487    Satisfy "Any"
6488  </Match>
6490 =item B<empty_counter>
6492 Matches all values with one or more data sources of type B<COUNTER> and where
6493 all counter values are zero. These counters usually I<never> increased since
6494 they started existing (and are therefore uninteresting), or got reset recently
6495 or overflowed and you had really, I<really> bad luck.
6497 Please keep in mind that ignoring such counters can result in confusing
6498 behavior: Counters which hardly ever increase will be zero for long periods of
6499 time. If the counter is reset for some reason (machine or service restarted,
6500 usually), the graph will be empty (NAN) for a long time. People may not
6501 understand why.
6503 =item B<hashed>
6505 Calculates a hash value of the host name and matches values according to that
6506 hash value. This makes it possible to divide all hosts into groups and match
6507 only values that are in a specific group. The intended use is in load
6508 balancing, where you want to handle only part of all data and leave the rest
6509 for other servers.
6511 The hashing function used tries to distribute the hosts evenly. First, it
6512 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
6514   hash_value = 0;
6515   for (i = 0; host[i] != 0; i++)
6516     hash_value = (hash_value * 251) + host[i];
6518 The constant 251 is a prime number which is supposed to make this hash value
6519 more random. The code then checks the group for this host according to the
6520 I<Total> and I<Match> arguments:
6522   if ((hash_value % Total) == Match)
6523     matches;
6524   else
6525     does not match;
6527 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
6528 groups), then the least significant bit of the hash value will be the XOR of
6529 all least significant bits in the host name. One consequence is that when you
6530 have two hosts, "server0.example.com" and "server1.example.com", where the host
6531 name differs in one digit only and the digits differ by one, those hosts will
6532 never end up in the same group.
6534 Available options:
6536 =over 4
6538 =item B<Match> I<Match> I<Total>
6540 Divide the data into I<Total> groups and match all hosts in group I<Match> as
6541 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
6542 be smaller than I<Total>. I<Total> must be at least one, although only values
6543 greater than one really do make any sense.
6545 You can repeat this option to match multiple groups, for example:
6547   Match 3 7
6548   Match 5 7
6550 The above config will divide the data into seven groups and match groups three
6551 and five. One use would be to keep every value on two hosts so that if one
6552 fails the missing data can later be reconstructed from the second host.
6554 =back
6556 Example:
6558  # Operate on the pre-cache chain, so that ignored values are not even in the
6559  # global cache.
6560  <Chain "PreCache">
6561    <Rule>
6562      <Match "hashed">
6563        # Divide all received hosts in seven groups and accept all hosts in
6564        # group three.
6565        Match 3 7
6566      </Match>
6567      # If matched: Return and continue.
6568      Target "return"
6569    </Rule>
6570    # If not matched: Return and stop.
6571    Target "stop"
6572  </Chain>
6574 =back
6576 =head2 Available targets
6578 =over 4
6580 =item B<notification>
6582 Creates and dispatches a notification.
6584 Available options:
6586 =over 4
6588 =item B<Message> I<String>
6590 This required option sets the message of the notification. The following
6591 placeholders will be replaced by an appropriate value:
6593 =over 4
6595 =item B<%{host}>
6597 =item B<%{plugin}>
6599 =item B<%{plugin_instance}>
6601 =item B<%{type}>
6603 =item B<%{type_instance}>
6605 These placeholders are replaced by the identifier field of the same name.
6607 =item B<%{ds:>I<name>B<}>
6609 These placeholders are replaced by a (hopefully) human readable representation
6610 of the current rate of this data source. If you changed the instance name
6611 (using the B<set> or B<replace> targets, see below), it may not be possible to
6612 convert counter values to rates.
6614 =back
6616 Please note that these placeholders are B<case sensitive>!
6618 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
6620 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
6621 used.
6623 =back
6625 Example:
6627   <Target "notification">
6628     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
6629     Severity "WARNING"
6630   </Target>
6632 =item B<replace>
6634 Replaces parts of the identifier using regular expressions.
6636 Available options:
6638 =over 4
6640 =item B<Host> I<Regex> I<Replacement>
6642 =item B<Plugin> I<Regex> I<Replacement>
6644 =item B<PluginInstance> I<Regex> I<Replacement>
6646 =item B<TypeInstance> I<Regex> I<Replacement>
6648 Match the appropriate field with the given regular expression I<Regex>. If the
6649 regular expression matches, that part that matches is replaced with
6650 I<Replacement>. If multiple places of the input buffer match a given regular
6651 expression, only the first occurrence will be replaced.
6653 You can specify each option multiple times to use multiple regular expressions
6654 one after another.
6656 =back
6658 Example:
6660  <Target "replace">
6661    # Replace "example.net" with "example.com"
6662    Host "\\<example.net\\>" "example.com"
6663  
6664    # Strip "www." from hostnames
6665    Host "\\<www\\." ""
6666  </Target>
6668 =item B<set>
6670 Sets part of the identifier of a value to a given string.
6672 Available options:
6674 =over 4
6676 =item B<Host> I<String>
6678 =item B<Plugin> I<String>
6680 =item B<PluginInstance> I<String>
6682 =item B<TypeInstance> I<String>
6684 Set the appropriate field to the given string. The strings for plugin instance
6685 and type instance may be empty, the strings for host and plugin may not be
6686 empty. It's currently not possible to set the type of a value this way.
6688 =back
6690 Example:
6692  <Target "set">
6693    PluginInstance "coretemp"
6694    TypeInstance "core3"
6695  </Target>
6697 =back
6699 =head2 Backwards compatibility
6701 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6702 B<Chain> block, it will behave as it used to. This is equivalent to the
6703 following configuration:
6705  <Chain "PostCache">
6706    Target "write"
6707  </Chain>
6709 If you specify a B<PostCacheChain>, the B<write> target will not be added
6710 anywhere and you will have to make sure that it is called where appropriate. We
6711 suggest to add the above snippet as default target to your "PostCache" chain.
6713 =head2 Examples
6715 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
6716 be an FQDN.
6718  <Chain "PreCache">
6719    <Rule "no_fqdn">
6720      <Match "regex">
6721        Host "^[^\.]*$"
6722      </Match>
6723      Target "stop"
6724    </Rule>
6725    Target "write"
6726  </Chain>
6728 =head1 SEE ALSO
6730 L<collectd(1)>,
6731 L<collectd-exec(5)>,
6732 L<collectd-perl(5)>,
6733 L<collectd-unixsock(5)>,
6734 L<types.db(5)>,
6735 L<hddtemp(8)>,
6736 L<iptables(8)>,
6737 L<kstat(3KSTAT)>,
6738 L<mbmon(1)>,
6739 L<psql(1)>,
6740 L<regex(7)>,
6741 L<rrdtool(1)>,
6742 L<sensors(1)>
6744 =head1 AUTHOR
6746 Florian Forster E<lt>octo@verplant.orgE<gt>
6748 =cut