Code

Merge branch 'fix-stringio-python2.7' of git://github.com/aelse/collectd
[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>. This is required to load plugins, unless the
72 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
73 I<collectd> will be mostly useless.
75 Only the first B<LoadPlugin> statement or block for a given plugin name has any
76 effect. This is useful when you want to split up the configuration into smaller
77 files and want each file to be "self contained", i.e. it contains a B<Plugin>
78 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
79 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
80 different intervals, only one of them (the first one encountered) will take
81 effect and all others will be silently ignored.
83 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
84 with additional options, affecting the behavior of B<LoadPlugin>. A simple
85 statement looks like this:
87  LoadPlugin "cpu"
89 Options inside a B<LoadPlugin> block can override default settings and
90 influence the way plugins are loaded, e.g.:
92  <LoadPlugin perl>
93    Globals true
94    Interval 60
95  </LoadPlugin>
97 The following options are valid inside B<LoadPlugin> blocks:
99 =over 4
101 =item B<Globals> B<true|false>
103 If enabled, collectd will export all global symbols of the plugin (and of all
104 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
105 available for resolving unresolved symbols in subsequently loaded plugins if
106 that is supported by your system.
108 This is useful (or possibly even required), e.g., when loading a plugin that
109 embeds some scripting language into the daemon (e.g. the I<Perl> and
110 I<Python plugins>). Scripting languages usually provide means to load
111 extensions written in C. Those extensions require symbols provided by the
112 interpreter, which is loaded as a dependency of the respective collectd plugin.
113 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
114 L<collectd-python(5)>) for details.
116 By default, this is disabled. As a special exception, if the plugin name is
117 either C<perl> or C<python>, the default is changed to enabled in order to keep
118 the average user from ever having to deal with this low level linking stuff.
120 =item B<Interval> I<Seconds>
122 Sets a plugin-specific interval for collecting metrics. This overrides the
123 global B<Interval> setting. If a plugin provides own support for specifying an
124 interval, that setting will take precedence.
126 =back
128 =item B<AutoLoadPlugin> B<false>|B<true>
130 When set to B<false> (the default), each plugin needs to be loaded explicitly,
131 using the B<LoadPlugin> statement documented above. If a
132 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
133 handling callback for this plugin has been registered, a warning is logged and
134 the block is ignored.
136 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
137 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
138 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
139 plugins that don't provide any configuration, e.g. the I<Load plugin>.
141 =item B<Include> I<Path> [I<pattern>]
143 If I<Path> points to a file, includes that file. If I<Path> points to a
144 directory, recursively includes all files within that directory and its
145 subdirectories. If the C<wordexp> function is available on your system,
146 shell-like wildcards are expanded before files are included. This means you can
147 use statements like the following:
149   Include "/etc/collectd.d/*.conf"
151 If the C<fnmatch> function is available on your system, a shell-like wildcard
152 I<pattern> may be specified to filter which files to include. This may be used
153 in combination with recursively including a directory to easily be able to
154 arbitrarily mix configuration files and other documents (e.g. README files).
155 The following statement is similar to the example above but includes all files
156 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
158   Include "/etc/collectd.d" "*.conf"
160 If more than one files are included by a single B<Include> option, the files
161 will be included in lexicographical order (as defined by the C<strcmp>
162 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
163 order in which the files are loaded.
165 To prevent loops and shooting yourself in the foot in interesting ways the
166 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
167 most uses. Since symlinks are followed it is still possible to crash the daemon
168 by looping symlinks. In our opinion significant stupidity should result in an
169 appropriate amount of pain.
171 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
172 file, but you cannot include files from within blocks.
174 =item B<PIDFile> I<File>
176 Sets where to write the PID file to. This file is overwritten when it exists
177 and deleted when the program is stopped. Some init-scripts might override this
178 setting using the B<-P> command-line option.
180 =item B<PluginDir> I<Directory>
182 Path to the plugins (shared objects) of collectd.
184 =item B<TypesDB> I<File> [I<File> ...]
186 Set one or more files that contain the data-set descriptions. See
187 L<types.db(5)> for a description of the format of this file.
189 =item B<Interval> I<Seconds>
191 Configures the interval in which to query the read plugins. Obviously smaller
192 values lead to a higher system load produced by collectd, while higher values
193 lead to more coarse statistics.
195 B<Warning:> You should set this once and then never touch it again. If you do,
196 I<you will have to delete all your RRD files> or know some serious RRDtool
197 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
199 =item B<Timeout> I<Iterations>
201 Consider a value list "missing" when no update has been read or received for
202 I<Iterations> iterations. By default, I<collectd> considers a value list
203 missing when no update has been received for twice the update interval. Since
204 this setting uses iterations, the maximum allowed time without update depends
205 on the I<Interval> information contained in each value list. This is used in
206 the I<Threshold> configuration to dispatch notifications about missing values,
207 see L<collectd-threshold(5)> for details.
209 =item B<ReadThreads> I<Num>
211 Number of threads to start for reading plugins. The default value is B<5>, but
212 you may want to increase this if you have more than five plugins that take a
213 long time to read. Mostly those are plugins that do network-IO. Setting this to
214 a value higher than the number of registered read callbacks is not recommended.
216 =item B<WriteThreads> I<Num>
218 Number of threads to start for dispatching value lists to write plugins. The
219 default value is B<5>, but you may want to increase this if you have more than
220 five plugins that may take relatively long to write to.
222 =item B<Hostname> I<Name>
224 Sets the hostname that identifies a host. If you omit this setting, the
225 hostname will be determined using the L<gethostname(2)> system call.
227 =item B<FQDNLookup> B<true|false>
229 If B<Hostname> is determined automatically this setting controls whether or not
230 the daemon should try to figure out the "fully qualified domain name", FQDN.
231 This is done using a lookup of the name returned by C<gethostname>. This option
232 is enabled by default.
234 =item B<PreCacheChain> I<ChainName>
236 =item B<PostCacheChain> I<ChainName>
238 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
239 see L<FILTER CONFIGURATION> below on information on chains and how these
240 setting change the daemon's behavior.
242 =back
244 =head1 PLUGIN OPTIONS
246 Some plugins may register own options. These options must be enclosed in a
247 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
248 require external configuration, too. The C<apache plugin>, for example,
249 required C<mod_status> to be configured in the webserver you're going to
250 collect data from. These plugins are listed below as well, even if they don't
251 require any configuration within collectd's configuration file.
253 A list of all plugins and a short summary for each plugin can be found in the
254 F<README> file shipped with the sourcecode and hopefully binary packets as
255 well.
257 =head2 Plugin C<aggregation>
259 The I<Aggregation plugin> makes it possible to aggregate several values into
260 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
261 This can be put to a wide variety of uses, e.g. average and total CPU
262 statistics for your entire fleet.
264 The grouping is powerful but, as with many powerful tools, may be a bit
265 difficult to wrap your head around. The grouping will therefore be
266 demonstrated using an example: The average and sum of the CPU usage across
267 all CPUs of each host is to be calculated.
269 To select all the affected values for our example, set C<Plugin cpu> and
270 C<Type cpu>. The other values are left unspecified, meaning "all values". The
271 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
272 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
273 statement.
275   Plugin "cpu"
276   Type "cpu"
278 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...)  and
279 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
280 example, the intention is to have a new value for each host / type instance
281 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
282 It can be specified multiple times to group by more than one field.
284   GroupBy "Host"
285   GroupBy "TypeInstance"
287 We do neither specify nor group by I<plugin instance> (the CPU number), so all
288 metrics that differ in the CPU number only will be aggregated. Each
289 aggregation needs I<at least one> such field, otherwise no aggregation would
290 take place.
292 The full example configuration looks like this:
294  <Plugin "aggregation">
295    <Aggregation>
296      Plugin "cpu"
297      Type "cpu"
298      
299      GroupBy "Host"
300      GroupBy "TypeInstance"
301      
302      CalculateSum true
303      CalculateAverage true
304    </Aggregation>
305  </Plugin>
307 There are a couple of limitations you should be aware of:
309 =over 4
311 =item
313 The I<Type> cannot be left unspecified, because it is not reasonable to add
314 apples to oranges. Also, the internal lookup structure won't work if you try
315 to group by type.
317 =item
319 There must be at least one unspecified, ungrouped field. Otherwise nothing
320 will be aggregated.
322 =back
324 As you can see in the example above, each aggregation has its own
325 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
326 blocks may match the same values, i.e. one value list can update multiple
327 aggregations. The following options are valid inside B<Aggregation> blocks:
329 =over 4
331 =item B<Host> I<Host>
333 =item B<Plugin> I<Plugin>
335 =item B<PluginInstance> I<PluginInstance>
337 =item B<Type> I<Type>
339 =item B<TypeInstance> I<TypeInstance>
341 Selects the value lists to be added to this aggregation. B<Type> must be a
342 valid data set name, see L<types.db(5)> for details.
344 If the string starts with and ends with a slash (C</>), the string is
345 interpreted as a I<regular expression>. The regex flavor used are POSIX
346 extended regular expressions as described in L<regex(7)>. Example usage:
348  Host "/^db[0-9]\\.example\\.com$/"
350 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
352 Group valued by the specified field. The B<GroupBy> option may be repeated to
353 group by multiple fields.
355 =item B<SetHost> I<Host>
357 =item B<SetPlugin> I<Plugin>
359 =item B<SetPluginInstance> I<PluginInstance>
361 =item B<SetTypeInstance> I<TypeInstance>
363 Sets the appropriate part of the identifier to the provided string.
365 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
366 will be replaced with the aggregation function, e.g. "average". Not including
367 the placeholder will result in duplication warnings and/or messed up values if
368 more than one aggregation function are enabled.
370 The following example calculates the average usage of all "even" CPUs:
372  <Plugin "aggregation">
373    <Aggregation>
374      Plugin "cpu"
375      PluginInstance "/[0,2,4,6,8]$/"
376      Type "cpu"
377      
378      SetPlugin "cpu"
379      SetPluginInstance "even-%{aggregation}"
380      
381      GroupBy "Host"
382      GroupBy "TypeInstance"
383      
384      CalculateAverage true
385    </Aggregation>
386  </Plugin>
388 This will create the files:
390 =over 4
392 =item
394 foo.example.com/cpu-even-average/cpu-idle
396 =item
398 foo.example.com/cpu-even-average/cpu-system
400 =item
402 foo.example.com/cpu-even-average/cpu-user
404 =item
406 ...
408 =back
410 =item B<CalculateNum> B<true>|B<false>
412 =item B<CalculateSum> B<true>|B<false>
414 =item B<CalculateAverage> B<true>|B<false>
416 =item B<CalculateMinimum> B<true>|B<false>
418 =item B<CalculateMaximum> B<true>|B<false>
420 =item B<CalculateStddev> B<true>|B<false>
422 Boolean options for enabling calculation of the number of value lists, their
423 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
424 are disabled by default.
426 =back
428 =head2 Plugin C<amqp>
430 The I<AMQMP plugin> can be used to communicate with other instances of
431 I<collectd> or third party applications using an AMQP message broker. Values
432 are sent to or received from the broker, which handles routing, queueing and
433 possibly filtering or messages.
435  <Plugin "amqp">
436    # Send values to an AMQP broker
437    <Publish "some_name">
438      Host "localhost"
439      Port "5672"
440      VHost "/"
441      User "guest"
442      Password "guest"
443      Exchange "amq.fanout"
444  #   ExchangeType "fanout"
445  #   RoutingKey "collectd"
446  #   Persistent false
447  #   Format "command"
448  #   StoreRates false
449  #   GraphitePrefix "collectd."
450  #   GraphiteEscapeChar "_"
451    </Publish>
452    
453    # Receive values from an AMQP broker
454    <Subscribe "some_name">
455      Host "localhost"
456      Port "5672"
457      VHost "/"
458      User "guest"
459      Password "guest"
460      Exchange "amq.fanout"
461  #   ExchangeType "fanout"
462  #   Queue "queue_name"
463  #   RoutingKey "collectd.#"
464    </Subscribe>
465  </Plugin>
467 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
468 blocks, which configure sending and receiving of values respectively. The two
469 blocks are very similar, so unless otherwise noted, an option can be used in
470 either block. The name given in the blocks starting tag is only used for
471 reporting messages, but may be used to support I<flushing> of certain
472 I<Publish> blocks in the future.
474 =over 4
476 =item B<Host> I<Host>
478 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
479 the underlying communications library, I<rabbitmq-c>, which is "localhost".
481 =item B<Port> I<Port>
483 Service name or port number on which the AMQP broker accepts connections. This
484 argument must be a string, even if the numeric form is used. Defaults to
485 "5672".
487 =item B<VHost> I<VHost>
489 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
491 =item B<User> I<User>
493 =item B<Password> I<Password>
495 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
496 is used.
498 =item B<Exchange> I<Exchange>
500 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
501 By default, "amq.fanout" will be used.
503 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
504 the given exchange and the I<queue> is created, using the I<routing key> if
505 configured. See the B<Queue> and B<RoutingKey> options below.
507 =item B<ExchangeType> I<Type>
509 If given, the plugin will try to create the configured I<exchange> with this
510 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
511 be bound to this exchange.
513 =item B<Queue> I<Queue> (Subscribe only)
515 Configures the I<queue> name to subscribe to. If no queue name was configures
516 explicitly, a unique queue name will be created by the broker.
518 =item B<RoutingKey> I<Key>
520 In I<Publish> blocks, this configures the routing key to set on all outgoing
521 messages. If not given, the routing key will be computed from the I<identifier>
522 of the value. The host, plugin, type and the two instances are concatenated
523 together using dots as the separator and all containing dots replaced with
524 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
525 possible to receive only specific values using a "topic" exchange.
527 In I<Subscribe> blocks, configures the I<routing key> used when creating a
528 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
529 used to filter messages when using a "topic" exchange. If you're only
530 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
531 for example.
533 =item B<Persistent> B<true>|B<false> (Publish only)
535 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
536 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
537 default), the I<transient> delivery mode will be used, i.e. messages may be
538 lost due to high load, overflowing queues or similar issues.
540 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
542 Selects the format in which messages are sent to the broker. If set to
543 B<Command> (the default), values are sent as C<PUTVAL> commands which are
544 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
545 case, the C<Content-Type> header field will be set to C<text/collectd>.
547 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
548 an easy and straight forward exchange format. The C<Content-Type> header field
549 will be set to C<application/json>.
551 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
552 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
553 C<text/graphite>.
555 A subscribing client I<should> use the C<Content-Type> header field to
556 determine how to decode the values. Currently, the I<AMQP plugin> itself can
557 only decode the B<Command> format.
559 =item B<StoreRates> B<true>|B<false> (Publish only)
561 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
562 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
563 default), no conversion is performed. Otherwise the conversion is performed
564 using the internal value cache.
566 Please note that currently this option is only used if the B<Format> option has
567 been set to B<JSON>.
569 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
571 A prefix can be added in the metric name when outputting in the I<Graphite> format.
572 It's added before the I<Host> name.
573 Metric name will be "<prefix><host><postfix><plugin><type><name>"
575 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
577 A postfix can be added in the metric name when outputting in the I<Graphite> format.
578 It's added after the I<Host> name.
579 Metric name will be "<prefix><host><postfix><plugin><type><name>"
581 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
583 Specify a character to replace dots (.) in the host part of the metric name.
584 In I<Graphite> metric name, dots are used as separators between different
585 metric parts (host, plugin, type).
586 Default is "_" (I<Underscore>).
588 =back
590 =head2 Plugin C<apache>
592 To configure the C<apache>-plugin you first need to configure the Apache
593 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
594 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
595 the following snipped to base your Apache config upon:
597   ExtendedStatus on
598   <IfModule mod_status.c>
599     <Location /mod_status>
600       SetHandler server-status
601     </Location>
602   </IfModule>
604 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
605 also supported. It introduces a new field, called C<BusyServers>, to count the
606 number of currently connected clients. This field is also supported.
608 The configuration of the I<Apache> plugin consists of one or more
609 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
610 as the instance name. For example:
612  <Plugin "apache">
613    <Instance "www1">
614      URL "http://www1.example.com/mod_status?auto"
615    </Instance>
616    <Instance "www2">
617      URL "http://www2.example.com/mod_status?auto"
618    </Instance>
619  </Plugin>
621 The instance name will be used as the I<plugin instance>. To emulate the old
622 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
623 plugin to work correctly, each instance name must be unique. This is not
624 enforced by the plugin and it is your responsibility to ensure it.
626 The following options are accepted within each I<Instance> block:
628 =over 4
630 =item B<URL> I<http://host/mod_status?auto>
632 Sets the URL of the C<mod_status> output. This needs to be the output generated
633 by C<ExtendedStatus on> and it needs to be the machine readable output
634 generated by appending the C<?auto> argument. This option is I<mandatory>.
636 =item B<User> I<Username>
638 Optional user name needed for authentication.
640 =item B<Password> I<Password>
642 Optional password needed for authentication.
644 =item B<VerifyPeer> B<true|false>
646 Enable or disable peer SSL certificate verification. See
647 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
649 =item B<VerifyHost> B<true|false>
651 Enable or disable peer host name verification. If enabled, the plugin checks
652 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
653 certificate matches the host name provided by the B<URL> option. If this
654 identity check fails, the connection is aborted. Obviously, only works when
655 connecting to a SSL enabled server. Enabled by default.
657 =item B<CACert> I<File>
659 File that holds one or more SSL certificates. If you want to use HTTPS you will
660 possibly need this option. What CA certificates come bundled with C<libcurl>
661 and are checked by default depends on the distribution you use.
663 =back
665 =head2 Plugin C<apcups>
667 =over 4
669 =item B<Host> I<Hostname>
671 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
672 that IPv6 support has been disabled unless someone can confirm or decline that
673 B<apcupsd> can handle it.
675 =item B<Port> I<Port>
677 TCP-Port to connect to. Defaults to B<3551>.
679 =item B<ReportSeconds> B<true|false>
681 If set to B<true>, the time reported in the C<timeleft> metric will be
682 converted to seconds. This is the recommended setting. If set to B<false>, the
683 default for backwards compatibility, the time will be reported in minutes.
685 =back
687 =head2 Plugin C<ascent>
689 This plugin collects information about an Ascent server, a free server for the
690 "World of Warcraft" game. This plugin gathers the information by fetching the
691 XML status page using C<libcurl> and parses it using C<libxml2>.
693 The configuration options are the same as for the C<apache> plugin above:
695 =over 4
697 =item B<URL> I<http://localhost/ascent/status/>
699 Sets the URL of the XML status output.
701 =item B<User> I<Username>
703 Optional user name needed for authentication.
705 =item B<Password> I<Password>
707 Optional password needed for authentication.
709 =item B<VerifyPeer> B<true|false>
711 Enable or disable peer SSL certificate verification. See
712 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
714 =item B<VerifyHost> B<true|false>
716 Enable or disable peer host name verification. If enabled, the plugin checks
717 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
718 certificate matches the host name provided by the B<URL> option. If this
719 identity check fails, the connection is aborted. Obviously, only works when
720 connecting to a SSL enabled server. Enabled by default.
722 =item B<CACert> I<File>
724 File that holds one or more SSL certificates. If you want to use HTTPS you will
725 possibly need this option. What CA certificates come bundled with C<libcurl>
726 and are checked by default depends on the distribution you use.
728 =back
730 =head2 Plugin C<bind>
732 Starting with BIND 9.5.0, the most widely used DNS server software provides
733 extensive statistics about queries, responses and lots of other information.
734 The bind plugin retrieves this information that's encoded in XML and provided
735 via HTTP and submits the values to collectd.
737 To use this plugin, you first need to tell BIND to make this information
738 available. This is done with the C<statistics-channels> configuration option:
740  statistics-channels {
741    inet localhost port 8053;
742  };
744 The configuration follows the grouping that can be seen when looking at the
745 data with an XSLT compatible viewer, such as a modern web browser. It's
746 probably a good idea to make yourself familiar with the provided values, so you
747 can understand what the collected statistics actually mean.
749 Synopsis:
751  <Plugin "bind">
752    URL "http://localhost:8053/"
753    ParseTime       false
754    OpCodes         true
755    QTypes          true
756  
757    ServerStats     true
758    ZoneMaintStats  true
759    ResolverStats   false
760    MemoryStats     true
761  
762    <View "_default">
763      QTypes        true
764      ResolverStats true
765      CacheRRSets   true
766  
767      Zone "127.in-addr.arpa/IN"
768    </View>
769  </Plugin>
771 The bind plugin accepts the following configuration options:
773 =over 4
775 =item B<URL> I<URL>
777 URL from which to retrieve the XML data. If not specified,
778 C<http://localhost:8053/> will be used.
780 =item B<ParseTime> B<true>|B<false>
782 When set to B<true>, the time provided by BIND will be parsed and used to
783 dispatch the values. When set to B<false>, the local time source is queried.
785 This setting is set to B<true> by default for backwards compatibility; setting
786 this to B<false> is I<recommended> to avoid problems with timezones and
787 localization.
789 =item B<OpCodes> B<true>|B<false>
791 When enabled, statistics about the I<"OpCodes">, for example the number of
792 C<QUERY> packets, are collected.
794 Default: Enabled.
796 =item B<QTypes> B<true>|B<false>
798 When enabled, the number of I<incoming> queries by query types (for example
799 C<A>, C<MX>, C<AAAA>) is collected.
801 Default: Enabled.
803 =item B<ServerStats> B<true>|B<false>
805 Collect global server statistics, such as requests received over IPv4 and IPv6,
806 successful queries, and failed updates.
808 Default: Enabled.
810 =item B<ZoneMaintStats> B<true>|B<false>
812 Collect zone maintenance statistics, mostly information about notifications
813 (zone updates) and zone transfers.
815 Default: Enabled.
817 =item B<ResolverStats> B<true>|B<false>
819 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
820 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
821 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
822 default. Use the B<ResolverStats> option within a B<View "_default"> block
823 instead for the same functionality.
825 Default: Disabled.
827 =item B<MemoryStats>
829 Collect global memory statistics.
831 Default: Enabled.
833 =item B<View> I<Name>
835 Collect statistics about a specific I<"view">. BIND can behave different,
836 mostly depending on the source IP-address of the request. These different
837 configurations are called "views". If you don't use this feature, you most
838 likely are only interested in the C<_default> view.
840 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
841 information you want to collect about a view. If no B<View> block is
842 configured, no detailed view statistics will be collected.
844 =over 4
846 =item B<QTypes> B<true>|B<false>
848 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
849 C<MX>) is collected.
851 Default: Enabled.
853 =item B<ResolverStats> B<true>|B<false>
855 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
856 (e.E<nbsp>g. queries over IPv4, lame servers).
858 Default: Enabled.
860 =item B<CacheRRSets> B<true>|B<false>
862 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
863 type is collected. Negative entries (queries which resulted in an error, for
864 example names that do not exist) are reported with a leading exclamation mark,
865 e.E<nbsp>g. "!A".
867 Default: Enabled.
869 =item B<Zone> I<Name>
871 When given, collect detailed information about the given zone in the view. The
872 information collected if very similar to the global B<ServerStats> information
873 (see above).
875 You can repeat this option to collect detailed information about multiple
876 zones.
878 By default no detailed zone information is collected.
880 =back
882 =back
884 =head2 Plugin C<cgroups>
886 This plugin collects the CPU user/system time for each I<cgroup> by reading the
887 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
888 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
890 =over 4
892 =item B<CGroup> I<Directory>
894 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
895 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
896 see below.
898 =item B<IgnoreSelected> B<true>|B<false>
900 Invert the selection: If set to true, all cgroups I<except> the ones that
901 match any one of the criteria are collected. By default only selected
902 cgroups are collected if a selection is made. If no selection is configured
903 at all, B<all> cgroups are selected.
905 =back
907 =head2 Plugin C<cpufreq>
909 This plugin doesn't have any options. It reads
910 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
911 installed) to get the current CPU frequency. If this file does not exist make
912 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
913 installed and an "cpu governor" (that's a kernel module) is loaded.
915 =head2 Plugin C<csv>
917 =over 4
919 =item B<DataDir> I<Directory>
921 Set the directory to store CSV-files under. Per default CSV-files are generated
922 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
923 The special strings B<stdout> and B<stderr> can be used to write to the standard
924 output and standard error channels, respectively. This, of course, only makes
925 much sense when collectd is running in foreground- or non-daemon-mode.
927 =item B<StoreRates> B<true|false>
929 If set to B<true>, convert counter values to rates. If set to B<false> (the
930 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
931 number.
933 =back
935 =head2 Plugin C<curl>
937 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
938 and the match infrastructure (the same code used by the tail plugin) to use
939 regular expressions with the received data.
941 The following example will read the current value of AMD stock from Google's
942 finance page and dispatch the value to collectd.
944   <Plugin curl>
945     <Page "stock_quotes">
946       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
947       User "foo"
948       Password "bar"
949       <Match>
950         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
951         DSType "GaugeAverage"
952         # Note: `stock_value' is not a standard type.
953         Type "stock_value"
954         Instance "AMD"
955       </Match>
956     </Page>
957   </Plugin>
959 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
960 a web page and one or more "matches" to be performed on the returned data. The
961 string argument to the B<Page> block is used as plugin instance.
963 The following options are valid within B<Page> blocks:
965 =over 4
967 =item B<URL> I<URL>
969 URL of the web site to retrieve. Since a regular expression will be used to
970 extract information from this data, non-binary data is a big plus here ;)
972 =item B<User> I<Name>
974 Username to use if authorization is required to read the page.
976 =item B<Password> I<Password>
978 Password to use if authorization is required to read the page.
980 =item B<VerifyPeer> B<true>|B<false>
982 Enable or disable peer SSL certificate verification. See
983 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
985 =item B<VerifyHost> B<true>|B<false>
987 Enable or disable peer host name verification. If enabled, the plugin checks if
988 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
989 matches the host name provided by the B<URL> option. If this identity check
990 fails, the connection is aborted. Obviously, only works when connecting to a
991 SSL enabled server. Enabled by default.
993 =item B<CACert> I<file>
995 File that holds one or more SSL certificates. If you want to use HTTPS you will
996 possibly need this option. What CA certificates come bundled with C<libcurl>
997 and are checked by default depends on the distribution you use.
999 =item B<Header> I<Header>
1001 A HTTP header to add to the request. Multiple headers are added if this option
1002 is specified more than once.
1004 =item B<Post> I<Body>
1006 Specifies that the HTTP operation should be a POST instead of a GET. The
1007 complete data to be posted is given as the argument.  This option will usually
1008 need to be accompanied by a B<Header> option to set an appropriate
1009 C<Content-Type> for the post body (e.g. to
1010 C<application/x-www-form-urlencoded>).
1012 =item B<MeasureResponseTime> B<true>|B<false>
1014 Measure response time for the request. If this setting is enabled, B<Match>
1015 blocks (see below) are optional. Disabled by default.
1017 =item B<E<lt>MatchE<gt>>
1019 One or more B<Match> blocks that define how to match information in the data
1020 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1021 used by the C<tail> plugin, so please see the documentation of the C<tail>
1022 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1023 is set to B<true>, B<Match> blocks are optional.
1025 =back
1027 =head2 Plugin C<curl_json>
1029 The B<curl_json plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and
1030 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) to retrieve JSON data
1031 via cURL. This can be used to collect values from CouchDB documents (which are
1032 stored JSON notation), for example.
1034 The following example will collect several values from the built-in `_stats'
1035 runtime statistics module of CouchDB
1036 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1038   <Plugin curl_json>
1039     <URL "http://localhost:5984/_stats">
1040       Instance "httpd"
1041       <Key "httpd/requests/count">
1042         Type "http_requests"
1043       </Key>
1045       <Key "httpd_request_methods/*/count">
1046         Type "http_request_methods"
1047       </Key>
1049       <Key "httpd_status_codes/*/count">
1050         Type "http_response_codes"
1051       </Key>
1052     </URL>
1053   </Plugin>
1055 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining
1056 a URL to be fetched via HTTP (using libcurl) and one or more B<Key> blocks.
1057 The B<Key> string argument must be in a path format, which is used to collect a
1058 value from a JSON map object. If a path element of B<Key> is the
1059 I<*>E<nbsp>wildcard, the values for all keys will be collectd.
1061 The following options are valid within B<URL> blocks:
1063 =over 4
1065 =item B<Instance> I<Instance>
1067 Sets the plugin instance to I<Instance>.
1069 =item B<User> I<Name>
1070 =item B<Password> I<Password>
1071 =item B<VerifyPeer> B<true>|B<false>
1072 =item B<VerifyHost> B<true>|B<false>
1073 =item B<CACert> I<file>
1074 =item B<Header> I<Header>
1075 =item B<Post> I<Body>
1077 These options behave exactly equivalent to the appropriate options of the
1078 I<cURL> plugin. Please see there for a detailed description.
1080 =back
1082 The following options are valid within B<Key> blocks:
1084 =over 4
1086 =item B<Type> I<Type>
1088 Sets the type used to dispatch the values to the daemon. Detailed information
1089 about types and their configuration can be found in L<types.db(5)>. This
1090 option is mandatory.
1092 =item B<Instance> I<Instance>
1094 Type-instance to use. Defaults to the current map key or current string array element value.
1096 =back
1098 =head2 Plugin C<curl_xml>
1100 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1101 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1103  <Plugin "curl_xml">
1104    <URL "http://localhost/stats.xml">
1105      Host "my_host"
1106      Instance "some_instance"
1107      User "collectd"
1108      Password "thaiNg0I"
1109      VerifyPeer true
1110      VerifyHost true
1111      CACert "/path/to/ca.crt"
1113      <XPath "table[@id=\"magic_level\"]/tr">
1114        Type "magic_level"
1115        #InstancePrefix "prefix-"
1116        InstanceFrom "td[1]"
1117        ValuesFrom "td[2]/span[@class=\"level\"]"
1118      </XPath>
1119    </URL>
1120  </Plugin>
1122 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1123 URL to be fetched using libcurl. Within each B<URL> block there are
1124 options which specify the connection parameters, for example authentication
1125 information, and one or more B<XPath> blocks.
1127 Each B<XPath> block specifies how to get one type of information. The
1128 string argument must be a valid XPath expression which returns a list
1129 of "base elements". One value is dispatched for each "base element". The
1130 I<type instance> and values are looked up using further I<XPath> expressions
1131 that should be relative to the base element.
1133 Within the B<URL> block the following options are accepted:
1135 =over 4
1137 =item B<Host> I<Name>
1139 Use I<Name> as the host name when submitting values. Defaults to the global
1140 host name setting.
1142 =item B<Instance> I<Instance>
1144 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1145 empty string (no plugin instance).
1147 =item B<Namespace> I<Prefix> I<URL>
1149 If an XPath expression references namespaces, they must be specified
1150 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1151 I<URL> is the "namespace name", an URI reference uniquely identifying the
1152 namespace. The option can be repeated to register multiple namespaces.
1154 Examples:
1156   Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1157   Namespace "m" "http://www.w3.org/1998/Math/MathML"
1159 =item B<User> I<User>
1161 =item B<Password> I<Password>
1163 =item B<VerifyPeer> B<true>|B<false>
1165 =item B<VerifyHost> B<true>|B<false>
1167 =item B<CACert> I<CA Cert File>
1169 =item B<Header> I<Header>
1171 =item B<Post> I<Body>
1173 These options behave exactly equivalent to the appropriate options of the
1174 I<cURL plugin>. Please see there for a detailed description.
1176 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1178 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1179 B<XPath> block specifies how to get one type of information. The string
1180 argument must be a valid XPath expression which returns a list of "base
1181 elements". One value is dispatched for each "base element".
1183 Within the B<XPath> block the following options are accepted:
1185 =over 4
1187 =item B<Type> I<Type>
1189 Specifies the I<Type> used for submitting patches. This determines the number
1190 of values that are required / expected and whether the strings are parsed as
1191 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1192 This option is required.
1194 =item B<InstancePrefix> I<InstancePrefix>
1196 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1197 concatenated together without any separator.
1198 This option is optional.
1200 =item B<InstanceFrom> I<InstanceFrom>
1202 Specifies a XPath expression to use for determining the I<type instance>. The
1203 XPath expression must return exactly one element. The element's value is then
1204 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1206 This value is required. As a special exception, if the "base XPath expression"
1207 (the argument to the B<XPath> block) returns exactly one argument, then this
1208 option may be omitted.
1210 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1212 Specifies one or more XPath expression to use for reading the values. The
1213 number of XPath expressions must match the number of data sources in the
1214 I<type> specified with B<Type> (see above). Each XPath expression must return
1215 exactly one element. The element's value is then parsed as a number and used as
1216 value for the appropriate value in the value list dispatched to the daemon.
1218 =back
1220 =back
1222 =head2 Plugin C<dbi>
1224 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1225 connect to various databases, execute I<SQL> statements and read back the
1226 results. I<dbi> is an acronym for "database interface" in case you were
1227 wondering about the name. You can configure how each column is to be
1228 interpreted and the plugin will generate one or more data sets from each row
1229 returned according to these rules.
1231 Because the plugin is very generic, the configuration is a little more complex
1232 than those of other plugins. It usually looks something like this:
1234   <Plugin dbi>
1235     <Query "out_of_stock">
1236       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1237       # Use with MySQL 5.0.0 or later
1238       MinVersion 50000
1239       <Result>
1240         Type "gauge"
1241         InstancePrefix "out_of_stock"
1242         InstancesFrom "category"
1243         ValuesFrom "value"
1244       </Result>
1245     </Query>
1246     <Database "product_information">
1247       Driver "mysql"
1248       DriverOption "host" "localhost"
1249       DriverOption "username" "collectd"
1250       DriverOption "password" "aZo6daiw"
1251       DriverOption "dbname" "prod_info"
1252       SelectDB "prod_info"
1253       Query "out_of_stock"
1254     </Database>
1255   </Plugin>
1257 The configuration above defines one query with one result and one database. The
1258 query is then linked to the database with the B<Query> option I<within> the
1259 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1260 and you can also use the B<Include> statement to split up the configuration
1261 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1262 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1263 top to bottom!
1265 The following is a complete list of options:
1267 =head3 B<Query> blocks
1269 Query blocks define I<SQL> statements and how the returned data should be
1270 interpreted. They are identified by the name that is given in the opening line
1271 of the block. Thus the name needs to be unique. Other than that, the name is
1272 not used in collectd.
1274 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1275 define which column holds which value or instance information. You can use
1276 multiple B<Result> blocks to create multiple values from one returned row. This
1277 is especially useful, when queries take a long time and sending almost the same
1278 query again and again is not desirable.
1280 Example:
1282   <Query "environment">
1283     Statement "select station, temperature, humidity from environment"
1284     <Result>
1285       Type "temperature"
1286       # InstancePrefix "foo"
1287       InstancesFrom "station"
1288       ValuesFrom "temperature"
1289     </Result>
1290     <Result>
1291       Type "humidity"
1292       InstancesFrom "station"
1293       ValuesFrom "humidity"
1294     </Result>
1295   </Query>
1297 The following options are accepted:
1299 =over 4
1301 =item B<Statement> I<SQL>
1303 Sets the statement that should be executed on the server. This is B<not>
1304 interpreted by collectd, but simply passed to the database server. Therefore,
1305 the SQL dialect that's used depends on the server collectd is connected to.
1307 The query has to return at least two columns, one for the instance and one
1308 value. You cannot omit the instance, even if the statement is guaranteed to
1309 always return exactly one line. In that case, you can usually specify something
1310 like this:
1312   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1314 (That works with MySQL but may not be valid SQL according to the spec. If you
1315 use a more strict database server, you may have to select from a dummy table or
1316 something.)
1318 Please note that some databases, for example B<Oracle>, will fail if you
1319 include a semicolon at the end of the statement.
1321 =item B<MinVersion> I<Version>
1323 =item B<MaxVersion> I<Value>
1325 Only use this query for the specified database version. You can use these
1326 options to provide multiple queries with the same name but with a slightly
1327 different syntax. The plugin will use only those queries, where the specified
1328 minimum and maximum versions fit the version of the database in use.
1330 The database version is determined by C<dbi_conn_get_engine_version>, see the
1331 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1332 for details. Basically, each part of the version is assumed to be in the range
1333 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1334 "40102", version "5.0.42" becomes "50042".
1336 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1337 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1338 happen. Don't to it! A valid example would be something along these lines:
1340   MinVersion 40000
1341   MaxVersion 49999
1342   ...
1343   MinVersion 50000
1344   MaxVersion 50099
1345   ...
1346   MinVersion 50100
1347   # No maximum
1349 In the above example, there are three ranges that don't overlap. The last one
1350 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1351 before "4.0.0" are not specified.
1353 =item B<Type> I<Type>
1355 The B<type> that's used for each line returned. See L<types.db(5)> for more
1356 details on how types are defined. In short: A type is a predefined layout of
1357 data and the number of values and type of values has to match the type
1358 definition.
1360 If you specify "temperature" here, you need exactly one gauge column. If you
1361 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1362 setting below.
1364 There must be exactly one B<Type> option inside each B<Result> block.
1366 =item B<InstancePrefix> I<prefix>
1368 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1369 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1370 all strings returned in the appropriate columns are concatenated together,
1371 separated by dashes I<("-")>.
1373 =item B<InstancesFrom> I<column0> [I<column1> ...]
1375 Specifies the columns whose values will be used to create the "type-instance"
1376 for each row. If you specify more than one column, the value of all columns
1377 will be joined together with dashes I<("-")> as separation characters.
1379 The plugin itself does not check whether or not all built instances are
1380 different. It's your responsibility to assure that each is unique. This is
1381 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1382 sure that only one row is returned in this case.
1384 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1385 will be empty.
1387 =item B<ValuesFrom> I<column0> [I<column1> ...]
1389 Names the columns whose content is used as the actual data for the data sets
1390 that are dispatched to the daemon. How many such columns you need is determined
1391 by the B<Type> setting above. If you specify too many or not enough columns,
1392 the plugin will complain about that and no data will be submitted to the
1393 daemon.
1395 The actual data type in the columns is not that important. The plugin will
1396 automatically cast the values to the right type if it know how to do that. So
1397 it should be able to handle integer an floating point types, as well as strings
1398 (if they include a number at the beginning).
1400 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1402 =back
1404 =head3 B<Database> blocks
1406 Database blocks define a connection to a database and which queries should be
1407 sent to that database. Since the used "dbi" library can handle a wide variety
1408 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1409 documentationE<nbsp>- we stick as close to the terminology used there.
1411 Each database needs a "name" as string argument in the starting tag of the
1412 block. This name will be used as "PluginInstance" in the values submitted to
1413 the daemon. Other than that, that name is not used.
1415 =over 4
1417 =item B<Driver> I<Driver>
1419 Specifies the driver to use to connect to the database. In many cases those
1420 drivers are named after the database they can connect to, but this is not a
1421 technical necessity. These drivers are sometimes referred to as "DBD",
1422 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1423 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1424 project at L<http://libdbi-drivers.sourceforge.net/>.
1426 You need to give the driver name as expected by the "dbi" library here. You
1427 should be able to find that in the documentation for each driver. If you
1428 mistype the driver name, the plugin will dump a list of all known driver names
1429 to the log.
1431 =item B<DriverOption> I<Key> I<Value>
1433 Sets driver-specific options. What option a driver supports can be found in the
1434 documentation for each driver, somewhere at
1435 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1436 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1438 DBDs can register two types of options: String options and numeric options. The
1439 plugin will use the C<dbi_conn_set_option> function when the configuration
1440 provides a string and the C<dbi_conn_require_option_numeric> function when the
1441 configuration provides a number. So these two lines will actually result in
1442 different calls being used:
1444   DriverOption "Port" 1234      # numeric
1445   DriverOption "Port" "1234"    # string
1447 Unfortunately, drivers are not too keen to report errors when an unknown option
1448 is passed to them, so invalid settings here may go unnoticed. This is not the
1449 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1450 the driver. If a driver complains about an option, the plugin will dump a
1451 complete list of all options understood by that driver to the log. There is no
1452 way to programatically find out if an option expects a string or a numeric
1453 argument, so you will have to refer to the appropriate DBD's documentation to
1454 find this out. Sorry.
1456 =item B<SelectDB> I<Database>
1458 In some cases, the database name you connect with is not the database name you
1459 want to use for querying data. If this option is set, the plugin will "select"
1460 (switch to) that database after the connection is established.
1462 =item B<Query> I<QueryName>
1464 Associates the query named I<QueryName> with this database connection. The
1465 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1466 blocks you want to refer to must be placed above the database block you want to
1467 refer to them from.
1469 =item B<Host> I<Hostname>
1471 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1472 values. Defaults to the global hostname setting.
1474 =back
1476 =head2 Plugin C<df>
1478 =over 4
1480 =item B<Device> I<Device>
1482 Select partitions based on the devicename.
1484 =item B<MountPoint> I<Directory>
1486 Select partitions based on the mountpoint.
1488 =item B<FSType> I<FSType>
1490 Select partitions based on the filesystem type.
1492 =item B<IgnoreSelected> B<true>|B<false>
1494 Invert the selection: If set to true, all partitions B<except> the ones that
1495 match any one of the criteria are collected. By default only selected
1496 partitions are collected if a selection is made. If no selection is configured
1497 at all, B<all> partitions are selected.
1499 =item B<ReportByDevice> B<true>|B<false>
1501 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1502 (the default), it will report a disk as "root", but with it I<true>, it will be
1503 "sda1" (or whichever).
1505 =item B<ReportInodes> B<true>|B<false>
1507 Enables or disables reporting of free, reserved and used inodes. Defaults to
1508 inode collection being disabled.
1510 Enable this option if inodes are a scarce resource for you, usually because
1511 many small files are stored on the disk. This is a usual scenario for mail
1512 transfer agents and web caches.
1514 =item B<ValuesAbsolute> B<true>|B<false>
1516 Enables or disables reporting of free, used and used disk space in 1K-blocks. 
1517 Defaults to true.
1519 =item B<ValuesPercentage> B<true>|B<false>
1521 Enables or disables reporting of free, used and used disk space in percentage.
1522 Defaults to false.
1524 This is useful for deploying collectd on the cloud, where machines with
1525 different disk size may exist. Then it is more practical to configure thresholds
1526 based on relative disk size.
1528 =back
1530 =head2 Plugin C<disk>
1532 The C<disk> plugin collects information about the usage of physical disks and
1533 logical disks (partitions). Values collected are the number of octets written
1534 to and read from a disk or partition, the number of read/write operations
1535 issued to the disk and a rather complex "time" it took for these commands to be
1536 issued.
1538 Using the following two options you can ignore some disks or configure the
1539 collection only of specific disks.
1541 =over 4
1543 =item B<Disk> I<Name>
1545 Select the disk I<Name>. Whether it is collected or ignored depends on the
1546 B<IgnoreSelected> setting, see below. As with other plugins that use the
1547 daemon's ignorelist functionality, a string that starts and ends with a slash
1548 is interpreted as a regular expression. Examples:
1550   Disk "sdd"
1551   Disk "/hda[34]/"
1553 =item B<IgnoreSelected> B<true>|B<false>
1555 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1556 statements, are ignored or if all other disks are ignored. The behavior
1557 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1558 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1559 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1560 is set to B<true>, all disks are collected B<except> the ones matched.
1562 =back
1564 =head2 Plugin C<dns>
1566 =over 4
1568 =item B<Interface> I<Interface>
1570 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1571 option sets the interface that should be used. If this option is not set, or
1572 set to "any", the plugin will try to get packets from B<all> interfaces. This
1573 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1575 =item B<IgnoreSource> I<IP-address>
1577 Ignore packets that originate from this address.
1579 =item B<SelectNumericQueryTypes> B<true>|B<false>
1581 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1583 =back
1585 =head2 Plugin C<email>
1587 =over 4
1589 =item B<SocketFile> I<Path>
1591 Sets the socket-file which is to be created.
1593 =item B<SocketGroup> I<Group>
1595 If running as root change the group of the UNIX-socket after it has been
1596 created. Defaults to B<collectd>.
1598 =item B<SocketPerms> I<Permissions>
1600 Change the file permissions of the UNIX-socket after it has been created. The
1601 permissions must be given as a numeric, octal value as you would pass to
1602 L<chmod(1)>. Defaults to B<0770>.
1604 =item B<MaxConns> I<Number>
1606 Sets the maximum number of connections that can be handled in parallel. Since
1607 this many threads will be started immediately setting this to a very high
1608 value will waste valuable resources. Defaults to B<5> and will be forced to be
1609 at most B<16384> to prevent typos and dumb mistakes.
1611 =back
1613 =head2 Plugin C<ethstat>
1615 The I<ethstat plugin> collects information about network interface cards (NICs)
1616 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1618 B<Synopsis:>
1620  <Plugin "ethstat">
1621    Interface "eth0"
1622    Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1623    Map "multicast" "if_multicast"
1624  </Plugin>
1626 B<Options:>
1628 =over 4
1630 =item B<Interface> I<Name>
1632 Collect statistical information about interface I<Name>.
1634 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1636 By default, the plugin will submit values as type C<derive> and I<type
1637 instance> set to I<Name>, the name of the metric as reported by the driver. If
1638 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1639 I<TypeInstance> will be used.
1641 =item B<MappedOnly> B<true>|B<false>
1643 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1644 collected, all other metrics will be ignored. Defaults to B<false>.
1646 =back
1648 =head2 Plugin C<exec>
1650 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1651 contains valuable information on when the executable is executed and the
1652 output that is expected from it.
1654 =over 4
1656 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1658 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1660 Execute the executable I<Executable> as user I<User>. If the user name is
1661 followed by a colon and a group name, the effective group is set to that group.
1662 The real group and saved-set group will be set to the default group of that
1663 user. If no group is given the effective group ID will be the same as the real
1664 group ID.
1666 Please note that in order to change the user and/or group the daemon needs
1667 superuser privileges. If the daemon is run as an unprivileged user you must
1668 specify the same user/group here. If the daemon is run with superuser
1669 privileges, you must supply a non-root user here.
1671 The executable may be followed by optional arguments that are passed to the
1672 program. Please note that due to the configuration parsing numbers and boolean
1673 values may be changed. If you want to be absolutely sure that something is
1674 passed as-is please enclose it in quotes.
1676 The B<Exec> and B<NotificationExec> statements change the semantics of the
1677 programs executed, i.E<nbsp>e. the data passed to them and the response
1678 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1680 =back
1682 =head2 Plugin C<filecount>
1684 The C<filecount> plugin counts the number of files in a certain directory (and
1685 its subdirectories) and their combined size. The configuration is very straight
1686 forward:
1688   <Plugin "filecount">
1689     <Directory "/var/qmail/queue/mess">
1690       Instance "qmail-message"
1691     </Directory>
1692     <Directory "/var/qmail/queue/todo">
1693       Instance "qmail-todo"
1694     </Directory>
1695     <Directory "/var/lib/php5">
1696       Instance "php5-sessions"
1697       Name "sess_*"
1698     </Directory>
1699   </Plugin>
1701 The example above counts the number of files in QMail's queue directories and
1702 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1703 QMail has not yet looked at, the "message" queue holds the messages that were
1704 classified into "local" and "remote".
1706 As you can see, the configuration consists of one or more C<Directory> blocks,
1707 each of which specifies a directory in which to count the files. Within those
1708 blocks, the following options are recognized:
1710 =over 4
1712 =item B<Instance> I<Instance>
1714 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1715 it's your responsibility, the plugin doesn't check for that. If not given, the
1716 instance is set to the directory name with all slashes replaced by underscores
1717 and all leading underscores removed.
1719 =item B<Name> I<Pattern>
1721 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1722 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1723 against the pattern, not the entire path. In case this makes it easier for you:
1724 This option has been named after the B<-name> parameter to L<find(1)>.
1726 =item B<MTime> I<Age>
1728 Count only files of a specific age: If I<Age> is greater than zero, only files
1729 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1730 a negative number, this is inversed. For example, if B<-60> is specified, only
1731 files that have been modified in the last minute will be counted.
1733 The number can also be followed by a "multiplier" to easily specify a larger
1734 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1735 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1736 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1737 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1738 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1739 B<"12h">.
1741 =item B<Size> I<Size>
1743 Count only files of a specific size. When I<Size> is a positive number, only
1744 files that are at least this big are counted. If I<Size> is a negative number,
1745 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1746 I<Size> are counted.
1748 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1749 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1750 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1751 note that there are 1000 bytes in a kilobyte, not 1024.
1753 =item B<Recursive> I<true>|I<false>
1755 Controls whether or not to recurse into subdirectories. Enabled by default.
1757 =item B<IncludeHidden> I<true>|I<false>
1759 Controls whether or not to include "hidden" files and directories in the count.
1760 "Hidden" files and directories are those, whose name begins with a dot.
1761 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1763 =back
1765 =head2 Plugin C<GenericJMX>
1767 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1768 L<collectd-java(5)>.
1770 =head2 Plugin C<gmond>
1772 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1773 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1774 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1776 Synopsis:
1778  <Plugin "gmond">
1779    MCReceiveFrom "239.2.11.71" "8649"
1780    <Metric "swap_total">
1781      Type "swap"
1782      TypeInstance "total"
1783      DataSource "value"
1784    </Metric>
1785    <Metric "swap_free">
1786      Type "swap"
1787      TypeInstance "free"
1788      DataSource "value"
1789    </Metric>
1790  </Plugin>
1792 The following metrics are built-in:
1794 =over 4
1796 =item *
1798 load_one, load_five, load_fifteen
1800 =item *
1802 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1804 =item *
1806 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1808 =item *
1810 bytes_in, bytes_out
1812 =item *
1814 pkts_in, pkts_out
1816 =back
1818 Available configuration options:
1820 =over 4
1822 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1824 Sets sets the multicast group and UDP port to which to subscribe.
1826 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1828 =item E<lt>B<Metric> I<Name>E<gt>
1830 These blocks add a new metric conversion to the internal table. I<Name>, the
1831 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1833 =over 4
1835 =item B<Type> I<Type>
1837 Type to map this metric to. Required.
1839 =item B<TypeInstance> I<Instance>
1841 Type-instance to use. Optional.
1843 =item B<DataSource> I<Name>
1845 Data source to map this metric to. If the configured type has exactly one data
1846 source, this is optional. Otherwise the option is required.
1848 =back
1850 =back
1852 =head2 Plugin C<hddtemp>
1854 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
1855 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
1856 default values, see below. C<hddtemp> has to be running to work correctly. If
1857 C<hddtemp> is not running timeouts may appear which may interfere with other
1858 statistics..
1860 The B<hddtemp> homepage can be found at
1861 L<http://www.guzu.net/linux/hddtemp.php>.
1863 =over 4
1865 =item B<Host> I<Hostname>
1867 Hostname to connect to. Defaults to B<127.0.0.1>.
1869 =item B<Port> I<Port>
1871 TCP-Port to connect to. Defaults to B<7634>.
1873 =back
1875 =head2 Plugin C<interface>
1877 =over 4
1879 =item B<Interface> I<Interface>
1881 Select this interface. By default these interfaces will then be collected. For
1882 a more detailed description see B<IgnoreSelected> below.
1884 =item B<IgnoreSelected> I<true>|I<false>
1886 If no configuration if given, the B<traffic>-plugin will collect data from
1887 all interfaces. This may not be practical, especially for loopback- and
1888 similar interfaces. Thus, you can use the B<Interface>-option to pick the
1889 interfaces you're interested in. Sometimes, however, it's easier/preferred
1890 to collect all interfaces I<except> a few ones. This option enables you to
1891 do that: By setting B<IgnoreSelected> to I<true> the effect of
1892 B<Interface> is inverted: All selected interfaces are ignored and all
1893 other interfaces are collected.
1895 =back
1897 =head2 Plugin C<ipmi>
1899 =over 4
1901 =item B<Sensor> I<Sensor>
1903 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
1905 =item B<IgnoreSelected> I<true>|I<false>
1907 If no configuration if given, the B<ipmi> plugin will collect data from all
1908 sensors found of type "temperature", "voltage", "current" and "fanspeed".
1909 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
1910 the effect of B<Sensor> is inverted: All selected sensors are ignored and
1911 all other sensors are collected.
1913 =item B<NotifySensorAdd> I<true>|I<false>
1915 If a sensor appears after initialization time of a minute a notification
1916 is sent.
1918 =item B<NotifySensorRemove> I<true>|I<false>
1920 If a sensor disappears a notification is sent.
1922 =item B<NotifySensorNotPresent> I<true>|I<false>
1924 If you have for example dual power supply and one of them is (un)plugged then
1925 a notification is sent.
1927 =back
1929 =head2 Plugin C<iptables>
1931 =over 4
1933 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
1935 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
1936 will collect the counters of all rules which have a comment-match. The comment
1937 is then used as type-instance.
1939 If I<Comment> or I<Number> is given, only the rule with the matching comment or
1940 the I<n>th rule will be collected. Again, the comment (or the number) will be
1941 used as the type-instance.
1943 If I<Name> is supplied, it will be used as the type-instance instead of the
1944 comment or the number.
1946 =back
1948 =head2 Plugin C<irq>
1950 =over 4
1952 =item B<Irq> I<Irq>
1954 Select this irq. By default these irqs will then be collected. For a more
1955 detailed description see B<IgnoreSelected> below.
1957 =item B<IgnoreSelected> I<true>|I<false>
1959 If no configuration if given, the B<irq>-plugin will collect data from all
1960 irqs. This may not be practical, especially if no interrupts happen. Thus, you
1961 can use the B<Irq>-option to pick the interrupt you're interested in.
1962 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
1963 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
1964 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
1965 and all other interrupts are collected.
1967 =back
1969 =head2 Plugin C<java>
1971 The I<Java> plugin makes it possible to write extensions for collectd in Java.
1972 This section only discusses the syntax and semantic of the configuration
1973 options. For more in-depth information on the I<Java> plugin, please read
1974 L<collectd-java(5)>.
1976 Synopsis:
1978  <Plugin "java">
1979    JVMArg "-verbose:jni"
1980    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
1981    LoadPlugin "org.collectd.java.Foobar"
1982    <Plugin "org.collectd.java.Foobar">
1983      # To be parsed by the plugin
1984    </Plugin>
1985  </Plugin>
1987 Available configuration options:
1989 =over 4
1991 =item B<JVMArg> I<Argument>
1993 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
1994 exactly the way the arguments to the I<java> binary on the command line work.
1995 Execute C<javaE<nbsp>--help> for details.
1997 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
1998 any other options! When another option is found, the JVM will be started and
1999 later options will have to be ignored!
2001 =item B<LoadPlugin> I<JavaClass>
2003 Instantiates a new I<JavaClass> object. The constructor of this object very
2004 likely then registers one or more callback methods with the server.
2006 See L<collectd-java(5)> for details.
2008 When the first such option is found, the virtual machine (JVM) is created. This
2009 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2010 B<LoadPlugin> options!
2012 =item B<Plugin> I<Name>
2014 The entire block is passed to the Java plugin as an
2015 I<org.collectd.api.OConfigItem> object.
2017 For this to work, the plugin has to register a configuration callback first,
2018 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2019 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2020 depends on the (Java) plugin registering the callback and is completely
2021 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2023 =back
2025 =head2 Plugin C<libvirt>
2027 This plugin allows CPU, disk and network load to be collected for virtualized
2028 guests on the machine. This means that these characteristics can be collected
2029 for guest systems without installing any software on them - collectd only runs
2030 on the hosting system. The statistics are collected through libvirt
2031 (L<http://libvirt.org/>).
2033 Only I<Connection> is required.
2035 =over 4
2037 =item B<Connection> I<uri>
2039 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2041  Connection "xen:///"
2043 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2045 =item B<RefreshInterval> I<seconds>
2047 Refresh the list of domains and devices every I<seconds>. The default is 60
2048 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2049 the list of domains and devices to be refreshed on every iteration.
2051 Refreshing the devices in particular is quite a costly operation, so if your
2052 virtualization setup is static you might consider increasing this. If this
2053 option is set to 0, refreshing is disabled completely.
2055 =item B<Domain> I<name>
2057 =item B<BlockDevice> I<name:dev>
2059 =item B<InterfaceDevice> I<name:dev>
2061 =item B<IgnoreSelected> I<true>|I<false>
2063 Select which domains and devices are collected.
2065 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2066 disk/network devices are collected.
2068 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2069 domains and disk/network devices are ignored, while the rest are collected.
2071 The domain name and device names may use a regular expression, if the name is
2072 surrounded by I</.../> and collectd was compiled with support for regexps.
2074 The default is to collect statistics for all domains and all their devices.
2076 Example:
2078  BlockDevice "/:hdb/"
2079  IgnoreSelected "true"
2081 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2082 will be collected.
2084 =item B<HostnameFormat> B<name|uuid|hostname|...>
2086 When the libvirt plugin logs data, it sets the hostname of the collected data
2087 according to this setting. The default is to use the guest name as provided by
2088 the hypervisor, which is equal to setting B<name>.
2090 B<uuid> means use the guest's UUID. This is useful if you want to track the
2091 same guest across migrations.
2093 B<hostname> means to use the global B<Hostname> setting, which is probably not
2094 useful on its own because all guests will appear to have the same name.
2096 You can also specify combinations of these fields. For example B<name uuid>
2097 means to concatenate the guest name and UUID (with a literal colon character
2098 between, thus I<"foo:1234-1234-1234-1234">).
2100 =item B<InterfaceFormat> B<name>|B<address>
2102 When the libvirt plugin logs interface data, it sets the name of the collected
2103 data according to this setting. The default is to use the path as provided by
2104 the hypervisor (the "dev" property of the target node), which is equal to
2105 setting B<name>.
2107 B<address> means use the interface's mac address. This is useful since the
2108 interface path might change between reboots of a guest or across migrations.
2110 =back
2112 =head2 Plugin C<logfile>
2114 =over 4
2116 =item B<LogLevel> B<debug|info|notice|warning|err>
2118 Sets the log-level. If, for example, set to B<notice>, then all events with
2119 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2121 Please note that B<debug> is only available if collectd has been compiled with
2122 debugging support.
2124 =item B<File> I<File>
2126 Sets the file to write log messages to. The special strings B<stdout> and
2127 B<stderr> can be used to write to the standard output and standard error
2128 channels, respectively. This, of course, only makes much sense when I<collectd>
2129 is running in foreground- or non-daemon-mode.
2131 =item B<Timestamp> B<true>|B<false>
2133 Prefix all lines printed by the current time. Defaults to B<true>.
2135 =item B<PrintSeverity> B<true>|B<false>
2137 When enabled, all lines are prefixed by the severity of the log message, for
2138 example "warning". Defaults to B<false>.
2140 =back
2142 B<Note>: There is no need to notify the daemon after moving or removing the
2143 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2144 for each line it writes.
2146 =head2 Plugin C<lpar>
2148 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2149 virtualization technique for IBM POWER processors. It takes into account CPU
2150 time stolen from or donated to a partition, in addition to the usual user,
2151 system, I/O statistics.
2153 The following configuration options are available:
2155 =over 4
2157 =item B<CpuPoolStats> B<false>|B<true>
2159 When enabled, statistics about the processor pool are read, too. The partition
2160 needs to have pool authority in order to be able to acquire this information.
2161 Defaults to false.
2163 =item B<ReportBySerial> B<false>|B<true>
2165 If enabled, the serial of the physical machine the partition is currently
2166 running on is reported as I<hostname> and the logical hostname of the machine
2167 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2168 used (just like other plugins) and the I<plugin instance> will be empty.
2169 Defaults to false.
2171 =back
2173 =head2 Plugin C<mbmon>
2175 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2177 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2178 B<Host> and B<Port> options can be used to change these values, see below.
2179 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2180 timeouts may appear which may interfere with other statistics..
2182 C<mbmon> must be run with the -r option ("print TAG and Value format");
2183 Debian's F</etc/init.d/mbmon> script already does this, other people
2184 will need to ensure that this is the case.
2186 =over 4
2188 =item B<Host> I<Hostname>
2190 Hostname to connect to. Defaults to B<127.0.0.1>.
2192 =item B<Port> I<Port>
2194 TCP-Port to connect to. Defaults to B<411>.
2196 =back
2198 =head2 Plugin C<md>
2200 The C<md plugin> collects information from Linux Software-RAID devices (md).
2202 All reported values are of the type C<md_disks>. Reported type instances are
2203 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2204 I<missing> (physically absent) disks.
2206 =over 4
2208 =item B<Device> I<Device>
2210 Select md devices based on device name. The I<device name> is the basename of
2211 the device, i.e. the name of the block device without the leading C</dev/>.
2212 See B<IgnoreSelected> for more details.
2214 =item B<IgnoreSelected> B<true>|B<false>
2216 Invert device selection: If set to B<true>, all md devices B<except> those
2217 listed using B<Device> are collected. If B<false> (the default), only those
2218 listed are collected. If no configuration is given, the B<md> plugin will
2219 collect data from all md devices.
2221 =back
2223 =head2 Plugin C<memcachec>
2225 The C<memcachec plugin> connects to a memcached server, queries one or more
2226 given I<pages> and parses the returned data according to user specification.
2227 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2228 plugins.
2230 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2231 library. Please note that there is another library with a very similar name,
2232 libmemcache (notice the missing `d'), which is not applicable.
2234 Synopsis of the configuration:
2236  <Plugin "memcachec">
2237    <Page "plugin_instance">
2238      Server "localhost"
2239      Key "page_key"
2240      <Match>
2241        Regex "(\\d+) bytes sent"
2242        DSType CounterAdd
2243        Type "ipt_octets"
2244        Instance "type_instance"
2245      </Match>
2246    </Page>
2247  </Plugin>
2249 The configuration options are:
2251 =over 4
2253 =item E<lt>B<Page> I<Name>E<gt>
2255 Each B<Page> block defines one I<page> to be queried from the memcached server.
2256 The block requires one string argument which is used as I<plugin instance>.
2258 =item B<Server> I<Address>
2260 Sets the server address to connect to when querying the page. Must be inside a
2261 B<Page> block.
2263 =item B<Key> I<Key>
2265 When connected to the memcached server, asks for the page I<Key>.
2267 =item E<lt>B<Match>E<gt>
2269 Match blocks define which strings to look for and how matches substrings are
2270 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2272 =back
2274 =head2 Plugin C<memcached>
2276 The B<memcached plugin> connects to a memcached server and queries statistics
2277 about cache utilization, memory and bandwidth used.
2278 L<http://www.danga.com/memcached/>
2280  <Plugin "memcached">
2281    <Instance "name">
2282      Host "memcache.example.com"
2283      Port 11211
2284    </Instance>
2285  </Plugin>
2287 The plugin configuration consists of one or more B<Instance> blocks which
2288 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2289 following options are allowed:
2291 =over 4
2293 =item B<Host> I<Hostname>
2295 Hostname to connect to. Defaults to B<127.0.0.1>.
2297 =item B<Port> I<Port>
2299 TCP-Port to connect to. Defaults to B<11211>.
2301 =item B<Socket> I<Path>
2303 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2304 setting is given, the B<Host> and B<Port> settings are ignored.
2306 =back
2308 =head2 Plugin C<mic>
2310 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2311 Intel's Many Integrated Core (MIC) systems.
2313 B<Synopsis:>
2315  <Plugin mic>
2316    ShowCPU true
2317    ShowCPUCores true
2318    ShowMemory true
2319    
2320    ShowTemperatures true
2321    Temperature vddg
2322    Temperature vddq
2323    IgnoreSelectedTemperature true
2325    ShowPower true
2326    Power total0
2327    Power total1
2328    IgnoreSelectedPower true   
2329  </Plugin>
2331 The following options are valid inside the B<PluginE<nbsp>mic> block:
2333 =over 4
2335 =item B<ShowCPU> B<true>|B<false>
2337 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2339 =item B<ShowCPUCores> B<true>|B<false>
2341 If enabled (the default) per-core CPU usage is reported.
2343 =item B<ShowMemory> B<true>|B<false>
2345 If enabled (the default) the physical memory usage of the MIC system is
2346 reported.
2348 =item B<ShowTemperatures> B<true>|B<false>
2350 If enabled (the default) various temperatures of the MIC system are reported.
2352 =item B<Temperature> I<Name>
2354 This option controls which temperatures are being reported. Whether matching
2355 temperatures are being ignored or I<only> matching temperatures are reported
2356 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2357 temperatures are reported.
2359 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2361 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2362 (the default) only temperatures matching a B<Temperature> option are reported
2363 or, if no B<Temperature> option is specified, all temperatures are reported. If
2364 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2365 are reported.
2367 Known temperature names are:
2369 =over 4
2371 =item die
2373 Die of the CPU
2375 =item devmem
2377 Device Memory
2379 =item fin
2381 Fan In
2383 =item fout
2385 Fan Out 
2387 =item vccp
2389 Voltage ccp
2391 =item vddg
2393 Voltage ddg
2395 =item vddq
2397 Voltage ddq
2399 =back
2401 =item B<ShowPower> B<true>|B<false>
2403 If enabled (the default) various temperatures of the MIC system are reported.
2405 =item B<Power> I<Name>
2407 This option controls which power readings are being reported. Whether matching
2408 power readings are being ignored or I<only> matching power readings are reported
2409 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2410 power readings are reported.
2412 =item B<IgnoreSelectedPower> B<false>|B<true>
2414 Controls the behavior of the B<Power> setting above. If set to B<false>
2415 (the default) only power readings matching a B<Power> option are reported
2416 or, if no B<Power> option is specified, all power readings are reported. If
2417 set to B<true>, matching power readings are I<ignored> and all other power readings
2418 are reported.
2420 Known power names are:
2422 =over 4
2424 =item total0
2426 Total power utilization averaged over Time Window 0 (uWatts). 
2428 =item total1
2430 Total power utilization averaged over Time Window 0 (uWatts). 
2432 =item inst
2434 Instantaneous power (uWatts).
2436 =item imax
2438 Max instantaneous power (uWatts). 
2440 =item pcie
2442 PCI-E connector power (uWatts). 
2444 =item c2x3
2446 2x3 connector power (uWatts). 
2448 =item c2x4
2450 2x4 connector power (uWatts). 
2452 =item vccp
2454 Core rail (uVolts). 
2456 =item vddg
2458 Uncore rail (uVolts). 
2460 =item vddq
2462 Memory subsystem rail (uVolts). 
2464 =back
2466 =back
2468 =head2 Plugin C<modbus>
2470 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2471 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2472 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2473 values (two registers interpreted as IEEE floats in big endian notation).
2475 B<Synopsis:>
2477  <Data "voltage-input-1">
2478    RegisterBase 0
2479    RegisterType float
2480    Type voltage
2481    Instance "input-1"
2482  </Data>
2483  
2484  <Data "voltage-input-2">
2485    RegisterBase 2
2486    RegisterType float
2487    Type voltage
2488    Instance "input-2"
2489  </Data>
2490  
2491  <Host "modbus.example.com">
2492    Address "192.168.0.42"
2493    Port    "502"
2494    Interval 60
2495    
2496    <Slave 1>
2497      Instance "power-supply"
2498      Collect  "voltage-input-1"
2499      Collect  "voltage-input-2"
2500    </Slave>
2501  </Host>
2503 =over 4
2505 =item E<lt>B<Data> I<Name>E<gt> blocks
2507 Data blocks define a mapping between register numbers and the "types" used by
2508 I<collectd>.
2510 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2512 =over 4
2514 =item B<RegisterBase> I<Number>
2516 Configures the base register to read from the device. If the option
2517 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2518 register will be read (the register number is increased by one).
2520 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2522 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2523 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2524 combined into one value. Defaults to B<Uint16>.
2526 =item B<Type> I<Type>
2528 Specifies the "type" (data set) to use when dispatching the value to
2529 I<collectd>. Currently, only data sets with exactly one data source are
2530 supported.
2532 =item B<Instance> I<Instance>
2534 Sets the type instance to use when dispatching the value to I<collectd>. If
2535 unset, an empty string (no type instance) is used.
2537 =back
2539 =item E<lt>B<Host> I<Name>E<gt> blocks
2541 Host blocks are used to specify to which hosts to connect and what data to read
2542 from their "slaves". The string argument I<Name> is used as hostname when
2543 dispatching the values to I<collectd>.
2545 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2547 =over 4
2549 =item B<Address> I<Hostname>
2551 Specifies the node name (the actual network address) used to connect to the
2552 host. This may be an IP address or a hostname. Please note that the used
2553 I<libmodbus> library only supports IPv4 at the moment.
2555 =item B<Port> I<Service>
2557 Specifies the port used to connect to the host. The port can either be given as
2558 a number or as a service name. Please note that the I<Service> argument must be
2559 a string, even if ports are given in their numerical form. Defaults to "502".
2561 =item B<Interval> I<Interval>
2563 Sets the interval (in seconds) in which the values will be collected from this
2564 host. By default the global B<Interval> setting will be used.
2566 =item E<lt>B<Slave> I<ID>E<gt>
2568 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2569 is used to specify which device should be addressed. For each device you want
2570 to query, one B<Slave> block must be given.
2572 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2574 =over 4
2576 =item B<Instance> I<Instance>
2578 Specify the plugin instance to use when dispatching the values to I<collectd>.
2579 By default "slave_I<ID>" is used.
2581 =item B<Collect> I<DataName>
2583 Specifies which data to retrieve from the device. I<DataName> must be the same
2584 string as the I<Name> argument passed to a B<Data> block. You can specify this
2585 option multiple times to collect more than one value from a slave. At least one
2586 B<Collect> option is mandatory.
2588 =back
2590 =back
2592 =back
2594 =head2 Plugin C<mysql>
2596 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2597 one or more databases when started and keeps the connection up as long as
2598 possible. When the connection is interrupted for whatever reason it will try
2599 to re-connect. The plugin will complain loudly in case anything goes wrong.
2601 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2602 and collects information about MySQL network traffic, executed statements,
2603 requests, the query cache and threads by evaluating the
2604 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2605 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2606 Status Variables> for an explanation of these values.
2608 Optionally, master and slave statistics may be collected in a MySQL
2609 replication setup. In that case, information about the synchronization state
2610 of the nodes are collected by evaluating the C<Position> return value of the
2611 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2612 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2613 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2614 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2615 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2617 Synopsis:
2619   <Plugin mysql>
2620     <Database foo>
2621       Host "hostname"
2622       User "username"
2623       Password "password"
2624       Port "3306"
2625       MasterStats true
2626     </Database>
2628     <Database bar>
2629       Host "localhost"
2630       Socket "/var/run/mysql/mysqld.sock"
2631       SlaveStats true
2632       SlaveNotifications true
2633     </Database>
2634   </Plugin>
2636 A B<Database> block defines one connection to a MySQL database. It accepts a
2637 single argument which specifies the name of the database. None of the other
2638 options are required. MySQL will use default values as documented in the
2639 section "mysql_real_connect()" in the B<MySQL reference manual>.
2641 =over 4
2643 =item B<Host> I<Hostname>
2645 Hostname of the database server. Defaults to B<localhost>.
2647 =item B<User> I<Username>
2649 Username to use when connecting to the database. The user does not have to be
2650 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2651 unless you want to collectd replication statistics (see B<MasterStats> and
2652 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2653 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2655 =item B<Password> I<Password>
2657 Password needed to log into the database.
2659 =item B<Database> I<Database>
2661 Select this database. Defaults to I<no database> which is a perfectly reasonable
2662 option for what this plugin does.
2664 =item B<Port> I<Port>
2666 TCP-port to connect to. The port must be specified in its numeric form, but it
2667 must be passed as a string nonetheless. For example:
2669   Port "3306"
2671 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2672 See the documentation for the C<mysql_real_connect> function for details.
2674 =item B<Socket> I<Socket>
2676 Specifies the path to the UNIX domain socket of the MySQL server. This option
2677 only has any effect, if B<Host> is set to B<localhost> (the default).
2678 Otherwise, use the B<Port> option above. See the documentation for the
2679 C<mysql_real_connect> function for details.
2681 =item B<MasterStats> I<true|false>
2683 =item B<SlaveStats> I<true|false>
2685 Enable the collection of master / slave statistics in a replication setup. In
2686 order to be able to get access to these statistics, the user needs special
2687 privileges. See the B<User> documentation above.
2689 =item B<SlaveNotifications> I<true|false>
2691 If enabled, the plugin sends a notification if the replication slave I/O and /
2692 or SQL threads are not running.
2694 =back
2696 =head2 Plugin C<netapp>
2698 The netapp plugin can collect various performance and capacity information
2699 from a NetApp filer using the NetApp API.
2701 Please note that NetApp has a wide line of products and a lot of different
2702 software versions for each of these products. This plugin was developed for a
2703 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2704 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2705 model and software version but it is very hard to test this.
2706 If you have used this plugin with other models and/or software version, feel
2707 free to send us a mail to tell us about the results, even if it's just a short
2708 "It works".
2710 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2711 basic authentication.
2713 B<Do not use a regular user for this!> Create a special collectd user with just
2714 the minimum of capabilities needed. The user only needs the "login-http-admin"
2715 capability as well as a few more depending on which data will be collected.
2716 Required capabilities are documented below.
2718 =head3 Synopsis
2720  <Plugin "netapp">
2721    <Host "netapp1.example.com">
2722     Protocol      "https"
2723     Address       "10.0.0.1"
2724     Port          443
2725     User          "username"
2726     Password      "aef4Aebe"
2727     Interval      30
2728     
2729     <WAFL>
2730       Interval 30
2731       GetNameCache   true
2732       GetDirCache    true
2733       GetBufferCache true
2734       GetInodeCache  true
2735     </WAFL>
2736     
2737     <Disks>
2738       Interval 30
2739       GetBusy true
2740     </Disks>
2741     
2742     <VolumePerf>
2743       Interval 30
2744       GetIO      "volume0"
2745       IgnoreSelectedIO      false
2746       GetOps     "volume0"
2747       IgnoreSelectedOps     false
2748       GetLatency "volume0"
2749       IgnoreSelectedLatency false
2750     </VolumePerf>
2751     
2752     <VolumeUsage>
2753       Interval 30
2754       GetCapacity "vol0"
2755       GetCapacity "vol1"
2756       IgnoreSelectedCapacity false
2757       GetSnapshot "vol1"
2758       GetSnapshot "vol3"
2759       IgnoreSelectedSnapshot false
2760     </VolumeUsage>
2761     
2762     <Quota>
2763       Interval 60
2764     </Quota>
2765     
2766     <Snapvault>
2767       Interval 30
2768     </Snapvault>
2769     
2770     <System>
2771       Interval 30
2772       GetCPULoad     true
2773       GetInterfaces  true
2774       GetDiskOps     true
2775       GetDiskIO      true
2776     </System>
2778     <VFiler vfilerA>
2779       Interval 60
2781       SnapVault true
2782       # ...
2783     </VFiler>
2784    </Host>
2785  </Plugin>
2787 The netapp plugin accepts the following configuration options:
2789 =over 4
2791 =item B<Host> I<Name>
2793 A host block defines one NetApp filer. It will appear in collectd with the name
2794 you specify here which does not have to be its real name nor its hostname (see
2795 the B<Address> option below).
2797 =item B<VFiler> I<Name>
2799 A B<VFiler> block may only be used inside a host block. It accepts all the
2800 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
2801 will execute all NetApp API commands in the context of the specified
2802 VFiler(R). It will appear in collectd with the name you specify here which
2803 does not have to be its real name. The VFiler name may be specified using the
2804 B<VFilerName> option. If this is not specified, it will default to the name
2805 you specify here.
2807 The VFiler block inherits all connection related settings from the surrounding
2808 B<Host> block (which appear before the B<VFiler> block) but they may be
2809 overwritten inside the B<VFiler> block.
2811 This feature is useful, for example, when using a VFiler as SnapVault target
2812 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
2813 available in the host filer (vfiler0) but only in the respective VFiler
2814 context.
2816 =item B<Protocol> B<httpd>|B<http>
2818 The protocol collectd will use to query this host.
2820 Optional
2822 Type: string
2824 Default: https
2826 Valid options: http, https
2828 =item B<Address> I<Address>
2830 The hostname or IP address of the host.
2832 Optional
2834 Type: string
2836 Default: The "host" block's name.
2838 =item B<Port> I<Port>
2840 The TCP port to connect to on the host.
2842 Optional
2844 Type: integer
2846 Default: 80 for protocol "http", 443 for protocol "https"
2848 =item B<User> I<User>
2850 =item B<Password> I<Password>
2852 The username and password to use to login to the NetApp.
2854 Mandatory
2856 Type: string
2858 =item B<VFilerName> I<Name>
2860 The name of the VFiler in which context to execute API commands. If not
2861 specified, the name provided to the B<VFiler> block will be used instead.
2863 Optional
2865 Type: string
2867 Default: name of the B<VFiler> block
2869 B<Note:> This option may only be used inside B<VFiler> blocks.
2871 =item B<Interval> I<Interval>
2873 B<TODO>
2875 =back
2877 The following options decide what kind of data will be collected. You can
2878 either use them as a block and fine tune various parameters inside this block,
2879 use them as a single statement to just accept all default values, or omit it to
2880 not collect any data.
2882 The following options are valid inside all blocks:
2884 =over 4
2886 =item B<Interval> I<Seconds>
2888 Collect the respective statistics every I<Seconds> seconds. Defaults to the
2889 host specific setting.
2891 =back
2893 =head3 The System block
2895 This will collect various performance data about the whole system.
2897 B<Note:> To get this data the collectd user needs the
2898 "api-perf-object-get-instances" capability.
2900 =over 4
2902 =item B<Interval> I<Seconds>
2904 Collect disk statistics every I<Seconds> seconds.
2906 =item B<GetCPULoad> B<true>|B<false>
2908 If you set this option to true the current CPU usage will be read. This will be
2909 the average usage between all CPUs in your NetApp without any information about
2910 individual CPUs.
2912 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2913 returns in the "CPU" field.
2915 Optional
2917 Type: boolean
2919 Default: true
2921 Result: Two value lists of type "cpu", and type instances "idle" and "system".
2923 =item B<GetInterfaces> B<true>|B<false>
2925 If you set this option to true the current traffic of the network interfaces
2926 will be read. This will be the total traffic over all interfaces of your NetApp
2927 without any information about individual interfaces.
2929 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2930 in the "Net kB/s" field.
2932 B<Or is it?>
2934 Optional
2936 Type: boolean
2938 Default: true
2940 Result: One value list of type "if_octects".
2942 =item B<GetDiskIO> B<true>|B<false>
2944 If you set this option to true the current IO throughput will be read. This
2945 will be the total IO of your NetApp without any information about individual
2946 disks, volumes or aggregates.
2948 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
2949 in the "DiskE<nbsp>kB/s" field.
2951 Optional
2953 Type: boolean
2955 Default: true
2957 Result: One value list of type "disk_octets".
2959 =item B<GetDiskOps> B<true>|B<false>
2961 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
2962 iSCSI, etc. operations will be read. This will be the total number of
2963 operations on your NetApp without any information about individual volumes or
2964 aggregates.
2966 B<Note:> These are the same values that the NetApp CLI command "sysstat"
2967 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
2969 Optional
2971 Type: boolean
2973 Default: true
2975 Result: A variable number of value lists of type "disk_ops_complex". Each type
2976 of operation will result in one value list with the name of the operation as
2977 type instance.
2979 =back
2981 =head3 The WAFL block
2983 This will collect various performance data about the WAFL file system. At the
2984 moment this just means cache performance.
2986 B<Note:> To get this data the collectd user needs the
2987 "api-perf-object-get-instances" capability.
2989 B<Note:> The interface to get these values is classified as "Diagnostics" by
2990 NetApp. This means that it is not guaranteed to be stable even between minor
2991 releases.
2993 =over 4
2995 =item B<Interval> I<Seconds>
2997 Collect disk statistics every I<Seconds> seconds.
2999 =item B<GetNameCache> B<true>|B<false>
3001 Optional
3003 Type: boolean
3005 Default: true
3007 Result: One value list of type "cache_ratio" and type instance
3008 "name_cache_hit".
3010 =item B<GetDirCache> B<true>|B<false>
3012 Optional
3014 Type: boolean
3016 Default: true
3018 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3020 =item B<GetInodeCache> B<true>|B<false>
3022 Optional
3024 Type: boolean
3026 Default: true
3028 Result: One value list of type "cache_ratio" and type instance
3029 "inode_cache_hit".
3031 =item B<GetBufferCache> B<true>|B<false>
3033 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3034 in the "Cache hit" field.
3036 Optional
3038 Type: boolean
3040 Default: true
3042 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3044 =back
3046 =head3 The Disks block
3048 This will collect performance data about the individual disks in the NetApp.
3050 B<Note:> To get this data the collectd user needs the
3051 "api-perf-object-get-instances" capability.
3053 =over 4
3055 =item B<Interval> I<Seconds>
3057 Collect disk statistics every I<Seconds> seconds.
3059 =item B<GetBusy> B<true>|B<false>
3061 If you set this option to true the busy time of all disks will be calculated
3062 and the value of the busiest disk in the system will be written.
3064 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3065 in the "Disk util" field. Probably.
3067 Optional
3069 Type: boolean
3071 Default: true
3073 Result: One value list of type "percent" and type instance "disk_busy".
3075 =back
3077 =head3 The VolumePerf block
3079 This will collect various performance data about the individual volumes.
3081 You can select which data to collect about which volume using the following
3082 options. They follow the standard ignorelist semantic.
3084 B<Note:> To get this data the collectd user needs the
3085 I<api-perf-object-get-instances> capability.
3087 =over 4
3089 =item B<Interval> I<Seconds>
3091 Collect volume performance data every I<Seconds> seconds.
3093 =item B<GetIO> I<Volume>
3095 =item B<GetOps> I<Volume>
3097 =item B<GetLatency> I<Volume>
3099 Select the given volume for IO, operations or latency statistics collection.
3100 The argument is the name of the volume without the C</vol/> prefix.
3102 Since the standard ignorelist functionality is used here, you can use a string
3103 starting and ending with a slash to specify regular expression matching: To
3104 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3105 expression:
3107   GetIO "/^vol[027]$/"
3109 If no regular expression is specified, an exact match is required. Both,
3110 regular and exact matching are case sensitive.
3112 If no volume was specified at all for either of the three options, that data
3113 will be collected for all available volumes.
3115 =item B<IgnoreSelectedIO> B<true>|B<false>
3117 =item B<IgnoreSelectedOps> B<true>|B<false>
3119 =item B<IgnoreSelectedLatency> B<true>|B<false>
3121 When set to B<true>, the volumes selected for IO, operations or latency
3122 statistics collection will be ignored and the data will be collected for all
3123 other volumes.
3125 When set to B<false>, data will only be collected for the specified volumes and
3126 all other volumes will be ignored.
3128 If no volumes have been specified with the above B<Get*> options, all volumes
3129 will be collected regardless of the B<IgnoreSelected*> option.
3131 Defaults to B<false>
3133 =back
3135 =head3 The VolumeUsage block
3137 This will collect capacity data about the individual volumes.
3139 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3140 capability.
3142 =over 4
3144 =item B<Interval> I<Seconds>
3146 Collect volume usage statistics every I<Seconds> seconds.
3148 =item B<GetCapacity> I<VolumeName>
3150 The current capacity of the volume will be collected. This will result in two
3151 to four value lists, depending on the configuration of the volume. All data
3152 sources are of type "df_complex" with the name of the volume as
3153 plugin_instance.
3155 There will be type_instances "used" and "free" for the number of used and
3156 available bytes on the volume.  If the volume has some space reserved for
3157 snapshots, a type_instance "snap_reserved" will be available.  If the volume
3158 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3159 number of bytes saved by the SIS feature.
3161 B<Note:> The current NetApp API has a bug that results in this value being
3162 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3163 number which works most of the time.  If you see strange values here, bug
3164 NetApp support to fix this.
3166 Repeat this option to specify multiple volumes.
3168 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3170 Specify whether to collect only the volumes selected by the B<GetCapacity>
3171 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3172 B<false>. However, if no B<GetCapacity> option is specified at all, all
3173 capacities will be selected anyway.
3175 =item B<GetSnapshot> I<VolumeName>
3177 Select volumes from which to collect snapshot information.
3179 Usually, the space used for snapshots is included in the space reported as
3180 "used". If snapshot information is collected as well, the space used for
3181 snapshots is subtracted from the used space.
3183 To make things even more interesting, it is possible to reserve space to be
3184 used for snapshots. If the space required for snapshots is less than that
3185 reserved space, there is "reserved free" and "reserved used" space in addition
3186 to "free" and "used". If the space required for snapshots exceeds the reserved
3187 space, that part allocated in the normal space is subtracted from the "used"
3188 space again.
3190 Repeat this option to specify multiple volumes.
3192 =item B<IgnoreSelectedSnapshot>
3194 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3195 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3196 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3197 capacities will be selected anyway.
3199 =back
3201 =head3 The Quota block
3203 This will collect (tree) quota statistics (used disk space and number of used
3204 files). This mechanism is useful to get usage information for single qtrees.
3205 In case the quotas are not used for any other purpose, an entry similar to the
3206 following in C</etc/quotas> would be sufficient:
3208   /vol/volA/some_qtree tree - - - - -
3210 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3212 =over 4
3214 =item B<Interval> I<Seconds>
3216 Collect SnapVault(R) statistics every I<Seconds> seconds.
3218 =back
3220 =head3 The SnapVault block
3222 This will collect statistics about the time and traffic of SnapVault(R)
3223 transfers.
3225 =over 4
3227 =item B<Interval> I<Seconds>
3229 Collect SnapVault(R) statistics every I<Seconds> seconds.
3231 =back
3233 =head2 Plugin C<netlink>
3235 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3236 statistics of various interface and routing aspects.
3238 =over 4
3240 =item B<Interface> I<Interface>
3242 =item B<VerboseInterface> I<Interface>
3244 Instruct the plugin to collect interface statistics. This is basically the same
3245 as the statistics provided by the C<interface> plugin (see above) but
3246 potentially much more detailed.
3248 When configuring with B<Interface> only the basic statistics will be collected,
3249 namely octets, packets, and errors. These statistics are collected by
3250 the C<interface> plugin, too, so using both at the same time is no benefit.
3252 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3253 so that no data needs to be collected twice if you use the C<interface> plugin.
3254 This includes dropped packets, received multicast packets, collisions and a
3255 whole zoo of differentiated RX and TX errors. You can try the following command
3256 to get an idea of what awaits you:
3258   ip -s -s link list
3260 If I<Interface> is B<All>, all interfaces will be selected.
3262 =item B<QDisc> I<Interface> [I<QDisc>]
3264 =item B<Class> I<Interface> [I<Class>]
3266 =item B<Filter> I<Interface> [I<Filter>]
3268 Collect the octets and packets that pass a certain qdisc, class or filter.
3270 QDiscs and classes are identified by their type and handle (or classid).
3271 Filters don't necessarily have a handle, therefore the parent's handle is used.
3272 The notation used in collectd differs from that used in tc(1) in that it
3273 doesn't skip the major or minor number if it's zero and doesn't print special
3274 ids by their name. So, for example, a qdisc may be identified by
3275 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3276 thus not displayed by tc(1).
3278 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3279 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3280 associated with that interface will be collected.
3282 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3283 used. This may lead to problems when more than one filter is attached to a
3284 qdisc or class. This isn't nice, but we don't know how this could be done any
3285 better. If you have a idea, please don't hesitate to tell us.
3287 As with the B<Interface> option you can specify B<All> as the interface,
3288 meaning all interfaces.
3290 Here are some examples to help you understand the above text more easily:
3292   <Plugin netlink>
3293     VerboseInterface "All"
3294     QDisc "eth0" "pfifo_fast-1:0"
3295     QDisc "ppp0"
3296     Class "ppp0" "htb-1:10"
3297     Filter "ppp0" "u32-1:0"
3298   </Plugin>
3300 =item B<IgnoreSelected>
3302 The behavior is the same as with all other similar plugins: If nothing is
3303 selected at all, everything is collected. If some things are selected using the
3304 options described above, only these statistics are collected. If you set
3305 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3306 specified statistics will not be collected.
3308 =back
3310 =head2 Plugin C<network>
3312 The Network plugin sends data to a remote instance of collectd, receives data
3313 from a remote instance, or both at the same time. Data which has been received
3314 from the network is usually not transmitted again, but this can be activated, see
3315 the B<Forward> option below.
3317 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3318 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3320 Both, B<Server> and B<Listen> can be used as single option or as block. When
3321 used as block, given options are valid for this socket only. The following
3322 example will export the metrics twice: Once to an "internal" server (without
3323 encryption and signing) and one to an external server (with cryptographic
3324 signature):
3326  <Plugin "network">
3327    # Export to an internal server
3328    # (demonstrates usage without additional options)
3329    Server "collectd.internal.tld"
3330    
3331    # Export to an external server
3332    # (demonstrates usage with signature options)
3333    <Server "collectd.external.tld">
3334      SecurityLevel "sign"
3335      Username "myhostname"
3336      Password "ohl0eQue"
3337    </Server>
3338  </Plugin>
3340 =over 4
3342 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3344 The B<Server> statement/block sets the server to send datagrams to. The
3345 statement may occur multiple times to send each datagram to multiple
3346 destinations.
3348 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3349 optional second argument specifies a port number or a service name. If not
3350 given, the default, B<25826>, is used.
3352 The following options are recognized within B<Server> blocks:
3354 =over 4
3356 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3358 Set the security you require for network communication. When the security level
3359 has been set to B<Encrypt>, data sent over the network will be encrypted using
3360 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3361 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3362 authentication code. When set to B<None>, data is sent without any security.
3364 This feature is only available if the I<network> plugin was linked with
3365 I<libgcrypt>.
3367 =item B<Username> I<Username>
3369 Sets the username to transmit. This is used by the server to lookup the
3370 password. See B<AuthFile> below. All security levels except B<None> require
3371 this setting.
3373 This feature is only available if the I<network> plugin was linked with
3374 I<libgcrypt>.
3376 =item B<Password> I<Password>
3378 Sets a password (shared secret) for this socket. All security levels except
3379 B<None> require this setting.
3381 This feature is only available if the I<network> plugin was linked with
3382 I<libgcrypt>.
3384 =item B<Interface> I<Interface name>
3386 Set the outgoing interface for IP packets. This applies at least
3387 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3388 undefined or a non-existent interface name is specified, the default
3389 behavior is to let the kernel choose the appropriate interface. Be warned
3390 that the manual selection of an interface for unicast traffic is only
3391 necessary in rare cases.
3393 =back
3395 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3397 The B<Listen> statement sets the interfaces to bind to. When multiple
3398 statements are found the daemon will bind to multiple interfaces.
3400 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3401 the argument is a multicast address the daemon will join that multicast group.
3402 The optional second argument specifies a port number or a service name. If not
3403 given, the default, B<25826>, is used.
3405 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3407 =over 4
3409 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3411 Set the security you require for network communication. When the security level
3412 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3413 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3414 signed and encrypted data is accepted. When set to B<None>, all data will be
3415 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3416 decrypted if possible.
3418 This feature is only available if the I<network> plugin was linked with
3419 I<libgcrypt>.
3421 =item B<AuthFile> I<Filename>
3423 Sets a file in which usernames are mapped to passwords. These passwords are
3424 used to verify signatures and to decrypt encrypted network packets. If
3425 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3426 verified and encrypted packets are decrypted. Otherwise, signed data is
3427 accepted without checking the signature and encrypted data cannot be decrypted.
3428 For the other security levels this option is mandatory.
3430 The file format is very simple: Each line consists of a username followed by a
3431 colon and any number of spaces followed by the password. To demonstrate, an
3432 example file could look like this:
3434   user0: foo
3435   user1: bar
3437 Each time a packet is received, the modification time of the file is checked
3438 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3439 the file is being read, it is locked using L<fcntl(2)>.
3441 =item B<Interface> I<Interface name>
3443 Set the incoming interface for IP packets explicitly. This applies at least
3444 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3445 undefined or a non-existent interface name is specified, the default
3446 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3447 traffic gets only accepted, if it arrives on the given interface.
3449 =back
3451 =item B<TimeToLive> I<1-255>
3453 Set the time-to-live of sent packets. This applies to all, unicast and
3454 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3455 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3456 operating systems.
3458 =item B<MaxPacketSize> I<1024-65535>
3460 Set the maximum size for datagrams received over the network. Packets larger
3461 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3462 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3463 UDP.
3465 On the server side, this limit should be set to the largest value used on
3466 I<any> client. Likewise, the value on the client must not be larger than the
3467 value on the server, or data will be lost.
3469 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3470 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3471 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3472 server.
3474 =item B<Forward> I<true|false>
3476 If set to I<true>, write packets that were received via the network plugin to
3477 the sending sockets. This should only be activated when the B<Listen>- and
3478 B<Server>-statements differ. Otherwise packets may be send multiple times to
3479 the same multicast group. While this results in more network traffic than
3480 necessary it's not a huge problem since the plugin has a duplicate detection,
3481 so the values will not loop.
3483 =item B<ReportStats> B<true>|B<false>
3485 The network plugin cannot only receive and send statistics, it can also create
3486 statistics about itself. Collected data included the number of received and
3487 sent octets and packets, the length of the receive queue and the number of
3488 values handled. When set to B<true>, the I<Network plugin> will make these
3489 statistics available. Defaults to B<false>.
3491 =back
3493 =head2 Plugin C<nginx>
3495 This plugin collects the number of connections and requests handled by the
3496 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3497 queries the page provided by the C<ngx_http_stub_status_module> module, which
3498 isn't compiled by default. Please refer to
3499 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3500 how to compile and configure nginx and this module.
3502 The following options are accepted by the C<nginx plugin>:
3504 =over 4
3506 =item B<URL> I<http://host/nginx_status>
3508 Sets the URL of the C<ngx_http_stub_status_module> output.
3510 =item B<User> I<Username>
3512 Optional user name needed for authentication.
3514 =item B<Password> I<Password>
3516 Optional password needed for authentication.
3518 =item B<VerifyPeer> B<true|false>
3520 Enable or disable peer SSL certificate verification. See
3521 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3523 =item B<VerifyHost> B<true|false>
3525 Enable or disable peer host name verification. If enabled, the plugin checks
3526 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3527 certificate matches the host name provided by the B<URL> option. If this
3528 identity check fails, the connection is aborted. Obviously, only works when
3529 connecting to a SSL enabled server. Enabled by default.
3531 =item B<CACert> I<File>
3533 File that holds one or more SSL certificates. If you want to use HTTPS you will
3534 possibly need this option. What CA certificates come bundled with C<libcurl>
3535 and are checked by default depends on the distribution you use.
3537 =back
3539 =head2 Plugin C<notify_desktop>
3541 This plugin sends a desktop notification to a notification daemon, as defined
3542 in the Desktop Notification Specification. To actually display the
3543 notifications, B<notification-daemon> is required and B<collectd> has to be
3544 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3545 environment variables have to be set correctly) and the D-Bus message bus.
3547 The Desktop Notification Specification can be found at
3548 L<http://www.galago-project.org/specs/notification/>.
3550 =over 4
3552 =item B<OkayTimeout> I<timeout>
3554 =item B<WarningTimeout> I<timeout>
3556 =item B<FailureTimeout> I<timeout>
3558 Set the I<timeout>, in milliseconds, after which to expire the notification
3559 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3560 been specified, the displayed notification will not be closed at all - the
3561 user has to do so herself. These options default to 5000. If a negative number
3562 has been specified, the default is used as well.
3564 =back
3566 =head2 Plugin C<notify_email>
3568 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3569 configured email address.
3571 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3573 Available configuration options:
3575 =over 4
3577 =item B<From> I<Address>
3579 Email address from which the emails should appear to come from.
3581 Default: C<root@localhost>
3583 =item B<Recipient> I<Address>
3585 Configures the email address(es) to which the notifications should be mailed.
3586 May be repeated to send notifications to multiple addresses.
3588 At least one B<Recipient> must be present for the plugin to work correctly.
3590 =item B<SMTPServer> I<Hostname>
3592 Hostname of the SMTP server to connect to.
3594 Default: C<localhost>
3596 =item B<SMTPPort> I<Port>
3598 TCP port to connect to.
3600 Default: C<25>
3602 =item B<SMTPUser> I<Username>
3604 Username for ASMTP authentication. Optional.
3606 =item B<SMTPPassword> I<Password>
3608 Password for ASMTP authentication. Optional.
3610 =item B<Subject> I<Subject>
3612 Subject-template to use when sending emails. There must be exactly two
3613 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3614 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3615 with the hostname.
3617 Default: C<Collectd notify: %s@%s>
3619 =back
3621 =head2 Plugin C<ntpd>
3623 =over 4
3625 =item B<Host> I<Hostname>
3627 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3629 =item B<Port> I<Port>
3631 UDP-Port to connect to. Defaults to B<123>.
3633 =item B<ReverseLookups> B<true>|B<false>
3635 Sets whether or not to perform reverse lookups on peers. Since the name or
3636 IP-address may be used in a filename it is recommended to disable reverse
3637 lookups. The default is to do reverse lookups to preserve backwards
3638 compatibility, though.
3640 =item B<IncludeUnitID> B<true>|B<false>
3642 When a peer is a refclock, include the unit ID in the I<type instance>.
3643 Defaults to B<false> for backward compatibility.
3645 If two refclock peers use the same driver and this is B<false>, the plugin will
3646 try to write simultaneous measurements from both to the same type instance.
3647 This will result in error messages in the log and only one set of measurements
3648 making it through.
3650 =back
3652 =head2 Plugin C<nut>
3654 =over 4
3656 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3658 Add a UPS to collect data from. The format is identical to the one accepted by
3659 L<upsc(8)>.
3661 =back
3663 =head2 Plugin C<olsrd>
3665 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3666 the Optimized Link State Routing daemon and reads information about the current
3667 state of the meshed network.
3669 The following configuration options are understood:
3671 =over 4
3673 =item B<Host> I<Host>
3675 Connect to I<Host>. Defaults to B<"localhost">.
3677 =item B<Port> I<Port>
3679 Specifies the port to connect to. This must be a string, even if you give the
3680 port as a number rather than a service name. Defaults to B<"2006">.
3682 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3684 Specifies what information to collect about links, i.E<nbsp>e. direct
3685 connections of the daemon queried. If set to B<No>, no information is
3686 collected. If set to B<Summary>, the number of links and the average of all
3687 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3688 If set to B<Detail> LQ and NLQ are collected per link.
3690 Defaults to B<Detail>.
3692 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3694 Specifies what information to collect about routes of the daemon queried. If
3695 set to B<No>, no information is collected. If set to B<Summary>, the number of
3696 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3697 metric and ETX are collected per route.
3699 Defaults to B<Summary>.
3701 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3703 Specifies what information to collect about the global topology. If set to
3704 B<No>, no information is collected. If set to B<Summary>, the number of links
3705 in the entire topology and the average I<link quality> (LQ) is calculated.
3706 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3708 Defaults to B<Summary>.
3710 =back
3712 =head2 Plugin C<onewire>
3714 B<EXPERIMENTAL!> See notes below.
3716 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3717 L<http://owfs.org/> to read sensors connected via the onewire bus.
3719 Currently only temperature sensors (sensors with the family code C<10>,
3720 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3721 would like to have included, please send a sort request to the mailing list.
3723 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3724 experimental, below.
3726 =over 4
3728 =item B<Device> I<Device>
3730 Sets the device to read the values from. This can either be a "real" hardware
3731 device, such as a serial port or an USB port, or the address of the
3732 L<owserver(1)> socket, usually B<localhost:4304>.
3734 Though the documentation claims to automatically recognize the given address
3735 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3736 with that version, the following configuration worked for us:
3738   <Plugin onewire>
3739     Device "-s localhost:4304"
3740   </Plugin>
3742 This directive is B<required> and does not have a default value.
3744 =item B<Sensor> I<Sensor>
3746 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3747 below. Sensors are specified without the family byte at the beginning, to you'd
3748 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3749 point.
3751 =item B<IgnoreSelected> I<true>|I<false>
3753 If no configuration if given, the B<onewire> plugin will collect data from all
3754 sensors found. This may not be practical, especially if sensors are added and
3755 removed regularly. Sometimes, however, it's easier/preferred to collect only
3756 specific sensors or all sensors I<except> a few specified ones. This option
3757 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3758 B<Sensor> is inverted: All selected interfaces are ignored and all other
3759 interfaces are collected.
3761 =item B<Interval> I<Seconds>
3763 Sets the interval in which all sensors should be read. If not specified, the
3764 global B<Interval> setting is used.
3766 =back
3768 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3769 work with big setups. It works with one sensor being attached to one
3770 controller, but as soon as you throw in a couple more senors and maybe a hub
3771 or two, reading all values will take more than ten seconds (the default
3772 interval). We will probably add some separate thread for reading the sensors
3773 and some cache or something like that, but it's not done yet. We will try to
3774 maintain backwards compatibility in the future, but we can't promise. So in
3775 short: If it works for you: Great! But keep in mind that the config I<might>
3776 change, though this is unlikely. Oh, and if you want to help improving this
3777 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
3779 =head2 Plugin C<openvpn>
3781 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
3782 traffic statistics about connected clients.
3784 To set up OpenVPN to write to the status file periodically, use the
3785 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
3786 you need to set the required format, too. This is done by setting
3787 B<--status-version> to B<2>.
3789 So, in a nutshell you need:
3791   openvpn $OTHER_OPTIONS \
3792     --status "/var/run/openvpn-status" 10 \
3793     --status-version 2
3795 Available options:
3797 =over 4
3799 =item B<StatusFile> I<File>
3801 Specifies the location of the status file.
3803 =item B<ImprovedNamingSchema> B<true>|B<false>
3805 When enabled, the filename of the status file will be used as plugin instance
3806 and the client's "common name" will be used as type instance. This is required
3807 when reading multiple status files. Enabling this option is recommended, but to
3808 maintain backwards compatibility this option is disabled by default.
3810 =item B<CollectCompression> B<true>|B<false>
3812 Sets whether or not statistics about the compression used by OpenVPN should be
3813 collected. This information is only available in I<single> mode. Enabled by
3814 default.
3816 =item B<CollectIndividualUsers> B<true>|B<false>
3818 Sets whether or not traffic information is collected for each connected client
3819 individually. If set to false, currently no traffic data is collected at all
3820 because aggregating this data in a save manner is tricky. Defaults to B<true>.
3822 =item B<CollectUserCount> B<true>|B<false>
3824 When enabled, the number of currently connected clients or users is collected.
3825 This is especially interesting when B<CollectIndividualUsers> is disabled, but
3826 can be configured independently from that option. Defaults to B<false>.
3828 =back
3830 =head2 Plugin C<oracle>
3832 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
3833 Oracle® Database and lets you execute SQL statements there. It is very similar
3834 to the "dbi" plugin, because it was written around the same time. See the "dbi"
3835 plugin's documentation above for details.
3837   <Plugin oracle>
3838     <Query "out_of_stock">
3839       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
3840       <Result>
3841         Type "gauge"
3842         # InstancePrefix "foo"
3843         InstancesFrom "category"
3844         ValuesFrom "value"
3845       </Result>
3846     </Query>
3847     <Database "product_information">
3848       ConnectID "db01"
3849       Username "oracle"
3850       Password "secret"
3851       Query "out_of_stock"
3852     </Database>
3853   </Plugin>
3855 =head3 B<Query> blocks
3857 The Query blocks are handled identically to the Query blocks of the "dbi"
3858 plugin. Please see its documentation above for details on how to specify
3859 queries.
3861 =head3 B<Database> blocks
3863 Database blocks define a connection to a database and which queries should be
3864 sent to that database. Each database needs a "name" as string argument in the
3865 starting tag of the block. This name will be used as "PluginInstance" in the
3866 values submitted to the daemon. Other than that, that name is not used.
3868 =over 4
3870 =item B<ConnectID> I<ID>
3872 Defines the "database alias" or "service name" to connect to. Usually, these
3873 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
3875 =item B<Host> I<Host>
3877 Hostname to use when dispatching values for this database. Defaults to using
3878 the global hostname of the I<collectd> instance.
3880 =item B<Username> I<Username>
3882 Username used for authentication.
3884 =item B<Password> I<Password>
3886 Password used for authentication.
3888 =item B<Query> I<QueryName>
3890 Associates the query named I<QueryName> with this database connection. The
3891 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
3892 blocks you want to refer to must be placed above the database block you want to
3893 refer to them from.
3895 =back
3897 =head2 Plugin C<perl>
3899 This plugin embeds a Perl-interpreter into collectd and provides an interface
3900 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
3902 =head2 Plugin C<pinba>
3904 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
3905 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
3906 PHP-based webpage has been delivered, the extension will send a UDP packet
3907 containing timing information, peak memory usage and so on. The plugin will
3908 wait for such packets, parse them and account the provided information, which
3909 is then dispatched to the daemon once per interval.
3911 Synopsis:
3913  <Plugin pinba>
3914    Address "::0"
3915    Port "30002"
3916    # Overall statistics for the website.
3917    <View "www-total">
3918      Server "www.example.com"
3919    </View>
3920    # Statistics for www-a only
3921    <View "www-a">
3922      Host "www-a.example.com"
3923      Server "www.example.com"
3924    </View>
3925    # Statistics for www-b only
3926    <View "www-b">
3927      Host "www-b.example.com"
3928      Server "www.example.com"
3929    </View>
3930  </Plugin>
3932 The plugin provides the following configuration options:
3934 =over 4
3936 =item B<Address> I<Node>
3938 Configures the address used to open a listening socket. By default, plugin will
3939 bind to the I<any> address C<::0>.
3941 =item B<Port> I<Service>
3943 Configures the port (service) to bind to. By default the default Pinba port
3944 "30002" will be used. The option accepts service names in addition to port
3945 numbers and thus requires a I<string> argument.
3947 =item E<lt>B<View> I<Name>E<gt> block
3949 The packets sent by the Pinba extension include the hostname of the server, the
3950 server name (the name of the virtual host) and the script that was executed.
3951 Using B<View> blocks it is possible to separate the data into multiple groups
3952 to get more meaningful statistics. Each packet is added to all matching groups,
3953 so that a packet may be accounted for more than once.
3955 =over 4
3957 =item B<Host> I<Host>
3959 Matches the hostname of the system the webserver / script is running on. This
3960 will contain the result of the L<gethostname(2)> system call. If not
3961 configured, all hostnames will be accepted.
3963 =item B<Server> I<Server>
3965 Matches the name of the I<virtual host>, i.e. the contents of the
3966 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
3967 server names will be accepted.
3969 =item B<Script> I<Script>
3971 Matches the name of the I<script name>, i.e. the contents of the
3972 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
3973 script names will be accepted.
3975 =back
3977 =back
3979 =head2 Plugin C<ping>
3981 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
3982 configured hosts periodically and measures the network latency. Whenever the
3983 C<read> function of the plugin is called, it submits the average latency, the
3984 standard deviation and the drop rate for each host.
3986 Available configuration options:
3988 =over 4
3990 =item B<Host> I<IP-address>
3992 Host to ping periodically. This option may be repeated several times to ping
3993 multiple hosts.
3995 =item B<Interval> I<Seconds>
3997 Sets the interval in which to send ICMP echo packets to the configured hosts.
3998 This is B<not> the interval in which statistics are queries from the plugin but
3999 the interval in which the hosts are "pinged". Therefore, the setting here
4000 should be smaller than or equal to the global B<Interval> setting. Fractional
4001 times, such as "1.24" are allowed.
4003 Default: B<1.0>
4005 =item B<Timeout> I<Seconds>
4007 Time to wait for a response from the host to which an ICMP packet had been
4008 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4009 to be down or the packet to be dropped. This setting must be smaller than the
4010 B<Interval> setting above for the plugin to work correctly. Fractional
4011 arguments are accepted.
4013 Default: B<0.9>
4015 =item B<TTL> I<0-255>
4017 Sets the Time-To-Live of generated ICMP packets.
4019 =item B<SourceAddress> I<host>
4021 Sets the source address to use. I<host> may either be a numerical network
4022 address or a network hostname.
4024 =item B<Device> I<name>
4026 Sets the outgoing network device to be used. I<name> has to specify an
4027 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4028 operating systems.
4030 =item B<MaxMissed> I<Packets>
4032 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4033 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4035 Default: B<-1> (disabled)
4037 =back
4039 =head2 Plugin C<postgresql>
4041 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4042 keeps a persistent connection to all configured databases and tries to
4043 reconnect if the connection has been interrupted. A database is configured by
4044 specifying a B<Database> block as described below. The default statistics are
4045 collected from PostgreSQL's B<statistics collector> which thus has to be
4046 enabled for this plugin to work correctly. This should usually be the case by
4047 default. See the section "The Statistics Collector" of the B<PostgreSQL
4048 Documentation> for details.
4050 By specifying custom database queries using a B<Query> block as described
4051 below, you may collect any data that is available from some PostgreSQL
4052 database. This way, you are able to access statistics of external daemons
4053 which are available in a PostgreSQL database or use future or special
4054 statistics provided by PostgreSQL without the need to upgrade your collectd
4055 installation.
4057 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4058 PostgreSQL databases as well. This has been implemented in a generic way. You
4059 need to specify an SQL statement which will then be executed by collectd in
4060 order to write the data (see below for details). The benefit of that approach
4061 is that there is no fixed database layout. Rather, the layout may be optimized
4062 for the current setup.
4064 The B<PostgreSQL Documentation> manual can be found at
4065 L<http://www.postgresql.org/docs/manuals/>.
4067   <Plugin postgresql>
4068     <Query magic>
4069       Statement "SELECT magic FROM wizard WHERE host = $1;"
4070       Param hostname
4071       <Result>
4072         Type gauge
4073         InstancePrefix "magic"
4074         ValuesFrom magic
4075       </Result>
4076     </Query>
4078     <Query rt36_tickets>
4079       Statement "SELECT COUNT(type) AS count, type \
4080                         FROM (SELECT CASE \
4081                                      WHEN resolved = 'epoch' THEN 'open' \
4082                                      ELSE 'resolved' END AS type \
4083                                      FROM tickets) type \
4084                         GROUP BY type;"
4085       <Result>
4086         Type counter
4087         InstancePrefix "rt36_tickets"
4088         InstancesFrom "type"
4089         ValuesFrom "count"
4090       </Result>
4091     </Query>
4093     <Writer sqlstore>
4094       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4095       StoreRates true
4096     </Writer>
4098     <Database foo>
4099       Host "hostname"
4100       Port "5432"
4101       User "username"
4102       Password "secret"
4103       SSLMode "prefer"
4104       KRBSrvName "kerberos_service_name"
4105       Query magic
4106     </Database>
4108     <Database bar>
4109       Interval 300
4110       Service "service_name"
4111       Query backend # predefined
4112       Query rt36_tickets
4113     </Database>
4115     <Database qux>
4116       # ...
4117       Writer sqlstore
4118       CommitInterval 10
4119     </Database>
4120   </Plugin>
4122 The B<Query> block defines one database query which may later be used by a
4123 database definition. It accepts a single mandatory argument which specifies
4124 the name of the query. The names of all queries have to be unique (see the
4125 B<MinVersion> and B<MaxVersion> options below for an exception to this
4126 rule). The following configuration options are available to define the query:
4128 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4129 blocks define how to handle the values returned from the query. They define
4130 which column holds which value and how to dispatch that value to the daemon.
4131 Multiple B<Result> blocks may be used to extract multiple values from a single
4132 query.
4134 =over 4
4136 =item B<Statement> I<sql query statement>
4138 Specify the I<sql query statement> which the plugin should execute. The string
4139 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4140 first, second, etc. parameter. The value of the parameters is specified by the
4141 B<Param> configuration option - see below for details. To include a literal
4142 B<$> character followed by a number, surround it with single quotes (B<'>).
4144 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4145 allowed. Note, however, that only a single command may be used. Semicolons are
4146 allowed as long as a single non-empty command has been specified only.
4148 The returned lines will be handled separately one after another.
4150 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4152 Specify the parameters which should be passed to the SQL query. The parameters
4153 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4154 they appear in the configuration file. The value of the parameter is
4155 determined depending on the value of the B<Param> option as follows:
4157 =over 4
4159 =item I<hostname>
4161 The configured hostname of the database connection. If a UNIX domain socket is
4162 used, the parameter expands to "localhost".
4164 =item I<database>
4166 The name of the database of the current connection.
4168 =item I<instance>
4170 The name of the database plugin instance. See the B<Instance> option of the
4171 database specification below for details.
4173 =item I<username>
4175 The username used to connect to the database.
4177 =item I<interval>
4179 The interval with which this database is queried (as specified by the database
4180 specific or global B<Interval> options).
4182 =back
4184 Please note that parameters are only supported by PostgreSQL's protocol
4185 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4187 =item B<Type> I<type>
4189 The I<type> name to be used when dispatching the values. The type describes
4190 how to handle the data and where to store it. See L<types.db(5)> for more
4191 details on types and their configuration. The number and type of values (as
4192 selected by the B<ValuesFrom> option) has to match the type of the given name.
4194 This option is required inside a B<Result> block.
4196 =item B<InstancePrefix> I<prefix>
4198 =item B<InstancesFrom> I<column0> [I<column1> ...]
4200 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4201 B<InstancePrefix> defines a static prefix that will be prepended to all type
4202 instances. B<InstancesFrom> defines the column names whose values will be used
4203 to create the type instance. Multiple values will be joined together using the
4204 hyphen (C<->) as separation character.
4206 The plugin itself does not check whether or not all built instances are
4207 different. It is your responsibility to assure that each is unique.
4209 Both options are optional. If none is specified, the type instance will be
4210 empty.
4212 =item B<ValuesFrom> I<column0> [I<column1> ...]
4214 Names the columns whose content is used as the actual data for the data sets
4215 that are dispatched to the daemon. How many such columns you need is
4216 determined by the B<Type> setting as explained above. If you specify too many
4217 or not enough columns, the plugin will complain about that and no data will be
4218 submitted to the daemon.
4220 The actual data type, as seen by PostgreSQL, is not that important as long as
4221 it represents numbers. The plugin will automatically cast the values to the
4222 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4223 L<strtod(3)> functions, so anything supported by those functions is supported
4224 by the plugin as well.
4226 This option is required inside a B<Result> block and may be specified multiple
4227 times. If multiple B<ValuesFrom> options are specified, the columns are read
4228 in the given order.
4230 =item B<MinVersion> I<version>
4232 =item B<MaxVersion> I<version>
4234 Specify the minimum or maximum version of PostgreSQL that this query should be
4235 used with. Some statistics might only be available with certain versions of
4236 PostgreSQL. This allows you to specify multiple queries with the same name but
4237 which apply to different versions, thus allowing you to use the same
4238 configuration in a heterogeneous environment.
4240 The I<version> has to be specified as the concatenation of the major, minor
4241 and patch-level versions, each represented as two-decimal-digit numbers. For
4242 example, version 8.2.3 will become 80203.
4244 =back
4246 The following predefined queries are available (the definitions can be found
4247 in the F<postgresql_default.conf> file which, by default, is available at
4248 C<I<prefix>/share/collectd/>):
4250 =over 4
4252 =item B<backends>
4254 This query collects the number of backends, i.E<nbsp>e. the number of
4255 connected clients.
4257 =item B<transactions>
4259 This query collects the numbers of committed and rolled-back transactions of
4260 the user tables.
4262 =item B<queries>
4264 This query collects the numbers of various table modifications (i.E<nbsp>e.
4265 insertions, updates, deletions) of the user tables.
4267 =item B<query_plans>
4269 This query collects the numbers of various table scans and returned tuples of
4270 the user tables.
4272 =item B<table_states>
4274 This query collects the numbers of live and dead rows in the user tables.
4276 =item B<disk_io>
4278 This query collects disk block access counts for user tables.
4280 =item B<disk_usage>
4282 This query collects the on-disk size of the database in bytes.
4284 =back
4286 In addition, the following detailed queries are available by default. Please
4287 note that each of those queries collects information B<by table>, thus,
4288 potentially producing B<a lot> of data. For details see the description of the
4289 non-by_table queries above.
4291 =over 4
4293 =item B<queries_by_table>
4295 =item B<query_plans_by_table>
4297 =item B<table_states_by_table>
4299 =item B<disk_io_by_table>
4301 =back
4303 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4304 mandatory argument specifying the name of the writer. This will then be used
4305 in the B<Database> specification in order to activate the writer instance. The
4306 names of all writers have to be unique. The following options may be
4307 specified:
4309 =over 4
4311 =item B<Statement> I<sql statement>
4313 This mandatory option specifies the SQL statement that will be executed for
4314 each submitted value. A single SQL statement is allowed only. Anything after
4315 the first semicolon will be ignored.
4317 Nine parameters will be passed to the statement and should be specified as
4318 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4319 values are made available through those parameters:
4321 =over 4
4323 =item B<$1>
4325 The timestamp of the queried value as a floating point number.
4327 =item B<$2>
4329 The hostname of the queried value.
4331 =item B<$3>
4333 The plugin name of the queried value.
4335 =item B<$4>
4337 The plugin instance of the queried value. This value may be B<NULL> if there
4338 is no plugin instance.
4340 =item B<$5>
4342 The type of the queried value (cf. L<types.db(5)>).
4344 =item B<$6>
4346 The type instance of the queried value. This value may be B<NULL> if there is
4347 no type instance.
4349 =item B<$7>
4351 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4352 sources of the submitted value-list).
4354 =item B<$8>
4356 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4357 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4358 B<StoreRates> is enabled (which is the default, see below), all types will be
4359 C<gauge>.
4361 =item B<$9>
4363 An array of the submitted values. The dimensions of the value name and value
4364 arrays match.
4366 =back
4368 In general, it is advisable to create and call a custom function in the
4369 PostgreSQL database for this purpose. Any procedural language supported by
4370 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4371 for details).
4373 =item B<StoreRates> B<false>|B<true>
4375 If set to B<true> (the default), convert counter values to rates. If set to
4376 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4377 number.
4379 =back
4381 The B<Database> block defines one PostgreSQL database for which to collect
4382 statistics. It accepts a single mandatory argument which specifies the
4383 database name. None of the other options are required. PostgreSQL will use
4384 default values as documented in the section "CONNECTING TO A DATABASE" in the
4385 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4386 the user collectd is run as and special environment variables. See the manpage
4387 for details.
4389 =over 4
4391 =item B<Interval> I<seconds>
4393 Specify the interval with which the database should be queried. The default is
4394 to use the global B<Interval> setting.
4396 =item B<CommitInterval> I<seconds>
4398 This option may be used for database connections which have "writers" assigned
4399 (see above). If specified, it causes a writer to put several updates into a
4400 single transaction. This transaction will last for the specified amount of
4401 time. By default, each update will be executed in a separate transaction. Each
4402 transaction generates a fair amount of overhead which can, thus, be reduced by
4403 activating this option. The draw-back is, that data covering the specified
4404 amount of time will be lost, for example, if a single statement within the
4405 transaction fails or if the database server crashes.
4407 =item B<Host> I<hostname>
4409 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4410 value begins with a slash, it is interpreted as the directory name in which to
4411 look for the UNIX domain socket.
4413 This option is also used to determine the hostname that is associated with a
4414 collected data set. If it has been omitted or either begins with with a slash
4415 or equals B<localhost> it will be replaced with the global hostname definition
4416 of collectd. Any other value will be passed literally to collectd when
4417 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4419 =item B<Port> I<port>
4421 Specify the TCP port or the local UNIX domain socket file extension of the
4422 server.
4424 =item B<User> I<username>
4426 Specify the username to be used when connecting to the server.
4428 =item B<Password> I<password>
4430 Specify the password to be used when connecting to the server.
4432 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4434 Specify whether to use an SSL connection when contacting the server. The
4435 following modes are supported:
4437 =item B<Instance> I<name>
4439 Specify the plugin instance name that should be used instead of the database
4440 name (which is the default, if this option has not been specified). This
4441 allows to query multiple databases of the same name on the same host (e.g.
4442 when running multiple database server versions in parallel).
4444 =over 4
4446 =item I<disable>
4448 Do not use SSL at all.
4450 =item I<allow>
4452 First, try to connect without using SSL. If that fails, try using SSL.
4454 =item I<prefer> (default)
4456 First, try to connect using SSL. If that fails, try without using SSL.
4458 =item I<require>
4460 Use SSL only.
4462 =back
4464 =item B<KRBSrvName> I<kerberos_service_name>
4466 Specify the Kerberos service name to use when authenticating with Kerberos 5
4467 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4468 B<PostgreSQL Documentation> for details.
4470 =item B<Service> I<service_name>
4472 Specify the PostgreSQL service name to use for additional parameters. That
4473 service has to be defined in F<pg_service.conf> and holds additional
4474 connection parameters. See the section "The Connection Service File" in the
4475 B<PostgreSQL Documentation> for details.
4477 =item B<Query> I<query>
4479 Specifies a I<query> which should be executed in the context of the database
4480 connection. This may be any of the predefined or user-defined queries. If no
4481 such option is given, it defaults to "backends", "transactions", "queries",
4482 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4483 has been specified). Else, the specified queries are used only.
4485 =item B<Writer> I<writer>
4487 Assigns the specified I<writer> backend to the database connection. This
4488 causes all collected data to be send to the database using the settings
4489 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4490 below for details on how to selectively send data to certain plugins).
4492 Each writer will register a flush callback which may be used when having long
4493 transactions enabled (see the B<CommitInterval> option above). When issuing
4494 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4495 transaction will be committed right away. Two different kinds of flush
4496 callbacks are available with the C<postgresql> plugin:
4498 =over 4
4500 =item B<postgresql>
4502 Flush all writer backends.
4504 =item B<postgresql->I<database>
4506 Flush all writers of the specified I<database> only.
4508 =back
4510 =back
4512 =head2 Plugin C<powerdns>
4514 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4515 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4516 values, many of which are probably meaningless to most users, but may be useful
4517 for some. So you may chose which values to collect, but if you don't, some
4518 reasonable defaults will be collected.
4520   <Plugin "powerdns">
4521     <Server "server_name">
4522       Collect "latency"
4523       Collect "udp-answers" "udp-queries"
4524       Socket "/var/run/pdns.controlsocket"
4525     </Server>
4526     <Recursor "recursor_name">
4527       Collect "questions"
4528       Collect "cache-hits" "cache-misses"
4529       Socket "/var/run/pdns_recursor.controlsocket"
4530     </Recursor>
4531     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4532   </Plugin>
4534 =over 4
4536 =item B<Server> and B<Recursor> block
4538 The B<Server> block defines one authoritative server to query, the B<Recursor>
4539 does the same for an recursing server. The possible options in both blocks are
4540 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4541 and is required.
4543 =over 4
4545 =item B<Collect> I<Field>
4547 Using the B<Collect> statement you can select which values to collect. Here,
4548 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4549 C<dlg-only-drops>, C<answers10-100>.
4551 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4552 When querying the server a C<SHOW *> command is issued in any case, because
4553 that's the only way of getting multiple values out of the server at once.
4554 collectd then picks out the values you have selected. When querying the
4555 recursor, a command is generated to query exactly these values. So if you
4556 specify invalid fields when querying the recursor, a syntax error may be
4557 returned by the daemon and collectd may not collect any values at all.
4559 If no B<Collect> statement is given, the following B<Server> values will be
4560 collected:
4562 =over 4
4564 =item latency
4566 =item packetcache-hit
4568 =item packetcache-miss
4570 =item packetcache-size
4572 =item query-cache-hit
4574 =item query-cache-miss
4576 =item recursing-answers
4578 =item recursing-questions
4580 =item tcp-answers
4582 =item tcp-queries
4584 =item udp-answers
4586 =item udp-queries
4588 =back
4590 The following B<Recursor> values will be collected by default:
4592 =over 4
4594 =item noerror-answers
4596 =item nxdomain-answers
4598 =item servfail-answers
4600 =item sys-msec
4602 =item user-msec
4604 =item qa-latency
4606 =item cache-entries
4608 =item cache-hits
4610 =item cache-misses
4612 =item questions
4614 =back
4616 Please note that up to that point collectd doesn't know what values are
4617 available on the server and values that are added do not need a change of the
4618 mechanism so far. However, the values must be mapped to collectd's naming
4619 scheme, which is done using a lookup table that lists all known values. If
4620 values are added in the future and collectd does not know about them, you will
4621 get an error much like this:
4623   powerdns plugin: submit: Not found in lookup table: foobar = 42
4625 In this case please file a bug report with the collectd team.
4627 =item B<Socket> I<Path>
4629 Configures the path to the UNIX domain socket to be used when connecting to the
4630 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4631 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4632 will be used for the recursor.
4634 =back
4636 =item B<LocalSocket> I<Path>
4638 Querying the recursor is done using UDP. When using UDP over UNIX domain
4639 sockets, the client socket needs a name in the file system, too. You can set
4640 this local name to I<Path> using the B<LocalSocket> option. The default is
4641 C<I<prefix>/var/run/collectd-powerdns>.
4643 =back
4645 =head2 Plugin C<processes>
4647 =over 4
4649 =item B<Process> I<Name>
4651 Select more detailed statistics of processes matching this name. The statistics
4652 collected for these selected processes are size of the resident segment size
4653 (RSS), user- and system-time used, number of processes and number of threads,
4654 io data (where available) and minor and major pagefaults.
4656 =item B<ProcessMatch> I<name> I<regex>
4658 Similar to the B<Process> option this allows to select more detailed
4659 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4660 details). The statistics of all matching processes are summed up and
4661 dispatched to the daemon using the specified I<name> as an identifier. This
4662 allows to "group" several processes together. I<name> must not contain
4663 slashes.
4665 =back
4667 =head2 Plugin C<protocols>
4669 Collects a lot of information about various network protocols, such as I<IP>,
4670 I<TCP>, I<UDP>, etc.
4672 Available configuration options:
4674 =over 4
4676 =item B<Value> I<Selector>
4678 Selects whether or not to select a specific value. The string being matched is
4679 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4680 plugin instance and I<ValueName> will be used as type instance. An example of
4681 the string being used would be C<Tcp:RetransSegs>.
4683 You can use regular expressions to match a large number of values with just one
4684 configuration option. To select all "extended" I<TCP> values, you could use the
4685 following statement:
4687   Value "/^TcpExt:/"
4689 Whether only matched values are selected or all matched values are ignored
4690 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4691 If no value is configured at all, all values will be selected.
4693 =item B<IgnoreSelected> B<true>|B<false>
4695 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4696 matching values will be ignored.
4698 =back
4700 =head2 Plugin C<python>
4702 This plugin embeds a Python-interpreter into collectd and provides an interface
4703 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4705 =head2 Plugin C<routeros>
4707 The C<routeros> plugin connects to a device running I<RouterOS>, the
4708 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4709 I<librouteros> to connect and reads information about the interfaces and
4710 wireless connections of the device. The configuration supports querying
4711 multiple routers:
4713   <Plugin "routeros">
4714     <Router>
4715       Host "router0.example.com"
4716       User "collectd"
4717       Password "secr3t"
4718       CollectInterface true
4719       CollectCPULoad true
4720       CollectMemory true
4721     </Router>
4722     <Router>
4723       Host "router1.example.com"
4724       User "collectd"
4725       Password "5ecret"
4726       CollectInterface true
4727       CollectRegistrationTable true
4728       CollectDF true
4729       CollectDisk true
4730     </Router>
4731   </Plugin>
4733 As you can see above, the configuration of the I<routeros> plugin consists of
4734 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4735 options are understood:
4737 =over 4
4739 =item B<Host> I<Host>
4741 Hostname or IP-address of the router to connect to.
4743 =item B<Port> I<Port>
4745 Port name or port number used when connecting. If left unspecified, the default
4746 will be chosen by I<librouteros>, currently "8728". This option expects a
4747 string argument, even when a numeric port number is given.
4749 =item B<User> I<User>
4751 Use the user name I<User> to authenticate. Defaults to "admin".
4753 =item B<Password> I<Password>
4755 Set the password used to authenticate.
4757 =item B<CollectInterface> B<true>|B<false>
4759 When set to B<true>, interface statistics will be collected for all interfaces
4760 present on the device. Defaults to B<false>.
4762 =item B<CollectRegistrationTable> B<true>|B<false>
4764 When set to B<true>, information about wireless LAN connections will be
4765 collected. Defaults to B<false>.
4767 =item B<CollectCPULoad> B<true>|B<false>
4769 When set to B<true>, information about the CPU usage will be collected. The
4770 number is a dimensionless value where zero indicates no CPU usage at all.
4771 Defaults to B<false>.
4773 =item B<CollectMemory> B<true>|B<false>
4775 When enabled, the amount of used and free memory will be collected. How used
4776 memory is calculated is unknown, for example whether or not caches are counted
4777 as used space.
4778 Defaults to B<false>.
4780 =item B<CollectDF> B<true>|B<false>
4782 When enabled, the amount of used and free disk space will be collected.
4783 Defaults to B<false>.
4785 =item B<CollectDisk> B<true>|B<false>
4787 When enabled, the number of sectors written and bad blocks will be collected.
4788 Defaults to B<false>.
4790 =back
4792 =head2 Plugin C<redis>
4794 The I<Redis plugin> connects to one or more Redis servers and gathers
4795 information about each server's state. For each server there is a I<Node> block
4796 which configures the connection parameters for this node.
4798   <Plugin redis>
4799     <Node "example">
4800         Host "localhost"
4801         Port "6379"
4802         Timeout 2000
4803     </Node>
4804   </Plugin>
4806 The information shown in the synopsis above is the I<default configuration>
4807 which is used by the plugin if no configuration is present.
4809 =over 4
4811 =item B<Node> I<Nodename>
4813 The B<Node> block identifies a new Redis node, that is a new Redis instance
4814 running in an specified host and port. The name for node is a canonical
4815 identifier which is used as I<plugin instance>. It is limited to
4816 64E<nbsp>characters in length.
4818 =item B<Host> I<Hostname>
4820 The B<Host> option is the hostname or IP-address where the Redis instance is
4821 running on.
4823 =item B<Port> I<Port>
4825 The B<Port> option is the TCP port on which the Redis instance accepts
4826 connections. Either a service name of a port number may be given. Please note
4827 that numerical port numbers must be given as a string, too.
4829 =item B<Password> I<Password>
4831 Use I<Password> to authenticate when connecting to I<Redis>.
4833 =item B<Timeout> I<Timeout in miliseconds>
4835 The B<Timeout> option set the socket timeout for node response. Since the Redis
4836 read function is blocking, you should keep this value as low as possible. Keep
4837 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
4838 than B<Interval> defined globally.
4840 =back
4842 =head2 Plugin C<rrdcached>
4844 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
4845 to store values to RRD files in an efficient manner. The combination of the
4846 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
4847 way the C<rrdtool> plugin works (see below). The added abstraction layer
4848 provides a number of benefits, though: Because the cache is not within
4849 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
4850 restarted. This results in much shorter (if any) gaps in graphs, especially
4851 under heavy load. Also, the C<rrdtool> command line utility is aware of the
4852 daemon so that it can flush values to disk automatically when needed. This
4853 allows to integrate automated flushing of values into graphing solutions much
4854 more easily.
4856 There are disadvantages, though: The daemon may reside on a different host, so
4857 it may not be possible for C<collectd> to create the appropriate RRD files
4858 anymore. And even if C<rrdcached> runs on the same host, it may run in a
4859 different base directory, so relative paths may do weird stuff if you're not
4860 careful.
4862 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
4863 on the same host, communicating via a UNIX domain socket. The B<DataDir>
4864 setting should be set to an absolute path, so that a changed base directory
4865 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
4867 =over 4
4869 =item B<DaemonAddress> I<Address>
4871 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
4872 library. See L<rrdcached(1)> for details. Example:
4874   <Plugin "rrdcached">
4875     DaemonAddress "unix:/var/run/rrdcached.sock"
4876   </Plugin>
4878 =item B<DataDir> I<Directory>
4880 Set the base directory in which the RRD files reside. If this is a relative
4881 path, it is relative to the working base directory of the C<rrdcached> daemon!
4882 Use of an absolute path is recommended.
4884 =item B<CreateFiles> B<true>|B<false>
4886 Enables or disables the creation of RRD files. If the daemon is not running
4887 locally, or B<DataDir> is set to a relative path, this will not work as
4888 expected. Default is B<true>.
4890 =item B<CreateFilesAsync> B<false>|B<true>
4892 When enabled, new RRD files are enabled asynchronously, using a separate thread
4893 that runs in the background. This prevents writes to block, which is a problem
4894 especially when many hundreds of files need to be created at once. However,
4895 since the purpose of creating the files asynchronously is I<not> to block until
4896 the file is available, values before the file is available will be discarded.
4897 When disabled (the default) files are created synchronously, blocking for a
4898 short while, while the file is being written.
4900 =item B<StepSize> I<Seconds>
4902 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4903 this setting is unset and the stepsize is set to the interval in which the data
4904 is collected. Do not use this option unless you absolutely have to for some
4905 reason. Setting this option may cause problems with the C<snmp plugin>, the
4906 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4908 =item B<HeartBeat> I<Seconds>
4910 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4911 in which case the heartbeat is set to twice the B<StepSize> which should equal
4912 the interval in which data is collected. Do not set this option unless you have
4913 a very good reason to do so.
4915 =item B<RRARows> I<NumRows>
4917 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4918 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4919 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4920 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4921 week, one month, and one year.
4923 So for each timespan, it calculates how many PDPs need to be consolidated into
4924 one CDP by calculating:
4925   number of PDPs = timespan / (stepsize * rrarows)
4927 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4928 default is 1200.
4930 =item B<RRATimespan> I<Seconds>
4932 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
4933 more then one RRA. If this option is never used, the built-in default of (3600,
4934 86400, 604800, 2678400, 31622400) is used.
4936 For more information on how RRA-sizes are calculated see B<RRARows> above.
4938 =item B<XFF> I<Factor>
4940 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
4941 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
4942 one (exclusive).
4944 =back
4946 =head2 Plugin C<rrdtool>
4948 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
4949 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
4950 using these settings. If you don't want to dive into the depths of RRDtool, you
4951 can safely ignore these settings.
4953 =over 4
4955 =item B<DataDir> I<Directory>
4957 Set the directory to store RRD files under. By default RRD files are generated
4958 beneath the daemon's working directory, i.e. the B<BaseDir>.
4960 =item B<CreateFilesAsync> B<false>|B<true>
4962 When enabled, new RRD files are enabled asynchronously, using a separate thread
4963 that runs in the background. This prevents writes to block, which is a problem
4964 especially when many hundreds of files need to be created at once. However,
4965 since the purpose of creating the files asynchronously is I<not> to block until
4966 the file is available, values before the file is available will be discarded.
4967 When disabled (the default) files are created synchronously, blocking for a
4968 short while, while the file is being written.
4970 =item B<StepSize> I<Seconds>
4972 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
4973 this setting is unset and the stepsize is set to the interval in which the data
4974 is collected. Do not use this option unless you absolutely have to for some
4975 reason. Setting this option may cause problems with the C<snmp plugin>, the
4976 C<exec plugin> or when the daemon is set up to receive data from other hosts.
4978 =item B<HeartBeat> I<Seconds>
4980 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
4981 in which case the heartbeat is set to twice the B<StepSize> which should equal
4982 the interval in which data is collected. Do not set this option unless you have
4983 a very good reason to do so.
4985 =item B<RRARows> I<NumRows>
4987 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
4988 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
4989 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
4990 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
4991 week, one month, and one year.
4993 So for each timespan, it calculates how many PDPs need to be consolidated into
4994 one CDP by calculating:
4995   number of PDPs = timespan / (stepsize * rrarows)
4997 Bottom line is, set this no smaller than the width of you graphs in pixels. The
4998 default is 1200.
5000 =item B<RRATimespan> I<Seconds>
5002 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5003 more then one RRA. If this option is never used, the built-in default of (3600,
5004 86400, 604800, 2678400, 31622400) is used.
5006 For more information on how RRA-sizes are calculated see B<RRARows> above.
5008 =item B<XFF> I<Factor>
5010 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5011 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5012 one (exclusive).
5014 =item B<CacheFlush> I<Seconds>
5016 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5017 it writes all values for a certain RRD-file if the oldest value is older than
5018 (or equal to) the number of seconds specified. If some RRD-file is not updated
5019 anymore for some reason (the computer was shut down, the network is broken,
5020 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5021 entire cache is searched for entries older than B<CacheTimeout> seconds and
5022 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5023 does nothing under normal circumstances, this value should not be too small.
5024 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5025 normally do much harm either.
5027 =item B<CacheTimeout> I<Seconds>
5029 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5030 save values in a cache, as described above. Writing multiple values at once
5031 reduces IO-operations and thus lessens the load produced by updating the files.
5032 The trade off is that the graphs kind of "drag behind" and that more memory is
5033 used.
5035 =item B<WritesPerSecond> I<Updates>
5037 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5038 will run serious performance problems. The B<CacheFlush> setting and the
5039 internal update queue assert that collectd continues to work just fine even
5040 under heavy load, but the system may become very unresponsive and slow. This is
5041 a problem especially if you create graphs from the RRD files on the same
5042 machine, for example using the C<graph.cgi> script included in the
5043 C<contrib/collection3/> directory.
5045 This setting is designed for very large setups. Setting this option to a value
5046 between 25 and 80 updates per second, depending on your hardware, will leave
5047 the server responsive enough to draw graphs even while all the cached values
5048 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5049 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5050 written as fast as possible, so that web frontends have up to date data when
5051 generating graphs.
5053 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5054 updates per second, writing all values to disk will take approximately
5055 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5056 "collection3" you'll end up with a responsive and fast system, up to date
5057 graphs and basically a "backup" of your values every hour.
5059 =item B<RandomTimeout> I<Seconds>
5061 When set, the actual timeout for each value is chosen randomly between
5062 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5063 intention is to avoid high load situations that appear when many values timeout
5064 at the same time. This is especially a problem shortly after the daemon starts,
5065 because all values were added to the internal cache at roughly the same time.
5067 =back
5069 =head2 Plugin C<sensors>
5071 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5072 that all the needed modules have to be loaded and lm_sensors has to be
5073 configured (most likely by editing F</etc/sensors.conf>. Read
5074 L<sensors.conf(5)> for details.
5076 The B<lm_sensors> homepage can be found at
5077 L<http://secure.netroedge.com/~lm78/>.
5079 =over 4
5081 =item B<SensorConfigFile> I<File>
5083 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5084 the library's default will be used.
5086 =item B<Sensor> I<chip-bus-address/type-feature>
5088 Selects the name of the sensor which you want to collect or ignore, depending
5089 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5090 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5091 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5093 =item B<IgnoreSelected> I<true>|I<false>
5095 If no configuration if given, the B<sensors>-plugin will collect data from all
5096 sensors. This may not be practical, especially for uninteresting sensors.
5097 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5098 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5099 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5100 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5101 and all other sensors are collected.
5103 =back
5105 =head2 Plugin C<snmp>
5107 Since the configuration of the C<snmp plugin> is a little more complicated than
5108 other plugins, its documentation has been moved to an own manpage,
5109 L<collectd-snmp(5)>. Please see there for details.
5111 =head2 Plugin C<swap>
5113 The I<Swap plugin> collects information about used and available swap space. On
5114 I<Linux> and I<Solaris>, the following options are available:
5116 =over 4
5118 =item B<ReportByDevice> B<false>|B<true>
5120 Configures how to report physical swap devices. If set to B<false> (the
5121 default), the summary over all swap devices is reported only, i.e. the globally
5122 used and available space over all devices. If B<true> is configured, the used
5123 and available space of each device will be reported separately.
5125 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5126 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5128 =item B<ReportBytes> B<false>|B<true>
5130 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5131 I<swap I/O> is reported in pages. This option is available under Linux only.
5133 =back
5135 =head2 Plugin C<syslog>
5137 =over 4
5139 =item B<LogLevel> B<debug|info|notice|warning|err>
5141 Sets the log-level. If, for example, set to B<notice>, then all events with
5142 severity B<notice>, B<warning>, or B<err> will be submitted to the
5143 syslog-daemon.
5145 Please note that B<debug> is only available if collectd has been compiled with
5146 debugging support.
5148 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5150 Controls which notifications should be sent to syslog. The default behaviour is
5151 not to send any. Less severe notifications always imply logging more severe
5152 notifications: Setting this to B<OKAY> means all notifications will be sent to
5153 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5154 notifications but will dismiss B<OKAY> notifications. Setting this option to
5155 B<FAILURE> will only send failures to syslog.
5157 =back
5159 =head2 Plugin C<table>
5161 The C<table plugin> provides generic means to parse tabular data and dispatch
5162 user specified values. Values are selected based on column numbers. For
5163 example, this plugin may be used to get values from the Linux L<proc(5)>
5164 filesystem or CSV (comma separated values) files.
5166   <Plugin table>
5167     <Table "/proc/slabinfo">
5168       Instance "slabinfo"
5169       Separator " "
5170       <Result>
5171         Type gauge
5172         InstancePrefix "active_objs"
5173         InstancesFrom 0
5174         ValuesFrom 1
5175       </Result>
5176       <Result>
5177         Type gauge
5178         InstancePrefix "objperslab"
5179         InstancesFrom 0
5180         ValuesFrom 4
5181       </Result>
5182     </Table>
5183   </Plugin>
5185 The configuration consists of one or more B<Table> blocks, each of which
5186 configures one file to parse. Within each B<Table> block, there are one or
5187 more B<Result> blocks, which configure which data to select and how to
5188 interpret it.
5190 The following options are available inside a B<Table> block:
5192 =over 4
5194 =item B<Instance> I<instance>
5196 If specified, I<instance> is used as the plugin instance. So, in the above
5197 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5198 filename of the table is used instead, with all special characters replaced
5199 with an underscore (C<_>).
5201 =item B<Separator> I<string>
5203 Any character of I<string> is interpreted as a delimiter between the different
5204 columns of the table. A sequence of two or more contiguous delimiters in the
5205 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5206 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5207 of a table - see its documentation for more details. This option is mandatory.
5209 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5210 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5211 required because of collectd's config parsing.
5213 =back
5215 The following options are available inside a B<Result> block:
5217 =over 4
5219 =item B<Type> I<type>
5221 Sets the type used to dispatch the values to the daemon. Detailed information
5222 about types and their configuration can be found in L<types.db(5)>. This
5223 option is mandatory.
5225 =item B<InstancePrefix> I<prefix>
5227 If specified, prepend I<prefix> to the type instance. If omitted, only the
5228 B<InstancesFrom> option is considered for the type instance.
5230 =item B<InstancesFrom> I<column0> [I<column1> ...]
5232 If specified, the content of the given columns (identified by the column
5233 number starting at zero) will be used to create the type instance for each
5234 row. Multiple values (and the instance prefix) will be joined together with
5235 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5236 option is considered for the type instance.
5238 The plugin itself does not check whether or not all built instances are
5239 different. It’s your responsibility to assure that each is unique. This is
5240 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5241 sure that the table only contains one row.
5243 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5244 will be empty.
5246 =item B<ValuesFrom> I<column0> [I<column1> ...]
5248 Specifies the columns (identified by the column numbers starting at zero)
5249 whose content is used as the actual data for the data sets that are dispatched
5250 to the daemon. How many such columns you need is determined by the B<Type>
5251 setting above. If you specify too many or not enough columns, the plugin will
5252 complain about that and no data will be submitted to the daemon. The plugin
5253 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5254 respectively, so anything supported by those functions is supported by the
5255 plugin as well. This option is mandatory.
5257 =back
5259 =head2 Plugin C<tail>
5261 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5262 each line and dispatches found values. What is matched can be configured by the
5263 user using (extended) regular expressions, as described in L<regex(7)>.
5265   <Plugin "tail">
5266     <File "/var/log/exim4/mainlog">
5267       Instance "exim"
5268       <Match>
5269         Regex "S=([1-9][0-9]*)"
5270         DSType "CounterAdd"
5271         Type "ipt_bytes"
5272         Instance "total"
5273       </Match>
5274       <Match>
5275         Regex "\\<R=local_user\\>"
5276         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5277         DSType "CounterInc"
5278         Type "counter"
5279         Instance "local_user"
5280       </Match>
5281     </File>
5282   </Plugin>
5284 The config consists of one or more B<File> blocks, each of which configures one
5285 logfile to parse. Within each B<File> block, there are one or more B<Match>
5286 blocks, which configure a regular expression to search for.
5288 The B<Instance> option in the B<File> block may be used to set the plugin
5289 instance. So in the above example the plugin name C<tail-foo> would be used.
5290 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5291 next B<Instance> option. This way you can extract several plugin instances from
5292 one logfile, handy when parsing syslog and the like.
5294 Each B<Match> block has the following options to describe how the match should
5295 be performed:
5297 =over 4
5299 =item B<Regex> I<regex>
5301 Sets the regular expression to use for matching against a line. The first
5302 subexpression has to match something that can be turned into a number by
5303 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5304 below. Because B<extended> regular expressions are used, you do not need to use
5305 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5306 collectd's config parsing you need to escape backslashes, though. So if you
5307 want to match literal parentheses you need to do the following:
5309   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5311 =item B<ExcludeRegex> I<regex>
5313 Sets an optional regular expression to use for excluding lines from the match.
5314 An example which excludes all connections from localhost from the match:
5316   ExcludeRegex "127\\.0\\.0\\.1"
5318 =item B<DSType> I<Type>
5320 Sets how the values are cumulated. I<Type> is one of:
5322 =over 4
5324 =item B<GaugeAverage>
5326 Calculate the average.
5328 =item B<GaugeMin>
5330 Use the smallest number only.
5332 =item B<GaugeMax>
5334 Use the greatest number only.
5336 =item B<GaugeLast>
5338 Use the last number found.
5340 =item B<CounterSet>
5342 =item B<DeriveSet>
5344 =item B<AbsoluteSet>
5346 The matched number is a counter. Simply I<sets> the internal counter to this
5347 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5349 =item B<CounterAdd>
5351 =item B<DeriveAdd>
5353 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5354 matched number may be negative, which will effectively subtract from the
5355 internal counter.
5357 =item B<CounterInc>
5359 =item B<DeriveInc>
5361 Increase the internal counter by one. These B<DSType> are the only ones that do
5362 not use the matched subexpression, but simply count the number of matched
5363 lines. Thus, you may use a regular expression without submatch in this case.
5365 =back
5367 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5368 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5369 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5370 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5371 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5372 case.
5374 =item B<Type> I<Type>
5376 Sets the type used to dispatch this value. Detailed information about types and
5377 their configuration can be found in L<types.db(5)>.
5379 =item B<Instance> I<TypeInstance>
5381 This optional setting sets the type instance to use.
5383 =back
5385 =head2 Plugin C<tail_csv>
5387 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5388 written by I<Snort>.
5390 B<Synopsis:>
5392  <Plugin "tail_csv">
5393    <Metric "snort-dropped">
5394        Type "percent"
5395        Instance "dropped"
5396        Index 1
5397    </Metric>
5398    <File "/var/log/snort/snort.stats">
5399        Instance "snort-eth0"
5400        Interval 600
5401        Collect "snort-dropped"
5402    </File>
5403  </Plugin>
5405 The configuration consists of one or more B<Metric> blocks that define an index
5406 into the line of the CSV file and how this value is mapped to I<collectd's>
5407 internal representation. These are followed by one or more B<Instance> blocks
5408 which configure which file to read, in which interval and which metrics to
5409 extract.
5411 =over 4
5413 =item E<lt>B<Metric> I<Name>E<gt>
5415 The B<Metric> block configures a new metric to be extracted from the statistics
5416 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5417 only used inside the B<Instance> blocks to refer to this block, so you can use
5418 one B<Metric> block for multiple CSV files.
5420 =over 4
5422 =item B<Type> I<Type>
5424 Configures which I<Type> to use when dispatching this metric. Types are defined
5425 in the L<types.db(5)> file, see the appropriate manual page for more
5426 information on specifying types. Only types with a single I<data source> are
5427 supported by the I<tail_csv plugin>. The information whether the value is an
5428 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5429 I<Type's> definition.
5431 =item B<Instance> I<TypeInstance>
5433 If set, I<TypeInstance> is used to populate the type instance field of the
5434 created value lists. Otherwise, no type instance is used.
5436 =item B<ValueFrom> I<Index>
5438 Configure to read the value from the field with the zero-based index I<Index>.
5439 If the value is parsed as signed integer, unsigned integer or double depends on
5440 the B<Type> setting, see above.
5442 =back
5444 =item E<lt>B<File> I<Path>E<gt>
5446 Each B<File> block represents one CSV file to read. There must be at least one
5447 I<File> block but there can be multiple if you have multiple CSV files.
5449 =over 4
5451 =item B<Instance> I<PluginInstance>
5453 Sets the I<plugin instance> used when dispatching the values.
5455 =item B<Collect> I<Metric>
5457 Specifies which I<Metric> to collect. This option must be specified at least
5458 once, and you can use this option multiple times to specify more than one
5459 metric to be extracted from this statistic file.
5461 =item B<Interval> I<Seconds>
5463 Configures the interval in which to read values from this instance / file.
5464 Defaults to the plugin's default interval.
5466 =item B<TimeFrom> I<Index>
5468 Rather than using the local time when dispatching a value, read the timestamp
5469 from the field with the zero-based index I<Index>. The value is interpreted as
5470 seconds since epoch. The value is parsed as a double and may be factional.
5472 =back
5474 =back
5476 =head2 Plugin C<teamspeak2>
5478 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5479 polls interesting global and virtual server data. The plugin can query only one
5480 physical server but unlimited virtual servers. You can use the following
5481 options to configure it:
5483 =over 4
5485 =item B<Host> I<hostname/ip>
5487 The hostname or ip which identifies the physical server.
5488 Default: 127.0.0.1
5490 =item B<Port> I<port>
5492 The query port of the physical server. This needs to be a string.
5493 Default: "51234"
5495 =item B<Server> I<port>
5497 This option has to be added once for every virtual server the plugin should
5498 query. If you want to query the virtual server on port 8767 this is what the
5499 option would look like:
5501   Server "8767"
5503 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5504 use quotes around it! If no such statement is given only global information
5505 will be collected.
5507 =back
5509 =head2 Plugin C<ted>
5511 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5512 measure power consumption. These devices are usually connected to a serial
5513 (RS232) or USB port. The plugin opens a configured device and tries to read the
5514 current energy readings. For more information on TED, visit
5515 L<http://www.theenergydetective.com/>.
5517 Available configuration options:
5519 =over 4
5521 =item B<Device> I<Path>
5523 Path to the device on which TED is connected. collectd will need read and write
5524 permissions on that file.
5526 Default: B</dev/ttyUSB0>
5528 =item B<Retries> I<Num>
5530 Apparently reading from TED is not that reliable. You can therefore configure a
5531 number of retries here. You only configure the I<retries> here, to if you
5532 specify zero, one reading will be performed (but no retries if that fails); if
5533 you specify three, a maximum of four readings are performed. Negative values
5534 are illegal.
5536 Default: B<0>
5538 =back
5540 =head2 Plugin C<tcpconns>
5542 The C<tcpconns plugin> counts the number of currently established TCP
5543 connections based on the local port and/or the remote port. Since there may be
5544 a lot of connections the default if to count all connections with a local port,
5545 for which a listening socket is opened. You can use the following options to
5546 fine-tune the ports you are interested in:
5548 =over 4
5550 =item B<ListeningPorts> I<true>|I<false>
5552 If this option is set to I<true>, statistics for all local ports for which a
5553 listening socket exists are collected. The default depends on B<LocalPort> and
5554 B<RemotePort> (see below): If no port at all is specifically selected, the
5555 default is to collect listening ports. If specific ports (no matter if local or
5556 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5557 the selected ports will be collected unless this option is set to I<true>
5558 specifically.
5560 =item B<LocalPort> I<Port>
5562 Count the connections to a specific local port. This can be used to see how
5563 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5564 You have to specify the port in numeric form, so for the mailserver example
5565 you'd need to set B<25>.
5567 =item B<RemotePort> I<Port>
5569 Count the connections to a specific remote port. This is useful to see how
5570 much a remote service is used. This is most useful if you want to know how many
5571 connections a local service has opened to remote services, e.E<nbsp>g. how many
5572 connections a mail server or news server has to other mail or news servers, or
5573 how many connections a web proxy holds to web servers. You have to give the
5574 port in numeric form.
5576 =back
5578 =head2 Plugin C<thermal>
5580 =over 4
5582 =item B<ForceUseProcfs> I<true>|I<false>
5584 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5585 C<sysfs> interface. If that is not available, the plugin falls back to the
5586 C<procfs> interface. By setting this option to I<true>, you can force the
5587 plugin to use the latter. This option defaults to I<false>.
5589 =item B<Device> I<Device>
5591 Selects the name of the thermal device that you want to collect or ignore,
5592 depending on the value of the B<IgnoreSelected> option. This option may be
5593 used multiple times to specify a list of devices.
5595 =item B<IgnoreSelected> I<true>|I<false>
5597 Invert the selection: If set to true, all devices B<except> the ones that
5598 match the device names specified by the B<Device> option are collected. By
5599 default only selected devices are collected if a selection is made. If no
5600 selection is configured at all, B<all> devices are selected.
5602 =back
5604 =head2 Plugin C<threshold>
5606 The I<Threshold plugin> checks values collected or received by I<collectd>
5607 against a configurable I<threshold> and issues I<notifications> if values are
5608 out of bounds.
5610 Documentation for this plugin is available in the L<collectd-threshold(5)>
5611 manual page.
5613 =head2 Plugin C<tokyotyrant>
5615 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5616 couple metrics: number of records, and database size on disk.
5618 =over 4
5620 =item B<Host> I<Hostname/IP>
5622 The hostname or ip which identifies the server.
5623 Default: B<127.0.0.1>
5625 =item B<Port> I<Service/Port>
5627 The query port of the server. This needs to be a string, even if the port is
5628 given in its numeric form.
5629 Default: B<1978>
5631 =back
5633 =head2 Plugin C<unixsock>
5635 =over 4
5637 =item B<SocketFile> I<Path>
5639 Sets the socket-file which is to be created.
5641 =item B<SocketGroup> I<Group>
5643 If running as root change the group of the UNIX-socket after it has been
5644 created. Defaults to B<collectd>.
5646 =item B<SocketPerms> I<Permissions>
5648 Change the file permissions of the UNIX-socket after it has been created. The
5649 permissions must be given as a numeric, octal value as you would pass to
5650 L<chmod(1)>. Defaults to B<0770>.
5652 =item B<DeleteSocket> B<false>|B<true>
5654 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
5655 with the given name already exists. If I<collectd> crashes a socket file may be
5656 left over, preventing the daemon from opening a new socket when restarted.
5657 Since this is potentially dangerous, this defaults to B<false>.
5659 =back
5661 =head2 Plugin C<uuid>
5663 This plugin, if loaded, causes the Hostname to be taken from the machine's
5664 UUID. The UUID is a universally unique designation for the machine, usually
5665 taken from the machine's BIOS. This is most useful if the machine is running in
5666 a virtual environment such as Xen, in which case the UUID is preserved across
5667 shutdowns and migration.
5669 The following methods are used to find the machine's UUID, in order:
5671 =over 4
5673 =item
5675 Check I</etc/uuid> (or I<UUIDFile>).
5677 =item
5679 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
5680 present.
5682 =item
5684 Check for UUID from C<dmidecode> / SMBIOS.
5686 =item
5688 Check for UUID from Xen hypervisor.
5690 =back
5692 If no UUID can be found then the hostname is not modified.
5694 =over 4
5696 =item B<UUIDFile> I<Path>
5698 Take the UUID from the given file (default I</etc/uuid>).
5700 =back
5702 =head2 Plugin C<varnish>
5704 The Varnish plugin collects information about Varnish, an HTTP accelerator.
5706 =over 4
5708 =item B<CollectCache> B<true>|B<false>
5710 Cache hits and misses. True by default.
5712 =item B<CollectConnections> B<true>|B<false>
5714 Number of client connections received, accepted and dropped. True by default.
5716 =item B<CollectBackend> B<true>|B<false>
5718 Back-end connection statistics, such as successful, reused,
5719 and closed connections. True by default.
5721 =item B<CollectSHM> B<true>|B<false>
5723 Statistics about the shared memory log, a memory region to store
5724 log messages which is flushed to disk when full. True by default.
5726 =item B<CollectBan> B<true>|B<false>
5728 Statistics about ban operations, such as number of bans added, retired, and
5729 number of objects tested against ban operations. Only available with Varnish
5730 3.x. False by default.
5732 =item B<CollectDirectorDNS> B<true>|B<false>
5734 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
5735 default.
5737 =item B<CollectESI> B<true>|B<false>
5739 Edge Side Includes (ESI) parse statistics. False by default.
5741 =item B<CollectFetch> B<true>|B<false>
5743 Statistics about fetches (HTTP requests sent to the backend). False by default.
5745 =item B<CollectHCB> B<true>|B<false>
5747 Inserts and look-ups in the crit bit tree based hash. Look-ups are
5748 divided into locked and unlocked look-ups. False by default.
5750 =item B<CollectObjects> B<true>|B<false>
5752 Statistics on cached objects: number of objects expired, nuked (prematurely
5753 expired), saved, moved, etc. False by default.
5755 =item B<CollectPurge> B<true>|B<false>
5757 Statistics about purge operations, such as number of purges added, retired, and
5758 number of objects tested against purge operations. Only available with Varnish
5759 2.x. False by default.
5761 =item B<CollectSession> B<true>|B<false>
5763 Client session statistics. Number of past and current sessions, session herd and
5764 linger counters, etc. False by default.
5766 =item B<CollectSMA> B<true>|B<false>
5768 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
5769 component is Solaris specific. Only available with Varnish 2.x. False by
5770 default.
5772 =item B<CollectSMS> B<true>|B<false>
5774 synth (synthetic content) storage statistics. This storage
5775 component is used internally only. False by default.
5777 =item B<CollectSM> B<true>|B<false>
5779 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
5780 False by default.
5782 =item B<CollectStruct> B<true>|B<false>
5784 Current varnish internal state statistics. Number of current sessions, objects
5785 in cache store, open connections to backends (with Varnish 2.x), etc. False by
5786 default.
5788 =item B<CollectTotals> B<true>|B<false>
5790 Collects overview counters, such as the number of sessions created,
5791 the number of requests and bytes transferred. False by default.
5793 =item B<CollectUptime> B<true>|B<false>
5795 Varnish uptime. False by default.
5797 =item B<CollectVCL> B<true>|B<false>
5799 Number of total (available + discarded) VCL (config files). False by default.
5801 =item B<CollectWorkers> B<true>|B<false>
5803 Collect statistics about worker threads. False by default.
5805 =back
5807 =head2 Plugin C<vmem>
5809 The C<vmem> plugin collects information about the usage of virtual memory.
5810 Since the statistics provided by the Linux kernel are very detailed, they are
5811 collected very detailed. However, to get all the details, you have to switch
5812 them on manually. Most people just want an overview over, such as the number of
5813 pages read from swap space.
5815 =over 4
5817 =item B<Verbose> B<true>|B<false>
5819 Enables verbose collection of information. This will start collecting page
5820 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
5821 Part of these statistics are collected on a "per zone" basis.
5823 =back
5825 =head2 Plugin C<vserver>
5827 This plugin doesn't have any options. B<VServer> support is only available for
5828 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
5829 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
5830 need to apply the patches and compile your own kernel, which will then provide
5831 the F</proc/virtual> filesystem that is required by this plugin.
5833 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
5835 B<Note>: The traffic collected by this plugin accounts for the amount of
5836 traffic passing a socket which might be a lot less than the actual on-wire
5837 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
5838 collect on-wire traffic you could, for example, use the logging facilities of
5839 iptables to feed data for the guest IPs into the iptables plugin.
5841 =head2 Plugin C<write_graphite>
5843 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
5844 storage and graphing project. The plugin connects to I<Carbon>, the data layer
5845 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
5846 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
5847 of at most 1428 bytes to minimize the number of network packets.
5849 Synopsis:
5851  <Plugin write_graphite>
5852    <Node "example">
5853      Host "localhost"
5854      Port "2003"
5855      Protocol "udp"
5856      LogSendErrors true
5857      Prefix "collectd"
5858    </Node>
5859  </Plugin>
5861 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
5862 blocks. Inside the B<Node> blocks, the following options are recognized:
5864 =over 4
5866 =item B<Host> I<Address>
5868 Hostname or address to connect to. Defaults to C<localhost>.
5870 =item B<Port> I<Service>
5872 Service name or port number to connect to. Defaults to C<2003>.
5874 =item B<Protocol> I<String>
5876 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
5878 =item B<LogSendErrors> B<false>|B<true>
5880 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
5881 If set to B<false>, it will not log the errors. This is especially useful when
5882 using Protocol UDP since many times we want to use the "fire-and-forget"
5883 approach and logging errors fills syslog with unneeded messages.
5885 =item B<Prefix> I<String>
5887 When set, I<String> is added in front of the host name. Dots and whitespace are
5888 I<not> escaped in this string (see B<EscapeCharacter> below).
5890 =item B<Postfix> I<String>
5892 When set, I<String> is appended to the host name. Dots and whitespace are
5893 I<not> escaped in this string (see B<EscapeCharacter> below).
5895 =item B<EscapeCharacter> I<Char>
5897 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
5898 in the identifier. The B<EscapeCharacter> option determines which character
5899 dots, whitespace and control characters are replaced with. Defaults to
5900 underscore (C<_>).
5902 =item B<StoreRates> B<false>|B<true>
5904 If set to B<true> (the default), convert counter values to rates. If set to
5905 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5906 number.
5908 =item B<SeparateInstances> B<false>|B<true>
5910 If set to B<true>, the plugin instance and type instance will be in their own
5911 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
5912 default), the plugin and plugin instance (and likewise the type and type
5913 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
5915 =item B<AlwaysAppendDS> B<false>|B<true>
5917 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
5918 identifier. If set to B<false> (the default), this is only done when there is
5919 more than one DS.
5921 =back
5923 =head2 Plugin C<write_mongodb>
5925 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
5926 NoSQL database.
5928 B<Synopsis:>
5930  <Plugin "write_mongodb">
5931    <Node "default">
5932      Host "localhost"
5933      Port "27017"
5934      Timeout 1000
5935      StoreRates true
5936    </Node>
5937  </Plugin>
5939 The plugin can send values to multiple instances of I<MongoDB> by specifying
5940 one B<Node> block for each instance. Within the B<Node> blocks, the following
5941 options are available:
5943 =over 4
5945 =item B<Host> I<Address>
5947 Hostname or address to connect to. Defaults to C<localhost>.
5949 =item B<Port> I<Service>
5951 Service name or port number to connect to. Defaults to C<27017>.
5953 =item B<Timeout> I<Timeout>
5955 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
5956 Setting this option to zero means no timeout, which is the default.
5958 =item B<StoreRates> B<false>|B<true>
5960 If set to B<true> (the default), convert counter values to rates. If set to
5961 B<false> counter values are stored as is, i.e. as an increasing integer
5962 number.
5964 =item B<Database> I<Database>
5966 =item B<User> I<User>
5968 =item B<Password> I<Password>
5970 Sets the information used when authenticating to a I<MongoDB> database. The
5971 fields are optional (in which case no authentication is attempted), but if you
5972 want to use authentication all three fields must be set.
5974 =back
5976 =head2 Plugin C<write_http>
5978 This output plugin submits values to an http server by POST them using the
5979 PUTVAL plain-text protocol. Each destination you want to post data to needs to
5980 have one B<URL> block, within which the destination can be configured further,
5981 for example by specifying authentication data.
5983 Synopsis:
5985  <Plugin "write_http">
5986    <URL "http://example.com/post-collectd">
5987      User "collectd"
5988      Password "weCh3ik0"
5989    </URL>
5990  </Plugin>
5992 B<URL> blocks need one string argument which is used as the URL to which data
5993 is posted. The following options are understood within B<URL> blocks.
5995 =over 4
5997 =item B<User> I<Username>
5999 Optional user name needed for authentication.
6001 =item B<Password> I<Password>
6003 Optional password needed for authentication.
6005 =item B<VerifyPeer> B<true>|B<false>
6007 Enable or disable peer SSL certificate verification. See
6008 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6010 =item B<VerifyHost> B<true|false>
6012 Enable or disable peer host name verification. If enabled, the plugin checks if
6013 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6014 matches the host name provided by the B<URL> option. If this identity check
6015 fails, the connection is aborted. Obviously, only works when connecting to a
6016 SSL enabled server. Enabled by default.
6018 =item B<CACert> I<File>
6020 File that holds one or more SSL certificates. If you want to use HTTPS you will
6021 possibly need this option. What CA certificates come bundled with C<libcurl>
6022 and are checked by default depends on the distribution you use.
6024 =item B<Format> B<Command>|B<JSON>
6026 Format of the output to generate. If set to B<Command>, will create output that
6027 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6028 create output in the I<JavaScript Object Notation> (JSON).
6030 Defaults to B<Command>.
6032 =item B<StoreRates> B<true|false>
6034 If set to B<true>, convert counter values to rates. If set to B<false> (the
6035 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6036 number.
6038 =back
6040 =head2 Plugin C<write_riemann>
6042 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
6043 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6044 I<Riemann> using UDP packets.
6046 Synopsis:
6048  <Plugin "write_riemann">
6049    <Node "example">
6050      Host "localhost"
6051      Port "5555"
6052      Protocol UDP
6053      StoreRates true
6054      AlwaysAppendDS false
6055      TTLFactor 2.0
6056    </Node>
6057    Tag "foobar"
6058  </Plugin>
6060 The following options are understood by the I<write_riemann plugin>:
6062 =over 4
6064 =item E<lt>B<Node> I<Name>E<gt>
6066 The plugin's configuration consists of one or more B<Node> blocks. Each block
6067 is given a unique I<Name> and specifies one connection to an instance of
6068 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6069 understood:
6071 =over 4
6073 =item B<Host> I<Address>
6075 Hostname or address to connect to. Defaults to C<localhost>.
6077 =item B<Port> I<Service>
6079 Service name or port number to connect to. Defaults to C<5555>.
6081 =item B<Protocol> B<UDP>|B<TCP>
6083 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6084 B<UDP>.
6086 =item B<StoreRates> B<true>|B<false>
6088 If set to B<true> (the default), convert counter values to rates. If set to
6089 B<false> counter values are stored as is, i.e. as an increasing integer number.
6091 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6092 converted values will have "rate" appended to the data source type, e.g.
6093 C<ds_type:derive:rate>.
6095 =item B<AlwaysAppendDS> B<false>|B<true>
6097 If set the B<true>, append the name of the I<Data Source> (DS) to the
6098 "service", i.e. the field that, together with the "host" field, uniquely
6099 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6100 only done when there is more than one DS.
6102 =item B<TTLFactor> I<Factor>
6104 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6105 event is considered active. I<collectd> populates this field based on the
6106 metrics interval setting. This setting controls the factor with which the
6107 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6108 know exactly what you're doing, you should only increase this setting from its
6109 default value.
6111 =back
6113 =item B<Tag> I<String>
6115 Add the given string as an additional tag to the metric being sent to
6116 I<Riemann>.
6118 =back
6120 =head1 THRESHOLD CONFIGURATION
6122 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6123 we mean that the values are not only stored or sent somewhere, but that they
6124 are judged and, if a problem is recognized, acted upon. The only action
6125 collectd takes itself is to generate and dispatch a "notification". Plugins can
6126 register to receive notifications and perform appropriate further actions.
6128 Since systems and what you expect them to do differ a lot, you can configure
6129 B<thresholds> for your values freely. This gives you a lot of flexibility but
6130 also a lot of responsibility.
6132 Every time a value is out of range a notification is dispatched. This means
6133 that the idle percentage of your CPU needs to be less then the configured
6134 threshold only once for a notification to be generated. There's no such thing
6135 as a moving average or similar - at least not now.
6137 Also, all values that match a threshold are considered to be relevant or
6138 "interesting". As a consequence collectd will issue a notification if they are
6139 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6140 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6141 "2" (the default) and some hosts sends it's CPU statistics to the server every
6142 60 seconds, a notification will be dispatched after about 120 seconds. It may
6143 take a little longer because the timeout is checked only once each B<Interval>
6144 on the server.
6146 When a value comes within range again or is received after it was missing, an
6147 "OKAY-notification" is dispatched.
6149 Here is a configuration example to get you started. Read below for more
6150 information.
6152  <Threshold>
6153    <Type "foo">
6154      WarningMin    0.00
6155      WarningMax 1000.00
6156      FailureMin    0.00
6157      FailureMax 1200.00
6158      Invert false
6159      Instance "bar"
6160    </Type>
6162    <Plugin "interface">
6163      Instance "eth0"
6164      <Type "if_octets">
6165        FailureMax 10000000
6166        DataSource "rx"
6167      </Type>
6168    </Plugin>
6170    <Host "hostname">
6171      <Type "cpu">
6172        Instance "idle"
6173        FailureMin 10
6174      </Type>
6176      <Plugin "memory">
6177        <Type "memory">
6178          Instance "cached"
6179          WarningMin 100000000
6180        </Type>
6181      </Plugin>
6182    </Host>
6183  </Threshold>
6185 There are basically two types of configuration statements: The C<Host>,
6186 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6187 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6188 C<Instance> option. You can combine the block by nesting the blocks, though
6189 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6190 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6191 C<Type> may not contain other blocks. If multiple blocks apply to the same
6192 value the most specific block is used.
6194 The other statements specify the threshold to configure. They B<must> be
6195 included in a C<Type> block. Currently the following statements are recognized:
6197 =over 4
6199 =item B<FailureMax> I<Value>
6201 =item B<WarningMax> I<Value>
6203 Sets the upper bound of acceptable values. If unset defaults to positive
6204 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6205 will be created. If the value is greater than B<WarningMax> but less than (or
6206 equal to) B<FailureMax> a B<WARNING> notification will be created.
6208 =item B<FailureMin> I<Value>
6210 =item B<WarningMin> I<Value>
6212 Sets the lower bound of acceptable values. If unset defaults to negative
6213 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6214 be created. If the value is less than B<WarningMin> but greater than (or equal
6215 to) B<FailureMin> a B<WARNING> notification will be created.
6217 =item B<DataSource> I<DSName>
6219 Some data sets have more than one "data source". Interesting examples are the
6220 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6221 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6222 system load data set, C<load>, even has three data sources: C<shortterm>,
6223 C<midterm>, and C<longterm>.
6225 Normally, all data sources are checked against a configured threshold. If this
6226 is undesirable, or if you want to specify different limits for each data
6227 source, you can use the B<DataSource> option to have a threshold apply only to
6228 one data source.
6230 =item B<Invert> B<true>|B<false>
6232 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6233 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6234 B<WarningMax>) are not okay. Defaults to B<false>.
6236 =item B<Persist> B<true>|B<false>
6238 Sets how often notifications are generated. If set to B<true> one notification
6239 will be generated for each value that is out of the acceptable range. If set to
6240 B<false> (the default) then a notification is only generated if a value is out
6241 of range but the previous value was okay.
6243 This applies to missing values, too: If set to B<true> a notification about a
6244 missing value is generated once every B<Interval> seconds. If set to B<false>
6245 only one such notification is generated until the value appears again.
6247 =item B<Percentage> B<true>|B<false>
6249 If set to B<true>, the minimum and maximum values given are interpreted as
6250 percentage value, relative to the other data sources. This is helpful for
6251 example for the "df" type, where you may want to issue a warning when less than
6252 5E<nbsp>% of the total space is available. Defaults to B<false>.
6254 =item B<Hits> I<Number>
6256 Delay creating the notification until the threshold has been passed I<Number>
6257 times. When a notification has been generated, or when a subsequent value is
6258 inside the threshold, the counter is reset. If, for example, a value is
6259 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6260 will be dispatched at most once every 30E<nbsp>seconds.
6262 This is useful when short bursts are not a problem. If, for example, 100% CPU
6263 usage for up to a minute is normal (and data is collected every
6264 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6266 =item B<Hysteresis> I<Number>
6268 When set to non-zero, a hysteresis value is applied when checking minimum and
6269 maximum bounds. This is useful for values that increase slowly and fluctuate a
6270 bit while doing so. When these values come close to the threshold, they may
6271 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6273 If, for example, the threshold is configures as
6275   WarningMax 100.0
6276   Hysteresis 1.0
6278 then a I<Warning> notification is created when the value exceeds I<101> and the
6279 corresponding I<Okay> notification is only created once the value falls below
6280 I<99>, thus avoiding the "flapping".
6282 =back
6284 =head1 FILTER CONFIGURATION
6286 Starting with collectd 4.6 there is a powerful filtering infrastructure
6287 implemented in the daemon. The concept has mostly been copied from
6288 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6289 terminology, so that users that are familiar with iptables feel right at home.
6291 =head2 Terminology
6293 The following are the terms used in the remainder of the filter configuration
6294 documentation. For an ASCII-art schema of the mechanism, see
6295 L<"General structure"> below.
6297 =over 4
6299 =item B<Match>
6301 A I<match> is a criteria to select specific values. Examples are, of course, the
6302 name of the value or it's current value.
6304 Matches are implemented in plugins which you have to load prior to using the
6305 match. The name of such plugins starts with the "match_" prefix.
6307 =item B<Target>
6309 A I<target> is some action that is to be performed with data. Such actions
6310 could, for example, be to change part of the value's identifier or to ignore
6311 the value completely.
6313 Some of these targets are built into the daemon, see L<"Built-in targets">
6314 below. Other targets are implemented in plugins which you have to load prior to
6315 using the target. The name of such plugins starts with the "target_" prefix.
6317 =item B<Rule>
6319 The combination of any number of matches and at least one target is called a
6320 I<rule>. The target actions will be performed for all values for which B<all>
6321 matches apply. If the rule does not have any matches associated with it, the
6322 target action will be performed for all values.
6324 =item B<Chain>
6326 A I<chain> is a list of rules and possibly default targets. The rules are tried
6327 in order and if one matches, the associated target will be called. If a value
6328 is handled by a rule, it depends on the target whether or not any subsequent
6329 rules are considered or if traversal of the chain is aborted, see
6330 L<"Flow control"> below. After all rules have been checked, the default targets
6331 will be executed.
6333 =back
6335 =head2 General structure
6337 The following shows the resulting structure:
6339  +---------+
6340  ! Chain   !
6341  +---------+
6342       !
6343       V
6344  +---------+  +---------+  +---------+  +---------+
6345  ! Rule    !->! Match   !->! Match   !->! Target  !
6346  +---------+  +---------+  +---------+  +---------+
6347       !
6348       V
6349  +---------+  +---------+  +---------+
6350  ! Rule    !->! Target  !->! Target  !
6351  +---------+  +---------+  +---------+
6352       !
6353       V
6354       :
6355       :
6356       !
6357       V
6358  +---------+  +---------+  +---------+
6359  ! Rule    !->! Match   !->! Target  !
6360  +---------+  +---------+  +---------+
6361       !
6362       V
6363  +---------+
6364  ! Default !
6365  ! Target  !
6366  +---------+
6368 =head2 Flow control
6370 There are four ways to control which way a value takes through the filter
6371 mechanism:
6373 =over 4
6375 =item B<jump>
6377 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6378 process the value with another chain. When the called chain finishes, usually
6379 the next target or rule after the jump is executed.
6381 =item B<stop>
6383 The stop condition, signaled for example by the built-in target B<stop>, causes
6384 all processing of the value to be stopped immediately.
6386 =item B<return>
6388 Causes processing in the current chain to be aborted, but processing of the
6389 value generally will continue. This means that if the chain was called via
6390 B<Jump>, the next target or rule after the jump will be executed. If the chain
6391 was not called by another chain, control will be returned to the daemon and it
6392 may pass the value to another chain.
6394 =item B<continue>
6396 Most targets will signal the B<continue> condition, meaning that processing
6397 should continue normally. There is no special built-in target for this
6398 condition.
6400 =back
6402 =head2 Synopsis
6404 The configuration reflects this structure directly:
6406  PostCacheChain "PostCache"
6407  <Chain "PostCache">
6408    <Rule "ignore_mysql_show">
6409      <Match "regex">
6410        Plugin "^mysql$"
6411        Type "^mysql_command$"
6412        TypeInstance "^show_"
6413      </Match>
6414      <Target "stop">
6415      </Target>
6416    </Rule>
6417    <Target "write">
6418      Plugin "rrdtool"
6419    </Target>
6420  </Chain>
6422 The above configuration example will ignore all values where the plugin field
6423 is "mysql", the type is "mysql_command" and the type instance begins with
6424 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6425 default target of the chain. Since this chain is run after the value has been
6426 added to the cache, the MySQL C<show_*> command statistics will be available
6427 via the C<unixsock> plugin.
6429 =head2 List of configuration options
6431 =over 4
6433 =item B<PreCacheChain> I<ChainName>
6435 =item B<PostCacheChain> I<ChainName>
6437 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6438 argument is the name of a I<chain> that should be executed before and/or after
6439 the values have been added to the cache.
6441 To understand the implications, it's important you know what is going on inside
6442 I<collectd>. The following diagram shows how values are passed from the
6443 read-plugins to the write-plugins:
6445    +---------------+
6446    !  Read-Plugin  !
6447    +-------+-------+
6448            !
6449  + - - - - V - - - - +
6450  : +---------------+ :
6451  : !   Pre-Cache   ! :
6452  : !     Chain     ! :
6453  : +-------+-------+ :
6454  :         !         :
6455  :         V         :
6456  : +-------+-------+ :  +---------------+
6457  : !     Cache     !--->!  Value Cache  !
6458  : !     insert    ! :  +---+---+-------+
6459  : +-------+-------+ :      !   !
6460  :         !   ,------------'   !
6461  :         V   V     :          V
6462  : +-------+---+---+ :  +-------+-------+
6463  : !  Post-Cache   +--->! Write-Plugins !
6464  : !     Chain     ! :  +---------------+
6465  : +---------------+ :
6466  :                   :
6467  :  dispatch values  :
6468  + - - - - - - - - - +
6470 After the values are passed from the "read" plugins to the dispatch functions,
6471 the pre-cache chain is run first. The values are added to the internal cache
6472 afterwards. The post-cache chain is run after the values have been added to the
6473 cache. So why is it such a huge deal if chains are run before or after the
6474 values have been added to this cache?
6476 Targets that change the identifier of a value list should be executed before
6477 the values are added to the cache, so that the name in the cache matches the
6478 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6479 this cache to receive a list of all available values. If you change the
6480 identifier after the value list has been added to the cache, this may easily
6481 lead to confusion, but it's not forbidden of course.
6483 The cache is also used to convert counter values to rates. These rates are, for
6484 example, used by the C<value> match (see below). If you use the rate stored in
6485 the cache B<before> the new value is added, you will use the old, B<previous>
6486 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6487 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6488 command.
6490 Last but not last, the B<stop> target makes a difference: If the pre-cache
6491 chain returns the stop condition, the value will not be added to the cache and
6492 the post-cache chain will not be run.
6494 =item B<Chain> I<Name>
6496 Adds a new chain with a certain name. This name can be used to refer to a
6497 specific chain, for example to jump to it.
6499 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
6501 =item B<Rule> [I<Name>]
6503 Adds a new rule to the current chain. The name of the rule is optional and
6504 currently has no meaning for the daemon.
6506 Within the B<Rule> block, there may be any number of B<Match> blocks and there
6507 must be at least one B<Target> block.
6509 =item B<Match> I<Name>
6511 Adds a match to a B<Rule> block. The name specifies what kind of match should
6512 be performed. Available matches depend on the plugins that have been loaded.
6514 The arguments inside the B<Match> block are passed to the plugin implementing
6515 the match, so which arguments are valid here depends on the plugin being used.
6516 If you do not need any to pass any arguments to a match, you can use the
6517 shorter syntax:
6519  Match "foobar"
6521 Which is equivalent to:
6523  <Match "foobar">
6524  </Match>
6526 =item B<Target> I<Name>
6528 Add a target to a rule or a default target to a chain. The name specifies what
6529 kind of target is to be added. Which targets are available depends on the
6530 plugins being loaded.
6532 The arguments inside the B<Target> block are passed to the plugin implementing
6533 the target, so which arguments are valid here depends on the plugin being used.
6534 If you do not need any to pass any arguments to a target, you can use the
6535 shorter syntax:
6537  Target "stop"
6539 This is the same as writing:
6541  <Target "stop">
6542  </Target>
6544 =back
6546 =head2 Built-in targets
6548 The following targets are built into the core daemon and therefore need no
6549 plugins to be loaded:
6551 =over 4
6553 =item B<return>
6555 Signals the "return" condition, see the L<"Flow control"> section above. This
6556 causes the current chain to stop processing the value and returns control to
6557 the calling chain. The calling chain will continue processing targets and rules
6558 just after the B<jump> target (see below). This is very similar to the
6559 B<RETURN> target of iptables, see L<iptables(8)>.
6561 This target does not have any options.
6563 Example:
6565  Target "return"
6567 =item B<stop>
6569 Signals the "stop" condition, see the L<"Flow control"> section above. This
6570 causes processing of the value to be aborted immediately. This is similar to
6571 the B<DROP> target of iptables, see L<iptables(8)>.
6573 This target does not have any options.
6575 Example:
6577  Target "stop"
6579 =item B<write>
6581 Sends the value to "write" plugins.
6583 Available options:
6585 =over 4
6587 =item B<Plugin> I<Name>
6589 Name of the write plugin to which the data should be sent. This option may be
6590 given multiple times to send the data to more than one write plugin.
6592 =back
6594 If no plugin is explicitly specified, the values will be sent to all available
6595 write plugins.
6597 Example:
6599  <Target "write">
6600    Plugin "rrdtool"
6601  </Target>
6603 =item B<jump>
6605 Starts processing the rules of another chain, see L<"Flow control"> above. If
6606 the end of that chain is reached, or a stop condition is encountered,
6607 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
6608 next target or the next rule. This is similar to the B<-j> command line option
6609 of iptables, see L<iptables(8)>.
6611 Available options:
6613 =over 4
6615 =item B<Chain> I<Name>
6617 Jumps to the chain I<Name>. This argument is required and may appear only once.
6619 =back
6621 Example:
6623  <Target "jump">
6624    Chain "foobar"
6625  </Target>
6627 =back
6629 =head2 Available matches
6631 =over 4
6633 =item B<regex>
6635 Matches a value using regular expressions.
6637 Available options:
6639 =over 4
6641 =item B<Host> I<Regex>
6643 =item B<Plugin> I<Regex>
6645 =item B<PluginInstance> I<Regex>
6647 =item B<Type> I<Regex>
6649 =item B<TypeInstance> I<Regex>
6651 Match values where the given regular expressions match the various fields of
6652 the identifier of a value. If multiple regular expressions are given, B<all>
6653 regexen must match for a value to match.
6655 =item B<Invert> B<false>|B<true>
6657 When set to B<true>, the result of the match is inverted, i.e. all value lists
6658 where all regular expressions apply are not matched, all other value lists are
6659 matched. Defaults to B<false>.
6661 =back
6663 Example:
6665  <Match "regex">
6666    Host "customer[0-9]+"
6667    Plugin "^foobar$"
6668  </Match>
6670 =item B<timediff>
6672 Matches values that have a time which differs from the time on the server.
6674 This match is mainly intended for servers that receive values over the
6675 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
6676 is very sensitive to the timestamp used when updating the RRD files. In
6677 particular, the time must be ever increasing. If a misbehaving client sends one
6678 packet with a timestamp far in the future, all further packets with a correct
6679 time will be ignored because of that one packet. What's worse, such corrupted
6680 RRD files are hard to fix.
6682 This match lets one match all values B<outside> a specified time range
6683 (relative to the server's time), so you can use the B<stop> target (see below)
6684 to ignore the value, for example.
6686 Available options:
6688 =over 4
6690 =item B<Future> I<Seconds>
6692 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
6693 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6694 non-zero.
6696 =item B<Past> I<Seconds>
6698 Matches all values that are I<behind> of the server's time by I<Seconds> or
6699 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
6700 non-zero.
6702 =back
6704 Example:
6706  <Match "timediff">
6707    Future  300
6708    Past   3600
6709  </Match>
6711 This example matches all values that are five minutes or more ahead of the
6712 server or one hour (or more) lagging behind.
6714 =item B<value>
6716 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
6717 values. If a data-set consists of more than one data-source, all data-sources
6718 must match the specified ranges for a positive match.
6720 Available options:
6722 =over 4
6724 =item B<Min> I<Value>
6726 Sets the smallest value which still results in a match. If unset, behaves like
6727 negative infinity.
6729 =item B<Max> I<Value>
6731 Sets the largest value which still results in a match. If unset, behaves like
6732 positive infinity.
6734 =item B<Invert> B<true>|B<false>
6736 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
6737 no-match is returned and vice versa. Please note that the B<Invert> setting
6738 only effects how B<Min> and B<Max> are applied to a specific value. Especially
6739 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
6741 =item B<DataSource> I<DSName> [I<DSName> ...]
6743 Select one or more of the data sources. If no data source is configured, all
6744 data sources will be checked. If the type handled by the match does not have a
6745 data source of the specified name(s), this will always result in no match
6746 (independent of the B<Invert> setting).
6748 =item B<Satisfy> B<Any>|B<All>
6750 Specifies how checking with several data sources is performed. If set to
6751 B<Any>, the match succeeds if one of the data sources is in the configured
6752 range. If set to B<All> the match only succeeds if all data sources are within
6753 the configured range. Default is B<All>.
6755 Usually B<All> is used for positive matches, B<Any> is used for negative
6756 matches. This means that with B<All> you usually check that all values are in a
6757 "good" range, while with B<Any> you check if any value is within a "bad" range
6758 (or outside the "good" range).
6760 =back
6762 Either B<Min> or B<Max>, but not both, may be unset.
6764 Example:
6766  # Match all values smaller than or equal to 100. Matches only if all data
6767  # sources are below 100.
6768  <Match "value">
6769    Max 100
6770    Satisfy "All"
6771  </Match>
6772  
6773  # Match if the value of any data source is outside the range of 0 - 100.
6774  <Match "value">
6775    Min   0
6776    Max 100
6777    Invert true
6778    Satisfy "Any"
6779  </Match>
6781 =item B<empty_counter>
6783 Matches all values with one or more data sources of type B<COUNTER> and where
6784 all counter values are zero. These counters usually I<never> increased since
6785 they started existing (and are therefore uninteresting), or got reset recently
6786 or overflowed and you had really, I<really> bad luck.
6788 Please keep in mind that ignoring such counters can result in confusing
6789 behavior: Counters which hardly ever increase will be zero for long periods of
6790 time. If the counter is reset for some reason (machine or service restarted,
6791 usually), the graph will be empty (NAN) for a long time. People may not
6792 understand why.
6794 =item B<hashed>
6796 Calculates a hash value of the host name and matches values according to that
6797 hash value. This makes it possible to divide all hosts into groups and match
6798 only values that are in a specific group. The intended use is in load
6799 balancing, where you want to handle only part of all data and leave the rest
6800 for other servers.
6802 The hashing function used tries to distribute the hosts evenly. First, it
6803 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
6805   hash_value = 0;
6806   for (i = 0; host[i] != 0; i++)
6807     hash_value = (hash_value * 251) + host[i];
6809 The constant 251 is a prime number which is supposed to make this hash value
6810 more random. The code then checks the group for this host according to the
6811 I<Total> and I<Match> arguments:
6813   if ((hash_value % Total) == Match)
6814     matches;
6815   else
6816     does not match;
6818 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
6819 groups), then the least significant bit of the hash value will be the XOR of
6820 all least significant bits in the host name. One consequence is that when you
6821 have two hosts, "server0.example.com" and "server1.example.com", where the host
6822 name differs in one digit only and the digits differ by one, those hosts will
6823 never end up in the same group.
6825 Available options:
6827 =over 4
6829 =item B<Match> I<Match> I<Total>
6831 Divide the data into I<Total> groups and match all hosts in group I<Match> as
6832 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
6833 be smaller than I<Total>. I<Total> must be at least one, although only values
6834 greater than one really do make any sense.
6836 You can repeat this option to match multiple groups, for example:
6838   Match 3 7
6839   Match 5 7
6841 The above config will divide the data into seven groups and match groups three
6842 and five. One use would be to keep every value on two hosts so that if one
6843 fails the missing data can later be reconstructed from the second host.
6845 =back
6847 Example:
6849  # Operate on the pre-cache chain, so that ignored values are not even in the
6850  # global cache.
6851  <Chain "PreCache">
6852    <Rule>
6853      <Match "hashed">
6854        # Divide all received hosts in seven groups and accept all hosts in
6855        # group three.
6856        Match 3 7
6857      </Match>
6858      # If matched: Return and continue.
6859      Target "return"
6860    </Rule>
6861    # If not matched: Return and stop.
6862    Target "stop"
6863  </Chain>
6865 =back
6867 =head2 Available targets
6869 =over 4
6871 =item B<notification>
6873 Creates and dispatches a notification.
6875 Available options:
6877 =over 4
6879 =item B<Message> I<String>
6881 This required option sets the message of the notification. The following
6882 placeholders will be replaced by an appropriate value:
6884 =over 4
6886 =item B<%{host}>
6888 =item B<%{plugin}>
6890 =item B<%{plugin_instance}>
6892 =item B<%{type}>
6894 =item B<%{type_instance}>
6896 These placeholders are replaced by the identifier field of the same name.
6898 =item B<%{ds:>I<name>B<}>
6900 These placeholders are replaced by a (hopefully) human readable representation
6901 of the current rate of this data source. If you changed the instance name
6902 (using the B<set> or B<replace> targets, see below), it may not be possible to
6903 convert counter values to rates.
6905 =back
6907 Please note that these placeholders are B<case sensitive>!
6909 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
6911 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
6912 used.
6914 =back
6916 Example:
6918   <Target "notification">
6919     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
6920     Severity "WARNING"
6921   </Target>
6923 =item B<replace>
6925 Replaces parts of the identifier using regular expressions.
6927 Available options:
6929 =over 4
6931 =item B<Host> I<Regex> I<Replacement>
6933 =item B<Plugin> I<Regex> I<Replacement>
6935 =item B<PluginInstance> I<Regex> I<Replacement>
6937 =item B<TypeInstance> I<Regex> I<Replacement>
6939 Match the appropriate field with the given regular expression I<Regex>. If the
6940 regular expression matches, that part that matches is replaced with
6941 I<Replacement>. If multiple places of the input buffer match a given regular
6942 expression, only the first occurrence will be replaced.
6944 You can specify each option multiple times to use multiple regular expressions
6945 one after another.
6947 =back
6949 Example:
6951  <Target "replace">
6952    # Replace "example.net" with "example.com"
6953    Host "\\<example.net\\>" "example.com"
6954  
6955    # Strip "www." from hostnames
6956    Host "\\<www\\." ""
6957  </Target>
6959 =item B<set>
6961 Sets part of the identifier of a value to a given string.
6963 Available options:
6965 =over 4
6967 =item B<Host> I<String>
6969 =item B<Plugin> I<String>
6971 =item B<PluginInstance> I<String>
6973 =item B<TypeInstance> I<String>
6975 Set the appropriate field to the given string. The strings for plugin instance
6976 and type instance may be empty, the strings for host and plugin may not be
6977 empty. It's currently not possible to set the type of a value this way.
6979 =back
6981 Example:
6983  <Target "set">
6984    PluginInstance "coretemp"
6985    TypeInstance "core3"
6986  </Target>
6988 =back
6990 =head2 Backwards compatibility
6992 If you use collectd with an old configuration, i.E<nbsp>e. one without a
6993 B<Chain> block, it will behave as it used to. This is equivalent to the
6994 following configuration:
6996  <Chain "PostCache">
6997    Target "write"
6998  </Chain>
7000 If you specify a B<PostCacheChain>, the B<write> target will not be added
7001 anywhere and you will have to make sure that it is called where appropriate. We
7002 suggest to add the above snippet as default target to your "PostCache" chain.
7004 =head2 Examples
7006 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7007 be an FQDN.
7009  <Chain "PreCache">
7010    <Rule "no_fqdn">
7011      <Match "regex">
7012        Host "^[^\.]*$"
7013      </Match>
7014      Target "stop"
7015    </Rule>
7016    Target "write"
7017  </Chain>
7019 =head1 SEE ALSO
7021 L<collectd(1)>,
7022 L<collectd-exec(5)>,
7023 L<collectd-perl(5)>,
7024 L<collectd-unixsock(5)>,
7025 L<types.db(5)>,
7026 L<hddtemp(8)>,
7027 L<iptables(8)>,
7028 L<kstat(3KSTAT)>,
7029 L<mbmon(1)>,
7030 L<psql(1)>,
7031 L<regex(7)>,
7032 L<rrdtool(1)>,
7033 L<sensors(1)>
7035 =head1 AUTHOR
7037 Florian Forster E<lt>octo@verplant.orgE<gt>
7039 =cut