Code

curl_json plugin: len is unsigned
[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 "/var/lib/collectd"
10   PIDFile "/run/collectd.pid"
11   Interval 10.0
13   LoadPlugin cpu
14   LoadPlugin load
16   <LoadPlugin df>
17     Interval 3600
18   </LoadPlugin>
19   <Plugin df>
20     ValuesPercentage true
21   </Plugin>
23   LoadPlugin ping
24   <Plugin ping>
25     Host "example.org"
26     Host "provider.net"
27   </Plugin>
29 =head1 DESCRIPTION
31 This config file controls how the system statistics collection daemon
32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
33 controls which plugins to load. These plugins ultimately define collectd's
34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
38 The syntax of this config file is similar to the config file of the famous
39 I<Apache> webserver. Each line contains either an option (a key and a list of
40 one or more values) or a section-start or -end. Empty lines and everything
41 after a non-quoted hash-symbol (C<#>) are ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
54 Lines may be wrapped by using C<\> as the last character before the newline.
55 This allows long lines to be split into multiple lines. Quoted strings may be
56 wrapped as well. However, those are treated special in that whitespace at the
57 beginning of the following lines will be ignored, which allows for nicely
58 indenting the wrapped lines.
60 The configuration is read and processed in order, i.e. from top to bottom. So
61 the plugins are loaded in the order listed in this config file. It is a good
62 idea to load any logging plugins first in order to catch messages from plugins
63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
64 B<LoadPlugin> option I<must> occur I<before> the appropriate
65 C<E<lt>B<Plugin> ...E<gt>> block.
67 =head1 GLOBAL OPTIONS
69 =over 4
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath which all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
77 =item B<LoadPlugin> I<Plugin>
79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
81 I<collectd> will be mostly useless.
83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
84 effect. This is useful when you want to split up the configuration into smaller
85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
86 block I<and> the appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
93 statement looks like this:
95  LoadPlugin "cpu"
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
100  <LoadPlugin perl>
101    Interval 60
102  </LoadPlugin>
104 The following options are valid inside B<LoadPlugin> blocks:
106 =over 4
108 =item B<Globals> B<true|false>
110 If enabled, collectd will export all global symbols of the plugin (and of all
111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
112 available for resolving unresolved symbols in subsequently loaded plugins if
113 that is supported by your system.
115 This is useful (or possibly even required), e.g., when loading a plugin that
116 embeds some scripting language into the daemon (e.g. the I<Perl> and
117 I<Python plugins>). Scripting languages usually provide means to load
118 extensions written in C. Those extensions require symbols provided by the
119 interpreter, which is loaded as a dependency of the respective collectd plugin.
120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
121 L<collectd-python(5)>) for details.
123 By default, this is disabled. As a special exception, if the plugin name is
124 either C<perl> or C<python>, the default is changed to enabled in order to keep
125 the average user from ever having to deal with this low level linking stuff.
127 =item B<Interval> I<Seconds>
129 Sets a plugin-specific interval for collecting metrics. This overrides the
130 global B<Interval> setting. If a plugin provides its own support for specifying
131 an interval, that setting will take precedence.
133 =item B<FlushInterval> I<Seconds>
135 Specifies the interval, in seconds, to call the flush callback if it's
136 defined in this plugin. By default, this is disabled.
138 =item B<FlushTimeout> I<Seconds>
140 Specifies the value of the timeout argument of the flush callback.
142 =back
144 =item B<AutoLoadPlugin> B<false>|B<true>
146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
147 using the B<LoadPlugin> statement documented above. If a
148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
149 handling callback for this plugin has been registered, a warning is logged and
150 the block is ignored.
152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
157 =item B<CollectInternalStats> B<false>|B<true>
159 When set to B<true>, various statistics about the I<collectd> daemon will be
160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
162 The following metrics are reported:
164 =over 4
166 =item C<collectd-write_queue/queue_length>
168 The number of metrics currently in the write queue. You can limit the queue
169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
171 =item C<collectd-write_queue/derive-dropped>
173 The number of metrics dropped due to a queue length limitation.
174 If this value is non-zero, your system can't handle all incoming metrics and
175 protects itself against overload by dropping metrics.
177 =item C<collectd-cache/cache_size>
179 The number of elements in the metric cache (the cache you can interact with
180 using L<collectd-unixsock(5)>).
182 =back
184 =item B<Include> I<Path> [I<pattern>]
186 If I<Path> points to a file, includes that file. If I<Path> points to a
187 directory, recursively includes all files within that directory and its
188 subdirectories. If the C<wordexp> function is available on your system,
189 shell-like wildcards are expanded before files are included. This means you can
190 use statements like the following:
192   Include "/etc/collectd.d/*.conf"
194 Starting with version 5.3, this may also be a block in which further options
195 affecting the behavior of B<Include> may be specified. The following option is
196 currently allowed:
198   <Include "/etc/collectd.d">
199     Filter "*.conf"
200   </Include>
202 =over 4
204 =item B<Filter> I<pattern>
206 If the C<fnmatch> function is available on your system, a shell-like wildcard
207 I<pattern> may be specified to filter which files to include. This may be used
208 in combination with recursively including a directory to easily be able to
209 arbitrarily mix configuration files and other documents (e.g. README files).
210 The given example is similar to the first example above but includes all files
211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
213 =back
215 If more than one file is included by a single B<Include> option, the files
216 will be included in lexicographical order (as defined by the C<strcmp>
217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
218 order in which the files are loaded.
220 To prevent loops and shooting yourself in the foot in interesting ways the
221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
222 most uses. Since symlinks are followed it is still possible to crash the daemon
223 by looping symlinks. In our opinion significant stupidity should result in an
224 appropriate amount of pain.
226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
227 file, but you cannot include files from within blocks.
229 =item B<PIDFile> I<File>
231 Sets where to write the PID file to. This file is overwritten when it exists
232 and deleted when the program is stopped. Some init-scripts might override this
233 setting using the B<-P> command-line option.
235 =item B<PluginDir> I<Directory>
237 Path to the plugins (shared objects) of collectd.
239 =item B<TypesDB> I<File> [I<File> ...]
241 Set one or more files that contain the data-set descriptions. See
242 L<types.db(5)> for a description of the format of this file.
244 =item B<Interval> I<Seconds>
246 Configures the interval in which to query the read plugins. Obviously smaller
247 values lead to a higher system load produced by collectd, while higher values
248 lead to more coarse statistics.
250 B<Warning:> You should set this once and then never touch it again. If you do,
251 I<you will have to delete all your RRD files> or know some serious RRDtool
252 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
254 =item B<MaxReadInterval> I<Seconds>
256 A read plugin doubles the interval between queries after each failed attempt
257 to get data.
259 This options limits the maximum value of the interval. The default value is
260 B<86400>.
262 =item B<Timeout> I<Iterations>
264 Consider a value list "missing" when no update has been read or received for
265 I<Iterations> iterations. By default, I<collectd> considers a value list
266 missing when no update has been received for twice the update interval. Since
267 this setting uses iterations, the maximum allowed time without update depends
268 on the I<Interval> information contained in each value list. This is used in
269 the I<Threshold> configuration to dispatch notifications about missing values,
270 see L<collectd-threshold(5)> for details.
272 =item B<ReadThreads> I<Num>
274 Number of threads to start for reading plugins. The default value is B<5>, but
275 you may want to increase this if you have more than five plugins that take a
276 long time to read. Mostly those are plugins that do network-IO. Setting this to
277 a value higher than the number of registered read callbacks is not recommended.
279 =item B<WriteThreads> I<Num>
281 Number of threads to start for dispatching value lists to write plugins. The
282 default value is B<5>, but you may want to increase this if you have more than
283 five plugins that may take relatively long to write to.
285 =item B<WriteQueueLimitHigh> I<HighNum>
287 =item B<WriteQueueLimitLow> I<LowNum>
289 Metrics are read by the I<read threads> and then put into a queue to be handled
290 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
291 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
292 running into memory issues in such a case, you can limit the size of this
293 queue.
295 By default, there is no limit and memory may grow indefinitely. This is most
296 likely not an issue for clients, i.e. instances that only handle the local
297 metrics. For servers it is recommended to set this to a non-zero value, though.
299 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
300 Each of them takes a numerical argument which is the number of metrics in the
301 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
302 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
303 I<will> be enqueued. If the number of metrics currently in the queue is between
304 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
305 proportional to the number of metrics in the queue (i.e. it increases linearly
306 until it reaches 100%.)
308 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
309 unset, the latter will default to half of B<WriteQueueLimitHigh>.
311 If you do not want to randomly drop values when the queue size is between
312 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
313 to the same value.
315 Enabling the B<CollectInternalStats> option is of great help to figure out the
316 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
318 =item B<Hostname> I<Name>
320 Sets the hostname that identifies a host. If you omit this setting, the
321 hostname will be determined using the L<gethostname(2)> system call.
323 =item B<FQDNLookup> B<true|false>
325 If B<Hostname> is determined automatically this setting controls whether or not
326 the daemon should try to figure out the "fully qualified domain name", FQDN.
327 This is done using a lookup of the name returned by C<gethostname>. This option
328 is enabled by default.
330 =item B<PreCacheChain> I<ChainName>
332 =item B<PostCacheChain> I<ChainName>
334 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
335 see L<FILTER CONFIGURATION> below on information on chains and how these
336 setting change the daemon's behavior.
338 =back
340 =head1 PLUGIN OPTIONS
342 Some plugins may register own options. These options must be enclosed in a
343 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
344 require external configuration, too. The C<apache plugin>, for example,
345 required C<mod_status> to be configured in the webserver you're going to
346 collect data from. These plugins are listed below as well, even if they don't
347 require any configuration within collectd's configuration file.
349 A list of all plugins and a short summary for each plugin can be found in the
350 F<README> file shipped with the sourcecode and hopefully binary packets as
351 well.
353 =head2 Plugin C<aggregation>
355 The I<Aggregation plugin> makes it possible to aggregate several values into
356 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
357 This can be put to a wide variety of uses, e.g. average and total CPU
358 statistics for your entire fleet.
360 The grouping is powerful but, as with many powerful tools, may be a bit
361 difficult to wrap your head around. The grouping will therefore be
362 demonstrated using an example: The average and sum of the CPU usage across
363 all CPUs of each host is to be calculated.
365 To select all the affected values for our example, set C<Plugin cpu> and
366 C<Type cpu>. The other values are left unspecified, meaning "all values". The
367 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
368 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
369 statement.
371   Plugin "cpu"
372   Type "cpu"
374 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...)  and
375 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
376 example, the intention is to have a new value for each host / type instance
377 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
378 It can be specified multiple times to group by more than one field.
380   GroupBy "Host"
381   GroupBy "TypeInstance"
383 We do neither specify nor group by I<plugin instance> (the CPU number), so all
384 metrics that differ in the CPU number only will be aggregated. Each
385 aggregation needs I<at least one> such field, otherwise no aggregation would
386 take place.
388 The full example configuration looks like this:
390  <Plugin "aggregation">
391    <Aggregation>
392      Plugin "cpu"
393      Type "cpu"
395      GroupBy "Host"
396      GroupBy "TypeInstance"
398      CalculateSum true
399      CalculateAverage true
400    </Aggregation>
401  </Plugin>
403 There are a couple of limitations you should be aware of:
405 =over 4
407 =item
409 The I<Type> cannot be left unspecified, because it is not reasonable to add
410 apples to oranges. Also, the internal lookup structure won't work if you try
411 to group by type.
413 =item
415 There must be at least one unspecified, ungrouped field. Otherwise nothing
416 will be aggregated.
418 =back
420 As you can see in the example above, each aggregation has its own
421 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
422 blocks may match the same values, i.e. one value list can update multiple
423 aggregations. The following options are valid inside B<Aggregation> blocks:
425 =over 4
427 =item B<Host> I<Host>
429 =item B<Plugin> I<Plugin>
431 =item B<PluginInstance> I<PluginInstance>
433 =item B<Type> I<Type>
435 =item B<TypeInstance> I<TypeInstance>
437 Selects the value lists to be added to this aggregation. B<Type> must be a
438 valid data set name, see L<types.db(5)> for details.
440 If the string starts with and ends with a slash (C</>), the string is
441 interpreted as a I<regular expression>. The regex flavor used are POSIX
442 extended regular expressions as described in L<regex(7)>. Example usage:
444  Host "/^db[0-9]\\.example\\.com$/"
446 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
448 Group valued by the specified field. The B<GroupBy> option may be repeated to
449 group by multiple fields.
451 =item B<SetHost> I<Host>
453 =item B<SetPlugin> I<Plugin>
455 =item B<SetPluginInstance> I<PluginInstance>
457 =item B<SetTypeInstance> I<TypeInstance>
459 Sets the appropriate part of the identifier to the provided string.
461 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
462 will be replaced with the aggregation function, e.g. "average". Not including
463 the placeholder will result in duplication warnings and/or messed up values if
464 more than one aggregation function are enabled.
466 The following example calculates the average usage of all "even" CPUs:
468  <Plugin "aggregation">
469    <Aggregation>
470      Plugin "cpu"
471      PluginInstance "/[0,2,4,6,8]$/"
472      Type "cpu"
474      SetPlugin "cpu"
475      SetPluginInstance "even-%{aggregation}"
477      GroupBy "Host"
478      GroupBy "TypeInstance"
480      CalculateAverage true
481    </Aggregation>
482  </Plugin>
484 This will create the files:
486 =over 4
488 =item
490 foo.example.com/cpu-even-average/cpu-idle
492 =item
494 foo.example.com/cpu-even-average/cpu-system
496 =item
498 foo.example.com/cpu-even-average/cpu-user
500 =item
502 ...
504 =back
506 =item B<CalculateNum> B<true>|B<false>
508 =item B<CalculateSum> B<true>|B<false>
510 =item B<CalculateAverage> B<true>|B<false>
512 =item B<CalculateMinimum> B<true>|B<false>
514 =item B<CalculateMaximum> B<true>|B<false>
516 =item B<CalculateStddev> B<true>|B<false>
518 Boolean options for enabling calculation of the number of value lists, their
519 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
520 are disabled by default.
522 =back
524 =head2 Plugin C<amqp>
526 The I<AMQP plugin> can be used to communicate with other instances of
527 I<collectd> or third party applications using an AMQP message broker. Values
528 are sent to or received from the broker, which handles routing, queueing and
529 possibly filtering out messages.
531 B<Synopsis:>
533  <Plugin "amqp">
534    # Send values to an AMQP broker
535    <Publish "some_name">
536      Host "localhost"
537      Port "5672"
538      VHost "/"
539      User "guest"
540      Password "guest"
541      Exchange "amq.fanout"
542  #   ExchangeType "fanout"
543  #   RoutingKey "collectd"
544  #   Persistent false
545  #   ConnectionRetryDelay 0
546  #   Format "command"
547  #   StoreRates false
548  #   GraphitePrefix "collectd."
549  #   GraphiteEscapeChar "_"
550  #   GraphiteSeparateInstances false
551  #   GraphiteAlwaysAppendDS false
552    </Publish>
554    # Receive values from an AMQP broker
555    <Subscribe "some_name">
556      Host "localhost"
557      Port "5672"
558      VHost "/"
559      User "guest"
560      Password "guest"
561      Exchange "amq.fanout"
562  #   ExchangeType "fanout"
563  #   Queue "queue_name"
564  #   QueueDurable false
565  #   QueueAutoDelete true
566  #   RoutingKey "collectd.#"
567  #   ConnectionRetryDelay 0
568    </Subscribe>
569  </Plugin>
571 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
572 blocks, which configure sending and receiving of values respectively. The two
573 blocks are very similar, so unless otherwise noted, an option can be used in
574 either block. The name given in the blocks starting tag is only used for
575 reporting messages, but may be used to support I<flushing> of certain
576 I<Publish> blocks in the future.
578 =over 4
580 =item B<Host> I<Host>
582 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
583 the underlying communications library, I<rabbitmq-c>, which is "localhost".
585 =item B<Port> I<Port>
587 Service name or port number on which the AMQP broker accepts connections. This
588 argument must be a string, even if the numeric form is used. Defaults to
589 "5672".
591 =item B<VHost> I<VHost>
593 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
595 =item B<User> I<User>
597 =item B<Password> I<Password>
599 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
600 is used.
602 =item B<Exchange> I<Exchange>
604 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
605 By default, "amq.fanout" will be used.
607 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
608 the given exchange and the I<queue> is created, using the I<routing key> if
609 configured. See the B<Queue> and B<RoutingKey> options below.
611 =item B<ExchangeType> I<Type>
613 If given, the plugin will try to create the configured I<exchange> with this
614 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
615 be bound to this exchange.
617 =item B<Queue> I<Queue> (Subscribe only)
619 Configures the I<queue> name to subscribe to. If no queue name was configured
620 explicitly, a unique queue name will be created by the broker.
622 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
624 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
625 or transient (will disappear if the AMQP broker is restarted). Defaults to
626 "false".
628 This option should be used in conjunction with the I<Persistent> option on the
629 publish side.
631 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
633 Defines if the I<queue> subscribed to will be deleted once the last consumer
634 unsubscribes. Defaults to "true".
636 =item B<RoutingKey> I<Key>
638 In I<Publish> blocks, this configures the routing key to set on all outgoing
639 messages. If not given, the routing key will be computed from the I<identifier>
640 of the value. The host, plugin, type and the two instances are concatenated
641 together using dots as the separator and all containing dots replaced with
642 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
643 possible to receive only specific values using a "topic" exchange.
645 In I<Subscribe> blocks, configures the I<routing key> used when creating a
646 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
647 used to filter messages when using a "topic" exchange. If you're only
648 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
649 for example.
651 =item B<Persistent> B<true>|B<false> (Publish only)
653 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
654 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
655 default), the I<transient> delivery mode will be used, i.e. messages may be
656 lost due to high load, overflowing queues or similar issues.
658 =item B<ConnectionRetryDelay> I<Delay>
660 When the connection to the AMQP broker is lost, defines the time in seconds to
661 wait before attempting to reconnect. Defaults to 0, which implies collectd will
662 attempt to reconnect at each read interval (in Subscribe mode) or each time
663 values are ready for submission (in Publish mode).
665 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
667 Selects the format in which messages are sent to the broker. If set to
668 B<Command> (the default), values are sent as C<PUTVAL> commands which are
669 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
670 case, the C<Content-Type> header field will be set to C<text/collectd>.
672 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
673 an easy and straight forward exchange format. The C<Content-Type> header field
674 will be set to C<application/json>.
676 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
677 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
678 C<text/graphite>.
680 A subscribing client I<should> use the C<Content-Type> header field to
681 determine how to decode the values. Currently, the I<AMQP plugin> itself can
682 only decode the B<Command> format.
684 =item B<StoreRates> B<true>|B<false> (Publish only)
686 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
687 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
688 default), no conversion is performed. Otherwise the conversion is performed
689 using the internal value cache.
691 Please note that currently this option is only used if the B<Format> option has
692 been set to B<JSON>.
694 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
696 A prefix can be added in the metric name when outputting in the I<Graphite> format.
697 It's added before the I<Host> name.
698 Metric name will be "<prefix><host><postfix><plugin><type><name>"
700 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
702 A postfix can be added in the metric name when outputting in the I<Graphite> format.
703 It's added after the I<Host> name.
704 Metric name will be "<prefix><host><postfix><plugin><type><name>"
706 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
708 Specify a character to replace dots (.) in the host part of the metric name.
709 In I<Graphite> metric name, dots are used as separators between different
710 metric parts (host, plugin, type).
711 Default is "_" (I<Underscore>).
713 =item B<GraphiteSeparateInstances> B<true>|B<false>
715 If set to B<true>, the plugin instance and type instance will be in their own
716 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
717 default), the plugin and plugin instance (and likewise the type and type
718 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
720 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
722 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
723 identifier. If set to B<false> (the default), this is only done when there is
724 more than one DS.
726 =back
728 =head2 Plugin C<apache>
730 To configure the C<apache>-plugin you first need to configure the Apache
731 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
732 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
733 the following snipped to base your Apache config upon:
735   ExtendedStatus on
736   <IfModule mod_status.c>
737     <Location /mod_status>
738       SetHandler server-status
739     </Location>
740   </IfModule>
742 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
743 also supported. It introduces a new field, called C<BusyServers>, to count the
744 number of currently connected clients. This field is also supported.
746 The configuration of the I<Apache> plugin consists of one or more
747 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
748 as the instance name. For example:
750  <Plugin "apache">
751    <Instance "www1">
752      URL "http://www1.example.com/mod_status?auto"
753    </Instance>
754    <Instance "www2">
755      URL "http://www2.example.com/mod_status?auto"
756    </Instance>
757  </Plugin>
759 The instance name will be used as the I<plugin instance>. To emulate the old
760 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
761 plugin to work correctly, each instance name must be unique. This is not
762 enforced by the plugin and it is your responsibility to ensure it.
764 The following options are accepted within each I<Instance> block:
766 =over 4
768 =item B<URL> I<http://host/mod_status?auto>
770 Sets the URL of the C<mod_status> output. This needs to be the output generated
771 by C<ExtendedStatus on> and it needs to be the machine readable output
772 generated by appending the C<?auto> argument. This option is I<mandatory>.
774 =item B<User> I<Username>
776 Optional user name needed for authentication.
778 =item B<Password> I<Password>
780 Optional password needed for authentication.
782 =item B<VerifyPeer> B<true|false>
784 Enable or disable peer SSL certificate verification. See
785 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
787 =item B<VerifyHost> B<true|false>
789 Enable or disable peer host name verification. If enabled, the plugin checks
790 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
791 certificate matches the host name provided by the B<URL> option. If this
792 identity check fails, the connection is aborted. Obviously, only works when
793 connecting to a SSL enabled server. Enabled by default.
795 =item B<CACert> I<File>
797 File that holds one or more SSL certificates. If you want to use HTTPS you will
798 possibly need this option. What CA certificates come bundled with C<libcurl>
799 and are checked by default depends on the distribution you use.
801 =item B<SSLCiphers> I<list of ciphers>
803 Specifies which ciphers to use in the connection. The list of ciphers
804 must specify valid ciphers. See
805 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
807 =item B<Timeout> I<Milliseconds>
809 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
810 milliseconds. By default, the configured B<Interval> is used to set the
811 timeout.
813 =back
815 =head2 Plugin C<apcups>
817 =over 4
819 =item B<Host> I<Hostname>
821 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
822 that IPv6 support has been disabled unless someone can confirm or decline that
823 B<apcupsd> can handle it.
825 =item B<Port> I<Port>
827 TCP-Port to connect to. Defaults to B<3551>.
829 =item B<ReportSeconds> B<true>|B<false>
831 If set to B<true>, the time reported in the C<timeleft> metric will be
832 converted to seconds. This is the recommended setting. If set to B<false>, the
833 default for backwards compatibility, the time will be reported in minutes.
835 =item B<PersistentConnection> B<true>|B<false>
837 By default, the plugin will try to keep the connection to UPS open between
838 reads. Since this appears to be somewhat brittle (I<apcupsd> appears to close
839 the connection due to inactivity quite quickly), the plugin will try to detect
840 this problem and switch to an open-read-close mode in such cases.
842 You can instruct the plugin to close the connection after each read by setting
843 this option to B<false>.
845 =back
847 =head2 Plugin C<aquaero>
849 This plugin collects the value of the available sensors in an
850 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
851 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
852 connection for monitoring and configuration. The board can handle multiple
853 temperature sensors, fans, water pumps and water level sensors and adjust the
854 output settings such as fan voltage or power used by the water pump based on
855 the available inputs using a configurable controller included in the board.
856 This plugin collects all the available inputs as well as some of the output
857 values chosen by this controller. The plugin is based on the I<libaquaero5>
858 library provided by I<aquatools-ng>.
860 =over 4
862 =item B<Device> I<DevicePath>
864 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
865 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
866 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
868 =back
870 =head2 Plugin C<ascent>
872 This plugin collects information about an Ascent server, a free server for the
873 "World of Warcraft" game. This plugin gathers the information by fetching the
874 XML status page using C<libcurl> and parses it using C<libxml2>.
876 The configuration options are the same as for the C<apache> plugin above:
878 =over 4
880 =item B<URL> I<http://localhost/ascent/status/>
882 Sets the URL of the XML status output.
884 =item B<User> I<Username>
886 Optional user name needed for authentication.
888 =item B<Password> I<Password>
890 Optional password needed for authentication.
892 =item B<VerifyPeer> B<true|false>
894 Enable or disable peer SSL certificate verification. See
895 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
897 =item B<VerifyHost> B<true|false>
899 Enable or disable peer host name verification. If enabled, the plugin checks
900 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
901 certificate matches the host name provided by the B<URL> option. If this
902 identity check fails, the connection is aborted. Obviously, only works when
903 connecting to a SSL enabled server. Enabled by default.
905 =item B<CACert> I<File>
907 File that holds one or more SSL certificates. If you want to use HTTPS you will
908 possibly need this option. What CA certificates come bundled with C<libcurl>
909 and are checked by default depends on the distribution you use.
911 =item B<Timeout> I<Milliseconds>
913 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
914 milliseconds. By default, the configured B<Interval> is used to set the
915 timeout.
917 =back
919 =head2 Plugin C<barometer>
921 This plugin reads absolute air pressure using digital barometer sensor on a I2C
922 bus. Supported sensors are:
924 =over 5
926 =item I<MPL115A2> from Freescale,
927 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
930 =item I<MPL3115> from Freescale
931 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
934 =item I<BMP085> from Bosch Sensortec
936 =back
938 The sensor type - one of the above - is detected automatically by the plugin
939 and indicated in the plugin_instance (you will see subdirectory
940 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
941 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
942 (only one sensor can be used by the plugin).
944 The plugin provides absolute barometric pressure, air pressure reduced to sea
945 level (several possible approximations) and as an auxiliary value also internal
946 sensor temperature. It uses (expects/provides) typical metric units - pressure
947 in [hPa], temperature in [C], altitude in [m].
949 It was developed and tested under Linux only. The only platform dependency is
950 the standard Linux i2c-dev interface (the particular bus driver has to
951 support the SM Bus command subset).
953 The reduction or normalization to mean sea level pressure requires (depending
954 on selected method/approximation) also altitude and reference to temperature
955 sensor(s).  When multiple temperature sensors are configured the minumum of
956 their values is always used (expecting that the warmer ones are affected by
957 e.g. direct sun light at that moment).
959 Synopsis:
961   <Plugin "barometer">
962      Device            "/dev/i2c-0";
963      Oversampling      512
964      PressureOffset    0.0
965      TemperatureOffset 0.0
966      Normalization     2
967      Altitude          238.0
968      TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
969   </Plugin>
971 =over 4
973 =item B<Device> I<device>
975 The only mandatory configuration parameter.
977 Device name of the I2C bus to which the sensor is connected. Note that
978 typically you need to have loaded the i2c-dev module.
979 Using i2c-tools you can check/list i2c buses available on your system by:
981   i2cdetect -l
983 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
985   i2cdetect -y -a 0
987 This way you should be able to verify that the pressure sensor (either type) is
988 connected and detected on address 0x60.
990 =item B<Oversampling> I<value>
992 Optional parameter controlling the oversampling/accuracy. Default value
993 is 1 providing fastest and least accurate reading.
995 For I<MPL115> this is the size of the averaging window. To filter out sensor
996 noise a simple averaging using floating window of this configurable size is
997 used. The plugin will use average of the last C<value> measurements (value of 1
998 means no averaging).  Minimal size is 1, maximal 1024.
1000 For I<MPL3115> this is the oversampling value. The actual oversampling is
1001 performed by the sensor and the higher value the higher accuracy and longer
1002 conversion time (although nothing to worry about in the collectd context).
1003 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1004 adjusted by the plugin to the closest supported one.
1006 For I<BMP085> this is the oversampling value. The actual oversampling is
1007 performed by the sensor and the higher value the higher accuracy and longer
1008 conversion time (although nothing to worry about in the collectd context).
1009 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1010 the closest supported one.
1012 =item B<PressureOffset> I<offset>
1014 Optional parameter for MPL3115 only.
1016 You can further calibrate the sensor by supplying pressure and/or temperature
1017 offsets.  This is added to the measured/caclulated value (i.e. if the measured
1018 value is too high then use negative offset).
1019 In hPa, default is 0.0.
1021 =item B<TemperatureOffset> I<offset>
1023 Optional parameter for MPL3115 only.
1025 You can further calibrate the sensor by supplying pressure and/or temperature
1026 offsets.  This is added to the measured/caclulated value (i.e. if the measured
1027 value is too high then use negative offset).
1028 In C, default is 0.0.
1030 =item B<Normalization> I<method>
1032 Optional parameter, default value is 0.
1034 Normalization method - what approximation/model is used to compute the mean sea
1035 level pressure from the air absolute pressure.
1037 Supported values of the C<method> (integer between from 0 to 2) are:
1039 =over 5
1041 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1042        do not need to configure C<Altitude> or C<TemperatureSensor>.
1044 =item B<1> - international formula for conversion ,
1045 See
1046 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1047 For this method you have to configure C<Altitude> but do not need
1048 C<TemperatureSensor> (uses fixed global temperature average instead).
1050 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1051 Meteorological Service).
1052 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1053 For this method you have to configure both  C<Altitude> and
1054 C<TemperatureSensor>.
1056 =back
1059 =item B<Altitude> I<altitude>
1061 The altitude (in meters) of the location where you meassure the pressure.
1063 =item B<TemperatureSensor> I<reference>
1065 Temperature sensor(s) which should be used as a reference when normalizing the
1066 pressure using C<Normalization> method 2.
1067 When specified more sensors a minumum is found and used each time.  The
1068 temperature reading directly from this pressure sensor/plugin is typically not
1069 suitable as the pressure sensor will be probably inside while we want outside
1070 temperature.  The collectd reference name is something like
1071 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1072 (<type_instance> is usually omitted when there is just single value type). Or
1073 you can figure it out from the path of the output data files.
1075 =back
1077 =head2 Plugin C<battery>
1079 The I<battery plugin> reports the remaining capacity, power and voltage of
1080 laptop batteries.
1082 =over 4
1084 =item B<ValuesPercentage> B<false>|B<true>
1086 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1087 capacity remaining". Otherwise the capacity is stored as reported by the
1088 battery, most likely in "Wh". This option does not work with all input methods,
1089 in particular when only C</proc/pmu> is available on an old Linux system.
1090 Defaults to B<false>.
1092 =item B<ReportDegraded> B<false>|B<true>
1094 Typical laptop batteries degrade over time, meaning the capacity decreases with
1095 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1096 "last full capacity" and used to determine that a battery is "fully charged".
1098 When this option is set to B<false>, the default, the I<battery plugin> will
1099 only report the remaining capacity. If the B<ValuesPercentage> option is
1100 enabled, the relative remaining capacity is calculated as the ratio of the
1101 "remaining capacity" and the "last full capacity". This is what most tools,
1102 such as the status bar of desktop environments, also do.
1104 When set to B<true>, the battery plugin will report three values: B<charged>
1105 (remaining capacity), B<discharged> (difference between "last full capacity"
1106 and "remaining capacity") and B<degraded> (difference between "design capacity"
1107 and "last full capacity").
1109 =back
1111 =head2 Plugin C<bind>
1113 Starting with BIND 9.5.0, the most widely used DNS server software provides
1114 extensive statistics about queries, responses and lots of other information.
1115 The bind plugin retrieves this information that's encoded in XML and provided
1116 via HTTP and submits the values to collectd.
1118 To use this plugin, you first need to tell BIND to make this information
1119 available. This is done with the C<statistics-channels> configuration option:
1121  statistics-channels {
1122    inet localhost port 8053;
1123  };
1125 The configuration follows the grouping that can be seen when looking at the
1126 data with an XSLT compatible viewer, such as a modern web browser. It's
1127 probably a good idea to make yourself familiar with the provided values, so you
1128 can understand what the collected statistics actually mean.
1130 Synopsis:
1132  <Plugin "bind">
1133    URL "http://localhost:8053/"
1134    ParseTime       false
1135    OpCodes         true
1136    QTypes          true
1138    ServerStats     true
1139    ZoneMaintStats  true
1140    ResolverStats   false
1141    MemoryStats     true
1143    <View "_default">
1144      QTypes        true
1145      ResolverStats true
1146      CacheRRSets   true
1148      Zone "127.in-addr.arpa/IN"
1149    </View>
1150  </Plugin>
1152 The bind plugin accepts the following configuration options:
1154 =over 4
1156 =item B<URL> I<URL>
1158 URL from which to retrieve the XML data. If not specified,
1159 C<http://localhost:8053/> will be used.
1161 =item B<ParseTime> B<true>|B<false>
1163 When set to B<true>, the time provided by BIND will be parsed and used to
1164 dispatch the values. When set to B<false>, the local time source is queried.
1166 This setting is set to B<true> by default for backwards compatibility; setting
1167 this to B<false> is I<recommended> to avoid problems with timezones and
1168 localization.
1170 =item B<OpCodes> B<true>|B<false>
1172 When enabled, statistics about the I<"OpCodes">, for example the number of
1173 C<QUERY> packets, are collected.
1175 Default: Enabled.
1177 =item B<QTypes> B<true>|B<false>
1179 When enabled, the number of I<incoming> queries by query types (for example
1180 C<A>, C<MX>, C<AAAA>) is collected.
1182 Default: Enabled.
1184 =item B<ServerStats> B<true>|B<false>
1186 Collect global server statistics, such as requests received over IPv4 and IPv6,
1187 successful queries, and failed updates.
1189 Default: Enabled.
1191 =item B<ZoneMaintStats> B<true>|B<false>
1193 Collect zone maintenance statistics, mostly information about notifications
1194 (zone updates) and zone transfers.
1196 Default: Enabled.
1198 =item B<ResolverStats> B<true>|B<false>
1200 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1201 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1202 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1203 default. Use the B<ResolverStats> option within a B<View "_default"> block
1204 instead for the same functionality.
1206 Default: Disabled.
1208 =item B<MemoryStats>
1210 Collect global memory statistics.
1212 Default: Enabled.
1214 =item B<Timeout> I<Milliseconds>
1216 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1217 milliseconds. By default, the configured B<Interval> is used to set the
1218 timeout.
1220 =item B<View> I<Name>
1222 Collect statistics about a specific I<"view">. BIND can behave different,
1223 mostly depending on the source IP-address of the request. These different
1224 configurations are called "views". If you don't use this feature, you most
1225 likely are only interested in the C<_default> view.
1227 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1228 information you want to collect about a view. If no B<View> block is
1229 configured, no detailed view statistics will be collected.
1231 =over 4
1233 =item B<QTypes> B<true>|B<false>
1235 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1236 C<MX>) is collected.
1238 Default: Enabled.
1240 =item B<ResolverStats> B<true>|B<false>
1242 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1243 (e.E<nbsp>g. queries over IPv4, lame servers).
1245 Default: Enabled.
1247 =item B<CacheRRSets> B<true>|B<false>
1249 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1250 type is collected. Negative entries (queries which resulted in an error, for
1251 example names that do not exist) are reported with a leading exclamation mark,
1252 e.E<nbsp>g. "!A".
1254 Default: Enabled.
1256 =item B<Zone> I<Name>
1258 When given, collect detailed information about the given zone in the view. The
1259 information collected if very similar to the global B<ServerStats> information
1260 (see above).
1262 You can repeat this option to collect detailed information about multiple
1263 zones.
1265 By default no detailed zone information is collected.
1267 =back
1269 =back
1271 =head2 Plugin C<ceph>
1273 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1274 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1276 A separate B<Daemon> block must be configured for each ceph daemon to be
1277 monitored. The following example will read daemon statistics from four
1278 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1280   <Plugin ceph>
1281     LongRunAvgLatency false
1282     ConvertSpecialMetricTypes true
1283     <Daemon "osd.0">
1284       SocketPath "/var/run/ceph/ceph-osd.0.asok"
1285     </Daemon>
1286     <Daemon "osd.1">
1287       SocketPath "/var/run/ceph/ceph-osd.1.asok"
1288     </Daemon>
1289     <Daemon "mon.a">
1290       SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1291     </Daemon>
1292     <Daemon "mds.a">
1293       SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1294     </Daemon>
1295   </Plugin>
1297 The ceph plugin accepts the following configuration options:
1299 =over 4
1301 =item B<LongRunAvgLatency> B<true>|B<false>
1303 If enabled, latency values(sum,count pairs) are calculated as the long run
1304 average - average since the ceph daemon was started = (sum / count).
1305 When disabled, latency values are calculated as the average since the last
1306 collection = (sum_now - sum_last) / (count_now - count_last).
1308 Default: Disabled
1310 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1312 If enabled, special metrics (metrics that differ in type from similar counters)
1313 are converted to the type of those similar counters. This currently only
1314 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1315 ceph schema reports this metric type as a sum,count pair while similar counters
1316 are treated as derive types. When converted, the sum is used as the counter
1317 value and is treated as a derive type.
1318 When disabled, all metrics are treated as the types received from the ceph schema.
1320 Default: Enabled
1322 =back
1324 Each B<Daemon> block must have a string argument for the plugin instance name.
1325 A B<SocketPath> is also required for each B<Daemon> block:
1327 =over 4
1329 =item B<Daemon> I<DaemonName>
1331 Name to be used as the instance name for this daemon.
1333 =item B<SocketPath> I<SocketPath>
1335 Specifies the path to the UNIX admin socket of the ceph daemon.
1337 =back
1339 =head2 Plugin C<cgroups>
1341 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1342 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1343 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1345 =over 4
1347 =item B<CGroup> I<Directory>
1349 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1350 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1351 see below.
1353 =item B<IgnoreSelected> B<true>|B<false>
1355 Invert the selection: If set to true, all cgroups I<except> the ones that
1356 match any one of the criteria are collected. By default only selected
1357 cgroups are collected if a selection is made. If no selection is configured
1358 at all, B<all> cgroups are selected.
1360 =back
1362 =head2 Plugin C<conntrack>
1364 This plugin collects IP conntrack statistics.
1366 =over 4
1368 =item B<OldFiles>
1370 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1371 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1373 =back
1375 =head2 Plugin C<cpu>
1377 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1378 as Jiffies, using the C<cpu> type. Two aggregations are available:
1380 =over 4
1382 =item
1384 Sum, per-state, over all CPUs installed in the system; and
1386 =item
1388 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1390 =back
1392 The two aggregations can be combined, leading to I<collectd> only emitting a
1393 single "active" metric for the entire system. As soon as one of these
1394 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1395 rather than Jiffies. In addition, you can request individual, per-state,
1396 per-CPU metrics to be reported as percentage.
1398 The following configuration options are available:
1400 =over 4
1402 =item B<ReportByState> B<true>|B<false>
1404 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1405 "user" and "idle".
1406 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1407 "active" metric.
1409 =item B<ReportByCpu> B<true>|B<false>
1411 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1412 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1413 global sum of CPU states is emitted.
1415 =item B<ValuesPercentage> B<false>|B<true>
1417 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1418 are set to B<true>. In this case, by default, metrics will be reported as
1419 Jiffies. By setting this option to B<true>, you can request percentage values
1420 in the un-aggregated (per-CPU, per-state) mode as well.
1422 =back
1424 =head2 Plugin C<cpufreq>
1426 This plugin doesn't have any options. It reads
1427 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1428 installed) to get the current CPU frequency. If this file does not exist make
1429 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1430 installed and an "cpu governor" (that's a kernel module) is loaded.
1432 =head2 Plugin C<csv>
1434 =over 4
1436 =item B<DataDir> I<Directory>
1438 Set the directory to store CSV-files under. Per default CSV-files are generated
1439 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1440 The special strings B<stdout> and B<stderr> can be used to write to the standard
1441 output and standard error channels, respectively. This, of course, only makes
1442 much sense when collectd is running in foreground- or non-daemon-mode.
1444 =item B<StoreRates> B<true|false>
1446 If set to B<true>, convert counter values to rates. If set to B<false> (the
1447 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1448 number.
1450 =back
1452 =head2 Plugin C<curl>
1454 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1455 and the match infrastructure (the same code used by the tail plugin) to use
1456 regular expressions with the received data.
1458 The following example will read the current value of AMD stock from Google's
1459 finance page and dispatch the value to collectd.
1461   <Plugin curl>
1462     <Page "stock_quotes">
1463       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1464       User "foo"
1465       Password "bar"
1466       Digest false
1467       VerifyPeer true
1468       VerifyHost true
1469       CACert "/path/to/ca.crt"
1470       Header "X-Custom-Header: foobar"
1471       Post "foo=bar"
1473       MeasureResponseTime false
1474       MeasureResponseCode false
1476       <Match>
1477         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1478         DSType "GaugeAverage"
1479         # Note: `stock_value' is not a standard type.
1480         Type "stock_value"
1481         Instance "AMD"
1482       </Match>
1483     </Page>
1484   </Plugin>
1486 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1487 a web page and one or more "matches" to be performed on the returned data. The
1488 string argument to the B<Page> block is used as plugin instance.
1490 The following options are valid within B<Page> blocks:
1492 =over 4
1494 =item B<URL> I<URL>
1496 URL of the web site to retrieve. Since a regular expression will be used to
1497 extract information from this data, non-binary data is a big plus here ;)
1499 =item B<User> I<Name>
1501 Username to use if authorization is required to read the page.
1503 =item B<Password> I<Password>
1505 Password to use if authorization is required to read the page.
1507 =item B<Digest> B<true>|B<false>
1509 Enable HTTP digest authentication.
1511 =item B<VerifyPeer> B<true>|B<false>
1513 Enable or disable peer SSL certificate verification. See
1514 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1516 =item B<VerifyHost> B<true>|B<false>
1518 Enable or disable peer host name verification. If enabled, the plugin checks if
1519 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1520 matches the host name provided by the B<URL> option. If this identity check
1521 fails, the connection is aborted. Obviously, only works when connecting to a
1522 SSL enabled server. Enabled by default.
1524 =item B<CACert> I<file>
1526 File that holds one or more SSL certificates. If you want to use HTTPS you will
1527 possibly need this option. What CA certificates come bundled with C<libcurl>
1528 and are checked by default depends on the distribution you use.
1530 =item B<Header> I<Header>
1532 A HTTP header to add to the request. Multiple headers are added if this option
1533 is specified more than once.
1535 =item B<Post> I<Body>
1537 Specifies that the HTTP operation should be a POST instead of a GET. The
1538 complete data to be posted is given as the argument.  This option will usually
1539 need to be accompanied by a B<Header> option to set an appropriate
1540 C<Content-Type> for the post body (e.g. to
1541 C<application/x-www-form-urlencoded>).
1543 =item B<MeasureResponseTime> B<true>|B<false>
1545 Measure response time for the request. If this setting is enabled, B<Match>
1546 blocks (see below) are optional. Disabled by default.
1548 Beware that requests will get aborted if they take too long to complete. Adjust
1549 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1550 requests.
1552 =item B<MeasureResponseCode> B<true>|B<false>
1554 Measure response code for the request. If this setting is enabled, B<Match>
1555 blocks (see below) are optional. Disabled by default.
1557 =item B<E<lt>MatchE<gt>>
1559 One or more B<Match> blocks that define how to match information in the data
1560 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1561 used by the C<tail> plugin, so please see the documentation of the C<tail>
1562 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1563 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1564 optional.
1566 =item B<Timeout> I<Milliseconds>
1568 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1569 milliseconds. By default, the configured B<Interval> is used to set the
1570 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1571 indefinitely. This legacy behaviour can be achieved by setting the value of
1572 B<Timeout> to 0.
1574 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1575 network connection will stall one read thread. Adjust the B<ReadThreads> global
1576 setting accordingly to prevent this from blocking other plugins.
1578 =back
1580 =head2 Plugin C<curl_json>
1582 The B<curl_json plugin> collects values from JSON data to be parsed by
1583 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1584 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1585 unix socket. The former can be used, for example, to collect values
1586 from CouchDB documents (which are stored JSON notation), and the
1587 latter to collect values from a uWSGI stats socket.
1589 The following example will collect several values from the built-in
1590 C<_stats> runtime statistics module of I<CouchDB>
1591 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1593   <Plugin curl_json>
1594     <URL "http://localhost:5984/_stats">
1595       Instance "httpd"
1596       <Key "httpd/requests/count">
1597         Type "http_requests"
1598       </Key>
1600       <Key "httpd_request_methods/*/count">
1601         Type "http_request_methods"
1602       </Key>
1604       <Key "httpd_status_codes/*/count">
1605         Type "http_response_codes"
1606       </Key>
1607     </URL>
1608   </Plugin>
1610 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1612   <Plugin curl_json>
1613     <Sock "/var/run/uwsgi.stats.sock">
1614       Instance "uwsgi"
1615       <Key "workers/*/requests">
1616         Type "http_requests"
1617       </Key>
1619       <Key "workers/*/apps/*/requests">
1620         Type "http_requests"
1621       </Key>
1622     </Sock>
1623   </Plugin>
1625 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1626 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1627 blocks defining a unix socket to read JSON from directly.  Each of
1628 these blocks may have one or more B<Key> blocks.
1630 The B<Key> string argument must be in a path format. Each component is
1631 used to match the key from a JSON map or the index of an JSON
1632 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1633 values for all map keys or array indices will be collectd.
1635 The following options are valid within B<URL> blocks:
1637 =over 4
1639 =item B<Instance> I<Instance>
1641 Sets the plugin instance to I<Instance>.
1643 =item B<Interval> I<Interval>
1645 Sets the interval (in seconds) in which the values will be collected from this
1646 URL. By default the global B<Interval> setting will be used.
1648 =item B<User> I<Name>
1650 =item B<Password> I<Password>
1652 =item B<Digest> B<true>|B<false>
1654 =item B<VerifyPeer> B<true>|B<false>
1656 =item B<VerifyHost> B<true>|B<false>
1658 =item B<CACert> I<file>
1660 =item B<Header> I<Header>
1662 =item B<Post> I<Body>
1664 =item B<Timeout> I<Milliseconds>
1666 These options behave exactly equivalent to the appropriate options of the
1667 I<cURL> plugin. Please see there for a detailed description.
1669 =back
1671 The following options are valid within B<Key> blocks:
1673 =over 4
1675 =item B<Type> I<Type>
1677 Sets the type used to dispatch the values to the daemon. Detailed information
1678 about types and their configuration can be found in L<types.db(5)>. This
1679 option is mandatory.
1681 =item B<Instance> I<Instance>
1683 Type-instance to use. Defaults to the current map key or current string array element value.
1685 =back
1687 =head2 Plugin C<curl_xml>
1689 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1690 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1692  <Plugin "curl_xml">
1693    <URL "http://localhost/stats.xml">
1694      Host "my_host"
1695      Instance "some_instance"
1696      User "collectd"
1697      Password "thaiNg0I"
1698      VerifyPeer true
1699      VerifyHost true
1700      CACert "/path/to/ca.crt"
1701      Header "X-Custom-Header: foobar"
1702      Post "foo=bar"
1704      <XPath "table[@id=\"magic_level\"]/tr">
1705        Type "magic_level"
1706        #InstancePrefix "prefix-"
1707        InstanceFrom "td[1]"
1708        ValuesFrom "td[2]/span[@class=\"level\"]"
1709      </XPath>
1710    </URL>
1711  </Plugin>
1713 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1714 URL to be fetched using libcurl. Within each B<URL> block there are
1715 options which specify the connection parameters, for example authentication
1716 information, and one or more B<XPath> blocks.
1718 Each B<XPath> block specifies how to get one type of information. The
1719 string argument must be a valid XPath expression which returns a list
1720 of "base elements". One value is dispatched for each "base element". The
1721 I<type instance> and values are looked up using further I<XPath> expressions
1722 that should be relative to the base element.
1724 Within the B<URL> block the following options are accepted:
1726 =over 4
1728 =item B<Host> I<Name>
1730 Use I<Name> as the host name when submitting values. Defaults to the global
1731 host name setting.
1733 =item B<Instance> I<Instance>
1735 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1736 empty string (no plugin instance).
1738 =item B<Namespace> I<Prefix> I<URL>
1740 If an XPath expression references namespaces, they must be specified
1741 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1742 I<URL> is the "namespace name", an URI reference uniquely identifying the
1743 namespace. The option can be repeated to register multiple namespaces.
1745 Examples:
1747   Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1748   Namespace "m" "http://www.w3.org/1998/Math/MathML"
1750 =item B<User> I<User>
1752 =item B<Password> I<Password>
1754 =item B<Digest> B<true>|B<false>
1756 =item B<VerifyPeer> B<true>|B<false>
1758 =item B<VerifyHost> B<true>|B<false>
1760 =item B<CACert> I<CA Cert File>
1762 =item B<Header> I<Header>
1764 =item B<Post> I<Body>
1766 =item B<Timeout> I<Milliseconds>
1768 These options behave exactly equivalent to the appropriate options of the
1769 I<cURL plugin>. Please see there for a detailed description.
1771 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1773 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1774 B<XPath> block specifies how to get one type of information. The string
1775 argument must be a valid XPath expression which returns a list of "base
1776 elements". One value is dispatched for each "base element".
1778 Within the B<XPath> block the following options are accepted:
1780 =over 4
1782 =item B<Type> I<Type>
1784 Specifies the I<Type> used for submitting patches. This determines the number
1785 of values that are required / expected and whether the strings are parsed as
1786 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1787 This option is required.
1789 =item B<InstancePrefix> I<InstancePrefix>
1791 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1792 concatenated together without any separator.
1793 This option is optional.
1795 =item B<InstanceFrom> I<InstanceFrom>
1797 Specifies a XPath expression to use for determining the I<type instance>. The
1798 XPath expression must return exactly one element. The element's value is then
1799 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1801 This value is required. As a special exception, if the "base XPath expression"
1802 (the argument to the B<XPath> block) returns exactly one argument, then this
1803 option may be omitted.
1805 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1807 Specifies one or more XPath expression to use for reading the values. The
1808 number of XPath expressions must match the number of data sources in the
1809 I<type> specified with B<Type> (see above). Each XPath expression must return
1810 exactly one element. The element's value is then parsed as a number and used as
1811 value for the appropriate value in the value list dispatched to the daemon.
1813 =back
1815 =back
1817 =head2 Plugin C<dbi>
1819 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1820 connect to various databases, execute I<SQL> statements and read back the
1821 results. I<dbi> is an acronym for "database interface" in case you were
1822 wondering about the name. You can configure how each column is to be
1823 interpreted and the plugin will generate one or more data sets from each row
1824 returned according to these rules.
1826 Because the plugin is very generic, the configuration is a little more complex
1827 than those of other plugins. It usually looks something like this:
1829   <Plugin dbi>
1830     <Query "out_of_stock">
1831       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1832       # Use with MySQL 5.0.0 or later
1833       MinVersion 50000
1834       <Result>
1835         Type "gauge"
1836         InstancePrefix "out_of_stock"
1837         InstancesFrom "category"
1838         ValuesFrom "value"
1839       </Result>
1840     </Query>
1841     <Database "product_information">
1842       Driver "mysql"
1843       Interval 120
1844       DriverOption "host" "localhost"
1845       DriverOption "username" "collectd"
1846       DriverOption "password" "aZo6daiw"
1847       DriverOption "dbname" "prod_info"
1848       SelectDB "prod_info"
1849       Query "out_of_stock"
1850     </Database>
1851   </Plugin>
1853 The configuration above defines one query with one result and one database. The
1854 query is then linked to the database with the B<Query> option I<within> the
1855 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1856 and you can also use the B<Include> statement to split up the configuration
1857 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1858 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1859 top to bottom!
1861 The following is a complete list of options:
1863 =head3 B<Query> blocks
1865 Query blocks define I<SQL> statements and how the returned data should be
1866 interpreted. They are identified by the name that is given in the opening line
1867 of the block. Thus the name needs to be unique. Other than that, the name is
1868 not used in collectd.
1870 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1871 define which column holds which value or instance information. You can use
1872 multiple B<Result> blocks to create multiple values from one returned row. This
1873 is especially useful, when queries take a long time and sending almost the same
1874 query again and again is not desirable.
1876 Example:
1878   <Query "environment">
1879     Statement "select station, temperature, humidity from environment"
1880     <Result>
1881       Type "temperature"
1882       # InstancePrefix "foo"
1883       InstancesFrom "station"
1884       ValuesFrom "temperature"
1885     </Result>
1886     <Result>
1887       Type "humidity"
1888       InstancesFrom "station"
1889       ValuesFrom "humidity"
1890     </Result>
1891   </Query>
1893 The following options are accepted:
1895 =over 4
1897 =item B<Statement> I<SQL>
1899 Sets the statement that should be executed on the server. This is B<not>
1900 interpreted by collectd, but simply passed to the database server. Therefore,
1901 the SQL dialect that's used depends on the server collectd is connected to.
1903 The query has to return at least two columns, one for the instance and one
1904 value. You cannot omit the instance, even if the statement is guaranteed to
1905 always return exactly one line. In that case, you can usually specify something
1906 like this:
1908   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1910 (That works with MySQL but may not be valid SQL according to the spec. If you
1911 use a more strict database server, you may have to select from a dummy table or
1912 something.)
1914 Please note that some databases, for example B<Oracle>, will fail if you
1915 include a semicolon at the end of the statement.
1917 =item B<MinVersion> I<Version>
1919 =item B<MaxVersion> I<Value>
1921 Only use this query for the specified database version. You can use these
1922 options to provide multiple queries with the same name but with a slightly
1923 different syntax. The plugin will use only those queries, where the specified
1924 minimum and maximum versions fit the version of the database in use.
1926 The database version is determined by C<dbi_conn_get_engine_version>, see the
1927 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1928 for details. Basically, each part of the version is assumed to be in the range
1929 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1930 "40102", version "5.0.42" becomes "50042".
1932 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1933 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1934 happen. Don't to it! A valid example would be something along these lines:
1936   MinVersion 40000
1937   MaxVersion 49999
1938   ...
1939   MinVersion 50000
1940   MaxVersion 50099
1941   ...
1942   MinVersion 50100
1943   # No maximum
1945 In the above example, there are three ranges that don't overlap. The last one
1946 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1947 before "4.0.0" are not specified.
1949 =item B<Type> I<Type>
1951 The B<type> that's used for each line returned. See L<types.db(5)> for more
1952 details on how types are defined. In short: A type is a predefined layout of
1953 data and the number of values and type of values has to match the type
1954 definition.
1956 If you specify "temperature" here, you need exactly one gauge column. If you
1957 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1958 setting below.
1960 There must be exactly one B<Type> option inside each B<Result> block.
1962 =item B<InstancePrefix> I<prefix>
1964 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1965 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1966 all strings returned in the appropriate columns are concatenated together,
1967 separated by dashes I<("-")>.
1969 =item B<InstancesFrom> I<column0> [I<column1> ...]
1971 Specifies the columns whose values will be used to create the "type-instance"
1972 for each row. If you specify more than one column, the value of all columns
1973 will be joined together with dashes I<("-")> as separation characters.
1975 The plugin itself does not check whether or not all built instances are
1976 different. It's your responsibility to assure that each is unique. This is
1977 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1978 sure that only one row is returned in this case.
1980 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1981 will be empty.
1983 =item B<ValuesFrom> I<column0> [I<column1> ...]
1985 Names the columns whose content is used as the actual data for the data sets
1986 that are dispatched to the daemon. How many such columns you need is determined
1987 by the B<Type> setting above. If you specify too many or not enough columns,
1988 the plugin will complain about that and no data will be submitted to the
1989 daemon.
1991 The actual data type in the columns is not that important. The plugin will
1992 automatically cast the values to the right type if it know how to do that. So
1993 it should be able to handle integer an floating point types, as well as strings
1994 (if they include a number at the beginning).
1996 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1998 =item B<MetadataFrom> [I<column0> I<column1> ...]
2000 Names the columns whose content is used as metadata for the data sets
2001 that are dispatched to the daemon.
2003 The actual data type in the columns is not that important. The plugin will
2004 automatically cast the values to the right type if it know how to do that. So
2005 it should be able to handle integer an floating point types, as well as strings
2006 (if they include a number at the beginning).
2008 =back
2010 =head3 B<Database> blocks
2012 Database blocks define a connection to a database and which queries should be
2013 sent to that database. Since the used "dbi" library can handle a wide variety
2014 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2015 documentationE<nbsp>- we stick as close to the terminology used there.
2017 Each database needs a "name" as string argument in the starting tag of the
2018 block. This name will be used as "PluginInstance" in the values submitted to
2019 the daemon. Other than that, that name is not used.
2021 =over 4
2023 =item B<Interval> I<Interval>
2025 Sets the interval (in seconds) in which the values will be collected from this
2026 database. By default the global B<Interval> setting will be used.
2028 =item B<Driver> I<Driver>
2030 Specifies the driver to use to connect to the database. In many cases those
2031 drivers are named after the database they can connect to, but this is not a
2032 technical necessity. These drivers are sometimes referred to as "DBD",
2033 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2034 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2035 project at L<http://libdbi-drivers.sourceforge.net/>.
2037 You need to give the driver name as expected by the "dbi" library here. You
2038 should be able to find that in the documentation for each driver. If you
2039 mistype the driver name, the plugin will dump a list of all known driver names
2040 to the log.
2042 =item B<DriverOption> I<Key> I<Value>
2044 Sets driver-specific options. What option a driver supports can be found in the
2045 documentation for each driver, somewhere at
2046 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2047 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2049 DBDs can register two types of options: String options and numeric options. The
2050 plugin will use the C<dbi_conn_set_option> function when the configuration
2051 provides a string and the C<dbi_conn_require_option_numeric> function when the
2052 configuration provides a number. So these two lines will actually result in
2053 different calls being used:
2055   DriverOption "Port" 1234      # numeric
2056   DriverOption "Port" "1234"    # string
2058 Unfortunately, drivers are not too keen to report errors when an unknown option
2059 is passed to them, so invalid settings here may go unnoticed. This is not the
2060 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2061 the driver. If a driver complains about an option, the plugin will dump a
2062 complete list of all options understood by that driver to the log. There is no
2063 way to programatically find out if an option expects a string or a numeric
2064 argument, so you will have to refer to the appropriate DBD's documentation to
2065 find this out. Sorry.
2067 =item B<SelectDB> I<Database>
2069 In some cases, the database name you connect with is not the database name you
2070 want to use for querying data. If this option is set, the plugin will "select"
2071 (switch to) that database after the connection is established.
2073 =item B<Query> I<QueryName>
2075 Associates the query named I<QueryName> with this database connection. The
2076 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2077 blocks you want to refer to must be placed above the database block you want to
2078 refer to them from.
2080 =item B<Host> I<Hostname>
2082 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2083 values. Defaults to the global hostname setting.
2085 =back
2087 =head2 Plugin C<df>
2089 =over 4
2091 =item B<Device> I<Device>
2093 Select partitions based on the devicename.
2095 =item B<MountPoint> I<Directory>
2097 Select partitions based on the mountpoint.
2099 =item B<FSType> I<FSType>
2101 Select partitions based on the filesystem type.
2103 =item B<IgnoreSelected> B<true>|B<false>
2105 Invert the selection: If set to true, all partitions B<except> the ones that
2106 match any one of the criteria are collected. By default only selected
2107 partitions are collected if a selection is made. If no selection is configured
2108 at all, B<all> partitions are selected.
2110 =item B<ReportByDevice> B<true>|B<false>
2112 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2113 (the default), it will report a disk as "root", but with it I<true>, it will be
2114 "sda1" (or whichever).
2116 =item B<ReportInodes> B<true>|B<false>
2118 Enables or disables reporting of free, reserved and used inodes. Defaults to
2119 inode collection being disabled.
2121 Enable this option if inodes are a scarce resource for you, usually because
2122 many small files are stored on the disk. This is a usual scenario for mail
2123 transfer agents and web caches.
2125 =item B<ValuesAbsolute> B<true>|B<false>
2127 Enables or disables reporting of free and used disk space in 1K-blocks.
2128 Defaults to B<true>.
2130 =item B<ValuesPercentage> B<false>|B<true>
2132 Enables or disables reporting of free and used disk space in percentage.
2133 Defaults to B<false>.
2135 This is useful for deploying I<collectd> on the cloud, where machines with
2136 different disk size may exist. Then it is more practical to configure
2137 thresholds based on relative disk size.
2139 =back
2141 =head2 Plugin C<disk>
2143 The C<disk> plugin collects information about the usage of physical disks and
2144 logical disks (partitions). Values collected are the number of octets written
2145 to and read from a disk or partition, the number of read/write operations
2146 issued to the disk and a rather complex "time" it took for these commands to be
2147 issued.
2149 Using the following two options you can ignore some disks or configure the
2150 collection only of specific disks.
2152 =over 4
2154 =item B<Disk> I<Name>
2156 Select the disk I<Name>. Whether it is collected or ignored depends on the
2157 B<IgnoreSelected> setting, see below. As with other plugins that use the
2158 daemon's ignorelist functionality, a string that starts and ends with a slash
2159 is interpreted as a regular expression. Examples:
2161   Disk "sdd"
2162   Disk "/hda[34]/"
2164 =item B<IgnoreSelected> B<true>|B<false>
2166 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2167 statements, are ignored or if all other disks are ignored. The behavior
2168 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2169 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2170 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2171 is set to B<true>, all disks are collected B<except> the ones matched.
2173 =item B<UseBSDName> B<true>|B<false>
2175 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2176 default major/minor numbers. Requires collectd to be built with Apple's
2177 IOKitLib support.
2179 =item B<UdevNameAttr> I<Attribute>
2181 Attempt to override disk instance name with the value of a specified udev
2182 attribute when built with B<libudev>.  If the attribute is not defined for the
2183 given device, the default name is used. Example:
2185   UdevNameAttr "DM_NAME"
2187 =back
2189 =head2 Plugin C<dns>
2191 =over 4
2193 =item B<Interface> I<Interface>
2195 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2196 option sets the interface that should be used. If this option is not set, or
2197 set to "any", the plugin will try to get packets from B<all> interfaces. This
2198 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2200 =item B<IgnoreSource> I<IP-address>
2202 Ignore packets that originate from this address.
2204 =item B<SelectNumericQueryTypes> B<true>|B<false>
2206 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2208 =back
2210 =head2 Plugin C<email>
2212 =over 4
2214 =item B<SocketFile> I<Path>
2216 Sets the socket-file which is to be created.
2218 =item B<SocketGroup> I<Group>
2220 If running as root change the group of the UNIX-socket after it has been
2221 created. Defaults to B<collectd>.
2223 =item B<SocketPerms> I<Permissions>
2225 Change the file permissions of the UNIX-socket after it has been created. The
2226 permissions must be given as a numeric, octal value as you would pass to
2227 L<chmod(1)>. Defaults to B<0770>.
2229 =item B<MaxConns> I<Number>
2231 Sets the maximum number of connections that can be handled in parallel. Since
2232 this many threads will be started immediately setting this to a very high
2233 value will waste valuable resources. Defaults to B<5> and will be forced to be
2234 at most B<16384> to prevent typos and dumb mistakes.
2236 =back
2238 =head2 Plugin C<ethstat>
2240 The I<ethstat plugin> collects information about network interface cards (NICs)
2241 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2243 B<Synopsis:>
2245  <Plugin "ethstat">
2246    Interface "eth0"
2247    Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2248    Map "multicast" "if_multicast"
2249  </Plugin>
2251 B<Options:>
2253 =over 4
2255 =item B<Interface> I<Name>
2257 Collect statistical information about interface I<Name>.
2259 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2261 By default, the plugin will submit values as type C<derive> and I<type
2262 instance> set to I<Name>, the name of the metric as reported by the driver. If
2263 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2264 I<TypeInstance> will be used.
2266 =item B<MappedOnly> B<true>|B<false>
2268 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2269 collected, all other metrics will be ignored. Defaults to B<false>.
2271 =back
2273 =head2 Plugin C<exec>
2275 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2276 contains valuable information on when the executable is executed and the
2277 output that is expected from it.
2279 =over 4
2281 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2283 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2285 Execute the executable I<Executable> as user I<User>. If the user name is
2286 followed by a colon and a group name, the effective group is set to that group.
2287 The real group and saved-set group will be set to the default group of that
2288 user. If no group is given the effective group ID will be the same as the real
2289 group ID.
2291 Please note that in order to change the user and/or group the daemon needs
2292 superuser privileges. If the daemon is run as an unprivileged user you must
2293 specify the same user/group here. If the daemon is run with superuser
2294 privileges, you must supply a non-root user here.
2296 The executable may be followed by optional arguments that are passed to the
2297 program. Please note that due to the configuration parsing numbers and boolean
2298 values may be changed. If you want to be absolutely sure that something is
2299 passed as-is please enclose it in quotes.
2301 The B<Exec> and B<NotificationExec> statements change the semantics of the
2302 programs executed, i.E<nbsp>e. the data passed to them and the response
2303 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2305 =back
2307 =head2 Plugin C<fhcount>
2309 The C<fhcount> plugin provides statistics about used, unused and total number of
2310 file handles on Linux.
2312 The I<fhcount plugin> provides the following configuration options:
2314 =over 4
2316 =item B<ValuesAbsolute> B<true>|B<false>
2318 Enables or disables reporting of file handles usage in absolute numbers,
2319 e.g. file handles used. Defaults to B<true>.
2321 =item B<ValuesPercentage> B<false>|B<true>
2323 Enables or disables reporting of file handles usage in percentages, e.g.
2324 percent of file handles used. Defaults to B<false>.
2326 =back
2328 =head2 Plugin C<filecount>
2330 The C<filecount> plugin counts the number of files in a certain directory (and
2331 its subdirectories) and their combined size. The configuration is very straight
2332 forward:
2334   <Plugin "filecount">
2335     <Directory "/var/qmail/queue/mess">
2336       Instance "qmail-message"
2337     </Directory>
2338     <Directory "/var/qmail/queue/todo">
2339       Instance "qmail-todo"
2340     </Directory>
2341     <Directory "/var/lib/php5">
2342       Instance "php5-sessions"
2343       Name "sess_*"
2344     </Directory>
2345   </Plugin>
2347 The example above counts the number of files in QMail's queue directories and
2348 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2349 QMail has not yet looked at, the "message" queue holds the messages that were
2350 classified into "local" and "remote".
2352 As you can see, the configuration consists of one or more C<Directory> blocks,
2353 each of which specifies a directory in which to count the files. Within those
2354 blocks, the following options are recognized:
2356 =over 4
2358 =item B<Instance> I<Instance>
2360 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2361 it's your responsibility, the plugin doesn't check for that. If not given, the
2362 instance is set to the directory name with all slashes replaced by underscores
2363 and all leading underscores removed.
2365 =item B<Name> I<Pattern>
2367 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2368 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2369 against the pattern, not the entire path. In case this makes it easier for you:
2370 This option has been named after the B<-name> parameter to L<find(1)>.
2372 =item B<MTime> I<Age>
2374 Count only files of a specific age: If I<Age> is greater than zero, only files
2375 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2376 a negative number, this is inversed. For example, if B<-60> is specified, only
2377 files that have been modified in the last minute will be counted.
2379 The number can also be followed by a "multiplier" to easily specify a larger
2380 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2381 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2382 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2383 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2384 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2385 B<"12h">.
2387 =item B<Size> I<Size>
2389 Count only files of a specific size. When I<Size> is a positive number, only
2390 files that are at least this big are counted. If I<Size> is a negative number,
2391 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2392 I<Size> are counted.
2394 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2395 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2396 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2397 note that there are 1000 bytes in a kilobyte, not 1024.
2399 =item B<Recursive> I<true>|I<false>
2401 Controls whether or not to recurse into subdirectories. Enabled by default.
2403 =item B<IncludeHidden> I<true>|I<false>
2405 Controls whether or not to include "hidden" files and directories in the count.
2406 "Hidden" files and directories are those, whose name begins with a dot.
2407 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2409 =back
2411 =head2 Plugin C<GenericJMX>
2413 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2414 L<collectd-java(5)>.
2416 =head2 Plugin C<gmond>
2418 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2419 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2420 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2422 Synopsis:
2424  <Plugin "gmond">
2425    MCReceiveFrom "239.2.11.71" "8649"
2426    <Metric "swap_total">
2427      Type "swap"
2428      TypeInstance "total"
2429      DataSource "value"
2430    </Metric>
2431    <Metric "swap_free">
2432      Type "swap"
2433      TypeInstance "free"
2434      DataSource "value"
2435    </Metric>
2436  </Plugin>
2438 The following metrics are built-in:
2440 =over 4
2442 =item *
2444 load_one, load_five, load_fifteen
2446 =item *
2448 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2450 =item *
2452 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2454 =item *
2456 bytes_in, bytes_out
2458 =item *
2460 pkts_in, pkts_out
2462 =back
2464 Available configuration options:
2466 =over 4
2468 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2470 Sets sets the multicast group and UDP port to which to subscribe.
2472 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2474 =item E<lt>B<Metric> I<Name>E<gt>
2476 These blocks add a new metric conversion to the internal table. I<Name>, the
2477 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2479 =over 4
2481 =item B<Type> I<Type>
2483 Type to map this metric to. Required.
2485 =item B<TypeInstance> I<Instance>
2487 Type-instance to use. Optional.
2489 =item B<DataSource> I<Name>
2491 Data source to map this metric to. If the configured type has exactly one data
2492 source, this is optional. Otherwise the option is required.
2494 =back
2496 =back
2498 =head2 Plugin C<hddtemp>
2500 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2501 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2502 default values, see below. C<hddtemp> has to be running to work correctly. If
2503 C<hddtemp> is not running timeouts may appear which may interfere with other
2504 statistics..
2506 The B<hddtemp> homepage can be found at
2507 L<http://www.guzu.net/linux/hddtemp.php>.
2509 =over 4
2511 =item B<Host> I<Hostname>
2513 Hostname to connect to. Defaults to B<127.0.0.1>.
2515 =item B<Port> I<Port>
2517 TCP-Port to connect to. Defaults to B<7634>.
2519 =back
2521 =head2 Plugin C<interface>
2523 =over 4
2525 =item B<Interface> I<Interface>
2527 Select this interface. By default these interfaces will then be collected. For
2528 a more detailed description see B<IgnoreSelected> below.
2530 =item B<IgnoreSelected> I<true>|I<false>
2532 If no configuration if given, the B<interface>-plugin will collect data from
2533 all interfaces. This may not be practical, especially for loopback- and
2534 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2535 interfaces you're interested in. Sometimes, however, it's easier/preferred
2536 to collect all interfaces I<except> a few ones. This option enables you to
2537 do that: By setting B<IgnoreSelected> to I<true> the effect of
2538 B<Interface> is inverted: All selected interfaces are ignored and all
2539 other interfaces are collected.
2541 It is possible to use regular expressions to match interface names, if the
2542 name is surrounded by I</.../> and collectd was compiled with support for
2543 regexps. This is useful if there's a need to collect (or ignore) data
2544 for a group of interfaces that are similarly named, without the need to
2545 explicitly list all of them (especially useful if the list is dynamic).
2546 Example:
2548  Interface "lo"
2549  Interface "/^veth/"
2550  Interface "/^tun[0-9]+/"
2551  IgnoreSelected "true"
2553 This will ignore the loopback interface, all interfaces with names starting
2554 with I<veth> and all interfaces with names starting with I<tun> followed by
2555 at least one digit.
2558 =item B<UniqueName> I<true>|I<false>
2560 Interface name is not unique on Solaris (KSTAT), interface name is unique
2561 only within a module/instance. Following tuple is considered unique:
2562    (ks_module, ks_instance, ks_name)
2563 If this option is set to true, interface name contains above three fields
2564 separated by an underscore. For more info on KSTAT, visit
2565 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
2567 This option is only available on Solaris.
2569 =back
2571 =head2 Plugin C<ipmi>
2573 =over 4
2575 =item B<Sensor> I<Sensor>
2577 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2579 =item B<IgnoreSelected> I<true>|I<false>
2581 If no configuration if given, the B<ipmi> plugin will collect data from all
2582 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2583 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2584 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2585 all other sensors are collected.
2587 =item B<NotifySensorAdd> I<true>|I<false>
2589 If a sensor appears after initialization time of a minute a notification
2590 is sent.
2592 =item B<NotifySensorRemove> I<true>|I<false>
2594 If a sensor disappears a notification is sent.
2596 =item B<NotifySensorNotPresent> I<true>|I<false>
2598 If you have for example dual power supply and one of them is (un)plugged then
2599 a notification is sent.
2601 =back
2603 =head2 Plugin C<iptables>
2605 =over 4
2607 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2609 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2611 Select the iptables/ip6tables filter rules to count packets and bytes from.
2613 If only I<Table> and I<Chain> are given, this plugin will collect the counters
2614 of all rules which have a comment-match. The comment is then used as
2615 type-instance.
2617 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2618 the I<n>th rule will be collected. Again, the comment (or the number) will be
2619 used as the type-instance.
2621 If I<Name> is supplied, it will be used as the type-instance instead of the
2622 comment or the number.
2624 =back
2626 =head2 Plugin C<irq>
2628 =over 4
2630 =item B<Irq> I<Irq>
2632 Select this irq. By default these irqs will then be collected. For a more
2633 detailed description see B<IgnoreSelected> below.
2635 =item B<IgnoreSelected> I<true>|I<false>
2637 If no configuration if given, the B<irq>-plugin will collect data from all
2638 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2639 can use the B<Irq>-option to pick the interrupt you're interested in.
2640 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2641 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2642 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2643 and all other interrupts are collected.
2645 =back
2647 =head2 Plugin C<java>
2649 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2650 This section only discusses the syntax and semantic of the configuration
2651 options. For more in-depth information on the I<Java> plugin, please read
2652 L<collectd-java(5)>.
2654 Synopsis:
2656  <Plugin "java">
2657    JVMArg "-verbose:jni"
2658    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2659    LoadPlugin "org.collectd.java.Foobar"
2660    <Plugin "org.collectd.java.Foobar">
2661      # To be parsed by the plugin
2662    </Plugin>
2663  </Plugin>
2665 Available configuration options:
2667 =over 4
2669 =item B<JVMArg> I<Argument>
2671 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2672 exactly the way the arguments to the I<java> binary on the command line work.
2673 Execute C<javaE<nbsp>--help> for details.
2675 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2676 any other options! When another option is found, the JVM will be started and
2677 later options will have to be ignored!
2679 =item B<LoadPlugin> I<JavaClass>
2681 Instantiates a new I<JavaClass> object. The constructor of this object very
2682 likely then registers one or more callback methods with the server.
2684 See L<collectd-java(5)> for details.
2686 When the first such option is found, the virtual machine (JVM) is created. This
2687 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2688 B<LoadPlugin> options!
2690 =item B<Plugin> I<Name>
2692 The entire block is passed to the Java plugin as an
2693 I<org.collectd.api.OConfigItem> object.
2695 For this to work, the plugin has to register a configuration callback first,
2696 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2697 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2698 depends on the (Java) plugin registering the callback and is completely
2699 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2701 =back
2703 =head2 Plugin C<load>
2705 The I<Load plugin> collects the system load. These numbers give a rough overview
2706 over the utilization of a machine. The system load is defined as the number of
2707 runnable tasks in the run-queue and is provided by many operating systems as a
2708 one, five or fifteen minute average.
2710 The following configuration options are available:
2712 =over 4
2714 =item B<ReportRelative> B<false>|B<true>
2716 When enabled, system load divided by number of available CPU cores is reported
2717 for intervals 1 min, 5 min and 15 min. Defaults to false.
2719 =back
2722 =head2 Plugin C<logfile>
2724 =over 4
2726 =item B<LogLevel> B<debug|info|notice|warning|err>
2728 Sets the log-level. If, for example, set to B<notice>, then all events with
2729 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2731 Please note that B<debug> is only available if collectd has been compiled with
2732 debugging support.
2734 =item B<File> I<File>
2736 Sets the file to write log messages to. The special strings B<stdout> and
2737 B<stderr> can be used to write to the standard output and standard error
2738 channels, respectively. This, of course, only makes much sense when I<collectd>
2739 is running in foreground- or non-daemon-mode.
2741 =item B<Timestamp> B<true>|B<false>
2743 Prefix all lines printed by the current time. Defaults to B<true>.
2745 =item B<PrintSeverity> B<true>|B<false>
2747 When enabled, all lines are prefixed by the severity of the log message, for
2748 example "warning". Defaults to B<false>.
2750 =back
2752 B<Note>: There is no need to notify the daemon after moving or removing the
2753 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2754 for each line it writes.
2756 =head2 Plugin C<log_logstash>
2758 The I<log logstash plugin> behaves like the logfile plugin but formats
2759 messages as JSON events for logstash to parse and input.
2761 =over 4
2763 =item B<LogLevel> B<debug|info|notice|warning|err>
2765 Sets the log-level. If, for example, set to B<notice>, then all events with
2766 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2768 Please note that B<debug> is only available if collectd has been compiled with
2769 debugging support.
2771 =item B<File> I<File>
2773 Sets the file to write log messages to. The special strings B<stdout> and
2774 B<stderr> can be used to write to the standard output and standard error
2775 channels, respectively. This, of course, only makes much sense when I<collectd>
2776 is running in foreground- or non-daemon-mode.
2778 =back
2780 B<Note>: There is no need to notify the daemon after moving or removing the
2781 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2782 for each line it writes.
2784 =head2 Plugin C<lpar>
2786 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2787 virtualization technique for IBM POWER processors. It takes into account CPU
2788 time stolen from or donated to a partition, in addition to the usual user,
2789 system, I/O statistics.
2791 The following configuration options are available:
2793 =over 4
2795 =item B<CpuPoolStats> B<false>|B<true>
2797 When enabled, statistics about the processor pool are read, too. The partition
2798 needs to have pool authority in order to be able to acquire this information.
2799 Defaults to false.
2801 =item B<ReportBySerial> B<false>|B<true>
2803 If enabled, the serial of the physical machine the partition is currently
2804 running on is reported as I<hostname> and the logical hostname of the machine
2805 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2806 used (just like other plugins) and the I<plugin instance> will be empty.
2807 Defaults to false.
2809 =back
2811 =head2 Plugin C<mbmon>
2813 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2815 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2816 B<Host> and B<Port> options can be used to change these values, see below.
2817 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2818 timeouts may appear which may interfere with other statistics..
2820 C<mbmon> must be run with the -r option ("print TAG and Value format");
2821 Debian's F</etc/init.d/mbmon> script already does this, other people
2822 will need to ensure that this is the case.
2824 =over 4
2826 =item B<Host> I<Hostname>
2828 Hostname to connect to. Defaults to B<127.0.0.1>.
2830 =item B<Port> I<Port>
2832 TCP-Port to connect to. Defaults to B<411>.
2834 =back
2836 =head2 Plugin C<md>
2838 The C<md plugin> collects information from Linux Software-RAID devices (md).
2840 All reported values are of the type C<md_disks>. Reported type instances are
2841 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2842 I<missing> (physically absent) disks.
2844 =over 4
2846 =item B<Device> I<Device>
2848 Select md devices based on device name. The I<device name> is the basename of
2849 the device, i.e. the name of the block device without the leading C</dev/>.
2850 See B<IgnoreSelected> for more details.
2852 =item B<IgnoreSelected> B<true>|B<false>
2854 Invert device selection: If set to B<true>, all md devices B<except> those
2855 listed using B<Device> are collected. If B<false> (the default), only those
2856 listed are collected. If no configuration is given, the B<md> plugin will
2857 collect data from all md devices.
2859 =back
2861 =head2 Plugin C<memcachec>
2863 The C<memcachec plugin> connects to a memcached server, queries one or more
2864 given I<pages> and parses the returned data according to user specification.
2865 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2866 plugins.
2868 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2869 library. Please note that there is another library with a very similar name,
2870 libmemcache (notice the missing `d'), which is not applicable.
2872 Synopsis of the configuration:
2874  <Plugin "memcachec">
2875    <Page "plugin_instance">
2876      Server "localhost"
2877      Key "page_key"
2878      <Match>
2879        Regex "(\\d+) bytes sent"
2880        DSType CounterAdd
2881        Type "ipt_octets"
2882        Instance "type_instance"
2883      </Match>
2884    </Page>
2885  </Plugin>
2887 The configuration options are:
2889 =over 4
2891 =item E<lt>B<Page> I<Name>E<gt>
2893 Each B<Page> block defines one I<page> to be queried from the memcached server.
2894 The block requires one string argument which is used as I<plugin instance>.
2896 =item B<Server> I<Address>
2898 Sets the server address to connect to when querying the page. Must be inside a
2899 B<Page> block.
2901 =item B<Key> I<Key>
2903 When connected to the memcached server, asks for the page I<Key>.
2905 =item E<lt>B<Match>E<gt>
2907 Match blocks define which strings to look for and how matches substrings are
2908 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2910 =back
2912 =head2 Plugin C<memcached>
2914 The B<memcached plugin> connects to a memcached server and queries statistics
2915 about cache utilization, memory and bandwidth used.
2916 L<http://www.danga.com/memcached/>
2918  <Plugin "memcached">
2919    <Instance "name">
2920      Host "memcache.example.com"
2921      Port 11211
2922    </Instance>
2923  </Plugin>
2925 The plugin configuration consists of one or more B<Instance> blocks which
2926 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2927 following options are allowed:
2929 =over 4
2931 =item B<Host> I<Hostname>
2933 Hostname to connect to. Defaults to B<127.0.0.1>.
2935 =item B<Port> I<Port>
2937 TCP-Port to connect to. Defaults to B<11211>.
2939 =item B<Socket> I<Path>
2941 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2942 setting is given, the B<Host> and B<Port> settings are ignored.
2944 =back
2946 =head2 Plugin C<mic>
2948 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2949 Intel's Many Integrated Core (MIC) systems.
2951 B<Synopsis:>
2953  <Plugin mic>
2954    ShowCPU true
2955    ShowCPUCores true
2956    ShowMemory true
2958    ShowTemperatures true
2959    Temperature vddg
2960    Temperature vddq
2961    IgnoreSelectedTemperature true
2963    ShowPower true
2964    Power total0
2965    Power total1
2966    IgnoreSelectedPower true
2967  </Plugin>
2969 The following options are valid inside the B<PluginE<nbsp>mic> block:
2971 =over 4
2973 =item B<ShowCPU> B<true>|B<false>
2975 If enabled (the default) a sum of the CPU usage across all cores is reported.
2977 =item B<ShowCPUCores> B<true>|B<false>
2979 If enabled (the default) per-core CPU usage is reported.
2981 =item B<ShowMemory> B<true>|B<false>
2983 If enabled (the default) the physical memory usage of the MIC system is
2984 reported.
2986 =item B<ShowTemperatures> B<true>|B<false>
2988 If enabled (the default) various temperatures of the MIC system are reported.
2990 =item B<Temperature> I<Name>
2992 This option controls which temperatures are being reported. Whether matching
2993 temperatures are being ignored or I<only> matching temperatures are reported
2994 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2995 temperatures are reported.
2997 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2999 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3000 (the default) only temperatures matching a B<Temperature> option are reported
3001 or, if no B<Temperature> option is specified, all temperatures are reported. If
3002 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3003 are reported.
3005 Known temperature names are:
3007 =over 4
3009 =item die
3011 Die of the CPU
3013 =item devmem
3015 Device Memory
3017 =item fin
3019 Fan In
3021 =item fout
3023 Fan Out
3025 =item vccp
3027 Voltage ccp
3029 =item vddg
3031 Voltage ddg
3033 =item vddq
3035 Voltage ddq
3037 =back
3039 =item B<ShowPower> B<true>|B<false>
3041 If enabled (the default) various temperatures of the MIC system are reported.
3043 =item B<Power> I<Name>
3045 This option controls which power readings are being reported. Whether matching
3046 power readings are being ignored or I<only> matching power readings are reported
3047 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3048 power readings are reported.
3050 =item B<IgnoreSelectedPower> B<false>|B<true>
3052 Controls the behavior of the B<Power> setting above. If set to B<false>
3053 (the default) only power readings matching a B<Power> option are reported
3054 or, if no B<Power> option is specified, all power readings are reported. If
3055 set to B<true>, matching power readings are I<ignored> and all other power readings
3056 are reported.
3058 Known power names are:
3060 =over 4
3062 =item total0
3064 Total power utilization averaged over Time Window 0 (uWatts).
3066 =item total1
3068 Total power utilization averaged over Time Window 0 (uWatts).
3070 =item inst
3072 Instantaneous power (uWatts).
3074 =item imax
3076 Max instantaneous power (uWatts).
3078 =item pcie
3080 PCI-E connector power (uWatts).
3082 =item c2x3
3084 2x3 connector power (uWatts).
3086 =item c2x4
3088 2x4 connector power (uWatts).
3090 =item vccp
3092 Core rail (uVolts).
3094 =item vddg
3096 Uncore rail (uVolts).
3098 =item vddq
3100 Memory subsystem rail (uVolts).
3102 =back
3104 =back
3106 =head2 Plugin C<memory>
3108 The I<memory plugin> provides the following configuration options:
3110 =over 4
3112 =item B<ValuesAbsolute> B<true>|B<false>
3114 Enables or disables reporting of physical memory usage in absolute numbers,
3115 i.e. bytes. Defaults to B<true>.
3117 =item B<ValuesPercentage> B<false>|B<true>
3119 Enables or disables reporting of physical memory usage in percentages, e.g.
3120 percent of physical memory used. Defaults to B<false>.
3122 This is useful for deploying I<collectd> in a heterogeneous environment in
3123 which the sizes of physical memory vary.
3125 =back
3127 =head2 Plugin C<modbus>
3129 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3130 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3131 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3132 values (two registers interpreted as IEEE floats in big endian notation).
3134 B<Synopsis:>
3136  <Data "voltage-input-1">
3137    RegisterBase 0
3138    RegisterType float
3139    RegisterCmd ReadHolding
3140    Type voltage
3141    Instance "input-1"
3142  </Data>
3144  <Data "voltage-input-2">
3145    RegisterBase 2
3146    RegisterType float
3147    RegisterCmd ReadHolding
3148    Type voltage
3149    Instance "input-2"
3150  </Data>
3152  <Data "supply-temperature-1">
3153    RegisterBase 0
3154    RegisterType Int16
3155    RegisterCmd ReadHolding
3156    Type temperature
3157    Instance "temp-1"
3158  </Data>
3160  <Host "modbus.example.com">
3161    Address "192.168.0.42"
3162    Port    "502"
3163    Interval 60
3165    <Slave 1>
3166      Instance "power-supply"
3167      Collect  "voltage-input-1"
3168      Collect  "voltage-input-2"
3169    </Slave>
3170  </Host>
3172  <Host "localhost">
3173    Device "/dev/ttyUSB0"
3174    Baudrate 38400
3175    Interval 20
3177    <Slave 1>
3178      Instance "temperature"
3179      Collect  "supply-temperature-1"
3180    </Slave>
3181  </Host>
3183 =over 4
3185 =item E<lt>B<Data> I<Name>E<gt> blocks
3187 Data blocks define a mapping between register numbers and the "types" used by
3188 I<collectd>.
3190 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3192 =over 4
3194 =item B<RegisterBase> I<Number>
3196 Configures the base register to read from the device. If the option
3197 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3198 register will be read (the register number is increased by one).
3200 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3202 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3203 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3204 combined into one value. Defaults to B<Uint16>.
3206 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3208 Specifies register type to be collected from device. Works only with libmodbus
3209 2.9.2 or higher. Defaults to B<ReadHolding>.
3211 =item B<Type> I<Type>
3213 Specifies the "type" (data set) to use when dispatching the value to
3214 I<collectd>. Currently, only data sets with exactly one data source are
3215 supported.
3217 =item B<Instance> I<Instance>
3219 Sets the type instance to use when dispatching the value to I<collectd>. If
3220 unset, an empty string (no type instance) is used.
3222 =back
3224 =item E<lt>B<Host> I<Name>E<gt> blocks
3226 Host blocks are used to specify to which hosts to connect and what data to read
3227 from their "slaves". The string argument I<Name> is used as hostname when
3228 dispatching the values to I<collectd>.
3230 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3232 =over 4
3234 =item B<Address> I<Hostname>
3236 For Modbus/TCP, specifies the node name (the actual network address) used to
3237 connect to the host. This may be an IP address or a hostname. Please note that
3238 the used I<libmodbus> library only supports IPv4 at the moment.
3240 =item B<Port> I<Service>
3242 for Modbus/TCP, specifies the port used to connect to the host. The port can
3243 either be given as a number or as a service name. Please note that the
3244 I<Service> argument must be a string, even if ports are given in their numerical
3245 form. Defaults to "502".
3247 =item B<Device> I<Devicenode>
3249 For Modbus/RTU, specifies the path to the serial device being used.
3251 =item B<Baudrate> I<Baudrate>
3253 For Modbus/RTU, specifies the baud rate of the serial device.
3254 Note, connections currently support only 8/N/1.
3256 =item B<Interval> I<Interval>
3258 Sets the interval (in seconds) in which the values will be collected from this
3259 host. By default the global B<Interval> setting will be used.
3261 =item E<lt>B<Slave> I<ID>E<gt>
3263 Over each connection, multiple Modbus devices may be reached. The slave ID
3264 is used to specify which device should be addressed. For each device you want
3265 to query, one B<Slave> block must be given.
3267 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3269 =over 4
3271 =item B<Instance> I<Instance>
3273 Specify the plugin instance to use when dispatching the values to I<collectd>.
3274 By default "slave_I<ID>" is used.
3276 =item B<Collect> I<DataName>
3278 Specifies which data to retrieve from the device. I<DataName> must be the same
3279 string as the I<Name> argument passed to a B<Data> block. You can specify this
3280 option multiple times to collect more than one value from a slave. At least one
3281 B<Collect> option is mandatory.
3283 =back
3285 =back
3287 =back
3289 =head2 Plugin C<mqtt>
3291 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
3292 values from MQTT (B<Subscribe> blocks).
3294 B<Synopsis:>
3296  <Plugin mqtt>
3297    <Publish "name">
3298      Host "mqtt.example.com"
3299      Prefix "collectd"
3300    </Publish>
3301    <Subscribe "name">
3302      Host "mqtt.example.com"
3303      Topic "collectd/#"
3304    </Subscribe>
3305  </Plugin>
3307 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
3308 configuring the sending and receiving direction respectively. The plugin will
3309 register a write callback named C<mqtt/I<name>> where I<name> is the string
3310 argument given to the B<Publish> block. Both types of blocks share many but not
3311 all of the following options. If an option is valid in only one of the blocks,
3312 it will be mentioned explicitly.
3314 B<Options:>
3316 =over 4
3318 =item B<Host> I<Hostname>
3320 Hostname of the MQTT broker to connect to.
3322 =item B<Port> I<Service>
3324 Port number or service name of the MQTT broker to connect to.
3326 =item B<User> I<UserName>
3328 Username used when authenticating to the MQTT broker.
3330 =item B<Password> I<Password>
3332 Password used when authenticating to the MQTT broker.
3334 =item B<ClientId> I<ClientId>
3336 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
3338 =item B<QoS> [B<0>-B<2>]
3340 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
3342 =over 4
3344 =item B<0>
3346 At most once
3348 =item B<1>
3350 At least once
3352 =item B<2>
3354 Exactly once
3356 =back
3358 In B<Publish> blocks, this option determines the QoS flag set on outgoing
3359 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
3360 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
3361 on a message is larger than the maximum accepted QoS of a subscriber, the
3362 message's QoS will be downgraded.
3364 =item B<Prefix> I<Prefix> (Publish only)
3366 This plugin will use one topic per I<value list> which will looks like a path.
3367 I<Prefix> is used as the first path element and defaults to B<collectd>.
3369 An example topic name would be:
3371  collectd/cpu-0/cpu-user
3373 =item B<Retain> B<false>|B<true> (Publish only)
3375 Controls whether the MQTT broker will retain (keep a copy of) the last message
3376 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
3378 =item B<StoreRates> B<true>|B<false> (Publish only)
3380 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
3381 before sending. Defaults to B<true>.
3383 =item B<CleanSession> B<true>|B<false> (Subscribe only)
3385 Controls whether the MQTT "cleans" the session up after the subscriber
3386 disconnects or if it maintains the subscriber's subscriptions and all messages
3387 that arrive while the subscriber is disconnected. Defaults to B<true>.
3389 =item B<Topic> I<TopicName> (Subscribe only)
3391 Configures the topic(s) to subscribe to. You can use the single level C<+> and
3392 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
3393 the B<collectd> branch.
3395 =item B<CACert> I<file>
3397 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
3398 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
3399 port of the MQTT broker.
3400 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3402 =item B<CertificateFile> I<file>
3404 Path to the PEM-encoded certificate file to use as client certificate when
3405 connecting to the MQTT broker.
3406 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3408 =item B<CertificateKeyFile> I<file>
3410 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
3411 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3413 =item B<TLSProtocol> I<protocol>
3415 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
3416 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
3417 version is used which depends on the version of OpenSSL the Mosquitto library
3418 was linked against.
3420 =item B<CipherSuite> I<ciphersuite>
3422 A string describing the ciphers available for use. See L<ciphers(1)> and the
3423 C<openssl ciphers> utility for more information. If unset, the default ciphers
3424 will be used.
3427 =back
3429 =head2 Plugin C<mysql>
3431 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3432 one or more databases when started and keeps the connection up as long as
3433 possible. When the connection is interrupted for whatever reason it will try
3434 to re-connect. The plugin will complain loudly in case anything goes wrong.
3436 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3437 and collects information about MySQL network traffic, executed statements,
3438 requests, the query cache and threads by evaluating the
3439 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3440 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3441 Status Variables> for an explanation of these values.
3443 Optionally, master and slave statistics may be collected in a MySQL
3444 replication setup. In that case, information about the synchronization state
3445 of the nodes are collected by evaluating the C<Position> return value of the
3446 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3447 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3448 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3449 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3450 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3452 Synopsis:
3454   <Plugin mysql>
3455     <Database foo>
3456       Host "hostname"
3457       User "username"
3458       Password "password"
3459       Port "3306"
3460       MasterStats true
3461       ConnectTimeout 10
3462     </Database>
3464     <Database bar>
3465       Alias "squeeze"
3466       Host "localhost"
3467       Socket "/var/run/mysql/mysqld.sock"
3468       SlaveStats true
3469       SlaveNotifications true
3470     </Database>
3471   </Plugin>
3473 A B<Database> block defines one connection to a MySQL database. It accepts a
3474 single argument which specifies the name of the database. None of the other
3475 options are required. MySQL will use default values as documented in the
3476 section "mysql_real_connect()" in the B<MySQL reference manual>.
3478 =over 4
3480 =item B<Alias> I<Alias>
3482 Alias to use as sender instead of hostname when reporting. This may be useful
3483 when having cryptic hostnames.
3485 =item B<Host> I<Hostname>
3487 Hostname of the database server. Defaults to B<localhost>.
3489 =item B<User> I<Username>
3491 Username to use when connecting to the database. The user does not have to be
3492 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3493 unless you want to collectd replication statistics (see B<MasterStats> and
3494 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3495 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3497 =item B<Password> I<Password>
3499 Password needed to log into the database.
3501 =item B<Database> I<Database>
3503 Select this database. Defaults to I<no database> which is a perfectly reasonable
3504 option for what this plugin does.
3506 =item B<Port> I<Port>
3508 TCP-port to connect to. The port must be specified in its numeric form, but it
3509 must be passed as a string nonetheless. For example:
3511   Port "3306"
3513 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3514 See the documentation for the C<mysql_real_connect> function for details.
3516 =item B<Socket> I<Socket>
3518 Specifies the path to the UNIX domain socket of the MySQL server. This option
3519 only has any effect, if B<Host> is set to B<localhost> (the default).
3520 Otherwise, use the B<Port> option above. See the documentation for the
3521 C<mysql_real_connect> function for details.
3523 =item B<InnodbStats> I<true|false>
3525 If enabled, metrics about the InnoDB storage engine are collected.
3526 Disabled by default.
3528 =item B<MasterStats> I<true|false>
3530 =item B<SlaveStats> I<true|false>
3532 Enable the collection of master / slave statistics in a replication setup. In
3533 order to be able to get access to these statistics, the user needs special
3534 privileges. See the B<User> documentation above. Defaults to B<false>.
3536 =item B<SlaveNotifications> I<true|false>
3538 If enabled, the plugin sends a notification if the replication slave I/O and /
3539 or SQL threads are not running. Defaults to B<false>.
3541 =item B<ConnectTimeout> I<Seconds>
3543 Sets the connect timeout for the MySQL client.
3545 =back
3547 =head2 Plugin C<netapp>
3549 The netapp plugin can collect various performance and capacity information
3550 from a NetApp filer using the NetApp API.
3552 Please note that NetApp has a wide line of products and a lot of different
3553 software versions for each of these products. This plugin was developed for a
3554 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3555 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3556 model and software version but it is very hard to test this.
3557 If you have used this plugin with other models and/or software version, feel
3558 free to send us a mail to tell us about the results, even if it's just a short
3559 "It works".
3561 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3562 basic authentication.
3564 B<Do not use a regular user for this!> Create a special collectd user with just
3565 the minimum of capabilities needed. The user only needs the "login-http-admin"
3566 capability as well as a few more depending on which data will be collected.
3567 Required capabilities are documented below.
3569 =head3 Synopsis
3571  <Plugin "netapp">
3572    <Host "netapp1.example.com">
3573     Protocol      "https"
3574     Address       "10.0.0.1"
3575     Port          443
3576     User          "username"
3577     Password      "aef4Aebe"
3578     Interval      30
3580     <WAFL>
3581       Interval 30
3582       GetNameCache   true
3583       GetDirCache    true
3584       GetBufferCache true
3585       GetInodeCache  true
3586     </WAFL>
3588     <Disks>
3589       Interval 30
3590       GetBusy true
3591     </Disks>
3593     <VolumePerf>
3594       Interval 30
3595       GetIO      "volume0"
3596       IgnoreSelectedIO      false
3597       GetOps     "volume0"
3598       IgnoreSelectedOps     false
3599       GetLatency "volume0"
3600       IgnoreSelectedLatency false
3601     </VolumePerf>
3603     <VolumeUsage>
3604       Interval 30
3605       GetCapacity "vol0"
3606       GetCapacity "vol1"
3607       IgnoreSelectedCapacity false
3608       GetSnapshot "vol1"
3609       GetSnapshot "vol3"
3610       IgnoreSelectedSnapshot false
3611     </VolumeUsage>
3613     <Quota>
3614       Interval 60
3615     </Quota>
3617     <Snapvault>
3618       Interval 30
3619     </Snapvault>
3621     <System>
3622       Interval 30
3623       GetCPULoad     true
3624       GetInterfaces  true
3625       GetDiskOps     true
3626       GetDiskIO      true
3627     </System>
3629     <VFiler vfilerA>
3630       Interval 60
3632       SnapVault true
3633       # ...
3634     </VFiler>
3635    </Host>
3636  </Plugin>
3638 The netapp plugin accepts the following configuration options:
3640 =over 4
3642 =item B<Host> I<Name>
3644 A host block defines one NetApp filer. It will appear in collectd with the name
3645 you specify here which does not have to be its real name nor its hostname (see
3646 the B<Address> option below).
3648 =item B<VFiler> I<Name>
3650 A B<VFiler> block may only be used inside a host block. It accepts all the
3651 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3652 will execute all NetApp API commands in the context of the specified
3653 VFiler(R). It will appear in collectd with the name you specify here which
3654 does not have to be its real name. The VFiler name may be specified using the
3655 B<VFilerName> option. If this is not specified, it will default to the name
3656 you specify here.
3658 The VFiler block inherits all connection related settings from the surrounding
3659 B<Host> block (which appear before the B<VFiler> block) but they may be
3660 overwritten inside the B<VFiler> block.
3662 This feature is useful, for example, when using a VFiler as SnapVault target
3663 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3664 available in the host filer (vfiler0) but only in the respective VFiler
3665 context.
3667 =item B<Protocol> B<httpd>|B<http>
3669 The protocol collectd will use to query this host.
3671 Optional
3673 Type: string
3675 Default: https
3677 Valid options: http, https
3679 =item B<Address> I<Address>
3681 The hostname or IP address of the host.
3683 Optional
3685 Type: string
3687 Default: The "host" block's name.
3689 =item B<Port> I<Port>
3691 The TCP port to connect to on the host.
3693 Optional
3695 Type: integer
3697 Default: 80 for protocol "http", 443 for protocol "https"
3699 =item B<User> I<User>
3701 =item B<Password> I<Password>
3703 The username and password to use to login to the NetApp.
3705 Mandatory
3707 Type: string
3709 =item B<VFilerName> I<Name>
3711 The name of the VFiler in which context to execute API commands. If not
3712 specified, the name provided to the B<VFiler> block will be used instead.
3714 Optional
3716 Type: string
3718 Default: name of the B<VFiler> block
3720 B<Note:> This option may only be used inside B<VFiler> blocks.
3722 =item B<Interval> I<Interval>
3724 B<TODO>
3726 =back
3728 The following options decide what kind of data will be collected. You can
3729 either use them as a block and fine tune various parameters inside this block,
3730 use them as a single statement to just accept all default values, or omit it to
3731 not collect any data.
3733 The following options are valid inside all blocks:
3735 =over 4
3737 =item B<Interval> I<Seconds>
3739 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3740 host specific setting.
3742 =back
3744 =head3 The System block
3746 This will collect various performance data about the whole system.
3748 B<Note:> To get this data the collectd user needs the
3749 "api-perf-object-get-instances" capability.
3751 =over 4
3753 =item B<Interval> I<Seconds>
3755 Collect disk statistics every I<Seconds> seconds.
3757 =item B<GetCPULoad> B<true>|B<false>
3759 If you set this option to true the current CPU usage will be read. This will be
3760 the average usage between all CPUs in your NetApp without any information about
3761 individual CPUs.
3763 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3764 returns in the "CPU" field.
3766 Optional
3768 Type: boolean
3770 Default: true
3772 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3774 =item B<GetInterfaces> B<true>|B<false>
3776 If you set this option to true the current traffic of the network interfaces
3777 will be read. This will be the total traffic over all interfaces of your NetApp
3778 without any information about individual interfaces.
3780 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3781 in the "Net kB/s" field.
3783 B<Or is it?>
3785 Optional
3787 Type: boolean
3789 Default: true
3791 Result: One value list of type "if_octects".
3793 =item B<GetDiskIO> B<true>|B<false>
3795 If you set this option to true the current IO throughput will be read. This
3796 will be the total IO of your NetApp without any information about individual
3797 disks, volumes or aggregates.
3799 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3800 in the "DiskE<nbsp>kB/s" field.
3802 Optional
3804 Type: boolean
3806 Default: true
3808 Result: One value list of type "disk_octets".
3810 =item B<GetDiskOps> B<true>|B<false>
3812 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3813 iSCSI, etc. operations will be read. This will be the total number of
3814 operations on your NetApp without any information about individual volumes or
3815 aggregates.
3817 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3818 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3820 Optional
3822 Type: boolean
3824 Default: true
3826 Result: A variable number of value lists of type "disk_ops_complex". Each type
3827 of operation will result in one value list with the name of the operation as
3828 type instance.
3830 =back
3832 =head3 The WAFL block
3834 This will collect various performance data about the WAFL file system. At the
3835 moment this just means cache performance.
3837 B<Note:> To get this data the collectd user needs the
3838 "api-perf-object-get-instances" capability.
3840 B<Note:> The interface to get these values is classified as "Diagnostics" by
3841 NetApp. This means that it is not guaranteed to be stable even between minor
3842 releases.
3844 =over 4
3846 =item B<Interval> I<Seconds>
3848 Collect disk statistics every I<Seconds> seconds.
3850 =item B<GetNameCache> B<true>|B<false>
3852 Optional
3854 Type: boolean
3856 Default: true
3858 Result: One value list of type "cache_ratio" and type instance
3859 "name_cache_hit".
3861 =item B<GetDirCache> B<true>|B<false>
3863 Optional
3865 Type: boolean
3867 Default: true
3869 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3871 =item B<GetInodeCache> B<true>|B<false>
3873 Optional
3875 Type: boolean
3877 Default: true
3879 Result: One value list of type "cache_ratio" and type instance
3880 "inode_cache_hit".
3882 =item B<GetBufferCache> B<true>|B<false>
3884 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3885 in the "Cache hit" field.
3887 Optional
3889 Type: boolean
3891 Default: true
3893 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3895 =back
3897 =head3 The Disks block
3899 This will collect performance data about the individual disks in the NetApp.
3901 B<Note:> To get this data the collectd user needs the
3902 "api-perf-object-get-instances" capability.
3904 =over 4
3906 =item B<Interval> I<Seconds>
3908 Collect disk statistics every I<Seconds> seconds.
3910 =item B<GetBusy> B<true>|B<false>
3912 If you set this option to true the busy time of all disks will be calculated
3913 and the value of the busiest disk in the system will be written.
3915 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3916 in the "Disk util" field. Probably.
3918 Optional
3920 Type: boolean
3922 Default: true
3924 Result: One value list of type "percent" and type instance "disk_busy".
3926 =back
3928 =head3 The VolumePerf block
3930 This will collect various performance data about the individual volumes.
3932 You can select which data to collect about which volume using the following
3933 options. They follow the standard ignorelist semantic.
3935 B<Note:> To get this data the collectd user needs the
3936 I<api-perf-object-get-instances> capability.
3938 =over 4
3940 =item B<Interval> I<Seconds>
3942 Collect volume performance data every I<Seconds> seconds.
3944 =item B<GetIO> I<Volume>
3946 =item B<GetOps> I<Volume>
3948 =item B<GetLatency> I<Volume>
3950 Select the given volume for IO, operations or latency statistics collection.
3951 The argument is the name of the volume without the C</vol/> prefix.
3953 Since the standard ignorelist functionality is used here, you can use a string
3954 starting and ending with a slash to specify regular expression matching: To
3955 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3956 expression:
3958   GetIO "/^vol[027]$/"
3960 If no regular expression is specified, an exact match is required. Both,
3961 regular and exact matching are case sensitive.
3963 If no volume was specified at all for either of the three options, that data
3964 will be collected for all available volumes.
3966 =item B<IgnoreSelectedIO> B<true>|B<false>
3968 =item B<IgnoreSelectedOps> B<true>|B<false>
3970 =item B<IgnoreSelectedLatency> B<true>|B<false>
3972 When set to B<true>, the volumes selected for IO, operations or latency
3973 statistics collection will be ignored and the data will be collected for all
3974 other volumes.
3976 When set to B<false>, data will only be collected for the specified volumes and
3977 all other volumes will be ignored.
3979 If no volumes have been specified with the above B<Get*> options, all volumes
3980 will be collected regardless of the B<IgnoreSelected*> option.
3982 Defaults to B<false>
3984 =back
3986 =head3 The VolumeUsage block
3988 This will collect capacity data about the individual volumes.
3990 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3991 capability.
3993 =over 4
3995 =item B<Interval> I<Seconds>
3997 Collect volume usage statistics every I<Seconds> seconds.
3999 =item B<GetCapacity> I<VolumeName>
4001 The current capacity of the volume will be collected. This will result in two
4002 to four value lists, depending on the configuration of the volume. All data
4003 sources are of type "df_complex" with the name of the volume as
4004 plugin_instance.
4006 There will be type_instances "used" and "free" for the number of used and
4007 available bytes on the volume.  If the volume has some space reserved for
4008 snapshots, a type_instance "snap_reserved" will be available.  If the volume
4009 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4010 number of bytes saved by the SIS feature.
4012 B<Note:> The current NetApp API has a bug that results in this value being
4013 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4014 number which works most of the time.  If you see strange values here, bug
4015 NetApp support to fix this.
4017 Repeat this option to specify multiple volumes.
4019 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4021 Specify whether to collect only the volumes selected by the B<GetCapacity>
4022 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4023 B<false>. However, if no B<GetCapacity> option is specified at all, all
4024 capacities will be selected anyway.
4026 =item B<GetSnapshot> I<VolumeName>
4028 Select volumes from which to collect snapshot information.
4030 Usually, the space used for snapshots is included in the space reported as
4031 "used". If snapshot information is collected as well, the space used for
4032 snapshots is subtracted from the used space.
4034 To make things even more interesting, it is possible to reserve space to be
4035 used for snapshots. If the space required for snapshots is less than that
4036 reserved space, there is "reserved free" and "reserved used" space in addition
4037 to "free" and "used". If the space required for snapshots exceeds the reserved
4038 space, that part allocated in the normal space is subtracted from the "used"
4039 space again.
4041 Repeat this option to specify multiple volumes.
4043 =item B<IgnoreSelectedSnapshot>
4045 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4046 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4047 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4048 capacities will be selected anyway.
4050 =back
4052 =head3 The Quota block
4054 This will collect (tree) quota statistics (used disk space and number of used
4055 files). This mechanism is useful to get usage information for single qtrees.
4056 In case the quotas are not used for any other purpose, an entry similar to the
4057 following in C</etc/quotas> would be sufficient:
4059   /vol/volA/some_qtree tree - - - - -
4061 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4063 =over 4
4065 =item B<Interval> I<Seconds>
4067 Collect SnapVault(R) statistics every I<Seconds> seconds.
4069 =back
4071 =head3 The SnapVault block
4073 This will collect statistics about the time and traffic of SnapVault(R)
4074 transfers.
4076 =over 4
4078 =item B<Interval> I<Seconds>
4080 Collect SnapVault(R) statistics every I<Seconds> seconds.
4082 =back
4084 =head2 Plugin C<netlink>
4086 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4087 statistics of various interface and routing aspects.
4089 =over 4
4091 =item B<Interface> I<Interface>
4093 =item B<VerboseInterface> I<Interface>
4095 Instruct the plugin to collect interface statistics. This is basically the same
4096 as the statistics provided by the C<interface> plugin (see above) but
4097 potentially much more detailed.
4099 When configuring with B<Interface> only the basic statistics will be collected,
4100 namely octets, packets, and errors. These statistics are collected by
4101 the C<interface> plugin, too, so using both at the same time is no benefit.
4103 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4104 so that no data needs to be collected twice if you use the C<interface> plugin.
4105 This includes dropped packets, received multicast packets, collisions and a
4106 whole zoo of differentiated RX and TX errors. You can try the following command
4107 to get an idea of what awaits you:
4109   ip -s -s link list
4111 If I<Interface> is B<All>, all interfaces will be selected.
4113 =item B<QDisc> I<Interface> [I<QDisc>]
4115 =item B<Class> I<Interface> [I<Class>]
4117 =item B<Filter> I<Interface> [I<Filter>]
4119 Collect the octets and packets that pass a certain qdisc, class or filter.
4121 QDiscs and classes are identified by their type and handle (or classid).
4122 Filters don't necessarily have a handle, therefore the parent's handle is used.
4123 The notation used in collectd differs from that used in tc(1) in that it
4124 doesn't skip the major or minor number if it's zero and doesn't print special
4125 ids by their name. So, for example, a qdisc may be identified by
4126 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4127 thus not displayed by tc(1).
4129 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4130 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4131 associated with that interface will be collected.
4133 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4134 used. This may lead to problems when more than one filter is attached to a
4135 qdisc or class. This isn't nice, but we don't know how this could be done any
4136 better. If you have a idea, please don't hesitate to tell us.
4138 As with the B<Interface> option you can specify B<All> as the interface,
4139 meaning all interfaces.
4141 Here are some examples to help you understand the above text more easily:
4143   <Plugin netlink>
4144     VerboseInterface "All"
4145     QDisc "eth0" "pfifo_fast-1:0"
4146     QDisc "ppp0"
4147     Class "ppp0" "htb-1:10"
4148     Filter "ppp0" "u32-1:0"
4149   </Plugin>
4151 =item B<IgnoreSelected>
4153 The behavior is the same as with all other similar plugins: If nothing is
4154 selected at all, everything is collected. If some things are selected using the
4155 options described above, only these statistics are collected. If you set
4156 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4157 specified statistics will not be collected.
4159 =back
4161 =head2 Plugin C<network>
4163 The Network plugin sends data to a remote instance of collectd, receives data
4164 from a remote instance, or both at the same time. Data which has been received
4165 from the network is usually not transmitted again, but this can be activated, see
4166 the B<Forward> option below.
4168 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4169 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4171 Both, B<Server> and B<Listen> can be used as single option or as block. When
4172 used as block, given options are valid for this socket only. The following
4173 example will export the metrics twice: Once to an "internal" server (without
4174 encryption and signing) and one to an external server (with cryptographic
4175 signature):
4177  <Plugin "network">
4178    # Export to an internal server
4179    # (demonstrates usage without additional options)
4180    Server "collectd.internal.tld"
4182    # Export to an external server
4183    # (demonstrates usage with signature options)
4184    <Server "collectd.external.tld">
4185      SecurityLevel "sign"
4186      Username "myhostname"
4187      Password "ohl0eQue"
4188    </Server>
4189  </Plugin>
4191 =over 4
4193 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4195 The B<Server> statement/block sets the server to send datagrams to. The
4196 statement may occur multiple times to send each datagram to multiple
4197 destinations.
4199 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4200 optional second argument specifies a port number or a service name. If not
4201 given, the default, B<25826>, is used.
4203 The following options are recognized within B<Server> blocks:
4205 =over 4
4207 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4209 Set the security you require for network communication. When the security level
4210 has been set to B<Encrypt>, data sent over the network will be encrypted using
4211 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4212 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4213 authentication code. When set to B<None>, data is sent without any security.
4215 This feature is only available if the I<network> plugin was linked with
4216 I<libgcrypt>.
4218 =item B<Username> I<Username>
4220 Sets the username to transmit. This is used by the server to lookup the
4221 password. See B<AuthFile> below. All security levels except B<None> require
4222 this setting.
4224 This feature is only available if the I<network> plugin was linked with
4225 I<libgcrypt>.
4227 =item B<Password> I<Password>
4229 Sets a password (shared secret) for this socket. All security levels except
4230 B<None> require this setting.
4232 This feature is only available if the I<network> plugin was linked with
4233 I<libgcrypt>.
4235 =item B<Interface> I<Interface name>
4237 Set the outgoing interface for IP packets. This applies at least
4238 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4239 undefined or a non-existent interface name is specified, the default
4240 behavior is to let the kernel choose the appropriate interface. Be warned
4241 that the manual selection of an interface for unicast traffic is only
4242 necessary in rare cases.
4244 =item B<ResolveInterval> I<Seconds>
4246 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4247 useful to force a regular DNS lookup to support a high availability setup. If
4248 not specified, re-resolves are never attempted.
4250 =back
4252 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4254 The B<Listen> statement sets the interfaces to bind to. When multiple
4255 statements are found the daemon will bind to multiple interfaces.
4257 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4258 the argument is a multicast address the daemon will join that multicast group.
4259 The optional second argument specifies a port number or a service name. If not
4260 given, the default, B<25826>, is used.
4262 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4264 =over 4
4266 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4268 Set the security you require for network communication. When the security level
4269 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4270 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4271 signed and encrypted data is accepted. When set to B<None>, all data will be
4272 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4273 decrypted if possible.
4275 This feature is only available if the I<network> plugin was linked with
4276 I<libgcrypt>.
4278 =item B<AuthFile> I<Filename>
4280 Sets a file in which usernames are mapped to passwords. These passwords are
4281 used to verify signatures and to decrypt encrypted network packets. If
4282 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4283 verified and encrypted packets are decrypted. Otherwise, signed data is
4284 accepted without checking the signature and encrypted data cannot be decrypted.
4285 For the other security levels this option is mandatory.
4287 The file format is very simple: Each line consists of a username followed by a
4288 colon and any number of spaces followed by the password. To demonstrate, an
4289 example file could look like this:
4291   user0: foo
4292   user1: bar
4294 Each time a packet is received, the modification time of the file is checked
4295 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4296 the file is being read, it is locked using L<fcntl(2)>.
4298 =item B<Interface> I<Interface name>
4300 Set the incoming interface for IP packets explicitly. This applies at least
4301 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4302 undefined or a non-existent interface name is specified, the default
4303 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4304 traffic gets only accepted, if it arrives on the given interface.
4306 =back
4308 =item B<TimeToLive> I<1-255>
4310 Set the time-to-live of sent packets. This applies to all, unicast and
4311 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4312 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4313 operating systems.
4315 =item B<MaxPacketSize> I<1024-65535>
4317 Set the maximum size for datagrams received over the network. Packets larger
4318 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4319 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4320 UDP.
4322 On the server side, this limit should be set to the largest value used on
4323 I<any> client. Likewise, the value on the client must not be larger than the
4324 value on the server, or data will be lost.
4326 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4327 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4328 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4329 server.
4331 =item B<Forward> I<true|false>
4333 If set to I<true>, write packets that were received via the network plugin to
4334 the sending sockets. This should only be activated when the B<Listen>- and
4335 B<Server>-statements differ. Otherwise packets may be send multiple times to
4336 the same multicast group. While this results in more network traffic than
4337 necessary it's not a huge problem since the plugin has a duplicate detection,
4338 so the values will not loop.
4340 =item B<ReportStats> B<true>|B<false>
4342 The network plugin cannot only receive and send statistics, it can also create
4343 statistics about itself. Collected data included the number of received and
4344 sent octets and packets, the length of the receive queue and the number of
4345 values handled. When set to B<true>, the I<Network plugin> will make these
4346 statistics available. Defaults to B<false>.
4348 =back
4350 =head2 Plugin C<nginx>
4352 This plugin collects the number of connections and requests handled by the
4353 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4354 queries the page provided by the C<ngx_http_stub_status_module> module, which
4355 isn't compiled by default. Please refer to
4356 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4357 how to compile and configure nginx and this module.
4359 The following options are accepted by the C<nginx plugin>:
4361 =over 4
4363 =item B<URL> I<http://host/nginx_status>
4365 Sets the URL of the C<ngx_http_stub_status_module> output.
4367 =item B<User> I<Username>
4369 Optional user name needed for authentication.
4371 =item B<Password> I<Password>
4373 Optional password needed for authentication.
4375 =item B<VerifyPeer> B<true|false>
4377 Enable or disable peer SSL certificate verification. See
4378 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4380 =item B<VerifyHost> B<true|false>
4382 Enable or disable peer host name verification. If enabled, the plugin checks
4383 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4384 certificate matches the host name provided by the B<URL> option. If this
4385 identity check fails, the connection is aborted. Obviously, only works when
4386 connecting to a SSL enabled server. Enabled by default.
4388 =item B<CACert> I<File>
4390 File that holds one or more SSL certificates. If you want to use HTTPS you will
4391 possibly need this option. What CA certificates come bundled with C<libcurl>
4392 and are checked by default depends on the distribution you use.
4394 =item B<Timeout> I<Milliseconds>
4396 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4397 milliseconds. By default, the configured B<Interval> is used to set the
4398 timeout.
4400 =back
4402 =head2 Plugin C<notify_desktop>
4404 This plugin sends a desktop notification to a notification daemon, as defined
4405 in the Desktop Notification Specification. To actually display the
4406 notifications, B<notification-daemon> is required and B<collectd> has to be
4407 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4408 environment variables have to be set correctly) and the D-Bus message bus.
4410 The Desktop Notification Specification can be found at
4411 L<http://www.galago-project.org/specs/notification/>.
4413 =over 4
4415 =item B<OkayTimeout> I<timeout>
4417 =item B<WarningTimeout> I<timeout>
4419 =item B<FailureTimeout> I<timeout>
4421 Set the I<timeout>, in milliseconds, after which to expire the notification
4422 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4423 been specified, the displayed notification will not be closed at all - the
4424 user has to do so herself. These options default to 5000. If a negative number
4425 has been specified, the default is used as well.
4427 =back
4429 =head2 Plugin C<notify_email>
4431 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4432 configured email address.
4434 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4436 Available configuration options:
4438 =over 4
4440 =item B<From> I<Address>
4442 Email address from which the emails should appear to come from.
4444 Default: C<root@localhost>
4446 =item B<Recipient> I<Address>
4448 Configures the email address(es) to which the notifications should be mailed.
4449 May be repeated to send notifications to multiple addresses.
4451 At least one B<Recipient> must be present for the plugin to work correctly.
4453 =item B<SMTPServer> I<Hostname>
4455 Hostname of the SMTP server to connect to.
4457 Default: C<localhost>
4459 =item B<SMTPPort> I<Port>
4461 TCP port to connect to.
4463 Default: C<25>
4465 =item B<SMTPUser> I<Username>
4467 Username for ASMTP authentication. Optional.
4469 =item B<SMTPPassword> I<Password>
4471 Password for ASMTP authentication. Optional.
4473 =item B<Subject> I<Subject>
4475 Subject-template to use when sending emails. There must be exactly two
4476 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4477 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4478 with the hostname.
4480 Default: C<Collectd notify: %s@%s>
4482 =back
4484 =head2 Plugin C<notify_nagios>
4486 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
4487 a I<passive service check result>.
4489 Available configuration options:
4491 =over 4
4493 =item B<CommandFile> I<Path>
4495 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
4497 =back
4499 =head2 Plugin C<ntpd>
4501 The C<ntpd> plugin collects per-peer ntpd data such as time offset and time
4502 dispersion.
4504 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
4505 wire - using B<mode 7> specific requests. This mode is deprecated with
4506 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
4507 correctly with them, the ntp daemon must be explicitly configured to
4508 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
4509 manual page for details.
4511 Available configuration options for the C<ntpd> plugin:
4513 =over 4
4515 =item B<Host> I<Hostname>
4517 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4519 =item B<Port> I<Port>
4521 UDP-Port to connect to. Defaults to B<123>.
4523 =item B<ReverseLookups> B<true>|B<false>
4525 Sets whether or not to perform reverse lookups on peers. Since the name or
4526 IP-address may be used in a filename it is recommended to disable reverse
4527 lookups. The default is to do reverse lookups to preserve backwards
4528 compatibility, though.
4530 =item B<IncludeUnitID> B<true>|B<false>
4532 When a peer is a refclock, include the unit ID in the I<type instance>.
4533 Defaults to B<false> for backward compatibility.
4535 If two refclock peers use the same driver and this is B<false>, the plugin will
4536 try to write simultaneous measurements from both to the same type instance.
4537 This will result in error messages in the log and only one set of measurements
4538 making it through.
4540 =back
4542 =head2 Plugin C<nut>
4544 =over 4
4546 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4548 Add a UPS to collect data from. The format is identical to the one accepted by
4549 L<upsc(8)>.
4551 =back
4553 =head2 Plugin C<olsrd>
4555 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4556 the Optimized Link State Routing daemon and reads information about the current
4557 state of the meshed network.
4559 The following configuration options are understood:
4561 =over 4
4563 =item B<Host> I<Host>
4565 Connect to I<Host>. Defaults to B<"localhost">.
4567 =item B<Port> I<Port>
4569 Specifies the port to connect to. This must be a string, even if you give the
4570 port as a number rather than a service name. Defaults to B<"2006">.
4572 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4574 Specifies what information to collect about links, i.E<nbsp>e. direct
4575 connections of the daemon queried. If set to B<No>, no information is
4576 collected. If set to B<Summary>, the number of links and the average of all
4577 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4578 If set to B<Detail> LQ and NLQ are collected per link.
4580 Defaults to B<Detail>.
4582 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4584 Specifies what information to collect about routes of the daemon queried. If
4585 set to B<No>, no information is collected. If set to B<Summary>, the number of
4586 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4587 metric and ETX are collected per route.
4589 Defaults to B<Summary>.
4591 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4593 Specifies what information to collect about the global topology. If set to
4594 B<No>, no information is collected. If set to B<Summary>, the number of links
4595 in the entire topology and the average I<link quality> (LQ) is calculated.
4596 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4598 Defaults to B<Summary>.
4600 =back
4602 =head2 Plugin C<onewire>
4604 B<EXPERIMENTAL!> See notes below.
4606 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4607 L<http://owfs.org/> to read sensors connected via the onewire bus.
4609 It can be used in two possible modes - standard or advanced.
4611 In the standard mode only temperature sensors (sensors with the family code
4612 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4613 other sensors you would like to have included, please send a sort request to
4614 the mailing list. You can select sensors to be read or to be ignored depending
4615 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4616 walked and all sensors are read.
4618 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4619 experimental, below.
4621 In the advanced mode you can configure any sensor to be read (only numerical
4622 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4623 In this mode you have to list all the sensors. Neither default bus walk nor
4624 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4625 the path automatically and should produce compatible structure with the "standard"
4626 mode (basically the path is expected as for example
4627 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4628 "F10FCA000800" and the rest after the slash is considered the type - here
4629 "temperature").
4630 There are two advantages to this mode - you can access virtually any sensor
4631 (not just temperature), select whether to use cached or directly read values
4632 and it is slighlty faster. The downside is more complex configuration.
4634 The two modes are distinguished automatically by the format of the address.
4635 It is not possible to mix the two modes. Once a full path is detected in any
4636 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4637 (and as standard addresses will fail parsing they will be ignored).
4639 =over 4
4641 =item B<Device> I<Device>
4643 Sets the device to read the values from. This can either be a "real" hardware
4644 device, such as a serial port or an USB port, or the address of the
4645 L<owserver(1)> socket, usually B<localhost:4304>.
4647 Though the documentation claims to automatically recognize the given address
4648 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4649 with that version, the following configuration worked for us:
4651   <Plugin onewire>
4652     Device "-s localhost:4304"
4653   </Plugin>
4655 This directive is B<required> and does not have a default value.
4657 =item B<Sensor> I<Sensor>
4659 In the standard mode selects sensors to collect or to ignore
4660 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4661 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4662 and B<not> include the leading C<10.> family byte and point.
4663 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4664 sensors (see above) are read.
4666 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4667 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4668 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4670 As there can be multiple devices on the bus you can list multiple sensor (use
4671 multiple B<Sensor> elements).
4673 =item B<IgnoreSelected> I<true>|I<false>
4675 If no configuration is given, the B<onewire> plugin will collect data from all
4676 sensors found. This may not be practical, especially if sensors are added and
4677 removed regularly. Sometimes, however, it's easier/preferred to collect only
4678 specific sensors or all sensors I<except> a few specified ones. This option
4679 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4680 B<Sensor> is inverted: All selected interfaces are ignored and all other
4681 interfaces are collected.
4683 Used only in the standard mode - see above.
4685 =item B<Interval> I<Seconds>
4687 Sets the interval in which all sensors should be read. If not specified, the
4688 global B<Interval> setting is used.
4690 =back
4692 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4693 work with big setups. It works with one sensor being attached to one
4694 controller, but as soon as you throw in a couple more senors and maybe a hub
4695 or two, reading all values will take more than ten seconds (the default
4696 interval). We will probably add some separate thread for reading the sensors
4697 and some cache or something like that, but it's not done yet. We will try to
4698 maintain backwards compatibility in the future, but we can't promise. So in
4699 short: If it works for you: Great! But keep in mind that the config I<might>
4700 change, though this is unlikely. Oh, and if you want to help improving this
4701 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4703 =head2 Plugin C<openldap>
4705 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4706 server correctly. The backend database C<monitor> needs to be loaded and
4707 working. See slapd-monitor(5) for the details.
4709 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4710 blocks. Each block requires one string argument as the instance name. For
4711 example:
4713  <Plugin "openldap">
4714    <Instance "foo">
4715      URL "ldap://localhost/"
4716    </Instance>
4717    <Instance "bar">
4718      URL "ldaps://localhost/"
4719    </Instance>
4720  </Plugin>
4722 The instance name will be used as the I<plugin instance>. To emulate the old
4723 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4724 plugin to work correctly, each instance name must be unique. This is not
4725 enforced by the plugin and it is your responsibility to ensure it is.
4727 The following options are accepted within each B<Instance> block:
4729 =over 4
4731 =item B<URL> I<ldap://host/binddn>
4733 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4734 I<mandatory>.
4736 =item B<BindDN> I<BindDN>
4738 Name in the form of an LDAP distinguished name intended to be used for
4739 authentication. Defaults to empty string to establish an anonymous authorization.
4741 =item B<Password> I<Password>
4743 Password for simple bind authentication. If this option is not set,
4744 unauthenticated bind operation is used.
4746 =item B<StartTLS> B<true|false>
4748 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4749 Disabled by default.
4751 =item B<VerifyHost> B<true|false>
4753 Enables or disables peer host name verification. If enabled, the plugin checks
4754 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4755 certificate matches the host name provided by the B<URL> option. If this
4756 identity check fails, the connection is aborted. Enabled by default.
4758 =item B<CACert> I<File>
4760 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4761 may possibly need this option. What CA certificates are checked by default
4762 depends on the distribution you use and can be changed with the usual ldap
4763 client configuration mechanisms. See ldap.conf(5) for the details.
4765 =item B<Timeout> I<Seconds>
4767 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4768 an infinite timeout.
4770 =item B<Version> I<Version>
4772 An integer which sets the LDAP protocol version number to use when connecting
4773 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4775 =back
4777 =head2 Plugin C<openvpn>
4779 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4780 traffic statistics about connected clients.
4782 To set up OpenVPN to write to the status file periodically, use the
4783 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4784 you need to set the required format, too. This is done by setting
4785 B<--status-version> to B<2>.
4787 So, in a nutshell you need:
4789   openvpn $OTHER_OPTIONS \
4790     --status "/var/run/openvpn-status" 10 \
4791     --status-version 2
4793 Available options:
4795 =over 4
4797 =item B<StatusFile> I<File>
4799 Specifies the location of the status file.
4801 =item B<ImprovedNamingSchema> B<true>|B<false>
4803 When enabled, the filename of the status file will be used as plugin instance
4804 and the client's "common name" will be used as type instance. This is required
4805 when reading multiple status files. Enabling this option is recommended, but to
4806 maintain backwards compatibility this option is disabled by default.
4808 =item B<CollectCompression> B<true>|B<false>
4810 Sets whether or not statistics about the compression used by OpenVPN should be
4811 collected. This information is only available in I<single> mode. Enabled by
4812 default.
4814 =item B<CollectIndividualUsers> B<true>|B<false>
4816 Sets whether or not traffic information is collected for each connected client
4817 individually. If set to false, currently no traffic data is collected at all
4818 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4820 =item B<CollectUserCount> B<true>|B<false>
4822 When enabled, the number of currently connected clients or users is collected.
4823 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4824 can be configured independently from that option. Defaults to B<false>.
4826 =back
4828 =head2 Plugin C<oracle>
4830 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4831 Oracle® Database and lets you execute SQL statements there. It is very similar
4832 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4833 plugin's documentation above for details.
4835   <Plugin oracle>
4836     <Query "out_of_stock">
4837       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4838       <Result>
4839         Type "gauge"
4840         # InstancePrefix "foo"
4841         InstancesFrom "category"
4842         ValuesFrom "value"
4843       </Result>
4844     </Query>
4845     <Database "product_information">
4846       ConnectID "db01"
4847       Username "oracle"
4848       Password "secret"
4849       Query "out_of_stock"
4850     </Database>
4851   </Plugin>
4853 =head3 B<Query> blocks
4855 The Query blocks are handled identically to the Query blocks of the "dbi"
4856 plugin. Please see its documentation above for details on how to specify
4857 queries.
4859 =head3 B<Database> blocks
4861 Database blocks define a connection to a database and which queries should be
4862 sent to that database. Each database needs a "name" as string argument in the
4863 starting tag of the block. This name will be used as "PluginInstance" in the
4864 values submitted to the daemon. Other than that, that name is not used.
4866 =over 4
4868 =item B<ConnectID> I<ID>
4870 Defines the "database alias" or "service name" to connect to. Usually, these
4871 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4873 =item B<Host> I<Host>
4875 Hostname to use when dispatching values for this database. Defaults to using
4876 the global hostname of the I<collectd> instance.
4878 =item B<Username> I<Username>
4880 Username used for authentication.
4882 =item B<Password> I<Password>
4884 Password used for authentication.
4886 =item B<Query> I<QueryName>
4888 Associates the query named I<QueryName> with this database connection. The
4889 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4890 blocks you want to refer to must be placed above the database block you want to
4891 refer to them from.
4893 =back
4895 =head2 Plugin C<perl>
4897 This plugin embeds a Perl-interpreter into collectd and provides an interface
4898 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4900 =head2 Plugin C<pinba>
4902 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4903 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4904 PHP-based webpage has been delivered, the extension will send a UDP packet
4905 containing timing information, peak memory usage and so on. The plugin will
4906 wait for such packets, parse them and account the provided information, which
4907 is then dispatched to the daemon once per interval.
4909 Synopsis:
4911  <Plugin pinba>
4912    Address "::0"
4913    Port "30002"
4914    # Overall statistics for the website.
4915    <View "www-total">
4916      Server "www.example.com"
4917    </View>
4918    # Statistics for www-a only
4919    <View "www-a">
4920      Host "www-a.example.com"
4921      Server "www.example.com"
4922    </View>
4923    # Statistics for www-b only
4924    <View "www-b">
4925      Host "www-b.example.com"
4926      Server "www.example.com"
4927    </View>
4928  </Plugin>
4930 The plugin provides the following configuration options:
4932 =over 4
4934 =item B<Address> I<Node>
4936 Configures the address used to open a listening socket. By default, plugin will
4937 bind to the I<any> address C<::0>.
4939 =item B<Port> I<Service>
4941 Configures the port (service) to bind to. By default the default Pinba port
4942 "30002" will be used. The option accepts service names in addition to port
4943 numbers and thus requires a I<string> argument.
4945 =item E<lt>B<View> I<Name>E<gt> block
4947 The packets sent by the Pinba extension include the hostname of the server, the
4948 server name (the name of the virtual host) and the script that was executed.
4949 Using B<View> blocks it is possible to separate the data into multiple groups
4950 to get more meaningful statistics. Each packet is added to all matching groups,
4951 so that a packet may be accounted for more than once.
4953 =over 4
4955 =item B<Host> I<Host>
4957 Matches the hostname of the system the webserver / script is running on. This
4958 will contain the result of the L<gethostname(2)> system call. If not
4959 configured, all hostnames will be accepted.
4961 =item B<Server> I<Server>
4963 Matches the name of the I<virtual host>, i.e. the contents of the
4964 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4965 server names will be accepted.
4967 =item B<Script> I<Script>
4969 Matches the name of the I<script name>, i.e. the contents of the
4970 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4971 script names will be accepted.
4973 =back
4975 =back
4977 =head2 Plugin C<ping>
4979 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4980 configured hosts periodically and measures the network latency. Whenever the
4981 C<read> function of the plugin is called, it submits the average latency, the
4982 standard deviation and the drop rate for each host.
4984 Available configuration options:
4986 =over 4
4988 =item B<Host> I<IP-address>
4990 Host to ping periodically. This option may be repeated several times to ping
4991 multiple hosts.
4993 =item B<Interval> I<Seconds>
4995 Sets the interval in which to send ICMP echo packets to the configured hosts.
4996 This is B<not> the interval in which statistics are queries from the plugin but
4997 the interval in which the hosts are "pinged". Therefore, the setting here
4998 should be smaller than or equal to the global B<Interval> setting. Fractional
4999 times, such as "1.24" are allowed.
5001 Default: B<1.0>
5003 =item B<Timeout> I<Seconds>
5005 Time to wait for a response from the host to which an ICMP packet had been
5006 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
5007 to be down or the packet to be dropped. This setting must be smaller than the
5008 B<Interval> setting above for the plugin to work correctly. Fractional
5009 arguments are accepted.
5011 Default: B<0.9>
5013 =item B<TTL> I<0-255>
5015 Sets the Time-To-Live of generated ICMP packets.
5017 =item B<Size> I<size>
5019 Sets the size of the data payload in ICMP packet to specified I<size> (it
5020 will be filled with regular ASCII pattern). If not set, default 56 byte
5021 long string is used so that the packet size of an ICMPv4 packet is exactly
5022 64 bytes, similar to the behaviour of normal ping(1) command.
5024 =item B<SourceAddress> I<host>
5026 Sets the source address to use. I<host> may either be a numerical network
5027 address or a network hostname.
5029 =item B<Device> I<name>
5031 Sets the outgoing network device to be used. I<name> has to specify an
5032 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
5033 operating systems.
5035 =item B<MaxMissed> I<Packets>
5037 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
5038 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
5040 Default: B<-1> (disabled)
5042 =back
5044 =head2 Plugin C<postgresql>
5046 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
5047 keeps a persistent connection to all configured databases and tries to
5048 reconnect if the connection has been interrupted. A database is configured by
5049 specifying a B<Database> block as described below. The default statistics are
5050 collected from PostgreSQL's B<statistics collector> which thus has to be
5051 enabled for this plugin to work correctly. This should usually be the case by
5052 default. See the section "The Statistics Collector" of the B<PostgreSQL
5053 Documentation> for details.
5055 By specifying custom database queries using a B<Query> block as described
5056 below, you may collect any data that is available from some PostgreSQL
5057 database. This way, you are able to access statistics of external daemons
5058 which are available in a PostgreSQL database or use future or special
5059 statistics provided by PostgreSQL without the need to upgrade your collectd
5060 installation.
5062 Starting with version 5.2, the C<postgresql> plugin supports writing data to
5063 PostgreSQL databases as well. This has been implemented in a generic way. You
5064 need to specify an SQL statement which will then be executed by collectd in
5065 order to write the data (see below for details). The benefit of that approach
5066 is that there is no fixed database layout. Rather, the layout may be optimized
5067 for the current setup.
5069 The B<PostgreSQL Documentation> manual can be found at
5070 L<http://www.postgresql.org/docs/manuals/>.
5072   <Plugin postgresql>
5073     <Query magic>
5074       Statement "SELECT magic FROM wizard WHERE host = $1;"
5075       Param hostname
5076       <Result>
5077         Type gauge
5078         InstancePrefix "magic"
5079         ValuesFrom magic
5080       </Result>
5081     </Query>
5083     <Query rt36_tickets>
5084       Statement "SELECT COUNT(type) AS count, type \
5085                         FROM (SELECT CASE \
5086                                      WHEN resolved = 'epoch' THEN 'open' \
5087                                      ELSE 'resolved' END AS type \
5088                                      FROM tickets) type \
5089                         GROUP BY type;"
5090       <Result>
5091         Type counter
5092         InstancePrefix "rt36_tickets"
5093         InstancesFrom "type"
5094         ValuesFrom "count"
5095       </Result>
5096     </Query>
5098     <Writer sqlstore>
5099       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
5100       StoreRates true
5101     </Writer>
5103     <Database foo>
5104       Host "hostname"
5105       Port "5432"
5106       User "username"
5107       Password "secret"
5108       SSLMode "prefer"
5109       KRBSrvName "kerberos_service_name"
5110       Query magic
5111     </Database>
5113     <Database bar>
5114       Interval 300
5115       Service "service_name"
5116       Query backend # predefined
5117       Query rt36_tickets
5118     </Database>
5120     <Database qux>
5121       # ...
5122       Writer sqlstore
5123       CommitInterval 10
5124     </Database>
5125   </Plugin>
5127 The B<Query> block defines one database query which may later be used by a
5128 database definition. It accepts a single mandatory argument which specifies
5129 the name of the query. The names of all queries have to be unique (see the
5130 B<MinVersion> and B<MaxVersion> options below for an exception to this
5131 rule). The following configuration options are available to define the query:
5133 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
5134 blocks define how to handle the values returned from the query. They define
5135 which column holds which value and how to dispatch that value to the daemon.
5136 Multiple B<Result> blocks may be used to extract multiple values from a single
5137 query.
5139 =over 4
5141 =item B<Statement> I<sql query statement>
5143 Specify the I<sql query statement> which the plugin should execute. The string
5144 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
5145 first, second, etc. parameter. The value of the parameters is specified by the
5146 B<Param> configuration option - see below for details. To include a literal
5147 B<$> character followed by a number, surround it with single quotes (B<'>).
5149 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
5150 allowed. Note, however, that only a single command may be used. Semicolons are
5151 allowed as long as a single non-empty command has been specified only.
5153 The returned lines will be handled separately one after another.
5155 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
5157 Specify the parameters which should be passed to the SQL query. The parameters
5158 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
5159 they appear in the configuration file. The value of the parameter is
5160 determined depending on the value of the B<Param> option as follows:
5162 =over 4
5164 =item I<hostname>
5166 The configured hostname of the database connection. If a UNIX domain socket is
5167 used, the parameter expands to "localhost".
5169 =item I<database>
5171 The name of the database of the current connection.
5173 =item I<instance>
5175 The name of the database plugin instance. See the B<Instance> option of the
5176 database specification below for details.
5178 =item I<username>
5180 The username used to connect to the database.
5182 =item I<interval>
5184 The interval with which this database is queried (as specified by the database
5185 specific or global B<Interval> options).
5187 =back
5189 Please note that parameters are only supported by PostgreSQL's protocol
5190 version 3 and above which was introduced in version 7.4 of PostgreSQL.
5192 =item B<Type> I<type>
5194 The I<type> name to be used when dispatching the values. The type describes
5195 how to handle the data and where to store it. See L<types.db(5)> for more
5196 details on types and their configuration. The number and type of values (as
5197 selected by the B<ValuesFrom> option) has to match the type of the given name.
5199 This option is required inside a B<Result> block.
5201 =item B<InstancePrefix> I<prefix>
5203 =item B<InstancesFrom> I<column0> [I<column1> ...]
5205 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
5206 B<InstancePrefix> defines a static prefix that will be prepended to all type
5207 instances. B<InstancesFrom> defines the column names whose values will be used
5208 to create the type instance. Multiple values will be joined together using the
5209 hyphen (C<->) as separation character.
5211 The plugin itself does not check whether or not all built instances are
5212 different. It is your responsibility to assure that each is unique.
5214 Both options are optional. If none is specified, the type instance will be
5215 empty.
5217 =item B<ValuesFrom> I<column0> [I<column1> ...]
5219 Names the columns whose content is used as the actual data for the data sets
5220 that are dispatched to the daemon. How many such columns you need is
5221 determined by the B<Type> setting as explained above. If you specify too many
5222 or not enough columns, the plugin will complain about that and no data will be
5223 submitted to the daemon.
5225 The actual data type, as seen by PostgreSQL, is not that important as long as
5226 it represents numbers. The plugin will automatically cast the values to the
5227 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
5228 L<strtod(3)> functions, so anything supported by those functions is supported
5229 by the plugin as well.
5231 This option is required inside a B<Result> block and may be specified multiple
5232 times. If multiple B<ValuesFrom> options are specified, the columns are read
5233 in the given order.
5235 =item B<MinVersion> I<version>
5237 =item B<MaxVersion> I<version>
5239 Specify the minimum or maximum version of PostgreSQL that this query should be
5240 used with. Some statistics might only be available with certain versions of
5241 PostgreSQL. This allows you to specify multiple queries with the same name but
5242 which apply to different versions, thus allowing you to use the same
5243 configuration in a heterogeneous environment.
5245 The I<version> has to be specified as the concatenation of the major, minor
5246 and patch-level versions, each represented as two-decimal-digit numbers. For
5247 example, version 8.2.3 will become 80203.
5249 =back
5251 The following predefined queries are available (the definitions can be found
5252 in the F<postgresql_default.conf> file which, by default, is available at
5253 C<I<prefix>/share/collectd/>):
5255 =over 4
5257 =item B<backends>
5259 This query collects the number of backends, i.E<nbsp>e. the number of
5260 connected clients.
5262 =item B<transactions>
5264 This query collects the numbers of committed and rolled-back transactions of
5265 the user tables.
5267 =item B<queries>
5269 This query collects the numbers of various table modifications (i.E<nbsp>e.
5270 insertions, updates, deletions) of the user tables.
5272 =item B<query_plans>
5274 This query collects the numbers of various table scans and returned tuples of
5275 the user tables.
5277 =item B<table_states>
5279 This query collects the numbers of live and dead rows in the user tables.
5281 =item B<disk_io>
5283 This query collects disk block access counts for user tables.
5285 =item B<disk_usage>
5287 This query collects the on-disk size of the database in bytes.
5289 =back
5291 In addition, the following detailed queries are available by default. Please
5292 note that each of those queries collects information B<by table>, thus,
5293 potentially producing B<a lot> of data. For details see the description of the
5294 non-by_table queries above.
5296 =over 4
5298 =item B<queries_by_table>
5300 =item B<query_plans_by_table>
5302 =item B<table_states_by_table>
5304 =item B<disk_io_by_table>
5306 =back
5308 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5309 mandatory argument specifying the name of the writer. This will then be used
5310 in the B<Database> specification in order to activate the writer instance. The
5311 names of all writers have to be unique. The following options may be
5312 specified:
5314 =over 4
5316 =item B<Statement> I<sql statement>
5318 This mandatory option specifies the SQL statement that will be executed for
5319 each submitted value. A single SQL statement is allowed only. Anything after
5320 the first semicolon will be ignored.
5322 Nine parameters will be passed to the statement and should be specified as
5323 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5324 values are made available through those parameters:
5326 =over 4
5328 =item B<$1>
5330 The timestamp of the queried value as a floating point number.
5332 =item B<$2>
5334 The hostname of the queried value.
5336 =item B<$3>
5338 The plugin name of the queried value.
5340 =item B<$4>
5342 The plugin instance of the queried value. This value may be B<NULL> if there
5343 is no plugin instance.
5345 =item B<$5>
5347 The type of the queried value (cf. L<types.db(5)>).
5349 =item B<$6>
5351 The type instance of the queried value. This value may be B<NULL> if there is
5352 no type instance.
5354 =item B<$7>
5356 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5357 sources of the submitted value-list).
5359 =item B<$8>
5361 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5362 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5363 B<StoreRates> is enabled (which is the default, see below), all types will be
5364 C<gauge>.
5366 =item B<$9>
5368 An array of the submitted values. The dimensions of the value name and value
5369 arrays match.
5371 =back
5373 In general, it is advisable to create and call a custom function in the
5374 PostgreSQL database for this purpose. Any procedural language supported by
5375 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5376 for details).
5378 =item B<StoreRates> B<false>|B<true>
5380 If set to B<true> (the default), convert counter values to rates. If set to
5381 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5382 number.
5384 =back
5386 The B<Database> block defines one PostgreSQL database for which to collect
5387 statistics. It accepts a single mandatory argument which specifies the
5388 database name. None of the other options are required. PostgreSQL will use
5389 default values as documented in the section "CONNECTING TO A DATABASE" in the
5390 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5391 the user collectd is run as and special environment variables. See the manpage
5392 for details.
5394 =over 4
5396 =item B<Interval> I<seconds>
5398 Specify the interval with which the database should be queried. The default is
5399 to use the global B<Interval> setting.
5401 =item B<CommitInterval> I<seconds>
5403 This option may be used for database connections which have "writers" assigned
5404 (see above). If specified, it causes a writer to put several updates into a
5405 single transaction. This transaction will last for the specified amount of
5406 time. By default, each update will be executed in a separate transaction. Each
5407 transaction generates a fair amount of overhead which can, thus, be reduced by
5408 activating this option. The draw-back is, that data covering the specified
5409 amount of time will be lost, for example, if a single statement within the
5410 transaction fails or if the database server crashes.
5412 =item B<Instance> I<name>
5414 Specify the plugin instance name that should be used instead of the database
5415 name (which is the default, if this option has not been specified). This
5416 allows to query multiple databases of the same name on the same host (e.g.
5417 when running multiple database server versions in parallel).
5419 =item B<Host> I<hostname>
5421 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5422 value begins with a slash, it is interpreted as the directory name in which to
5423 look for the UNIX domain socket.
5425 This option is also used to determine the hostname that is associated with a
5426 collected data set. If it has been omitted or either begins with with a slash
5427 or equals B<localhost> it will be replaced with the global hostname definition
5428 of collectd. Any other value will be passed literally to collectd when
5429 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5431 =item B<Port> I<port>
5433 Specify the TCP port or the local UNIX domain socket file extension of the
5434 server.
5436 =item B<User> I<username>
5438 Specify the username to be used when connecting to the server.
5440 =item B<Password> I<password>
5442 Specify the password to be used when connecting to the server.
5444 =item B<ExpireDelay> I<delay>
5446 Skip expired values in query output.
5448 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5450 Specify whether to use an SSL connection when contacting the server. The
5451 following modes are supported:
5453 =over 4
5455 =item I<disable>
5457 Do not use SSL at all.
5459 =item I<allow>
5461 First, try to connect without using SSL. If that fails, try using SSL.
5463 =item I<prefer> (default)
5465 First, try to connect using SSL. If that fails, try without using SSL.
5467 =item I<require>
5469 Use SSL only.
5471 =back
5473 =item B<Instance> I<name>
5475 Specify the plugin instance name that should be used instead of the database
5476 name (which is the default, if this option has not been specified). This
5477 allows to query multiple databases of the same name on the same host (e.g.
5478 when running multiple database server versions in parallel).
5480 =item B<KRBSrvName> I<kerberos_service_name>
5482 Specify the Kerberos service name to use when authenticating with Kerberos 5
5483 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5484 B<PostgreSQL Documentation> for details.
5486 =item B<Service> I<service_name>
5488 Specify the PostgreSQL service name to use for additional parameters. That
5489 service has to be defined in F<pg_service.conf> and holds additional
5490 connection parameters. See the section "The Connection Service File" in the
5491 B<PostgreSQL Documentation> for details.
5493 =item B<Query> I<query>
5495 Specifies a I<query> which should be executed in the context of the database
5496 connection. This may be any of the predefined or user-defined queries. If no
5497 such option is given, it defaults to "backends", "transactions", "queries",
5498 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5499 has been specified). Else, the specified queries are used only.
5501 =item B<Writer> I<writer>
5503 Assigns the specified I<writer> backend to the database connection. This
5504 causes all collected data to be send to the database using the settings
5505 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5506 below for details on how to selectively send data to certain plugins).
5508 Each writer will register a flush callback which may be used when having long
5509 transactions enabled (see the B<CommitInterval> option above). When issuing
5510 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5511 transaction will be committed right away. Two different kinds of flush
5512 callbacks are available with the C<postgresql> plugin:
5514 =over 4
5516 =item B<postgresql>
5518 Flush all writer backends.
5520 =item B<postgresql->I<database>
5522 Flush all writers of the specified I<database> only.
5524 =back
5526 =back
5528 =head2 Plugin C<powerdns>
5530 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5531 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5532 values, many of which are probably meaningless to most users, but may be useful
5533 for some. So you may chose which values to collect, but if you don't, some
5534 reasonable defaults will be collected.
5536   <Plugin "powerdns">
5537     <Server "server_name">
5538       Collect "latency"
5539       Collect "udp-answers" "udp-queries"
5540       Socket "/var/run/pdns.controlsocket"
5541     </Server>
5542     <Recursor "recursor_name">
5543       Collect "questions"
5544       Collect "cache-hits" "cache-misses"
5545       Socket "/var/run/pdns_recursor.controlsocket"
5546     </Recursor>
5547     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5548   </Plugin>
5550 =over 4
5552 =item B<Server> and B<Recursor> block
5554 The B<Server> block defines one authoritative server to query, the B<Recursor>
5555 does the same for an recursing server. The possible options in both blocks are
5556 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5557 and is required.
5559 =over 4
5561 =item B<Collect> I<Field>
5563 Using the B<Collect> statement you can select which values to collect. Here,
5564 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5565 C<dlg-only-drops>, C<answers10-100>.
5567 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5568 When querying the server a C<SHOW *> command is issued in any case, because
5569 that's the only way of getting multiple values out of the server at once.
5570 collectd then picks out the values you have selected. When querying the
5571 recursor, a command is generated to query exactly these values. So if you
5572 specify invalid fields when querying the recursor, a syntax error may be
5573 returned by the daemon and collectd may not collect any values at all.
5575 If no B<Collect> statement is given, the following B<Server> values will be
5576 collected:
5578 =over 4
5580 =item latency
5582 =item packetcache-hit
5584 =item packetcache-miss
5586 =item packetcache-size
5588 =item query-cache-hit
5590 =item query-cache-miss
5592 =item recursing-answers
5594 =item recursing-questions
5596 =item tcp-answers
5598 =item tcp-queries
5600 =item udp-answers
5602 =item udp-queries
5604 =back
5606 The following B<Recursor> values will be collected by default:
5608 =over 4
5610 =item noerror-answers
5612 =item nxdomain-answers
5614 =item servfail-answers
5616 =item sys-msec
5618 =item user-msec
5620 =item qa-latency
5622 =item cache-entries
5624 =item cache-hits
5626 =item cache-misses
5628 =item questions
5630 =back
5632 Please note that up to that point collectd doesn't know what values are
5633 available on the server and values that are added do not need a change of the
5634 mechanism so far. However, the values must be mapped to collectd's naming
5635 scheme, which is done using a lookup table that lists all known values. If
5636 values are added in the future and collectd does not know about them, you will
5637 get an error much like this:
5639   powerdns plugin: submit: Not found in lookup table: foobar = 42
5641 In this case please file a bug report with the collectd team.
5643 =item B<Socket> I<Path>
5645 Configures the path to the UNIX domain socket to be used when connecting to the
5646 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5647 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5648 will be used for the recursor.
5650 =back
5652 =item B<LocalSocket> I<Path>
5654 Querying the recursor is done using UDP. When using UDP over UNIX domain
5655 sockets, the client socket needs a name in the file system, too. You can set
5656 this local name to I<Path> using the B<LocalSocket> option. The default is
5657 C<I<prefix>/var/run/collectd-powerdns>.
5659 =back
5661 =head2 Plugin C<processes>
5663 =over 4
5665 =item B<Process> I<Name>
5667 Select more detailed statistics of processes matching this name. The statistics
5668 collected for these selected processes are size of the resident segment size
5669 (RSS), user- and system-time used, number of processes and number of threads,
5670 io data (where available) and minor and major pagefaults.
5672 =item B<ProcessMatch> I<name> I<regex>
5674 Similar to the B<Process> option this allows to select more detailed
5675 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5676 details). The statistics of all matching processes are summed up and
5677 dispatched to the daemon using the specified I<name> as an identifier. This
5678 allows to "group" several processes together. I<name> must not contain
5679 slashes.
5681 =item B<CollectContextSwitch> I<Boolean>
5683 Collect context switch of the process.
5685 =back
5687 =head2 Plugin C<protocols>
5689 Collects a lot of information about various network protocols, such as I<IP>,
5690 I<TCP>, I<UDP>, etc.
5692 Available configuration options:
5694 =over 4
5696 =item B<Value> I<Selector>
5698 Selects whether or not to select a specific value. The string being matched is
5699 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5700 plugin instance and I<ValueName> will be used as type instance. An example of
5701 the string being used would be C<Tcp:RetransSegs>.
5703 You can use regular expressions to match a large number of values with just one
5704 configuration option. To select all "extended" I<TCP> values, you could use the
5705 following statement:
5707   Value "/^TcpExt:/"
5709 Whether only matched values are selected or all matched values are ignored
5710 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5711 If no value is configured at all, all values will be selected.
5713 =item B<IgnoreSelected> B<true>|B<false>
5715 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5716 matching values will be ignored.
5718 =back
5720 =head2 Plugin C<python>
5722 This plugin embeds a Python-interpreter into collectd and provides an interface
5723 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5725 =head2 Plugin C<routeros>
5727 The C<routeros> plugin connects to a device running I<RouterOS>, the
5728 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5729 I<librouteros> to connect and reads information about the interfaces and
5730 wireless connections of the device. The configuration supports querying
5731 multiple routers:
5733   <Plugin "routeros">
5734     <Router>
5735       Host "router0.example.com"
5736       User "collectd"
5737       Password "secr3t"
5738       CollectInterface true
5739       CollectCPULoad true
5740       CollectMemory true
5741     </Router>
5742     <Router>
5743       Host "router1.example.com"
5744       User "collectd"
5745       Password "5ecret"
5746       CollectInterface true
5747       CollectRegistrationTable true
5748       CollectDF true
5749       CollectDisk true
5750     </Router>
5751   </Plugin>
5753 As you can see above, the configuration of the I<routeros> plugin consists of
5754 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5755 options are understood:
5757 =over 4
5759 =item B<Host> I<Host>
5761 Hostname or IP-address of the router to connect to.
5763 =item B<Port> I<Port>
5765 Port name or port number used when connecting. If left unspecified, the default
5766 will be chosen by I<librouteros>, currently "8728". This option expects a
5767 string argument, even when a numeric port number is given.
5769 =item B<User> I<User>
5771 Use the user name I<User> to authenticate. Defaults to "admin".
5773 =item B<Password> I<Password>
5775 Set the password used to authenticate.
5777 =item B<CollectInterface> B<true>|B<false>
5779 When set to B<true>, interface statistics will be collected for all interfaces
5780 present on the device. Defaults to B<false>.
5782 =item B<CollectRegistrationTable> B<true>|B<false>
5784 When set to B<true>, information about wireless LAN connections will be
5785 collected. Defaults to B<false>.
5787 =item B<CollectCPULoad> B<true>|B<false>
5789 When set to B<true>, information about the CPU usage will be collected. The
5790 number is a dimensionless value where zero indicates no CPU usage at all.
5791 Defaults to B<false>.
5793 =item B<CollectMemory> B<true>|B<false>
5795 When enabled, the amount of used and free memory will be collected. How used
5796 memory is calculated is unknown, for example whether or not caches are counted
5797 as used space.
5798 Defaults to B<false>.
5800 =item B<CollectDF> B<true>|B<false>
5802 When enabled, the amount of used and free disk space will be collected.
5803 Defaults to B<false>.
5805 =item B<CollectDisk> B<true>|B<false>
5807 When enabled, the number of sectors written and bad blocks will be collected.
5808 Defaults to B<false>.
5810 =back
5812 =head2 Plugin C<redis>
5814 The I<Redis plugin> connects to one or more Redis servers and gathers
5815 information about each server's state. For each server there is a I<Node> block
5816 which configures the connection parameters for this node.
5818   <Plugin redis>
5819     <Node "example">
5820         Host "localhost"
5821         Port "6379"
5822         Timeout 2000
5823         <Query "LLEN myqueue">
5824           Type "queue_length"
5825           Instance "myqueue"
5826         <Query>
5827     </Node>
5828   </Plugin>
5830 The information shown in the synopsis above is the I<default configuration>
5831 which is used by the plugin if no configuration is present.
5833 =over 4
5835 =item B<Node> I<Nodename>
5837 The B<Node> block identifies a new Redis node, that is a new Redis instance
5838 running in an specified host and port. The name for node is a canonical
5839 identifier which is used as I<plugin instance>. It is limited to
5840 64E<nbsp>characters in length.
5842 =item B<Host> I<Hostname>
5844 The B<Host> option is the hostname or IP-address where the Redis instance is
5845 running on.
5847 =item B<Port> I<Port>
5849 The B<Port> option is the TCP port on which the Redis instance accepts
5850 connections. Either a service name of a port number may be given. Please note
5851 that numerical port numbers must be given as a string, too.
5853 =item B<Password> I<Password>
5855 Use I<Password> to authenticate when connecting to I<Redis>.
5857 =item B<Timeout> I<Milliseconds>
5859 The B<Timeout> option set the socket timeout for node response. Since the Redis
5860 read function is blocking, you should keep this value as low as possible. Keep
5861 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5862 than B<Interval> defined globally.
5864 =item B<Query> I<Querystring>
5866 The B<Query> block identifies a query to execute against the redis server.
5867 There may be an arbitrary number of queries to execute.
5869 =item B<Type> I<Collectd type>
5871 Within a query definition, a valid collectd type to use as when submitting
5872 the result of the query. When not supplied, will default to B<gauge>.
5874 =item B<Instance> I<Type instance>
5876 Within a query definition, an optional type instance to use when submitting
5877 the result of the query. When not supplied will default to the escaped
5878 command, up to 64 chars.
5880 =back
5882 =head2 Plugin C<rrdcached>
5884 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5885 to store values to RRD files in an efficient manner. The combination of the
5886 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5887 way the C<rrdtool> plugin works (see below). The added abstraction layer
5888 provides a number of benefits, though: Because the cache is not within
5889 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5890 restarted. This results in much shorter (if any) gaps in graphs, especially
5891 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5892 daemon so that it can flush values to disk automatically when needed. This
5893 allows to integrate automated flushing of values into graphing solutions much
5894 more easily.
5896 There are disadvantages, though: The daemon may reside on a different host, so
5897 it may not be possible for C<collectd> to create the appropriate RRD files
5898 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5899 different base directory, so relative paths may do weird stuff if you're not
5900 careful.
5902 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5903 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5904 setting should be set to an absolute path, so that a changed base directory
5905 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5907 =over 4
5909 =item B<DaemonAddress> I<Address>
5911 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5912 library. See L<rrdcached(1)> for details. Example:
5914   <Plugin "rrdcached">
5915     DaemonAddress "unix:/var/run/rrdcached.sock"
5916   </Plugin>
5918 =item B<DataDir> I<Directory>
5920 Set the base directory in which the RRD files reside. If this is a relative
5921 path, it is relative to the working base directory of the C<rrdcached> daemon!
5922 Use of an absolute path is recommended.
5924 =item B<CreateFiles> B<true>|B<false>
5926 Enables or disables the creation of RRD files. If the daemon is not running
5927 locally, or B<DataDir> is set to a relative path, this will not work as
5928 expected. Default is B<true>.
5930 =item B<CreateFilesAsync> B<false>|B<true>
5932 When enabled, new RRD files are enabled asynchronously, using a separate thread
5933 that runs in the background. This prevents writes to block, which is a problem
5934 especially when many hundreds of files need to be created at once. However,
5935 since the purpose of creating the files asynchronously is I<not> to block until
5936 the file is available, values before the file is available will be discarded.
5937 When disabled (the default) files are created synchronously, blocking for a
5938 short while, while the file is being written.
5940 =item B<StepSize> I<Seconds>
5942 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5943 this setting is unset and the stepsize is set to the interval in which the data
5944 is collected. Do not use this option unless you absolutely have to for some
5945 reason. Setting this option may cause problems with the C<snmp plugin>, the
5946 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5948 =item B<HeartBeat> I<Seconds>
5950 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5951 in which case the heartbeat is set to twice the B<StepSize> which should equal
5952 the interval in which data is collected. Do not set this option unless you have
5953 a very good reason to do so.
5955 =item B<RRARows> I<NumRows>
5957 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5958 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5959 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5960 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5961 week, one month, and one year.
5963 So for each timespan, it calculates how many PDPs need to be consolidated into
5964 one CDP by calculating:
5965   number of PDPs = timespan / (stepsize * rrarows)
5967 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5968 default is 1200.
5970 =item B<RRATimespan> I<Seconds>
5972 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5973 more then one RRA. If this option is never used, the built-in default of (3600,
5974 86400, 604800, 2678400, 31622400) is used.
5976 For more information on how RRA-sizes are calculated see B<RRARows> above.
5978 =item B<XFF> I<Factor>
5980 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5981 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5982 one (exclusive).
5984 =item B<CollectStatistics> B<false>|B<true>
5986 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5987 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5989 Statistics are read via I<rrdcached>s socket using the STATS command.
5990 See L<rrdcached(1)> for details.
5992 =back
5994 =head2 Plugin C<rrdtool>
5996 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5997 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5998 using these settings. If you don't want to dive into the depths of RRDtool, you
5999 can safely ignore these settings.
6001 =over 4
6003 =item B<DataDir> I<Directory>
6005 Set the directory to store RRD files under. By default RRD files are generated
6006 beneath the daemon's working directory, i.e. the B<BaseDir>.
6008 =item B<CreateFilesAsync> B<false>|B<true>
6010 When enabled, new RRD files are enabled asynchronously, using a separate thread
6011 that runs in the background. This prevents writes to block, which is a problem
6012 especially when many hundreds of files need to be created at once. However,
6013 since the purpose of creating the files asynchronously is I<not> to block until
6014 the file is available, values before the file is available will be discarded.
6015 When disabled (the default) files are created synchronously, blocking for a
6016 short while, while the file is being written.
6018 =item B<StepSize> I<Seconds>
6020 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6021 this setting is unset and the stepsize is set to the interval in which the data
6022 is collected. Do not use this option unless you absolutely have to for some
6023 reason. Setting this option may cause problems with the C<snmp plugin>, the
6024 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6026 =item B<HeartBeat> I<Seconds>
6028 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6029 in which case the heartbeat is set to twice the B<StepSize> which should equal
6030 the interval in which data is collected. Do not set this option unless you have
6031 a very good reason to do so.
6033 =item B<RRARows> I<NumRows>
6035 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6036 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6037 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6038 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6039 week, one month, and one year.
6041 So for each timespan, it calculates how many PDPs need to be consolidated into
6042 one CDP by calculating:
6043   number of PDPs = timespan / (stepsize * rrarows)
6045 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6046 default is 1200.
6048 =item B<RRATimespan> I<Seconds>
6050 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6051 more then one RRA. If this option is never used, the built-in default of (3600,
6052 86400, 604800, 2678400, 31622400) is used.
6054 For more information on how RRA-sizes are calculated see B<RRARows> above.
6056 =item B<XFF> I<Factor>
6058 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6059 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6060 one (exclusive).
6062 =item B<CacheFlush> I<Seconds>
6064 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
6065 it writes all values for a certain RRD-file if the oldest value is older than
6066 (or equal to) the number of seconds specified. If some RRD-file is not updated
6067 anymore for some reason (the computer was shut down, the network is broken,
6068 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
6069 entire cache is searched for entries older than B<CacheTimeout> seconds and
6070 written to disk every I<Seconds> seconds. Since this is kind of expensive and
6071 does nothing under normal circumstances, this value should not be too small.
6072 900 seconds might be a good value, though setting this to 7200 seconds doesn't
6073 normally do much harm either.
6075 =item B<CacheTimeout> I<Seconds>
6077 If this option is set to a value greater than zero, the C<rrdtool plugin> will
6078 save values in a cache, as described above. Writing multiple values at once
6079 reduces IO-operations and thus lessens the load produced by updating the files.
6080 The trade off is that the graphs kind of "drag behind" and that more memory is
6081 used.
6083 =item B<WritesPerSecond> I<Updates>
6085 When collecting many statistics with collectd and the C<rrdtool> plugin, you
6086 will run serious performance problems. The B<CacheFlush> setting and the
6087 internal update queue assert that collectd continues to work just fine even
6088 under heavy load, but the system may become very unresponsive and slow. This is
6089 a problem especially if you create graphs from the RRD files on the same
6090 machine, for example using the C<graph.cgi> script included in the
6091 C<contrib/collection3/> directory.
6093 This setting is designed for very large setups. Setting this option to a value
6094 between 25 and 80 updates per second, depending on your hardware, will leave
6095 the server responsive enough to draw graphs even while all the cached values
6096 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
6097 by the B<FLUSH> command, are B<not> effected by this limit. They are still
6098 written as fast as possible, so that web frontends have up to date data when
6099 generating graphs.
6101 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
6102 updates per second, writing all values to disk will take approximately
6103 56E<nbsp>minutes. Together with the flushing ability that's integrated into
6104 "collection3" you'll end up with a responsive and fast system, up to date
6105 graphs and basically a "backup" of your values every hour.
6107 =item B<RandomTimeout> I<Seconds>
6109 When set, the actual timeout for each value is chosen randomly between
6110 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
6111 intention is to avoid high load situations that appear when many values timeout
6112 at the same time. This is especially a problem shortly after the daemon starts,
6113 because all values were added to the internal cache at roughly the same time.
6115 =back
6117 =head2 Plugin C<sensors>
6119 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
6120 that all the needed modules have to be loaded and lm_sensors has to be
6121 configured (most likely by editing F</etc/sensors.conf>. Read
6122 L<sensors.conf(5)> for details.
6124 The B<lm_sensors> homepage can be found at
6125 L<http://secure.netroedge.com/~lm78/>.
6127 =over 4
6129 =item B<SensorConfigFile> I<File>
6131 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
6132 the library's default will be used.
6134 =item B<Sensor> I<chip-bus-address/type-feature>
6136 Selects the name of the sensor which you want to collect or ignore, depending
6137 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
6138 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
6139 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
6141 =item B<IgnoreSelected> I<true>|I<false>
6143 If no configuration if given, the B<sensors>-plugin will collect data from all
6144 sensors. This may not be practical, especially for uninteresting sensors.
6145 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
6146 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
6147 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
6148 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
6149 and all other sensors are collected.
6151 =item B<UseLabels> I<true>|I<false>
6153 Configures how sensor readings are reported. When set to I<true>, sensor
6154 readings are reported using their descriptive label (e.g. "VCore"). When set to
6155 I<false> (the default) the sensor name is used ("in0").
6157 =back
6159 =head2 Plugin C<sigrok>
6161 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
6162 supported by the L<sigrok|http://sigrok.org/> project.
6164 B<Synopsis>
6166  <Plugin sigrok>
6167    LogLevel 3
6168    <Device "AC Voltage">
6169       Driver "fluke-dmm"
6170       MinimumInterval 10
6171       Conn "/dev/ttyUSB2"
6172    </Device>
6173    <Device "Sound Level">
6174       Driver "cem-dt-885x"
6175       Conn "/dev/ttyUSB1"
6176    </Device>
6177  </Plugin>
6179 =over 4
6181 =item B<LogLevel> B<0-5>
6183 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
6184 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
6185 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
6186 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
6187 their level, are always submitted to I<collectd> at its INFO log level.
6189 =item E<lt>B<Device> I<Name>E<gt>
6191 A sigrok-supported device, uniquely identified by this section's options. The
6192 I<Name> is passed to I<collectd> as the I<plugin instance>.
6194 =item B<Driver> I<DriverName>
6196 The sigrok driver to use for this device.
6198 =item B<Conn> I<ConnectionSpec>
6200 If the device cannot be auto-discovered, or more than one might be discovered
6201 by the driver, I<ConnectionSpec> specifies the connection string to the device.
6202 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
6203 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
6204 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
6205 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
6207 =item B<SerialComm> I<SerialSpec>
6209 For serial devices with non-standard port settings, this option can be used
6210 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
6211 This should not be necessary; drivers know how to communicate with devices they
6212 support.
6214 =item B<MinimumInterval> I<Seconds>
6216 Specifies the minimum time between measurement dispatches to I<collectd>, in
6217 seconds. Since some I<sigrok> supported devices can acquire measurements many
6218 times per second, it may be necessary to throttle these. For example, the
6219 I<RRD plugin> cannot process writes more than once per second.
6221 The default B<MinimumInterval> is B<0>, meaning measurements received from the
6222 device are always dispatched to I<collectd>. When throttled, unused
6223 measurements are discarded.
6225 =back
6227 =head2 Plugin C<smart>
6229 The C<smart> plugin collects SMART information from physical
6230 disks. Values collectd include temperature, power cycle count, poweron
6231 time and bad sectors. Also, all SMART attributes are collected along
6232 with the normalized current value, the worst value, the threshold and
6233 a human readable value.
6235 Using the following two options you can ignore some disks or configure the
6236 collection only of specific disks.
6238 =over 4
6240 =item B<Disk> I<Name>
6242 Select the disk I<Name>. Whether it is collected or ignored depends on the
6243 B<IgnoreSelected> setting, see below. As with other plugins that use the
6244 daemon's ignorelist functionality, a string that starts and ends with a slash
6245 is interpreted as a regular expression. Examples:
6247   Disk "sdd"
6248   Disk "/hda[34]/"
6250 =item B<IgnoreSelected> B<true>|B<false>
6252 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
6253 statements, are ignored or if all other disks are ignored. The behavior
6254 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
6255 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
6256 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
6257 is set to B<true>, all disks are collected B<except> the ones matched.
6259 =back
6261 =head2 Plugin C<snmp>
6263 Since the configuration of the C<snmp plugin> is a little more complicated than
6264 other plugins, its documentation has been moved to an own manpage,
6265 L<collectd-snmp(5)>. Please see there for details.
6267 =head2 Plugin C<statsd>
6269 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
6270 protocol and dispatches rates or other aggregates of these numbers
6271 periodically.
6273 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
6274 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
6275 C<objects> respectively.
6277 The following configuration options are valid:
6279 =over 4
6281 =item B<Host> I<Host>
6283 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
6284 "any" address, i.e. accept packets sent to any of the hosts addresses.
6286 =item B<Port> I<Port>
6288 UDP port to listen to. This can be either a service name or a port number.
6289 Defaults to C<8125>.
6291 =item B<DeleteCounters> B<false>|B<true>
6293 =item B<DeleteTimers> B<false>|B<true>
6295 =item B<DeleteGauges> B<false>|B<true>
6297 =item B<DeleteSets> B<false>|B<true>
6299 These options control what happens if metrics are not updated in an interval.
6300 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6301 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6302 are unchanged. If set to B<True>, the such metrics are not dispatched and
6303 removed from the internal cache.
6305 =item B<CounterSum> B<false>|B<true>
6307 When enabled, creates a C<count> metric which reports the change since the last
6308 read. This option primarily exists for compatibility with the I<statsd>
6309 implementation by Etsy.
6311 =item B<TimerPercentile> I<Percent>
6313 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6314 that I<Percent> of all reported timers are smaller than or equal to the
6315 computed latency. This is useful for cutting off the long tail latency, as it's
6316 often done in I<Service Level Agreements> (SLAs).
6318 Different percentiles can be calculated by setting this option several times.
6319 If none are specified, no percentiles are calculated / dispatched.
6321 =item B<TimerLower> B<false>|B<true>
6323 =item B<TimerUpper> B<false>|B<true>
6325 =item B<TimerSum> B<false>|B<true>
6327 =item B<TimerCount> B<false>|B<true>
6329 Calculate and dispatch various values out of I<Timer> metrics received during
6330 an interval. If set to B<False>, the default, these values aren't calculated /
6331 dispatched.
6333 =back
6335 =head2 Plugin C<swap>
6337 The I<Swap plugin> collects information about used and available swap space. On
6338 I<Linux> and I<Solaris>, the following options are available:
6340 =over 4
6342 =item B<ReportByDevice> B<false>|B<true>
6344 Configures how to report physical swap devices. If set to B<false> (the
6345 default), the summary over all swap devices is reported only, i.e. the globally
6346 used and available space over all devices. If B<true> is configured, the used
6347 and available space of each device will be reported separately.
6349 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6350 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6352 =item B<ReportBytes> B<false>|B<true>
6354 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6355 I<swap I/O> is reported in pages. This option is available under Linux only.
6357 =item B<ValuesAbsolute> B<true>|B<false>
6359 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6360 available and used. Defaults to B<true>.
6362 =item B<ValuesPercentage> B<false>|B<true>
6364 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6365 available and free. Defaults to B<false>.
6367 This is useful for deploying I<collectd> in a heterogeneous environment, where
6368 swap sizes differ and you want to specify generic thresholds or similar.
6370 =back
6372 =head2 Plugin C<syslog>
6374 =over 4
6376 =item B<LogLevel> B<debug|info|notice|warning|err>
6378 Sets the log-level. If, for example, set to B<notice>, then all events with
6379 severity B<notice>, B<warning>, or B<err> will be submitted to the
6380 syslog-daemon.
6382 Please note that B<debug> is only available if collectd has been compiled with
6383 debugging support.
6385 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6387 Controls which notifications should be sent to syslog. The default behaviour is
6388 not to send any. Less severe notifications always imply logging more severe
6389 notifications: Setting this to B<OKAY> means all notifications will be sent to
6390 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6391 notifications but will dismiss B<OKAY> notifications. Setting this option to
6392 B<FAILURE> will only send failures to syslog.
6394 =back
6396 =head2 Plugin C<table>
6398 The C<table plugin> provides generic means to parse tabular data and dispatch
6399 user specified values. Values are selected based on column numbers. For
6400 example, this plugin may be used to get values from the Linux L<proc(5)>
6401 filesystem or CSV (comma separated values) files.
6403   <Plugin table>
6404     <Table "/proc/slabinfo">
6405       Instance "slabinfo"
6406       Separator " "
6407       <Result>
6408         Type gauge
6409         InstancePrefix "active_objs"
6410         InstancesFrom 0
6411         ValuesFrom 1
6412       </Result>
6413       <Result>
6414         Type gauge
6415         InstancePrefix "objperslab"
6416         InstancesFrom 0
6417         ValuesFrom 4
6418       </Result>
6419     </Table>
6420   </Plugin>
6422 The configuration consists of one or more B<Table> blocks, each of which
6423 configures one file to parse. Within each B<Table> block, there are one or
6424 more B<Result> blocks, which configure which data to select and how to
6425 interpret it.
6427 The following options are available inside a B<Table> block:
6429 =over 4
6431 =item B<Instance> I<instance>
6433 If specified, I<instance> is used as the plugin instance. So, in the above
6434 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6435 filename of the table is used instead, with all special characters replaced
6436 with an underscore (C<_>).
6438 =item B<Separator> I<string>
6440 Any character of I<string> is interpreted as a delimiter between the different
6441 columns of the table. A sequence of two or more contiguous delimiters in the
6442 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6443 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6444 of a table - see its documentation for more details. This option is mandatory.
6446 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6447 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6448 required because of collectd's config parsing.
6450 =back
6452 The following options are available inside a B<Result> block:
6454 =over 4
6456 =item B<Type> I<type>
6458 Sets the type used to dispatch the values to the daemon. Detailed information
6459 about types and their configuration can be found in L<types.db(5)>. This
6460 option is mandatory.
6462 =item B<InstancePrefix> I<prefix>
6464 If specified, prepend I<prefix> to the type instance. If omitted, only the
6465 B<InstancesFrom> option is considered for the type instance.
6467 =item B<InstancesFrom> I<column0> [I<column1> ...]
6469 If specified, the content of the given columns (identified by the column
6470 number starting at zero) will be used to create the type instance for each
6471 row. Multiple values (and the instance prefix) will be joined together with
6472 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6473 option is considered for the type instance.
6475 The plugin itself does not check whether or not all built instances are
6476 different. It’s your responsibility to assure that each is unique. This is
6477 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6478 sure that the table only contains one row.
6480 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6481 will be empty.
6483 =item B<ValuesFrom> I<column0> [I<column1> ...]
6485 Specifies the columns (identified by the column numbers starting at zero)
6486 whose content is used as the actual data for the data sets that are dispatched
6487 to the daemon. How many such columns you need is determined by the B<Type>
6488 setting above. If you specify too many or not enough columns, the plugin will
6489 complain about that and no data will be submitted to the daemon. The plugin
6490 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6491 respectively, so anything supported by those functions is supported by the
6492 plugin as well. This option is mandatory.
6494 =back
6496 =head2 Plugin C<tail>
6498 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6499 each line and dispatches found values. What is matched can be configured by the
6500 user using (extended) regular expressions, as described in L<regex(7)>.
6502   <Plugin "tail">
6503     <File "/var/log/exim4/mainlog">
6504       Instance "exim"
6505       Interval 60
6506       <Match>
6507         Regex "S=([1-9][0-9]*)"
6508         DSType "CounterAdd"
6509         Type "ipt_bytes"
6510         Instance "total"
6511       </Match>
6512       <Match>
6513         Regex "\\<R=local_user\\>"
6514         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6515         DSType "CounterInc"
6516         Type "counter"
6517         Instance "local_user"
6518       </Match>
6519     </File>
6520   </Plugin>
6522 The config consists of one or more B<File> blocks, each of which configures one
6523 logfile to parse. Within each B<File> block, there are one or more B<Match>
6524 blocks, which configure a regular expression to search for.
6526 The B<Instance> option in the B<File> block may be used to set the plugin
6527 instance. So in the above example the plugin name C<tail-foo> would be used.
6528 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6529 next B<Instance> option. This way you can extract several plugin instances from
6530 one logfile, handy when parsing syslog and the like.
6532 The B<Interval> option allows you to define the length of time between reads. If
6533 this is not set, the default Interval will be used.
6535 Each B<Match> block has the following options to describe how the match should
6536 be performed:
6538 =over 4
6540 =item B<Regex> I<regex>
6542 Sets the regular expression to use for matching against a line. The first
6543 subexpression has to match something that can be turned into a number by
6544 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6545 below. Because B<extended> regular expressions are used, you do not need to use
6546 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6547 collectd's config parsing you need to escape backslashes, though. So if you
6548 want to match literal parentheses you need to do the following:
6550   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6552 =item B<ExcludeRegex> I<regex>
6554 Sets an optional regular expression to use for excluding lines from the match.
6555 An example which excludes all connections from localhost from the match:
6557   ExcludeRegex "127\\.0\\.0\\.1"
6559 =item B<DSType> I<Type>
6561 Sets how the values are cumulated. I<Type> is one of:
6563 =over 4
6565 =item B<GaugeAverage>
6567 Calculate the average.
6569 =item B<GaugeMin>
6571 Use the smallest number only.
6573 =item B<GaugeMax>
6575 Use the greatest number only.
6577 =item B<GaugeLast>
6579 Use the last number found.
6581 =item B<CounterSet>
6583 =item B<DeriveSet>
6585 =item B<AbsoluteSet>
6587 The matched number is a counter. Simply I<sets> the internal counter to this
6588 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6590 =item B<GaugeAdd>
6592 =item B<CounterAdd>
6594 =item B<DeriveAdd>
6596 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6597 matched number may be negative, which will effectively subtract from the
6598 internal counter.
6600 =item B<GaugeInc>
6602 =item B<CounterInc>
6604 =item B<DeriveInc>
6606 Increase the internal counter by one. These B<DSType> are the only ones that do
6607 not use the matched subexpression, but simply count the number of matched
6608 lines. Thus, you may use a regular expression without submatch in this case.
6610 =back
6612 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6613 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6614 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6615 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6616 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6617 case.
6619 =item B<Type> I<Type>
6621 Sets the type used to dispatch this value. Detailed information about types and
6622 their configuration can be found in L<types.db(5)>.
6624 =item B<Instance> I<TypeInstance>
6626 This optional setting sets the type instance to use.
6628 =back
6630 =head2 Plugin C<tail_csv>
6632 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6633 written by I<Snort>.
6635 B<Synopsis:>
6637  <Plugin "tail_csv">
6638    <Metric "snort-dropped">
6639        Type "percent"
6640        Instance "dropped"
6641        Index 1
6642    </Metric>
6643    <File "/var/log/snort/snort.stats">
6644        Instance "snort-eth0"
6645        Interval 600
6646        Collect "snort-dropped"
6647    </File>
6648  </Plugin>
6650 The configuration consists of one or more B<Metric> blocks that define an index
6651 into the line of the CSV file and how this value is mapped to I<collectd's>
6652 internal representation. These are followed by one or more B<Instance> blocks
6653 which configure which file to read, in which interval and which metrics to
6654 extract.
6656 =over 4
6658 =item E<lt>B<Metric> I<Name>E<gt>
6660 The B<Metric> block configures a new metric to be extracted from the statistics
6661 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6662 only used inside the B<Instance> blocks to refer to this block, so you can use
6663 one B<Metric> block for multiple CSV files.
6665 =over 4
6667 =item B<Type> I<Type>
6669 Configures which I<Type> to use when dispatching this metric. Types are defined
6670 in the L<types.db(5)> file, see the appropriate manual page for more
6671 information on specifying types. Only types with a single I<data source> are
6672 supported by the I<tail_csv plugin>. The information whether the value is an
6673 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6674 I<Type's> definition.
6676 =item B<Instance> I<TypeInstance>
6678 If set, I<TypeInstance> is used to populate the type instance field of the
6679 created value lists. Otherwise, no type instance is used.
6681 =item B<ValueFrom> I<Index>
6683 Configure to read the value from the field with the zero-based index I<Index>.
6684 If the value is parsed as signed integer, unsigned integer or double depends on
6685 the B<Type> setting, see above.
6687 =back
6689 =item E<lt>B<File> I<Path>E<gt>
6691 Each B<File> block represents one CSV file to read. There must be at least one
6692 I<File> block but there can be multiple if you have multiple CSV files.
6694 =over 4
6696 =item B<Instance> I<PluginInstance>
6698 Sets the I<plugin instance> used when dispatching the values.
6700 =item B<Collect> I<Metric>
6702 Specifies which I<Metric> to collect. This option must be specified at least
6703 once, and you can use this option multiple times to specify more than one
6704 metric to be extracted from this statistic file.
6706 =item B<Interval> I<Seconds>
6708 Configures the interval in which to read values from this instance / file.
6709 Defaults to the plugin's default interval.
6711 =item B<TimeFrom> I<Index>
6713 Rather than using the local time when dispatching a value, read the timestamp
6714 from the field with the zero-based index I<Index>. The value is interpreted as
6715 seconds since epoch. The value is parsed as a double and may be factional.
6717 =back
6719 =back
6721 =head2 Plugin C<teamspeak2>
6723 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6724 polls interesting global and virtual server data. The plugin can query only one
6725 physical server but unlimited virtual servers. You can use the following
6726 options to configure it:
6728 =over 4
6730 =item B<Host> I<hostname/ip>
6732 The hostname or ip which identifies the physical server.
6733 Default: 127.0.0.1
6735 =item B<Port> I<port>
6737 The query port of the physical server. This needs to be a string.
6738 Default: "51234"
6740 =item B<Server> I<port>
6742 This option has to be added once for every virtual server the plugin should
6743 query. If you want to query the virtual server on port 8767 this is what the
6744 option would look like:
6746   Server "8767"
6748 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6749 use quotes around it! If no such statement is given only global information
6750 will be collected.
6752 =back
6754 =head2 Plugin C<ted>
6756 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6757 measure power consumption. These devices are usually connected to a serial
6758 (RS232) or USB port. The plugin opens a configured device and tries to read the
6759 current energy readings. For more information on TED, visit
6760 L<http://www.theenergydetective.com/>.
6762 Available configuration options:
6764 =over 4
6766 =item B<Device> I<Path>
6768 Path to the device on which TED is connected. collectd will need read and write
6769 permissions on that file.
6771 Default: B</dev/ttyUSB0>
6773 =item B<Retries> I<Num>
6775 Apparently reading from TED is not that reliable. You can therefore configure a
6776 number of retries here. You only configure the I<retries> here, to if you
6777 specify zero, one reading will be performed (but no retries if that fails); if
6778 you specify three, a maximum of four readings are performed. Negative values
6779 are illegal.
6781 Default: B<0>
6783 =back
6785 =head2 Plugin C<tcpconns>
6787 The C<tcpconns plugin> counts the number of currently established TCP
6788 connections based on the local port and/or the remote port. Since there may be
6789 a lot of connections the default if to count all connections with a local port,
6790 for which a listening socket is opened. You can use the following options to
6791 fine-tune the ports you are interested in:
6793 =over 4
6795 =item B<ListeningPorts> I<true>|I<false>
6797 If this option is set to I<true>, statistics for all local ports for which a
6798 listening socket exists are collected. The default depends on B<LocalPort> and
6799 B<RemotePort> (see below): If no port at all is specifically selected, the
6800 default is to collect listening ports. If specific ports (no matter if local or
6801 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6802 the selected ports will be collected unless this option is set to I<true>
6803 specifically.
6805 =item B<LocalPort> I<Port>
6807 Count the connections to a specific local port. This can be used to see how
6808 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6809 You have to specify the port in numeric form, so for the mailserver example
6810 you'd need to set B<25>.
6812 =item B<RemotePort> I<Port>
6814 Count the connections to a specific remote port. This is useful to see how
6815 much a remote service is used. This is most useful if you want to know how many
6816 connections a local service has opened to remote services, e.E<nbsp>g. how many
6817 connections a mail server or news server has to other mail or news servers, or
6818 how many connections a web proxy holds to web servers. You have to give the
6819 port in numeric form.
6821 =item B<AllPortsSummary> I<true>|I<false>
6823 If this option is set to I<true> a summary of statistics from all connections
6824 are collectd. This option defaults to I<false>.
6826 =back
6828 =head2 Plugin C<thermal>
6830 =over 4
6832 =item B<ForceUseProcfs> I<true>|I<false>
6834 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6835 C<sysfs> interface. If that is not available, the plugin falls back to the
6836 C<procfs> interface. By setting this option to I<true>, you can force the
6837 plugin to use the latter. This option defaults to I<false>.
6839 =item B<Device> I<Device>
6841 Selects the name of the thermal device that you want to collect or ignore,
6842 depending on the value of the B<IgnoreSelected> option. This option may be
6843 used multiple times to specify a list of devices.
6845 =item B<IgnoreSelected> I<true>|I<false>
6847 Invert the selection: If set to true, all devices B<except> the ones that
6848 match the device names specified by the B<Device> option are collected. By
6849 default only selected devices are collected if a selection is made. If no
6850 selection is configured at all, B<all> devices are selected.
6852 =back
6854 =head2 Plugin C<threshold>
6856 The I<Threshold plugin> checks values collected or received by I<collectd>
6857 against a configurable I<threshold> and issues I<notifications> if values are
6858 out of bounds.
6860 Documentation for this plugin is available in the L<collectd-threshold(5)>
6861 manual page.
6863 =head2 Plugin C<tokyotyrant>
6865 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6866 couple metrics: number of records, and database size on disk.
6868 =over 4
6870 =item B<Host> I<Hostname/IP>
6872 The hostname or ip which identifies the server.
6873 Default: B<127.0.0.1>
6875 =item B<Port> I<Service/Port>
6877 The query port of the server. This needs to be a string, even if the port is
6878 given in its numeric form.
6879 Default: B<1978>
6881 =back
6883 =head2 Plugin C<turbostat>
6885 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
6886 Intel processors by using the new Model Specific Registers.
6888 =over 4
6890 =item B<CoreCstates> I<Bitmask(Integer)>
6892 Bitmask of the list of core C states supported by the processor.
6893 This option should only be used if the automated detection fails.
6894 Default value extracted from the cpu model and family.
6896 Currently supported C-states (by this plugin): 3, 6, 7
6898 Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
6900 =item B<PackageCstates> I<Bitmask(Integer)>
6902 Bitmask of the list of pacages C states supported by the processor.
6903 This option should only be used if the automated detection fails.
6904 Default value extracted from the cpu model and family.
6906 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
6908 Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7
6910 =item B<SystemManagementInterrupt> I<true>|I<false>
6912 Boolean enabling the collection of the I/O System-Management Interrupt
6913 counter'. This option should only be used if the automated detection
6914 fails or if you want to disable this feature.
6916 =item B<DigitalTemperatureSensor> I<true>|I<false>
6918 Boolean enabling the collection of the temperature of each core.
6919 This option should only be used if the automated detectionfails or
6920 if you want to disable this feature.
6922 =item B<DigitalTemperatureSensor> I<true>|I<false>
6924 Boolean enabling the collection of the temperature of each package.
6925 This option should only be used if the automated detectionfails or
6926 if you want to disable this feature.
6928 =item B<TCCActivationTemp> I<Temperature>
6930 Thermal Control Circuit Activation Temperature of the installed
6931 CPU. This temperature is used when collecting the temperature of
6932 cores or packages. This option should only be used if the automated
6933 detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
6935 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
6937 Bitmask of the list of elements to be thermally monitored. This option
6938 should only be used if the automated detection fails or if you want to
6939 disable some collections. The different bits of this bitmask accepted
6940 by this plugin are:
6942 =over 4
6944 =item 0 ('1'): Package
6946 =item 1 ('2'): DRAM
6948 =item 2 ('4'): Cores
6950 =item 3 ('8'): Embedded graphic device
6952 =back
6954 =back
6956 =head2 Plugin C<unixsock>
6958 =over 4
6960 =item B<SocketFile> I<Path>
6962 Sets the socket-file which is to be created.
6964 =item B<SocketGroup> I<Group>
6966 If running as root change the group of the UNIX-socket after it has been
6967 created. Defaults to B<collectd>.
6969 =item B<SocketPerms> I<Permissions>
6971 Change the file permissions of the UNIX-socket after it has been created. The
6972 permissions must be given as a numeric, octal value as you would pass to
6973 L<chmod(1)>. Defaults to B<0770>.
6975 =item B<DeleteSocket> B<false>|B<true>
6977 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6978 with the given name already exists. If I<collectd> crashes a socket file may be
6979 left over, preventing the daemon from opening a new socket when restarted.
6980 Since this is potentially dangerous, this defaults to B<false>.
6982 =back
6984 =head2 Plugin C<uuid>
6986 This plugin, if loaded, causes the Hostname to be taken from the machine's
6987 UUID. The UUID is a universally unique designation for the machine, usually
6988 taken from the machine's BIOS. This is most useful if the machine is running in
6989 a virtual environment such as Xen, in which case the UUID is preserved across
6990 shutdowns and migration.
6992 The following methods are used to find the machine's UUID, in order:
6994 =over 4
6996 =item
6998 Check I</etc/uuid> (or I<UUIDFile>).
7000 =item
7002 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
7003 present.
7005 =item
7007 Check for UUID from C<dmidecode> / SMBIOS.
7009 =item
7011 Check for UUID from Xen hypervisor.
7013 =back
7015 If no UUID can be found then the hostname is not modified.
7017 =over 4
7019 =item B<UUIDFile> I<Path>
7021 Take the UUID from the given file (default I</etc/uuid>).
7023 =back
7025 =head2 Plugin C<varnish>
7027 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
7028 It collects a subset of the values displayed by L<varnishstat(1)>, and
7029 organizes them in categories which can be enabled or disabled. Currently only
7030 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
7031 meaning of each metric can be found in L<varnish-counters(7)>.
7033 Synopsis:
7035  <Plugin "varnish">
7036    <Instance "example">
7037      CollectBackend     true
7038      CollectBan         false
7039      CollectCache       true
7040      CollectConnections true
7041      CollectDirectorDNS false
7042      CollectESI         false
7043      CollectFetch       false
7044      CollectHCB         false
7045      CollectObjects     false
7046      CollectPurge       false
7047      CollectSession     false
7048      CollectSHM         true
7049      CollectSMA         false
7050      CollectSMS         false
7051      CollectSM          false
7052      CollectStruct      false
7053      CollectTotals      false
7054      CollectUptime      false
7055      CollectVCL         false
7056      CollectVSM         false
7057      CollectWorkers     false
7058    </Instance>
7059  </Plugin>
7061 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
7062 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
7063 will collectd statistics from the default "varnishd" instance (this should work
7064 fine in most cases).
7066 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
7068 =over 4
7070 =item B<CollectBackend> B<true>|B<false>
7072 Back-end connection statistics, such as successful, reused,
7073 and closed connections. True by default.
7075 =item B<CollectBan> B<true>|B<false>
7077 Statistics about ban operations, such as number of bans added, retired, and
7078 number of objects tested against ban operations. Only available with Varnish
7079 3.x and above. False by default.
7081 =item B<CollectCache> B<true>|B<false>
7083 Cache hits and misses. True by default.
7085 =item B<CollectConnections> B<true>|B<false>
7087 Number of client connections received, accepted and dropped. True by default.
7089 =item B<CollectDirectorDNS> B<true>|B<false>
7091 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
7092 default.
7094 =item B<CollectESI> B<true>|B<false>
7096 Edge Side Includes (ESI) parse statistics. False by default.
7098 =item B<CollectFetch> B<true>|B<false>
7100 Statistics about fetches (HTTP requests sent to the backend). False by default.
7102 =item B<CollectHCB> B<true>|B<false>
7104 Inserts and look-ups in the crit bit tree based hash. Look-ups are
7105 divided into locked and unlocked look-ups. False by default.
7107 =item B<CollectObjects> B<true>|B<false>
7109 Statistics on cached objects: number of objects expired, nuked (prematurely
7110 expired), saved, moved, etc. False by default.
7112 =item B<CollectPurge> B<true>|B<false>
7114 Statistics about purge operations, such as number of purges added, retired, and
7115 number of objects tested against purge operations. Only available with Varnish
7116 2.x. False by default.
7118 =item B<CollectSession> B<true>|B<false>
7120 Client session statistics. Number of past and current sessions, session herd and
7121 linger counters, etc. False by default. Note that if using Varnish 4.x, some
7122 metrics found in the Connections and Threads sections with previous versions of
7123 Varnish have been moved here.
7125 =item B<CollectSHM> B<true>|B<false>
7127 Statistics about the shared memory log, a memory region to store
7128 log messages which is flushed to disk when full. True by default.
7130 =item B<CollectSMA> B<true>|B<false>
7132 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
7133 component is Solaris specific. Only available with Varnish 2.x. False by
7134 default.
7136 =item B<CollectSMS> B<true>|B<false>
7138 synth (synthetic content) storage statistics. This storage
7139 component is used internally only. False by default.
7141 =item B<CollectSM> B<true>|B<false>
7143 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
7144 False by default.
7146 =item B<CollectStruct> B<true>|B<false>
7148 Current varnish internal state statistics. Number of current sessions, objects
7149 in cache store, open connections to backends (with Varnish 2.x), etc. False by
7150 default.
7152 =item B<CollectTotals> B<true>|B<false>
7154 Collects overview counters, such as the number of sessions created,
7155 the number of requests and bytes transferred. False by default.
7157 =item B<CollectUptime> B<true>|B<false>
7159 Varnish uptime. Only available with Varnish 3.x and above. False by default.
7161 =item B<CollectVCL> B<true>|B<false>
7163 Number of total (available + discarded) VCL (config files). False by default.
7165 =item B<CollectVSM> B<true>|B<false>
7167 Collect statistics about Varnish's shared memory usage (used by the logging and
7168 statistics subsystems). Only available with Varnish 4.x. False by default.
7170 =item B<CollectWorkers> B<true>|B<false>
7172 Collect statistics about worker threads. False by default.
7174 =back
7176 =head2 Plugin C<virt>
7178 This plugin allows CPU, disk and network load to be collected for virtualized
7179 guests on the machine. This means that these metrics can be collected for guest
7180 systems without installing any software on them - I<collectd> only runs on the
7181 host system. The statistics are collected through libvirt
7182 (L<http://libvirt.org/>).
7184 Only I<Connection> is required.
7186 =over 4
7188 =item B<Connection> I<uri>
7190 Connect to the hypervisor given by I<uri>. For example if using Xen use:
7192  Connection "xen:///"
7194 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
7196 =item B<RefreshInterval> I<seconds>
7198 Refresh the list of domains and devices every I<seconds>. The default is 60
7199 seconds. Setting this to be the same or smaller than the I<Interval> will cause
7200 the list of domains and devices to be refreshed on every iteration.
7202 Refreshing the devices in particular is quite a costly operation, so if your
7203 virtualization setup is static you might consider increasing this. If this
7204 option is set to 0, refreshing is disabled completely.
7206 =item B<Domain> I<name>
7208 =item B<BlockDevice> I<name:dev>
7210 =item B<InterfaceDevice> I<name:dev>
7212 =item B<IgnoreSelected> B<true>|B<false>
7214 Select which domains and devices are collected.
7216 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
7217 disk/network devices are collected.
7219 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
7220 domains and disk/network devices are ignored, while the rest are collected.
7222 The domain name and device names may use a regular expression, if the name is
7223 surrounded by I</.../> and collectd was compiled with support for regexps.
7225 The default is to collect statistics for all domains and all their devices.
7227 Example:
7229  BlockDevice "/:hdb/"
7230  IgnoreSelected "true"
7232 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
7233 will be collected.
7235 =item B<HostnameFormat> B<name|uuid|hostname|...>
7237 When the virt plugin logs data, it sets the hostname of the collected data
7238 according to this setting. The default is to use the guest name as provided by
7239 the hypervisor, which is equal to setting B<name>.
7241 B<uuid> means use the guest's UUID. This is useful if you want to track the
7242 same guest across migrations.
7244 B<hostname> means to use the global B<Hostname> setting, which is probably not
7245 useful on its own because all guests will appear to have the same name.
7247 You can also specify combinations of these fields. For example B<name uuid>
7248 means to concatenate the guest name and UUID (with a literal colon character
7249 between, thus I<"foo:1234-1234-1234-1234">).
7251 At the moment of writing (collectd-5.5), hostname string is limited to 62
7252 characters. In case when combination of fields exceeds 62 characters,
7253 hostname will be truncated without a warning.
7255 =item B<InterfaceFormat> B<name>|B<address>
7257 When the virt plugin logs interface data, it sets the name of the collected
7258 data according to this setting. The default is to use the path as provided by
7259 the hypervisor (the "dev" property of the target node), which is equal to
7260 setting B<name>.
7262 B<address> means use the interface's mac address. This is useful since the
7263 interface path might change between reboots of a guest or across migrations.
7265 =item B<PluginInstanceFormat> B<name|uuid|none>
7267 When the virt plugin logs data, it sets the plugin_instance of the collected
7268 data according to this setting. The default is to not set the plugin_instance.
7270 B<name> means use the guest's name as provided by the hypervisor.
7271 B<uuid> means use the guest's UUID.
7273 You can also specify combinations of the B<name> and B<uuid> fields.
7274 For example B<name uuid> means to concatenate the guest name and UUID
7275 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
7277 =back
7279 =head2 Plugin C<vmem>
7281 The C<vmem> plugin collects information about the usage of virtual memory.
7282 Since the statistics provided by the Linux kernel are very detailed, they are
7283 collected very detailed. However, to get all the details, you have to switch
7284 them on manually. Most people just want an overview over, such as the number of
7285 pages read from swap space.
7287 =over 4
7289 =item B<Verbose> B<true>|B<false>
7291 Enables verbose collection of information. This will start collecting page
7292 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
7293 Part of these statistics are collected on a "per zone" basis.
7295 =back
7297 =head2 Plugin C<vserver>
7299 This plugin doesn't have any options. B<VServer> support is only available for
7300 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
7301 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
7302 need to apply the patches and compile your own kernel, which will then provide
7303 the F</proc/virtual> filesystem that is required by this plugin.
7305 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
7307 B<Note>: The traffic collected by this plugin accounts for the amount of
7308 traffic passing a socket which might be a lot less than the actual on-wire
7309 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
7310 collect on-wire traffic you could, for example, use the logging facilities of
7311 iptables to feed data for the guest IPs into the iptables plugin.
7313 =head2 Plugin C<write_graphite>
7315 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
7316 storage and graphing project. The plugin connects to I<Carbon>, the data layer
7317 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
7318 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
7319 of at most 1428 bytes to minimize the number of network packets.
7321 Synopsis:
7323  <Plugin write_graphite>
7324    <Node "example">
7325      Host "localhost"
7326      Port "2003"
7327      Protocol "tcp"
7328      LogSendErrors true
7329      Prefix "collectd"
7330    </Node>
7331  </Plugin>
7333 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7334 blocks. Inside the B<Node> blocks, the following options are recognized:
7336 =over 4
7338 =item B<Host> I<Address>
7340 Hostname or address to connect to. Defaults to C<localhost>.
7342 =item B<Port> I<Service>
7344 Service name or port number to connect to. Defaults to C<2003>.
7346 =item B<Protocol> I<String>
7348 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
7350 =item B<ReconnectInterval> I<Seconds>
7352 When set to non-zero, forces the connection to the Graphite backend to be
7353 closed and re-opend periodically. This behavior is desirable in environments
7354 where the connection to the Graphite backend is done through load balancers,
7355 for example. When set to zero, the default, the connetion is kept open for as
7356 long as possible.
7358 =item B<LogSendErrors> B<false>|B<true>
7360 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
7361 If set to B<false>, it will not log the errors. This is especially useful when
7362 using Protocol UDP since many times we want to use the "fire-and-forget"
7363 approach and logging errors fills syslog with unneeded messages.
7365 =item B<Prefix> I<String>
7367 When set, I<String> is added in front of the host name. Dots and whitespace are
7368 I<not> escaped in this string (see B<EscapeCharacter> below).
7370 =item B<Postfix> I<String>
7372 When set, I<String> is appended to the host name. Dots and whitespace are
7373 I<not> escaped in this string (see B<EscapeCharacter> below).
7375 =item B<EscapeCharacter> I<Char>
7377 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
7378 in the identifier. The B<EscapeCharacter> option determines which character
7379 dots, whitespace and control characters are replaced with. Defaults to
7380 underscore (C<_>).
7382 =item B<StoreRates> B<false>|B<true>
7384 If set to B<true> (the default), convert counter values to rates. If set to
7385 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7386 number.
7388 =item B<SeparateInstances> B<false>|B<true>
7390 If set to B<true>, the plugin instance and type instance will be in their own
7391 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7392 default), the plugin and plugin instance (and likewise the type and type
7393 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7395 =item B<AlwaysAppendDS> B<false>|B<true>
7397 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7398 identifier. If set to B<false> (the default), this is only done when there is
7399 more than one DS.
7401 =back
7403 =head2 Plugin C<write_tsdb>
7405 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7406 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7407 state daemon that ingests metrics and stores them in HBase. The plugin uses
7408 I<TCP> over the "line based" protocol with a default port 4242. The data will
7409 be sent in blocks of at most 1428 bytes to minimize the number of network
7410 packets.
7412 Synopsis:
7414  <Plugin write_tsdb>
7415    <Node "example">
7416      Host "tsd-1.my.domain"
7417      Port "4242"
7418      HostTags "status=production"
7419    </Node>
7420  </Plugin>
7422 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7423 blocks. Inside the B<Node> blocks, the following options are recognized:
7425 =over 4
7427 =item B<Host> I<Address>
7429 Hostname or address to connect to. Defaults to C<localhost>.
7431 =item B<Port> I<Service>
7433 Service name or port number to connect to. Defaults to C<4242>.
7436 =item B<HostTags> I<String>
7438 When set, I<HostTags> is added to the end of the metric. It is intended to be
7439 used for name=value pairs that the TSD will tag the metric with. Dots and
7440 whitespace are I<not> escaped in this string.
7442 =item B<StoreRates> B<false>|B<true>
7444 If set to B<true>, convert counter values to rates. If set to B<false>
7445 (the default) counter values are stored as is, as an increasing
7446 integer number.
7448 =item B<AlwaysAppendDS> B<false>|B<true>
7450 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7451 identifier. If set to B<false> (the default), this is only done when there is
7452 more than one DS.
7454 =back
7456 =head2 Plugin C<write_mongodb>
7458 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7459 NoSQL database.
7461 B<Synopsis:>
7463  <Plugin "write_mongodb">
7464    <Node "default">
7465      Host "localhost"
7466      Port "27017"
7467      Timeout 1000
7468      StoreRates true
7469    </Node>
7470  </Plugin>
7472 The plugin can send values to multiple instances of I<MongoDB> by specifying
7473 one B<Node> block for each instance. Within the B<Node> blocks, the following
7474 options are available:
7476 =over 4
7478 =item B<Host> I<Address>
7480 Hostname or address to connect to. Defaults to C<localhost>.
7482 =item B<Port> I<Service>
7484 Service name or port number to connect to. Defaults to C<27017>.
7486 =item B<Timeout> I<Milliseconds>
7488 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7489 Setting this option to zero means no timeout, which is the default.
7491 =item B<StoreRates> B<false>|B<true>
7493 If set to B<true> (the default), convert counter values to rates. If set to
7494 B<false> counter values are stored as is, i.e. as an increasing integer
7495 number.
7497 =item B<Database> I<Database>
7499 =item B<User> I<User>
7501 =item B<Password> I<Password>
7503 Sets the information used when authenticating to a I<MongoDB> database. The
7504 fields are optional (in which case no authentication is attempted), but if you
7505 want to use authentication all three fields must be set.
7507 =back
7509 =head2 Plugin C<write_http>
7511 This output plugin submits values to an HTTP server using POST requests and
7512 encoding metrics with JSON or using the C<PUTVAL> command described in
7513 L<collectd-unixsock(5)>.
7515 Synopsis:
7517  <Plugin "write_http">
7518    <Node "example">
7519      URL "http://example.com/post-collectd"
7520      User "collectd"
7521      Password "weCh3ik0"
7522      Format JSON
7523    </Node>
7524  </Plugin>
7526 The plugin can send values to multiple HTTP servers by specifying one
7527 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7528 block, the following options are available:
7530 =over 4
7532 =item B<URL> I<URL>
7534 URL to which the values are submitted to. Mandatory.
7536 =item B<User> I<Username>
7538 Optional user name needed for authentication.
7540 =item B<Password> I<Password>
7542 Optional password needed for authentication.
7544 =item B<VerifyPeer> B<true>|B<false>
7546 Enable or disable peer SSL certificate verification. See
7547 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7549 =item B<VerifyHost> B<true|false>
7551 Enable or disable peer host name verification. If enabled, the plugin checks if
7552 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7553 matches the host name provided by the B<URL> option. If this identity check
7554 fails, the connection is aborted. Obviously, only works when connecting to a
7555 SSL enabled server. Enabled by default.
7557 =item B<CACert> I<File>
7559 File that holds one or more SSL certificates. If you want to use HTTPS you will
7560 possibly need this option. What CA certificates come bundled with C<libcurl>
7561 and are checked by default depends on the distribution you use.
7563 =item B<CAPath> I<Directory>
7565 Directory holding one or more CA certificate files. You can use this if for
7566 some reason all the needed CA certificates aren't in the same file and can't be
7567 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7568 OpenSSL.
7570 =item B<ClientKey> I<File>
7572 File that holds the private key in PEM format to be used for certificate-based
7573 authentication.
7575 =item B<ClientCert> I<File>
7577 File that holds the SSL certificate to be used for certificate-based
7578 authentication.
7580 =item B<ClientKeyPass> I<Password>
7582 Password required to load the private key in B<ClientKey>.
7584 =item B<Header> I<Header>
7586 A HTTP header to add to the request.  Multiple headers are added if this option is specified more than once.  Example:
7588   Header "X-Custom-Header: custom_value"
7590 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7592 Define which SSL protocol version must be used. By default C<libcurl> will
7593 attempt to figure out the remote SSL protocol version. See
7594 L<curl_easy_setopt(3)> for more details.
7596 =item B<Format> B<Command>|B<JSON>
7598 Format of the output to generate. If set to B<Command>, will create output that
7599 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7600 create output in the I<JavaScript Object Notation> (JSON).
7602 Defaults to B<Command>.
7604 =item B<StoreRates> B<true|false>
7606 If set to B<true>, convert counter values to rates. If set to B<false> (the
7607 default) counter values are stored as is, i.e. as an increasing integer number.
7609 =item B<BufferSize> I<Bytes>
7611 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7612 requests will be generated, but more metrics will be batched / metrics are
7613 cached for longer before being sent, introducing additional delay until they
7614 are available on the server side. I<Bytes> must be at least 1024 and cannot
7615 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7616 Defaults to C<4096>.
7618 =item B<LowSpeedLimit> I<Bytes per Second>
7620 Sets the minimal transfer rate in I<Bytes per Second> below which the
7621 connection with the HTTP server will be considered too slow and aborted. All
7622 the data submitted over this connection will probably be lost. Defaults to 0,
7623 which means no minimum transfer rate is enforced.
7625 =item B<Timeout> I<Timeout>
7627 Sets the maximum time in milliseconds given for HTTP POST operations to
7628 complete. When this limit is reached, the POST operation will be aborted, and
7629 all the data in the current send buffer will probably be lost. Defaults to 0,
7630 which means the connection never times out.
7632 =item B<LogHttpError> B<false>|B<true>
7634 Enables printing of HTTP error code to log. Turned off by default.
7636 The C<write_http> plugin regularly submits the collected values to the HTTP
7637 server. How frequently this happens depends on how much data you are collecting
7638 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
7639 slightly below this interval, which you can estimate by monitoring the network
7640 traffic between collectd and the HTTP server.
7642 =back
7644 =head2 Plugin C<write_kafka>
7646 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7647 queue.
7648 Synopsis:
7650  <Plugin "write_kafka">
7651    Property "metadata.broker.list" "broker1:9092,broker2:9092"
7652    <Topic "collectd">
7653      Format JSON
7654    </Topic>
7655  </Plugin>
7657 The following options are understood by the I<write_kafka plugin>:
7659 =over 4
7661 =item E<lt>B<Topic> I<Name>E<gt>
7663 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7664 is given a unique I<Name> and specifies one kafka producer.
7665 Inside the B<Topic> block, the following per-topic options are
7666 understood:
7668 =over 4
7670 =item B<Property> I<String> I<String>
7672 Configure the named property for the current topic. Properties are
7673 forwarded to the kafka producer library B<librdkafka>.
7675 =item B<Key> I<String>
7677 Use the specified string as a partioning key for the topic. Kafka breaks
7678 topic into partitions and guarantees that for a given topology, the same
7679 consumer will be used for a specific key. The special (case insensitive)
7680 string B<Random> can be used to specify that an arbitrary partition should
7681 be used.
7683 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7685 Selects the format in which messages are sent to the broker. If set to
7686 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7687 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7689 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7690 an easy and straight forward exchange format.
7692 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7693 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7695 =item B<StoreRates> B<true>|B<false>
7697 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7698 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7699 default), no conversion is performed. Otherwise the conversion is performed
7700 using the internal value cache.
7702 Please note that currently this option is only used if the B<Format> option has
7703 been set to B<JSON>.
7705 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7707 A prefix can be added in the metric name when outputting in the I<Graphite>
7708 format. It's added before the I<Host> name.
7709 Metric name will be
7710 C<E<lt>prefixE<gt>E<lt>hostE<gt>E<lt>postfixE<gt>E<lt>pluginE<gt>E<lt>typeE<gt>E<lt>nameE<gt>>
7712 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7714 A postfix can be added in the metric name when outputting in the I<Graphite>
7715 format. It's added after the I<Host> name.
7716 Metric name will be
7717 C<E<lt>prefixE<gt>E<lt>hostE<gt>E<lt>postfixE<gt>E<lt>pluginE<gt>E<lt>typeE<gt>E<lt>nameE<gt>>
7719 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7721 Specify a character to replace dots (.) in the host part of the metric name.
7722 In I<Graphite> metric name, dots are used as separators between different
7723 metric parts (host, plugin, type).
7724 Default is C<_> (I<Underscore>).
7726 =item B<GraphiteSeparateInstances> B<false>|B<true>
7728 If set to B<true>, the plugin instance and type instance will be in their own
7729 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7730 default), the plugin and plugin instance (and likewise the type and type
7731 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7733 =item B<StoreRates> B<true>|B<false>
7735 If set to B<true> (the default), convert counter values to rates. If set to
7736 B<false> counter values are stored as is, i.e. as an increasing integer number.
7738 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7739 converted values will have "rate" appended to the data source type, e.g.
7740 C<ds_type:derive:rate>.
7742 =back
7744 =item B<Property> I<String> I<String>
7746 Configure the kafka producer through properties, you almost always will
7747 want to set B<metadata.broker.list> to your Kafka broker list.
7749 =back
7751 =head2 Plugin C<write_redis>
7753 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7755 Synopsis:
7757   <Plugin "write_redis">
7758     <Node "example">
7759         Host "localhost"
7760         Port "6379"
7761         Timeout 1000
7762         Prefix "collectd/"
7763         Database 1
7764         MaxSetSize -1
7765         StoreRates true
7766     </Node>
7767   </Plugin>
7769 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7770 the timestamp as the score. Retrieving a date range can then be done using the
7771 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
7772 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
7773 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
7774 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
7775 with the B<Database> parameter (default is C<0>). See
7776 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7777 details.
7779 The information shown in the synopsis above is the I<default configuration>
7780 which is used by the plugin if no configuration is present.
7782 The plugin can send values to multiple instances of I<Redis> by specifying
7783 one B<Node> block for each instance. Within the B<Node> blocks, the following
7784 options are available:
7786 =over 4
7788 =item B<Node> I<Nodename>
7790 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7791 instance running on a specified host and port. The node name is a
7792 canonical identifier which is used as I<plugin instance>. It is limited to
7793 51E<nbsp>characters in length.
7795 =item B<Host> I<Hostname>
7797 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7798 running on.
7800 =item B<Port> I<Port>
7802 The B<Port> option is the TCP port on which the Redis instance accepts
7803 connections. Either a service name of a port number may be given. Please note
7804 that numerical port numbers must be given as a string, too.
7806 =item B<Timeout> I<Milliseconds>
7808 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7810 =item B<Prefix> I<Prefix>
7812 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
7813 containing all metrics. Defaults to C<collectd/>, so metrics will have names
7814 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
7815 is recommended but not required to include a trailing slash in I<Prefix>.
7817 =item B<Database> I<Index>
7819 This index selects the redis database to use for writing operations. Defaults
7820 to C<0>.
7822 =item B<MaxSetSize> I<Items>
7824 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
7825 hold. Negative values for I<Items> sets no limit, which is the default behavior.
7827 =item B<StoreRates> B<true>|B<false>
7829 If set to B<true> (the default), convert counter values to rates. If set to
7830 B<false> counter values are stored as is, i.e. as an increasing integer number.
7832 =back
7834 =head2 Plugin C<write_riemann>
7836 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7837 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7838 I<Riemann> using UDP packets.
7840 Synopsis:
7842  <Plugin "write_riemann">
7843    <Node "example">
7844      Host "localhost"
7845      Port "5555"
7846      Protocol UDP
7847      StoreRates true
7848      AlwaysAppendDS false
7849      TTLFactor 2.0
7850    </Node>
7851    Tag "foobar"
7852    Attribute "foo" "bar"
7853  </Plugin>
7855 The following options are understood by the I<write_riemann plugin>:
7857 =over 4
7859 =item E<lt>B<Node> I<Name>E<gt>
7861 The plugin's configuration consists of one or more B<Node> blocks. Each block
7862 is given a unique I<Name> and specifies one connection to an instance of
7863 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7864 understood:
7866 =over 4
7868 =item B<Host> I<Address>
7870 Hostname or address to connect to. Defaults to C<localhost>.
7872 =item B<Port> I<Service>
7874 Service name or port number to connect to. Defaults to C<5555>.
7876 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
7878 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7879 B<TCP>.
7881 =item B<TLSCertFile> I<Path>
7883 When using the B<TLS> protocol, path to a PEM certificate to present
7884 to remote host.
7886 =item B<TLSCAFile> I<Path>
7888 When using the B<TLS> protocol, path to a PEM CA certificate to
7889 use to validate the remote hosts's identity.
7891 =item B<TLSKeyFile> I<Path>
7893 When using the B<TLS> protocol, path to a PEM private key associated
7894 with the certificate defined by B<TLSCertFile>.
7896 =item B<Batch> B<true>|B<false>
7898 If set to B<true> and B<Protocol> is set to B<TCP>,
7899 events will be batched in memory and flushed at
7900 regular intervals or when B<BatchMaxSize> is exceeded.
7902 Notifications are not batched and sent as soon as possible.
7904 When enabled, it can occur that events get processed by the Riemann server
7905 close to or after their expiration time. Tune the B<TTLFactor> and
7906 B<BatchMaxSize> settings according to the amount of values collected, if this
7907 is an issue.
7909 Defaults to true
7911 =item B<BatchMaxSize> I<size>
7913 Maximum payload size for a riemann packet. Defaults to 8192
7915 =item B<BatchFlushTimeout> I<seconds>
7917 Maximum amount of seconds to wait in between to batch flushes.
7918 No timeout by default.
7920 =item B<StoreRates> B<true>|B<false>
7922 If set to B<true> (the default), convert counter values to rates. If set to
7923 B<false> counter values are stored as is, i.e. as an increasing integer number.
7925 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7926 converted values will have "rate" appended to the data source type, e.g.
7927 C<ds_type:derive:rate>.
7929 =item B<AlwaysAppendDS> B<false>|B<true>
7931 If set to B<true>, append the name of the I<Data Source> (DS) to the
7932 "service", i.e. the field that, together with the "host" field, uniquely
7933 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7934 only done when there is more than one DS.
7936 =item B<TTLFactor> I<Factor>
7938 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7939 event is considered active. I<collectd> populates this field based on the
7940 metrics interval setting. This setting controls the factor with which the
7941 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7942 know exactly what you're doing, you should only increase this setting from its
7943 default value.
7945 =item B<Notifications> B<false>|B<true>
7947 If set to B<true>, create riemann events for notifications. This is B<true>
7948 by default. When processing thresholds from write_riemann, it might prove
7949 useful to avoid getting notification events.
7951 =item B<CheckThresholds> B<false>|B<true>
7953 If set to B<true>, attach state to events based on thresholds defined
7954 in the B<Threshold> plugin. Defaults to B<false>.
7956 =item B<EventServicePrefix> I<String>
7958 Add the given string as a prefix to the event service name.
7959 If B<EventServicePrefix> not set or set to an empty string (""),
7960 no prefix will be used.
7962 =back
7964 =item B<Tag> I<String>
7966 Add the given string as an additional tag to the metric being sent to
7967 I<Riemann>.
7969 =item B<Attribute> I<String> I<String>
7971 Consider the two given strings to be the key and value of an additional
7972 attribute for each metric being sent out to I<Riemann>.
7974 =back
7976 =head2 Plugin C<write_sensu>
7978 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
7979 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
7980 a local I<Sensu> client using a TCP socket.
7982 At the moment, the I<write_sensu plugin> does not send over a collectd_host
7983 parameter so it is not possible to use one collectd instance as a gateway for
7984 others. Each collectd host must pair with one I<Sensu> client.
7986 Synopsis:
7988  <Plugin "write_sensu">
7989    <Node "example">
7990      Host "localhost"
7991      Port "3030"
7992      StoreRates true
7993      AlwaysAppendDS false
7994      MetricHandler "influx"
7995      MetricHandler "default"
7996      NotificationHandler "flapjack"
7997      NotificationHandler "howling_monkey"
7998      Notifications true
7999    </Node>
8000    Tag "foobar"
8001    Attribute "foo" "bar"
8002  </Plugin>
8004 The following options are understood by the I<write_sensu plugin>:
8006 =over 4
8008 =item E<lt>B<Node> I<Name>E<gt>
8010 The plugin's configuration consists of one or more B<Node> blocks. Each block
8011 is given a unique I<Name> and specifies one connection to an instance of
8012 I<Sensu>. Inside the B<Node> block, the following per-connection options are
8013 understood:
8015 =over 4
8017 =item B<Host> I<Address>
8019 Hostname or address to connect to. Defaults to C<localhost>.
8021 =item B<Port> I<Service>
8023 Service name or port number to connect to. Defaults to C<3030>.
8025 =item B<StoreRates> B<true>|B<false>
8027 If set to B<true> (the default), convert counter values to rates. If set to
8028 B<false> counter values are stored as is, i.e. as an increasing integer number.
8030 This will be reflected in the C<collectd_data_source_type> tag: If
8031 B<StoreRates> is enabled, converted values will have "rate" appended to the
8032 data source type, e.g.  C<collectd_data_source_type:derive:rate>.
8034 =item B<AlwaysAppendDS> B<false>|B<true>
8036 If set the B<true>, append the name of the I<Data Source> (DS) to the
8037 "service", i.e. the field that, together with the "host" field, uniquely
8038 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
8039 only done when there is more than one DS.
8041 =item B<Notifications> B<false>|B<true>
8043 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
8044 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8046 =item B<Metrics> B<false>|B<true>
8048 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
8049 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8052 =item B<Separator> I<String>
8054 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
8056 =item B<MetricHandler> I<String>
8058 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
8059 several of them, one per line. Defaults to no handler.
8061 =item B<NotificationHandler> I<String>
8063 Add a handler that will be set when notifications are sent to I<Sensu>. You can
8064 add several of them, one per line. Defaults to no handler.
8066 =item B<EventServicePrefix> I<String>
8068 Add the given string as a prefix to the event service name.
8069 If B<EventServicePrefix> not set or set to an empty string (""),
8070 no prefix will be used.
8072 =back
8074 =item B<Tag> I<String>
8076 Add the given string as an additional tag to the metric being sent to
8077 I<Sensu>.
8079 =item B<Attribute> I<String> I<String>
8081 Consider the two given strings to be the key and value of an additional
8082 attribute for each metric being sent out to I<Sensu>.
8084 =back
8086 =head2 Plugin C<xencpu>
8088 This plugin collects metrics of hardware CPU load for machine running Xen
8089 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
8090 Result is reported using the C<percent> type, for each CPU (core).
8092 This plugin doesn't have any options (yet).
8094 =head2 Plugin C<zookeeper>
8096 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
8097 using the mntr command.  It requires Zookeeper 3.4.0+ and access to the
8098 client port.
8100 B<Synopsis:>
8102  <Plugin "zookeeper">
8103    Host "127.0.0.1"
8104    Port "2181"
8105  </Plugin>
8107 =over 4
8109 =item B<Host> I<Address>
8111 Hostname or address to connect to. Defaults to C<localhost>.
8113 =item B<Port> I<Service>
8115 Service name or port number to connect to. Defaults to C<2181>.
8117 =back
8119 =head1 THRESHOLD CONFIGURATION
8121 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
8122 we mean that the values are not only stored or sent somewhere, but that they
8123 are judged and, if a problem is recognized, acted upon. The only action
8124 collectd takes itself is to generate and dispatch a "notification". Plugins can
8125 register to receive notifications and perform appropriate further actions.
8127 Since systems and what you expect them to do differ a lot, you can configure
8128 B<thresholds> for your values freely. This gives you a lot of flexibility but
8129 also a lot of responsibility.
8131 Every time a value is out of range a notification is dispatched. This means
8132 that the idle percentage of your CPU needs to be less then the configured
8133 threshold only once for a notification to be generated. There's no such thing
8134 as a moving average or similar - at least not now.
8136 Also, all values that match a threshold are considered to be relevant or
8137 "interesting". As a consequence collectd will issue a notification if they are
8138 not received for B<Timeout> iterations. The B<Timeout> configuration option is
8139 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
8140 "2" (the default) and some hosts sends it's CPU statistics to the server every
8141 60 seconds, a notification will be dispatched after about 120 seconds. It may
8142 take a little longer because the timeout is checked only once each B<Interval>
8143 on the server.
8145 When a value comes within range again or is received after it was missing, an
8146 "OKAY-notification" is dispatched.
8148 Here is a configuration example to get you started. Read below for more
8149 information.
8151  <Plugin threshold>
8152    <Type "foo">
8153      WarningMin    0.00
8154      WarningMax 1000.00
8155      FailureMin    0.00
8156      FailureMax 1200.00
8157      Invert false
8158      Instance "bar"
8159    </Type>
8161    <Plugin "interface">
8162      Instance "eth0"
8163      <Type "if_octets">
8164        FailureMax 10000000
8165        DataSource "rx"
8166      </Type>
8167    </Plugin>
8169    <Host "hostname">
8170      <Type "cpu">
8171        Instance "idle"
8172        FailureMin 10
8173      </Type>
8175      <Plugin "memory">
8176        <Type "memory">
8177          Instance "cached"
8178          WarningMin 100000000
8179        </Type>
8180      </Plugin>
8181    </Host>
8182  </Plugin>
8184 There are basically two types of configuration statements: The C<Host>,
8185 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
8186 configured. The C<Plugin> and C<Type> blocks may be specified further using the
8187 C<Instance> option. You can combine the block by nesting the blocks, though
8188 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
8189 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
8190 C<Type> may not contain other blocks. If multiple blocks apply to the same
8191 value the most specific block is used.
8193 The other statements specify the threshold to configure. They B<must> be
8194 included in a C<Type> block. Currently the following statements are recognized:
8196 =over 4
8198 =item B<FailureMax> I<Value>
8200 =item B<WarningMax> I<Value>
8202 Sets the upper bound of acceptable values. If unset defaults to positive
8203 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
8204 will be created. If the value is greater than B<WarningMax> but less than (or
8205 equal to) B<FailureMax> a B<WARNING> notification will be created.
8207 =item B<FailureMin> I<Value>
8209 =item B<WarningMin> I<Value>
8211 Sets the lower bound of acceptable values. If unset defaults to negative
8212 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
8213 be created. If the value is less than B<WarningMin> but greater than (or equal
8214 to) B<FailureMin> a B<WARNING> notification will be created.
8216 =item B<DataSource> I<DSName>
8218 Some data sets have more than one "data source". Interesting examples are the
8219 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
8220 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
8221 system load data set, C<load>, even has three data sources: C<shortterm>,
8222 C<midterm>, and C<longterm>.
8224 Normally, all data sources are checked against a configured threshold. If this
8225 is undesirable, or if you want to specify different limits for each data
8226 source, you can use the B<DataSource> option to have a threshold apply only to
8227 one data source.
8229 =item B<Invert> B<true>|B<false>
8231 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
8232 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
8233 B<WarningMax>) are not okay. Defaults to B<false>.
8235 =item B<Persist> B<true>|B<false>
8237 Sets how often notifications are generated. If set to B<true> one notification
8238 will be generated for each value that is out of the acceptable range. If set to
8239 B<false> (the default) then a notification is only generated if a value is out
8240 of range but the previous value was okay.
8242 This applies to missing values, too: If set to B<true> a notification about a
8243 missing value is generated once every B<Interval> seconds. If set to B<false>
8244 only one such notification is generated until the value appears again.
8246 =item B<Percentage> B<true>|B<false>
8248 If set to B<true>, the minimum and maximum values given are interpreted as
8249 percentage value, relative to the other data sources. This is helpful for
8250 example for the "df" type, where you may want to issue a warning when less than
8251 5E<nbsp>% of the total space is available. Defaults to B<false>.
8253 =item B<Hits> I<Number>
8255 Delay creating the notification until the threshold has been passed I<Number>
8256 times. When a notification has been generated, or when a subsequent value is
8257 inside the threshold, the counter is reset. If, for example, a value is
8258 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
8259 will be dispatched at most once every 30E<nbsp>seconds.
8261 This is useful when short bursts are not a problem. If, for example, 100% CPU
8262 usage for up to a minute is normal (and data is collected every
8263 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
8265 =item B<Hysteresis> I<Number>
8267 When set to non-zero, a hysteresis value is applied when checking minimum and
8268 maximum bounds. This is useful for values that increase slowly and fluctuate a
8269 bit while doing so. When these values come close to the threshold, they may
8270 "flap", i.e. switch between failure / warning case and okay case repeatedly.
8272 If, for example, the threshold is configures as
8274   WarningMax 100.0
8275   Hysteresis 1.0
8277 then a I<Warning> notification is created when the value exceeds I<101> and the
8278 corresponding I<Okay> notification is only created once the value falls below
8279 I<99>, thus avoiding the "flapping".
8281 =back
8283 =head1 FILTER CONFIGURATION
8285 Starting with collectd 4.6 there is a powerful filtering infrastructure
8286 implemented in the daemon. The concept has mostly been copied from
8287 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
8288 terminology, so that users that are familiar with iptables feel right at home.
8290 =head2 Terminology
8292 The following are the terms used in the remainder of the filter configuration
8293 documentation. For an ASCII-art schema of the mechanism, see
8294 L<"General structure"> below.
8296 =over 4
8298 =item B<Match>
8300 A I<match> is a criteria to select specific values. Examples are, of course, the
8301 name of the value or it's current value.
8303 Matches are implemented in plugins which you have to load prior to using the
8304 match. The name of such plugins starts with the "match_" prefix.
8306 =item B<Target>
8308 A I<target> is some action that is to be performed with data. Such actions
8309 could, for example, be to change part of the value's identifier or to ignore
8310 the value completely.
8312 Some of these targets are built into the daemon, see L<"Built-in targets">
8313 below. Other targets are implemented in plugins which you have to load prior to
8314 using the target. The name of such plugins starts with the "target_" prefix.
8316 =item B<Rule>
8318 The combination of any number of matches and at least one target is called a
8319 I<rule>. The target actions will be performed for all values for which B<all>
8320 matches apply. If the rule does not have any matches associated with it, the
8321 target action will be performed for all values.
8323 =item B<Chain>
8325 A I<chain> is a list of rules and possibly default targets. The rules are tried
8326 in order and if one matches, the associated target will be called. If a value
8327 is handled by a rule, it depends on the target whether or not any subsequent
8328 rules are considered or if traversal of the chain is aborted, see
8329 L<"Flow control"> below. After all rules have been checked, the default targets
8330 will be executed.
8332 =back
8334 =head2 General structure
8336 The following shows the resulting structure:
8338  +---------+
8339  ! Chain   !
8340  +---------+
8341       !
8342       V
8343  +---------+  +---------+  +---------+  +---------+
8344  ! Rule    !->! Match   !->! Match   !->! Target  !
8345  +---------+  +---------+  +---------+  +---------+
8346       !
8347       V
8348  +---------+  +---------+  +---------+
8349  ! Rule    !->! Target  !->! Target  !
8350  +---------+  +---------+  +---------+
8351       !
8352       V
8353       :
8354       :
8355       !
8356       V
8357  +---------+  +---------+  +---------+
8358  ! Rule    !->! Match   !->! Target  !
8359  +---------+  +---------+  +---------+
8360       !
8361       V
8362  +---------+
8363  ! Default !
8364  ! Target  !
8365  +---------+
8367 =head2 Flow control
8369 There are four ways to control which way a value takes through the filter
8370 mechanism:
8372 =over 4
8374 =item B<jump>
8376 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
8377 process the value with another chain. When the called chain finishes, usually
8378 the next target or rule after the jump is executed.
8380 =item B<stop>
8382 The stop condition, signaled for example by the built-in target B<stop>, causes
8383 all processing of the value to be stopped immediately.
8385 =item B<return>
8387 Causes processing in the current chain to be aborted, but processing of the
8388 value generally will continue. This means that if the chain was called via
8389 B<Jump>, the next target or rule after the jump will be executed. If the chain
8390 was not called by another chain, control will be returned to the daemon and it
8391 may pass the value to another chain.
8393 =item B<continue>
8395 Most targets will signal the B<continue> condition, meaning that processing
8396 should continue normally. There is no special built-in target for this
8397 condition.
8399 =back
8401 =head2 Synopsis
8403 The configuration reflects this structure directly:
8405  PostCacheChain "PostCache"
8406  <Chain "PostCache">
8407    <Rule "ignore_mysql_show">
8408      <Match "regex">
8409        Plugin "^mysql$"
8410        Type "^mysql_command$"
8411        TypeInstance "^show_"
8412      </Match>
8413      <Target "stop">
8414      </Target>
8415    </Rule>
8416    <Target "write">
8417      Plugin "rrdtool"
8418    </Target>
8419  </Chain>
8421 The above configuration example will ignore all values where the plugin field
8422 is "mysql", the type is "mysql_command" and the type instance begins with
8423 "show_". All other values will be sent to the C<rrdtool> write plugin via the
8424 default target of the chain. Since this chain is run after the value has been
8425 added to the cache, the MySQL C<show_*> command statistics will be available
8426 via the C<unixsock> plugin.
8428 =head2 List of configuration options
8430 =over 4
8432 =item B<PreCacheChain> I<ChainName>
8434 =item B<PostCacheChain> I<ChainName>
8436 Configure the name of the "pre-cache chain" and the "post-cache chain". The
8437 argument is the name of a I<chain> that should be executed before and/or after
8438 the values have been added to the cache.
8440 To understand the implications, it's important you know what is going on inside
8441 I<collectd>. The following diagram shows how values are passed from the
8442 read-plugins to the write-plugins:
8444    +---------------+
8445    !  Read-Plugin  !
8446    +-------+-------+
8447            !
8448  + - - - - V - - - - +
8449  : +---------------+ :
8450  : !   Pre-Cache   ! :
8451  : !     Chain     ! :
8452  : +-------+-------+ :
8453  :         !         :
8454  :         V         :
8455  : +-------+-------+ :  +---------------+
8456  : !     Cache     !--->!  Value Cache  !
8457  : !     insert    ! :  +---+---+-------+
8458  : +-------+-------+ :      !   !
8459  :         !   ,------------'   !
8460  :         V   V     :          V
8461  : +-------+---+---+ :  +-------+-------+
8462  : !  Post-Cache   +--->! Write-Plugins !
8463  : !     Chain     ! :  +---------------+
8464  : +---------------+ :
8465  :                   :
8466  :  dispatch values  :
8467  + - - - - - - - - - +
8469 After the values are passed from the "read" plugins to the dispatch functions,
8470 the pre-cache chain is run first. The values are added to the internal cache
8471 afterwards. The post-cache chain is run after the values have been added to the
8472 cache. So why is it such a huge deal if chains are run before or after the
8473 values have been added to this cache?
8475 Targets that change the identifier of a value list should be executed before
8476 the values are added to the cache, so that the name in the cache matches the
8477 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8478 this cache to receive a list of all available values. If you change the
8479 identifier after the value list has been added to the cache, this may easily
8480 lead to confusion, but it's not forbidden of course.
8482 The cache is also used to convert counter values to rates. These rates are, for
8483 example, used by the C<value> match (see below). If you use the rate stored in
8484 the cache B<before> the new value is added, you will use the old, B<previous>
8485 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8486 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8487 command.
8489 Last but not last, the B<stop> target makes a difference: If the pre-cache
8490 chain returns the stop condition, the value will not be added to the cache and
8491 the post-cache chain will not be run.
8493 =item B<Chain> I<Name>
8495 Adds a new chain with a certain name. This name can be used to refer to a
8496 specific chain, for example to jump to it.
8498 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8500 =item B<Rule> [I<Name>]
8502 Adds a new rule to the current chain. The name of the rule is optional and
8503 currently has no meaning for the daemon.
8505 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8506 must be at least one B<Target> block.
8508 =item B<Match> I<Name>
8510 Adds a match to a B<Rule> block. The name specifies what kind of match should
8511 be performed. Available matches depend on the plugins that have been loaded.
8513 The arguments inside the B<Match> block are passed to the plugin implementing
8514 the match, so which arguments are valid here depends on the plugin being used.
8515 If you do not need any to pass any arguments to a match, you can use the
8516 shorter syntax:
8518  Match "foobar"
8520 Which is equivalent to:
8522  <Match "foobar">
8523  </Match>
8525 =item B<Target> I<Name>
8527 Add a target to a rule or a default target to a chain. The name specifies what
8528 kind of target is to be added. Which targets are available depends on the
8529 plugins being loaded.
8531 The arguments inside the B<Target> block are passed to the plugin implementing
8532 the target, so which arguments are valid here depends on the plugin being used.
8533 If you do not need any to pass any arguments to a target, you can use the
8534 shorter syntax:
8536  Target "stop"
8538 This is the same as writing:
8540  <Target "stop">
8541  </Target>
8543 =back
8545 =head2 Built-in targets
8547 The following targets are built into the core daemon and therefore need no
8548 plugins to be loaded:
8550 =over 4
8552 =item B<return>
8554 Signals the "return" condition, see the L<"Flow control"> section above. This
8555 causes the current chain to stop processing the value and returns control to
8556 the calling chain. The calling chain will continue processing targets and rules
8557 just after the B<jump> target (see below). This is very similar to the
8558 B<RETURN> target of iptables, see L<iptables(8)>.
8560 This target does not have any options.
8562 Example:
8564  Target "return"
8566 =item B<stop>
8568 Signals the "stop" condition, see the L<"Flow control"> section above. This
8569 causes processing of the value to be aborted immediately. This is similar to
8570 the B<DROP> target of iptables, see L<iptables(8)>.
8572 This target does not have any options.
8574 Example:
8576  Target "stop"
8578 =item B<write>
8580 Sends the value to "write" plugins.
8582 Available options:
8584 =over 4
8586 =item B<Plugin> I<Name>
8588 Name of the write plugin to which the data should be sent. This option may be
8589 given multiple times to send the data to more than one write plugin. If the
8590 plugin supports multiple instances, the plugin's instance(s) must also be
8591 specified.
8593 =back
8595 If no plugin is explicitly specified, the values will be sent to all available
8596 write plugins.
8598 Single-instance plugin example:
8600  <Target "write">
8601    Plugin "rrdtool"
8602  </Target>
8604 Multi-instance plugin example:
8606  <Plugin "write_graphite">
8607    <Node "foo">
8608    ...
8609    </Node>
8610    <Node "bar">
8611    ...
8612    </Node>
8613  </Plugin>
8614   ...
8615  <Target "write">
8616    Plugin "write_graphite/foo"
8617  </Target>
8619 =item B<jump>
8621 Starts processing the rules of another chain, see L<"Flow control"> above. If
8622 the end of that chain is reached, or a stop condition is encountered,
8623 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
8624 next target or the next rule. This is similar to the B<-j> command line option
8625 of iptables, see L<iptables(8)>.
8627 Available options:
8629 =over 4
8631 =item B<Chain> I<Name>
8633 Jumps to the chain I<Name>. This argument is required and may appear only once.
8635 =back
8637 Example:
8639  <Target "jump">
8640    Chain "foobar"
8641  </Target>
8643 =back
8645 =head2 Available matches
8647 =over 4
8649 =item B<regex>
8651 Matches a value using regular expressions.
8653 Available options:
8655 =over 4
8657 =item B<Host> I<Regex>
8659 =item B<Plugin> I<Regex>
8661 =item B<PluginInstance> I<Regex>
8663 =item B<Type> I<Regex>
8665 =item B<TypeInstance> I<Regex>
8667 Match values where the given regular expressions match the various fields of
8668 the identifier of a value. If multiple regular expressions are given, B<all>
8669 regexen must match for a value to match.
8671 =item B<Invert> B<false>|B<true>
8673 When set to B<true>, the result of the match is inverted, i.e. all value lists
8674 where all regular expressions apply are not matched, all other value lists are
8675 matched. Defaults to B<false>.
8677 =back
8679 Example:
8681  <Match "regex">
8682    Host "customer[0-9]+"
8683    Plugin "^foobar$"
8684  </Match>
8686 =item B<timediff>
8688 Matches values that have a time which differs from the time on the server.
8690 This match is mainly intended for servers that receive values over the
8691 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8692 is very sensitive to the timestamp used when updating the RRD files. In
8693 particular, the time must be ever increasing. If a misbehaving client sends one
8694 packet with a timestamp far in the future, all further packets with a correct
8695 time will be ignored because of that one packet. What's worse, such corrupted
8696 RRD files are hard to fix.
8698 This match lets one match all values B<outside> a specified time range
8699 (relative to the server's time), so you can use the B<stop> target (see below)
8700 to ignore the value, for example.
8702 Available options:
8704 =over 4
8706 =item B<Future> I<Seconds>
8708 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8709 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8710 non-zero.
8712 =item B<Past> I<Seconds>
8714 Matches all values that are I<behind> of the server's time by I<Seconds> or
8715 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8716 non-zero.
8718 =back
8720 Example:
8722  <Match "timediff">
8723    Future  300
8724    Past   3600
8725  </Match>
8727 This example matches all values that are five minutes or more ahead of the
8728 server or one hour (or more) lagging behind.
8730 =item B<value>
8732 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8733 values. If a data-set consists of more than one data-source, all data-sources
8734 must match the specified ranges for a positive match.
8736 Available options:
8738 =over 4
8740 =item B<Min> I<Value>
8742 Sets the smallest value which still results in a match. If unset, behaves like
8743 negative infinity.
8745 =item B<Max> I<Value>
8747 Sets the largest value which still results in a match. If unset, behaves like
8748 positive infinity.
8750 =item B<Invert> B<true>|B<false>
8752 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8753 no-match is returned and vice versa. Please note that the B<Invert> setting
8754 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8755 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8757 =item B<DataSource> I<DSName> [I<DSName> ...]
8759 Select one or more of the data sources. If no data source is configured, all
8760 data sources will be checked. If the type handled by the match does not have a
8761 data source of the specified name(s), this will always result in no match
8762 (independent of the B<Invert> setting).
8764 =item B<Satisfy> B<Any>|B<All>
8766 Specifies how checking with several data sources is performed. If set to
8767 B<Any>, the match succeeds if one of the data sources is in the configured
8768 range. If set to B<All> the match only succeeds if all data sources are within
8769 the configured range. Default is B<All>.
8771 Usually B<All> is used for positive matches, B<Any> is used for negative
8772 matches. This means that with B<All> you usually check that all values are in a
8773 "good" range, while with B<Any> you check if any value is within a "bad" range
8774 (or outside the "good" range).
8776 =back
8778 Either B<Min> or B<Max>, but not both, may be unset.
8780 Example:
8782  # Match all values smaller than or equal to 100. Matches only if all data
8783  # sources are below 100.
8784  <Match "value">
8785    Max 100
8786    Satisfy "All"
8787  </Match>
8789  # Match if the value of any data source is outside the range of 0 - 100.
8790  <Match "value">
8791    Min   0
8792    Max 100
8793    Invert true
8794    Satisfy "Any"
8795  </Match>
8797 =item B<empty_counter>
8799 Matches all values with one or more data sources of type B<COUNTER> and where
8800 all counter values are zero. These counters usually I<never> increased since
8801 they started existing (and are therefore uninteresting), or got reset recently
8802 or overflowed and you had really, I<really> bad luck.
8804 Please keep in mind that ignoring such counters can result in confusing
8805 behavior: Counters which hardly ever increase will be zero for long periods of
8806 time. If the counter is reset for some reason (machine or service restarted,
8807 usually), the graph will be empty (NAN) for a long time. People may not
8808 understand why.
8810 =item B<hashed>
8812 Calculates a hash value of the host name and matches values according to that
8813 hash value. This makes it possible to divide all hosts into groups and match
8814 only values that are in a specific group. The intended use is in load
8815 balancing, where you want to handle only part of all data and leave the rest
8816 for other servers.
8818 The hashing function used tries to distribute the hosts evenly. First, it
8819 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8821   hash_value = 0;
8822   for (i = 0; host[i] != 0; i++)
8823     hash_value = (hash_value * 251) + host[i];
8825 The constant 251 is a prime number which is supposed to make this hash value
8826 more random. The code then checks the group for this host according to the
8827 I<Total> and I<Match> arguments:
8829   if ((hash_value % Total) == Match)
8830     matches;
8831   else
8832     does not match;
8834 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8835 groups), then the least significant bit of the hash value will be the XOR of
8836 all least significant bits in the host name. One consequence is that when you
8837 have two hosts, "server0.example.com" and "server1.example.com", where the host
8838 name differs in one digit only and the digits differ by one, those hosts will
8839 never end up in the same group.
8841 Available options:
8843 =over 4
8845 =item B<Match> I<Match> I<Total>
8847 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8848 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8849 be smaller than I<Total>. I<Total> must be at least one, although only values
8850 greater than one really do make any sense.
8852 You can repeat this option to match multiple groups, for example:
8854   Match 3 7
8855   Match 5 7
8857 The above config will divide the data into seven groups and match groups three
8858 and five. One use would be to keep every value on two hosts so that if one
8859 fails the missing data can later be reconstructed from the second host.
8861 =back
8863 Example:
8865  # Operate on the pre-cache chain, so that ignored values are not even in the
8866  # global cache.
8867  <Chain "PreCache">
8868    <Rule>
8869      <Match "hashed">
8870        # Divide all received hosts in seven groups and accept all hosts in
8871        # group three.
8872        Match 3 7
8873      </Match>
8874      # If matched: Return and continue.
8875      Target "return"
8876    </Rule>
8877    # If not matched: Return and stop.
8878    Target "stop"
8879  </Chain>
8881 =back
8883 =head2 Available targets
8885 =over 4
8887 =item B<notification>
8889 Creates and dispatches a notification.
8891 Available options:
8893 =over 4
8895 =item B<Message> I<String>
8897 This required option sets the message of the notification. The following
8898 placeholders will be replaced by an appropriate value:
8900 =over 4
8902 =item B<%{host}>
8904 =item B<%{plugin}>
8906 =item B<%{plugin_instance}>
8908 =item B<%{type}>
8910 =item B<%{type_instance}>
8912 These placeholders are replaced by the identifier field of the same name.
8914 =item B<%{ds:>I<name>B<}>
8916 These placeholders are replaced by a (hopefully) human readable representation
8917 of the current rate of this data source. If you changed the instance name
8918 (using the B<set> or B<replace> targets, see below), it may not be possible to
8919 convert counter values to rates.
8921 =back
8923 Please note that these placeholders are B<case sensitive>!
8925 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8927 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8928 used.
8930 =back
8932 Example:
8934   <Target "notification">
8935     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8936     Severity "WARNING"
8937   </Target>
8939 =item B<replace>
8941 Replaces parts of the identifier using regular expressions.
8943 Available options:
8945 =over 4
8947 =item B<Host> I<Regex> I<Replacement>
8949 =item B<Plugin> I<Regex> I<Replacement>
8951 =item B<PluginInstance> I<Regex> I<Replacement>
8953 =item B<TypeInstance> I<Regex> I<Replacement>
8955 Match the appropriate field with the given regular expression I<Regex>. If the
8956 regular expression matches, that part that matches is replaced with
8957 I<Replacement>. If multiple places of the input buffer match a given regular
8958 expression, only the first occurrence will be replaced.
8960 You can specify each option multiple times to use multiple regular expressions
8961 one after another.
8963 =back
8965 Example:
8967  <Target "replace">
8968    # Replace "example.net" with "example.com"
8969    Host "\\<example.net\\>" "example.com"
8971    # Strip "www." from hostnames
8972    Host "\\<www\\." ""
8973  </Target>
8975 =item B<set>
8977 Sets part of the identifier of a value to a given string.
8979 Available options:
8981 =over 4
8983 =item B<Host> I<String>
8985 =item B<Plugin> I<String>
8987 =item B<PluginInstance> I<String>
8989 =item B<TypeInstance> I<String>
8991 =item B<MetaDataSet> I<String> I<String>
8993 Set the appropriate field to the given string. The strings for plugin instance
8994 and type instance may be empty, the strings for host and plugin may not be
8995 empty. It's currently not possible to set the type of a value this way.
8997 =back
8999 Example:
9001  <Target "set">
9002    PluginInstance "coretemp"
9003    TypeInstance "core3"
9004  </Target>
9006 =back
9008 =head2 Backwards compatibility
9010 If you use collectd with an old configuration, i.E<nbsp>e. one without a
9011 B<Chain> block, it will behave as it used to. This is equivalent to the
9012 following configuration:
9014  <Chain "PostCache">
9015    Target "write"
9016  </Chain>
9018 If you specify a B<PostCacheChain>, the B<write> target will not be added
9019 anywhere and you will have to make sure that it is called where appropriate. We
9020 suggest to add the above snippet as default target to your "PostCache" chain.
9022 =head2 Examples
9024 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
9025 be an FQDN.
9027  <Chain "PreCache">
9028    <Rule "no_fqdn">
9029      <Match "regex">
9030        Host "^[^\.]*$"
9031      </Match>
9032      Target "stop"
9033    </Rule>
9034    Target "write"
9035  </Chain>
9037 =head1 SEE ALSO
9039 L<collectd(1)>,
9040 L<collectd-exec(5)>,
9041 L<collectd-perl(5)>,
9042 L<collectd-unixsock(5)>,
9043 L<types.db(5)>,
9044 L<hddtemp(8)>,
9045 L<iptables(8)>,
9046 L<kstat(3KSTAT)>,
9047 L<mbmon(1)>,
9048 L<psql(1)>,
9049 L<regex(7)>,
9050 L<rrdtool(1)>,
9051 L<sensors(1)>
9053 =head1 AUTHOR
9055 Florian Forster E<lt>octo@collectd.orgE<gt>
9057 =cut