Code

Merge pull request #647 from manuelluis/mlsr/threshold-missing_time
[collectd.git] / src / collectd.conf.pod
1 =encoding UTF-8
3 =head1 NAME
5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
7 =head1 SYNOPSIS
9   BaseDir "/path/to/data/"
10   PIDFile "/path/to/pidfile/collectd.pid"
11   Server  "123.123.123.123" 12345
13   LoadPlugin cpu
14   LoadPlugin load
16   <LoadPlugin df>
17     Interval 3600
18   </LoadPlugin>
20   LoadPlugin ping
21   <Plugin ping>
22     Host "example.org"
23     Host "provider.net"
24   </Plugin>
26 =head1 DESCRIPTION
28 This config file controls how the system statistics collection daemon
29 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
30 controls which plugins to load. These plugins ultimately define collectd's
31 behavior.
33 The syntax of this config file is similar to the config file of the famous
34 I<Apache> webserver. Each line contains either an option (a key and a list of
35 one or more values) or a section-start or -end. Empty lines and everything
36 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
37 strings, consisting only of alphanumeric characters and the underscore (C<_>)
38 character. Keys are handled case insensitive by I<collectd> itself and all
39 plugins included with it. I<Values> can either be an I<unquoted string>, a
40 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
41 expression. I<Unquoted strings> consist of only alphanumeric characters and
42 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
43 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
44 to include double quotes as part of the string. I<Numbers> can be specified in
45 decimal and floating point format (using a dot C<.> as decimal separator),
46 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
47 I<Boolean> values are either B<true> or B<false>.
49 Lines may be wrapped by using C<\> as the last character before the newline.
50 This allows long lines to be split into multiple lines. Quoted strings may be
51 wrapped as well. However, those are treated special in that whitespace at the
52 beginning of the following lines will be ignored, which allows for nicely
53 indenting the wrapped lines.
55 The configuration is read and processed in order, i.e. from top to bottom. So
56 the plugins are loaded in the order listed in this config file. It is a good
57 idea to load any logging plugins first in order to catch messages from plugins
58 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
59 the appropriate C<E<lt>Plugin ...E<gt>> block.
61 =head1 GLOBAL OPTIONS
63 =over 4
65 =item B<BaseDir> I<Directory>
67 Sets the base directory. This is the directory beneath all RRD-files are
68 created. Possibly more subdirectories are created. This is also the working
69 directory for the daemon.
71 =item B<LoadPlugin> I<Plugin>
73 Loads the plugin I<Plugin>. This is required to load plugins, unless the
74 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
75 I<collectd> will be mostly useless.
77 Only the first B<LoadPlugin> statement or block for a given plugin name has any
78 effect. This is useful when you want to split up the configuration into smaller
79 files and want each file to be "self contained", i.e. it contains a B<Plugin>
80 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
81 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
82 different intervals, only one of them (the first one encountered) will take
83 effect and all others will be silently ignored.
85 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
86 with additional options, affecting the behavior of B<LoadPlugin>. A simple
87 statement looks like this:
89  LoadPlugin "cpu"
91 Options inside a B<LoadPlugin> block can override default settings and
92 influence the way plugins are loaded, e.g.:
94  <LoadPlugin perl>
95    Globals true
96    Interval 60
97  </LoadPlugin>
99 The following options are valid inside B<LoadPlugin> blocks:
101 =over 4
103 =item B<Globals> B<true|false>
105 If enabled, collectd will export all global symbols of the plugin (and of all
106 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
107 available for resolving unresolved symbols in subsequently loaded plugins if
108 that is supported by your system.
110 This is useful (or possibly even required), e.g., when loading a plugin that
111 embeds some scripting language into the daemon (e.g. the I<Perl> and
112 I<Python plugins>). Scripting languages usually provide means to load
113 extensions written in C. Those extensions require symbols provided by the
114 interpreter, which is loaded as a dependency of the respective collectd plugin.
115 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
116 L<collectd-python(5)>) for details.
118 By default, this is disabled. As a special exception, if the plugin name is
119 either C<perl> or C<python>, the default is changed to enabled in order to keep
120 the average user from ever having to deal with this low level linking stuff.
122 =item B<Interval> I<Seconds>
124 Sets a plugin-specific interval for collecting metrics. This overrides the
125 global B<Interval> setting. If a plugin provides own support for specifying an
126 interval, that setting will take precedence.
128 =back
130 =item B<AutoLoadPlugin> B<false>|B<true>
132 When set to B<false> (the default), each plugin needs to be loaded explicitly,
133 using the B<LoadPlugin> statement documented above. If a
134 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
135 handling callback for this plugin has been registered, a warning is logged and
136 the block is ignored.
138 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
139 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
140 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
141 plugins that don't provide any configuration, e.g. the I<Load plugin>.
143 =item B<Include> I<Path> [I<pattern>]
145 If I<Path> points to a file, includes that file. If I<Path> points to a
146 directory, recursively includes all files within that directory and its
147 subdirectories. If the C<wordexp> function is available on your system,
148 shell-like wildcards are expanded before files are included. This means you can
149 use statements like the following:
151   Include "/etc/collectd.d/*.conf"
153 Starting with version 5.3, this may also be a block in which further options
154 affecting the behavior of B<Include> may be specified. The following option is
155 currently allowed:
157   <Include "/etc/collectd.d">
158     Filter "*.conf"
159   </Include>
161 =over 4
163 =item B<Filter> I<pattern>
165 If the C<fnmatch> function is available on your system, a shell-like wildcard
166 I<pattern> may be specified to filter which files to include. This may be used
167 in combination with recursively including a directory to easily be able to
168 arbitrarily mix configuration files and other documents (e.g. README files).
169 The given example is similar to the first example above but includes all files
170 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
172   Include "/etc/collectd.d" "*.conf"
174 =back
176 If more than one files are included by a single B<Include> option, the files
177 will be included in lexicographical order (as defined by the C<strcmp>
178 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
179 order in which the files are loaded.
181 To prevent loops and shooting yourself in the foot in interesting ways the
182 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
183 most uses. Since symlinks are followed it is still possible to crash the daemon
184 by looping symlinks. In our opinion significant stupidity should result in an
185 appropriate amount of pain.
187 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
188 file, but you cannot include files from within blocks.
190 =item B<PIDFile> I<File>
192 Sets where to write the PID file to. This file is overwritten when it exists
193 and deleted when the program is stopped. Some init-scripts might override this
194 setting using the B<-P> command-line option.
196 =item B<PluginDir> I<Directory>
198 Path to the plugins (shared objects) of collectd.
200 =item B<TypesDB> I<File> [I<File> ...]
202 Set one or more files that contain the data-set descriptions. See
203 L<types.db(5)> for a description of the format of this file.
205 =item B<Interval> I<Seconds>
207 Configures the interval in which to query the read plugins. Obviously smaller
208 values lead to a higher system load produced by collectd, while higher values
209 lead to more coarse statistics.
211 B<Warning:> You should set this once and then never touch it again. If you do,
212 I<you will have to delete all your RRD files> or know some serious RRDtool
213 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
215 =item B<Timeout> I<Iterations>
217 Consider a value list "missing" when no update has been read or received for
218 I<Iterations> iterations. By default, I<collectd> considers a value list
219 missing when no update has been received for twice the update interval. Since
220 this setting uses iterations, the maximum allowed time without update depends
221 on the I<Interval> information contained in each value list. This is used in
222 the I<Threshold> configuration to dispatch notifications about missing values,
223 see L<collectd-threshold(5)> for details.
225 =item B<ReadThreads> I<Num>
227 Number of threads to start for reading plugins. The default value is B<5>, but
228 you may want to increase this if you have more than five plugins that take a
229 long time to read. Mostly those are plugins that do network-IO. Setting this to
230 a value higher than the number of registered read callbacks is not recommended.
232 =item B<WriteThreads> I<Num>
234 Number of threads to start for dispatching value lists to write plugins. The
235 default value is B<5>, but you may want to increase this if you have more than
236 five plugins that may take relatively long to write to.
238 =item B<WriteQueueLimitHigh> I<HighNum>
240 =item B<WriteQueueLimitLow> I<LowNum>
242 Metrics are read by the I<read threads> and then put into a queue to be handled
243 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
244 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
245 running into memory issues in such a case, you can limit the size of this
246 queue.
248 By default, there is no limit and memory may grow indefinitely. This is most
249 likely not an issue for clients, i.e. instances that only handle the local
250 metrics. For servers it is recommended to set this to a non-zero value, though.
252 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
253 Each of them takes a numerical argument which is the number of metrics in the
254 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
255 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
256 I<will> be enqueued. If the number of metrics currently in the queue is between
257 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
258 proportional to the number of metrics in the queue (i.e. it increases linearly
259 until it reaches 100%.)
261 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
262 unset, the latter will default to half of B<WriteQueueLimitHigh>.
264 If you do not want to randomly drop values when the queue size is between
265 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
266 B<WriteQueueLimitLow> to same value.
268 =item B<Hostname> I<Name>
270 Sets the hostname that identifies a host. If you omit this setting, the
271 hostname will be determined using the L<gethostname(2)> system call.
273 =item B<FQDNLookup> B<true|false>
275 If B<Hostname> is determined automatically this setting controls whether or not
276 the daemon should try to figure out the "fully qualified domain name", FQDN.
277 This is done using a lookup of the name returned by C<gethostname>. This option
278 is enabled by default.
280 =item B<PreCacheChain> I<ChainName>
282 =item B<PostCacheChain> I<ChainName>
284 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
285 see L<FILTER CONFIGURATION> below on information on chains and how these
286 setting change the daemon's behavior.
288 =back
290 =head1 PLUGIN OPTIONS
292 Some plugins may register own options. These options must be enclosed in a
293 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
294 require external configuration, too. The C<apache plugin>, for example,
295 required C<mod_status> to be configured in the webserver you're going to
296 collect data from. These plugins are listed below as well, even if they don't
297 require any configuration within collectd's configuration file.
299 A list of all plugins and a short summary for each plugin can be found in the
300 F<README> file shipped with the sourcecode and hopefully binary packets as
301 well.
303 =head2 Plugin C<aggregation>
305 The I<Aggregation plugin> makes it possible to aggregate several values into
306 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
307 This can be put to a wide variety of uses, e.g. average and total CPU
308 statistics for your entire fleet.
310 The grouping is powerful but, as with many powerful tools, may be a bit
311 difficult to wrap your head around. The grouping will therefore be
312 demonstrated using an example: The average and sum of the CPU usage across
313 all CPUs of each host is to be calculated.
315 To select all the affected values for our example, set C<Plugin cpu> and
316 C<Type cpu>. The other values are left unspecified, meaning "all values". The
317 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
318 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
319 statement.
321   Plugin "cpu"
322   Type "cpu"
324 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...)  and
325 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
326 example, the intention is to have a new value for each host / type instance
327 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
328 It can be specified multiple times to group by more than one field.
330   GroupBy "Host"
331   GroupBy "TypeInstance"
333 We do neither specify nor group by I<plugin instance> (the CPU number), so all
334 metrics that differ in the CPU number only will be aggregated. Each
335 aggregation needs I<at least one> such field, otherwise no aggregation would
336 take place.
338 The full example configuration looks like this:
340  <Plugin "aggregation">
341    <Aggregation>
342      Plugin "cpu"
343      Type "cpu"
345      GroupBy "Host"
346      GroupBy "TypeInstance"
348      CalculateSum true
349      CalculateAverage true
350    </Aggregation>
351  </Plugin>
353 There are a couple of limitations you should be aware of:
355 =over 4
357 =item
359 The I<Type> cannot be left unspecified, because it is not reasonable to add
360 apples to oranges. Also, the internal lookup structure won't work if you try
361 to group by type.
363 =item
365 There must be at least one unspecified, ungrouped field. Otherwise nothing
366 will be aggregated.
368 =back
370 As you can see in the example above, each aggregation has its own
371 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
372 blocks may match the same values, i.e. one value list can update multiple
373 aggregations. The following options are valid inside B<Aggregation> blocks:
375 =over 4
377 =item B<Host> I<Host>
379 =item B<Plugin> I<Plugin>
381 =item B<PluginInstance> I<PluginInstance>
383 =item B<Type> I<Type>
385 =item B<TypeInstance> I<TypeInstance>
387 Selects the value lists to be added to this aggregation. B<Type> must be a
388 valid data set name, see L<types.db(5)> for details.
390 If the string starts with and ends with a slash (C</>), the string is
391 interpreted as a I<regular expression>. The regex flavor used are POSIX
392 extended regular expressions as described in L<regex(7)>. Example usage:
394  Host "/^db[0-9]\\.example\\.com$/"
396 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
398 Group valued by the specified field. The B<GroupBy> option may be repeated to
399 group by multiple fields.
401 =item B<SetHost> I<Host>
403 =item B<SetPlugin> I<Plugin>
405 =item B<SetPluginInstance> I<PluginInstance>
407 =item B<SetTypeInstance> I<TypeInstance>
409 Sets the appropriate part of the identifier to the provided string.
411 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
412 will be replaced with the aggregation function, e.g. "average". Not including
413 the placeholder will result in duplication warnings and/or messed up values if
414 more than one aggregation function are enabled.
416 The following example calculates the average usage of all "even" CPUs:
418  <Plugin "aggregation">
419    <Aggregation>
420      Plugin "cpu"
421      PluginInstance "/[0,2,4,6,8]$/"
422      Type "cpu"
424      SetPlugin "cpu"
425      SetPluginInstance "even-%{aggregation}"
427      GroupBy "Host"
428      GroupBy "TypeInstance"
430      CalculateAverage true
431    </Aggregation>
432  </Plugin>
434 This will create the files:
436 =over 4
438 =item
440 foo.example.com/cpu-even-average/cpu-idle
442 =item
444 foo.example.com/cpu-even-average/cpu-system
446 =item
448 foo.example.com/cpu-even-average/cpu-user
450 =item
452 ...
454 =back
456 =item B<CalculateNum> B<true>|B<false>
458 =item B<CalculateSum> B<true>|B<false>
460 =item B<CalculateAverage> B<true>|B<false>
462 =item B<CalculateMinimum> B<true>|B<false>
464 =item B<CalculateMaximum> B<true>|B<false>
466 =item B<CalculateStddev> B<true>|B<false>
468 Boolean options for enabling calculation of the number of value lists, their
469 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
470 are disabled by default.
472 =back
474 =head2 Plugin C<amqp>
476 The I<AMQMP plugin> can be used to communicate with other instances of
477 I<collectd> or third party applications using an AMQP message broker. Values
478 are sent to or received from the broker, which handles routing, queueing and
479 possibly filtering or messages.
481  <Plugin "amqp">
482    # Send values to an AMQP broker
483    <Publish "some_name">
484      Host "localhost"
485      Port "5672"
486      VHost "/"
487      User "guest"
488      Password "guest"
489      Exchange "amq.fanout"
490  #   ExchangeType "fanout"
491  #   RoutingKey "collectd"
492  #   Persistent false
493  #   Format "command"
494  #   StoreRates false
495  #   GraphitePrefix "collectd."
496  #   GraphiteEscapeChar "_"
497    </Publish>
499    # Receive values from an AMQP broker
500    <Subscribe "some_name">
501      Host "localhost"
502      Port "5672"
503      VHost "/"
504      User "guest"
505      Password "guest"
506      Exchange "amq.fanout"
507  #   ExchangeType "fanout"
508  #   Queue "queue_name"
509  #   QueueDurable false
510  #   QueueAutoDelete true
511  #   RoutingKey "collectd.#"
512    </Subscribe>
513  </Plugin>
515 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
516 blocks, which configure sending and receiving of values respectively. The two
517 blocks are very similar, so unless otherwise noted, an option can be used in
518 either block. The name given in the blocks starting tag is only used for
519 reporting messages, but may be used to support I<flushing> of certain
520 I<Publish> blocks in the future.
522 =over 4
524 =item B<Host> I<Host>
526 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
527 the underlying communications library, I<rabbitmq-c>, which is "localhost".
529 =item B<Port> I<Port>
531 Service name or port number on which the AMQP broker accepts connections. This
532 argument must be a string, even if the numeric form is used. Defaults to
533 "5672".
535 =item B<VHost> I<VHost>
537 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
539 =item B<User> I<User>
541 =item B<Password> I<Password>
543 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
544 is used.
546 =item B<Exchange> I<Exchange>
548 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
549 By default, "amq.fanout" will be used.
551 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
552 the given exchange and the I<queue> is created, using the I<routing key> if
553 configured. See the B<Queue> and B<RoutingKey> options below.
555 =item B<ExchangeType> I<Type>
557 If given, the plugin will try to create the configured I<exchange> with this
558 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
559 be bound to this exchange.
561 =item B<Queue> I<Queue> (Subscribe only)
563 Configures the I<queue> name to subscribe to. If no queue name was configured
564 explicitly, a unique queue name will be created by the broker.
566 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
568 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
569 or transient (will disappear if the AMQP broker is restarted). Defaults to
570 "false".
572 This option should be used in conjunction with the I<Persistent> option on the
573 publish side.
575 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
577 Defines if the I<queue> subscribed to will be deleted once the last consumer
578 unsubscribes. Defaults to "true".
580 =item B<RoutingKey> I<Key>
582 In I<Publish> blocks, this configures the routing key to set on all outgoing
583 messages. If not given, the routing key will be computed from the I<identifier>
584 of the value. The host, plugin, type and the two instances are concatenated
585 together using dots as the separator and all containing dots replaced with
586 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
587 possible to receive only specific values using a "topic" exchange.
589 In I<Subscribe> blocks, configures the I<routing key> used when creating a
590 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
591 used to filter messages when using a "topic" exchange. If you're only
592 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
593 for example.
595 =item B<Persistent> B<true>|B<false> (Publish only)
597 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
598 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
599 default), the I<transient> delivery mode will be used, i.e. messages may be
600 lost due to high load, overflowing queues or similar issues.
602 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
604 Selects the format in which messages are sent to the broker. If set to
605 B<Command> (the default), values are sent as C<PUTVAL> commands which are
606 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
607 case, the C<Content-Type> header field will be set to C<text/collectd>.
609 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
610 an easy and straight forward exchange format. The C<Content-Type> header field
611 will be set to C<application/json>.
613 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
614 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
615 C<text/graphite>.
617 A subscribing client I<should> use the C<Content-Type> header field to
618 determine how to decode the values. Currently, the I<AMQP plugin> itself can
619 only decode the B<Command> format.
621 =item B<StoreRates> B<true>|B<false> (Publish only)
623 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
624 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
625 default), no conversion is performed. Otherwise the conversion is performed
626 using the internal value cache.
628 Please note that currently this option is only used if the B<Format> option has
629 been set to B<JSON>.
631 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
633 A prefix can be added in the metric name when outputting in the I<Graphite> format.
634 It's added before the I<Host> name.
635 Metric name will be "<prefix><host><postfix><plugin><type><name>"
637 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
639 A postfix can be added in the metric name when outputting in the I<Graphite> format.
640 It's added after the I<Host> name.
641 Metric name will be "<prefix><host><postfix><plugin><type><name>"
643 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
645 Specify a character to replace dots (.) in the host part of the metric name.
646 In I<Graphite> metric name, dots are used as separators between different
647 metric parts (host, plugin, type).
648 Default is "_" (I<Underscore>).
650 =back
652 =head2 Plugin C<apache>
654 To configure the C<apache>-plugin you first need to configure the Apache
655 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
656 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
657 the following snipped to base your Apache config upon:
659   ExtendedStatus on
660   <IfModule mod_status.c>
661     <Location /mod_status>
662       SetHandler server-status
663     </Location>
664   </IfModule>
666 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
667 also supported. It introduces a new field, called C<BusyServers>, to count the
668 number of currently connected clients. This field is also supported.
670 The configuration of the I<Apache> plugin consists of one or more
671 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
672 as the instance name. For example:
674  <Plugin "apache">
675    <Instance "www1">
676      URL "http://www1.example.com/mod_status?auto"
677    </Instance>
678    <Instance "www2">
679      URL "http://www2.example.com/mod_status?auto"
680    </Instance>
681  </Plugin>
683 The instance name will be used as the I<plugin instance>. To emulate the old
684 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
685 plugin to work correctly, each instance name must be unique. This is not
686 enforced by the plugin and it is your responsibility to ensure it.
688 The following options are accepted within each I<Instance> block:
690 =over 4
692 =item B<URL> I<http://host/mod_status?auto>
694 Sets the URL of the C<mod_status> output. This needs to be the output generated
695 by C<ExtendedStatus on> and it needs to be the machine readable output
696 generated by appending the C<?auto> argument. This option is I<mandatory>.
698 =item B<User> I<Username>
700 Optional user name needed for authentication.
702 =item B<Password> I<Password>
704 Optional password needed for authentication.
706 =item B<VerifyPeer> B<true|false>
708 Enable or disable peer SSL certificate verification. See
709 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
711 =item B<VerifyHost> B<true|false>
713 Enable or disable peer host name verification. If enabled, the plugin checks
714 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
715 certificate matches the host name provided by the B<URL> option. If this
716 identity check fails, the connection is aborted. Obviously, only works when
717 connecting to a SSL enabled server. Enabled by default.
719 =item B<CACert> I<File>
721 File that holds one or more SSL certificates. If you want to use HTTPS you will
722 possibly need this option. What CA certificates come bundled with C<libcurl>
723 and are checked by default depends on the distribution you use.
725 =back
727 =head2 Plugin C<apcups>
729 =over 4
731 =item B<Host> I<Hostname>
733 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
734 that IPv6 support has been disabled unless someone can confirm or decline that
735 B<apcupsd> can handle it.
737 =item B<Port> I<Port>
739 TCP-Port to connect to. Defaults to B<3551>.
741 =item B<ReportSeconds> B<true|false>
743 If set to B<true>, the time reported in the C<timeleft> metric will be
744 converted to seconds. This is the recommended setting. If set to B<false>, the
745 default for backwards compatibility, the time will be reported in minutes.
747 =back
749 =head2 Plugin C<aquaero>
751 This plugin collects the value of the available sensors in an
752 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
753 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
754 connection for monitoring and configuration. The board can handle multiple
755 temperature sensors, fans, water pumps and water level sensors and adjust the
756 output settings such as fan voltage or power used by the water pump based on
757 the available inputs using a configurable controller included in the board.
758 This plugin collects all the available inputs as well as some of the output
759 values chosen by this controller. The plugin is based on the I<libaquaero5>
760 library provided by I<aquatools-ng>.
762 =over 4
764 =item B<Device> I<DevicePath>
766 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
767 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
768 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
770 =back
772 =head2 Plugin C<ascent>
774 This plugin collects information about an Ascent server, a free server for the
775 "World of Warcraft" game. This plugin gathers the information by fetching the
776 XML status page using C<libcurl> and parses it using C<libxml2>.
778 The configuration options are the same as for the C<apache> plugin above:
780 =over 4
782 =item B<URL> I<http://localhost/ascent/status/>
784 Sets the URL of the XML status output.
786 =item B<User> I<Username>
788 Optional user name needed for authentication.
790 =item B<Password> I<Password>
792 Optional password needed for authentication.
794 =item B<VerifyPeer> B<true|false>
796 Enable or disable peer SSL certificate verification. See
797 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
799 =item B<VerifyHost> B<true|false>
801 Enable or disable peer host name verification. If enabled, the plugin checks
802 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
803 certificate matches the host name provided by the B<URL> option. If this
804 identity check fails, the connection is aborted. Obviously, only works when
805 connecting to a SSL enabled server. Enabled by default.
807 =item B<CACert> I<File>
809 File that holds one or more SSL certificates. If you want to use HTTPS you will
810 possibly need this option. What CA certificates come bundled with C<libcurl>
811 and are checked by default depends on the distribution you use.
813 =back
815 =head2 Plugin C<bind>
817 Starting with BIND 9.5.0, the most widely used DNS server software provides
818 extensive statistics about queries, responses and lots of other information.
819 The bind plugin retrieves this information that's encoded in XML and provided
820 via HTTP and submits the values to collectd.
822 To use this plugin, you first need to tell BIND to make this information
823 available. This is done with the C<statistics-channels> configuration option:
825  statistics-channels {
826    inet localhost port 8053;
827  };
829 The configuration follows the grouping that can be seen when looking at the
830 data with an XSLT compatible viewer, such as a modern web browser. It's
831 probably a good idea to make yourself familiar with the provided values, so you
832 can understand what the collected statistics actually mean.
834 Synopsis:
836  <Plugin "bind">
837    URL "http://localhost:8053/"
838    ParseTime       false
839    OpCodes         true
840    QTypes          true
842    ServerStats     true
843    ZoneMaintStats  true
844    ResolverStats   false
845    MemoryStats     true
847    <View "_default">
848      QTypes        true
849      ResolverStats true
850      CacheRRSets   true
852      Zone "127.in-addr.arpa/IN"
853    </View>
854  </Plugin>
856 The bind plugin accepts the following configuration options:
858 =over 4
860 =item B<URL> I<URL>
862 URL from which to retrieve the XML data. If not specified,
863 C<http://localhost:8053/> will be used.
865 =item B<ParseTime> B<true>|B<false>
867 When set to B<true>, the time provided by BIND will be parsed and used to
868 dispatch the values. When set to B<false>, the local time source is queried.
870 This setting is set to B<true> by default for backwards compatibility; setting
871 this to B<false> is I<recommended> to avoid problems with timezones and
872 localization.
874 =item B<OpCodes> B<true>|B<false>
876 When enabled, statistics about the I<"OpCodes">, for example the number of
877 C<QUERY> packets, are collected.
879 Default: Enabled.
881 =item B<QTypes> B<true>|B<false>
883 When enabled, the number of I<incoming> queries by query types (for example
884 C<A>, C<MX>, C<AAAA>) is collected.
886 Default: Enabled.
888 =item B<ServerStats> B<true>|B<false>
890 Collect global server statistics, such as requests received over IPv4 and IPv6,
891 successful queries, and failed updates.
893 Default: Enabled.
895 =item B<ZoneMaintStats> B<true>|B<false>
897 Collect zone maintenance statistics, mostly information about notifications
898 (zone updates) and zone transfers.
900 Default: Enabled.
902 =item B<ResolverStats> B<true>|B<false>
904 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
905 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
906 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
907 default. Use the B<ResolverStats> option within a B<View "_default"> block
908 instead for the same functionality.
910 Default: Disabled.
912 =item B<MemoryStats>
914 Collect global memory statistics.
916 Default: Enabled.
918 =item B<View> I<Name>
920 Collect statistics about a specific I<"view">. BIND can behave different,
921 mostly depending on the source IP-address of the request. These different
922 configurations are called "views". If you don't use this feature, you most
923 likely are only interested in the C<_default> view.
925 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
926 information you want to collect about a view. If no B<View> block is
927 configured, no detailed view statistics will be collected.
929 =over 4
931 =item B<QTypes> B<true>|B<false>
933 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
934 C<MX>) is collected.
936 Default: Enabled.
938 =item B<ResolverStats> B<true>|B<false>
940 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
941 (e.E<nbsp>g. queries over IPv4, lame servers).
943 Default: Enabled.
945 =item B<CacheRRSets> B<true>|B<false>
947 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
948 type is collected. Negative entries (queries which resulted in an error, for
949 example names that do not exist) are reported with a leading exclamation mark,
950 e.E<nbsp>g. "!A".
952 Default: Enabled.
954 =item B<Zone> I<Name>
956 When given, collect detailed information about the given zone in the view. The
957 information collected if very similar to the global B<ServerStats> information
958 (see above).
960 You can repeat this option to collect detailed information about multiple
961 zones.
963 By default no detailed zone information is collected.
965 =back
967 =back
969 =head2 Plugin C<cgroups>
971 This plugin collects the CPU user/system time for each I<cgroup> by reading the
972 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
973 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
975 =over 4
977 =item B<CGroup> I<Directory>
979 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
980 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
981 see below.
983 =item B<IgnoreSelected> B<true>|B<false>
985 Invert the selection: If set to true, all cgroups I<except> the ones that
986 match any one of the criteria are collected. By default only selected
987 cgroups are collected if a selection is made. If no selection is configured
988 at all, B<all> cgroups are selected.
990 =back
992 =head2 Plugin C<cpu>
994 The I<CPU plugin> collects CPU usage metrics.
996 The following configuration options are available:
998 =over 4
1000 =item B<ReportActive> B<false>|B<true>
1002 Reports non-idle CPU usage as the "active" value. Defaults to false.
1004 =item B<ReportByCpu> B<false>|B<true>
1006 When true reports usage for all cores. When false, reports cpu usage
1007 aggregated over all cores. Implies ValuesPercentage when false.
1008 Defaults to true.
1010 =item B<ValuesPercentage> B<false>|B<true>
1012 When true report percentage usage instead of tick values. Defaults to false.
1014 =back
1017 =head2 Plugin C<cpufreq>
1019 This plugin doesn't have any options. It reads
1020 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1021 installed) to get the current CPU frequency. If this file does not exist make
1022 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1023 installed and an "cpu governor" (that's a kernel module) is loaded.
1025 =head2 Plugin C<csv>
1027 =over 4
1029 =item B<DataDir> I<Directory>
1031 Set the directory to store CSV-files under. Per default CSV-files are generated
1032 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1033 The special strings B<stdout> and B<stderr> can be used to write to the standard
1034 output and standard error channels, respectively. This, of course, only makes
1035 much sense when collectd is running in foreground- or non-daemon-mode.
1037 =item B<StoreRates> B<true|false>
1039 If set to B<true>, convert counter values to rates. If set to B<false> (the
1040 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1041 number.
1043 =back
1045 =head2 Plugin C<curl>
1047 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1048 and the match infrastructure (the same code used by the tail plugin) to use
1049 regular expressions with the received data.
1051 The following example will read the current value of AMD stock from Google's
1052 finance page and dispatch the value to collectd.
1054   <Plugin curl>
1055     <Page "stock_quotes">
1056       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1057       User "foo"
1058       Password "bar"
1059       <Match>
1060         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1061         DSType "GaugeAverage"
1062         # Note: `stock_value' is not a standard type.
1063         Type "stock_value"
1064         Instance "AMD"
1065       </Match>
1066     </Page>
1067   </Plugin>
1069 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1070 a web page and one or more "matches" to be performed on the returned data. The
1071 string argument to the B<Page> block is used as plugin instance.
1073 The following options are valid within B<Page> blocks:
1075 =over 4
1077 =item B<URL> I<URL>
1079 URL of the web site to retrieve. Since a regular expression will be used to
1080 extract information from this data, non-binary data is a big plus here ;)
1082 =item B<User> I<Name>
1084 Username to use if authorization is required to read the page.
1086 =item B<Password> I<Password>
1088 Password to use if authorization is required to read the page.
1090 =item B<Digest> B<true>|B<false>
1092 Enable HTTP digest authentication.
1094 =item B<VerifyPeer> B<true>|B<false>
1096 Enable or disable peer SSL certificate verification. See
1097 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1099 =item B<VerifyHost> B<true>|B<false>
1101 Enable or disable peer host name verification. If enabled, the plugin checks if
1102 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1103 matches the host name provided by the B<URL> option. If this identity check
1104 fails, the connection is aborted. Obviously, only works when connecting to a
1105 SSL enabled server. Enabled by default.
1107 =item B<CACert> I<file>
1109 File that holds one or more SSL certificates. If you want to use HTTPS you will
1110 possibly need this option. What CA certificates come bundled with C<libcurl>
1111 and are checked by default depends on the distribution you use.
1113 =item B<Header> I<Header>
1115 A HTTP header to add to the request. Multiple headers are added if this option
1116 is specified more than once.
1118 =item B<Post> I<Body>
1120 Specifies that the HTTP operation should be a POST instead of a GET. The
1121 complete data to be posted is given as the argument.  This option will usually
1122 need to be accompanied by a B<Header> option to set an appropriate
1123 C<Content-Type> for the post body (e.g. to
1124 C<application/x-www-form-urlencoded>).
1126 =item B<MeasureResponseTime> B<true>|B<false>
1128 Measure response time for the request. If this setting is enabled, B<Match>
1129 blocks (see below) are optional. Disabled by default.
1131 =item B<E<lt>MatchE<gt>>
1133 One or more B<Match> blocks that define how to match information in the data
1134 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1135 used by the C<tail> plugin, so please see the documentation of the C<tail>
1136 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1137 is set to B<true>, B<Match> blocks are optional.
1139 =back
1141 =head2 Plugin C<curl_json>
1143 The B<curl_json plugin> collects values from JSON data to be parsed by
1144 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1145 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1146 unix socket. The former can be used, for example, to collect values
1147 from CouchDB documents (which are stored JSON notation), and the
1148 latter to collect values from a uWSGI stats socket.
1150 The following example will collect several values from the built-in
1151 C<_stats> runtime statistics module of I<CouchDB>
1152 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1154   <Plugin curl_json>
1155     <URL "http://localhost:5984/_stats">
1156       Instance "httpd"
1157       <Key "httpd/requests/count">
1158         Type "http_requests"
1159       </Key>
1161       <Key "httpd_request_methods/*/count">
1162         Type "http_request_methods"
1163       </Key>
1165       <Key "httpd_status_codes/*/count">
1166         Type "http_response_codes"
1167       </Key>
1168     </URL>
1169   </Plugin>
1171 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1173   <Plugin curl_json>
1174     <Sock "/var/run/uwsgi.stats.sock">
1175       Instance "uwsgi"
1176       <Key "workers/*/requests">
1177         Type "http_requests"
1178       </Key>
1180       <Key "workers/*/apps/*/requests">
1181         Type "http_requests"
1182       </Key>
1183     </Sock>
1184   </Plugin>
1186 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1187 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1188 blocks defining a unix socket to read JSON from directly.  Each of
1189 these blocks may have one or more B<Key> blocks.
1191 The B<Key> string argument must be in a path format. Each component is
1192 used to match the key from a JSON map or the index of an JSON
1193 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1194 values for all map keys or array indices will be collectd.
1196 The following options are valid within B<URL> blocks:
1198 =over 4
1200 =item B<Instance> I<Instance>
1202 Sets the plugin instance to I<Instance>.
1204 =item B<User> I<Name>
1206 =item B<Password> I<Password>
1208 =item B<Digest> B<true>|B<false>
1210 =item B<VerifyPeer> B<true>|B<false>
1212 =item B<VerifyHost> B<true>|B<false>
1214 =item B<CACert> I<file>
1216 =item B<Header> I<Header>
1218 =item B<Post> I<Body>
1220 These options behave exactly equivalent to the appropriate options of the
1221 I<cURL> plugin. Please see there for a detailed description.
1223 =back
1225 The following options are valid within B<Key> blocks:
1227 =over 4
1229 =item B<Type> I<Type>
1231 Sets the type used to dispatch the values to the daemon. Detailed information
1232 about types and their configuration can be found in L<types.db(5)>. This
1233 option is mandatory.
1235 =item B<Instance> I<Instance>
1237 Type-instance to use. Defaults to the current map key or current string array element value.
1239 =back
1241 =head2 Plugin C<curl_xml>
1243 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1244 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1246  <Plugin "curl_xml">
1247    <URL "http://localhost/stats.xml">
1248      Host "my_host"
1249      Instance "some_instance"
1250      User "collectd"
1251      Password "thaiNg0I"
1252      VerifyPeer true
1253      VerifyHost true
1254      CACert "/path/to/ca.crt"
1256      <XPath "table[@id=\"magic_level\"]/tr">
1257        Type "magic_level"
1258        #InstancePrefix "prefix-"
1259        InstanceFrom "td[1]"
1260        ValuesFrom "td[2]/span[@class=\"level\"]"
1261      </XPath>
1262    </URL>
1263  </Plugin>
1265 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1266 URL to be fetched using libcurl. Within each B<URL> block there are
1267 options which specify the connection parameters, for example authentication
1268 information, and one or more B<XPath> blocks.
1270 Each B<XPath> block specifies how to get one type of information. The
1271 string argument must be a valid XPath expression which returns a list
1272 of "base elements". One value is dispatched for each "base element". The
1273 I<type instance> and values are looked up using further I<XPath> expressions
1274 that should be relative to the base element.
1276 Within the B<URL> block the following options are accepted:
1278 =over 4
1280 =item B<Host> I<Name>
1282 Use I<Name> as the host name when submitting values. Defaults to the global
1283 host name setting.
1285 =item B<Instance> I<Instance>
1287 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1288 empty string (no plugin instance).
1290 =item B<Namespace> I<Prefix> I<URL>
1292 If an XPath expression references namespaces, they must be specified
1293 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1294 I<URL> is the "namespace name", an URI reference uniquely identifying the
1295 namespace. The option can be repeated to register multiple namespaces.
1297 Examples:
1299   Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1300   Namespace "m" "http://www.w3.org/1998/Math/MathML"
1302 =item B<User> I<User>
1304 =item B<Password> I<Password>
1306 =item B<Digest> B<true>|B<false>
1308 =item B<VerifyPeer> B<true>|B<false>
1310 =item B<VerifyHost> B<true>|B<false>
1312 =item B<CACert> I<CA Cert File>
1314 =item B<Header> I<Header>
1316 =item B<Post> I<Body>
1318 These options behave exactly equivalent to the appropriate options of the
1319 I<cURL plugin>. Please see there for a detailed description.
1321 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1323 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1324 B<XPath> block specifies how to get one type of information. The string
1325 argument must be a valid XPath expression which returns a list of "base
1326 elements". One value is dispatched for each "base element".
1328 Within the B<XPath> block the following options are accepted:
1330 =over 4
1332 =item B<Type> I<Type>
1334 Specifies the I<Type> used for submitting patches. This determines the number
1335 of values that are required / expected and whether the strings are parsed as
1336 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1337 This option is required.
1339 =item B<InstancePrefix> I<InstancePrefix>
1341 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1342 concatenated together without any separator.
1343 This option is optional.
1345 =item B<InstanceFrom> I<InstanceFrom>
1347 Specifies a XPath expression to use for determining the I<type instance>. The
1348 XPath expression must return exactly one element. The element's value is then
1349 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1351 This value is required. As a special exception, if the "base XPath expression"
1352 (the argument to the B<XPath> block) returns exactly one argument, then this
1353 option may be omitted.
1355 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1357 Specifies one or more XPath expression to use for reading the values. The
1358 number of XPath expressions must match the number of data sources in the
1359 I<type> specified with B<Type> (see above). Each XPath expression must return
1360 exactly one element. The element's value is then parsed as a number and used as
1361 value for the appropriate value in the value list dispatched to the daemon.
1363 =back
1365 =back
1367 =head2 Plugin C<dbi>
1369 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1370 connect to various databases, execute I<SQL> statements and read back the
1371 results. I<dbi> is an acronym for "database interface" in case you were
1372 wondering about the name. You can configure how each column is to be
1373 interpreted and the plugin will generate one or more data sets from each row
1374 returned according to these rules.
1376 Because the plugin is very generic, the configuration is a little more complex
1377 than those of other plugins. It usually looks something like this:
1379   <Plugin dbi>
1380     <Query "out_of_stock">
1381       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1382       # Use with MySQL 5.0.0 or later
1383       MinVersion 50000
1384       <Result>
1385         Type "gauge"
1386         InstancePrefix "out_of_stock"
1387         InstancesFrom "category"
1388         ValuesFrom "value"
1389       </Result>
1390     </Query>
1391     <Database "product_information">
1392       Driver "mysql"
1393       DriverOption "host" "localhost"
1394       DriverOption "username" "collectd"
1395       DriverOption "password" "aZo6daiw"
1396       DriverOption "dbname" "prod_info"
1397       SelectDB "prod_info"
1398       Query "out_of_stock"
1399     </Database>
1400   </Plugin>
1402 The configuration above defines one query with one result and one database. The
1403 query is then linked to the database with the B<Query> option I<within> the
1404 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1405 and you can also use the B<Include> statement to split up the configuration
1406 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1407 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1408 top to bottom!
1410 The following is a complete list of options:
1412 =head3 B<Query> blocks
1414 Query blocks define I<SQL> statements and how the returned data should be
1415 interpreted. They are identified by the name that is given in the opening line
1416 of the block. Thus the name needs to be unique. Other than that, the name is
1417 not used in collectd.
1419 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1420 define which column holds which value or instance information. You can use
1421 multiple B<Result> blocks to create multiple values from one returned row. This
1422 is especially useful, when queries take a long time and sending almost the same
1423 query again and again is not desirable.
1425 Example:
1427   <Query "environment">
1428     Statement "select station, temperature, humidity from environment"
1429     <Result>
1430       Type "temperature"
1431       # InstancePrefix "foo"
1432       InstancesFrom "station"
1433       ValuesFrom "temperature"
1434     </Result>
1435     <Result>
1436       Type "humidity"
1437       InstancesFrom "station"
1438       ValuesFrom "humidity"
1439     </Result>
1440   </Query>
1442 The following options are accepted:
1444 =over 4
1446 =item B<Statement> I<SQL>
1448 Sets the statement that should be executed on the server. This is B<not>
1449 interpreted by collectd, but simply passed to the database server. Therefore,
1450 the SQL dialect that's used depends on the server collectd is connected to.
1452 The query has to return at least two columns, one for the instance and one
1453 value. You cannot omit the instance, even if the statement is guaranteed to
1454 always return exactly one line. In that case, you can usually specify something
1455 like this:
1457   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1459 (That works with MySQL but may not be valid SQL according to the spec. If you
1460 use a more strict database server, you may have to select from a dummy table or
1461 something.)
1463 Please note that some databases, for example B<Oracle>, will fail if you
1464 include a semicolon at the end of the statement.
1466 =item B<MinVersion> I<Version>
1468 =item B<MaxVersion> I<Value>
1470 Only use this query for the specified database version. You can use these
1471 options to provide multiple queries with the same name but with a slightly
1472 different syntax. The plugin will use only those queries, where the specified
1473 minimum and maximum versions fit the version of the database in use.
1475 The database version is determined by C<dbi_conn_get_engine_version>, see the
1476 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1477 for details. Basically, each part of the version is assumed to be in the range
1478 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1479 "40102", version "5.0.42" becomes "50042".
1481 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1482 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1483 happen. Don't to it! A valid example would be something along these lines:
1485   MinVersion 40000
1486   MaxVersion 49999
1487   ...
1488   MinVersion 50000
1489   MaxVersion 50099
1490   ...
1491   MinVersion 50100
1492   # No maximum
1494 In the above example, there are three ranges that don't overlap. The last one
1495 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1496 before "4.0.0" are not specified.
1498 =item B<Type> I<Type>
1500 The B<type> that's used for each line returned. See L<types.db(5)> for more
1501 details on how types are defined. In short: A type is a predefined layout of
1502 data and the number of values and type of values has to match the type
1503 definition.
1505 If you specify "temperature" here, you need exactly one gauge column. If you
1506 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1507 setting below.
1509 There must be exactly one B<Type> option inside each B<Result> block.
1511 =item B<InstancePrefix> I<prefix>
1513 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1514 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1515 all strings returned in the appropriate columns are concatenated together,
1516 separated by dashes I<("-")>.
1518 =item B<InstancesFrom> I<column0> [I<column1> ...]
1520 Specifies the columns whose values will be used to create the "type-instance"
1521 for each row. If you specify more than one column, the value of all columns
1522 will be joined together with dashes I<("-")> as separation characters.
1524 The plugin itself does not check whether or not all built instances are
1525 different. It's your responsibility to assure that each is unique. This is
1526 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1527 sure that only one row is returned in this case.
1529 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1530 will be empty.
1532 =item B<ValuesFrom> I<column0> [I<column1> ...]
1534 Names the columns whose content is used as the actual data for the data sets
1535 that are dispatched to the daemon. How many such columns you need is determined
1536 by the B<Type> setting above. If you specify too many or not enough columns,
1537 the plugin will complain about that and no data will be submitted to the
1538 daemon.
1540 The actual data type in the columns is not that important. The plugin will
1541 automatically cast the values to the right type if it know how to do that. So
1542 it should be able to handle integer an floating point types, as well as strings
1543 (if they include a number at the beginning).
1545 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1547 =back
1549 =head3 B<Database> blocks
1551 Database blocks define a connection to a database and which queries should be
1552 sent to that database. Since the used "dbi" library can handle a wide variety
1553 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1554 documentationE<nbsp>- we stick as close to the terminology used there.
1556 Each database needs a "name" as string argument in the starting tag of the
1557 block. This name will be used as "PluginInstance" in the values submitted to
1558 the daemon. Other than that, that name is not used.
1560 =over 4
1562 =item B<Driver> I<Driver>
1564 Specifies the driver to use to connect to the database. In many cases those
1565 drivers are named after the database they can connect to, but this is not a
1566 technical necessity. These drivers are sometimes referred to as "DBD",
1567 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1568 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1569 project at L<http://libdbi-drivers.sourceforge.net/>.
1571 You need to give the driver name as expected by the "dbi" library here. You
1572 should be able to find that in the documentation for each driver. If you
1573 mistype the driver name, the plugin will dump a list of all known driver names
1574 to the log.
1576 =item B<DriverOption> I<Key> I<Value>
1578 Sets driver-specific options. What option a driver supports can be found in the
1579 documentation for each driver, somewhere at
1580 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1581 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1583 DBDs can register two types of options: String options and numeric options. The
1584 plugin will use the C<dbi_conn_set_option> function when the configuration
1585 provides a string and the C<dbi_conn_require_option_numeric> function when the
1586 configuration provides a number. So these two lines will actually result in
1587 different calls being used:
1589   DriverOption "Port" 1234      # numeric
1590   DriverOption "Port" "1234"    # string
1592 Unfortunately, drivers are not too keen to report errors when an unknown option
1593 is passed to them, so invalid settings here may go unnoticed. This is not the
1594 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1595 the driver. If a driver complains about an option, the plugin will dump a
1596 complete list of all options understood by that driver to the log. There is no
1597 way to programatically find out if an option expects a string or a numeric
1598 argument, so you will have to refer to the appropriate DBD's documentation to
1599 find this out. Sorry.
1601 =item B<SelectDB> I<Database>
1603 In some cases, the database name you connect with is not the database name you
1604 want to use for querying data. If this option is set, the plugin will "select"
1605 (switch to) that database after the connection is established.
1607 =item B<Query> I<QueryName>
1609 Associates the query named I<QueryName> with this database connection. The
1610 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1611 blocks you want to refer to must be placed above the database block you want to
1612 refer to them from.
1614 =item B<Host> I<Hostname>
1616 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1617 values. Defaults to the global hostname setting.
1619 =back
1621 =head2 Plugin C<df>
1623 =over 4
1625 =item B<Device> I<Device>
1627 Select partitions based on the devicename.
1629 =item B<MountPoint> I<Directory>
1631 Select partitions based on the mountpoint.
1633 =item B<FSType> I<FSType>
1635 Select partitions based on the filesystem type.
1637 =item B<IgnoreSelected> B<true>|B<false>
1639 Invert the selection: If set to true, all partitions B<except> the ones that
1640 match any one of the criteria are collected. By default only selected
1641 partitions are collected if a selection is made. If no selection is configured
1642 at all, B<all> partitions are selected.
1644 =item B<ReportByDevice> B<true>|B<false>
1646 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1647 (the default), it will report a disk as "root", but with it I<true>, it will be
1648 "sda1" (or whichever).
1650 =item B<ReportInodes> B<true>|B<false>
1652 Enables or disables reporting of free, reserved and used inodes. Defaults to
1653 inode collection being disabled.
1655 Enable this option if inodes are a scarce resource for you, usually because
1656 many small files are stored on the disk. This is a usual scenario for mail
1657 transfer agents and web caches.
1659 =item B<ValuesAbsolute> B<true>|B<false>
1661 Enables or disables reporting of free and used disk space in 1K-blocks.
1662 Defaults to B<true>.
1664 =item B<ValuesPercentage> B<false>|B<true>
1666 Enables or disables reporting of free and used disk space in percentage.
1667 Defaults to B<false>.
1669 This is useful for deploying I<collectd> on the cloud, where machines with
1670 different disk size may exist. Then it is more practical to configure
1671 thresholds based on relative disk size.
1673 =back
1675 =head2 Plugin C<disk>
1677 The C<disk> plugin collects information about the usage of physical disks and
1678 logical disks (partitions). Values collected are the number of octets written
1679 to and read from a disk or partition, the number of read/write operations
1680 issued to the disk and a rather complex "time" it took for these commands to be
1681 issued.
1683 Using the following two options you can ignore some disks or configure the
1684 collection only of specific disks.
1686 =over 4
1688 =item B<Disk> I<Name>
1690 Select the disk I<Name>. Whether it is collected or ignored depends on the
1691 B<IgnoreSelected> setting, see below. As with other plugins that use the
1692 daemon's ignorelist functionality, a string that starts and ends with a slash
1693 is interpreted as a regular expression. Examples:
1695   Disk "sdd"
1696   Disk "/hda[34]/"
1698 =item B<IgnoreSelected> B<true>|B<false>
1700 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1701 statements, are ignored or if all other disks are ignored. The behavior
1702 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1703 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1704 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1705 is set to B<true>, all disks are collected B<except> the ones matched.
1707 =item B<UseBSDName> B<true>|B<false>
1709 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1710 default major/minor numbers. Requires collectd to be built with Apple's
1711 IOKitLib support.
1713 =item B<UdevNameAttr> I<Attribute>
1715 Attempt to override disk instance name with the value of a specified udev
1716 attribute when built with B<libudev>.  If the attribute is not defined for the
1717 given device, the default name is used. Example:
1719   UdevNameAttr "DM_NAME"
1721 =back
1723 =head2 Plugin C<dns>
1725 =over 4
1727 =item B<Interface> I<Interface>
1729 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1730 option sets the interface that should be used. If this option is not set, or
1731 set to "any", the plugin will try to get packets from B<all> interfaces. This
1732 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1734 =item B<IgnoreSource> I<IP-address>
1736 Ignore packets that originate from this address.
1738 =item B<SelectNumericQueryTypes> B<true>|B<false>
1740 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1742 =back
1744 =head2 Plugin C<email>
1746 =over 4
1748 =item B<SocketFile> I<Path>
1750 Sets the socket-file which is to be created.
1752 =item B<SocketGroup> I<Group>
1754 If running as root change the group of the UNIX-socket after it has been
1755 created. Defaults to B<collectd>.
1757 =item B<SocketPerms> I<Permissions>
1759 Change the file permissions of the UNIX-socket after it has been created. The
1760 permissions must be given as a numeric, octal value as you would pass to
1761 L<chmod(1)>. Defaults to B<0770>.
1763 =item B<MaxConns> I<Number>
1765 Sets the maximum number of connections that can be handled in parallel. Since
1766 this many threads will be started immediately setting this to a very high
1767 value will waste valuable resources. Defaults to B<5> and will be forced to be
1768 at most B<16384> to prevent typos and dumb mistakes.
1770 =back
1772 =head2 Plugin C<ethstat>
1774 The I<ethstat plugin> collects information about network interface cards (NICs)
1775 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1777 B<Synopsis:>
1779  <Plugin "ethstat">
1780    Interface "eth0"
1781    Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1782    Map "multicast" "if_multicast"
1783  </Plugin>
1785 B<Options:>
1787 =over 4
1789 =item B<Interface> I<Name>
1791 Collect statistical information about interface I<Name>.
1793 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1795 By default, the plugin will submit values as type C<derive> and I<type
1796 instance> set to I<Name>, the name of the metric as reported by the driver. If
1797 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1798 I<TypeInstance> will be used.
1800 =item B<MappedOnly> B<true>|B<false>
1802 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1803 collected, all other metrics will be ignored. Defaults to B<false>.
1805 =back
1807 =head2 Plugin C<exec>
1809 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1810 contains valuable information on when the executable is executed and the
1811 output that is expected from it.
1813 =over 4
1815 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1817 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1819 Execute the executable I<Executable> as user I<User>. If the user name is
1820 followed by a colon and a group name, the effective group is set to that group.
1821 The real group and saved-set group will be set to the default group of that
1822 user. If no group is given the effective group ID will be the same as the real
1823 group ID.
1825 Please note that in order to change the user and/or group the daemon needs
1826 superuser privileges. If the daemon is run as an unprivileged user you must
1827 specify the same user/group here. If the daemon is run with superuser
1828 privileges, you must supply a non-root user here.
1830 The executable may be followed by optional arguments that are passed to the
1831 program. Please note that due to the configuration parsing numbers and boolean
1832 values may be changed. If you want to be absolutely sure that something is
1833 passed as-is please enclose it in quotes.
1835 The B<Exec> and B<NotificationExec> statements change the semantics of the
1836 programs executed, i.E<nbsp>e. the data passed to them and the response
1837 expected from them. This is documented in great detail in L<collectd-exec(5)>.
1839 =back
1841 =head2 Plugin C<filecount>
1843 The C<filecount> plugin counts the number of files in a certain directory (and
1844 its subdirectories) and their combined size. The configuration is very straight
1845 forward:
1847   <Plugin "filecount">
1848     <Directory "/var/qmail/queue/mess">
1849       Instance "qmail-message"
1850     </Directory>
1851     <Directory "/var/qmail/queue/todo">
1852       Instance "qmail-todo"
1853     </Directory>
1854     <Directory "/var/lib/php5">
1855       Instance "php5-sessions"
1856       Name "sess_*"
1857     </Directory>
1858   </Plugin>
1860 The example above counts the number of files in QMail's queue directories and
1861 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
1862 QMail has not yet looked at, the "message" queue holds the messages that were
1863 classified into "local" and "remote".
1865 As you can see, the configuration consists of one or more C<Directory> blocks,
1866 each of which specifies a directory in which to count the files. Within those
1867 blocks, the following options are recognized:
1869 =over 4
1871 =item B<Instance> I<Instance>
1873 Sets the plugin instance to I<Instance>. That instance name must be unique, but
1874 it's your responsibility, the plugin doesn't check for that. If not given, the
1875 instance is set to the directory name with all slashes replaced by underscores
1876 and all leading underscores removed.
1878 =item B<Name> I<Pattern>
1880 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
1881 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
1882 against the pattern, not the entire path. In case this makes it easier for you:
1883 This option has been named after the B<-name> parameter to L<find(1)>.
1885 =item B<MTime> I<Age>
1887 Count only files of a specific age: If I<Age> is greater than zero, only files
1888 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
1889 a negative number, this is inversed. For example, if B<-60> is specified, only
1890 files that have been modified in the last minute will be counted.
1892 The number can also be followed by a "multiplier" to easily specify a larger
1893 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
1894 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
1895 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
1896 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
1897 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
1898 B<"12h">.
1900 =item B<Size> I<Size>
1902 Count only files of a specific size. When I<Size> is a positive number, only
1903 files that are at least this big are counted. If I<Size> is a negative number,
1904 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
1905 I<Size> are counted.
1907 As with the B<MTime> option, a "multiplier" may be added. For a detailed
1908 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
1909 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
1910 note that there are 1000 bytes in a kilobyte, not 1024.
1912 =item B<Recursive> I<true>|I<false>
1914 Controls whether or not to recurse into subdirectories. Enabled by default.
1916 =item B<IncludeHidden> I<true>|I<false>
1918 Controls whether or not to include "hidden" files and directories in the count.
1919 "Hidden" files and directories are those, whose name begins with a dot.
1920 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
1922 =back
1924 =head2 Plugin C<GenericJMX>
1926 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
1927 L<collectd-java(5)>.
1929 =head2 Plugin C<gmond>
1931 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
1932 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
1933 are built-in, custom mappings may be added via B<Metric> blocks, see below.
1935 Synopsis:
1937  <Plugin "gmond">
1938    MCReceiveFrom "239.2.11.71" "8649"
1939    <Metric "swap_total">
1940      Type "swap"
1941      TypeInstance "total"
1942      DataSource "value"
1943    </Metric>
1944    <Metric "swap_free">
1945      Type "swap"
1946      TypeInstance "free"
1947      DataSource "value"
1948    </Metric>
1949  </Plugin>
1951 The following metrics are built-in:
1953 =over 4
1955 =item *
1957 load_one, load_five, load_fifteen
1959 =item *
1961 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
1963 =item *
1965 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
1967 =item *
1969 bytes_in, bytes_out
1971 =item *
1973 pkts_in, pkts_out
1975 =back
1977 Available configuration options:
1979 =over 4
1981 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
1983 Sets sets the multicast group and UDP port to which to subscribe.
1985 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
1987 =item E<lt>B<Metric> I<Name>E<gt>
1989 These blocks add a new metric conversion to the internal table. I<Name>, the
1990 string argument to the B<Metric> block, is the metric name as used by Ganglia.
1992 =over 4
1994 =item B<Type> I<Type>
1996 Type to map this metric to. Required.
1998 =item B<TypeInstance> I<Instance>
2000 Type-instance to use. Optional.
2002 =item B<DataSource> I<Name>
2004 Data source to map this metric to. If the configured type has exactly one data
2005 source, this is optional. Otherwise the option is required.
2007 =back
2009 =back
2011 =head2 Plugin C<hddtemp>
2013 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2014 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2015 default values, see below. C<hddtemp> has to be running to work correctly. If
2016 C<hddtemp> is not running timeouts may appear which may interfere with other
2017 statistics..
2019 The B<hddtemp> homepage can be found at
2020 L<http://www.guzu.net/linux/hddtemp.php>.
2022 =over 4
2024 =item B<Host> I<Hostname>
2026 Hostname to connect to. Defaults to B<127.0.0.1>.
2028 =item B<Port> I<Port>
2030 TCP-Port to connect to. Defaults to B<7634>.
2032 =back
2034 =head2 Plugin C<interface>
2036 =over 4
2038 =item B<Interface> I<Interface>
2040 Select this interface. By default these interfaces will then be collected. For
2041 a more detailed description see B<IgnoreSelected> below.
2043 =item B<IgnoreSelected> I<true>|I<false>
2045 If no configuration if given, the B<traffic>-plugin will collect data from
2046 all interfaces. This may not be practical, especially for loopback- and
2047 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2048 interfaces you're interested in. Sometimes, however, it's easier/preferred
2049 to collect all interfaces I<except> a few ones. This option enables you to
2050 do that: By setting B<IgnoreSelected> to I<true> the effect of
2051 B<Interface> is inverted: All selected interfaces are ignored and all
2052 other interfaces are collected.
2054 =back
2056 =head2 Plugin C<ipmi>
2058 =over 4
2060 =item B<Sensor> I<Sensor>
2062 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2064 =item B<IgnoreSelected> I<true>|I<false>
2066 If no configuration if given, the B<ipmi> plugin will collect data from all
2067 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2068 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2069 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2070 all other sensors are collected.
2072 =item B<NotifySensorAdd> I<true>|I<false>
2074 If a sensor appears after initialization time of a minute a notification
2075 is sent.
2077 =item B<NotifySensorRemove> I<true>|I<false>
2079 If a sensor disappears a notification is sent.
2081 =item B<NotifySensorNotPresent> I<true>|I<false>
2083 If you have for example dual power supply and one of them is (un)plugged then
2084 a notification is sent.
2086 =back
2088 =head2 Plugin C<iptables>
2090 =over 4
2092 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2094 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2095 will collect the counters of all rules which have a comment-match. The comment
2096 is then used as type-instance.
2098 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2099 the I<n>th rule will be collected. Again, the comment (or the number) will be
2100 used as the type-instance.
2102 If I<Name> is supplied, it will be used as the type-instance instead of the
2103 comment or the number.
2105 =back
2107 =head2 Plugin C<irq>
2109 =over 4
2111 =item B<Irq> I<Irq>
2113 Select this irq. By default these irqs will then be collected. For a more
2114 detailed description see B<IgnoreSelected> below.
2116 =item B<IgnoreSelected> I<true>|I<false>
2118 If no configuration if given, the B<irq>-plugin will collect data from all
2119 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2120 can use the B<Irq>-option to pick the interrupt you're interested in.
2121 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2122 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2123 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2124 and all other interrupts are collected.
2126 =back
2128 =head2 Plugin C<java>
2130 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2131 This section only discusses the syntax and semantic of the configuration
2132 options. For more in-depth information on the I<Java> plugin, please read
2133 L<collectd-java(5)>.
2135 Synopsis:
2137  <Plugin "java">
2138    JVMArg "-verbose:jni"
2139    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2140    LoadPlugin "org.collectd.java.Foobar"
2141    <Plugin "org.collectd.java.Foobar">
2142      # To be parsed by the plugin
2143    </Plugin>
2144  </Plugin>
2146 Available configuration options:
2148 =over 4
2150 =item B<JVMArg> I<Argument>
2152 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2153 exactly the way the arguments to the I<java> binary on the command line work.
2154 Execute C<javaE<nbsp>--help> for details.
2156 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2157 any other options! When another option is found, the JVM will be started and
2158 later options will have to be ignored!
2160 =item B<LoadPlugin> I<JavaClass>
2162 Instantiates a new I<JavaClass> object. The constructor of this object very
2163 likely then registers one or more callback methods with the server.
2165 See L<collectd-java(5)> for details.
2167 When the first such option is found, the virtual machine (JVM) is created. This
2168 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2169 B<LoadPlugin> options!
2171 =item B<Plugin> I<Name>
2173 The entire block is passed to the Java plugin as an
2174 I<org.collectd.api.OConfigItem> object.
2176 For this to work, the plugin has to register a configuration callback first,
2177 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2178 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2179 depends on the (Java) plugin registering the callback and is completely
2180 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2182 =back
2184 =head2 Plugin C<libvirt>
2186 This plugin allows CPU, disk and network load to be collected for virtualized
2187 guests on the machine. This means that these characteristics can be collected
2188 for guest systems without installing any software on them - collectd only runs
2189 on the hosting system. The statistics are collected through libvirt
2190 (L<http://libvirt.org/>).
2192 Only I<Connection> is required.
2194 =over 4
2196 =item B<Connection> I<uri>
2198 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2200  Connection "xen:///"
2202 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2204 =item B<RefreshInterval> I<seconds>
2206 Refresh the list of domains and devices every I<seconds>. The default is 60
2207 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2208 the list of domains and devices to be refreshed on every iteration.
2210 Refreshing the devices in particular is quite a costly operation, so if your
2211 virtualization setup is static you might consider increasing this. If this
2212 option is set to 0, refreshing is disabled completely.
2214 =item B<Domain> I<name>
2216 =item B<BlockDevice> I<name:dev>
2218 =item B<InterfaceDevice> I<name:dev>
2220 =item B<IgnoreSelected> I<true>|I<false>
2222 Select which domains and devices are collected.
2224 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2225 disk/network devices are collected.
2227 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2228 domains and disk/network devices are ignored, while the rest are collected.
2230 The domain name and device names may use a regular expression, if the name is
2231 surrounded by I</.../> and collectd was compiled with support for regexps.
2233 The default is to collect statistics for all domains and all their devices.
2235 Example:
2237  BlockDevice "/:hdb/"
2238  IgnoreSelected "true"
2240 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2241 will be collected.
2243 =item B<HostnameFormat> B<name|uuid|hostname|...>
2245 When the libvirt plugin logs data, it sets the hostname of the collected data
2246 according to this setting. The default is to use the guest name as provided by
2247 the hypervisor, which is equal to setting B<name>.
2249 B<uuid> means use the guest's UUID. This is useful if you want to track the
2250 same guest across migrations.
2252 B<hostname> means to use the global B<Hostname> setting, which is probably not
2253 useful on its own because all guests will appear to have the same name.
2255 You can also specify combinations of these fields. For example B<name uuid>
2256 means to concatenate the guest name and UUID (with a literal colon character
2257 between, thus I<"foo:1234-1234-1234-1234">).
2259 =item B<InterfaceFormat> B<name>|B<address>
2261 When the libvirt plugin logs interface data, it sets the name of the collected
2262 data according to this setting. The default is to use the path as provided by
2263 the hypervisor (the "dev" property of the target node), which is equal to
2264 setting B<name>.
2266 B<address> means use the interface's mac address. This is useful since the
2267 interface path might change between reboots of a guest or across migrations.
2269 =back
2271 +=head2 Plugin C<load>
2273 The I<Load plugin> collects the system load. These numbers give a rough overview
2274 over the utilization of a machine. The system load is defined as the number of
2275 runnable tasks in the run-queue and is provided by many operating systems as a
2276 one, five or fifteen minute average.
2278 The following configuration options are available:
2280 =over 4
2282 =item B<ReportRelative> B<false>|B<true>
2284 When enabled, system load divided by number of available CPU cores is reported
2285 for intervals 1 min, 5 min and 15 min. Defaults to false.
2287 =back
2290 =head2 Plugin C<logfile>
2292 =over 4
2294 =item B<LogLevel> B<debug|info|notice|warning|err>
2296 Sets the log-level. If, for example, set to B<notice>, then all events with
2297 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2299 Please note that B<debug> is only available if collectd has been compiled with
2300 debugging support.
2302 =item B<File> I<File>
2304 Sets the file to write log messages to. The special strings B<stdout> and
2305 B<stderr> can be used to write to the standard output and standard error
2306 channels, respectively. This, of course, only makes much sense when I<collectd>
2307 is running in foreground- or non-daemon-mode.
2309 =item B<Timestamp> B<true>|B<false>
2311 Prefix all lines printed by the current time. Defaults to B<true>.
2313 =item B<PrintSeverity> B<true>|B<false>
2315 When enabled, all lines are prefixed by the severity of the log message, for
2316 example "warning". Defaults to B<false>.
2318 =back
2320 B<Note>: There is no need to notify the daemon after moving or removing the
2321 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2322 for each line it writes.
2324 =head2 Plugin C<log_logstash>
2326 The I<log logstash plugin> behaves like the logfile plugin but formats
2327 messages as JSON events for logstash to parse and input.
2329 =over 4
2331 =item B<LogLevel> B<debug|info|notice|warning|err>
2333 Sets the log-level. If, for example, set to B<notice>, then all events with
2334 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2336 Please note that B<debug> is only available if collectd has been compiled with
2337 debugging support.
2339 =item B<File> I<File>
2341 Sets the file to write log messages to. The special strings B<stdout> and
2342 B<stderr> can be used to write to the standard output and standard error
2343 channels, respectively. This, of course, only makes much sense when I<collectd>
2344 is running in foreground- or non-daemon-mode.
2346 =back
2348 B<Note>: There is no need to notify the daemon after moving or removing the
2349 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2350 for each line it writes.
2352 =head2 Plugin C<lpar>
2354 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2355 virtualization technique for IBM POWER processors. It takes into account CPU
2356 time stolen from or donated to a partition, in addition to the usual user,
2357 system, I/O statistics.
2359 The following configuration options are available:
2361 =over 4
2363 =item B<CpuPoolStats> B<false>|B<true>
2365 When enabled, statistics about the processor pool are read, too. The partition
2366 needs to have pool authority in order to be able to acquire this information.
2367 Defaults to false.
2369 =item B<ReportBySerial> B<false>|B<true>
2371 If enabled, the serial of the physical machine the partition is currently
2372 running on is reported as I<hostname> and the logical hostname of the machine
2373 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2374 used (just like other plugins) and the I<plugin instance> will be empty.
2375 Defaults to false.
2377 =back
2379 =head2 Plugin C<mbmon>
2381 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2383 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2384 B<Host> and B<Port> options can be used to change these values, see below.
2385 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2386 timeouts may appear which may interfere with other statistics..
2388 C<mbmon> must be run with the -r option ("print TAG and Value format");
2389 Debian's F</etc/init.d/mbmon> script already does this, other people
2390 will need to ensure that this is the case.
2392 =over 4
2394 =item B<Host> I<Hostname>
2396 Hostname to connect to. Defaults to B<127.0.0.1>.
2398 =item B<Port> I<Port>
2400 TCP-Port to connect to. Defaults to B<411>.
2402 =back
2404 =head2 Plugin C<md>
2406 The C<md plugin> collects information from Linux Software-RAID devices (md).
2408 All reported values are of the type C<md_disks>. Reported type instances are
2409 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2410 I<missing> (physically absent) disks.
2412 =over 4
2414 =item B<Device> I<Device>
2416 Select md devices based on device name. The I<device name> is the basename of
2417 the device, i.e. the name of the block device without the leading C</dev/>.
2418 See B<IgnoreSelected> for more details.
2420 =item B<IgnoreSelected> B<true>|B<false>
2422 Invert device selection: If set to B<true>, all md devices B<except> those
2423 listed using B<Device> are collected. If B<false> (the default), only those
2424 listed are collected. If no configuration is given, the B<md> plugin will
2425 collect data from all md devices.
2427 =back
2429 =head2 Plugin C<memcachec>
2431 The C<memcachec plugin> connects to a memcached server, queries one or more
2432 given I<pages> and parses the returned data according to user specification.
2433 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2434 plugins.
2436 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2437 library. Please note that there is another library with a very similar name,
2438 libmemcache (notice the missing `d'), which is not applicable.
2440 Synopsis of the configuration:
2442  <Plugin "memcachec">
2443    <Page "plugin_instance">
2444      Server "localhost"
2445      Key "page_key"
2446      <Match>
2447        Regex "(\\d+) bytes sent"
2448        DSType CounterAdd
2449        Type "ipt_octets"
2450        Instance "type_instance"
2451      </Match>
2452    </Page>
2453  </Plugin>
2455 The configuration options are:
2457 =over 4
2459 =item E<lt>B<Page> I<Name>E<gt>
2461 Each B<Page> block defines one I<page> to be queried from the memcached server.
2462 The block requires one string argument which is used as I<plugin instance>.
2464 =item B<Server> I<Address>
2466 Sets the server address to connect to when querying the page. Must be inside a
2467 B<Page> block.
2469 =item B<Key> I<Key>
2471 When connected to the memcached server, asks for the page I<Key>.
2473 =item E<lt>B<Match>E<gt>
2475 Match blocks define which strings to look for and how matches substrings are
2476 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2478 =back
2480 =head2 Plugin C<memcached>
2482 The B<memcached plugin> connects to a memcached server and queries statistics
2483 about cache utilization, memory and bandwidth used.
2484 L<http://www.danga.com/memcached/>
2486  <Plugin "memcached">
2487    <Instance "name">
2488      Host "memcache.example.com"
2489      Port 11211
2490    </Instance>
2491  </Plugin>
2493 The plugin configuration consists of one or more B<Instance> blocks which
2494 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2495 following options are allowed:
2497 =over 4
2499 =item B<Host> I<Hostname>
2501 Hostname to connect to. Defaults to B<127.0.0.1>.
2503 =item B<Port> I<Port>
2505 TCP-Port to connect to. Defaults to B<11211>.
2507 =item B<Socket> I<Path>
2509 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2510 setting is given, the B<Host> and B<Port> settings are ignored.
2512 =back
2514 =head2 Plugin C<mic>
2516 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2517 Intel's Many Integrated Core (MIC) systems.
2519 B<Synopsis:>
2521  <Plugin mic>
2522    ShowCPU true
2523    ShowCPUCores true
2524    ShowMemory true
2526    ShowTemperatures true
2527    Temperature vddg
2528    Temperature vddq
2529    IgnoreSelectedTemperature true
2531    ShowPower true
2532    Power total0
2533    Power total1
2534    IgnoreSelectedPower true
2535  </Plugin>
2537 The following options are valid inside the B<PluginE<nbsp>mic> block:
2539 =over 4
2541 =item B<ShowCPU> B<true>|B<false>
2543 If enabled (the default) a sum of the CPU usage accross all cores is reported.
2545 =item B<ShowCPUCores> B<true>|B<false>
2547 If enabled (the default) per-core CPU usage is reported.
2549 =item B<ShowMemory> B<true>|B<false>
2551 If enabled (the default) the physical memory usage of the MIC system is
2552 reported.
2554 =item B<ShowTemperatures> B<true>|B<false>
2556 If enabled (the default) various temperatures of the MIC system are reported.
2558 =item B<Temperature> I<Name>
2560 This option controls which temperatures are being reported. Whether matching
2561 temperatures are being ignored or I<only> matching temperatures are reported
2562 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2563 temperatures are reported.
2565 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2567 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2568 (the default) only temperatures matching a B<Temperature> option are reported
2569 or, if no B<Temperature> option is specified, all temperatures are reported. If
2570 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2571 are reported.
2573 Known temperature names are:
2575 =over 4
2577 =item die
2579 Die of the CPU
2581 =item devmem
2583 Device Memory
2585 =item fin
2587 Fan In
2589 =item fout
2591 Fan Out
2593 =item vccp
2595 Voltage ccp
2597 =item vddg
2599 Voltage ddg
2601 =item vddq
2603 Voltage ddq
2605 =back
2607 =item B<ShowPower> B<true>|B<false>
2609 If enabled (the default) various temperatures of the MIC system are reported.
2611 =item B<Power> I<Name>
2613 This option controls which power readings are being reported. Whether matching
2614 power readings are being ignored or I<only> matching power readings are reported
2615 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2616 power readings are reported.
2618 =item B<IgnoreSelectedPower> B<false>|B<true>
2620 Controls the behavior of the B<Power> setting above. If set to B<false>
2621 (the default) only power readings matching a B<Power> option are reported
2622 or, if no B<Power> option is specified, all power readings are reported. If
2623 set to B<true>, matching power readings are I<ignored> and all other power readings
2624 are reported.
2626 Known power names are:
2628 =over 4
2630 =item total0
2632 Total power utilization averaged over Time Window 0 (uWatts).
2634 =item total1
2636 Total power utilization averaged over Time Window 0 (uWatts).
2638 =item inst
2640 Instantaneous power (uWatts).
2642 =item imax
2644 Max instantaneous power (uWatts).
2646 =item pcie
2648 PCI-E connector power (uWatts).
2650 =item c2x3
2652 2x3 connector power (uWatts).
2654 =item c2x4
2656 2x4 connector power (uWatts).
2658 =item vccp
2660 Core rail (uVolts).
2662 =item vddg
2664 Uncore rail (uVolts).
2666 =item vddq
2668 Memory subsystem rail (uVolts).
2670 =back
2672 =back
2674 =head2 Plugin C<memory>
2676 The I<memory plugin> provides the following configuration options:
2678 =over 4
2680 =item B<ValuesAbsolute> B<true>|B<false>
2682 Enables or disables reporting of physical memory usage in absolute numbers,
2683 i.e. bytes. Defaults to B<true>.
2685 =item B<ValuesPercentage> B<false>|B<true>
2687 Enables or disables reporting of physical memory usage in percentages, e.g.
2688 percent of physical memory used. Defaults to B<false>.
2690 This is useful for deploying I<collectd> in a heterogeneous environment in
2691 which the sizes of physical memory vary.
2693 =back
2695 =head2 Plugin C<modbus>
2697 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2698 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2699 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2700 values (two registers interpreted as IEEE floats in big endian notation).
2702 B<Synopsis:>
2704  <Data "voltage-input-1">
2705    RegisterBase 0
2706    RegisterType float
2707    Type voltage
2708    Instance "input-1"
2709  </Data>
2711  <Data "voltage-input-2">
2712    RegisterBase 2
2713    RegisterType float
2714    Type voltage
2715    Instance "input-2"
2716  </Data>
2718  <Host "modbus.example.com">
2719    Address "192.168.0.42"
2720    Port    "502"
2721    Interval 60
2723    <Slave 1>
2724      Instance "power-supply"
2725      Collect  "voltage-input-1"
2726      Collect  "voltage-input-2"
2727    </Slave>
2728  </Host>
2730 =over 4
2732 =item E<lt>B<Data> I<Name>E<gt> blocks
2734 Data blocks define a mapping between register numbers and the "types" used by
2735 I<collectd>.
2737 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2739 =over 4
2741 =item B<RegisterBase> I<Number>
2743 Configures the base register to read from the device. If the option
2744 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2745 register will be read (the register number is increased by one).
2747 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2749 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2750 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2751 combined into one value. Defaults to B<Uint16>.
2753 =item B<Type> I<Type>
2755 Specifies the "type" (data set) to use when dispatching the value to
2756 I<collectd>. Currently, only data sets with exactly one data source are
2757 supported.
2759 =item B<Instance> I<Instance>
2761 Sets the type instance to use when dispatching the value to I<collectd>. If
2762 unset, an empty string (no type instance) is used.
2764 =back
2766 =item E<lt>B<Host> I<Name>E<gt> blocks
2768 Host blocks are used to specify to which hosts to connect and what data to read
2769 from their "slaves". The string argument I<Name> is used as hostname when
2770 dispatching the values to I<collectd>.
2772 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2774 =over 4
2776 =item B<Address> I<Hostname>
2778 Specifies the node name (the actual network address) used to connect to the
2779 host. This may be an IP address or a hostname. Please note that the used
2780 I<libmodbus> library only supports IPv4 at the moment.
2782 =item B<Port> I<Service>
2784 Specifies the port used to connect to the host. The port can either be given as
2785 a number or as a service name. Please note that the I<Service> argument must be
2786 a string, even if ports are given in their numerical form. Defaults to "502".
2788 =item B<Interval> I<Interval>
2790 Sets the interval (in seconds) in which the values will be collected from this
2791 host. By default the global B<Interval> setting will be used.
2793 =item E<lt>B<Slave> I<ID>E<gt>
2795 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2796 is used to specify which device should be addressed. For each device you want
2797 to query, one B<Slave> block must be given.
2799 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2801 =over 4
2803 =item B<Instance> I<Instance>
2805 Specify the plugin instance to use when dispatching the values to I<collectd>.
2806 By default "slave_I<ID>" is used.
2808 =item B<Collect> I<DataName>
2810 Specifies which data to retrieve from the device. I<DataName> must be the same
2811 string as the I<Name> argument passed to a B<Data> block. You can specify this
2812 option multiple times to collect more than one value from a slave. At least one
2813 B<Collect> option is mandatory.
2815 =back
2817 =back
2819 =back
2821 =head2 Plugin C<mysql>
2823 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
2824 one or more databases when started and keeps the connection up as long as
2825 possible. When the connection is interrupted for whatever reason it will try
2826 to re-connect. The plugin will complain loudly in case anything goes wrong.
2828 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
2829 and collects information about MySQL network traffic, executed statements,
2830 requests, the query cache and threads by evaluating the
2831 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
2832 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
2833 Status Variables> for an explanation of these values.
2835 Optionally, master and slave statistics may be collected in a MySQL
2836 replication setup. In that case, information about the synchronization state
2837 of the nodes are collected by evaluating the C<Position> return value of the
2838 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
2839 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
2840 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
2841 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
2842 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
2844 Synopsis:
2846   <Plugin mysql>
2847     <Database foo>
2848       Host "hostname"
2849       User "username"
2850       Password "password"
2851       Port "3306"
2852       MasterStats true
2853     </Database>
2855     <Database bar>
2856       Host "localhost"
2857       Socket "/var/run/mysql/mysqld.sock"
2858       SlaveStats true
2859       SlaveNotifications true
2860     </Database>
2861   </Plugin>
2863 A B<Database> block defines one connection to a MySQL database. It accepts a
2864 single argument which specifies the name of the database. None of the other
2865 options are required. MySQL will use default values as documented in the
2866 section "mysql_real_connect()" in the B<MySQL reference manual>.
2868 =over 4
2870 =item B<Host> I<Hostname>
2872 Hostname of the database server. Defaults to B<localhost>.
2874 =item B<User> I<Username>
2876 Username to use when connecting to the database. The user does not have to be
2877 granted any privileges (which is synonym to granting the C<USAGE> privilege),
2878 unless you want to collectd replication statistics (see B<MasterStats> and
2879 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
2880 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
2882 =item B<Password> I<Password>
2884 Password needed to log into the database.
2886 =item B<Database> I<Database>
2888 Select this database. Defaults to I<no database> which is a perfectly reasonable
2889 option for what this plugin does.
2891 =item B<Port> I<Port>
2893 TCP-port to connect to. The port must be specified in its numeric form, but it
2894 must be passed as a string nonetheless. For example:
2896   Port "3306"
2898 If B<Host> is set to B<localhost> (the default), this setting has no effect.
2899 See the documentation for the C<mysql_real_connect> function for details.
2901 =item B<Socket> I<Socket>
2903 Specifies the path to the UNIX domain socket of the MySQL server. This option
2904 only has any effect, if B<Host> is set to B<localhost> (the default).
2905 Otherwise, use the B<Port> option above. See the documentation for the
2906 C<mysql_real_connect> function for details.
2908 =item B<MasterStats> I<true|false>
2910 =item B<SlaveStats> I<true|false>
2912 Enable the collection of master / slave statistics in a replication setup. In
2913 order to be able to get access to these statistics, the user needs special
2914 privileges. See the B<User> documentation above.
2916 =item B<SlaveNotifications> I<true|false>
2918 If enabled, the plugin sends a notification if the replication slave I/O and /
2919 or SQL threads are not running.
2921 =back
2923 =head2 Plugin C<netapp>
2925 The netapp plugin can collect various performance and capacity information
2926 from a NetApp filer using the NetApp API.
2928 Please note that NetApp has a wide line of products and a lot of different
2929 software versions for each of these products. This plugin was developed for a
2930 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
2931 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
2932 model and software version but it is very hard to test this.
2933 If you have used this plugin with other models and/or software version, feel
2934 free to send us a mail to tell us about the results, even if it's just a short
2935 "It works".
2937 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
2938 basic authentication.
2940 B<Do not use a regular user for this!> Create a special collectd user with just
2941 the minimum of capabilities needed. The user only needs the "login-http-admin"
2942 capability as well as a few more depending on which data will be collected.
2943 Required capabilities are documented below.
2945 =head3 Synopsis
2947  <Plugin "netapp">
2948    <Host "netapp1.example.com">
2949     Protocol      "https"
2950     Address       "10.0.0.1"
2951     Port          443
2952     User          "username"
2953     Password      "aef4Aebe"
2954     Interval      30
2956     <WAFL>
2957       Interval 30
2958       GetNameCache   true
2959       GetDirCache    true
2960       GetBufferCache true
2961       GetInodeCache  true
2962     </WAFL>
2964     <Disks>
2965       Interval 30
2966       GetBusy true
2967     </Disks>
2969     <VolumePerf>
2970       Interval 30
2971       GetIO      "volume0"
2972       IgnoreSelectedIO      false
2973       GetOps     "volume0"
2974       IgnoreSelectedOps     false
2975       GetLatency "volume0"
2976       IgnoreSelectedLatency false
2977     </VolumePerf>
2979     <VolumeUsage>
2980       Interval 30
2981       GetCapacity "vol0"
2982       GetCapacity "vol1"
2983       IgnoreSelectedCapacity false
2984       GetSnapshot "vol1"
2985       GetSnapshot "vol3"
2986       IgnoreSelectedSnapshot false
2987     </VolumeUsage>
2989     <Quota>
2990       Interval 60
2991     </Quota>
2993     <Snapvault>
2994       Interval 30
2995     </Snapvault>
2997     <System>
2998       Interval 30
2999       GetCPULoad     true
3000       GetInterfaces  true
3001       GetDiskOps     true
3002       GetDiskIO      true
3003     </System>
3005     <VFiler vfilerA>
3006       Interval 60
3008       SnapVault true
3009       # ...
3010     </VFiler>
3011    </Host>
3012  </Plugin>
3014 The netapp plugin accepts the following configuration options:
3016 =over 4
3018 =item B<Host> I<Name>
3020 A host block defines one NetApp filer. It will appear in collectd with the name
3021 you specify here which does not have to be its real name nor its hostname (see
3022 the B<Address> option below).
3024 =item B<VFiler> I<Name>
3026 A B<VFiler> block may only be used inside a host block. It accepts all the
3027 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3028 will execute all NetApp API commands in the context of the specified
3029 VFiler(R). It will appear in collectd with the name you specify here which
3030 does not have to be its real name. The VFiler name may be specified using the
3031 B<VFilerName> option. If this is not specified, it will default to the name
3032 you specify here.
3034 The VFiler block inherits all connection related settings from the surrounding
3035 B<Host> block (which appear before the B<VFiler> block) but they may be
3036 overwritten inside the B<VFiler> block.
3038 This feature is useful, for example, when using a VFiler as SnapVault target
3039 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3040 available in the host filer (vfiler0) but only in the respective VFiler
3041 context.
3043 =item B<Protocol> B<httpd>|B<http>
3045 The protocol collectd will use to query this host.
3047 Optional
3049 Type: string
3051 Default: https
3053 Valid options: http, https
3055 =item B<Address> I<Address>
3057 The hostname or IP address of the host.
3059 Optional
3061 Type: string
3063 Default: The "host" block's name.
3065 =item B<Port> I<Port>
3067 The TCP port to connect to on the host.
3069 Optional
3071 Type: integer
3073 Default: 80 for protocol "http", 443 for protocol "https"
3075 =item B<User> I<User>
3077 =item B<Password> I<Password>
3079 The username and password to use to login to the NetApp.
3081 Mandatory
3083 Type: string
3085 =item B<VFilerName> I<Name>
3087 The name of the VFiler in which context to execute API commands. If not
3088 specified, the name provided to the B<VFiler> block will be used instead.
3090 Optional
3092 Type: string
3094 Default: name of the B<VFiler> block
3096 B<Note:> This option may only be used inside B<VFiler> blocks.
3098 =item B<Interval> I<Interval>
3100 B<TODO>
3102 =back
3104 The following options decide what kind of data will be collected. You can
3105 either use them as a block and fine tune various parameters inside this block,
3106 use them as a single statement to just accept all default values, or omit it to
3107 not collect any data.
3109 The following options are valid inside all blocks:
3111 =over 4
3113 =item B<Interval> I<Seconds>
3115 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3116 host specific setting.
3118 =back
3120 =head3 The System block
3122 This will collect various performance data about the whole system.
3124 B<Note:> To get this data the collectd user needs the
3125 "api-perf-object-get-instances" capability.
3127 =over 4
3129 =item B<Interval> I<Seconds>
3131 Collect disk statistics every I<Seconds> seconds.
3133 =item B<GetCPULoad> B<true>|B<false>
3135 If you set this option to true the current CPU usage will be read. This will be
3136 the average usage between all CPUs in your NetApp without any information about
3137 individual CPUs.
3139 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3140 returns in the "CPU" field.
3142 Optional
3144 Type: boolean
3146 Default: true
3148 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3150 =item B<GetInterfaces> B<true>|B<false>
3152 If you set this option to true the current traffic of the network interfaces
3153 will be read. This will be the total traffic over all interfaces of your NetApp
3154 without any information about individual interfaces.
3156 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3157 in the "Net kB/s" field.
3159 B<Or is it?>
3161 Optional
3163 Type: boolean
3165 Default: true
3167 Result: One value list of type "if_octects".
3169 =item B<GetDiskIO> B<true>|B<false>
3171 If you set this option to true the current IO throughput will be read. This
3172 will be the total IO of your NetApp without any information about individual
3173 disks, volumes or aggregates.
3175 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3176 in the "DiskE<nbsp>kB/s" field.
3178 Optional
3180 Type: boolean
3182 Default: true
3184 Result: One value list of type "disk_octets".
3186 =item B<GetDiskOps> B<true>|B<false>
3188 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3189 iSCSI, etc. operations will be read. This will be the total number of
3190 operations on your NetApp without any information about individual volumes or
3191 aggregates.
3193 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3194 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3196 Optional
3198 Type: boolean
3200 Default: true
3202 Result: A variable number of value lists of type "disk_ops_complex". Each type
3203 of operation will result in one value list with the name of the operation as
3204 type instance.
3206 =back
3208 =head3 The WAFL block
3210 This will collect various performance data about the WAFL file system. At the
3211 moment this just means cache performance.
3213 B<Note:> To get this data the collectd user needs the
3214 "api-perf-object-get-instances" capability.
3216 B<Note:> The interface to get these values is classified as "Diagnostics" by
3217 NetApp. This means that it is not guaranteed to be stable even between minor
3218 releases.
3220 =over 4
3222 =item B<Interval> I<Seconds>
3224 Collect disk statistics every I<Seconds> seconds.
3226 =item B<GetNameCache> B<true>|B<false>
3228 Optional
3230 Type: boolean
3232 Default: true
3234 Result: One value list of type "cache_ratio" and type instance
3235 "name_cache_hit".
3237 =item B<GetDirCache> B<true>|B<false>
3239 Optional
3241 Type: boolean
3243 Default: true
3245 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3247 =item B<GetInodeCache> B<true>|B<false>
3249 Optional
3251 Type: boolean
3253 Default: true
3255 Result: One value list of type "cache_ratio" and type instance
3256 "inode_cache_hit".
3258 =item B<GetBufferCache> B<true>|B<false>
3260 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3261 in the "Cache hit" field.
3263 Optional
3265 Type: boolean
3267 Default: true
3269 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3271 =back
3273 =head3 The Disks block
3275 This will collect performance data about the individual disks in the NetApp.
3277 B<Note:> To get this data the collectd user needs the
3278 "api-perf-object-get-instances" capability.
3280 =over 4
3282 =item B<Interval> I<Seconds>
3284 Collect disk statistics every I<Seconds> seconds.
3286 =item B<GetBusy> B<true>|B<false>
3288 If you set this option to true the busy time of all disks will be calculated
3289 and the value of the busiest disk in the system will be written.
3291 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3292 in the "Disk util" field. Probably.
3294 Optional
3296 Type: boolean
3298 Default: true
3300 Result: One value list of type "percent" and type instance "disk_busy".
3302 =back
3304 =head3 The VolumePerf block
3306 This will collect various performance data about the individual volumes.
3308 You can select which data to collect about which volume using the following
3309 options. They follow the standard ignorelist semantic.
3311 B<Note:> To get this data the collectd user needs the
3312 I<api-perf-object-get-instances> capability.
3314 =over 4
3316 =item B<Interval> I<Seconds>
3318 Collect volume performance data every I<Seconds> seconds.
3320 =item B<GetIO> I<Volume>
3322 =item B<GetOps> I<Volume>
3324 =item B<GetLatency> I<Volume>
3326 Select the given volume for IO, operations or latency statistics collection.
3327 The argument is the name of the volume without the C</vol/> prefix.
3329 Since the standard ignorelist functionality is used here, you can use a string
3330 starting and ending with a slash to specify regular expression matching: To
3331 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3332 expression:
3334   GetIO "/^vol[027]$/"
3336 If no regular expression is specified, an exact match is required. Both,
3337 regular and exact matching are case sensitive.
3339 If no volume was specified at all for either of the three options, that data
3340 will be collected for all available volumes.
3342 =item B<IgnoreSelectedIO> B<true>|B<false>
3344 =item B<IgnoreSelectedOps> B<true>|B<false>
3346 =item B<IgnoreSelectedLatency> B<true>|B<false>
3348 When set to B<true>, the volumes selected for IO, operations or latency
3349 statistics collection will be ignored and the data will be collected for all
3350 other volumes.
3352 When set to B<false>, data will only be collected for the specified volumes and
3353 all other volumes will be ignored.
3355 If no volumes have been specified with the above B<Get*> options, all volumes
3356 will be collected regardless of the B<IgnoreSelected*> option.
3358 Defaults to B<false>
3360 =back
3362 =head3 The VolumeUsage block
3364 This will collect capacity data about the individual volumes.
3366 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3367 capability.
3369 =over 4
3371 =item B<Interval> I<Seconds>
3373 Collect volume usage statistics every I<Seconds> seconds.
3375 =item B<GetCapacity> I<VolumeName>
3377 The current capacity of the volume will be collected. This will result in two
3378 to four value lists, depending on the configuration of the volume. All data
3379 sources are of type "df_complex" with the name of the volume as
3380 plugin_instance.
3382 There will be type_instances "used" and "free" for the number of used and
3383 available bytes on the volume.  If the volume has some space reserved for
3384 snapshots, a type_instance "snap_reserved" will be available.  If the volume
3385 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3386 number of bytes saved by the SIS feature.
3388 B<Note:> The current NetApp API has a bug that results in this value being
3389 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3390 number which works most of the time.  If you see strange values here, bug
3391 NetApp support to fix this.
3393 Repeat this option to specify multiple volumes.
3395 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3397 Specify whether to collect only the volumes selected by the B<GetCapacity>
3398 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3399 B<false>. However, if no B<GetCapacity> option is specified at all, all
3400 capacities will be selected anyway.
3402 =item B<GetSnapshot> I<VolumeName>
3404 Select volumes from which to collect snapshot information.
3406 Usually, the space used for snapshots is included in the space reported as
3407 "used". If snapshot information is collected as well, the space used for
3408 snapshots is subtracted from the used space.
3410 To make things even more interesting, it is possible to reserve space to be
3411 used for snapshots. If the space required for snapshots is less than that
3412 reserved space, there is "reserved free" and "reserved used" space in addition
3413 to "free" and "used". If the space required for snapshots exceeds the reserved
3414 space, that part allocated in the normal space is subtracted from the "used"
3415 space again.
3417 Repeat this option to specify multiple volumes.
3419 =item B<IgnoreSelectedSnapshot>
3421 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3422 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3423 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3424 capacities will be selected anyway.
3426 =back
3428 =head3 The Quota block
3430 This will collect (tree) quota statistics (used disk space and number of used
3431 files). This mechanism is useful to get usage information for single qtrees.
3432 In case the quotas are not used for any other purpose, an entry similar to the
3433 following in C</etc/quotas> would be sufficient:
3435   /vol/volA/some_qtree tree - - - - -
3437 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3439 =over 4
3441 =item B<Interval> I<Seconds>
3443 Collect SnapVault(R) statistics every I<Seconds> seconds.
3445 =back
3447 =head3 The SnapVault block
3449 This will collect statistics about the time and traffic of SnapVault(R)
3450 transfers.
3452 =over 4
3454 =item B<Interval> I<Seconds>
3456 Collect SnapVault(R) statistics every I<Seconds> seconds.
3458 =back
3460 =head2 Plugin C<netlink>
3462 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3463 statistics of various interface and routing aspects.
3465 =over 4
3467 =item B<Interface> I<Interface>
3469 =item B<VerboseInterface> I<Interface>
3471 Instruct the plugin to collect interface statistics. This is basically the same
3472 as the statistics provided by the C<interface> plugin (see above) but
3473 potentially much more detailed.
3475 When configuring with B<Interface> only the basic statistics will be collected,
3476 namely octets, packets, and errors. These statistics are collected by
3477 the C<interface> plugin, too, so using both at the same time is no benefit.
3479 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3480 so that no data needs to be collected twice if you use the C<interface> plugin.
3481 This includes dropped packets, received multicast packets, collisions and a
3482 whole zoo of differentiated RX and TX errors. You can try the following command
3483 to get an idea of what awaits you:
3485   ip -s -s link list
3487 If I<Interface> is B<All>, all interfaces will be selected.
3489 =item B<QDisc> I<Interface> [I<QDisc>]
3491 =item B<Class> I<Interface> [I<Class>]
3493 =item B<Filter> I<Interface> [I<Filter>]
3495 Collect the octets and packets that pass a certain qdisc, class or filter.
3497 QDiscs and classes are identified by their type and handle (or classid).
3498 Filters don't necessarily have a handle, therefore the parent's handle is used.
3499 The notation used in collectd differs from that used in tc(1) in that it
3500 doesn't skip the major or minor number if it's zero and doesn't print special
3501 ids by their name. So, for example, a qdisc may be identified by
3502 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3503 thus not displayed by tc(1).
3505 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3506 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3507 associated with that interface will be collected.
3509 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3510 used. This may lead to problems when more than one filter is attached to a
3511 qdisc or class. This isn't nice, but we don't know how this could be done any
3512 better. If you have a idea, please don't hesitate to tell us.
3514 As with the B<Interface> option you can specify B<All> as the interface,
3515 meaning all interfaces.
3517 Here are some examples to help you understand the above text more easily:
3519   <Plugin netlink>
3520     VerboseInterface "All"
3521     QDisc "eth0" "pfifo_fast-1:0"
3522     QDisc "ppp0"
3523     Class "ppp0" "htb-1:10"
3524     Filter "ppp0" "u32-1:0"
3525   </Plugin>
3527 =item B<IgnoreSelected>
3529 The behavior is the same as with all other similar plugins: If nothing is
3530 selected at all, everything is collected. If some things are selected using the
3531 options described above, only these statistics are collected. If you set
3532 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3533 specified statistics will not be collected.
3535 =back
3537 =head2 Plugin C<network>
3539 The Network plugin sends data to a remote instance of collectd, receives data
3540 from a remote instance, or both at the same time. Data which has been received
3541 from the network is usually not transmitted again, but this can be activated, see
3542 the B<Forward> option below.
3544 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3545 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3547 Both, B<Server> and B<Listen> can be used as single option or as block. When
3548 used as block, given options are valid for this socket only. The following
3549 example will export the metrics twice: Once to an "internal" server (without
3550 encryption and signing) and one to an external server (with cryptographic
3551 signature):
3553  <Plugin "network">
3554    # Export to an internal server
3555    # (demonstrates usage without additional options)
3556    Server "collectd.internal.tld"
3558    # Export to an external server
3559    # (demonstrates usage with signature options)
3560    <Server "collectd.external.tld">
3561      SecurityLevel "sign"
3562      Username "myhostname"
3563      Password "ohl0eQue"
3564    </Server>
3565  </Plugin>
3567 =over 4
3569 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3571 The B<Server> statement/block sets the server to send datagrams to. The
3572 statement may occur multiple times to send each datagram to multiple
3573 destinations.
3575 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3576 optional second argument specifies a port number or a service name. If not
3577 given, the default, B<25826>, is used.
3579 The following options are recognized within B<Server> blocks:
3581 =over 4
3583 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3585 Set the security you require for network communication. When the security level
3586 has been set to B<Encrypt>, data sent over the network will be encrypted using
3587 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3588 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3589 authentication code. When set to B<None>, data is sent without any security.
3591 This feature is only available if the I<network> plugin was linked with
3592 I<libgcrypt>.
3594 =item B<Username> I<Username>
3596 Sets the username to transmit. This is used by the server to lookup the
3597 password. See B<AuthFile> below. All security levels except B<None> require
3598 this setting.
3600 This feature is only available if the I<network> plugin was linked with
3601 I<libgcrypt>.
3603 =item B<Password> I<Password>
3605 Sets a password (shared secret) for this socket. All security levels except
3606 B<None> require this setting.
3608 This feature is only available if the I<network> plugin was linked with
3609 I<libgcrypt>.
3611 =item B<Interface> I<Interface name>
3613 Set the outgoing interface for IP packets. This applies at least
3614 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3615 undefined or a non-existent interface name is specified, the default
3616 behavior is to let the kernel choose the appropriate interface. Be warned
3617 that the manual selection of an interface for unicast traffic is only
3618 necessary in rare cases.
3620 =back
3622 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3624 The B<Listen> statement sets the interfaces to bind to. When multiple
3625 statements are found the daemon will bind to multiple interfaces.
3627 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3628 the argument is a multicast address the daemon will join that multicast group.
3629 The optional second argument specifies a port number or a service name. If not
3630 given, the default, B<25826>, is used.
3632 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3634 =over 4
3636 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3638 Set the security you require for network communication. When the security level
3639 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3640 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3641 signed and encrypted data is accepted. When set to B<None>, all data will be
3642 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3643 decrypted if possible.
3645 This feature is only available if the I<network> plugin was linked with
3646 I<libgcrypt>.
3648 =item B<AuthFile> I<Filename>
3650 Sets a file in which usernames are mapped to passwords. These passwords are
3651 used to verify signatures and to decrypt encrypted network packets. If
3652 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3653 verified and encrypted packets are decrypted. Otherwise, signed data is
3654 accepted without checking the signature and encrypted data cannot be decrypted.
3655 For the other security levels this option is mandatory.
3657 The file format is very simple: Each line consists of a username followed by a
3658 colon and any number of spaces followed by the password. To demonstrate, an
3659 example file could look like this:
3661   user0: foo
3662   user1: bar
3664 Each time a packet is received, the modification time of the file is checked
3665 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3666 the file is being read, it is locked using L<fcntl(2)>.
3668 =item B<Interface> I<Interface name>
3670 Set the incoming interface for IP packets explicitly. This applies at least
3671 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3672 undefined or a non-existent interface name is specified, the default
3673 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3674 traffic gets only accepted, if it arrives on the given interface.
3676 =back
3678 =item B<TimeToLive> I<1-255>
3680 Set the time-to-live of sent packets. This applies to all, unicast and
3681 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3682 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3683 operating systems.
3685 =item B<MaxPacketSize> I<1024-65535>
3687 Set the maximum size for datagrams received over the network. Packets larger
3688 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3689 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3690 UDP.
3692 On the server side, this limit should be set to the largest value used on
3693 I<any> client. Likewise, the value on the client must not be larger than the
3694 value on the server, or data will be lost.
3696 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3697 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3698 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3699 server.
3701 =item B<Forward> I<true|false>
3703 If set to I<true>, write packets that were received via the network plugin to
3704 the sending sockets. This should only be activated when the B<Listen>- and
3705 B<Server>-statements differ. Otherwise packets may be send multiple times to
3706 the same multicast group. While this results in more network traffic than
3707 necessary it's not a huge problem since the plugin has a duplicate detection,
3708 so the values will not loop.
3710 =item B<ReportStats> B<true>|B<false>
3712 The network plugin cannot only receive and send statistics, it can also create
3713 statistics about itself. Collected data included the number of received and
3714 sent octets and packets, the length of the receive queue and the number of
3715 values handled. When set to B<true>, the I<Network plugin> will make these
3716 statistics available. Defaults to B<false>.
3718 =back
3720 =head2 Plugin C<nginx>
3722 This plugin collects the number of connections and requests handled by the
3723 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3724 queries the page provided by the C<ngx_http_stub_status_module> module, which
3725 isn't compiled by default. Please refer to
3726 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3727 how to compile and configure nginx and this module.
3729 The following options are accepted by the C<nginx plugin>:
3731 =over 4
3733 =item B<URL> I<http://host/nginx_status>
3735 Sets the URL of the C<ngx_http_stub_status_module> output.
3737 =item B<User> I<Username>
3739 Optional user name needed for authentication.
3741 =item B<Password> I<Password>
3743 Optional password needed for authentication.
3745 =item B<VerifyPeer> B<true|false>
3747 Enable or disable peer SSL certificate verification. See
3748 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3750 =item B<VerifyHost> B<true|false>
3752 Enable or disable peer host name verification. If enabled, the plugin checks
3753 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3754 certificate matches the host name provided by the B<URL> option. If this
3755 identity check fails, the connection is aborted. Obviously, only works when
3756 connecting to a SSL enabled server. Enabled by default.
3758 =item B<CACert> I<File>
3760 File that holds one or more SSL certificates. If you want to use HTTPS you will
3761 possibly need this option. What CA certificates come bundled with C<libcurl>
3762 and are checked by default depends on the distribution you use.
3764 =back
3766 =head2 Plugin C<notify_desktop>
3768 This plugin sends a desktop notification to a notification daemon, as defined
3769 in the Desktop Notification Specification. To actually display the
3770 notifications, B<notification-daemon> is required and B<collectd> has to be
3771 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3772 environment variables have to be set correctly) and the D-Bus message bus.
3774 The Desktop Notification Specification can be found at
3775 L<http://www.galago-project.org/specs/notification/>.
3777 =over 4
3779 =item B<OkayTimeout> I<timeout>
3781 =item B<WarningTimeout> I<timeout>
3783 =item B<FailureTimeout> I<timeout>
3785 Set the I<timeout>, in milliseconds, after which to expire the notification
3786 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3787 been specified, the displayed notification will not be closed at all - the
3788 user has to do so herself. These options default to 5000. If a negative number
3789 has been specified, the default is used as well.
3791 =back
3793 =head2 Plugin C<notify_email>
3795 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3796 configured email address.
3798 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3800 Available configuration options:
3802 =over 4
3804 =item B<From> I<Address>
3806 Email address from which the emails should appear to come from.
3808 Default: C<root@localhost>
3810 =item B<Recipient> I<Address>
3812 Configures the email address(es) to which the notifications should be mailed.
3813 May be repeated to send notifications to multiple addresses.
3815 At least one B<Recipient> must be present for the plugin to work correctly.
3817 =item B<SMTPServer> I<Hostname>
3819 Hostname of the SMTP server to connect to.
3821 Default: C<localhost>
3823 =item B<SMTPPort> I<Port>
3825 TCP port to connect to.
3827 Default: C<25>
3829 =item B<SMTPUser> I<Username>
3831 Username for ASMTP authentication. Optional.
3833 =item B<SMTPPassword> I<Password>
3835 Password for ASMTP authentication. Optional.
3837 =item B<Subject> I<Subject>
3839 Subject-template to use when sending emails. There must be exactly two
3840 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
3841 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
3842 with the hostname.
3844 Default: C<Collectd notify: %s@%s>
3846 =back
3848 =head2 Plugin C<ntpd>
3850 =over 4
3852 =item B<Host> I<Hostname>
3854 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
3856 =item B<Port> I<Port>
3858 UDP-Port to connect to. Defaults to B<123>.
3860 =item B<ReverseLookups> B<true>|B<false>
3862 Sets whether or not to perform reverse lookups on peers. Since the name or
3863 IP-address may be used in a filename it is recommended to disable reverse
3864 lookups. The default is to do reverse lookups to preserve backwards
3865 compatibility, though.
3867 =item B<IncludeUnitID> B<true>|B<false>
3869 When a peer is a refclock, include the unit ID in the I<type instance>.
3870 Defaults to B<false> for backward compatibility.
3872 If two refclock peers use the same driver and this is B<false>, the plugin will
3873 try to write simultaneous measurements from both to the same type instance.
3874 This will result in error messages in the log and only one set of measurements
3875 making it through.
3877 =back
3879 =head2 Plugin C<nut>
3881 =over 4
3883 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
3885 Add a UPS to collect data from. The format is identical to the one accepted by
3886 L<upsc(8)>.
3888 =back
3890 =head2 Plugin C<olsrd>
3892 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
3893 the Optimized Link State Routing daemon and reads information about the current
3894 state of the meshed network.
3896 The following configuration options are understood:
3898 =over 4
3900 =item B<Host> I<Host>
3902 Connect to I<Host>. Defaults to B<"localhost">.
3904 =item B<Port> I<Port>
3906 Specifies the port to connect to. This must be a string, even if you give the
3907 port as a number rather than a service name. Defaults to B<"2006">.
3909 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
3911 Specifies what information to collect about links, i.E<nbsp>e. direct
3912 connections of the daemon queried. If set to B<No>, no information is
3913 collected. If set to B<Summary>, the number of links and the average of all
3914 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
3915 If set to B<Detail> LQ and NLQ are collected per link.
3917 Defaults to B<Detail>.
3919 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
3921 Specifies what information to collect about routes of the daemon queried. If
3922 set to B<No>, no information is collected. If set to B<Summary>, the number of
3923 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
3924 metric and ETX are collected per route.
3926 Defaults to B<Summary>.
3928 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
3930 Specifies what information to collect about the global topology. If set to
3931 B<No>, no information is collected. If set to B<Summary>, the number of links
3932 in the entire topology and the average I<link quality> (LQ) is calculated.
3933 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
3935 Defaults to B<Summary>.
3937 =back
3939 =head2 Plugin C<onewire>
3941 B<EXPERIMENTAL!> See notes below.
3943 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
3944 L<http://owfs.org/> to read sensors connected via the onewire bus.
3946 Currently only temperature sensors (sensors with the family code C<10>,
3947 e.E<nbsp>g. DS1820, DS18S20, DS1920) can be read. If you have other sensors you
3948 would like to have included, please send a sort request to the mailing list.
3950 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
3951 experimental, below.
3953 =over 4
3955 =item B<Device> I<Device>
3957 Sets the device to read the values from. This can either be a "real" hardware
3958 device, such as a serial port or an USB port, or the address of the
3959 L<owserver(1)> socket, usually B<localhost:4304>.
3961 Though the documentation claims to automatically recognize the given address
3962 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
3963 with that version, the following configuration worked for us:
3965   <Plugin onewire>
3966     Device "-s localhost:4304"
3967   </Plugin>
3969 This directive is B<required> and does not have a default value.
3971 =item B<Sensor> I<Sensor>
3973 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>, see
3974 below. Sensors are specified without the family byte at the beginning, to you'd
3975 use C<F10FCA000800>, and B<not> include the leading C<10.> family byte and
3976 point.
3978 =item B<IgnoreSelected> I<true>|I<false>
3980 If no configuration if given, the B<onewire> plugin will collect data from all
3981 sensors found. This may not be practical, especially if sensors are added and
3982 removed regularly. Sometimes, however, it's easier/preferred to collect only
3983 specific sensors or all sensors I<except> a few specified ones. This option
3984 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
3985 B<Sensor> is inverted: All selected interfaces are ignored and all other
3986 interfaces are collected.
3988 =item B<Interval> I<Seconds>
3990 Sets the interval in which all sensors should be read. If not specified, the
3991 global B<Interval> setting is used.
3993 =back
3995 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
3996 work with big setups. It works with one sensor being attached to one
3997 controller, but as soon as you throw in a couple more senors and maybe a hub
3998 or two, reading all values will take more than ten seconds (the default
3999 interval). We will probably add some separate thread for reading the sensors
4000 and some cache or something like that, but it's not done yet. We will try to
4001 maintain backwards compatibility in the future, but we can't promise. So in
4002 short: If it works for you: Great! But keep in mind that the config I<might>
4003 change, though this is unlikely. Oh, and if you want to help improving this
4004 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4006 =head2 Plugin C<openvpn>
4008 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4009 traffic statistics about connected clients.
4011 To set up OpenVPN to write to the status file periodically, use the
4012 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4013 you need to set the required format, too. This is done by setting
4014 B<--status-version> to B<2>.
4016 So, in a nutshell you need:
4018   openvpn $OTHER_OPTIONS \
4019     --status "/var/run/openvpn-status" 10 \
4020     --status-version 2
4022 Available options:
4024 =over 4
4026 =item B<StatusFile> I<File>
4028 Specifies the location of the status file.
4030 =item B<ImprovedNamingSchema> B<true>|B<false>
4032 When enabled, the filename of the status file will be used as plugin instance
4033 and the client's "common name" will be used as type instance. This is required
4034 when reading multiple status files. Enabling this option is recommended, but to
4035 maintain backwards compatibility this option is disabled by default.
4037 =item B<CollectCompression> B<true>|B<false>
4039 Sets whether or not statistics about the compression used by OpenVPN should be
4040 collected. This information is only available in I<single> mode. Enabled by
4041 default.
4043 =item B<CollectIndividualUsers> B<true>|B<false>
4045 Sets whether or not traffic information is collected for each connected client
4046 individually. If set to false, currently no traffic data is collected at all
4047 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4049 =item B<CollectUserCount> B<true>|B<false>
4051 When enabled, the number of currently connected clients or users is collected.
4052 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4053 can be configured independently from that option. Defaults to B<false>.
4055 =back
4057 =head2 Plugin C<oracle>
4059 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4060 Oracle® Database and lets you execute SQL statements there. It is very similar
4061 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4062 plugin's documentation above for details.
4064   <Plugin oracle>
4065     <Query "out_of_stock">
4066       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4067       <Result>
4068         Type "gauge"
4069         # InstancePrefix "foo"
4070         InstancesFrom "category"
4071         ValuesFrom "value"
4072       </Result>
4073     </Query>
4074     <Database "product_information">
4075       ConnectID "db01"
4076       Username "oracle"
4077       Password "secret"
4078       Query "out_of_stock"
4079     </Database>
4080   </Plugin>
4082 =head3 B<Query> blocks
4084 The Query blocks are handled identically to the Query blocks of the "dbi"
4085 plugin. Please see its documentation above for details on how to specify
4086 queries.
4088 =head3 B<Database> blocks
4090 Database blocks define a connection to a database and which queries should be
4091 sent to that database. Each database needs a "name" as string argument in the
4092 starting tag of the block. This name will be used as "PluginInstance" in the
4093 values submitted to the daemon. Other than that, that name is not used.
4095 =over 4
4097 =item B<ConnectID> I<ID>
4099 Defines the "database alias" or "service name" to connect to. Usually, these
4100 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4102 =item B<Host> I<Host>
4104 Hostname to use when dispatching values for this database. Defaults to using
4105 the global hostname of the I<collectd> instance.
4107 =item B<Username> I<Username>
4109 Username used for authentication.
4111 =item B<Password> I<Password>
4113 Password used for authentication.
4115 =item B<Query> I<QueryName>
4117 Associates the query named I<QueryName> with this database connection. The
4118 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4119 blocks you want to refer to must be placed above the database block you want to
4120 refer to them from.
4122 =back
4124 =head2 Plugin C<perl>
4126 This plugin embeds a Perl-interpreter into collectd and provides an interface
4127 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4129 =head2 Plugin C<pinba>
4131 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4132 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4133 PHP-based webpage has been delivered, the extension will send a UDP packet
4134 containing timing information, peak memory usage and so on. The plugin will
4135 wait for such packets, parse them and account the provided information, which
4136 is then dispatched to the daemon once per interval.
4138 Synopsis:
4140  <Plugin pinba>
4141    Address "::0"
4142    Port "30002"
4143    # Overall statistics for the website.
4144    <View "www-total">
4145      Server "www.example.com"
4146    </View>
4147    # Statistics for www-a only
4148    <View "www-a">
4149      Host "www-a.example.com"
4150      Server "www.example.com"
4151    </View>
4152    # Statistics for www-b only
4153    <View "www-b">
4154      Host "www-b.example.com"
4155      Server "www.example.com"
4156    </View>
4157  </Plugin>
4159 The plugin provides the following configuration options:
4161 =over 4
4163 =item B<Address> I<Node>
4165 Configures the address used to open a listening socket. By default, plugin will
4166 bind to the I<any> address C<::0>.
4168 =item B<Port> I<Service>
4170 Configures the port (service) to bind to. By default the default Pinba port
4171 "30002" will be used. The option accepts service names in addition to port
4172 numbers and thus requires a I<string> argument.
4174 =item E<lt>B<View> I<Name>E<gt> block
4176 The packets sent by the Pinba extension include the hostname of the server, the
4177 server name (the name of the virtual host) and the script that was executed.
4178 Using B<View> blocks it is possible to separate the data into multiple groups
4179 to get more meaningful statistics. Each packet is added to all matching groups,
4180 so that a packet may be accounted for more than once.
4182 =over 4
4184 =item B<Host> I<Host>
4186 Matches the hostname of the system the webserver / script is running on. This
4187 will contain the result of the L<gethostname(2)> system call. If not
4188 configured, all hostnames will be accepted.
4190 =item B<Server> I<Server>
4192 Matches the name of the I<virtual host>, i.e. the contents of the
4193 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4194 server names will be accepted.
4196 =item B<Script> I<Script>
4198 Matches the name of the I<script name>, i.e. the contents of the
4199 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4200 script names will be accepted.
4202 =back
4204 =back
4206 =head2 Plugin C<ping>
4208 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4209 configured hosts periodically and measures the network latency. Whenever the
4210 C<read> function of the plugin is called, it submits the average latency, the
4211 standard deviation and the drop rate for each host.
4213 Available configuration options:
4215 =over 4
4217 =item B<Host> I<IP-address>
4219 Host to ping periodically. This option may be repeated several times to ping
4220 multiple hosts.
4222 =item B<Interval> I<Seconds>
4224 Sets the interval in which to send ICMP echo packets to the configured hosts.
4225 This is B<not> the interval in which statistics are queries from the plugin but
4226 the interval in which the hosts are "pinged". Therefore, the setting here
4227 should be smaller than or equal to the global B<Interval> setting. Fractional
4228 times, such as "1.24" are allowed.
4230 Default: B<1.0>
4232 =item B<Timeout> I<Seconds>
4234 Time to wait for a response from the host to which an ICMP packet had been
4235 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4236 to be down or the packet to be dropped. This setting must be smaller than the
4237 B<Interval> setting above for the plugin to work correctly. Fractional
4238 arguments are accepted.
4240 Default: B<0.9>
4242 =item B<TTL> I<0-255>
4244 Sets the Time-To-Live of generated ICMP packets.
4246 =item B<SourceAddress> I<host>
4248 Sets the source address to use. I<host> may either be a numerical network
4249 address or a network hostname.
4251 =item B<Device> I<name>
4253 Sets the outgoing network device to be used. I<name> has to specify an
4254 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4255 operating systems.
4257 =item B<MaxMissed> I<Packets>
4259 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4260 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4262 Default: B<-1> (disabled)
4264 =back
4266 =head2 Plugin C<postgresql>
4268 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4269 keeps a persistent connection to all configured databases and tries to
4270 reconnect if the connection has been interrupted. A database is configured by
4271 specifying a B<Database> block as described below. The default statistics are
4272 collected from PostgreSQL's B<statistics collector> which thus has to be
4273 enabled for this plugin to work correctly. This should usually be the case by
4274 default. See the section "The Statistics Collector" of the B<PostgreSQL
4275 Documentation> for details.
4277 By specifying custom database queries using a B<Query> block as described
4278 below, you may collect any data that is available from some PostgreSQL
4279 database. This way, you are able to access statistics of external daemons
4280 which are available in a PostgreSQL database or use future or special
4281 statistics provided by PostgreSQL without the need to upgrade your collectd
4282 installation.
4284 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4285 PostgreSQL databases as well. This has been implemented in a generic way. You
4286 need to specify an SQL statement which will then be executed by collectd in
4287 order to write the data (see below for details). The benefit of that approach
4288 is that there is no fixed database layout. Rather, the layout may be optimized
4289 for the current setup.
4291 The B<PostgreSQL Documentation> manual can be found at
4292 L<http://www.postgresql.org/docs/manuals/>.
4294   <Plugin postgresql>
4295     <Query magic>
4296       Statement "SELECT magic FROM wizard WHERE host = $1;"
4297       Param hostname
4298       <Result>
4299         Type gauge
4300         InstancePrefix "magic"
4301         ValuesFrom magic
4302       </Result>
4303     </Query>
4305     <Query rt36_tickets>
4306       Statement "SELECT COUNT(type) AS count, type \
4307                         FROM (SELECT CASE \
4308                                      WHEN resolved = 'epoch' THEN 'open' \
4309                                      ELSE 'resolved' END AS type \
4310                                      FROM tickets) type \
4311                         GROUP BY type;"
4312       <Result>
4313         Type counter
4314         InstancePrefix "rt36_tickets"
4315         InstancesFrom "type"
4316         ValuesFrom "count"
4317       </Result>
4318     </Query>
4320     <Writer sqlstore>
4321       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4322       StoreRates true
4323     </Writer>
4325     <Database foo>
4326       Host "hostname"
4327       Port "5432"
4328       User "username"
4329       Password "secret"
4330       SSLMode "prefer"
4331       KRBSrvName "kerberos_service_name"
4332       Query magic
4333     </Database>
4335     <Database bar>
4336       Interval 300
4337       Service "service_name"
4338       Query backend # predefined
4339       Query rt36_tickets
4340     </Database>
4342     <Database qux>
4343       # ...
4344       Writer sqlstore
4345       CommitInterval 10
4346     </Database>
4347   </Plugin>
4349 The B<Query> block defines one database query which may later be used by a
4350 database definition. It accepts a single mandatory argument which specifies
4351 the name of the query. The names of all queries have to be unique (see the
4352 B<MinVersion> and B<MaxVersion> options below for an exception to this
4353 rule). The following configuration options are available to define the query:
4355 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4356 blocks define how to handle the values returned from the query. They define
4357 which column holds which value and how to dispatch that value to the daemon.
4358 Multiple B<Result> blocks may be used to extract multiple values from a single
4359 query.
4361 =over 4
4363 =item B<Statement> I<sql query statement>
4365 Specify the I<sql query statement> which the plugin should execute. The string
4366 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4367 first, second, etc. parameter. The value of the parameters is specified by the
4368 B<Param> configuration option - see below for details. To include a literal
4369 B<$> character followed by a number, surround it with single quotes (B<'>).
4371 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4372 allowed. Note, however, that only a single command may be used. Semicolons are
4373 allowed as long as a single non-empty command has been specified only.
4375 The returned lines will be handled separately one after another.
4377 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4379 Specify the parameters which should be passed to the SQL query. The parameters
4380 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4381 they appear in the configuration file. The value of the parameter is
4382 determined depending on the value of the B<Param> option as follows:
4384 =over 4
4386 =item I<hostname>
4388 The configured hostname of the database connection. If a UNIX domain socket is
4389 used, the parameter expands to "localhost".
4391 =item I<database>
4393 The name of the database of the current connection.
4395 =item I<instance>
4397 The name of the database plugin instance. See the B<Instance> option of the
4398 database specification below for details.
4400 =item I<username>
4402 The username used to connect to the database.
4404 =item I<interval>
4406 The interval with which this database is queried (as specified by the database
4407 specific or global B<Interval> options).
4409 =back
4411 Please note that parameters are only supported by PostgreSQL's protocol
4412 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4414 =item B<Type> I<type>
4416 The I<type> name to be used when dispatching the values. The type describes
4417 how to handle the data and where to store it. See L<types.db(5)> for more
4418 details on types and their configuration. The number and type of values (as
4419 selected by the B<ValuesFrom> option) has to match the type of the given name.
4421 This option is required inside a B<Result> block.
4423 =item B<InstancePrefix> I<prefix>
4425 =item B<InstancesFrom> I<column0> [I<column1> ...]
4427 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4428 B<InstancePrefix> defines a static prefix that will be prepended to all type
4429 instances. B<InstancesFrom> defines the column names whose values will be used
4430 to create the type instance. Multiple values will be joined together using the
4431 hyphen (C<->) as separation character.
4433 The plugin itself does not check whether or not all built instances are
4434 different. It is your responsibility to assure that each is unique.
4436 Both options are optional. If none is specified, the type instance will be
4437 empty.
4439 =item B<ValuesFrom> I<column0> [I<column1> ...]
4441 Names the columns whose content is used as the actual data for the data sets
4442 that are dispatched to the daemon. How many such columns you need is
4443 determined by the B<Type> setting as explained above. If you specify too many
4444 or not enough columns, the plugin will complain about that and no data will be
4445 submitted to the daemon.
4447 The actual data type, as seen by PostgreSQL, is not that important as long as
4448 it represents numbers. The plugin will automatically cast the values to the
4449 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4450 L<strtod(3)> functions, so anything supported by those functions is supported
4451 by the plugin as well.
4453 This option is required inside a B<Result> block and may be specified multiple
4454 times. If multiple B<ValuesFrom> options are specified, the columns are read
4455 in the given order.
4457 =item B<MinVersion> I<version>
4459 =item B<MaxVersion> I<version>
4461 Specify the minimum or maximum version of PostgreSQL that this query should be
4462 used with. Some statistics might only be available with certain versions of
4463 PostgreSQL. This allows you to specify multiple queries with the same name but
4464 which apply to different versions, thus allowing you to use the same
4465 configuration in a heterogeneous environment.
4467 The I<version> has to be specified as the concatenation of the major, minor
4468 and patch-level versions, each represented as two-decimal-digit numbers. For
4469 example, version 8.2.3 will become 80203.
4471 =back
4473 The following predefined queries are available (the definitions can be found
4474 in the F<postgresql_default.conf> file which, by default, is available at
4475 C<I<prefix>/share/collectd/>):
4477 =over 4
4479 =item B<backends>
4481 This query collects the number of backends, i.E<nbsp>e. the number of
4482 connected clients.
4484 =item B<transactions>
4486 This query collects the numbers of committed and rolled-back transactions of
4487 the user tables.
4489 =item B<queries>
4491 This query collects the numbers of various table modifications (i.E<nbsp>e.
4492 insertions, updates, deletions) of the user tables.
4494 =item B<query_plans>
4496 This query collects the numbers of various table scans and returned tuples of
4497 the user tables.
4499 =item B<table_states>
4501 This query collects the numbers of live and dead rows in the user tables.
4503 =item B<disk_io>
4505 This query collects disk block access counts for user tables.
4507 =item B<disk_usage>
4509 This query collects the on-disk size of the database in bytes.
4511 =back
4513 In addition, the following detailed queries are available by default. Please
4514 note that each of those queries collects information B<by table>, thus,
4515 potentially producing B<a lot> of data. For details see the description of the
4516 non-by_table queries above.
4518 =over 4
4520 =item B<queries_by_table>
4522 =item B<query_plans_by_table>
4524 =item B<table_states_by_table>
4526 =item B<disk_io_by_table>
4528 =back
4530 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4531 mandatory argument specifying the name of the writer. This will then be used
4532 in the B<Database> specification in order to activate the writer instance. The
4533 names of all writers have to be unique. The following options may be
4534 specified:
4536 =over 4
4538 =item B<Statement> I<sql statement>
4540 This mandatory option specifies the SQL statement that will be executed for
4541 each submitted value. A single SQL statement is allowed only. Anything after
4542 the first semicolon will be ignored.
4544 Nine parameters will be passed to the statement and should be specified as
4545 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4546 values are made available through those parameters:
4548 =over 4
4550 =item B<$1>
4552 The timestamp of the queried value as a floating point number.
4554 =item B<$2>
4556 The hostname of the queried value.
4558 =item B<$3>
4560 The plugin name of the queried value.
4562 =item B<$4>
4564 The plugin instance of the queried value. This value may be B<NULL> if there
4565 is no plugin instance.
4567 =item B<$5>
4569 The type of the queried value (cf. L<types.db(5)>).
4571 =item B<$6>
4573 The type instance of the queried value. This value may be B<NULL> if there is
4574 no type instance.
4576 =item B<$7>
4578 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4579 sources of the submitted value-list).
4581 =item B<$8>
4583 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4584 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4585 B<StoreRates> is enabled (which is the default, see below), all types will be
4586 C<gauge>.
4588 =item B<$9>
4590 An array of the submitted values. The dimensions of the value name and value
4591 arrays match.
4593 =back
4595 In general, it is advisable to create and call a custom function in the
4596 PostgreSQL database for this purpose. Any procedural language supported by
4597 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4598 for details).
4600 =item B<StoreRates> B<false>|B<true>
4602 If set to B<true> (the default), convert counter values to rates. If set to
4603 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4604 number.
4606 =back
4608 The B<Database> block defines one PostgreSQL database for which to collect
4609 statistics. It accepts a single mandatory argument which specifies the
4610 database name. None of the other options are required. PostgreSQL will use
4611 default values as documented in the section "CONNECTING TO A DATABASE" in the
4612 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4613 the user collectd is run as and special environment variables. See the manpage
4614 for details.
4616 =over 4
4618 =item B<Interval> I<seconds>
4620 Specify the interval with which the database should be queried. The default is
4621 to use the global B<Interval> setting.
4623 =item B<CommitInterval> I<seconds>
4625 This option may be used for database connections which have "writers" assigned
4626 (see above). If specified, it causes a writer to put several updates into a
4627 single transaction. This transaction will last for the specified amount of
4628 time. By default, each update will be executed in a separate transaction. Each
4629 transaction generates a fair amount of overhead which can, thus, be reduced by
4630 activating this option. The draw-back is, that data covering the specified
4631 amount of time will be lost, for example, if a single statement within the
4632 transaction fails or if the database server crashes.
4634 =item B<Host> I<hostname>
4636 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4637 value begins with a slash, it is interpreted as the directory name in which to
4638 look for the UNIX domain socket.
4640 This option is also used to determine the hostname that is associated with a
4641 collected data set. If it has been omitted or either begins with with a slash
4642 or equals B<localhost> it will be replaced with the global hostname definition
4643 of collectd. Any other value will be passed literally to collectd when
4644 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4646 =item B<Port> I<port>
4648 Specify the TCP port or the local UNIX domain socket file extension of the
4649 server.
4651 =item B<User> I<username>
4653 Specify the username to be used when connecting to the server.
4655 =item B<Password> I<password>
4657 Specify the password to be used when connecting to the server.
4659 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4661 Specify whether to use an SSL connection when contacting the server. The
4662 following modes are supported:
4664 =item B<Instance> I<name>
4666 Specify the plugin instance name that should be used instead of the database
4667 name (which is the default, if this option has not been specified). This
4668 allows to query multiple databases of the same name on the same host (e.g.
4669 when running multiple database server versions in parallel).
4671 =over 4
4673 =item I<disable>
4675 Do not use SSL at all.
4677 =item I<allow>
4679 First, try to connect without using SSL. If that fails, try using SSL.
4681 =item I<prefer> (default)
4683 First, try to connect using SSL. If that fails, try without using SSL.
4685 =item I<require>
4687 Use SSL only.
4689 =back
4691 =item B<KRBSrvName> I<kerberos_service_name>
4693 Specify the Kerberos service name to use when authenticating with Kerberos 5
4694 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4695 B<PostgreSQL Documentation> for details.
4697 =item B<Service> I<service_name>
4699 Specify the PostgreSQL service name to use for additional parameters. That
4700 service has to be defined in F<pg_service.conf> and holds additional
4701 connection parameters. See the section "The Connection Service File" in the
4702 B<PostgreSQL Documentation> for details.
4704 =item B<Query> I<query>
4706 Specifies a I<query> which should be executed in the context of the database
4707 connection. This may be any of the predefined or user-defined queries. If no
4708 such option is given, it defaults to "backends", "transactions", "queries",
4709 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4710 has been specified). Else, the specified queries are used only.
4712 =item B<Writer> I<writer>
4714 Assigns the specified I<writer> backend to the database connection. This
4715 causes all collected data to be send to the database using the settings
4716 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4717 below for details on how to selectively send data to certain plugins).
4719 Each writer will register a flush callback which may be used when having long
4720 transactions enabled (see the B<CommitInterval> option above). When issuing
4721 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4722 transaction will be committed right away. Two different kinds of flush
4723 callbacks are available with the C<postgresql> plugin:
4725 =over 4
4727 =item B<postgresql>
4729 Flush all writer backends.
4731 =item B<postgresql->I<database>
4733 Flush all writers of the specified I<database> only.
4735 =back
4737 =back
4739 =head2 Plugin C<powerdns>
4741 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4742 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4743 values, many of which are probably meaningless to most users, but may be useful
4744 for some. So you may chose which values to collect, but if you don't, some
4745 reasonable defaults will be collected.
4747   <Plugin "powerdns">
4748     <Server "server_name">
4749       Collect "latency"
4750       Collect "udp-answers" "udp-queries"
4751       Socket "/var/run/pdns.controlsocket"
4752     </Server>
4753     <Recursor "recursor_name">
4754       Collect "questions"
4755       Collect "cache-hits" "cache-misses"
4756       Socket "/var/run/pdns_recursor.controlsocket"
4757     </Recursor>
4758     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4759   </Plugin>
4761 =over 4
4763 =item B<Server> and B<Recursor> block
4765 The B<Server> block defines one authoritative server to query, the B<Recursor>
4766 does the same for an recursing server. The possible options in both blocks are
4767 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
4768 and is required.
4770 =over 4
4772 =item B<Collect> I<Field>
4774 Using the B<Collect> statement you can select which values to collect. Here,
4775 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
4776 C<dlg-only-drops>, C<answers10-100>.
4778 The method of getting the values differs for B<Server> and B<Recursor> blocks:
4779 When querying the server a C<SHOW *> command is issued in any case, because
4780 that's the only way of getting multiple values out of the server at once.
4781 collectd then picks out the values you have selected. When querying the
4782 recursor, a command is generated to query exactly these values. So if you
4783 specify invalid fields when querying the recursor, a syntax error may be
4784 returned by the daemon and collectd may not collect any values at all.
4786 If no B<Collect> statement is given, the following B<Server> values will be
4787 collected:
4789 =over 4
4791 =item latency
4793 =item packetcache-hit
4795 =item packetcache-miss
4797 =item packetcache-size
4799 =item query-cache-hit
4801 =item query-cache-miss
4803 =item recursing-answers
4805 =item recursing-questions
4807 =item tcp-answers
4809 =item tcp-queries
4811 =item udp-answers
4813 =item udp-queries
4815 =back
4817 The following B<Recursor> values will be collected by default:
4819 =over 4
4821 =item noerror-answers
4823 =item nxdomain-answers
4825 =item servfail-answers
4827 =item sys-msec
4829 =item user-msec
4831 =item qa-latency
4833 =item cache-entries
4835 =item cache-hits
4837 =item cache-misses
4839 =item questions
4841 =back
4843 Please note that up to that point collectd doesn't know what values are
4844 available on the server and values that are added do not need a change of the
4845 mechanism so far. However, the values must be mapped to collectd's naming
4846 scheme, which is done using a lookup table that lists all known values. If
4847 values are added in the future and collectd does not know about them, you will
4848 get an error much like this:
4850   powerdns plugin: submit: Not found in lookup table: foobar = 42
4852 In this case please file a bug report with the collectd team.
4854 =item B<Socket> I<Path>
4856 Configures the path to the UNIX domain socket to be used when connecting to the
4857 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
4858 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
4859 will be used for the recursor.
4861 =back
4863 =item B<LocalSocket> I<Path>
4865 Querying the recursor is done using UDP. When using UDP over UNIX domain
4866 sockets, the client socket needs a name in the file system, too. You can set
4867 this local name to I<Path> using the B<LocalSocket> option. The default is
4868 C<I<prefix>/var/run/collectd-powerdns>.
4870 =back
4872 =head2 Plugin C<processes>
4874 =over 4
4876 =item B<Process> I<Name>
4878 Select more detailed statistics of processes matching this name. The statistics
4879 collected for these selected processes are size of the resident segment size
4880 (RSS), user- and system-time used, number of processes and number of threads,
4881 io data (where available) and minor and major pagefaults.
4883 =item B<ProcessMatch> I<name> I<regex>
4885 Similar to the B<Process> option this allows to select more detailed
4886 statistics of processes matching the specified I<regex> (see L<regex(7)> for
4887 details). The statistics of all matching processes are summed up and
4888 dispatched to the daemon using the specified I<name> as an identifier. This
4889 allows to "group" several processes together. I<name> must not contain
4890 slashes.
4892 =back
4894 =head2 Plugin C<protocols>
4896 Collects a lot of information about various network protocols, such as I<IP>,
4897 I<TCP>, I<UDP>, etc.
4899 Available configuration options:
4901 =over 4
4903 =item B<Value> I<Selector>
4905 Selects whether or not to select a specific value. The string being matched is
4906 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
4907 plugin instance and I<ValueName> will be used as type instance. An example of
4908 the string being used would be C<Tcp:RetransSegs>.
4910 You can use regular expressions to match a large number of values with just one
4911 configuration option. To select all "extended" I<TCP> values, you could use the
4912 following statement:
4914   Value "/^TcpExt:/"
4916 Whether only matched values are selected or all matched values are ignored
4917 depends on the B<IgnoreSelected>. By default, only matched values are selected.
4918 If no value is configured at all, all values will be selected.
4920 =item B<IgnoreSelected> B<true>|B<false>
4922 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
4923 matching values will be ignored.
4925 =back
4927 =head2 Plugin C<python>
4929 This plugin embeds a Python-interpreter into collectd and provides an interface
4930 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
4932 =head2 Plugin C<routeros>
4934 The C<routeros> plugin connects to a device running I<RouterOS>, the
4935 Linux-based operating system for routers by I<MikroTik>. The plugin uses
4936 I<librouteros> to connect and reads information about the interfaces and
4937 wireless connections of the device. The configuration supports querying
4938 multiple routers:
4940   <Plugin "routeros">
4941     <Router>
4942       Host "router0.example.com"
4943       User "collectd"
4944       Password "secr3t"
4945       CollectInterface true
4946       CollectCPULoad true
4947       CollectMemory true
4948     </Router>
4949     <Router>
4950       Host "router1.example.com"
4951       User "collectd"
4952       Password "5ecret"
4953       CollectInterface true
4954       CollectRegistrationTable true
4955       CollectDF true
4956       CollectDisk true
4957     </Router>
4958   </Plugin>
4960 As you can see above, the configuration of the I<routeros> plugin consists of
4961 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
4962 options are understood:
4964 =over 4
4966 =item B<Host> I<Host>
4968 Hostname or IP-address of the router to connect to.
4970 =item B<Port> I<Port>
4972 Port name or port number used when connecting. If left unspecified, the default
4973 will be chosen by I<librouteros>, currently "8728". This option expects a
4974 string argument, even when a numeric port number is given.
4976 =item B<User> I<User>
4978 Use the user name I<User> to authenticate. Defaults to "admin".
4980 =item B<Password> I<Password>
4982 Set the password used to authenticate.
4984 =item B<CollectInterface> B<true>|B<false>
4986 When set to B<true>, interface statistics will be collected for all interfaces
4987 present on the device. Defaults to B<false>.
4989 =item B<CollectRegistrationTable> B<true>|B<false>
4991 When set to B<true>, information about wireless LAN connections will be
4992 collected. Defaults to B<false>.
4994 =item B<CollectCPULoad> B<true>|B<false>
4996 When set to B<true>, information about the CPU usage will be collected. The
4997 number is a dimensionless value where zero indicates no CPU usage at all.
4998 Defaults to B<false>.
5000 =item B<CollectMemory> B<true>|B<false>
5002 When enabled, the amount of used and free memory will be collected. How used
5003 memory is calculated is unknown, for example whether or not caches are counted
5004 as used space.
5005 Defaults to B<false>.
5007 =item B<CollectDF> B<true>|B<false>
5009 When enabled, the amount of used and free disk space will be collected.
5010 Defaults to B<false>.
5012 =item B<CollectDisk> B<true>|B<false>
5014 When enabled, the number of sectors written and bad blocks will be collected.
5015 Defaults to B<false>.
5017 =back
5019 =head2 Plugin C<redis>
5021 The I<Redis plugin> connects to one or more Redis servers and gathers
5022 information about each server's state. For each server there is a I<Node> block
5023 which configures the connection parameters for this node.
5025   <Plugin redis>
5026     <Node "example">
5027         Host "localhost"
5028         Port "6379"
5029         Timeout 2000
5030     </Node>
5031   </Plugin>
5033 The information shown in the synopsis above is the I<default configuration>
5034 which is used by the plugin if no configuration is present.
5036 =over 4
5038 =item B<Node> I<Nodename>
5040 The B<Node> block identifies a new Redis node, that is a new Redis instance
5041 running in an specified host and port. The name for node is a canonical
5042 identifier which is used as I<plugin instance>. It is limited to
5043 64E<nbsp>characters in length.
5045 =item B<Host> I<Hostname>
5047 The B<Host> option is the hostname or IP-address where the Redis instance is
5048 running on.
5050 =item B<Port> I<Port>
5052 The B<Port> option is the TCP port on which the Redis instance accepts
5053 connections. Either a service name of a port number may be given. Please note
5054 that numerical port numbers must be given as a string, too.
5056 =item B<Password> I<Password>
5058 Use I<Password> to authenticate when connecting to I<Redis>.
5060 =item B<Timeout> I<Timeout in miliseconds>
5062 The B<Timeout> option set the socket timeout for node response. Since the Redis
5063 read function is blocking, you should keep this value as low as possible. Keep
5064 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5065 than B<Interval> defined globally.
5067 =back
5069 =head2 Plugin C<rrdcached>
5071 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5072 to store values to RRD files in an efficient manner. The combination of the
5073 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5074 way the C<rrdtool> plugin works (see below). The added abstraction layer
5075 provides a number of benefits, though: Because the cache is not within
5076 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5077 restarted. This results in much shorter (if any) gaps in graphs, especially
5078 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5079 daemon so that it can flush values to disk automatically when needed. This
5080 allows to integrate automated flushing of values into graphing solutions much
5081 more easily.
5083 There are disadvantages, though: The daemon may reside on a different host, so
5084 it may not be possible for C<collectd> to create the appropriate RRD files
5085 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5086 different base directory, so relative paths may do weird stuff if you're not
5087 careful.
5089 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5090 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5091 setting should be set to an absolute path, so that a changed base directory
5092 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5094 =over 4
5096 =item B<DaemonAddress> I<Address>
5098 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5099 library. See L<rrdcached(1)> for details. Example:
5101   <Plugin "rrdcached">
5102     DaemonAddress "unix:/var/run/rrdcached.sock"
5103   </Plugin>
5105 =item B<DataDir> I<Directory>
5107 Set the base directory in which the RRD files reside. If this is a relative
5108 path, it is relative to the working base directory of the C<rrdcached> daemon!
5109 Use of an absolute path is recommended.
5111 =item B<CreateFiles> B<true>|B<false>
5113 Enables or disables the creation of RRD files. If the daemon is not running
5114 locally, or B<DataDir> is set to a relative path, this will not work as
5115 expected. Default is B<true>.
5117 =item B<CreateFilesAsync> B<false>|B<true>
5119 When enabled, new RRD files are enabled asynchronously, using a separate thread
5120 that runs in the background. This prevents writes to block, which is a problem
5121 especially when many hundreds of files need to be created at once. However,
5122 since the purpose of creating the files asynchronously is I<not> to block until
5123 the file is available, values before the file is available will be discarded.
5124 When disabled (the default) files are created synchronously, blocking for a
5125 short while, while the file is being written.
5127 =item B<StepSize> I<Seconds>
5129 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5130 this setting is unset and the stepsize is set to the interval in which the data
5131 is collected. Do not use this option unless you absolutely have to for some
5132 reason. Setting this option may cause problems with the C<snmp plugin>, the
5133 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5135 =item B<HeartBeat> I<Seconds>
5137 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5138 in which case the heartbeat is set to twice the B<StepSize> which should equal
5139 the interval in which data is collected. Do not set this option unless you have
5140 a very good reason to do so.
5142 =item B<RRARows> I<NumRows>
5144 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5145 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5146 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5147 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5148 week, one month, and one year.
5150 So for each timespan, it calculates how many PDPs need to be consolidated into
5151 one CDP by calculating:
5152   number of PDPs = timespan / (stepsize * rrarows)
5154 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5155 default is 1200.
5157 =item B<RRATimespan> I<Seconds>
5159 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5160 more then one RRA. If this option is never used, the built-in default of (3600,
5161 86400, 604800, 2678400, 31622400) is used.
5163 For more information on how RRA-sizes are calculated see B<RRARows> above.
5165 =item B<XFF> I<Factor>
5167 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5168 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5169 one (exclusive).
5171 =back
5173 =head2 Plugin C<rrdtool>
5175 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5176 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5177 using these settings. If you don't want to dive into the depths of RRDtool, you
5178 can safely ignore these settings.
5180 =over 4
5182 =item B<DataDir> I<Directory>
5184 Set the directory to store RRD files under. By default RRD files are generated
5185 beneath the daemon's working directory, i.e. the B<BaseDir>.
5187 =item B<CreateFilesAsync> B<false>|B<true>
5189 When enabled, new RRD files are enabled asynchronously, using a separate thread
5190 that runs in the background. This prevents writes to block, which is a problem
5191 especially when many hundreds of files need to be created at once. However,
5192 since the purpose of creating the files asynchronously is I<not> to block until
5193 the file is available, values before the file is available will be discarded.
5194 When disabled (the default) files are created synchronously, blocking for a
5195 short while, while the file is being written.
5197 =item B<StepSize> I<Seconds>
5199 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5200 this setting is unset and the stepsize is set to the interval in which the data
5201 is collected. Do not use this option unless you absolutely have to for some
5202 reason. Setting this option may cause problems with the C<snmp plugin>, the
5203 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5205 =item B<HeartBeat> I<Seconds>
5207 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5208 in which case the heartbeat is set to twice the B<StepSize> which should equal
5209 the interval in which data is collected. Do not set this option unless you have
5210 a very good reason to do so.
5212 =item B<RRARows> I<NumRows>
5214 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5215 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5216 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5217 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5218 week, one month, and one year.
5220 So for each timespan, it calculates how many PDPs need to be consolidated into
5221 one CDP by calculating:
5222   number of PDPs = timespan / (stepsize * rrarows)
5224 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5225 default is 1200.
5227 =item B<RRATimespan> I<Seconds>
5229 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5230 more then one RRA. If this option is never used, the built-in default of (3600,
5231 86400, 604800, 2678400, 31622400) is used.
5233 For more information on how RRA-sizes are calculated see B<RRARows> above.
5235 =item B<XFF> I<Factor>
5237 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5238 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5239 one (exclusive).
5241 =item B<CacheFlush> I<Seconds>
5243 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5244 it writes all values for a certain RRD-file if the oldest value is older than
5245 (or equal to) the number of seconds specified. If some RRD-file is not updated
5246 anymore for some reason (the computer was shut down, the network is broken,
5247 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5248 entire cache is searched for entries older than B<CacheTimeout> seconds and
5249 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5250 does nothing under normal circumstances, this value should not be too small.
5251 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5252 normally do much harm either.
5254 =item B<CacheTimeout> I<Seconds>
5256 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5257 save values in a cache, as described above. Writing multiple values at once
5258 reduces IO-operations and thus lessens the load produced by updating the files.
5259 The trade off is that the graphs kind of "drag behind" and that more memory is
5260 used.
5262 =item B<WritesPerSecond> I<Updates>
5264 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5265 will run serious performance problems. The B<CacheFlush> setting and the
5266 internal update queue assert that collectd continues to work just fine even
5267 under heavy load, but the system may become very unresponsive and slow. This is
5268 a problem especially if you create graphs from the RRD files on the same
5269 machine, for example using the C<graph.cgi> script included in the
5270 C<contrib/collection3/> directory.
5272 This setting is designed for very large setups. Setting this option to a value
5273 between 25 and 80 updates per second, depending on your hardware, will leave
5274 the server responsive enough to draw graphs even while all the cached values
5275 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5276 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5277 written as fast as possible, so that web frontends have up to date data when
5278 generating graphs.
5280 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5281 updates per second, writing all values to disk will take approximately
5282 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5283 "collection3" you'll end up with a responsive and fast system, up to date
5284 graphs and basically a "backup" of your values every hour.
5286 =item B<RandomTimeout> I<Seconds>
5288 When set, the actual timeout for each value is chosen randomly between
5289 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5290 intention is to avoid high load situations that appear when many values timeout
5291 at the same time. This is especially a problem shortly after the daemon starts,
5292 because all values were added to the internal cache at roughly the same time.
5294 =back
5296 =head2 Plugin C<sensors>
5298 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5299 that all the needed modules have to be loaded and lm_sensors has to be
5300 configured (most likely by editing F</etc/sensors.conf>. Read
5301 L<sensors.conf(5)> for details.
5303 The B<lm_sensors> homepage can be found at
5304 L<http://secure.netroedge.com/~lm78/>.
5306 =over 4
5308 =item B<SensorConfigFile> I<File>
5310 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5311 the library's default will be used.
5313 =item B<Sensor> I<chip-bus-address/type-feature>
5315 Selects the name of the sensor which you want to collect or ignore, depending
5316 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5317 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5318 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5320 =item B<IgnoreSelected> I<true>|I<false>
5322 If no configuration if given, the B<sensors>-plugin will collect data from all
5323 sensors. This may not be practical, especially for uninteresting sensors.
5324 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5325 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5326 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5327 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5328 and all other sensors are collected.
5330 =back
5332 =head2 Plugin C<sigrok>
5334 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5335 supported by the L<sigrok|http://sigrok.org/> project.
5337 B<Synopsis>
5339  <Plugin sigrok>
5340    LogLevel 3
5341    <Device "AC Voltage">
5342       Driver "fluke-dmm"
5343       MinimumInterval 10
5344       Conn "/dev/ttyUSB2"
5345    </Device>
5346    <Device "Sound Level">
5347       Driver "cem-dt-885x"
5348       Conn "/dev/ttyUSB1"
5349    </Device>
5350  </Plugin>
5352 =over 4
5354 =item B<LogLevel> B<0-5>
5356 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5357 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5358 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5359 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5360 their level, are always submitted to I<collectd> at its INFO log level.
5362 =item E<lt>B<Device> I<Name>E<gt>
5364 A sigrok-supported device, uniquely identified by this section's options. The
5365 I<Name> is passed to I<collectd> as the I<plugin instance>.
5367 =item B<Driver> I<DriverName>
5369 The sigrok driver to use for this device.
5371 =item B<Conn> I<ConnectionSpec>
5373 If the device cannot be auto-discovered, or more than one might be discovered
5374 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5375 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5376 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5377 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5378 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5380 =item B<SerialComm> I<SerialSpec>
5382 For serial devices with non-standard port settings, this option can be used
5383 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5384 This should not be necessary; drivers know how to communicate with devices they
5385 support.
5387 =item B<MinimumInterval> I<Seconds>
5389 Specifies the minimum time between measurement dispatches to I<collectd>, in
5390 seconds. Since some I<sigrok> supported devices can acquire measurements many
5391 times per second, it may be necessary to throttle these. For example, the
5392 I<RRD plugin> cannot process writes more than once per second.
5394 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5395 device are always dispatched to I<collectd>. When throttled, unused
5396 measurements are discarded.
5398 =back
5400 =head2 Plugin C<snmp>
5402 Since the configuration of the C<snmp plugin> is a little more complicated than
5403 other plugins, its documentation has been moved to an own manpage,
5404 L<collectd-snmp(5)>. Please see there for details.
5406 =head2 Plugin C<statsd>
5408 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5409 protocol and dispatches rates or other aggregates of these numbers
5410 periodically.
5412 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5413 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5414 C<objects> respectively.
5416 The following configuration options are valid:
5418 =over 4
5420 =item B<Host> I<Host>
5422 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5423 "any" address, i.e. accept packets sent to any of the hosts addresses.
5425 =item B<Port> I<Port>
5427 UDP port to listen to. This can be either a service name or a port number.
5428 Defaults to C<8125>.
5430 =item B<DeleteCounters> B<false>|B<true>
5432 =item B<DeleteTimers> B<false>|B<true>
5434 =item B<DeleteGauges> B<false>|B<true>
5436 =item B<DeleteSets> B<false>|B<true>
5438 These options control what happens if metrics are not updated in an interval.
5439 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5440 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5441 are unchanged. If set to B<True>, the such metrics are not dispatched and
5442 removed from the internal cache.
5444 =item B<TimerPercentile> I<Percent>
5446 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5447 that I<Percent> of all reported timers are smaller than or equal to the
5448 computed latency. This is useful for cutting off the long tail latency, as it's
5449 often done in I<Service Level Agreements> (SLAs).
5451 If not specified, no percentile is calculated / dispatched.
5453 =back
5455 =head2 Plugin C<swap>
5457 The I<Swap plugin> collects information about used and available swap space. On
5458 I<Linux> and I<Solaris>, the following options are available:
5460 =over 4
5462 =item B<ReportByDevice> B<false>|B<true>
5464 Configures how to report physical swap devices. If set to B<false> (the
5465 default), the summary over all swap devices is reported only, i.e. the globally
5466 used and available space over all devices. If B<true> is configured, the used
5467 and available space of each device will be reported separately.
5469 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5470 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5472 =item B<ReportBytes> B<false>|B<true>
5474 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5475 I<swap I/O> is reported in pages. This option is available under Linux only.
5477 =item B<ValuesAbsolute> B<true>|B<false>
5479 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5480 available and used. Defaults to B<true>.
5482 =item B<ValuesPercentage> B<false>|B<true>
5484 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5485 available and free. Defaults to B<false>.
5487 This is useful for deploying I<collectd> in a heterogeneous environment, where
5488 swap sizes differ and you want to specify generic thresholds or similar.
5490 =back
5492 =head2 Plugin C<syslog>
5494 =over 4
5496 =item B<LogLevel> B<debug|info|notice|warning|err>
5498 Sets the log-level. If, for example, set to B<notice>, then all events with
5499 severity B<notice>, B<warning>, or B<err> will be submitted to the
5500 syslog-daemon.
5502 Please note that B<debug> is only available if collectd has been compiled with
5503 debugging support.
5505 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5507 Controls which notifications should be sent to syslog. The default behaviour is
5508 not to send any. Less severe notifications always imply logging more severe
5509 notifications: Setting this to B<OKAY> means all notifications will be sent to
5510 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5511 notifications but will dismiss B<OKAY> notifications. Setting this option to
5512 B<FAILURE> will only send failures to syslog.
5514 =back
5516 =head2 Plugin C<table>
5518 The C<table plugin> provides generic means to parse tabular data and dispatch
5519 user specified values. Values are selected based on column numbers. For
5520 example, this plugin may be used to get values from the Linux L<proc(5)>
5521 filesystem or CSV (comma separated values) files.
5523   <Plugin table>
5524     <Table "/proc/slabinfo">
5525       Instance "slabinfo"
5526       Separator " "
5527       <Result>
5528         Type gauge
5529         InstancePrefix "active_objs"
5530         InstancesFrom 0
5531         ValuesFrom 1
5532       </Result>
5533       <Result>
5534         Type gauge
5535         InstancePrefix "objperslab"
5536         InstancesFrom 0
5537         ValuesFrom 4
5538       </Result>
5539     </Table>
5540   </Plugin>
5542 The configuration consists of one or more B<Table> blocks, each of which
5543 configures one file to parse. Within each B<Table> block, there are one or
5544 more B<Result> blocks, which configure which data to select and how to
5545 interpret it.
5547 The following options are available inside a B<Table> block:
5549 =over 4
5551 =item B<Instance> I<instance>
5553 If specified, I<instance> is used as the plugin instance. So, in the above
5554 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5555 filename of the table is used instead, with all special characters replaced
5556 with an underscore (C<_>).
5558 =item B<Separator> I<string>
5560 Any character of I<string> is interpreted as a delimiter between the different
5561 columns of the table. A sequence of two or more contiguous delimiters in the
5562 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5563 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5564 of a table - see its documentation for more details. This option is mandatory.
5566 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5567 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5568 required because of collectd's config parsing.
5570 =back
5572 The following options are available inside a B<Result> block:
5574 =over 4
5576 =item B<Type> I<type>
5578 Sets the type used to dispatch the values to the daemon. Detailed information
5579 about types and their configuration can be found in L<types.db(5)>. This
5580 option is mandatory.
5582 =item B<InstancePrefix> I<prefix>
5584 If specified, prepend I<prefix> to the type instance. If omitted, only the
5585 B<InstancesFrom> option is considered for the type instance.
5587 =item B<InstancesFrom> I<column0> [I<column1> ...]
5589 If specified, the content of the given columns (identified by the column
5590 number starting at zero) will be used to create the type instance for each
5591 row. Multiple values (and the instance prefix) will be joined together with
5592 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5593 option is considered for the type instance.
5595 The plugin itself does not check whether or not all built instances are
5596 different. It’s your responsibility to assure that each is unique. This is
5597 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5598 sure that the table only contains one row.
5600 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5601 will be empty.
5603 =item B<ValuesFrom> I<column0> [I<column1> ...]
5605 Specifies the columns (identified by the column numbers starting at zero)
5606 whose content is used as the actual data for the data sets that are dispatched
5607 to the daemon. How many such columns you need is determined by the B<Type>
5608 setting above. If you specify too many or not enough columns, the plugin will
5609 complain about that and no data will be submitted to the daemon. The plugin
5610 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5611 respectively, so anything supported by those functions is supported by the
5612 plugin as well. This option is mandatory.
5614 =back
5616 =head2 Plugin C<tail>
5618 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5619 each line and dispatches found values. What is matched can be configured by the
5620 user using (extended) regular expressions, as described in L<regex(7)>.
5622   <Plugin "tail">
5623     <File "/var/log/exim4/mainlog">
5624       Instance "exim"
5625       Interval 60
5626       <Match>
5627         Regex "S=([1-9][0-9]*)"
5628         DSType "CounterAdd"
5629         Type "ipt_bytes"
5630         Instance "total"
5631       </Match>
5632       <Match>
5633         Regex "\\<R=local_user\\>"
5634         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5635         DSType "CounterInc"
5636         Type "counter"
5637         Instance "local_user"
5638       </Match>
5639     </File>
5640   </Plugin>
5642 The config consists of one or more B<File> blocks, each of which configures one
5643 logfile to parse. Within each B<File> block, there are one or more B<Match>
5644 blocks, which configure a regular expression to search for.
5646 The B<Instance> option in the B<File> block may be used to set the plugin
5647 instance. So in the above example the plugin name C<tail-foo> would be used.
5648 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5649 next B<Instance> option. This way you can extract several plugin instances from
5650 one logfile, handy when parsing syslog and the like.
5652 The B<Interval> option allows you to define the length of time between reads. If
5653 this is not set, the default Interval will be used.
5655 Each B<Match> block has the following options to describe how the match should
5656 be performed:
5658 =over 4
5660 =item B<Regex> I<regex>
5662 Sets the regular expression to use for matching against a line. The first
5663 subexpression has to match something that can be turned into a number by
5664 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5665 below. Because B<extended> regular expressions are used, you do not need to use
5666 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5667 collectd's config parsing you need to escape backslashes, though. So if you
5668 want to match literal parentheses you need to do the following:
5670   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5672 =item B<ExcludeRegex> I<regex>
5674 Sets an optional regular expression to use for excluding lines from the match.
5675 An example which excludes all connections from localhost from the match:
5677   ExcludeRegex "127\\.0\\.0\\.1"
5679 =item B<DSType> I<Type>
5681 Sets how the values are cumulated. I<Type> is one of:
5683 =over 4
5685 =item B<GaugeAverage>
5687 Calculate the average.
5689 =item B<GaugeMin>
5691 Use the smallest number only.
5693 =item B<GaugeMax>
5695 Use the greatest number only.
5697 =item B<GaugeLast>
5699 Use the last number found.
5701 =item B<CounterSet>
5703 =item B<DeriveSet>
5705 =item B<AbsoluteSet>
5707 The matched number is a counter. Simply I<sets> the internal counter to this
5708 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5710 =item B<CounterAdd>
5712 =item B<DeriveAdd>
5714 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5715 matched number may be negative, which will effectively subtract from the
5716 internal counter.
5718 =item B<CounterInc>
5720 =item B<DeriveInc>
5722 Increase the internal counter by one. These B<DSType> are the only ones that do
5723 not use the matched subexpression, but simply count the number of matched
5724 lines. Thus, you may use a regular expression without submatch in this case.
5726 =back
5728 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5729 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5730 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5731 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5732 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5733 case.
5735 =item B<Type> I<Type>
5737 Sets the type used to dispatch this value. Detailed information about types and
5738 their configuration can be found in L<types.db(5)>.
5740 =item B<Instance> I<TypeInstance>
5742 This optional setting sets the type instance to use.
5744 =back
5746 =head2 Plugin C<tail_csv>
5748 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5749 written by I<Snort>.
5751 B<Synopsis:>
5753  <Plugin "tail_csv">
5754    <Metric "snort-dropped">
5755        Type "percent"
5756        Instance "dropped"
5757        Index 1
5758    </Metric>
5759    <File "/var/log/snort/snort.stats">
5760        Instance "snort-eth0"
5761        Interval 600
5762        Collect "snort-dropped"
5763    </File>
5764  </Plugin>
5766 The configuration consists of one or more B<Metric> blocks that define an index
5767 into the line of the CSV file and how this value is mapped to I<collectd's>
5768 internal representation. These are followed by one or more B<Instance> blocks
5769 which configure which file to read, in which interval and which metrics to
5770 extract.
5772 =over 4
5774 =item E<lt>B<Metric> I<Name>E<gt>
5776 The B<Metric> block configures a new metric to be extracted from the statistics
5777 file and how it is mapped on I<collectd's> data model. The string I<Name> is
5778 only used inside the B<Instance> blocks to refer to this block, so you can use
5779 one B<Metric> block for multiple CSV files.
5781 =over 4
5783 =item B<Type> I<Type>
5785 Configures which I<Type> to use when dispatching this metric. Types are defined
5786 in the L<types.db(5)> file, see the appropriate manual page for more
5787 information on specifying types. Only types with a single I<data source> are
5788 supported by the I<tail_csv plugin>. The information whether the value is an
5789 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
5790 I<Type's> definition.
5792 =item B<Instance> I<TypeInstance>
5794 If set, I<TypeInstance> is used to populate the type instance field of the
5795 created value lists. Otherwise, no type instance is used.
5797 =item B<ValueFrom> I<Index>
5799 Configure to read the value from the field with the zero-based index I<Index>.
5800 If the value is parsed as signed integer, unsigned integer or double depends on
5801 the B<Type> setting, see above.
5803 =back
5805 =item E<lt>B<File> I<Path>E<gt>
5807 Each B<File> block represents one CSV file to read. There must be at least one
5808 I<File> block but there can be multiple if you have multiple CSV files.
5810 =over 4
5812 =item B<Instance> I<PluginInstance>
5814 Sets the I<plugin instance> used when dispatching the values.
5816 =item B<Collect> I<Metric>
5818 Specifies which I<Metric> to collect. This option must be specified at least
5819 once, and you can use this option multiple times to specify more than one
5820 metric to be extracted from this statistic file.
5822 =item B<Interval> I<Seconds>
5824 Configures the interval in which to read values from this instance / file.
5825 Defaults to the plugin's default interval.
5827 =item B<TimeFrom> I<Index>
5829 Rather than using the local time when dispatching a value, read the timestamp
5830 from the field with the zero-based index I<Index>. The value is interpreted as
5831 seconds since epoch. The value is parsed as a double and may be factional.
5833 =back
5835 =back
5837 =head2 Plugin C<teamspeak2>
5839 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
5840 polls interesting global and virtual server data. The plugin can query only one
5841 physical server but unlimited virtual servers. You can use the following
5842 options to configure it:
5844 =over 4
5846 =item B<Host> I<hostname/ip>
5848 The hostname or ip which identifies the physical server.
5849 Default: 127.0.0.1
5851 =item B<Port> I<port>
5853 The query port of the physical server. This needs to be a string.
5854 Default: "51234"
5856 =item B<Server> I<port>
5858 This option has to be added once for every virtual server the plugin should
5859 query. If you want to query the virtual server on port 8767 this is what the
5860 option would look like:
5862   Server "8767"
5864 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
5865 use quotes around it! If no such statement is given only global information
5866 will be collected.
5868 =back
5870 =head2 Plugin C<ted>
5872 The I<TED> plugin connects to a device of "The Energy Detective", a device to
5873 measure power consumption. These devices are usually connected to a serial
5874 (RS232) or USB port. The plugin opens a configured device and tries to read the
5875 current energy readings. For more information on TED, visit
5876 L<http://www.theenergydetective.com/>.
5878 Available configuration options:
5880 =over 4
5882 =item B<Device> I<Path>
5884 Path to the device on which TED is connected. collectd will need read and write
5885 permissions on that file.
5887 Default: B</dev/ttyUSB0>
5889 =item B<Retries> I<Num>
5891 Apparently reading from TED is not that reliable. You can therefore configure a
5892 number of retries here. You only configure the I<retries> here, to if you
5893 specify zero, one reading will be performed (but no retries if that fails); if
5894 you specify three, a maximum of four readings are performed. Negative values
5895 are illegal.
5897 Default: B<0>
5899 =back
5901 =head2 Plugin C<tcpconns>
5903 The C<tcpconns plugin> counts the number of currently established TCP
5904 connections based on the local port and/or the remote port. Since there may be
5905 a lot of connections the default if to count all connections with a local port,
5906 for which a listening socket is opened. You can use the following options to
5907 fine-tune the ports you are interested in:
5909 =over 4
5911 =item B<ListeningPorts> I<true>|I<false>
5913 If this option is set to I<true>, statistics for all local ports for which a
5914 listening socket exists are collected. The default depends on B<LocalPort> and
5915 B<RemotePort> (see below): If no port at all is specifically selected, the
5916 default is to collect listening ports. If specific ports (no matter if local or
5917 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
5918 the selected ports will be collected unless this option is set to I<true>
5919 specifically.
5921 =item B<LocalPort> I<Port>
5923 Count the connections to a specific local port. This can be used to see how
5924 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
5925 You have to specify the port in numeric form, so for the mailserver example
5926 you'd need to set B<25>.
5928 =item B<RemotePort> I<Port>
5930 Count the connections to a specific remote port. This is useful to see how
5931 much a remote service is used. This is most useful if you want to know how many
5932 connections a local service has opened to remote services, e.E<nbsp>g. how many
5933 connections a mail server or news server has to other mail or news servers, or
5934 how many connections a web proxy holds to web servers. You have to give the
5935 port in numeric form.
5937 =back
5939 =head2 Plugin C<thermal>
5941 =over 4
5943 =item B<ForceUseProcfs> I<true>|I<false>
5945 By default, the I<Thermal plugin> tries to read the statistics from the Linux
5946 C<sysfs> interface. If that is not available, the plugin falls back to the
5947 C<procfs> interface. By setting this option to I<true>, you can force the
5948 plugin to use the latter. This option defaults to I<false>.
5950 =item B<Device> I<Device>
5952 Selects the name of the thermal device that you want to collect or ignore,
5953 depending on the value of the B<IgnoreSelected> option. This option may be
5954 used multiple times to specify a list of devices.
5956 =item B<IgnoreSelected> I<true>|I<false>
5958 Invert the selection: If set to true, all devices B<except> the ones that
5959 match the device names specified by the B<Device> option are collected. By
5960 default only selected devices are collected if a selection is made. If no
5961 selection is configured at all, B<all> devices are selected.
5963 =back
5965 =head2 Plugin C<threshold>
5967 The I<Threshold plugin> checks values collected or received by I<collectd>
5968 against a configurable I<threshold> and issues I<notifications> if values are
5969 out of bounds.
5971 Documentation for this plugin is available in the L<collectd-threshold(5)>
5972 manual page.
5974 =head2 Plugin C<tokyotyrant>
5976 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
5977 couple metrics: number of records, and database size on disk.
5979 =over 4
5981 =item B<Host> I<Hostname/IP>
5983 The hostname or ip which identifies the server.
5984 Default: B<127.0.0.1>
5986 =item B<Port> I<Service/Port>
5988 The query port of the server. This needs to be a string, even if the port is
5989 given in its numeric form.
5990 Default: B<1978>
5992 =back
5994 =head2 Plugin C<unixsock>
5996 =over 4
5998 =item B<SocketFile> I<Path>
6000 Sets the socket-file which is to be created.
6002 =item B<SocketGroup> I<Group>
6004 If running as root change the group of the UNIX-socket after it has been
6005 created. Defaults to B<collectd>.
6007 =item B<SocketPerms> I<Permissions>
6009 Change the file permissions of the UNIX-socket after it has been created. The
6010 permissions must be given as a numeric, octal value as you would pass to
6011 L<chmod(1)>. Defaults to B<0770>.
6013 =item B<DeleteSocket> B<false>|B<true>
6015 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6016 with the given name already exists. If I<collectd> crashes a socket file may be
6017 left over, preventing the daemon from opening a new socket when restarted.
6018 Since this is potentially dangerous, this defaults to B<false>.
6020 =back
6022 =head2 Plugin C<uuid>
6024 This plugin, if loaded, causes the Hostname to be taken from the machine's
6025 UUID. The UUID is a universally unique designation for the machine, usually
6026 taken from the machine's BIOS. This is most useful if the machine is running in
6027 a virtual environment such as Xen, in which case the UUID is preserved across
6028 shutdowns and migration.
6030 The following methods are used to find the machine's UUID, in order:
6032 =over 4
6034 =item
6036 Check I</etc/uuid> (or I<UUIDFile>).
6038 =item
6040 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6041 present.
6043 =item
6045 Check for UUID from C<dmidecode> / SMBIOS.
6047 =item
6049 Check for UUID from Xen hypervisor.
6051 =back
6053 If no UUID can be found then the hostname is not modified.
6055 =over 4
6057 =item B<UUIDFile> I<Path>
6059 Take the UUID from the given file (default I</etc/uuid>).
6061 =back
6063 =head2 Plugin C<varnish>
6065 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6067 Synopsis:
6069  <Plugin "varnish">
6070    <Instance "example">
6071      CollectCache       true
6072      CollectConnections true
6073      CollectBackend     true
6074      CollectSHM         true
6075      CollectESI         false
6076      CollectFetch       false
6077      CollectHCB         false
6078      CollectSMA         false
6079      CollectSMS         false
6080      CollectSM          false
6081      CollectTotals      false
6082      CollectWorkers     false
6083    </Instance>
6084  </Plugin>
6086 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6087 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6088 will collectd statistics from the default "varnishd" instance (this should work
6089 fine in most cases).
6091 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6093 =over 4
6095 =item B<CollectCache> B<true>|B<false>
6097 Cache hits and misses. True by default.
6099 =item B<CollectConnections> B<true>|B<false>
6101 Number of client connections received, accepted and dropped. True by default.
6103 =item B<CollectBackend> B<true>|B<false>
6105 Back-end connection statistics, such as successful, reused,
6106 and closed connections. True by default.
6108 =item B<CollectSHM> B<true>|B<false>
6110 Statistics about the shared memory log, a memory region to store
6111 log messages which is flushed to disk when full. True by default.
6113 =item B<CollectBan> B<true>|B<false>
6115 Statistics about ban operations, such as number of bans added, retired, and
6116 number of objects tested against ban operations. Only available with Varnish
6117 3.x. False by default.
6119 =item B<CollectDirectorDNS> B<true>|B<false>
6121 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6122 default.
6124 =item B<CollectESI> B<true>|B<false>
6126 Edge Side Includes (ESI) parse statistics. False by default.
6128 =item B<CollectFetch> B<true>|B<false>
6130 Statistics about fetches (HTTP requests sent to the backend). False by default.
6132 =item B<CollectHCB> B<true>|B<false>
6134 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6135 divided into locked and unlocked look-ups. False by default.
6137 =item B<CollectObjects> B<true>|B<false>
6139 Statistics on cached objects: number of objects expired, nuked (prematurely
6140 expired), saved, moved, etc. False by default.
6142 =item B<CollectPurge> B<true>|B<false>
6144 Statistics about purge operations, such as number of purges added, retired, and
6145 number of objects tested against purge operations. Only available with Varnish
6146 2.x. False by default.
6148 =item B<CollectSession> B<true>|B<false>
6150 Client session statistics. Number of past and current sessions, session herd and
6151 linger counters, etc. False by default.
6153 =item B<CollectSMA> B<true>|B<false>
6155 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6156 component is Solaris specific. Only available with Varnish 2.x. False by
6157 default.
6159 =item B<CollectSMS> B<true>|B<false>
6161 synth (synthetic content) storage statistics. This storage
6162 component is used internally only. False by default.
6164 =item B<CollectSM> B<true>|B<false>
6166 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6167 False by default.
6169 =item B<CollectStruct> B<true>|B<false>
6171 Current varnish internal state statistics. Number of current sessions, objects
6172 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6173 default.
6175 =item B<CollectTotals> B<true>|B<false>
6177 Collects overview counters, such as the number of sessions created,
6178 the number of requests and bytes transferred. False by default.
6180 =item B<CollectUptime> B<true>|B<false>
6182 Varnish uptime. False by default.
6184 =item B<CollectVCL> B<true>|B<false>
6186 Number of total (available + discarded) VCL (config files). False by default.
6188 =item B<CollectWorkers> B<true>|B<false>
6190 Collect statistics about worker threads. False by default.
6192 =back
6194 =head2 Plugin C<vmem>
6196 The C<vmem> plugin collects information about the usage of virtual memory.
6197 Since the statistics provided by the Linux kernel are very detailed, they are
6198 collected very detailed. However, to get all the details, you have to switch
6199 them on manually. Most people just want an overview over, such as the number of
6200 pages read from swap space.
6202 =over 4
6204 =item B<Verbose> B<true>|B<false>
6206 Enables verbose collection of information. This will start collecting page
6207 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6208 Part of these statistics are collected on a "per zone" basis.
6210 =back
6212 =head2 Plugin C<vserver>
6214 This plugin doesn't have any options. B<VServer> support is only available for
6215 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6216 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6217 need to apply the patches and compile your own kernel, which will then provide
6218 the F</proc/virtual> filesystem that is required by this plugin.
6220 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6222 B<Note>: The traffic collected by this plugin accounts for the amount of
6223 traffic passing a socket which might be a lot less than the actual on-wire
6224 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6225 collect on-wire traffic you could, for example, use the logging facilities of
6226 iptables to feed data for the guest IPs into the iptables plugin.
6228 =head2 Plugin C<write_graphite>
6230 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6231 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6232 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6233 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6234 of at most 1428 bytes to minimize the number of network packets.
6236 Synopsis:
6238  <Plugin write_graphite>
6239    <Node "example">
6240      Host "localhost"
6241      Port "2003"
6242      Protocol "tcp"
6243      LogSendErrors true
6244      Prefix "collectd"
6245    </Node>
6246  </Plugin>
6248 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6249 blocks. Inside the B<Node> blocks, the following options are recognized:
6251 =over 4
6253 =item B<Host> I<Address>
6255 Hostname or address to connect to. Defaults to C<localhost>.
6257 =item B<Port> I<Service>
6259 Service name or port number to connect to. Defaults to C<2003>.
6261 =item B<Protocol> I<String>
6263 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6265 =item B<LogSendErrors> B<false>|B<true>
6267 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6268 If set to B<false>, it will not log the errors. This is especially useful when
6269 using Protocol UDP since many times we want to use the "fire-and-forget"
6270 approach and logging errors fills syslog with unneeded messages.
6272 =item B<Prefix> I<String>
6274 When set, I<String> is added in front of the host name. Dots and whitespace are
6275 I<not> escaped in this string (see B<EscapeCharacter> below).
6277 =item B<Postfix> I<String>
6279 When set, I<String> is appended to the host name. Dots and whitespace are
6280 I<not> escaped in this string (see B<EscapeCharacter> below).
6282 =item B<EscapeCharacter> I<Char>
6284 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6285 in the identifier. The B<EscapeCharacter> option determines which character
6286 dots, whitespace and control characters are replaced with. Defaults to
6287 underscore (C<_>).
6289 =item B<StoreRates> B<false>|B<true>
6291 If set to B<true> (the default), convert counter values to rates. If set to
6292 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6293 number.
6295 =item B<SeparateInstances> B<false>|B<true>
6297 If set to B<true>, the plugin instance and type instance will be in their own
6298 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6299 default), the plugin and plugin instance (and likewise the type and type
6300 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6302 =item B<AlwaysAppendDS> B<false>|B<true>
6304 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6305 identifier. If set to B<false> (the default), this is only done when there is
6306 more than one DS.
6308 =back
6310 =head2 Plugin C<write_mongodb>
6312 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6313 NoSQL database.
6315 B<Synopsis:>
6317  <Plugin "write_mongodb">
6318    <Node "default">
6319      Host "localhost"
6320      Port "27017"
6321      Timeout 1000
6322      StoreRates true
6323    </Node>
6324  </Plugin>
6326 The plugin can send values to multiple instances of I<MongoDB> by specifying
6327 one B<Node> block for each instance. Within the B<Node> blocks, the following
6328 options are available:
6330 =over 4
6332 =item B<Host> I<Address>
6334 Hostname or address to connect to. Defaults to C<localhost>.
6336 =item B<Port> I<Service>
6338 Service name or port number to connect to. Defaults to C<27017>.
6340 =item B<Timeout> I<Timeout>
6342 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6343 Setting this option to zero means no timeout, which is the default.
6345 =item B<StoreRates> B<false>|B<true>
6347 If set to B<true> (the default), convert counter values to rates. If set to
6348 B<false> counter values are stored as is, i.e. as an increasing integer
6349 number.
6351 =item B<Database> I<Database>
6353 =item B<User> I<User>
6355 =item B<Password> I<Password>
6357 Sets the information used when authenticating to a I<MongoDB> database. The
6358 fields are optional (in which case no authentication is attempted), but if you
6359 want to use authentication all three fields must be set.
6361 =back
6363 =head2 Plugin C<write_http>
6365 This output plugin submits values to an http server by POST them using the
6366 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6367 have one B<URL> block, within which the destination can be configured further,
6368 for example by specifying authentication data.
6370 Synopsis:
6372  <Plugin "write_http">
6373    <URL "http://example.com/post-collectd">
6374      User "collectd"
6375      Password "weCh3ik0"
6376    </URL>
6377  </Plugin>
6379 B<URL> blocks need one string argument which is used as the URL to which data
6380 is posted. The following options are understood within B<URL> blocks.
6382 =over 4
6384 =item B<User> I<Username>
6386 Optional user name needed for authentication.
6388 =item B<Password> I<Password>
6390 Optional password needed for authentication.
6392 =item B<VerifyPeer> B<true>|B<false>
6394 Enable or disable peer SSL certificate verification. See
6395 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6397 =item B<VerifyHost> B<true|false>
6399 Enable or disable peer host name verification. If enabled, the plugin checks if
6400 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6401 matches the host name provided by the B<URL> option. If this identity check
6402 fails, the connection is aborted. Obviously, only works when connecting to a
6403 SSL enabled server. Enabled by default.
6405 =item B<CACert> I<File>
6407 File that holds one or more SSL certificates. If you want to use HTTPS you will
6408 possibly need this option. What CA certificates come bundled with C<libcurl>
6409 and are checked by default depends on the distribution you use.
6411 =item B<Format> B<Command>|B<JSON>
6413 Format of the output to generate. If set to B<Command>, will create output that
6414 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6415 create output in the I<JavaScript Object Notation> (JSON).
6417 Defaults to B<Command>.
6419 =item B<StoreRates> B<true|false>
6421 If set to B<true>, convert counter values to rates. If set to B<false> (the
6422 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6423 number.
6425 =back
6427 =head2 Plugin C<write_kafka>
6429 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6430 queue.
6431 Synopsis:
6433  <Plugin "write_kafka">
6434    Property "metadata.broker.list" "broker1:9092,broker2:9092"
6435    <Topic "collectd">
6436      Format JSON
6437    </Topic>
6438  </Plugin>
6440 The following options are understood by the I<write_kafka plugin>:
6442 =over 4
6444 =item E<lt>B<Topic> I<Name>E<gt>
6446 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6447 is given a unique I<Name> and specifies one kafka producer.
6448 Inside the B<Topic> block, the following per-topic options are
6449 understood:
6451 =over 4
6453 =item B<Property> I<String> I<String>
6455 Configure the named property for the current topic. Properties are
6456 forwarded to the kafka producer library B<librdkafka>.
6458 =item B<Key> I<String>
6460 Use the specified string as a partioning key for the topic. Kafka breaks
6461 topic into partitions and guarantees that for a given topology, the same
6462 consumer will be used for a specific key. The special (case insensitive)
6463 string B<Random> can be used to specify that an arbitrary partition should
6464 be used.
6466 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6468 Selects the format in which messages are sent to the broker. If set to
6469 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6470 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6472 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6473 an easy and straight forward exchange format.
6475 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6476 "<metric> <value> <timestamp>\n".
6478 =item B<StoreRates> B<true>|B<false>
6480 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6481 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6482 default), no conversion is performed. Otherwise the conversion is performed
6483 using the internal value cache.
6485 Please note that currently this option is only used if the B<Format> option has
6486 been set to B<JSON>.
6488 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6490 A prefix can be added in the metric name when outputting in the I<Graphite> format.
6491 It's added before the I<Host> name.
6492 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6494 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6496 A postfix can be added in the metric name when outputting in the I<Graphite> format.
6497 It's added after the I<Host> name.
6498 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6500 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6502 Specify a character to replace dots (.) in the host part of the metric name.
6503 In I<Graphite> metric name, dots are used as separators between different
6504 metric parts (host, plugin, type).
6505 Default is "_" (I<Underscore>).
6507 =item B<GraphiteSeparateInstances> B<false>|B<true>
6509 If set to B<true>, the plugin instance and type instance will be in their own
6510 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6511 default), the plugin and plugin instance (and likewise the type and type
6512 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6514 =item B<StoreRates> B<true>|B<false>
6516 If set to B<true> (the default), convert counter values to rates. If set to
6517 B<false> counter values are stored as is, i.e. as an increasing integer number.
6519 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6520 converted values will have "rate" appended to the data source type, e.g.
6521 C<ds_type:derive:rate>.
6523 =back
6525 =item B<Property> I<String> I<String>
6527 Configure the kafka producer through properties, you almost always will
6528 want to set B<metadata.broker.list> to your Kafka broker list.
6530 =back
6532 =head2 Plugin C<write_riemann>
6534 The I<write_riemann plugin> will send values to I<Riemann>, a powerfull stream
6535 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6536 I<Riemann> using UDP packets.
6538 Synopsis:
6540  <Plugin "write_riemann">
6541    <Node "example">
6542      Host "localhost"
6543      Port "5555"
6544      Protocol UDP
6545      StoreRates true
6546      AlwaysAppendDS false
6547      TTLFactor 2.0
6548    </Node>
6549    Tag "foobar"
6550    Attribute "foo" "bar"
6551  </Plugin>
6553 The following options are understood by the I<write_riemann plugin>:
6555 =over 4
6557 =item E<lt>B<Node> I<Name>E<gt>
6559 The plugin's configuration consists of one or more B<Node> blocks. Each block
6560 is given a unique I<Name> and specifies one connection to an instance of
6561 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6562 understood:
6564 =over 4
6566 =item B<Host> I<Address>
6568 Hostname or address to connect to. Defaults to C<localhost>.
6570 =item B<Port> I<Service>
6572 Service name or port number to connect to. Defaults to C<5555>.
6574 =item B<Protocol> B<UDP>|B<TCP>
6576 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6577 B<UDP>.
6579 =item B<StoreRates> B<true>|B<false>
6581 If set to B<true> (the default), convert counter values to rates. If set to
6582 B<false> counter values are stored as is, i.e. as an increasing integer number.
6584 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6585 converted values will have "rate" appended to the data source type, e.g.
6586 C<ds_type:derive:rate>.
6588 =item B<AlwaysAppendDS> B<false>|B<true>
6590 If set the B<true>, append the name of the I<Data Source> (DS) to the
6591 "service", i.e. the field that, together with the "host" field, uniquely
6592 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6593 only done when there is more than one DS.
6595 =item B<TTLFactor> I<Factor>
6597 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6598 event is considered active. I<collectd> populates this field based on the
6599 metrics interval setting. This setting controls the factor with which the
6600 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6601 know exactly what you're doing, you should only increase this setting from its
6602 default value.
6604 =item B<Notifications> B<false>|B<true>
6606 If set to B<true>, create riemann events for notifications. This is B<true>
6607 by default. When processing thresholds from write_riemann, it might prove
6608 useful to avoid getting notification events.
6610 =item B<CheckThresholds> B<false>|B<true>
6612 If set to B<true>, attach state to events based on thresholds defined
6613 in the B<Threshold> plugin. Defaults to B<false>.
6615 =back
6617 =item B<Tag> I<String>
6619 Add the given string as an additional tag to the metric being sent to
6620 I<Riemann>.
6622 =item B<Attribute> I<String> I<String>
6624 Consider the two given strings to be the key and value of an additional
6625 attribute for each metric being sent out to I<Riemann>.
6627 =back
6629 =head1 THRESHOLD CONFIGURATION
6631 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6632 we mean that the values are not only stored or sent somewhere, but that they
6633 are judged and, if a problem is recognized, acted upon. The only action
6634 collectd takes itself is to generate and dispatch a "notification". Plugins can
6635 register to receive notifications and perform appropriate further actions.
6637 Since systems and what you expect them to do differ a lot, you can configure
6638 B<thresholds> for your values freely. This gives you a lot of flexibility but
6639 also a lot of responsibility.
6641 Every time a value is out of range a notification is dispatched. This means
6642 that the idle percentage of your CPU needs to be less then the configured
6643 threshold only once for a notification to be generated. There's no such thing
6644 as a moving average or similar - at least not now.
6646 Also, all values that match a threshold are considered to be relevant or
6647 "interesting". As a consequence collectd will issue a notification if they are
6648 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6649 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6650 "2" (the default) and some hosts sends it's CPU statistics to the server every
6651 60 seconds, a notification will be dispatched after about 120 seconds. It may
6652 take a little longer because the timeout is checked only once each B<Interval>
6653 on the server.
6655 When a value comes within range again or is received after it was missing, an
6656 "OKAY-notification" is dispatched.
6658 Here is a configuration example to get you started. Read below for more
6659 information.
6661  <Plugin threshold>
6662    <Type "foo">
6663      WarningMin    0.00
6664      WarningMax 1000.00
6665      FailureMin    0.00
6666      FailureMax 1200.00
6667      Invert false
6668      Instance "bar"
6669    </Type>
6671    <Plugin "interface">
6672      Instance "eth0"
6673      <Type "if_octets">
6674        FailureMax 10000000
6675        DataSource "rx"
6676      </Type>
6677    </Plugin>
6679    <Host "hostname">
6680      <Type "cpu">
6681        Instance "idle"
6682        FailureMin 10
6683      </Type>
6685      <Plugin "memory">
6686        <Type "memory">
6687          Instance "cached"
6688          WarningMin 100000000
6689        </Type>
6690      </Plugin>
6691    </Host>
6692  </Plugin>
6694 There are basically two types of configuration statements: The C<Host>,
6695 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
6696 configured. The C<Plugin> and C<Type> blocks may be specified further using the
6697 C<Instance> option. You can combine the block by nesting the blocks, though
6698 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
6699 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
6700 C<Type> may not contain other blocks. If multiple blocks apply to the same
6701 value the most specific block is used.
6703 The other statements specify the threshold to configure. They B<must> be
6704 included in a C<Type> block. Currently the following statements are recognized:
6706 =over 4
6708 =item B<FailureMax> I<Value>
6710 =item B<WarningMax> I<Value>
6712 Sets the upper bound of acceptable values. If unset defaults to positive
6713 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
6714 will be created. If the value is greater than B<WarningMax> but less than (or
6715 equal to) B<FailureMax> a B<WARNING> notification will be created.
6717 =item B<FailureMin> I<Value>
6719 =item B<WarningMin> I<Value>
6721 Sets the lower bound of acceptable values. If unset defaults to negative
6722 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
6723 be created. If the value is less than B<WarningMin> but greater than (or equal
6724 to) B<FailureMin> a B<WARNING> notification will be created.
6726 =item B<DataSource> I<DSName>
6728 Some data sets have more than one "data source". Interesting examples are the
6729 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
6730 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
6731 system load data set, C<load>, even has three data sources: C<shortterm>,
6732 C<midterm>, and C<longterm>.
6734 Normally, all data sources are checked against a configured threshold. If this
6735 is undesirable, or if you want to specify different limits for each data
6736 source, you can use the B<DataSource> option to have a threshold apply only to
6737 one data source.
6739 =item B<Invert> B<true>|B<false>
6741 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
6742 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
6743 B<WarningMax>) are not okay. Defaults to B<false>.
6745 =item B<Persist> B<true>|B<false>
6747 Sets how often notifications are generated. If set to B<true> one notification
6748 will be generated for each value that is out of the acceptable range. If set to
6749 B<false> (the default) then a notification is only generated if a value is out
6750 of range but the previous value was okay.
6752 This applies to missing values, too: If set to B<true> a notification about a
6753 missing value is generated once every B<Interval> seconds. If set to B<false>
6754 only one such notification is generated until the value appears again.
6756 =item B<Percentage> B<true>|B<false>
6758 If set to B<true>, the minimum and maximum values given are interpreted as
6759 percentage value, relative to the other data sources. This is helpful for
6760 example for the "df" type, where you may want to issue a warning when less than
6761 5E<nbsp>% of the total space is available. Defaults to B<false>.
6763 =item B<Hits> I<Number>
6765 Delay creating the notification until the threshold has been passed I<Number>
6766 times. When a notification has been generated, or when a subsequent value is
6767 inside the threshold, the counter is reset. If, for example, a value is
6768 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
6769 will be dispatched at most once every 30E<nbsp>seconds.
6771 This is useful when short bursts are not a problem. If, for example, 100% CPU
6772 usage for up to a minute is normal (and data is collected every
6773 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
6775 =item B<Hysteresis> I<Number>
6777 When set to non-zero, a hysteresis value is applied when checking minimum and
6778 maximum bounds. This is useful for values that increase slowly and fluctuate a
6779 bit while doing so. When these values come close to the threshold, they may
6780 "flap", i.e. switch between failure / warning case and okay case repeatedly.
6782 If, for example, the threshold is configures as
6784   WarningMax 100.0
6785   Hysteresis 1.0
6787 then a I<Warning> notification is created when the value exceeds I<101> and the
6788 corresponding I<Okay> notification is only created once the value falls below
6789 I<99>, thus avoiding the "flapping".
6791 =back
6793 =head1 FILTER CONFIGURATION
6795 Starting with collectd 4.6 there is a powerful filtering infrastructure
6796 implemented in the daemon. The concept has mostly been copied from
6797 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
6798 terminology, so that users that are familiar with iptables feel right at home.
6800 =head2 Terminology
6802 The following are the terms used in the remainder of the filter configuration
6803 documentation. For an ASCII-art schema of the mechanism, see
6804 L<"General structure"> below.
6806 =over 4
6808 =item B<Match>
6810 A I<match> is a criteria to select specific values. Examples are, of course, the
6811 name of the value or it's current value.
6813 Matches are implemented in plugins which you have to load prior to using the
6814 match. The name of such plugins starts with the "match_" prefix.
6816 =item B<Target>
6818 A I<target> is some action that is to be performed with data. Such actions
6819 could, for example, be to change part of the value's identifier or to ignore
6820 the value completely.
6822 Some of these targets are built into the daemon, see L<"Built-in targets">
6823 below. Other targets are implemented in plugins which you have to load prior to
6824 using the target. The name of such plugins starts with the "target_" prefix.
6826 =item B<Rule>
6828 The combination of any number of matches and at least one target is called a
6829 I<rule>. The target actions will be performed for all values for which B<all>
6830 matches apply. If the rule does not have any matches associated with it, the
6831 target action will be performed for all values.
6833 =item B<Chain>
6835 A I<chain> is a list of rules and possibly default targets. The rules are tried
6836 in order and if one matches, the associated target will be called. If a value
6837 is handled by a rule, it depends on the target whether or not any subsequent
6838 rules are considered or if traversal of the chain is aborted, see
6839 L<"Flow control"> below. After all rules have been checked, the default targets
6840 will be executed.
6842 =back
6844 =head2 General structure
6846 The following shows the resulting structure:
6848  +---------+
6849  ! Chain   !
6850  +---------+
6851       !
6852       V
6853  +---------+  +---------+  +---------+  +---------+
6854  ! Rule    !->! Match   !->! Match   !->! Target  !
6855  +---------+  +---------+  +---------+  +---------+
6856       !
6857       V
6858  +---------+  +---------+  +---------+
6859  ! Rule    !->! Target  !->! Target  !
6860  +---------+  +---------+  +---------+
6861       !
6862       V
6863       :
6864       :
6865       !
6866       V
6867  +---------+  +---------+  +---------+
6868  ! Rule    !->! Match   !->! Target  !
6869  +---------+  +---------+  +---------+
6870       !
6871       V
6872  +---------+
6873  ! Default !
6874  ! Target  !
6875  +---------+
6877 =head2 Flow control
6879 There are four ways to control which way a value takes through the filter
6880 mechanism:
6882 =over 4
6884 =item B<jump>
6886 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
6887 process the value with another chain. When the called chain finishes, usually
6888 the next target or rule after the jump is executed.
6890 =item B<stop>
6892 The stop condition, signaled for example by the built-in target B<stop>, causes
6893 all processing of the value to be stopped immediately.
6895 =item B<return>
6897 Causes processing in the current chain to be aborted, but processing of the
6898 value generally will continue. This means that if the chain was called via
6899 B<Jump>, the next target or rule after the jump will be executed. If the chain
6900 was not called by another chain, control will be returned to the daemon and it
6901 may pass the value to another chain.
6903 =item B<continue>
6905 Most targets will signal the B<continue> condition, meaning that processing
6906 should continue normally. There is no special built-in target for this
6907 condition.
6909 =back
6911 =head2 Synopsis
6913 The configuration reflects this structure directly:
6915  PostCacheChain "PostCache"
6916  <Chain "PostCache">
6917    <Rule "ignore_mysql_show">
6918      <Match "regex">
6919        Plugin "^mysql$"
6920        Type "^mysql_command$"
6921        TypeInstance "^show_"
6922      </Match>
6923      <Target "stop">
6924      </Target>
6925    </Rule>
6926    <Target "write">
6927      Plugin "rrdtool"
6928    </Target>
6929  </Chain>
6931 The above configuration example will ignore all values where the plugin field
6932 is "mysql", the type is "mysql_command" and the type instance begins with
6933 "show_". All other values will be sent to the C<rrdtool> write plugin via the
6934 default target of the chain. Since this chain is run after the value has been
6935 added to the cache, the MySQL C<show_*> command statistics will be available
6936 via the C<unixsock> plugin.
6938 =head2 List of configuration options
6940 =over 4
6942 =item B<PreCacheChain> I<ChainName>
6944 =item B<PostCacheChain> I<ChainName>
6946 Configure the name of the "pre-cache chain" and the "post-cache chain". The
6947 argument is the name of a I<chain> that should be executed before and/or after
6948 the values have been added to the cache.
6950 To understand the implications, it's important you know what is going on inside
6951 I<collectd>. The following diagram shows how values are passed from the
6952 read-plugins to the write-plugins:
6954    +---------------+
6955    !  Read-Plugin  !
6956    +-------+-------+
6957            !
6958  + - - - - V - - - - +
6959  : +---------------+ :
6960  : !   Pre-Cache   ! :
6961  : !     Chain     ! :
6962  : +-------+-------+ :
6963  :         !         :
6964  :         V         :
6965  : +-------+-------+ :  +---------------+
6966  : !     Cache     !--->!  Value Cache  !
6967  : !     insert    ! :  +---+---+-------+
6968  : +-------+-------+ :      !   !
6969  :         !   ,------------'   !
6970  :         V   V     :          V
6971  : +-------+---+---+ :  +-------+-------+
6972  : !  Post-Cache   +--->! Write-Plugins !
6973  : !     Chain     ! :  +---------------+
6974  : +---------------+ :
6975  :                   :
6976  :  dispatch values  :
6977  + - - - - - - - - - +
6979 After the values are passed from the "read" plugins to the dispatch functions,
6980 the pre-cache chain is run first. The values are added to the internal cache
6981 afterwards. The post-cache chain is run after the values have been added to the
6982 cache. So why is it such a huge deal if chains are run before or after the
6983 values have been added to this cache?
6985 Targets that change the identifier of a value list should be executed before
6986 the values are added to the cache, so that the name in the cache matches the
6987 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
6988 this cache to receive a list of all available values. If you change the
6989 identifier after the value list has been added to the cache, this may easily
6990 lead to confusion, but it's not forbidden of course.
6992 The cache is also used to convert counter values to rates. These rates are, for
6993 example, used by the C<value> match (see below). If you use the rate stored in
6994 the cache B<before> the new value is added, you will use the old, B<previous>
6995 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
6996 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
6997 command.
6999 Last but not last, the B<stop> target makes a difference: If the pre-cache
7000 chain returns the stop condition, the value will not be added to the cache and
7001 the post-cache chain will not be run.
7003 =item B<Chain> I<Name>
7005 Adds a new chain with a certain name. This name can be used to refer to a
7006 specific chain, for example to jump to it.
7008 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7010 =item B<Rule> [I<Name>]
7012 Adds a new rule to the current chain. The name of the rule is optional and
7013 currently has no meaning for the daemon.
7015 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7016 must be at least one B<Target> block.
7018 =item B<Match> I<Name>
7020 Adds a match to a B<Rule> block. The name specifies what kind of match should
7021 be performed. Available matches depend on the plugins that have been loaded.
7023 The arguments inside the B<Match> block are passed to the plugin implementing
7024 the match, so which arguments are valid here depends on the plugin being used.
7025 If you do not need any to pass any arguments to a match, you can use the
7026 shorter syntax:
7028  Match "foobar"
7030 Which is equivalent to:
7032  <Match "foobar">
7033  </Match>
7035 =item B<Target> I<Name>
7037 Add a target to a rule or a default target to a chain. The name specifies what
7038 kind of target is to be added. Which targets are available depends on the
7039 plugins being loaded.
7041 The arguments inside the B<Target> block are passed to the plugin implementing
7042 the target, so which arguments are valid here depends on the plugin being used.
7043 If you do not need any to pass any arguments to a target, you can use the
7044 shorter syntax:
7046  Target "stop"
7048 This is the same as writing:
7050  <Target "stop">
7051  </Target>
7053 =back
7055 =head2 Built-in targets
7057 The following targets are built into the core daemon and therefore need no
7058 plugins to be loaded:
7060 =over 4
7062 =item B<return>
7064 Signals the "return" condition, see the L<"Flow control"> section above. This
7065 causes the current chain to stop processing the value and returns control to
7066 the calling chain. The calling chain will continue processing targets and rules
7067 just after the B<jump> target (see below). This is very similar to the
7068 B<RETURN> target of iptables, see L<iptables(8)>.
7070 This target does not have any options.
7072 Example:
7074  Target "return"
7076 =item B<stop>
7078 Signals the "stop" condition, see the L<"Flow control"> section above. This
7079 causes processing of the value to be aborted immediately. This is similar to
7080 the B<DROP> target of iptables, see L<iptables(8)>.
7082 This target does not have any options.
7084 Example:
7086  Target "stop"
7088 =item B<write>
7090 Sends the value to "write" plugins.
7092 Available options:
7094 =over 4
7096 =item B<Plugin> I<Name>
7098 Name of the write plugin to which the data should be sent. This option may be
7099 given multiple times to send the data to more than one write plugin.
7101 =back
7103 If no plugin is explicitly specified, the values will be sent to all available
7104 write plugins.
7106 Example:
7108  <Target "write">
7109    Plugin "rrdtool"
7110  </Target>
7112 =item B<jump>
7114 Starts processing the rules of another chain, see L<"Flow control"> above. If
7115 the end of that chain is reached, or a stop condition is encountered,
7116 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7117 next target or the next rule. This is similar to the B<-j> command line option
7118 of iptables, see L<iptables(8)>.
7120 Available options:
7122 =over 4
7124 =item B<Chain> I<Name>
7126 Jumps to the chain I<Name>. This argument is required and may appear only once.
7128 =back
7130 Example:
7132  <Target "jump">
7133    Chain "foobar"
7134  </Target>
7136 =back
7138 =head2 Available matches
7140 =over 4
7142 =item B<regex>
7144 Matches a value using regular expressions.
7146 Available options:
7148 =over 4
7150 =item B<Host> I<Regex>
7152 =item B<Plugin> I<Regex>
7154 =item B<PluginInstance> I<Regex>
7156 =item B<Type> I<Regex>
7158 =item B<TypeInstance> I<Regex>
7160 Match values where the given regular expressions match the various fields of
7161 the identifier of a value. If multiple regular expressions are given, B<all>
7162 regexen must match for a value to match.
7164 =item B<Invert> B<false>|B<true>
7166 When set to B<true>, the result of the match is inverted, i.e. all value lists
7167 where all regular expressions apply are not matched, all other value lists are
7168 matched. Defaults to B<false>.
7170 =back
7172 Example:
7174  <Match "regex">
7175    Host "customer[0-9]+"
7176    Plugin "^foobar$"
7177  </Match>
7179 =item B<timediff>
7181 Matches values that have a time which differs from the time on the server.
7183 This match is mainly intended for servers that receive values over the
7184 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7185 is very sensitive to the timestamp used when updating the RRD files. In
7186 particular, the time must be ever increasing. If a misbehaving client sends one
7187 packet with a timestamp far in the future, all further packets with a correct
7188 time will be ignored because of that one packet. What's worse, such corrupted
7189 RRD files are hard to fix.
7191 This match lets one match all values B<outside> a specified time range
7192 (relative to the server's time), so you can use the B<stop> target (see below)
7193 to ignore the value, for example.
7195 Available options:
7197 =over 4
7199 =item B<Future> I<Seconds>
7201 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7202 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7203 non-zero.
7205 =item B<Past> I<Seconds>
7207 Matches all values that are I<behind> of the server's time by I<Seconds> or
7208 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7209 non-zero.
7211 =back
7213 Example:
7215  <Match "timediff">
7216    Future  300
7217    Past   3600
7218  </Match>
7220 This example matches all values that are five minutes or more ahead of the
7221 server or one hour (or more) lagging behind.
7223 =item B<value>
7225 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7226 values. If a data-set consists of more than one data-source, all data-sources
7227 must match the specified ranges for a positive match.
7229 Available options:
7231 =over 4
7233 =item B<Min> I<Value>
7235 Sets the smallest value which still results in a match. If unset, behaves like
7236 negative infinity.
7238 =item B<Max> I<Value>
7240 Sets the largest value which still results in a match. If unset, behaves like
7241 positive infinity.
7243 =item B<Invert> B<true>|B<false>
7245 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7246 no-match is returned and vice versa. Please note that the B<Invert> setting
7247 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7248 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7250 =item B<DataSource> I<DSName> [I<DSName> ...]
7252 Select one or more of the data sources. If no data source is configured, all
7253 data sources will be checked. If the type handled by the match does not have a
7254 data source of the specified name(s), this will always result in no match
7255 (independent of the B<Invert> setting).
7257 =item B<Satisfy> B<Any>|B<All>
7259 Specifies how checking with several data sources is performed. If set to
7260 B<Any>, the match succeeds if one of the data sources is in the configured
7261 range. If set to B<All> the match only succeeds if all data sources are within
7262 the configured range. Default is B<All>.
7264 Usually B<All> is used for positive matches, B<Any> is used for negative
7265 matches. This means that with B<All> you usually check that all values are in a
7266 "good" range, while with B<Any> you check if any value is within a "bad" range
7267 (or outside the "good" range).
7269 =back
7271 Either B<Min> or B<Max>, but not both, may be unset.
7273 Example:
7275  # Match all values smaller than or equal to 100. Matches only if all data
7276  # sources are below 100.
7277  <Match "value">
7278    Max 100
7279    Satisfy "All"
7280  </Match>
7282  # Match if the value of any data source is outside the range of 0 - 100.
7283  <Match "value">
7284    Min   0
7285    Max 100
7286    Invert true
7287    Satisfy "Any"
7288  </Match>
7290 =item B<empty_counter>
7292 Matches all values with one or more data sources of type B<COUNTER> and where
7293 all counter values are zero. These counters usually I<never> increased since
7294 they started existing (and are therefore uninteresting), or got reset recently
7295 or overflowed and you had really, I<really> bad luck.
7297 Please keep in mind that ignoring such counters can result in confusing
7298 behavior: Counters which hardly ever increase will be zero for long periods of
7299 time. If the counter is reset for some reason (machine or service restarted,
7300 usually), the graph will be empty (NAN) for a long time. People may not
7301 understand why.
7303 =item B<hashed>
7305 Calculates a hash value of the host name and matches values according to that
7306 hash value. This makes it possible to divide all hosts into groups and match
7307 only values that are in a specific group. The intended use is in load
7308 balancing, where you want to handle only part of all data and leave the rest
7309 for other servers.
7311 The hashing function used tries to distribute the hosts evenly. First, it
7312 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7314   hash_value = 0;
7315   for (i = 0; host[i] != 0; i++)
7316     hash_value = (hash_value * 251) + host[i];
7318 The constant 251 is a prime number which is supposed to make this hash value
7319 more random. The code then checks the group for this host according to the
7320 I<Total> and I<Match> arguments:
7322   if ((hash_value % Total) == Match)
7323     matches;
7324   else
7325     does not match;
7327 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7328 groups), then the least significant bit of the hash value will be the XOR of
7329 all least significant bits in the host name. One consequence is that when you
7330 have two hosts, "server0.example.com" and "server1.example.com", where the host
7331 name differs in one digit only and the digits differ by one, those hosts will
7332 never end up in the same group.
7334 Available options:
7336 =over 4
7338 =item B<Match> I<Match> I<Total>
7340 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7341 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7342 be smaller than I<Total>. I<Total> must be at least one, although only values
7343 greater than one really do make any sense.
7345 You can repeat this option to match multiple groups, for example:
7347   Match 3 7
7348   Match 5 7
7350 The above config will divide the data into seven groups and match groups three
7351 and five. One use would be to keep every value on two hosts so that if one
7352 fails the missing data can later be reconstructed from the second host.
7354 =back
7356 Example:
7358  # Operate on the pre-cache chain, so that ignored values are not even in the
7359  # global cache.
7360  <Chain "PreCache">
7361    <Rule>
7362      <Match "hashed">
7363        # Divide all received hosts in seven groups and accept all hosts in
7364        # group three.
7365        Match 3 7
7366      </Match>
7367      # If matched: Return and continue.
7368      Target "return"
7369    </Rule>
7370    # If not matched: Return and stop.
7371    Target "stop"
7372  </Chain>
7374 =back
7376 =head2 Available targets
7378 =over 4
7380 =item B<notification>
7382 Creates and dispatches a notification.
7384 Available options:
7386 =over 4
7388 =item B<Message> I<String>
7390 This required option sets the message of the notification. The following
7391 placeholders will be replaced by an appropriate value:
7393 =over 4
7395 =item B<%{host}>
7397 =item B<%{plugin}>
7399 =item B<%{plugin_instance}>
7401 =item B<%{type}>
7403 =item B<%{type_instance}>
7405 These placeholders are replaced by the identifier field of the same name.
7407 =item B<%{ds:>I<name>B<}>
7409 These placeholders are replaced by a (hopefully) human readable representation
7410 of the current rate of this data source. If you changed the instance name
7411 (using the B<set> or B<replace> targets, see below), it may not be possible to
7412 convert counter values to rates.
7414 =back
7416 Please note that these placeholders are B<case sensitive>!
7418 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7420 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7421 used.
7423 =back
7425 Example:
7427   <Target "notification">
7428     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7429     Severity "WARNING"
7430   </Target>
7432 =item B<replace>
7434 Replaces parts of the identifier using regular expressions.
7436 Available options:
7438 =over 4
7440 =item B<Host> I<Regex> I<Replacement>
7442 =item B<Plugin> I<Regex> I<Replacement>
7444 =item B<PluginInstance> I<Regex> I<Replacement>
7446 =item B<TypeInstance> I<Regex> I<Replacement>
7448 Match the appropriate field with the given regular expression I<Regex>. If the
7449 regular expression matches, that part that matches is replaced with
7450 I<Replacement>. If multiple places of the input buffer match a given regular
7451 expression, only the first occurrence will be replaced.
7453 You can specify each option multiple times to use multiple regular expressions
7454 one after another.
7456 =back
7458 Example:
7460  <Target "replace">
7461    # Replace "example.net" with "example.com"
7462    Host "\\<example.net\\>" "example.com"
7464    # Strip "www." from hostnames
7465    Host "\\<www\\." ""
7466  </Target>
7468 =item B<set>
7470 Sets part of the identifier of a value to a given string.
7472 Available options:
7474 =over 4
7476 =item B<Host> I<String>
7478 =item B<Plugin> I<String>
7480 =item B<PluginInstance> I<String>
7482 =item B<TypeInstance> I<String>
7484 Set the appropriate field to the given string. The strings for plugin instance
7485 and type instance may be empty, the strings for host and plugin may not be
7486 empty. It's currently not possible to set the type of a value this way.
7488 =back
7490 Example:
7492  <Target "set">
7493    PluginInstance "coretemp"
7494    TypeInstance "core3"
7495  </Target>
7497 =back
7499 =head2 Backwards compatibility
7501 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7502 B<Chain> block, it will behave as it used to. This is equivalent to the
7503 following configuration:
7505  <Chain "PostCache">
7506    Target "write"
7507  </Chain>
7509 If you specify a B<PostCacheChain>, the B<write> target will not be added
7510 anywhere and you will have to make sure that it is called where appropriate. We
7511 suggest to add the above snippet as default target to your "PostCache" chain.
7513 =head2 Examples
7515 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7516 be an FQDN.
7518  <Chain "PreCache">
7519    <Rule "no_fqdn">
7520      <Match "regex">
7521        Host "^[^\.]*$"
7522      </Match>
7523      Target "stop"
7524    </Rule>
7525    Target "write"
7526  </Chain>
7528 =head1 SEE ALSO
7530 L<collectd(1)>,
7531 L<collectd-exec(5)>,
7532 L<collectd-perl(5)>,
7533 L<collectd-unixsock(5)>,
7534 L<types.db(5)>,
7535 L<hddtemp(8)>,
7536 L<iptables(8)>,
7537 L<kstat(3KSTAT)>,
7538 L<mbmon(1)>,
7539 L<psql(1)>,
7540 L<regex(7)>,
7541 L<rrdtool(1)>,
7542 L<sensors(1)>
7544 =head1 AUTHOR
7546 Florian Forster E<lt>octo@verplant.orgE<gt>
7548 =cut