write_kafka: correct mistyped function name
[collectd.git] / src / collectd.conf.pod
1 =encoding UTF-8
2
3 =head1 NAME
4
5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
6
7 =head1 SYNOPSIS
8
9   BaseDir "/var/lib/collectd"
10   PIDFile "/run/collectd.pid"
11   Interval 10.0
12
13   LoadPlugin cpu
14   LoadPlugin load
15
16   <LoadPlugin df>
17     Interval 3600
18   </LoadPlugin>
19   <Plugin df>
20     ValuesPercentage true
21   </Plugin>
22
23   LoadPlugin ping
24   <Plugin ping>
25     Host "example.org"
26     Host "provider.net"
27   </Plugin>
28
29 =head1 DESCRIPTION
30
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.
37
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<#>) is 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>.
53
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.
59
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.
66
67 =head1 GLOBAL OPTIONS
68
69 =over 4
70
71 =item B<BaseDir> I<Directory>
72
73 Sets the base directory. This is the directory beneath all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
76
77 =item B<LoadPlugin> I<Plugin>
78
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.
82
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> then 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.
90
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:
94
95  LoadPlugin "cpu"
96
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
99
100  <LoadPlugin perl>
101    Interval 60
102  </LoadPlugin>
103
104 The following options are valid inside B<LoadPlugin> blocks:
105
106 =over 4
107
108 =item B<Globals> B<true|false>
109
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.
114
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.
122
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.
126
127 =item B<Interval> I<Seconds>
128
129 Sets a plugin-specific interval for collecting metrics. This overrides the
130 global B<Interval> setting. If a plugin provides own support for specifying an
131 interval, that setting will take precedence.
132
133 =back
134
135 =item B<AutoLoadPlugin> B<false>|B<true>
136
137 When set to B<false> (the default), each plugin needs to be loaded explicitly,
138 using the B<LoadPlugin> statement documented above. If a
139 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
140 handling callback for this plugin has been registered, a warning is logged and
141 the block is ignored.
142
143 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
144 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
145 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
146 plugins that don't provide any configuration, e.g. the I<Load plugin>.
147
148 =item B<CollectInternalStats> B<false>|B<true>
149
150 When set to B<true>, various statistics about the I<collectd> daemon will be
151 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
152
153 The "write_queue" I<plugin instance> reports the number of elements currently
154 queued and the number of elements dropped off the queue by the
155 B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> mechanism.
156
157 The "cache" I<plugin instance> reports the number of elements in the value list
158 cache (the cache you can interact with using L<collectd-unixsock(5)>).
159
160 =item B<Include> I<Path> [I<pattern>]
161
162 If I<Path> points to a file, includes that file. If I<Path> points to a
163 directory, recursively includes all files within that directory and its
164 subdirectories. If the C<wordexp> function is available on your system,
165 shell-like wildcards are expanded before files are included. This means you can
166 use statements like the following:
167
168   Include "/etc/collectd.d/*.conf"
169
170 Starting with version 5.3, this may also be a block in which further options
171 affecting the behavior of B<Include> may be specified. The following option is
172 currently allowed:
173
174   <Include "/etc/collectd.d">
175     Filter "*.conf"
176   </Include>
177
178 =over 4
179
180 =item B<Filter> I<pattern>
181
182 If the C<fnmatch> function is available on your system, a shell-like wildcard
183 I<pattern> may be specified to filter which files to include. This may be used
184 in combination with recursively including a directory to easily be able to
185 arbitrarily mix configuration files and other documents (e.g. README files).
186 The given example is similar to the first example above but includes all files
187 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
188
189   Include "/etc/collectd.d" "*.conf"
190
191 =back
192
193 If more than one files are included by a single B<Include> option, the files
194 will be included in lexicographical order (as defined by the C<strcmp>
195 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
196 order in which the files are loaded.
197
198 To prevent loops and shooting yourself in the foot in interesting ways the
199 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
200 most uses. Since symlinks are followed it is still possible to crash the daemon
201 by looping symlinks. In our opinion significant stupidity should result in an
202 appropriate amount of pain.
203
204 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
205 file, but you cannot include files from within blocks.
206
207 =item B<PIDFile> I<File>
208
209 Sets where to write the PID file to. This file is overwritten when it exists
210 and deleted when the program is stopped. Some init-scripts might override this
211 setting using the B<-P> command-line option.
212
213 =item B<PluginDir> I<Directory>
214
215 Path to the plugins (shared objects) of collectd.
216
217 =item B<TypesDB> I<File> [I<File> ...]
218
219 Set one or more files that contain the data-set descriptions. See
220 L<types.db(5)> for a description of the format of this file.
221
222 =item B<Interval> I<Seconds>
223
224 Configures the interval in which to query the read plugins. Obviously smaller
225 values lead to a higher system load produced by collectd, while higher values
226 lead to more coarse statistics.
227
228 B<Warning:> You should set this once and then never touch it again. If you do,
229 I<you will have to delete all your RRD files> or know some serious RRDtool
230 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
231
232 =item B<MaxReadInterval> I<Seconds>
233
234 Read plugin doubles interval between queries after each failed attempt
235 to get data.
236
237 This options limits the maximum value of the interval. The default value is
238 B<86400>.
239
240 =item B<Timeout> I<Iterations>
241
242 Consider a value list "missing" when no update has been read or received for
243 I<Iterations> iterations. By default, I<collectd> considers a value list
244 missing when no update has been received for twice the update interval. Since
245 this setting uses iterations, the maximum allowed time without update depends
246 on the I<Interval> information contained in each value list. This is used in
247 the I<Threshold> configuration to dispatch notifications about missing values,
248 see L<collectd-threshold(5)> for details.
249
250 =item B<ReadThreads> I<Num>
251
252 Number of threads to start for reading plugins. The default value is B<5>, but
253 you may want to increase this if you have more than five plugins that take a
254 long time to read. Mostly those are plugins that do network-IO. Setting this to
255 a value higher than the number of registered read callbacks is not recommended.
256
257 =item B<WriteThreads> I<Num>
258
259 Number of threads to start for dispatching value lists to write plugins. The
260 default value is B<5>, but you may want to increase this if you have more than
261 five plugins that may take relatively long to write to.
262
263 =item B<WriteQueueLimitHigh> I<HighNum>
264
265 =item B<WriteQueueLimitLow> I<LowNum>
266
267 Metrics are read by the I<read threads> and then put into a queue to be handled
268 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
269 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
270 running into memory issues in such a case, you can limit the size of this
271 queue.
272
273 By default, there is no limit and memory may grow indefinitely. This is most
274 likely not an issue for clients, i.e. instances that only handle the local
275 metrics. For servers it is recommended to set this to a non-zero value, though.
276
277 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
278 Each of them takes a numerical argument which is the number of metrics in the
279 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
280 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
281 I<will> be enqueued. If the number of metrics currently in the queue is between
282 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
283 proportional to the number of metrics in the queue (i.e. it increases linearly
284 until it reaches 100%.)
285
286 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
287 unset, the latter will default to half of B<WriteQueueLimitHigh>.
288
289 If you do not want to randomly drop values when the queue size is between
290 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
291 to the same value.
292
293 Enabling the B<CollectInternalStats> option is of great help to figure out the
294 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
295
296 =item B<Hostname> I<Name>
297
298 Sets the hostname that identifies a host. If you omit this setting, the
299 hostname will be determined using the L<gethostname(2)> system call.
300
301 =item B<FQDNLookup> B<true|false>
302
303 If B<Hostname> is determined automatically this setting controls whether or not
304 the daemon should try to figure out the "fully qualified domain name", FQDN.
305 This is done using a lookup of the name returned by C<gethostname>. This option
306 is enabled by default.
307
308 =item B<PreCacheChain> I<ChainName>
309
310 =item B<PostCacheChain> I<ChainName>
311
312 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
313 see L<FILTER CONFIGURATION> below on information on chains and how these
314 setting change the daemon's behavior.
315
316 =back
317
318 =head1 PLUGIN OPTIONS
319
320 Some plugins may register own options. These options must be enclosed in a
321 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
322 require external configuration, too. The C<apache plugin>, for example,
323 required C<mod_status> to be configured in the webserver you're going to
324 collect data from. These plugins are listed below as well, even if they don't
325 require any configuration within collectd's configuration file.
326
327 A list of all plugins and a short summary for each plugin can be found in the
328 F<README> file shipped with the sourcecode and hopefully binary packets as
329 well.
330
331 =head2 Plugin C<aggregation>
332
333 The I<Aggregation plugin> makes it possible to aggregate several values into
334 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
335 This can be put to a wide variety of uses, e.g. average and total CPU
336 statistics for your entire fleet.
337
338 The grouping is powerful but, as with many powerful tools, may be a bit
339 difficult to wrap your head around. The grouping will therefore be
340 demonstrated using an example: The average and sum of the CPU usage across
341 all CPUs of each host is to be calculated.
342
343 To select all the affected values for our example, set C<Plugin cpu> and
344 C<Type cpu>. The other values are left unspecified, meaning "all values". The
345 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
346 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
347 statement.
348
349   Plugin "cpu"
350   Type "cpu"
351
352 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...)  and
353 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
354 example, the intention is to have a new value for each host / type instance
355 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
356 It can be specified multiple times to group by more than one field.
357
358   GroupBy "Host"
359   GroupBy "TypeInstance"
360
361 We do neither specify nor group by I<plugin instance> (the CPU number), so all
362 metrics that differ in the CPU number only will be aggregated. Each
363 aggregation needs I<at least one> such field, otherwise no aggregation would
364 take place.
365
366 The full example configuration looks like this:
367
368  <Plugin "aggregation">
369    <Aggregation>
370      Plugin "cpu"
371      Type "cpu"
372
373      GroupBy "Host"
374      GroupBy "TypeInstance"
375
376      CalculateSum true
377      CalculateAverage true
378    </Aggregation>
379  </Plugin>
380
381 There are a couple of limitations you should be aware of:
382
383 =over 4
384
385 =item
386
387 The I<Type> cannot be left unspecified, because it is not reasonable to add
388 apples to oranges. Also, the internal lookup structure won't work if you try
389 to group by type.
390
391 =item
392
393 There must be at least one unspecified, ungrouped field. Otherwise nothing
394 will be aggregated.
395
396 =back
397
398 As you can see in the example above, each aggregation has its own
399 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
400 blocks may match the same values, i.e. one value list can update multiple
401 aggregations. The following options are valid inside B<Aggregation> blocks:
402
403 =over 4
404
405 =item B<Host> I<Host>
406
407 =item B<Plugin> I<Plugin>
408
409 =item B<PluginInstance> I<PluginInstance>
410
411 =item B<Type> I<Type>
412
413 =item B<TypeInstance> I<TypeInstance>
414
415 Selects the value lists to be added to this aggregation. B<Type> must be a
416 valid data set name, see L<types.db(5)> for details.
417
418 If the string starts with and ends with a slash (C</>), the string is
419 interpreted as a I<regular expression>. The regex flavor used are POSIX
420 extended regular expressions as described in L<regex(7)>. Example usage:
421
422  Host "/^db[0-9]\\.example\\.com$/"
423
424 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
425
426 Group valued by the specified field. The B<GroupBy> option may be repeated to
427 group by multiple fields.
428
429 =item B<SetHost> I<Host>
430
431 =item B<SetPlugin> I<Plugin>
432
433 =item B<SetPluginInstance> I<PluginInstance>
434
435 =item B<SetTypeInstance> I<TypeInstance>
436
437 Sets the appropriate part of the identifier to the provided string.
438
439 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
440 will be replaced with the aggregation function, e.g. "average". Not including
441 the placeholder will result in duplication warnings and/or messed up values if
442 more than one aggregation function are enabled.
443
444 The following example calculates the average usage of all "even" CPUs:
445
446  <Plugin "aggregation">
447    <Aggregation>
448      Plugin "cpu"
449      PluginInstance "/[0,2,4,6,8]$/"
450      Type "cpu"
451
452      SetPlugin "cpu"
453      SetPluginInstance "even-%{aggregation}"
454
455      GroupBy "Host"
456      GroupBy "TypeInstance"
457
458      CalculateAverage true
459    </Aggregation>
460  </Plugin>
461
462 This will create the files:
463
464 =over 4
465
466 =item
467
468 foo.example.com/cpu-even-average/cpu-idle
469
470 =item
471
472 foo.example.com/cpu-even-average/cpu-system
473
474 =item
475
476 foo.example.com/cpu-even-average/cpu-user
477
478 =item
479
480 ...
481
482 =back
483
484 =item B<CalculateNum> B<true>|B<false>
485
486 =item B<CalculateSum> B<true>|B<false>
487
488 =item B<CalculateAverage> B<true>|B<false>
489
490 =item B<CalculateMinimum> B<true>|B<false>
491
492 =item B<CalculateMaximum> B<true>|B<false>
493
494 =item B<CalculateStddev> B<true>|B<false>
495
496 Boolean options for enabling calculation of the number of value lists, their
497 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
498 are disabled by default.
499
500 =back
501
502 =head2 Plugin C<amqp>
503
504 The I<AMQMP plugin> can be used to communicate with other instances of
505 I<collectd> or third party applications using an AMQP message broker. Values
506 are sent to or received from the broker, which handles routing, queueing and
507 possibly filtering or messages.
508
509  <Plugin "amqp">
510    # Send values to an AMQP broker
511    <Publish "some_name">
512      Host "localhost"
513      Port "5672"
514      VHost "/"
515      User "guest"
516      Password "guest"
517      Exchange "amq.fanout"
518  #   ExchangeType "fanout"
519  #   RoutingKey "collectd"
520  #   Persistent false
521  #   ConnectionRetryDelay 0
522  #   Format "command"
523  #   StoreRates false
524  #   GraphitePrefix "collectd."
525  #   GraphiteEscapeChar "_"
526  #   GraphiteSeparateInstances false
527  #   GraphiteAlwaysAppendDS false
528    </Publish>
529
530    # Receive values from an AMQP broker
531    <Subscribe "some_name">
532      Host "localhost"
533      Port "5672"
534      VHost "/"
535      User "guest"
536      Password "guest"
537      Exchange "amq.fanout"
538  #   ExchangeType "fanout"
539  #   Queue "queue_name"
540  #   QueueDurable false
541  #   QueueAutoDelete true
542  #   RoutingKey "collectd.#"
543  #   ConnectionRetryDelay 0
544    </Subscribe>
545  </Plugin>
546
547 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
548 blocks, which configure sending and receiving of values respectively. The two
549 blocks are very similar, so unless otherwise noted, an option can be used in
550 either block. The name given in the blocks starting tag is only used for
551 reporting messages, but may be used to support I<flushing> of certain
552 I<Publish> blocks in the future.
553
554 =over 4
555
556 =item B<Host> I<Host>
557
558 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
559 the underlying communications library, I<rabbitmq-c>, which is "localhost".
560
561 =item B<Port> I<Port>
562
563 Service name or port number on which the AMQP broker accepts connections. This
564 argument must be a string, even if the numeric form is used. Defaults to
565 "5672".
566
567 =item B<VHost> I<VHost>
568
569 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
570
571 =item B<User> I<User>
572
573 =item B<Password> I<Password>
574
575 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
576 is used.
577
578 =item B<Exchange> I<Exchange>
579
580 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
581 By default, "amq.fanout" will be used.
582
583 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
584 the given exchange and the I<queue> is created, using the I<routing key> if
585 configured. See the B<Queue> and B<RoutingKey> options below.
586
587 =item B<ExchangeType> I<Type>
588
589 If given, the plugin will try to create the configured I<exchange> with this
590 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
591 be bound to this exchange.
592
593 =item B<Queue> I<Queue> (Subscribe only)
594
595 Configures the I<queue> name to subscribe to. If no queue name was configured
596 explicitly, a unique queue name will be created by the broker.
597
598 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
599
600 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
601 or transient (will disappear if the AMQP broker is restarted). Defaults to
602 "false".
603
604 This option should be used in conjunction with the I<Persistent> option on the
605 publish side.
606
607 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
608
609 Defines if the I<queue> subscribed to will be deleted once the last consumer
610 unsubscribes. Defaults to "true".
611
612 =item B<RoutingKey> I<Key>
613
614 In I<Publish> blocks, this configures the routing key to set on all outgoing
615 messages. If not given, the routing key will be computed from the I<identifier>
616 of the value. The host, plugin, type and the two instances are concatenated
617 together using dots as the separator and all containing dots replaced with
618 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
619 possible to receive only specific values using a "topic" exchange.
620
621 In I<Subscribe> blocks, configures the I<routing key> used when creating a
622 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
623 used to filter messages when using a "topic" exchange. If you're only
624 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
625 for example.
626
627 =item B<Persistent> B<true>|B<false> (Publish only)
628
629 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
630 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
631 default), the I<transient> delivery mode will be used, i.e. messages may be
632 lost due to high load, overflowing queues or similar issues.
633
634 =item B<ConnectionRetryDelay> I<Delay>
635
636 When the connection to the AMQP broker is lost, defines the time in seconds to
637 wait before attempting to reconnect. Defaults to 0, which implies collectd will
638 attempt to reconnect at each read interval (in Subscribe mode) or each time
639 values are ready for submission (in Publish mode).
640
641 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
642
643 Selects the format in which messages are sent to the broker. If set to
644 B<Command> (the default), values are sent as C<PUTVAL> commands which are
645 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
646 case, the C<Content-Type> header field will be set to C<text/collectd>.
647
648 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
649 an easy and straight forward exchange format. The C<Content-Type> header field
650 will be set to C<application/json>.
651
652 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
653 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
654 C<text/graphite>.
655
656 A subscribing client I<should> use the C<Content-Type> header field to
657 determine how to decode the values. Currently, the I<AMQP plugin> itself can
658 only decode the B<Command> format.
659
660 =item B<StoreRates> B<true>|B<false> (Publish only)
661
662 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
663 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
664 default), no conversion is performed. Otherwise the conversion is performed
665 using the internal value cache.
666
667 Please note that currently this option is only used if the B<Format> option has
668 been set to B<JSON>.
669
670 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
671
672 A prefix can be added in the metric name when outputting in the I<Graphite> format.
673 It's added before the I<Host> name.
674 Metric name will be "<prefix><host><postfix><plugin><type><name>"
675
676 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
677
678 A postfix can be added in the metric name when outputting in the I<Graphite> format.
679 It's added after the I<Host> name.
680 Metric name will be "<prefix><host><postfix><plugin><type><name>"
681
682 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
683
684 Specify a character to replace dots (.) in the host part of the metric name.
685 In I<Graphite> metric name, dots are used as separators between different
686 metric parts (host, plugin, type).
687 Default is "_" (I<Underscore>).
688
689 =item B<GraphiteSeparateInstances> B<true>|B<false>
690
691 If set to B<true>, the plugin instance and type instance will be in their own
692 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
693 default), the plugin and plugin instance (and likewise the type and type
694 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
695
696 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
697
698 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
699 identifier. If set to B<false> (the default), this is only done when there is
700 more than one DS.
701
702 =back
703
704 =head2 Plugin C<apache>
705
706 To configure the C<apache>-plugin you first need to configure the Apache
707 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
708 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
709 the following snipped to base your Apache config upon:
710
711   ExtendedStatus on
712   <IfModule mod_status.c>
713     <Location /mod_status>
714       SetHandler server-status
715     </Location>
716   </IfModule>
717
718 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
719 also supported. It introduces a new field, called C<BusyServers>, to count the
720 number of currently connected clients. This field is also supported.
721
722 The configuration of the I<Apache> plugin consists of one or more
723 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
724 as the instance name. For example:
725
726  <Plugin "apache">
727    <Instance "www1">
728      URL "http://www1.example.com/mod_status?auto"
729    </Instance>
730    <Instance "www2">
731      URL "http://www2.example.com/mod_status?auto"
732    </Instance>
733  </Plugin>
734
735 The instance name will be used as the I<plugin instance>. To emulate the old
736 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
737 plugin to work correctly, each instance name must be unique. This is not
738 enforced by the plugin and it is your responsibility to ensure it.
739
740 The following options are accepted within each I<Instance> block:
741
742 =over 4
743
744 =item B<URL> I<http://host/mod_status?auto>
745
746 Sets the URL of the C<mod_status> output. This needs to be the output generated
747 by C<ExtendedStatus on> and it needs to be the machine readable output
748 generated by appending the C<?auto> argument. This option is I<mandatory>.
749
750 =item B<User> I<Username>
751
752 Optional user name needed for authentication.
753
754 =item B<Password> I<Password>
755
756 Optional password needed for authentication.
757
758 =item B<VerifyPeer> B<true|false>
759
760 Enable or disable peer SSL certificate verification. See
761 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
762
763 =item B<VerifyHost> B<true|false>
764
765 Enable or disable peer host name verification. If enabled, the plugin checks
766 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
767 certificate matches the host name provided by the B<URL> option. If this
768 identity check fails, the connection is aborted. Obviously, only works when
769 connecting to a SSL enabled server. Enabled by default.
770
771 =item B<CACert> I<File>
772
773 File that holds one or more SSL certificates. If you want to use HTTPS you will
774 possibly need this option. What CA certificates come bundled with C<libcurl>
775 and are checked by default depends on the distribution you use.
776
777 =item B<SSLCiphers> I<list of ciphers>
778
779 Specifies which ciphers to use in the connection. The list of ciphers
780 must specify valid ciphers. See
781 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
782
783 =item B<Timeout> I<Milliseconds>
784
785 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
786 milliseconds. By default, the configured B<Interval> is used to set the
787 timeout.
788
789 =back
790
791 =head2 Plugin C<apcups>
792
793 =over 4
794
795 =item B<Host> I<Hostname>
796
797 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
798 that IPv6 support has been disabled unless someone can confirm or decline that
799 B<apcupsd> can handle it.
800
801 =item B<Port> I<Port>
802
803 TCP-Port to connect to. Defaults to B<3551>.
804
805 =item B<ReportSeconds> B<true|false>
806
807 If set to B<true>, the time reported in the C<timeleft> metric will be
808 converted to seconds. This is the recommended setting. If set to B<false>, the
809 default for backwards compatibility, the time will be reported in minutes.
810
811 =back
812
813 =head2 Plugin C<aquaero>
814
815 This plugin collects the value of the available sensors in an
816 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
817 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
818 connection for monitoring and configuration. The board can handle multiple
819 temperature sensors, fans, water pumps and water level sensors and adjust the
820 output settings such as fan voltage or power used by the water pump based on
821 the available inputs using a configurable controller included in the board.
822 This plugin collects all the available inputs as well as some of the output
823 values chosen by this controller. The plugin is based on the I<libaquaero5>
824 library provided by I<aquatools-ng>.
825
826 =over 4
827
828 =item B<Device> I<DevicePath>
829
830 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
831 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
832 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
833
834 =back
835
836 =head2 Plugin C<ascent>
837
838 This plugin collects information about an Ascent server, a free server for the
839 "World of Warcraft" game. This plugin gathers the information by fetching the
840 XML status page using C<libcurl> and parses it using C<libxml2>.
841
842 The configuration options are the same as for the C<apache> plugin above:
843
844 =over 4
845
846 =item B<URL> I<http://localhost/ascent/status/>
847
848 Sets the URL of the XML status output.
849
850 =item B<User> I<Username>
851
852 Optional user name needed for authentication.
853
854 =item B<Password> I<Password>
855
856 Optional password needed for authentication.
857
858 =item B<VerifyPeer> B<true|false>
859
860 Enable or disable peer SSL certificate verification. See
861 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
862
863 =item B<VerifyHost> B<true|false>
864
865 Enable or disable peer host name verification. If enabled, the plugin checks
866 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
867 certificate matches the host name provided by the B<URL> option. If this
868 identity check fails, the connection is aborted. Obviously, only works when
869 connecting to a SSL enabled server. Enabled by default.
870
871 =item B<CACert> I<File>
872
873 File that holds one or more SSL certificates. If you want to use HTTPS you will
874 possibly need this option. What CA certificates come bundled with C<libcurl>
875 and are checked by default depends on the distribution you use.
876
877 =item B<Timeout> I<Milliseconds>
878
879 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
880 milliseconds. By default, the configured B<Interval> is used to set the
881 timeout.
882
883 =back
884
885 =head2 Plugin C<barometer>
886
887 This plugin reads absolute air pressure using digital barometer sensor on a I2C
888 bus. Supported sensors are:
889
890 =over 5
891
892 =item I<MPL115A2> from Freescale,
893 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
894
895
896 =item I<MPL3115> from Freescale
897 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
898
899
900 =item I<BMP085> from Bosch Sensortec
901
902 =back
903
904 The sensor type - one of the above - is detected automatically by the plugin
905 and indicated in the plugin_instance (you will see subdirectory
906 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
907 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
908 (only one sensor can be used by the plugin).
909
910 The plugin provides absolute barometric pressure, air pressure reduced to sea
911 level (several possible approximations) and as an auxiliary value also internal
912 sensor temperature. It uses (expects/provides) typical metric units - pressure
913 in [hPa], temperature in [C], altitude in [m].
914
915 It was developed and tested under Linux only. The only platform dependency is
916 the standard Linux i2c-dev interface (the particular bus driver has to
917 support the SM Bus command subset).
918
919 The reduction or normalization to mean sea level pressure requires (depending
920 on selected method/approximation) also altitude and reference to temperature
921 sensor(s).  When multiple temperature sensors are configured the minumum of
922 their values is always used (expecting that the warmer ones are affected by
923 e.g. direct sun light at that moment).
924
925 Synopsis:
926
927   <Plugin "barometer">
928      Device            "/dev/i2c-0";
929      Oversampling      512
930      PressureOffset    0.0
931      TemperatureOffset 0.0
932      Normalization     2
933      Altitude          238.0
934      TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
935   </Plugin>
936
937 =over 4
938
939 =item B<Device> I<device>
940
941 The only mandatory configuration parameter.
942
943 Device name of the I2C bus to which the sensor is connected. Note that
944 typically you need to have loaded the i2c-dev module.
945 Using i2c-tools you can check/list i2c buses available on your system by:
946
947   i2cdetect -l
948
949 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
950
951   i2cdetect -y -a 0
952
953 This way you should be able to verify that the pressure sensor (either type) is
954 connected and detected on address 0x60.
955
956 =item B<Oversampling> I<value>
957
958 Optional parameter controlling the oversampling/accuracy. Default value
959 is 1 providing fastest and least accurate reading.
960
961 For I<MPL115> this is the size of the averaging window. To filter out sensor
962 noise a simple averaging using floating window of this configurable size is
963 used. The plugin will use average of the last C<value> measurements (value of 1
964 means no averaging).  Minimal size is 1, maximal 1024.
965
966 For I<MPL3115> this is the oversampling value. The actual oversampling is
967 performed by the sensor and the higher value the higher accuracy and longer
968 conversion time (although nothing to worry about in the collectd context).
969 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
970 adjusted by the plugin to the closest supported one.
971
972 For I<BMP085> this is the oversampling value. The actual oversampling is
973 performed by the sensor and the higher value the higher accuracy and longer
974 conversion time (although nothing to worry about in the collectd context).
975 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
976 the closest supported one.
977
978 =item B<PressureOffset> I<offset>
979
980 Optional parameter for MPL3115 only.
981
982 You can further calibrate the sensor by supplying pressure and/or temperature
983 offsets.  This is added to the measured/caclulated value (i.e. if the measured
984 value is too high then use negative offset).
985 In hPa, default is 0.0.
986
987 =item B<TemperatureOffset> I<offset>
988
989 Optional parameter for MPL3115 only.
990
991 You can further calibrate the sensor by supplying pressure and/or temperature
992 offsets.  This is added to the measured/caclulated value (i.e. if the measured
993 value is too high then use negative offset).
994 In C, default is 0.0.
995
996 =item B<Normalization> I<method>
997
998 Optional parameter, default value is 0.
999
1000 Normalization method - what approximation/model is used to compute the mean sea
1001 level pressure from the air absolute pressure.
1002
1003 Supported values of the C<method> (integer between from 0 to 2) are:
1004
1005 =over 5
1006
1007 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1008        do not need to configure C<Altitude> or C<TemperatureSensor>.
1009
1010 =item B<1> - international formula for conversion ,
1011 See
1012 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1013 For this method you have to configure C<Altitude> but do not need
1014 C<TemperatureSensor> (uses fixed global temperature average instead).
1015
1016 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1017 Meteorological Service).
1018 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1019 For this method you have to configure both  C<Altitude> and
1020 C<TemperatureSensor>.
1021
1022 =back
1023
1024
1025 =item B<Altitude> I<altitude>
1026
1027 The altitude (in meters) of the location where you meassure the pressure.
1028
1029 =item B<TemperatureSensor> I<reference>
1030
1031 Temperature sensor(s) which should be used as a reference when normalizing the
1032 pressure using C<Normalization> method 2.
1033 When specified more sensors a minumum is found and used each time.  The
1034 temperature reading directly from this pressure sensor/plugin is typically not
1035 suitable as the pressure sensor will be probably inside while we want outside
1036 temperature.  The collectd reference name is something like
1037 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1038 (<type_instance> is usually omitted when there is just single value type). Or
1039 you can figure it out from the path of the output data files.
1040
1041 =back
1042
1043 =head2 Plugin C<battery>
1044
1045 The I<battery plugin> reports the remaining capacity, power and voltage of
1046 laptop batteries.
1047
1048 =over 4
1049
1050 =item B<ValuesPercentage> B<false>|B<true>
1051
1052 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1053 capacity remaining". Otherwise the capacity is stored as reported by the
1054 battery, most likely in "Wh". This option does not work with all input methods,
1055 in particular when only C</proc/pmu> is available on an old Linux system.
1056 Defaults to B<false>.
1057
1058 =item B<ReportDegraded> B<false>|B<true>
1059
1060 Typical laptop batteries degrade over time, meaning the capacity decreases with
1061 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1062 "last full capacity" and used to determine that a battery is "fully charged".
1063
1064 When this option is set to B<false>, the default, the I<battery plugin> will
1065 only report the remaining capacity. If the B<ValuesPercentage> option is
1066 enabled, the relative remaining capacity is calculated as the ratio of the
1067 "remaining capacity" and the "last full capacity". This is what most tools,
1068 such as the status bar of desktop environments, also do.
1069
1070 When set to B<true>, the battery plugin will report three values: B<charged>
1071 (remaining capacity), B<discharged> (difference between "last full capacity"
1072 and "remaining capacity") and B<degraded> (difference between "design capacity"
1073 and "last full capacity").
1074
1075 =back
1076
1077 =head2 Plugin C<bind>
1078
1079 Starting with BIND 9.5.0, the most widely used DNS server software provides
1080 extensive statistics about queries, responses and lots of other information.
1081 The bind plugin retrieves this information that's encoded in XML and provided
1082 via HTTP and submits the values to collectd.
1083
1084 To use this plugin, you first need to tell BIND to make this information
1085 available. This is done with the C<statistics-channels> configuration option:
1086
1087  statistics-channels {
1088    inet localhost port 8053;
1089  };
1090
1091 The configuration follows the grouping that can be seen when looking at the
1092 data with an XSLT compatible viewer, such as a modern web browser. It's
1093 probably a good idea to make yourself familiar with the provided values, so you
1094 can understand what the collected statistics actually mean.
1095
1096 Synopsis:
1097
1098  <Plugin "bind">
1099    URL "http://localhost:8053/"
1100    ParseTime       false
1101    OpCodes         true
1102    QTypes          true
1103
1104    ServerStats     true
1105    ZoneMaintStats  true
1106    ResolverStats   false
1107    MemoryStats     true
1108
1109    <View "_default">
1110      QTypes        true
1111      ResolverStats true
1112      CacheRRSets   true
1113
1114      Zone "127.in-addr.arpa/IN"
1115    </View>
1116  </Plugin>
1117
1118 The bind plugin accepts the following configuration options:
1119
1120 =over 4
1121
1122 =item B<URL> I<URL>
1123
1124 URL from which to retrieve the XML data. If not specified,
1125 C<http://localhost:8053/> will be used.
1126
1127 =item B<ParseTime> B<true>|B<false>
1128
1129 When set to B<true>, the time provided by BIND will be parsed and used to
1130 dispatch the values. When set to B<false>, the local time source is queried.
1131
1132 This setting is set to B<true> by default for backwards compatibility; setting
1133 this to B<false> is I<recommended> to avoid problems with timezones and
1134 localization.
1135
1136 =item B<OpCodes> B<true>|B<false>
1137
1138 When enabled, statistics about the I<"OpCodes">, for example the number of
1139 C<QUERY> packets, are collected.
1140
1141 Default: Enabled.
1142
1143 =item B<QTypes> B<true>|B<false>
1144
1145 When enabled, the number of I<incoming> queries by query types (for example
1146 C<A>, C<MX>, C<AAAA>) is collected.
1147
1148 Default: Enabled.
1149
1150 =item B<ServerStats> B<true>|B<false>
1151
1152 Collect global server statistics, such as requests received over IPv4 and IPv6,
1153 successful queries, and failed updates.
1154
1155 Default: Enabled.
1156
1157 =item B<ZoneMaintStats> B<true>|B<false>
1158
1159 Collect zone maintenance statistics, mostly information about notifications
1160 (zone updates) and zone transfers.
1161
1162 Default: Enabled.
1163
1164 =item B<ResolverStats> B<true>|B<false>
1165
1166 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1167 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1168 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1169 default. Use the B<ResolverStats> option within a B<View "_default"> block
1170 instead for the same functionality.
1171
1172 Default: Disabled.
1173
1174 =item B<MemoryStats>
1175
1176 Collect global memory statistics.
1177
1178 Default: Enabled.
1179
1180 =item B<Timeout> I<Milliseconds>
1181
1182 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1183 milliseconds. By default, the configured B<Interval> is used to set the
1184 timeout.
1185
1186 =item B<View> I<Name>
1187
1188 Collect statistics about a specific I<"view">. BIND can behave different,
1189 mostly depending on the source IP-address of the request. These different
1190 configurations are called "views". If you don't use this feature, you most
1191 likely are only interested in the C<_default> view.
1192
1193 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1194 information you want to collect about a view. If no B<View> block is
1195 configured, no detailed view statistics will be collected.
1196
1197 =over 4
1198
1199 =item B<QTypes> B<true>|B<false>
1200
1201 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1202 C<MX>) is collected.
1203
1204 Default: Enabled.
1205
1206 =item B<ResolverStats> B<true>|B<false>
1207
1208 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1209 (e.E<nbsp>g. queries over IPv4, lame servers).
1210
1211 Default: Enabled.
1212
1213 =item B<CacheRRSets> B<true>|B<false>
1214
1215 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1216 type is collected. Negative entries (queries which resulted in an error, for
1217 example names that do not exist) are reported with a leading exclamation mark,
1218 e.E<nbsp>g. "!A".
1219
1220 Default: Enabled.
1221
1222 =item B<Zone> I<Name>
1223
1224 When given, collect detailed information about the given zone in the view. The
1225 information collected if very similar to the global B<ServerStats> information
1226 (see above).
1227
1228 You can repeat this option to collect detailed information about multiple
1229 zones.
1230
1231 By default no detailed zone information is collected.
1232
1233 =back
1234
1235 =back
1236
1237 =head2 Plugin C<ceph>
1238
1239 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1240 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1241
1242 A separate B<Daemon> block must be configured for each ceph daemon to be
1243 monitored. The following example will read daemon statistics from four
1244 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1245
1246   <Plugin ceph>
1247     LongRunAvgLatency false
1248     ConvertSpecialMetricTypes true
1249     <Daemon "osd.0">
1250       SocketPath "/var/run/ceph/ceph-osd.0.asok"
1251     </Daemon>
1252     <Daemon "osd.1">
1253       SocketPath "/var/run/ceph/ceph-osd.1.asok"
1254     </Daemon>
1255     <Daemon "mon.a">
1256       SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1257     </Daemon>
1258     <Daemon "mds.a">
1259       SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1260     </Daemon>
1261   </Plugin>
1262
1263 The ceph plugin accepts the following configuration options:
1264
1265 =over 4
1266
1267 =item B<LongRunAvgLatency> B<true>|B<false>
1268
1269 If enabled, latency values(sum,count pairs) are calculated as the long run
1270 average - average since the ceph daemon was started = (sum / count).
1271 When disabled, latency values are calculated as the average since the last
1272 collection = (sum_now - sum_last) / (count_now - count_last).
1273
1274 Default: Disabled
1275
1276 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1277
1278 If enabled, special metrics (metrics that differ in type from similar counters)
1279 are converted to the type of those similar counters. This currently only
1280 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1281 ceph schema reports this metric type as a sum,count pair while similar counters
1282 are treated as derive types. When converted, the sum is used as the counter
1283 value and is treated as a derive type.
1284 When disabled, all metrics are treated as the types received from the ceph schema.
1285
1286 Default: Enabled
1287
1288 =back
1289
1290 Each B<Daemon> block must have a string argument for the plugin instance name.
1291 A B<SocketPath> is also required for each B<Daemon> block:
1292
1293 =over 4
1294
1295 =item B<Daemon> I<DaemonName>
1296
1297 Name to be used as the instance name for this daemon.
1298
1299 =item B<SocketPath> I<SocketPath>
1300
1301 Specifies the path to the UNIX admin socket of the ceph daemon.
1302
1303 =back
1304
1305 =head2 Plugin C<cgroups>
1306
1307 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1308 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1309 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1310
1311 =over 4
1312
1313 =item B<CGroup> I<Directory>
1314
1315 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1316 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1317 see below.
1318
1319 =item B<IgnoreSelected> B<true>|B<false>
1320
1321 Invert the selection: If set to true, all cgroups I<except> the ones that
1322 match any one of the criteria are collected. By default only selected
1323 cgroups are collected if a selection is made. If no selection is configured
1324 at all, B<all> cgroups are selected.
1325
1326 =back
1327
1328 =head2 Plugin C<conntrack>
1329
1330 This plugin collects IP conntrack statistics.
1331
1332 =over 4
1333
1334 =item B<OldFiles>
1335
1336 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1337 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1338
1339 =back
1340
1341 =head2 Plugin C<cpu>
1342
1343 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1344 as Jiffies, using the C<cpu> type. Two aggregations are available:
1345
1346 =over 4
1347
1348 =item
1349
1350 Sum, per-state, over all CPUs installed in the system; and
1351
1352 =item
1353
1354 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1355
1356 =back
1357
1358 The two aggregations can be combined, leading to I<collectd> only emitting a
1359 single "active" metric for the entire system. As soon as one of these
1360 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1361 rather than Jiffies. In addition, you can request individual, per-state,
1362 per-CPU metrics to be reported as percentage.
1363
1364 The following configuration options are available:
1365
1366 =over 4
1367
1368 =item B<ReportByState> B<true>|B<false>
1369
1370 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1371 "user" and "idle".
1372 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1373 "active" metric.
1374
1375 =item B<ReportByCpu> B<true>|B<false>
1376
1377 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1378 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1379 global sum of CPU states is emitted.
1380
1381 =item B<ValuesPercentage> B<false>|B<true>
1382
1383 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1384 are set to B<true>. In this case, by default, metrics will be reported as
1385 Jiffies. By setting this option to B<true>, you can request percentage values
1386 in the un-aggregated (per-CPU, per-state) mode as well.
1387
1388 =back
1389
1390 =head2 Plugin C<cpufreq>
1391
1392 This plugin doesn't have any options. It reads
1393 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1394 installed) to get the current CPU frequency. If this file does not exist make
1395 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1396 installed and an "cpu governor" (that's a kernel module) is loaded.
1397
1398 =head2 Plugin C<csv>
1399
1400 =over 4
1401
1402 =item B<DataDir> I<Directory>
1403
1404 Set the directory to store CSV-files under. Per default CSV-files are generated
1405 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1406 The special strings B<stdout> and B<stderr> can be used to write to the standard
1407 output and standard error channels, respectively. This, of course, only makes
1408 much sense when collectd is running in foreground- or non-daemon-mode.
1409
1410 =item B<StoreRates> B<true|false>
1411
1412 If set to B<true>, convert counter values to rates. If set to B<false> (the
1413 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1414 number.
1415
1416 =back
1417
1418 =head2 Plugin C<curl>
1419
1420 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1421 and the match infrastructure (the same code used by the tail plugin) to use
1422 regular expressions with the received data.
1423
1424 The following example will read the current value of AMD stock from Google's
1425 finance page and dispatch the value to collectd.
1426
1427   <Plugin curl>
1428     <Page "stock_quotes">
1429       URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1430       User "foo"
1431       Password "bar"
1432       Digest false
1433       VerifyPeer true
1434       VerifyHost true
1435       CACert "/path/to/ca.crt"
1436       Header "X-Custom-Header: foobar"
1437       Post "foo=bar"
1438
1439       MeasureResponseTime false
1440       MeasureResponseCode false
1441
1442       <Match>
1443         Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1444         DSType "GaugeAverage"
1445         # Note: `stock_value' is not a standard type.
1446         Type "stock_value"
1447         Instance "AMD"
1448       </Match>
1449     </Page>
1450   </Plugin>
1451
1452 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1453 a web page and one or more "matches" to be performed on the returned data. The
1454 string argument to the B<Page> block is used as plugin instance.
1455
1456 The following options are valid within B<Page> blocks:
1457
1458 =over 4
1459
1460 =item B<URL> I<URL>
1461
1462 URL of the web site to retrieve. Since a regular expression will be used to
1463 extract information from this data, non-binary data is a big plus here ;)
1464
1465 =item B<User> I<Name>
1466
1467 Username to use if authorization is required to read the page.
1468
1469 =item B<Password> I<Password>
1470
1471 Password to use if authorization is required to read the page.
1472
1473 =item B<Digest> B<true>|B<false>
1474
1475 Enable HTTP digest authentication.
1476
1477 =item B<VerifyPeer> B<true>|B<false>
1478
1479 Enable or disable peer SSL certificate verification. See
1480 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1481
1482 =item B<VerifyHost> B<true>|B<false>
1483
1484 Enable or disable peer host name verification. If enabled, the plugin checks if
1485 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1486 matches the host name provided by the B<URL> option. If this identity check
1487 fails, the connection is aborted. Obviously, only works when connecting to a
1488 SSL enabled server. Enabled by default.
1489
1490 =item B<CACert> I<file>
1491
1492 File that holds one or more SSL certificates. If you want to use HTTPS you will
1493 possibly need this option. What CA certificates come bundled with C<libcurl>
1494 and are checked by default depends on the distribution you use.
1495
1496 =item B<Header> I<Header>
1497
1498 A HTTP header to add to the request. Multiple headers are added if this option
1499 is specified more than once.
1500
1501 =item B<Post> I<Body>
1502
1503 Specifies that the HTTP operation should be a POST instead of a GET. The
1504 complete data to be posted is given as the argument.  This option will usually
1505 need to be accompanied by a B<Header> option to set an appropriate
1506 C<Content-Type> for the post body (e.g. to
1507 C<application/x-www-form-urlencoded>).
1508
1509 =item B<MeasureResponseTime> B<true>|B<false>
1510
1511 Measure response time for the request. If this setting is enabled, B<Match>
1512 blocks (see below) are optional. Disabled by default.
1513
1514 Beware that requests will get aborted if they take too long to complete. Adjust
1515 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1516 requests.
1517
1518 =item B<MeasureResponseCode> B<true>|B<false>
1519
1520 Measure response code for the request. If this setting is enabled, B<Match>
1521 blocks (see below) are optional. Disabled by default.
1522
1523 =item B<E<lt>MatchE<gt>>
1524
1525 One or more B<Match> blocks that define how to match information in the data
1526 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1527 used by the C<tail> plugin, so please see the documentation of the C<tail>
1528 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1529 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1530 optional.
1531
1532 =item B<Timeout> I<Milliseconds>
1533
1534 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1535 milliseconds. By default, the configured B<Interval> is used to set the
1536 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1537 indefinitely. This legacy behaviour can be achieved by setting the value of
1538 B<Timeout> to 0.
1539
1540 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1541 network connection will stall one read thread. Adjust the B<ReadThreads> global
1542 setting accordingly to prevent this from blocking other plugins.
1543
1544 =back
1545
1546 =head2 Plugin C<curl_json>
1547
1548 The B<curl_json plugin> collects values from JSON data to be parsed by
1549 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1550 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1551 unix socket. The former can be used, for example, to collect values
1552 from CouchDB documents (which are stored JSON notation), and the
1553 latter to collect values from a uWSGI stats socket.
1554
1555 The following example will collect several values from the built-in
1556 C<_stats> runtime statistics module of I<CouchDB>
1557 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1558
1559   <Plugin curl_json>
1560     <URL "http://localhost:5984/_stats">
1561       Instance "httpd"
1562       <Key "httpd/requests/count">
1563         Type "http_requests"
1564       </Key>
1565
1566       <Key "httpd_request_methods/*/count">
1567         Type "http_request_methods"
1568       </Key>
1569
1570       <Key "httpd_status_codes/*/count">
1571         Type "http_response_codes"
1572       </Key>
1573     </URL>
1574   </Plugin>
1575
1576 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1577
1578   <Plugin curl_json>
1579     <Sock "/var/run/uwsgi.stats.sock">
1580       Instance "uwsgi"
1581       <Key "workers/*/requests">
1582         Type "http_requests"
1583       </Key>
1584
1585       <Key "workers/*/apps/*/requests">
1586         Type "http_requests"
1587       </Key>
1588     </Sock>
1589   </Plugin>
1590
1591 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1592 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1593 blocks defining a unix socket to read JSON from directly.  Each of
1594 these blocks may have one or more B<Key> blocks.
1595
1596 The B<Key> string argument must be in a path format. Each component is
1597 used to match the key from a JSON map or the index of an JSON
1598 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1599 values for all map keys or array indices will be collectd.
1600
1601 The following options are valid within B<URL> blocks:
1602
1603 =over 4
1604
1605 =item B<Instance> I<Instance>
1606
1607 Sets the plugin instance to I<Instance>.
1608
1609 =item B<Interval> I<Interval>
1610
1611 Sets the interval (in seconds) in which the values will be collected from this
1612 URL. By default the global B<Interval> setting will be used.
1613
1614 =item B<User> I<Name>
1615
1616 =item B<Password> I<Password>
1617
1618 =item B<Digest> B<true>|B<false>
1619
1620 =item B<VerifyPeer> B<true>|B<false>
1621
1622 =item B<VerifyHost> B<true>|B<false>
1623
1624 =item B<CACert> I<file>
1625
1626 =item B<Header> I<Header>
1627
1628 =item B<Post> I<Body>
1629
1630 =item B<Timeout> I<Milliseconds>
1631
1632 These options behave exactly equivalent to the appropriate options of the
1633 I<cURL> plugin. Please see there for a detailed description.
1634
1635 =back
1636
1637 The following options are valid within B<Key> blocks:
1638
1639 =over 4
1640
1641 =item B<Type> I<Type>
1642
1643 Sets the type used to dispatch the values to the daemon. Detailed information
1644 about types and their configuration can be found in L<types.db(5)>. This
1645 option is mandatory.
1646
1647 =item B<Instance> I<Instance>
1648
1649 Type-instance to use. Defaults to the current map key or current string array element value.
1650
1651 =back
1652
1653 =head2 Plugin C<curl_xml>
1654
1655 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1656 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1657
1658  <Plugin "curl_xml">
1659    <URL "http://localhost/stats.xml">
1660      Host "my_host"
1661      Instance "some_instance"
1662      User "collectd"
1663      Password "thaiNg0I"
1664      VerifyPeer true
1665      VerifyHost true
1666      CACert "/path/to/ca.crt"
1667      Header "X-Custom-Header: foobar"
1668      Post "foo=bar"
1669
1670      <XPath "table[@id=\"magic_level\"]/tr">
1671        Type "magic_level"
1672        #InstancePrefix "prefix-"
1673        InstanceFrom "td[1]"
1674        ValuesFrom "td[2]/span[@class=\"level\"]"
1675      </XPath>
1676    </URL>
1677  </Plugin>
1678
1679 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1680 URL to be fetched using libcurl. Within each B<URL> block there are
1681 options which specify the connection parameters, for example authentication
1682 information, and one or more B<XPath> blocks.
1683
1684 Each B<XPath> block specifies how to get one type of information. The
1685 string argument must be a valid XPath expression which returns a list
1686 of "base elements". One value is dispatched for each "base element". The
1687 I<type instance> and values are looked up using further I<XPath> expressions
1688 that should be relative to the base element.
1689
1690 Within the B<URL> block the following options are accepted:
1691
1692 =over 4
1693
1694 =item B<Host> I<Name>
1695
1696 Use I<Name> as the host name when submitting values. Defaults to the global
1697 host name setting.
1698
1699 =item B<Instance> I<Instance>
1700
1701 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1702 empty string (no plugin instance).
1703
1704 =item B<Namespace> I<Prefix> I<URL>
1705
1706 If an XPath expression references namespaces, they must be specified
1707 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1708 I<URL> is the "namespace name", an URI reference uniquely identifying the
1709 namespace. The option can be repeated to register multiple namespaces.
1710
1711 Examples:
1712
1713   Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1714   Namespace "m" "http://www.w3.org/1998/Math/MathML"
1715
1716 =item B<User> I<User>
1717
1718 =item B<Password> I<Password>
1719
1720 =item B<Digest> B<true>|B<false>
1721
1722 =item B<VerifyPeer> B<true>|B<false>
1723
1724 =item B<VerifyHost> B<true>|B<false>
1725
1726 =item B<CACert> I<CA Cert File>
1727
1728 =item B<Header> I<Header>
1729
1730 =item B<Post> I<Body>
1731
1732 =item B<Timeout> I<Milliseconds>
1733
1734 These options behave exactly equivalent to the appropriate options of the
1735 I<cURL plugin>. Please see there for a detailed description.
1736
1737 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1738
1739 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1740 B<XPath> block specifies how to get one type of information. The string
1741 argument must be a valid XPath expression which returns a list of "base
1742 elements". One value is dispatched for each "base element".
1743
1744 Within the B<XPath> block the following options are accepted:
1745
1746 =over 4
1747
1748 =item B<Type> I<Type>
1749
1750 Specifies the I<Type> used for submitting patches. This determines the number
1751 of values that are required / expected and whether the strings are parsed as
1752 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1753 This option is required.
1754
1755 =item B<InstancePrefix> I<InstancePrefix>
1756
1757 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1758 concatenated together without any separator.
1759 This option is optional.
1760
1761 =item B<InstanceFrom> I<InstanceFrom>
1762
1763 Specifies a XPath expression to use for determining the I<type instance>. The
1764 XPath expression must return exactly one element. The element's value is then
1765 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1766
1767 This value is required. As a special exception, if the "base XPath expression"
1768 (the argument to the B<XPath> block) returns exactly one argument, then this
1769 option may be omitted.
1770
1771 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1772
1773 Specifies one or more XPath expression to use for reading the values. The
1774 number of XPath expressions must match the number of data sources in the
1775 I<type> specified with B<Type> (see above). Each XPath expression must return
1776 exactly one element. The element's value is then parsed as a number and used as
1777 value for the appropriate value in the value list dispatched to the daemon.
1778
1779 =back
1780
1781 =back
1782
1783 =head2 Plugin C<dbi>
1784
1785 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1786 connect to various databases, execute I<SQL> statements and read back the
1787 results. I<dbi> is an acronym for "database interface" in case you were
1788 wondering about the name. You can configure how each column is to be
1789 interpreted and the plugin will generate one or more data sets from each row
1790 returned according to these rules.
1791
1792 Because the plugin is very generic, the configuration is a little more complex
1793 than those of other plugins. It usually looks something like this:
1794
1795   <Plugin dbi>
1796     <Query "out_of_stock">
1797       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1798       # Use with MySQL 5.0.0 or later
1799       MinVersion 50000
1800       <Result>
1801         Type "gauge"
1802         InstancePrefix "out_of_stock"
1803         InstancesFrom "category"
1804         ValuesFrom "value"
1805       </Result>
1806     </Query>
1807     <Database "product_information">
1808       Driver "mysql"
1809       DriverOption "host" "localhost"
1810       DriverOption "username" "collectd"
1811       DriverOption "password" "aZo6daiw"
1812       DriverOption "dbname" "prod_info"
1813       SelectDB "prod_info"
1814       Query "out_of_stock"
1815     </Database>
1816   </Plugin>
1817
1818 The configuration above defines one query with one result and one database. The
1819 query is then linked to the database with the B<Query> option I<within> the
1820 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1821 and you can also use the B<Include> statement to split up the configuration
1822 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1823 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1824 top to bottom!
1825
1826 The following is a complete list of options:
1827
1828 =head3 B<Query> blocks
1829
1830 Query blocks define I<SQL> statements and how the returned data should be
1831 interpreted. They are identified by the name that is given in the opening line
1832 of the block. Thus the name needs to be unique. Other than that, the name is
1833 not used in collectd.
1834
1835 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1836 define which column holds which value or instance information. You can use
1837 multiple B<Result> blocks to create multiple values from one returned row. This
1838 is especially useful, when queries take a long time and sending almost the same
1839 query again and again is not desirable.
1840
1841 Example:
1842
1843   <Query "environment">
1844     Statement "select station, temperature, humidity from environment"
1845     <Result>
1846       Type "temperature"
1847       # InstancePrefix "foo"
1848       InstancesFrom "station"
1849       ValuesFrom "temperature"
1850     </Result>
1851     <Result>
1852       Type "humidity"
1853       InstancesFrom "station"
1854       ValuesFrom "humidity"
1855     </Result>
1856   </Query>
1857
1858 The following options are accepted:
1859
1860 =over 4
1861
1862 =item B<Statement> I<SQL>
1863
1864 Sets the statement that should be executed on the server. This is B<not>
1865 interpreted by collectd, but simply passed to the database server. Therefore,
1866 the SQL dialect that's used depends on the server collectd is connected to.
1867
1868 The query has to return at least two columns, one for the instance and one
1869 value. You cannot omit the instance, even if the statement is guaranteed to
1870 always return exactly one line. In that case, you can usually specify something
1871 like this:
1872
1873   Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1874
1875 (That works with MySQL but may not be valid SQL according to the spec. If you
1876 use a more strict database server, you may have to select from a dummy table or
1877 something.)
1878
1879 Please note that some databases, for example B<Oracle>, will fail if you
1880 include a semicolon at the end of the statement.
1881
1882 =item B<MinVersion> I<Version>
1883
1884 =item B<MaxVersion> I<Value>
1885
1886 Only use this query for the specified database version. You can use these
1887 options to provide multiple queries with the same name but with a slightly
1888 different syntax. The plugin will use only those queries, where the specified
1889 minimum and maximum versions fit the version of the database in use.
1890
1891 The database version is determined by C<dbi_conn_get_engine_version>, see the
1892 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1893 for details. Basically, each part of the version is assumed to be in the range
1894 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1895 "40102", version "5.0.42" becomes "50042".
1896
1897 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1898 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1899 happen. Don't to it! A valid example would be something along these lines:
1900
1901   MinVersion 40000
1902   MaxVersion 49999
1903   ...
1904   MinVersion 50000
1905   MaxVersion 50099
1906   ...
1907   MinVersion 50100
1908   # No maximum
1909
1910 In the above example, there are three ranges that don't overlap. The last one
1911 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1912 before "4.0.0" are not specified.
1913
1914 =item B<Type> I<Type>
1915
1916 The B<type> that's used for each line returned. See L<types.db(5)> for more
1917 details on how types are defined. In short: A type is a predefined layout of
1918 data and the number of values and type of values has to match the type
1919 definition.
1920
1921 If you specify "temperature" here, you need exactly one gauge column. If you
1922 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1923 setting below.
1924
1925 There must be exactly one B<Type> option inside each B<Result> block.
1926
1927 =item B<InstancePrefix> I<prefix>
1928
1929 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1930 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1931 all strings returned in the appropriate columns are concatenated together,
1932 separated by dashes I<("-")>.
1933
1934 =item B<InstancesFrom> I<column0> [I<column1> ...]
1935
1936 Specifies the columns whose values will be used to create the "type-instance"
1937 for each row. If you specify more than one column, the value of all columns
1938 will be joined together with dashes I<("-")> as separation characters.
1939
1940 The plugin itself does not check whether or not all built instances are
1941 different. It's your responsibility to assure that each is unique. This is
1942 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1943 sure that only one row is returned in this case.
1944
1945 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1946 will be empty.
1947
1948 =item B<ValuesFrom> I<column0> [I<column1> ...]
1949
1950 Names the columns whose content is used as the actual data for the data sets
1951 that are dispatched to the daemon. How many such columns you need is determined
1952 by the B<Type> setting above. If you specify too many or not enough columns,
1953 the plugin will complain about that and no data will be submitted to the
1954 daemon.
1955
1956 The actual data type in the columns is not that important. The plugin will
1957 automatically cast the values to the right type if it know how to do that. So
1958 it should be able to handle integer an floating point types, as well as strings
1959 (if they include a number at the beginning).
1960
1961 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1962
1963 =item B<MetadataFrom> [I<column0> I<column1> ...]
1964
1965 Names the columns whose content is used as metadata for the data sets
1966 that are dispatched to the daemon.
1967
1968 The actual data type in the columns is not that important. The plugin will
1969 automatically cast the values to the right type if it know how to do that. So
1970 it should be able to handle integer an floating point types, as well as strings
1971 (if they include a number at the beginning).
1972
1973 =back
1974
1975 =head3 B<Database> blocks
1976
1977 Database blocks define a connection to a database and which queries should be
1978 sent to that database. Since the used "dbi" library can handle a wide variety
1979 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1980 documentationE<nbsp>- we stick as close to the terminology used there.
1981
1982 Each database needs a "name" as string argument in the starting tag of the
1983 block. This name will be used as "PluginInstance" in the values submitted to
1984 the daemon. Other than that, that name is not used.
1985
1986 =over 4
1987
1988 =item B<Driver> I<Driver>
1989
1990 Specifies the driver to use to connect to the database. In many cases those
1991 drivers are named after the database they can connect to, but this is not a
1992 technical necessity. These drivers are sometimes referred to as "DBD",
1993 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1994 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1995 project at L<http://libdbi-drivers.sourceforge.net/>.
1996
1997 You need to give the driver name as expected by the "dbi" library here. You
1998 should be able to find that in the documentation for each driver. If you
1999 mistype the driver name, the plugin will dump a list of all known driver names
2000 to the log.
2001
2002 =item B<DriverOption> I<Key> I<Value>
2003
2004 Sets driver-specific options. What option a driver supports can be found in the
2005 documentation for each driver, somewhere at
2006 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2007 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2008
2009 DBDs can register two types of options: String options and numeric options. The
2010 plugin will use the C<dbi_conn_set_option> function when the configuration
2011 provides a string and the C<dbi_conn_require_option_numeric> function when the
2012 configuration provides a number. So these two lines will actually result in
2013 different calls being used:
2014
2015   DriverOption "Port" 1234      # numeric
2016   DriverOption "Port" "1234"    # string
2017
2018 Unfortunately, drivers are not too keen to report errors when an unknown option
2019 is passed to them, so invalid settings here may go unnoticed. This is not the
2020 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2021 the driver. If a driver complains about an option, the plugin will dump a
2022 complete list of all options understood by that driver to the log. There is no
2023 way to programatically find out if an option expects a string or a numeric
2024 argument, so you will have to refer to the appropriate DBD's documentation to
2025 find this out. Sorry.
2026
2027 =item B<SelectDB> I<Database>
2028
2029 In some cases, the database name you connect with is not the database name you
2030 want to use for querying data. If this option is set, the plugin will "select"
2031 (switch to) that database after the connection is established.
2032
2033 =item B<Query> I<QueryName>
2034
2035 Associates the query named I<QueryName> with this database connection. The
2036 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2037 blocks you want to refer to must be placed above the database block you want to
2038 refer to them from.
2039
2040 =item B<Host> I<Hostname>
2041
2042 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2043 values. Defaults to the global hostname setting.
2044
2045 =back
2046
2047 =head2 Plugin C<df>
2048
2049 =over 4
2050
2051 =item B<Device> I<Device>
2052
2053 Select partitions based on the devicename.
2054
2055 =item B<MountPoint> I<Directory>
2056
2057 Select partitions based on the mountpoint.
2058
2059 =item B<FSType> I<FSType>
2060
2061 Select partitions based on the filesystem type.
2062
2063 =item B<IgnoreSelected> B<true>|B<false>
2064
2065 Invert the selection: If set to true, all partitions B<except> the ones that
2066 match any one of the criteria are collected. By default only selected
2067 partitions are collected if a selection is made. If no selection is configured
2068 at all, B<all> partitions are selected.
2069
2070 =item B<ReportByDevice> B<true>|B<false>
2071
2072 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2073 (the default), it will report a disk as "root", but with it I<true>, it will be
2074 "sda1" (or whichever).
2075
2076 =item B<ReportInodes> B<true>|B<false>
2077
2078 Enables or disables reporting of free, reserved and used inodes. Defaults to
2079 inode collection being disabled.
2080
2081 Enable this option if inodes are a scarce resource for you, usually because
2082 many small files are stored on the disk. This is a usual scenario for mail
2083 transfer agents and web caches.
2084
2085 =item B<ValuesAbsolute> B<true>|B<false>
2086
2087 Enables or disables reporting of free and used disk space in 1K-blocks.
2088 Defaults to B<true>.
2089
2090 =item B<ValuesPercentage> B<false>|B<true>
2091
2092 Enables or disables reporting of free and used disk space in percentage.
2093 Defaults to B<false>.
2094
2095 This is useful for deploying I<collectd> on the cloud, where machines with
2096 different disk size may exist. Then it is more practical to configure
2097 thresholds based on relative disk size.
2098
2099 =back
2100
2101 =head2 Plugin C<disk>
2102
2103 The C<disk> plugin collects information about the usage of physical disks and
2104 logical disks (partitions). Values collected are the number of octets written
2105 to and read from a disk or partition, the number of read/write operations
2106 issued to the disk and a rather complex "time" it took for these commands to be
2107 issued.
2108
2109 Using the following two options you can ignore some disks or configure the
2110 collection only of specific disks.
2111
2112 =over 4
2113
2114 =item B<Disk> I<Name>
2115
2116 Select the disk I<Name>. Whether it is collected or ignored depends on the
2117 B<IgnoreSelected> setting, see below. As with other plugins that use the
2118 daemon's ignorelist functionality, a string that starts and ends with a slash
2119 is interpreted as a regular expression. Examples:
2120
2121   Disk "sdd"
2122   Disk "/hda[34]/"
2123
2124 =item B<IgnoreSelected> B<true>|B<false>
2125
2126 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2127 statements, are ignored or if all other disks are ignored. The behavior
2128 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2129 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2130 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2131 is set to B<true>, all disks are collected B<except> the ones matched.
2132
2133 =item B<UseBSDName> B<true>|B<false>
2134
2135 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2136 default major/minor numbers. Requires collectd to be built with Apple's
2137 IOKitLib support.
2138
2139 =item B<UdevNameAttr> I<Attribute>
2140
2141 Attempt to override disk instance name with the value of a specified udev
2142 attribute when built with B<libudev>.  If the attribute is not defined for the
2143 given device, the default name is used. Example:
2144
2145   UdevNameAttr "DM_NAME"
2146
2147 =back
2148
2149 =head2 Plugin C<dns>
2150
2151 =over 4
2152
2153 =item B<Interface> I<Interface>
2154
2155 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2156 option sets the interface that should be used. If this option is not set, or
2157 set to "any", the plugin will try to get packets from B<all> interfaces. This
2158 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2159
2160 =item B<IgnoreSource> I<IP-address>
2161
2162 Ignore packets that originate from this address.
2163
2164 =item B<SelectNumericQueryTypes> B<true>|B<false>
2165
2166 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2167
2168 =back
2169
2170 =head2 Plugin C<email>
2171
2172 =over 4
2173
2174 =item B<SocketFile> I<Path>
2175
2176 Sets the socket-file which is to be created.
2177
2178 =item B<SocketGroup> I<Group>
2179
2180 If running as root change the group of the UNIX-socket after it has been
2181 created. Defaults to B<collectd>.
2182
2183 =item B<SocketPerms> I<Permissions>
2184
2185 Change the file permissions of the UNIX-socket after it has been created. The
2186 permissions must be given as a numeric, octal value as you would pass to
2187 L<chmod(1)>. Defaults to B<0770>.
2188
2189 =item B<MaxConns> I<Number>
2190
2191 Sets the maximum number of connections that can be handled in parallel. Since
2192 this many threads will be started immediately setting this to a very high
2193 value will waste valuable resources. Defaults to B<5> and will be forced to be
2194 at most B<16384> to prevent typos and dumb mistakes.
2195
2196 =back
2197
2198 =head2 Plugin C<ethstat>
2199
2200 The I<ethstat plugin> collects information about network interface cards (NICs)
2201 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2202
2203 B<Synopsis:>
2204
2205  <Plugin "ethstat">
2206    Interface "eth0"
2207    Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2208    Map "multicast" "if_multicast"
2209  </Plugin>
2210
2211 B<Options:>
2212
2213 =over 4
2214
2215 =item B<Interface> I<Name>
2216
2217 Collect statistical information about interface I<Name>.
2218
2219 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2220
2221 By default, the plugin will submit values as type C<derive> and I<type
2222 instance> set to I<Name>, the name of the metric as reported by the driver. If
2223 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2224 I<TypeInstance> will be used.
2225
2226 =item B<MappedOnly> B<true>|B<false>
2227
2228 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2229 collected, all other metrics will be ignored. Defaults to B<false>.
2230
2231 =back
2232
2233 =head2 Plugin C<exec>
2234
2235 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2236 contains valuable information on when the executable is executed and the
2237 output that is expected from it.
2238
2239 =over 4
2240
2241 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2242
2243 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2244
2245 Execute the executable I<Executable> as user I<User>. If the user name is
2246 followed by a colon and a group name, the effective group is set to that group.
2247 The real group and saved-set group will be set to the default group of that
2248 user. If no group is given the effective group ID will be the same as the real
2249 group ID.
2250
2251 Please note that in order to change the user and/or group the daemon needs
2252 superuser privileges. If the daemon is run as an unprivileged user you must
2253 specify the same user/group here. If the daemon is run with superuser
2254 privileges, you must supply a non-root user here.
2255
2256 The executable may be followed by optional arguments that are passed to the
2257 program. Please note that due to the configuration parsing numbers and boolean
2258 values may be changed. If you want to be absolutely sure that something is
2259 passed as-is please enclose it in quotes.
2260
2261 The B<Exec> and B<NotificationExec> statements change the semantics of the
2262 programs executed, i.E<nbsp>e. the data passed to them and the response
2263 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2264
2265 =back
2266
2267 =head2 Plugin C<filecount>
2268
2269 The C<filecount> plugin counts the number of files in a certain directory (and
2270 its subdirectories) and their combined size. The configuration is very straight
2271 forward:
2272
2273   <Plugin "filecount">
2274     <Directory "/var/qmail/queue/mess">
2275       Instance "qmail-message"
2276     </Directory>
2277     <Directory "/var/qmail/queue/todo">
2278       Instance "qmail-todo"
2279     </Directory>
2280     <Directory "/var/lib/php5">
2281       Instance "php5-sessions"
2282       Name "sess_*"
2283     </Directory>
2284   </Plugin>
2285
2286 The example above counts the number of files in QMail's queue directories and
2287 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2288 QMail has not yet looked at, the "message" queue holds the messages that were
2289 classified into "local" and "remote".
2290
2291 As you can see, the configuration consists of one or more C<Directory> blocks,
2292 each of which specifies a directory in which to count the files. Within those
2293 blocks, the following options are recognized:
2294
2295 =over 4
2296
2297 =item B<Instance> I<Instance>
2298
2299 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2300 it's your responsibility, the plugin doesn't check for that. If not given, the
2301 instance is set to the directory name with all slashes replaced by underscores
2302 and all leading underscores removed.
2303
2304 =item B<Name> I<Pattern>
2305
2306 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2307 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2308 against the pattern, not the entire path. In case this makes it easier for you:
2309 This option has been named after the B<-name> parameter to L<find(1)>.
2310
2311 =item B<MTime> I<Age>
2312
2313 Count only files of a specific age: If I<Age> is greater than zero, only files
2314 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2315 a negative number, this is inversed. For example, if B<-60> is specified, only
2316 files that have been modified in the last minute will be counted.
2317
2318 The number can also be followed by a "multiplier" to easily specify a larger
2319 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2320 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2321 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2322 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2323 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2324 B<"12h">.
2325
2326 =item B<Size> I<Size>
2327
2328 Count only files of a specific size. When I<Size> is a positive number, only
2329 files that are at least this big are counted. If I<Size> is a negative number,
2330 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2331 I<Size> are counted.
2332
2333 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2334 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2335 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2336 note that there are 1000 bytes in a kilobyte, not 1024.
2337
2338 =item B<Recursive> I<true>|I<false>
2339
2340 Controls whether or not to recurse into subdirectories. Enabled by default.
2341
2342 =item B<IncludeHidden> I<true>|I<false>
2343
2344 Controls whether or not to include "hidden" files and directories in the count.
2345 "Hidden" files and directories are those, whose name begins with a dot.
2346 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2347
2348 =back
2349
2350 =head2 Plugin C<GenericJMX>
2351
2352 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2353 L<collectd-java(5)>.
2354
2355 =head2 Plugin C<gmond>
2356
2357 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2358 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2359 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2360
2361 Synopsis:
2362
2363  <Plugin "gmond">
2364    MCReceiveFrom "239.2.11.71" "8649"
2365    <Metric "swap_total">
2366      Type "swap"
2367      TypeInstance "total"
2368      DataSource "value"
2369    </Metric>
2370    <Metric "swap_free">
2371      Type "swap"
2372      TypeInstance "free"
2373      DataSource "value"
2374    </Metric>
2375  </Plugin>
2376
2377 The following metrics are built-in:
2378
2379 =over 4
2380
2381 =item *
2382
2383 load_one, load_five, load_fifteen
2384
2385 =item *
2386
2387 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2388
2389 =item *
2390
2391 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2392
2393 =item *
2394
2395 bytes_in, bytes_out
2396
2397 =item *
2398
2399 pkts_in, pkts_out
2400
2401 =back
2402
2403 Available configuration options:
2404
2405 =over 4
2406
2407 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2408
2409 Sets sets the multicast group and UDP port to which to subscribe.
2410
2411 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2412
2413 =item E<lt>B<Metric> I<Name>E<gt>
2414
2415 These blocks add a new metric conversion to the internal table. I<Name>, the
2416 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2417
2418 =over 4
2419
2420 =item B<Type> I<Type>
2421
2422 Type to map this metric to. Required.
2423
2424 =item B<TypeInstance> I<Instance>
2425
2426 Type-instance to use. Optional.
2427
2428 =item B<DataSource> I<Name>
2429
2430 Data source to map this metric to. If the configured type has exactly one data
2431 source, this is optional. Otherwise the option is required.
2432
2433 =back
2434
2435 =back
2436
2437 =head2 Plugin C<hddtemp>
2438
2439 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2440 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2441 default values, see below. C<hddtemp> has to be running to work correctly. If
2442 C<hddtemp> is not running timeouts may appear which may interfere with other
2443 statistics..
2444
2445 The B<hddtemp> homepage can be found at
2446 L<http://www.guzu.net/linux/hddtemp.php>.
2447
2448 =over 4
2449
2450 =item B<Host> I<Hostname>
2451
2452 Hostname to connect to. Defaults to B<127.0.0.1>.
2453
2454 =item B<Port> I<Port>
2455
2456 TCP-Port to connect to. Defaults to B<7634>.
2457
2458 =back
2459
2460 =head2 Plugin C<interface>
2461
2462 =over 4
2463
2464 =item B<Interface> I<Interface>
2465
2466 Select this interface. By default these interfaces will then be collected. For
2467 a more detailed description see B<IgnoreSelected> below.
2468
2469 =item B<IgnoreSelected> I<true>|I<false>
2470
2471 If no configuration if given, the B<traffic>-plugin will collect data from
2472 all interfaces. This may not be practical, especially for loopback- and
2473 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2474 interfaces you're interested in. Sometimes, however, it's easier/preferred
2475 to collect all interfaces I<except> a few ones. This option enables you to
2476 do that: By setting B<IgnoreSelected> to I<true> the effect of
2477 B<Interface> is inverted: All selected interfaces are ignored and all
2478 other interfaces are collected.
2479
2480 =back
2481
2482 =head2 Plugin C<ipmi>
2483
2484 =over 4
2485
2486 =item B<Sensor> I<Sensor>
2487
2488 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2489
2490 =item B<IgnoreSelected> I<true>|I<false>
2491
2492 If no configuration if given, the B<ipmi> plugin will collect data from all
2493 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2494 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2495 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2496 all other sensors are collected.
2497
2498 =item B<NotifySensorAdd> I<true>|I<false>
2499
2500 If a sensor appears after initialization time of a minute a notification
2501 is sent.
2502
2503 =item B<NotifySensorRemove> I<true>|I<false>
2504
2505 If a sensor disappears a notification is sent.
2506
2507 =item B<NotifySensorNotPresent> I<true>|I<false>
2508
2509 If you have for example dual power supply and one of them is (un)plugged then
2510 a notification is sent.
2511
2512 =back
2513
2514 =head2 Plugin C<iptables>
2515
2516 =over 4
2517
2518 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2519
2520 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2521 will collect the counters of all rules which have a comment-match. The comment
2522 is then used as type-instance.
2523
2524 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2525 the I<n>th rule will be collected. Again, the comment (or the number) will be
2526 used as the type-instance.
2527
2528 If I<Name> is supplied, it will be used as the type-instance instead of the
2529 comment or the number.
2530
2531 =back
2532
2533 =head2 Plugin C<irq>
2534
2535 =over 4
2536
2537 =item B<Irq> I<Irq>
2538
2539 Select this irq. By default these irqs will then be collected. For a more
2540 detailed description see B<IgnoreSelected> below.
2541
2542 =item B<IgnoreSelected> I<true>|I<false>
2543
2544 If no configuration if given, the B<irq>-plugin will collect data from all
2545 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2546 can use the B<Irq>-option to pick the interrupt you're interested in.
2547 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2548 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2549 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2550 and all other interrupts are collected.
2551
2552 =back
2553
2554 =head2 Plugin C<java>
2555
2556 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2557 This section only discusses the syntax and semantic of the configuration
2558 options. For more in-depth information on the I<Java> plugin, please read
2559 L<collectd-java(5)>.
2560
2561 Synopsis:
2562
2563  <Plugin "java">
2564    JVMArg "-verbose:jni"
2565    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2566    LoadPlugin "org.collectd.java.Foobar"
2567    <Plugin "org.collectd.java.Foobar">
2568      # To be parsed by the plugin
2569    </Plugin>
2570  </Plugin>
2571
2572 Available configuration options:
2573
2574 =over 4
2575
2576 =item B<JVMArg> I<Argument>
2577
2578 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2579 exactly the way the arguments to the I<java> binary on the command line work.
2580 Execute C<javaE<nbsp>--help> for details.
2581
2582 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2583 any other options! When another option is found, the JVM will be started and
2584 later options will have to be ignored!
2585
2586 =item B<LoadPlugin> I<JavaClass>
2587
2588 Instantiates a new I<JavaClass> object. The constructor of this object very
2589 likely then registers one or more callback methods with the server.
2590
2591 See L<collectd-java(5)> for details.
2592
2593 When the first such option is found, the virtual machine (JVM) is created. This
2594 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2595 B<LoadPlugin> options!
2596
2597 =item B<Plugin> I<Name>
2598
2599 The entire block is passed to the Java plugin as an
2600 I<org.collectd.api.OConfigItem> object.
2601
2602 For this to work, the plugin has to register a configuration callback first,
2603 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2604 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2605 depends on the (Java) plugin registering the callback and is completely
2606 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2607
2608 =back
2609
2610 =head2 Plugin C<load>
2611
2612 The I<Load plugin> collects the system load. These numbers give a rough overview
2613 over the utilization of a machine. The system load is defined as the number of
2614 runnable tasks in the run-queue and is provided by many operating systems as a
2615 one, five or fifteen minute average.
2616
2617 The following configuration options are available:
2618
2619 =over 4
2620
2621 =item B<ReportRelative> B<false>|B<true>
2622
2623 When enabled, system load divided by number of available CPU cores is reported
2624 for intervals 1 min, 5 min and 15 min. Defaults to false.
2625
2626 =back
2627
2628
2629 =head2 Plugin C<logfile>
2630
2631 =over 4
2632
2633 =item B<LogLevel> B<debug|info|notice|warning|err>
2634
2635 Sets the log-level. If, for example, set to B<notice>, then all events with
2636 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2637
2638 Please note that B<debug> is only available if collectd has been compiled with
2639 debugging support.
2640
2641 =item B<File> I<File>
2642
2643 Sets the file to write log messages to. The special strings B<stdout> and
2644 B<stderr> can be used to write to the standard output and standard error
2645 channels, respectively. This, of course, only makes much sense when I<collectd>
2646 is running in foreground- or non-daemon-mode.
2647
2648 =item B<Timestamp> B<true>|B<false>
2649
2650 Prefix all lines printed by the current time. Defaults to B<true>.
2651
2652 =item B<PrintSeverity> B<true>|B<false>
2653
2654 When enabled, all lines are prefixed by the severity of the log message, for
2655 example "warning". Defaults to B<false>.
2656
2657 =back
2658
2659 B<Note>: There is no need to notify the daemon after moving or removing the
2660 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2661 for each line it writes.
2662
2663 =head2 Plugin C<log_logstash>
2664
2665 The I<log logstash plugin> behaves like the logfile plugin but formats
2666 messages as JSON events for logstash to parse and input.
2667
2668 =over 4
2669
2670 =item B<LogLevel> B<debug|info|notice|warning|err>
2671
2672 Sets the log-level. If, for example, set to B<notice>, then all events with
2673 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2674
2675 Please note that B<debug> is only available if collectd has been compiled with
2676 debugging support.
2677
2678 =item B<File> I<File>
2679
2680 Sets the file to write log messages to. The special strings B<stdout> and
2681 B<stderr> can be used to write to the standard output and standard error
2682 channels, respectively. This, of course, only makes much sense when I<collectd>
2683 is running in foreground- or non-daemon-mode.
2684
2685 =back
2686
2687 B<Note>: There is no need to notify the daemon after moving or removing the
2688 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2689 for each line it writes.
2690
2691 =head2 Plugin C<lpar>
2692
2693 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2694 virtualization technique for IBM POWER processors. It takes into account CPU
2695 time stolen from or donated to a partition, in addition to the usual user,
2696 system, I/O statistics.
2697
2698 The following configuration options are available:
2699
2700 =over 4
2701
2702 =item B<CpuPoolStats> B<false>|B<true>
2703
2704 When enabled, statistics about the processor pool are read, too. The partition
2705 needs to have pool authority in order to be able to acquire this information.
2706 Defaults to false.
2707
2708 =item B<ReportBySerial> B<false>|B<true>
2709
2710 If enabled, the serial of the physical machine the partition is currently
2711 running on is reported as I<hostname> and the logical hostname of the machine
2712 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2713 used (just like other plugins) and the I<plugin instance> will be empty.
2714 Defaults to false.
2715
2716 =back
2717
2718 =head2 Plugin C<mbmon>
2719
2720 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2721
2722 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2723 B<Host> and B<Port> options can be used to change these values, see below.
2724 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2725 timeouts may appear which may interfere with other statistics..
2726
2727 C<mbmon> must be run with the -r option ("print TAG and Value format");
2728 Debian's F</etc/init.d/mbmon> script already does this, other people
2729 will need to ensure that this is the case.
2730
2731 =over 4
2732
2733 =item B<Host> I<Hostname>
2734
2735 Hostname to connect to. Defaults to B<127.0.0.1>.
2736
2737 =item B<Port> I<Port>
2738
2739 TCP-Port to connect to. Defaults to B<411>.
2740
2741 =back
2742
2743 =head2 Plugin C<md>
2744
2745 The C<md plugin> collects information from Linux Software-RAID devices (md).
2746
2747 All reported values are of the type C<md_disks>. Reported type instances are
2748 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2749 I<missing> (physically absent) disks.
2750
2751 =over 4
2752
2753 =item B<Device> I<Device>
2754
2755 Select md devices based on device name. The I<device name> is the basename of
2756 the device, i.e. the name of the block device without the leading C</dev/>.
2757 See B<IgnoreSelected> for more details.
2758
2759 =item B<IgnoreSelected> B<true>|B<false>
2760
2761 Invert device selection: If set to B<true>, all md devices B<except> those
2762 listed using B<Device> are collected. If B<false> (the default), only those
2763 listed are collected. If no configuration is given, the B<md> plugin will
2764 collect data from all md devices.
2765
2766 =back
2767
2768 =head2 Plugin C<memcachec>
2769
2770 The C<memcachec plugin> connects to a memcached server, queries one or more
2771 given I<pages> and parses the returned data according to user specification.
2772 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2773 plugins.
2774
2775 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2776 library. Please note that there is another library with a very similar name,
2777 libmemcache (notice the missing `d'), which is not applicable.
2778
2779 Synopsis of the configuration:
2780
2781  <Plugin "memcachec">
2782    <Page "plugin_instance">
2783      Server "localhost"
2784      Key "page_key"
2785      <Match>
2786        Regex "(\\d+) bytes sent"
2787        DSType CounterAdd
2788        Type "ipt_octets"
2789        Instance "type_instance"
2790      </Match>
2791    </Page>
2792  </Plugin>
2793
2794 The configuration options are:
2795
2796 =over 4
2797
2798 =item E<lt>B<Page> I<Name>E<gt>
2799
2800 Each B<Page> block defines one I<page> to be queried from the memcached server.
2801 The block requires one string argument which is used as I<plugin instance>.
2802
2803 =item B<Server> I<Address>
2804
2805 Sets the server address to connect to when querying the page. Must be inside a
2806 B<Page> block.
2807
2808 =item B<Key> I<Key>
2809
2810 When connected to the memcached server, asks for the page I<Key>.
2811
2812 =item E<lt>B<Match>E<gt>
2813
2814 Match blocks define which strings to look for and how matches substrings are
2815 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2816
2817 =back
2818
2819 =head2 Plugin C<memcached>
2820
2821 The B<memcached plugin> connects to a memcached server and queries statistics
2822 about cache utilization, memory and bandwidth used.
2823 L<http://www.danga.com/memcached/>
2824
2825  <Plugin "memcached">
2826    <Instance "name">
2827      Host "memcache.example.com"
2828      Port 11211
2829    </Instance>
2830  </Plugin>
2831
2832 The plugin configuration consists of one or more B<Instance> blocks which
2833 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2834 following options are allowed:
2835
2836 =over 4
2837
2838 =item B<Host> I<Hostname>
2839
2840 Hostname to connect to. Defaults to B<127.0.0.1>.
2841
2842 =item B<Port> I<Port>
2843
2844 TCP-Port to connect to. Defaults to B<11211>.
2845
2846 =item B<Socket> I<Path>
2847
2848 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2849 setting is given, the B<Host> and B<Port> settings are ignored.
2850
2851 =back
2852
2853 =head2 Plugin C<mic>
2854
2855 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2856 Intel's Many Integrated Core (MIC) systems.
2857
2858 B<Synopsis:>
2859
2860  <Plugin mic>
2861    ShowCPU true
2862    ShowCPUCores true
2863    ShowMemory true
2864
2865    ShowTemperatures true
2866    Temperature vddg
2867    Temperature vddq
2868    IgnoreSelectedTemperature true
2869
2870    ShowPower true
2871    Power total0
2872    Power total1
2873    IgnoreSelectedPower true
2874  </Plugin>
2875
2876 The following options are valid inside the B<PluginE<nbsp>mic> block:
2877
2878 =over 4
2879
2880 =item B<ShowCPU> B<true>|B<false>
2881
2882 If enabled (the default) a sum of the CPU usage across all cores is reported.
2883
2884 =item B<ShowCPUCores> B<true>|B<false>
2885
2886 If enabled (the default) per-core CPU usage is reported.
2887
2888 =item B<ShowMemory> B<true>|B<false>
2889
2890 If enabled (the default) the physical memory usage of the MIC system is
2891 reported.
2892
2893 =item B<ShowTemperatures> B<true>|B<false>
2894
2895 If enabled (the default) various temperatures of the MIC system are reported.
2896
2897 =item B<Temperature> I<Name>
2898
2899 This option controls which temperatures are being reported. Whether matching
2900 temperatures are being ignored or I<only> matching temperatures are reported
2901 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2902 temperatures are reported.
2903
2904 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2905
2906 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2907 (the default) only temperatures matching a B<Temperature> option are reported
2908 or, if no B<Temperature> option is specified, all temperatures are reported. If
2909 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2910 are reported.
2911
2912 Known temperature names are:
2913
2914 =over 4
2915
2916 =item die
2917
2918 Die of the CPU
2919
2920 =item devmem
2921
2922 Device Memory
2923
2924 =item fin
2925
2926 Fan In
2927
2928 =item fout
2929
2930 Fan Out
2931
2932 =item vccp
2933
2934 Voltage ccp
2935
2936 =item vddg
2937
2938 Voltage ddg
2939
2940 =item vddq
2941
2942 Voltage ddq
2943
2944 =back
2945
2946 =item B<ShowPower> B<true>|B<false>
2947
2948 If enabled (the default) various temperatures of the MIC system are reported.
2949
2950 =item B<Power> I<Name>
2951
2952 This option controls which power readings are being reported. Whether matching
2953 power readings are being ignored or I<only> matching power readings are reported
2954 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2955 power readings are reported.
2956
2957 =item B<IgnoreSelectedPower> B<false>|B<true>
2958
2959 Controls the behavior of the B<Power> setting above. If set to B<false>
2960 (the default) only power readings matching a B<Power> option are reported
2961 or, if no B<Power> option is specified, all power readings are reported. If
2962 set to B<true>, matching power readings are I<ignored> and all other power readings
2963 are reported.
2964
2965 Known power names are:
2966
2967 =over 4
2968
2969 =item total0
2970
2971 Total power utilization averaged over Time Window 0 (uWatts).
2972
2973 =item total1
2974
2975 Total power utilization averaged over Time Window 0 (uWatts).
2976
2977 =item inst
2978
2979 Instantaneous power (uWatts).
2980
2981 =item imax
2982
2983 Max instantaneous power (uWatts).
2984
2985 =item pcie
2986
2987 PCI-E connector power (uWatts).
2988
2989 =item c2x3
2990
2991 2x3 connector power (uWatts).
2992
2993 =item c2x4
2994
2995 2x4 connector power (uWatts).
2996
2997 =item vccp
2998
2999 Core rail (uVolts).
3000
3001 =item vddg
3002
3003 Uncore rail (uVolts).
3004
3005 =item vddq
3006
3007 Memory subsystem rail (uVolts).
3008
3009 =back
3010
3011 =back
3012
3013 =head2 Plugin C<memory>
3014
3015 The I<memory plugin> provides the following configuration options:
3016
3017 =over 4
3018
3019 =item B<ValuesAbsolute> B<true>|B<false>
3020
3021 Enables or disables reporting of physical memory usage in absolute numbers,
3022 i.e. bytes. Defaults to B<true>.
3023
3024 =item B<ValuesPercentage> B<false>|B<true>
3025
3026 Enables or disables reporting of physical memory usage in percentages, e.g.
3027 percent of physical memory used. Defaults to B<false>.
3028
3029 This is useful for deploying I<collectd> in a heterogeneous environment in
3030 which the sizes of physical memory vary.
3031
3032 =back
3033
3034 =head2 Plugin C<modbus>
3035
3036 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3037 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3038 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3039 values (two registers interpreted as IEEE floats in big endian notation).
3040
3041 B<Synopsis:>
3042
3043  <Data "voltage-input-1">
3044    RegisterBase 0
3045    RegisterType float
3046    RegisterCmd ReadHolding
3047    Type voltage
3048    Instance "input-1"
3049  </Data>
3050
3051  <Data "voltage-input-2">
3052    RegisterBase 2
3053    RegisterType float
3054    RegisterCmd ReadHolding
3055    Type voltage
3056    Instance "input-2"
3057  </Data>
3058
3059  <Data "supply-temperature-1">
3060    RegisterBase 0
3061    RegisterType Int16
3062    RegisterCmd ReadHolding
3063    Type temperature
3064    Instance "temp-1"
3065  </Data>
3066
3067  <Host "modbus.example.com">
3068    Address "192.168.0.42"
3069    Port    "502"
3070    Interval 60
3071
3072    <Slave 1>
3073      Instance "power-supply"
3074      Collect  "voltage-input-1"
3075      Collect  "voltage-input-2"
3076    </Slave>
3077  </Host>
3078
3079  <Host "localhost">
3080    Device "/dev/ttyUSB0"
3081    Baudrate 38400
3082    Interval 20
3083
3084    <Slave 1>
3085      Instance "temperature"
3086      Collect  "supply-temperature-1"
3087    </Slave>
3088  </Host>
3089
3090 =over 4
3091
3092 =item E<lt>B<Data> I<Name>E<gt> blocks
3093
3094 Data blocks define a mapping between register numbers and the "types" used by
3095 I<collectd>.
3096
3097 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3098
3099 =over 4
3100
3101 =item B<RegisterBase> I<Number>
3102
3103 Configures the base register to read from the device. If the option
3104 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3105 register will be read (the register number is increased by one).
3106
3107 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3108
3109 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3110 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3111 combined into one value. Defaults to B<Uint16>.
3112
3113 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3114
3115 Specifies register type to be collected from device. Works only with libmodbus
3116 2.9.2 or higher. Defaults to B<ReadHolding>.
3117
3118 =item B<Type> I<Type>
3119
3120 Specifies the "type" (data set) to use when dispatching the value to
3121 I<collectd>. Currently, only data sets with exactly one data source are
3122 supported.
3123
3124 =item B<Instance> I<Instance>
3125
3126 Sets the type instance to use when dispatching the value to I<collectd>. If
3127 unset, an empty string (no type instance) is used.
3128
3129 =back
3130
3131 =item E<lt>B<Host> I<Name>E<gt> blocks
3132
3133 Host blocks are used to specify to which hosts to connect and what data to read
3134 from their "slaves". The string argument I<Name> is used as hostname when
3135 dispatching the values to I<collectd>.
3136
3137 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3138
3139 =over 4
3140
3141 =item B<Address> I<Hostname>
3142
3143 For Modbus/TCP, specifies the node name (the actual network address) used to
3144 connect to the host. This may be an IP address or a hostname. Please note that
3145 the used I<libmodbus> library only supports IPv4 at the moment.
3146
3147 =item B<Port> I<Service>
3148
3149 for Modbus/TCP, specifies the port used to connect to the host. The port can
3150 either be given as a number or as a service name. Please note that the
3151 I<Service> argument must be a string, even if ports are given in their numerical
3152 form. Defaults to "502".
3153
3154 =item B<Device> I<Devicenode>
3155
3156 For Modbus/RTU, specifies the path to the serial device being used.
3157
3158 =item B<Baudrate> I<Baudrate>
3159
3160 For Modbus/RTU, specifies the baud rate of the serial device.
3161 Note, connections currently support only 8/N/1.
3162
3163 =item B<Interval> I<Interval>
3164
3165 Sets the interval (in seconds) in which the values will be collected from this
3166 host. By default the global B<Interval> setting will be used.
3167
3168 =item E<lt>B<Slave> I<ID>E<gt>
3169
3170 Over each connection, multiple Modbus devices may be reached. The slave ID
3171 is used to specify which device should be addressed. For each device you want
3172 to query, one B<Slave> block must be given.
3173
3174 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3175
3176 =over 4
3177
3178 =item B<Instance> I<Instance>
3179
3180 Specify the plugin instance to use when dispatching the values to I<collectd>.
3181 By default "slave_I<ID>" is used.
3182
3183 =item B<Collect> I<DataName>
3184
3185 Specifies which data to retrieve from the device. I<DataName> must be the same
3186 string as the I<Name> argument passed to a B<Data> block. You can specify this
3187 option multiple times to collect more than one value from a slave. At least one
3188 B<Collect> option is mandatory.
3189
3190 =back
3191
3192 =back
3193
3194 =back
3195
3196 =head2 Plugin C<mysql>
3197
3198 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3199 one or more databases when started and keeps the connection up as long as
3200 possible. When the connection is interrupted for whatever reason it will try
3201 to re-connect. The plugin will complain loudly in case anything goes wrong.
3202
3203 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3204 and collects information about MySQL network traffic, executed statements,
3205 requests, the query cache and threads by evaluating the
3206 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3207 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3208 Status Variables> for an explanation of these values.
3209
3210 Optionally, master and slave statistics may be collected in a MySQL
3211 replication setup. In that case, information about the synchronization state
3212 of the nodes are collected by evaluating the C<Position> return value of the
3213 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3214 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3215 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3216 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3217 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3218
3219 Synopsis:
3220
3221   <Plugin mysql>
3222     <Database foo>
3223       Host "hostname"
3224       User "username"
3225       Password "password"
3226       Port "3306"
3227       MasterStats true
3228       ConnectTimeout 10
3229     </Database>
3230
3231     <Database bar>
3232       Alias "squeeze"
3233       Host "localhost"
3234       Socket "/var/run/mysql/mysqld.sock"
3235       SlaveStats true
3236       SlaveNotifications true
3237     </Database>
3238   </Plugin>
3239
3240 A B<Database> block defines one connection to a MySQL database. It accepts a
3241 single argument which specifies the name of the database. None of the other
3242 options are required. MySQL will use default values as documented in the
3243 section "mysql_real_connect()" in the B<MySQL reference manual>.
3244
3245 =over 4
3246
3247 =item B<Alias> I<Alias>
3248
3249 Alias to use as sender instead of hostname when reporting. This may be useful
3250 when having cryptic hostnames.
3251
3252 =item B<Host> I<Hostname>
3253
3254 Hostname of the database server. Defaults to B<localhost>.
3255
3256 =item B<User> I<Username>
3257
3258 Username to use when connecting to the database. The user does not have to be
3259 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3260 unless you want to collectd replication statistics (see B<MasterStats> and
3261 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3262 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3263
3264 =item B<Password> I<Password>
3265
3266 Password needed to log into the database.
3267
3268 =item B<Database> I<Database>
3269
3270 Select this database. Defaults to I<no database> which is a perfectly reasonable
3271 option for what this plugin does.
3272
3273 =item B<Port> I<Port>
3274
3275 TCP-port to connect to. The port must be specified in its numeric form, but it
3276 must be passed as a string nonetheless. For example:
3277
3278   Port "3306"
3279
3280 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3281 See the documentation for the C<mysql_real_connect> function for details.
3282
3283 =item B<Socket> I<Socket>
3284
3285 Specifies the path to the UNIX domain socket of the MySQL server. This option
3286 only has any effect, if B<Host> is set to B<localhost> (the default).
3287 Otherwise, use the B<Port> option above. See the documentation for the
3288 C<mysql_real_connect> function for details.
3289
3290 =item B<InnodbStats> I<true|false>
3291
3292 If enabled, metrics about the InnoDB storage engine are collected.
3293 Disabled by default.
3294
3295 =item B<MasterStats> I<true|false>
3296
3297 =item B<SlaveStats> I<true|false>
3298
3299 Enable the collection of master / slave statistics in a replication setup. In
3300 order to be able to get access to these statistics, the user needs special
3301 privileges. See the B<User> documentation above. Defaults to B<false>.
3302
3303 =item B<SlaveNotifications> I<true|false>
3304
3305 If enabled, the plugin sends a notification if the replication slave I/O and /
3306 or SQL threads are not running. Defaults to B<false>.
3307
3308 =item B<ConnectTimeout> I<Seconds>
3309
3310 Sets the connect timeout for the MySQL client.
3311
3312 =back
3313
3314 =head2 Plugin C<netapp>
3315
3316 The netapp plugin can collect various performance and capacity information
3317 from a NetApp filer using the NetApp API.
3318
3319 Please note that NetApp has a wide line of products and a lot of different
3320 software versions for each of these products. This plugin was developed for a
3321 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3322 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3323 model and software version but it is very hard to test this.
3324 If you have used this plugin with other models and/or software version, feel
3325 free to send us a mail to tell us about the results, even if it's just a short
3326 "It works".
3327
3328 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3329 basic authentication.
3330
3331 B<Do not use a regular user for this!> Create a special collectd user with just
3332 the minimum of capabilities needed. The user only needs the "login-http-admin"
3333 capability as well as a few more depending on which data will be collected.
3334 Required capabilities are documented below.
3335
3336 =head3 Synopsis
3337
3338  <Plugin "netapp">
3339    <Host "netapp1.example.com">
3340     Protocol      "https"
3341     Address       "10.0.0.1"
3342     Port          443
3343     User          "username"
3344     Password      "aef4Aebe"
3345     Interval      30
3346
3347     <WAFL>
3348       Interval 30
3349       GetNameCache   true
3350       GetDirCache    true
3351       GetBufferCache true
3352       GetInodeCache  true
3353     </WAFL>
3354
3355     <Disks>
3356       Interval 30
3357       GetBusy true
3358     </Disks>
3359
3360     <VolumePerf>
3361       Interval 30
3362       GetIO      "volume0"
3363       IgnoreSelectedIO      false
3364       GetOps     "volume0"
3365       IgnoreSelectedOps     false
3366       GetLatency "volume0"
3367       IgnoreSelectedLatency false
3368     </VolumePerf>
3369
3370     <VolumeUsage>
3371       Interval 30
3372       GetCapacity "vol0"
3373       GetCapacity "vol1"
3374       IgnoreSelectedCapacity false
3375       GetSnapshot "vol1"
3376       GetSnapshot "vol3"
3377       IgnoreSelectedSnapshot false
3378     </VolumeUsage>
3379
3380     <Quota>
3381       Interval 60
3382     </Quota>
3383
3384     <Snapvault>
3385       Interval 30
3386     </Snapvault>
3387
3388     <System>
3389       Interval 30
3390       GetCPULoad     true
3391       GetInterfaces  true
3392       GetDiskOps     true
3393       GetDiskIO      true
3394     </System>
3395
3396     <VFiler vfilerA>
3397       Interval 60
3398
3399       SnapVault true
3400       # ...
3401     </VFiler>
3402    </Host>
3403  </Plugin>
3404
3405 The netapp plugin accepts the following configuration options:
3406
3407 =over 4
3408
3409 =item B<Host> I<Name>
3410
3411 A host block defines one NetApp filer. It will appear in collectd with the name
3412 you specify here which does not have to be its real name nor its hostname (see
3413 the B<Address> option below).
3414
3415 =item B<VFiler> I<Name>
3416
3417 A B<VFiler> block may only be used inside a host block. It accepts all the
3418 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3419 will execute all NetApp API commands in the context of the specified
3420 VFiler(R). It will appear in collectd with the name you specify here which
3421 does not have to be its real name. The VFiler name may be specified using the
3422 B<VFilerName> option. If this is not specified, it will default to the name
3423 you specify here.
3424
3425 The VFiler block inherits all connection related settings from the surrounding
3426 B<Host> block (which appear before the B<VFiler> block) but they may be
3427 overwritten inside the B<VFiler> block.
3428
3429 This feature is useful, for example, when using a VFiler as SnapVault target
3430 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3431 available in the host filer (vfiler0) but only in the respective VFiler
3432 context.
3433
3434 =item B<Protocol> B<httpd>|B<http>
3435
3436 The protocol collectd will use to query this host.
3437
3438 Optional
3439
3440 Type: string
3441
3442 Default: https
3443
3444 Valid options: http, https
3445
3446 =item B<Address> I<Address>
3447
3448 The hostname or IP address of the host.
3449
3450 Optional
3451
3452 Type: string
3453
3454 Default: The "host" block's name.
3455
3456 =item B<Port> I<Port>
3457
3458 The TCP port to connect to on the host.
3459
3460 Optional
3461
3462 Type: integer
3463
3464 Default: 80 for protocol "http", 443 for protocol "https"
3465
3466 =item B<User> I<User>
3467
3468 =item B<Password> I<Password>
3469
3470 The username and password to use to login to the NetApp.
3471
3472 Mandatory
3473
3474 Type: string
3475
3476 =item B<VFilerName> I<Name>
3477
3478 The name of the VFiler in which context to execute API commands. If not
3479 specified, the name provided to the B<VFiler> block will be used instead.
3480
3481 Optional
3482
3483 Type: string
3484
3485 Default: name of the B<VFiler> block
3486
3487 B<Note:> This option may only be used inside B<VFiler> blocks.
3488
3489 =item B<Interval> I<Interval>
3490
3491 B<TODO>
3492
3493 =back
3494
3495 The following options decide what kind of data will be collected. You can
3496 either use them as a block and fine tune various parameters inside this block,
3497 use them as a single statement to just accept all default values, or omit it to
3498 not collect any data.
3499
3500 The following options are valid inside all blocks:
3501
3502 =over 4
3503
3504 =item B<Interval> I<Seconds>
3505
3506 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3507 host specific setting.
3508
3509 =back
3510
3511 =head3 The System block
3512
3513 This will collect various performance data about the whole system.
3514
3515 B<Note:> To get this data the collectd user needs the
3516 "api-perf-object-get-instances" capability.
3517
3518 =over 4
3519
3520 =item B<Interval> I<Seconds>
3521
3522 Collect disk statistics every I<Seconds> seconds.
3523
3524 =item B<GetCPULoad> B<true>|B<false>
3525
3526 If you set this option to true the current CPU usage will be read. This will be
3527 the average usage between all CPUs in your NetApp without any information about
3528 individual CPUs.
3529
3530 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3531 returns in the "CPU" field.
3532
3533 Optional
3534
3535 Type: boolean
3536
3537 Default: true
3538
3539 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3540
3541 =item B<GetInterfaces> B<true>|B<false>
3542
3543 If you set this option to true the current traffic of the network interfaces
3544 will be read. This will be the total traffic over all interfaces of your NetApp
3545 without any information about individual interfaces.
3546
3547 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3548 in the "Net kB/s" field.
3549
3550 B<Or is it?>
3551
3552 Optional
3553
3554 Type: boolean
3555
3556 Default: true
3557
3558 Result: One value list of type "if_octects".
3559
3560 =item B<GetDiskIO> B<true>|B<false>
3561
3562 If you set this option to true the current IO throughput will be read. This
3563 will be the total IO of your NetApp without any information about individual
3564 disks, volumes or aggregates.
3565
3566 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3567 in the "DiskE<nbsp>kB/s" field.
3568
3569 Optional
3570
3571 Type: boolean
3572
3573 Default: true
3574
3575 Result: One value list of type "disk_octets".
3576
3577 =item B<GetDiskOps> B<true>|B<false>
3578
3579 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3580 iSCSI, etc. operations will be read. This will be the total number of
3581 operations on your NetApp without any information about individual volumes or
3582 aggregates.
3583
3584 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3585 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3586
3587 Optional
3588
3589 Type: boolean
3590
3591 Default: true
3592
3593 Result: A variable number of value lists of type "disk_ops_complex". Each type
3594 of operation will result in one value list with the name of the operation as
3595 type instance.
3596
3597 =back
3598
3599 =head3 The WAFL block
3600
3601 This will collect various performance data about the WAFL file system. At the
3602 moment this just means cache performance.
3603
3604 B<Note:> To get this data the collectd user needs the
3605 "api-perf-object-get-instances" capability.
3606
3607 B<Note:> The interface to get these values is classified as "Diagnostics" by
3608 NetApp. This means that it is not guaranteed to be stable even between minor
3609 releases.
3610
3611 =over 4
3612
3613 =item B<Interval> I<Seconds>
3614
3615 Collect disk statistics every I<Seconds> seconds.
3616
3617 =item B<GetNameCache> B<true>|B<false>
3618
3619 Optional
3620
3621 Type: boolean
3622
3623 Default: true
3624
3625 Result: One value list of type "cache_ratio" and type instance
3626 "name_cache_hit".
3627
3628 =item B<GetDirCache> B<true>|B<false>
3629
3630 Optional
3631
3632 Type: boolean
3633
3634 Default: true
3635
3636 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3637
3638 =item B<GetInodeCache> B<true>|B<false>
3639
3640 Optional
3641
3642 Type: boolean
3643
3644 Default: true
3645
3646 Result: One value list of type "cache_ratio" and type instance
3647 "inode_cache_hit".
3648
3649 =item B<GetBufferCache> B<true>|B<false>
3650
3651 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3652 in the "Cache hit" field.
3653
3654 Optional
3655
3656 Type: boolean
3657
3658 Default: true
3659
3660 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3661
3662 =back
3663
3664 =head3 The Disks block
3665
3666 This will collect performance data about the individual disks in the NetApp.
3667
3668 B<Note:> To get this data the collectd user needs the
3669 "api-perf-object-get-instances" capability.
3670
3671 =over 4
3672
3673 =item B<Interval> I<Seconds>
3674
3675 Collect disk statistics every I<Seconds> seconds.
3676
3677 =item B<GetBusy> B<true>|B<false>
3678
3679 If you set this option to true the busy time of all disks will be calculated
3680 and the value of the busiest disk in the system will be written.
3681
3682 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3683 in the "Disk util" field. Probably.
3684
3685 Optional
3686
3687 Type: boolean
3688
3689 Default: true
3690
3691 Result: One value list of type "percent" and type instance "disk_busy".
3692
3693 =back
3694
3695 =head3 The VolumePerf block
3696
3697 This will collect various performance data about the individual volumes.
3698
3699 You can select which data to collect about which volume using the following
3700 options. They follow the standard ignorelist semantic.
3701
3702 B<Note:> To get this data the collectd user needs the
3703 I<api-perf-object-get-instances> capability.
3704
3705 =over 4
3706
3707 =item B<Interval> I<Seconds>
3708
3709 Collect volume performance data every I<Seconds> seconds.
3710
3711 =item B<GetIO> I<Volume>
3712
3713 =item B<GetOps> I<Volume>
3714
3715 =item B<GetLatency> I<Volume>
3716
3717 Select the given volume for IO, operations or latency statistics collection.
3718 The argument is the name of the volume without the C</vol/> prefix.
3719
3720 Since the standard ignorelist functionality is used here, you can use a string
3721 starting and ending with a slash to specify regular expression matching: To
3722 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3723 expression:
3724
3725   GetIO "/^vol[027]$/"
3726
3727 If no regular expression is specified, an exact match is required. Both,
3728 regular and exact matching are case sensitive.
3729
3730 If no volume was specified at all for either of the three options, that data
3731 will be collected for all available volumes.
3732
3733 =item B<IgnoreSelectedIO> B<true>|B<false>
3734
3735 =item B<IgnoreSelectedOps> B<true>|B<false>
3736
3737 =item B<IgnoreSelectedLatency> B<true>|B<false>
3738
3739 When set to B<true>, the volumes selected for IO, operations or latency
3740 statistics collection will be ignored and the data will be collected for all
3741 other volumes.
3742
3743 When set to B<false>, data will only be collected for the specified volumes and
3744 all other volumes will be ignored.
3745
3746 If no volumes have been specified with the above B<Get*> options, all volumes
3747 will be collected regardless of the B<IgnoreSelected*> option.
3748
3749 Defaults to B<false>
3750
3751 =back
3752
3753 =head3 The VolumeUsage block
3754
3755 This will collect capacity data about the individual volumes.
3756
3757 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3758 capability.
3759
3760 =over 4
3761
3762 =item B<Interval> I<Seconds>
3763
3764 Collect volume usage statistics every I<Seconds> seconds.
3765
3766 =item B<GetCapacity> I<VolumeName>
3767
3768 The current capacity of the volume will be collected. This will result in two
3769 to four value lists, depending on the configuration of the volume. All data
3770 sources are of type "df_complex" with the name of the volume as
3771 plugin_instance.
3772
3773 There will be type_instances "used" and "free" for the number of used and
3774 available bytes on the volume.  If the volume has some space reserved for
3775 snapshots, a type_instance "snap_reserved" will be available.  If the volume
3776 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3777 number of bytes saved by the SIS feature.
3778
3779 B<Note:> The current NetApp API has a bug that results in this value being
3780 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3781 number which works most of the time.  If you see strange values here, bug
3782 NetApp support to fix this.
3783
3784 Repeat this option to specify multiple volumes.
3785
3786 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3787
3788 Specify whether to collect only the volumes selected by the B<GetCapacity>
3789 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3790 B<false>. However, if no B<GetCapacity> option is specified at all, all
3791 capacities will be selected anyway.
3792
3793 =item B<GetSnapshot> I<VolumeName>
3794
3795 Select volumes from which to collect snapshot information.
3796
3797 Usually, the space used for snapshots is included in the space reported as
3798 "used". If snapshot information is collected as well, the space used for
3799 snapshots is subtracted from the used space.
3800
3801 To make things even more interesting, it is possible to reserve space to be
3802 used for snapshots. If the space required for snapshots is less than that
3803 reserved space, there is "reserved free" and "reserved used" space in addition
3804 to "free" and "used". If the space required for snapshots exceeds the reserved
3805 space, that part allocated in the normal space is subtracted from the "used"
3806 space again.
3807
3808 Repeat this option to specify multiple volumes.
3809
3810 =item B<IgnoreSelectedSnapshot>
3811
3812 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3813 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3814 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3815 capacities will be selected anyway.
3816
3817 =back
3818
3819 =head3 The Quota block
3820
3821 This will collect (tree) quota statistics (used disk space and number of used
3822 files). This mechanism is useful to get usage information for single qtrees.
3823 In case the quotas are not used for any other purpose, an entry similar to the
3824 following in C</etc/quotas> would be sufficient:
3825
3826   /vol/volA/some_qtree tree - - - - -
3827
3828 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3829
3830 =over 4
3831
3832 =item B<Interval> I<Seconds>
3833
3834 Collect SnapVault(R) statistics every I<Seconds> seconds.
3835
3836 =back
3837
3838 =head3 The SnapVault block
3839
3840 This will collect statistics about the time and traffic of SnapVault(R)
3841 transfers.
3842
3843 =over 4
3844
3845 =item B<Interval> I<Seconds>
3846
3847 Collect SnapVault(R) statistics every I<Seconds> seconds.
3848
3849 =back
3850
3851 =head2 Plugin C<netlink>
3852
3853 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3854 statistics of various interface and routing aspects.
3855
3856 =over 4
3857
3858 =item B<Interface> I<Interface>
3859
3860 =item B<VerboseInterface> I<Interface>
3861
3862 Instruct the plugin to collect interface statistics. This is basically the same
3863 as the statistics provided by the C<interface> plugin (see above) but
3864 potentially much more detailed.
3865
3866 When configuring with B<Interface> only the basic statistics will be collected,
3867 namely octets, packets, and errors. These statistics are collected by
3868 the C<interface> plugin, too, so using both at the same time is no benefit.
3869
3870 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3871 so that no data needs to be collected twice if you use the C<interface> plugin.
3872 This includes dropped packets, received multicast packets, collisions and a
3873 whole zoo of differentiated RX and TX errors. You can try the following command
3874 to get an idea of what awaits you:
3875
3876   ip -s -s link list
3877
3878 If I<Interface> is B<All>, all interfaces will be selected.
3879
3880 =item B<QDisc> I<Interface> [I<QDisc>]
3881
3882 =item B<Class> I<Interface> [I<Class>]
3883
3884 =item B<Filter> I<Interface> [I<Filter>]
3885
3886 Collect the octets and packets that pass a certain qdisc, class or filter.
3887
3888 QDiscs and classes are identified by their type and handle (or classid).
3889 Filters don't necessarily have a handle, therefore the parent's handle is used.
3890 The notation used in collectd differs from that used in tc(1) in that it
3891 doesn't skip the major or minor number if it's zero and doesn't print special
3892 ids by their name. So, for example, a qdisc may be identified by
3893 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3894 thus not displayed by tc(1).
3895
3896 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3897 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3898 associated with that interface will be collected.
3899
3900 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3901 used. This may lead to problems when more than one filter is attached to a
3902 qdisc or class. This isn't nice, but we don't know how this could be done any
3903 better. If you have a idea, please don't hesitate to tell us.
3904
3905 As with the B<Interface> option you can specify B<All> as the interface,
3906 meaning all interfaces.
3907
3908 Here are some examples to help you understand the above text more easily:
3909
3910   <Plugin netlink>
3911     VerboseInterface "All"
3912     QDisc "eth0" "pfifo_fast-1:0"
3913     QDisc "ppp0"
3914     Class "ppp0" "htb-1:10"
3915     Filter "ppp0" "u32-1:0"
3916   </Plugin>
3917
3918 =item B<IgnoreSelected>
3919
3920 The behavior is the same as with all other similar plugins: If nothing is
3921 selected at all, everything is collected. If some things are selected using the
3922 options described above, only these statistics are collected. If you set
3923 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3924 specified statistics will not be collected.
3925
3926 =back
3927
3928 =head2 Plugin C<network>
3929
3930 The Network plugin sends data to a remote instance of collectd, receives data
3931 from a remote instance, or both at the same time. Data which has been received
3932 from the network is usually not transmitted again, but this can be activated, see
3933 the B<Forward> option below.
3934
3935 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3936 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3937
3938 Both, B<Server> and B<Listen> can be used as single option or as block. When
3939 used as block, given options are valid for this socket only. The following
3940 example will export the metrics twice: Once to an "internal" server (without
3941 encryption and signing) and one to an external server (with cryptographic
3942 signature):
3943
3944  <Plugin "network">
3945    # Export to an internal server
3946    # (demonstrates usage without additional options)
3947    Server "collectd.internal.tld"
3948
3949    # Export to an external server
3950    # (demonstrates usage with signature options)
3951    <Server "collectd.external.tld">
3952      SecurityLevel "sign"
3953      Username "myhostname"
3954      Password "ohl0eQue"
3955    </Server>
3956  </Plugin>
3957
3958 =over 4
3959
3960 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3961
3962 The B<Server> statement/block sets the server to send datagrams to. The
3963 statement may occur multiple times to send each datagram to multiple
3964 destinations.
3965
3966 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3967 optional second argument specifies a port number or a service name. If not
3968 given, the default, B<25826>, is used.
3969
3970 The following options are recognized within B<Server> blocks:
3971
3972 =over 4
3973
3974 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3975
3976 Set the security you require for network communication. When the security level
3977 has been set to B<Encrypt>, data sent over the network will be encrypted using
3978 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3979 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3980 authentication code. When set to B<None>, data is sent without any security.
3981
3982 This feature is only available if the I<network> plugin was linked with
3983 I<libgcrypt>.
3984
3985 =item B<Username> I<Username>
3986
3987 Sets the username to transmit. This is used by the server to lookup the
3988 password. See B<AuthFile> below. All security levels except B<None> require
3989 this setting.
3990
3991 This feature is only available if the I<network> plugin was linked with
3992 I<libgcrypt>.
3993
3994 =item B<Password> I<Password>
3995
3996 Sets a password (shared secret) for this socket. All security levels except
3997 B<None> require this setting.
3998
3999 This feature is only available if the I<network> plugin was linked with
4000 I<libgcrypt>.
4001
4002 =item B<Interface> I<Interface name>
4003
4004 Set the outgoing interface for IP packets. This applies at least
4005 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4006 undefined or a non-existent interface name is specified, the default
4007 behavior is to let the kernel choose the appropriate interface. Be warned
4008 that the manual selection of an interface for unicast traffic is only
4009 necessary in rare cases.
4010
4011 =item B<ResolveInterval> I<Seconds>
4012
4013 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4014 useful to force a regular DNS lookup to support a high availability setup. If
4015 not specified, re-resolves are never attempted.
4016
4017 =back
4018
4019 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4020
4021 The B<Listen> statement sets the interfaces to bind to. When multiple
4022 statements are found the daemon will bind to multiple interfaces.
4023
4024 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4025 the argument is a multicast address the daemon will join that multicast group.
4026 The optional second argument specifies a port number or a service name. If not
4027 given, the default, B<25826>, is used.
4028
4029 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4030
4031 =over 4
4032
4033 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4034
4035 Set the security you require for network communication. When the security level
4036 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4037 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4038 signed and encrypted data is accepted. When set to B<None>, all data will be
4039 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4040 decrypted if possible.
4041
4042 This feature is only available if the I<network> plugin was linked with
4043 I<libgcrypt>.
4044
4045 =item B<AuthFile> I<Filename>
4046
4047 Sets a file in which usernames are mapped to passwords. These passwords are
4048 used to verify signatures and to decrypt encrypted network packets. If
4049 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4050 verified and encrypted packets are decrypted. Otherwise, signed data is
4051 accepted without checking the signature and encrypted data cannot be decrypted.
4052 For the other security levels this option is mandatory.
4053
4054 The file format is very simple: Each line consists of a username followed by a
4055 colon and any number of spaces followed by the password. To demonstrate, an
4056 example file could look like this:
4057
4058   user0: foo
4059   user1: bar
4060
4061 Each time a packet is received, the modification time of the file is checked
4062 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4063 the file is being read, it is locked using L<fcntl(2)>.
4064
4065 =item B<Interface> I<Interface name>
4066
4067 Set the incoming interface for IP packets explicitly. This applies at least
4068 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4069 undefined or a non-existent interface name is specified, the default
4070 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4071 traffic gets only accepted, if it arrives on the given interface.
4072
4073 =back
4074
4075 =item B<TimeToLive> I<1-255>
4076
4077 Set the time-to-live of sent packets. This applies to all, unicast and
4078 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4079 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4080 operating systems.
4081
4082 =item B<MaxPacketSize> I<1024-65535>
4083
4084 Set the maximum size for datagrams received over the network. Packets larger
4085 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4086 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4087 UDP.
4088
4089 On the server side, this limit should be set to the largest value used on
4090 I<any> client. Likewise, the value on the client must not be larger than the
4091 value on the server, or data will be lost.
4092
4093 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4094 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4095 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4096 server.
4097
4098 =item B<Forward> I<true|false>
4099
4100 If set to I<true>, write packets that were received via the network plugin to
4101 the sending sockets. This should only be activated when the B<Listen>- and
4102 B<Server>-statements differ. Otherwise packets may be send multiple times to
4103 the same multicast group. While this results in more network traffic than
4104 necessary it's not a huge problem since the plugin has a duplicate detection,
4105 so the values will not loop.
4106
4107 =item B<ReportStats> B<true>|B<false>
4108
4109 The network plugin cannot only receive and send statistics, it can also create
4110 statistics about itself. Collected data included the number of received and
4111 sent octets and packets, the length of the receive queue and the number of
4112 values handled. When set to B<true>, the I<Network plugin> will make these
4113 statistics available. Defaults to B<false>.
4114
4115 =back
4116
4117 =head2 Plugin C<nginx>
4118
4119 This plugin collects the number of connections and requests handled by the
4120 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4121 queries the page provided by the C<ngx_http_stub_status_module> module, which
4122 isn't compiled by default. Please refer to
4123 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4124 how to compile and configure nginx and this module.
4125
4126 The following options are accepted by the C<nginx plugin>:
4127
4128 =over 4
4129
4130 =item B<URL> I<http://host/nginx_status>
4131
4132 Sets the URL of the C<ngx_http_stub_status_module> output.
4133
4134 =item B<User> I<Username>
4135
4136 Optional user name needed for authentication.
4137
4138 =item B<Password> I<Password>
4139
4140 Optional password needed for authentication.
4141
4142 =item B<VerifyPeer> B<true|false>
4143
4144 Enable or disable peer SSL certificate verification. See
4145 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4146
4147 =item B<VerifyHost> B<true|false>
4148
4149 Enable or disable peer host name verification. If enabled, the plugin checks
4150 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4151 certificate matches the host name provided by the B<URL> option. If this
4152 identity check fails, the connection is aborted. Obviously, only works when
4153 connecting to a SSL enabled server. Enabled by default.
4154
4155 =item B<CACert> I<File>
4156
4157 File that holds one or more SSL certificates. If you want to use HTTPS you will
4158 possibly need this option. What CA certificates come bundled with C<libcurl>
4159 and are checked by default depends on the distribution you use.
4160
4161 =item B<Timeout> I<Milliseconds>
4162
4163 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4164 milliseconds. By default, the configured B<Interval> is used to set the
4165 timeout.
4166
4167 =back
4168
4169 =head2 Plugin C<notify_desktop>
4170
4171 This plugin sends a desktop notification to a notification daemon, as defined
4172 in the Desktop Notification Specification. To actually display the
4173 notifications, B<notification-daemon> is required and B<collectd> has to be
4174 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4175 environment variables have to be set correctly) and the D-Bus message bus.
4176
4177 The Desktop Notification Specification can be found at
4178 L<http://www.galago-project.org/specs/notification/>.
4179
4180 =over 4
4181
4182 =item B<OkayTimeout> I<timeout>
4183
4184 =item B<WarningTimeout> I<timeout>
4185
4186 =item B<FailureTimeout> I<timeout>
4187
4188 Set the I<timeout>, in milliseconds, after which to expire the notification
4189 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4190 been specified, the displayed notification will not be closed at all - the
4191 user has to do so herself. These options default to 5000. If a negative number
4192 has been specified, the default is used as well.
4193
4194 =back
4195
4196 =head2 Plugin C<notify_email>
4197
4198 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4199 configured email address.
4200
4201 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4202
4203 Available configuration options:
4204
4205 =over 4
4206
4207 =item B<From> I<Address>
4208
4209 Email address from which the emails should appear to come from.
4210
4211 Default: C<root@localhost>
4212
4213 =item B<Recipient> I<Address>
4214
4215 Configures the email address(es) to which the notifications should be mailed.
4216 May be repeated to send notifications to multiple addresses.
4217
4218 At least one B<Recipient> must be present for the plugin to work correctly.
4219
4220 =item B<SMTPServer> I<Hostname>
4221
4222 Hostname of the SMTP server to connect to.
4223
4224 Default: C<localhost>
4225
4226 =item B<SMTPPort> I<Port>
4227
4228 TCP port to connect to.
4229
4230 Default: C<25>
4231
4232 =item B<SMTPUser> I<Username>
4233
4234 Username for ASMTP authentication. Optional.
4235
4236 =item B<SMTPPassword> I<Password>
4237
4238 Password for ASMTP authentication. Optional.
4239
4240 =item B<Subject> I<Subject>
4241
4242 Subject-template to use when sending emails. There must be exactly two
4243 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4244 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4245 with the hostname.
4246
4247 Default: C<Collectd notify: %s@%s>
4248
4249 =back
4250
4251 =head2 Plugin C<ntpd>
4252
4253 =over 4
4254
4255 =item B<Host> I<Hostname>
4256
4257 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4258
4259 =item B<Port> I<Port>
4260
4261 UDP-Port to connect to. Defaults to B<123>.
4262
4263 =item B<ReverseLookups> B<true>|B<false>
4264
4265 Sets whether or not to perform reverse lookups on peers. Since the name or
4266 IP-address may be used in a filename it is recommended to disable reverse
4267 lookups. The default is to do reverse lookups to preserve backwards
4268 compatibility, though.
4269
4270 =item B<IncludeUnitID> B<true>|B<false>
4271
4272 When a peer is a refclock, include the unit ID in the I<type instance>.
4273 Defaults to B<false> for backward compatibility.
4274
4275 If two refclock peers use the same driver and this is B<false>, the plugin will
4276 try to write simultaneous measurements from both to the same type instance.
4277 This will result in error messages in the log and only one set of measurements
4278 making it through.
4279
4280 =back
4281
4282 =head2 Plugin C<nut>
4283
4284 =over 4
4285
4286 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4287
4288 Add a UPS to collect data from. The format is identical to the one accepted by
4289 L<upsc(8)>.
4290
4291 =back
4292
4293 =head2 Plugin C<olsrd>
4294
4295 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4296 the Optimized Link State Routing daemon and reads information about the current
4297 state of the meshed network.
4298
4299 The following configuration options are understood:
4300
4301 =over 4
4302
4303 =item B<Host> I<Host>
4304
4305 Connect to I<Host>. Defaults to B<"localhost">.
4306
4307 =item B<Port> I<Port>
4308
4309 Specifies the port to connect to. This must be a string, even if you give the
4310 port as a number rather than a service name. Defaults to B<"2006">.
4311
4312 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4313
4314 Specifies what information to collect about links, i.E<nbsp>e. direct
4315 connections of the daemon queried. If set to B<No>, no information is
4316 collected. If set to B<Summary>, the number of links and the average of all
4317 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4318 If set to B<Detail> LQ and NLQ are collected per link.
4319
4320 Defaults to B<Detail>.
4321
4322 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4323
4324 Specifies what information to collect about routes of the daemon queried. If
4325 set to B<No>, no information is collected. If set to B<Summary>, the number of
4326 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4327 metric and ETX are collected per route.
4328
4329 Defaults to B<Summary>.
4330
4331 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4332
4333 Specifies what information to collect about the global topology. If set to
4334 B<No>, no information is collected. If set to B<Summary>, the number of links
4335 in the entire topology and the average I<link quality> (LQ) is calculated.
4336 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4337
4338 Defaults to B<Summary>.
4339
4340 =back
4341
4342 =head2 Plugin C<onewire>
4343
4344 B<EXPERIMENTAL!> See notes below.
4345
4346 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4347 L<http://owfs.org/> to read sensors connected via the onewire bus.
4348
4349 It can be used in two possible modes - standard or advanced.
4350
4351 In the standard mode only temperature sensors (sensors with the family code
4352 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4353 other sensors you would like to have included, please send a sort request to
4354 the mailing list. You can select sensors to be read or to be ignored depending
4355 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4356 walked and all sensors are read.
4357
4358 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4359 experimental, below.
4360
4361 In the advanced mode you can configure any sensor to be read (only numerical
4362 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4363 In this mode you have to list all the sensors. Neither default bus walk nor
4364 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4365 the path automatically and should produce compatible structure with the "standard"
4366 mode (basically the path is expected as for example
4367 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4368 "F10FCA000800" and the rest after the slash is considered the type - here
4369 "temperature").
4370 There are two advantages to this mode - you can access virtually any sensor
4371 (not just temperature), select whether to use cached or directly read values
4372 and it is slighlty faster. The downside is more complex configuration.
4373
4374 The two modes are distinguished automatically by the format of the address.
4375 It is not possible to mix the two modes. Once a full path is detected in any
4376 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4377 (and as standard addresses will fail parsing they will be ignored).
4378
4379 =over 4
4380
4381 =item B<Device> I<Device>
4382
4383 Sets the device to read the values from. This can either be a "real" hardware
4384 device, such as a serial port or an USB port, or the address of the
4385 L<owserver(1)> socket, usually B<localhost:4304>.
4386
4387 Though the documentation claims to automatically recognize the given address
4388 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4389 with that version, the following configuration worked for us:
4390
4391   <Plugin onewire>
4392     Device "-s localhost:4304"
4393   </Plugin>
4394
4395 This directive is B<required> and does not have a default value.
4396
4397 =item B<Sensor> I<Sensor>
4398
4399 In the standard mode selects sensors to collect or to ignore
4400 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4401 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4402 and B<not> include the leading C<10.> family byte and point.
4403 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4404 sensors (see above) are read.
4405
4406 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4407 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4408 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4409
4410 As there can be multiple devices on the bus you can list multiple sensor (use
4411 multiple B<Sensor> elements).
4412
4413 =item B<IgnoreSelected> I<true>|I<false>
4414
4415 If no configuration is given, the B<onewire> plugin will collect data from all
4416 sensors found. This may not be practical, especially if sensors are added and
4417 removed regularly. Sometimes, however, it's easier/preferred to collect only
4418 specific sensors or all sensors I<except> a few specified ones. This option
4419 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4420 B<Sensor> is inverted: All selected interfaces are ignored and all other
4421 interfaces are collected.
4422
4423 Used only in the standard mode - see above.
4424
4425 =item B<Interval> I<Seconds>
4426
4427 Sets the interval in which all sensors should be read. If not specified, the
4428 global B<Interval> setting is used.
4429
4430 =back
4431
4432 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4433 work with big setups. It works with one sensor being attached to one
4434 controller, but as soon as you throw in a couple more senors and maybe a hub
4435 or two, reading all values will take more than ten seconds (the default
4436 interval). We will probably add some separate thread for reading the sensors
4437 and some cache or something like that, but it's not done yet. We will try to
4438 maintain backwards compatibility in the future, but we can't promise. So in
4439 short: If it works for you: Great! But keep in mind that the config I<might>
4440 change, though this is unlikely. Oh, and if you want to help improving this
4441 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4442
4443 =head2 Plugin C<openldap>
4444
4445 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4446 server correctly. The backend database C<monitor> needs to be loaded and
4447 working. See slapd-monitor(5) for the details.
4448
4449 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4450 blocks. Each block requires one string argument as the instance name. For
4451 example:
4452
4453  <Plugin "openldap">
4454    <Instance "foo">
4455      URL "ldap://localhost/"
4456    </Instance>
4457    <Instance "bar">
4458      URL "ldaps://localhost/"
4459    </Instance>
4460  </Plugin>
4461
4462 The instance name will be used as the I<plugin instance>. To emulate the old
4463 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4464 plugin to work correctly, each instance name must be unique. This is not
4465 enforced by the plugin and it is your responsibility to ensure it is.
4466
4467 The following options are accepted within each B<Instance> block:
4468
4469 =over 4
4470
4471 =item B<URL> I<ldap://host/binddn>
4472
4473 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4474 I<mandatory>.
4475
4476 =item B<StartTLS> B<true|false>
4477
4478 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4479 Disabled by default.
4480
4481 =item B<VerifyHost> B<true|false>
4482
4483 Enables or disables peer host name verification. If enabled, the plugin checks
4484 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4485 certificate matches the host name provided by the B<URL> option. If this
4486 identity check fails, the connection is aborted. Enabled by default.
4487
4488 =item B<CACert> I<File>
4489
4490 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4491 may possibly need this option. What CA certificates are checked by default
4492 depends on the distribution you use and can be changed with the usual ldap
4493 client configuration mechanisms. See ldap.conf(5) for the details.
4494
4495 =item B<Timeout> I<Seconds>
4496
4497 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4498 an infinite timeout.
4499
4500 =item B<Version> I<Version>
4501
4502 An integer which sets the LDAP protocol version number to use when connecting
4503 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4504
4505 =back
4506
4507 =head2 Plugin C<openvpn>
4508
4509 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4510 traffic statistics about connected clients.
4511
4512 To set up OpenVPN to write to the status file periodically, use the
4513 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4514 you need to set the required format, too. This is done by setting
4515 B<--status-version> to B<2>.
4516
4517 So, in a nutshell you need:
4518
4519   openvpn $OTHER_OPTIONS \
4520     --status "/var/run/openvpn-status" 10 \
4521     --status-version 2
4522
4523 Available options:
4524
4525 =over 4
4526
4527 =item B<StatusFile> I<File>
4528
4529 Specifies the location of the status file.
4530
4531 =item B<ImprovedNamingSchema> B<true>|B<false>
4532
4533 When enabled, the filename of the status file will be used as plugin instance
4534 and the client's "common name" will be used as type instance. This is required
4535 when reading multiple status files. Enabling this option is recommended, but to
4536 maintain backwards compatibility this option is disabled by default.
4537
4538 =item B<CollectCompression> B<true>|B<false>
4539
4540 Sets whether or not statistics about the compression used by OpenVPN should be
4541 collected. This information is only available in I<single> mode. Enabled by
4542 default.
4543
4544 =item B<CollectIndividualUsers> B<true>|B<false>
4545
4546 Sets whether or not traffic information is collected for each connected client
4547 individually. If set to false, currently no traffic data is collected at all
4548 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4549
4550 =item B<CollectUserCount> B<true>|B<false>
4551
4552 When enabled, the number of currently connected clients or users is collected.
4553 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4554 can be configured independently from that option. Defaults to B<false>.
4555
4556 =back
4557
4558 =head2 Plugin C<oracle>
4559
4560 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4561 Oracle® Database and lets you execute SQL statements there. It is very similar
4562 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4563 plugin's documentation above for details.
4564
4565   <Plugin oracle>
4566     <Query "out_of_stock">
4567       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4568       <Result>
4569         Type "gauge"
4570         # InstancePrefix "foo"
4571         InstancesFrom "category"
4572         ValuesFrom "value"
4573       </Result>
4574     </Query>
4575     <Database "product_information">
4576       ConnectID "db01"
4577       Username "oracle"
4578       Password "secret"
4579       Query "out_of_stock"
4580     </Database>
4581   </Plugin>
4582
4583 =head3 B<Query> blocks
4584
4585 The Query blocks are handled identically to the Query blocks of the "dbi"
4586 plugin. Please see its documentation above for details on how to specify
4587 queries.
4588
4589 =head3 B<Database> blocks
4590
4591 Database blocks define a connection to a database and which queries should be
4592 sent to that database. Each database needs a "name" as string argument in the
4593 starting tag of the block. This name will be used as "PluginInstance" in the
4594 values submitted to the daemon. Other than that, that name is not used.
4595
4596 =over 4
4597
4598 =item B<ConnectID> I<ID>
4599
4600 Defines the "database alias" or "service name" to connect to. Usually, these
4601 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4602
4603 =item B<Host> I<Host>
4604
4605 Hostname to use when dispatching values for this database. Defaults to using
4606 the global hostname of the I<collectd> instance.
4607
4608 =item B<Username> I<Username>
4609
4610 Username used for authentication.
4611
4612 =item B<Password> I<Password>
4613
4614 Password used for authentication.
4615
4616 =item B<Query> I<QueryName>
4617
4618 Associates the query named I<QueryName> with this database connection. The
4619 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4620 blocks you want to refer to must be placed above the database block you want to
4621 refer to them from.
4622
4623 =back
4624
4625 =head2 Plugin C<perl>
4626
4627 This plugin embeds a Perl-interpreter into collectd and provides an interface
4628 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4629
4630 =head2 Plugin C<pinba>
4631
4632 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4633 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4634 PHP-based webpage has been delivered, the extension will send a UDP packet
4635 containing timing information, peak memory usage and so on. The plugin will
4636 wait for such packets, parse them and account the provided information, which
4637 is then dispatched to the daemon once per interval.
4638
4639 Synopsis:
4640
4641  <Plugin pinba>
4642    Address "::0"
4643    Port "30002"
4644    # Overall statistics for the website.
4645    <View "www-total">
4646      Server "www.example.com"
4647    </View>
4648    # Statistics for www-a only
4649    <View "www-a">
4650      Host "www-a.example.com"
4651      Server "www.example.com"
4652    </View>
4653    # Statistics for www-b only
4654    <View "www-b">
4655      Host "www-b.example.com"
4656      Server "www.example.com"
4657    </View>
4658  </Plugin>
4659
4660 The plugin provides the following configuration options:
4661
4662 =over 4
4663
4664 =item B<Address> I<Node>
4665
4666 Configures the address used to open a listening socket. By default, plugin will
4667 bind to the I<any> address C<::0>.
4668
4669 =item B<Port> I<Service>
4670
4671 Configures the port (service) to bind to. By default the default Pinba port
4672 "30002" will be used. The option accepts service names in addition to port
4673 numbers and thus requires a I<string> argument.
4674
4675 =item E<lt>B<View> I<Name>E<gt> block
4676
4677 The packets sent by the Pinba extension include the hostname of the server, the
4678 server name (the name of the virtual host) and the script that was executed.
4679 Using B<View> blocks it is possible to separate the data into multiple groups
4680 to get more meaningful statistics. Each packet is added to all matching groups,
4681 so that a packet may be accounted for more than once.
4682
4683 =over 4
4684
4685 =item B<Host> I<Host>
4686
4687 Matches the hostname of the system the webserver / script is running on. This
4688 will contain the result of the L<gethostname(2)> system call. If not
4689 configured, all hostnames will be accepted.
4690
4691 =item B<Server> I<Server>
4692
4693 Matches the name of the I<virtual host>, i.e. the contents of the
4694 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4695 server names will be accepted.
4696
4697 =item B<Script> I<Script>
4698
4699 Matches the name of the I<script name>, i.e. the contents of the
4700 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4701 script names will be accepted.
4702
4703 =back
4704
4705 =back
4706
4707 =head2 Plugin C<ping>
4708
4709 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4710 configured hosts periodically and measures the network latency. Whenever the
4711 C<read> function of the plugin is called, it submits the average latency, the
4712 standard deviation and the drop rate for each host.
4713
4714 Available configuration options:
4715
4716 =over 4
4717
4718 =item B<Host> I<IP-address>
4719
4720 Host to ping periodically. This option may be repeated several times to ping
4721 multiple hosts.
4722
4723 =item B<Interval> I<Seconds>
4724
4725 Sets the interval in which to send ICMP echo packets to the configured hosts.
4726 This is B<not> the interval in which statistics are queries from the plugin but
4727 the interval in which the hosts are "pinged". Therefore, the setting here
4728 should be smaller than or equal to the global B<Interval> setting. Fractional
4729 times, such as "1.24" are allowed.
4730
4731 Default: B<1.0>
4732
4733 =item B<Timeout> I<Seconds>
4734
4735 Time to wait for a response from the host to which an ICMP packet had been
4736 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4737 to be down or the packet to be dropped. This setting must be smaller than the
4738 B<Interval> setting above for the plugin to work correctly. Fractional
4739 arguments are accepted.
4740
4741 Default: B<0.9>
4742
4743 =item B<TTL> I<0-255>
4744
4745 Sets the Time-To-Live of generated ICMP packets.
4746
4747 =item B<SourceAddress> I<host>
4748
4749 Sets the source address to use. I<host> may either be a numerical network
4750 address or a network hostname.
4751
4752 =item B<Device> I<name>
4753
4754 Sets the outgoing network device to be used. I<name> has to specify an
4755 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4756 operating systems.
4757
4758 =item B<MaxMissed> I<Packets>
4759
4760 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4761 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4762
4763 Default: B<-1> (disabled)
4764
4765 =back
4766
4767 =head2 Plugin C<postgresql>
4768
4769 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4770 keeps a persistent connection to all configured databases and tries to
4771 reconnect if the connection has been interrupted. A database is configured by
4772 specifying a B<Database> block as described below. The default statistics are
4773 collected from PostgreSQL's B<statistics collector> which thus has to be
4774 enabled for this plugin to work correctly. This should usually be the case by
4775 default. See the section "The Statistics Collector" of the B<PostgreSQL
4776 Documentation> for details.
4777
4778 By specifying custom database queries using a B<Query> block as described
4779 below, you may collect any data that is available from some PostgreSQL
4780 database. This way, you are able to access statistics of external daemons
4781 which are available in a PostgreSQL database or use future or special
4782 statistics provided by PostgreSQL without the need to upgrade your collectd
4783 installation.
4784
4785 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4786 PostgreSQL databases as well. This has been implemented in a generic way. You
4787 need to specify an SQL statement which will then be executed by collectd in
4788 order to write the data (see below for details). The benefit of that approach
4789 is that there is no fixed database layout. Rather, the layout may be optimized
4790 for the current setup.
4791
4792 The B<PostgreSQL Documentation> manual can be found at
4793 L<http://www.postgresql.org/docs/manuals/>.
4794
4795   <Plugin postgresql>
4796     <Query magic>
4797       Statement "SELECT magic FROM wizard WHERE host = $1;"
4798       Param hostname
4799       <Result>
4800         Type gauge
4801         InstancePrefix "magic"
4802         ValuesFrom magic
4803       </Result>
4804     </Query>
4805
4806     <Query rt36_tickets>
4807       Statement "SELECT COUNT(type) AS count, type \
4808                         FROM (SELECT CASE \
4809                                      WHEN resolved = 'epoch' THEN 'open' \
4810                                      ELSE 'resolved' END AS type \
4811                                      FROM tickets) type \
4812                         GROUP BY type;"
4813       <Result>
4814         Type counter
4815         InstancePrefix "rt36_tickets"
4816         InstancesFrom "type"
4817         ValuesFrom "count"
4818       </Result>
4819     </Query>
4820
4821     <Writer sqlstore>
4822       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4823       StoreRates true
4824     </Writer>
4825
4826     <Database foo>
4827       Host "hostname"
4828       Port "5432"
4829       User "username"
4830       Password "secret"
4831       SSLMode "prefer"
4832       KRBSrvName "kerberos_service_name"
4833       Query magic
4834     </Database>
4835
4836     <Database bar>
4837       Interval 300
4838       Service "service_name"
4839       Query backend # predefined
4840       Query rt36_tickets
4841     </Database>
4842
4843     <Database qux>
4844       # ...
4845       Writer sqlstore
4846       CommitInterval 10
4847     </Database>
4848   </Plugin>
4849
4850 The B<Query> block defines one database query which may later be used by a
4851 database definition. It accepts a single mandatory argument which specifies
4852 the name of the query. The names of all queries have to be unique (see the
4853 B<MinVersion> and B<MaxVersion> options below for an exception to this
4854 rule). The following configuration options are available to define the query:
4855
4856 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4857 blocks define how to handle the values returned from the query. They define
4858 which column holds which value and how to dispatch that value to the daemon.
4859 Multiple B<Result> blocks may be used to extract multiple values from a single
4860 query.
4861
4862 =over 4
4863
4864 =item B<Statement> I<sql query statement>
4865
4866 Specify the I<sql query statement> which the plugin should execute. The string
4867 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4868 first, second, etc. parameter. The value of the parameters is specified by the
4869 B<Param> configuration option - see below for details. To include a literal
4870 B<$> character followed by a number, surround it with single quotes (B<'>).
4871
4872 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4873 allowed. Note, however, that only a single command may be used. Semicolons are
4874 allowed as long as a single non-empty command has been specified only.
4875
4876 The returned lines will be handled separately one after another.
4877
4878 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4879
4880 Specify the parameters which should be passed to the SQL query. The parameters
4881 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4882 they appear in the configuration file. The value of the parameter is
4883 determined depending on the value of the B<Param> option as follows:
4884
4885 =over 4
4886
4887 =item I<hostname>
4888
4889 The configured hostname of the database connection. If a UNIX domain socket is
4890 used, the parameter expands to "localhost".
4891
4892 =item I<database>
4893
4894 The name of the database of the current connection.
4895
4896 =item I<instance>
4897
4898 The name of the database plugin instance. See the B<Instance> option of the
4899 database specification below for details.
4900
4901 =item I<username>
4902
4903 The username used to connect to the database.
4904
4905 =item I<interval>
4906
4907 The interval with which this database is queried (as specified by the database
4908 specific or global B<Interval> options).
4909
4910 =back
4911
4912 Please note that parameters are only supported by PostgreSQL's protocol
4913 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4914
4915 =item B<Type> I<type>
4916
4917 The I<type> name to be used when dispatching the values. The type describes
4918 how to handle the data and where to store it. See L<types.db(5)> for more
4919 details on types and their configuration. The number and type of values (as
4920 selected by the B<ValuesFrom> option) has to match the type of the given name.
4921
4922 This option is required inside a B<Result> block.
4923
4924 =item B<InstancePrefix> I<prefix>
4925
4926 =item B<InstancesFrom> I<column0> [I<column1> ...]
4927
4928 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4929 B<InstancePrefix> defines a static prefix that will be prepended to all type
4930 instances. B<InstancesFrom> defines the column names whose values will be used
4931 to create the type instance. Multiple values will be joined together using the
4932 hyphen (C<->) as separation character.
4933
4934 The plugin itself does not check whether or not all built instances are
4935 different. It is your responsibility to assure that each is unique.
4936
4937 Both options are optional. If none is specified, the type instance will be
4938 empty.
4939
4940 =item B<ValuesFrom> I<column0> [I<column1> ...]
4941
4942 Names the columns whose content is used as the actual data for the data sets
4943 that are dispatched to the daemon. How many such columns you need is
4944 determined by the B<Type> setting as explained above. If you specify too many
4945 or not enough columns, the plugin will complain about that and no data will be
4946 submitted to the daemon.
4947
4948 The actual data type, as seen by PostgreSQL, is not that important as long as
4949 it represents numbers. The plugin will automatically cast the values to the
4950 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4951 L<strtod(3)> functions, so anything supported by those functions is supported
4952 by the plugin as well.
4953
4954 This option is required inside a B<Result> block and may be specified multiple
4955 times. If multiple B<ValuesFrom> options are specified, the columns are read
4956 in the given order.
4957
4958 =item B<MinVersion> I<version>
4959
4960 =item B<MaxVersion> I<version>
4961
4962 Specify the minimum or maximum version of PostgreSQL that this query should be
4963 used with. Some statistics might only be available with certain versions of
4964 PostgreSQL. This allows you to specify multiple queries with the same name but
4965 which apply to different versions, thus allowing you to use the same
4966 configuration in a heterogeneous environment.
4967
4968 The I<version> has to be specified as the concatenation of the major, minor
4969 and patch-level versions, each represented as two-decimal-digit numbers. For
4970 example, version 8.2.3 will become 80203.
4971
4972 =back
4973
4974 The following predefined queries are available (the definitions can be found
4975 in the F<postgresql_default.conf> file which, by default, is available at
4976 C<I<prefix>/share/collectd/>):
4977
4978 =over 4
4979
4980 =item B<backends>
4981
4982 This query collects the number of backends, i.E<nbsp>e. the number of
4983 connected clients.
4984
4985 =item B<transactions>
4986
4987 This query collects the numbers of committed and rolled-back transactions of
4988 the user tables.
4989
4990 =item B<queries>
4991
4992 This query collects the numbers of various table modifications (i.E<nbsp>e.
4993 insertions, updates, deletions) of the user tables.
4994
4995 =item B<query_plans>
4996
4997 This query collects the numbers of various table scans and returned tuples of
4998 the user tables.
4999
5000 =item B<table_states>
5001
5002 This query collects the numbers of live and dead rows in the user tables.
5003
5004 =item B<disk_io>
5005
5006 This query collects disk block access counts for user tables.
5007
5008 =item B<disk_usage>
5009
5010 This query collects the on-disk size of the database in bytes.
5011
5012 =back
5013
5014 In addition, the following detailed queries are available by default. Please
5015 note that each of those queries collects information B<by table>, thus,
5016 potentially producing B<a lot> of data. For details see the description of the
5017 non-by_table queries above.
5018
5019 =over 4
5020
5021 =item B<queries_by_table>
5022
5023 =item B<query_plans_by_table>
5024
5025 =item B<table_states_by_table>
5026
5027 =item B<disk_io_by_table>
5028
5029 =back
5030
5031 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5032 mandatory argument specifying the name of the writer. This will then be used
5033 in the B<Database> specification in order to activate the writer instance. The
5034 names of all writers have to be unique. The following options may be
5035 specified:
5036
5037 =over 4
5038
5039 =item B<Statement> I<sql statement>
5040
5041 This mandatory option specifies the SQL statement that will be executed for
5042 each submitted value. A single SQL statement is allowed only. Anything after
5043 the first semicolon will be ignored.
5044
5045 Nine parameters will be passed to the statement and should be specified as
5046 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5047 values are made available through those parameters:
5048
5049 =over 4
5050
5051 =item B<$1>
5052
5053 The timestamp of the queried value as a floating point number.
5054
5055 =item B<$2>
5056
5057 The hostname of the queried value.
5058
5059 =item B<$3>
5060
5061 The plugin name of the queried value.
5062
5063 =item B<$4>
5064
5065 The plugin instance of the queried value. This value may be B<NULL> if there
5066 is no plugin instance.
5067
5068 =item B<$5>
5069
5070 The type of the queried value (cf. L<types.db(5)>).
5071
5072 =item B<$6>
5073
5074 The type instance of the queried value. This value may be B<NULL> if there is
5075 no type instance.
5076
5077 =item B<$7>
5078
5079 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5080 sources of the submitted value-list).
5081
5082 =item B<$8>
5083
5084 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5085 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5086 B<StoreRates> is enabled (which is the default, see below), all types will be
5087 C<gauge>.
5088
5089 =item B<$9>
5090
5091 An array of the submitted values. The dimensions of the value name and value
5092 arrays match.
5093
5094 =back
5095
5096 In general, it is advisable to create and call a custom function in the
5097 PostgreSQL database for this purpose. Any procedural language supported by
5098 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5099 for details).
5100
5101 =item B<StoreRates> B<false>|B<true>
5102
5103 If set to B<true> (the default), convert counter values to rates. If set to
5104 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5105 number.
5106
5107 =back
5108
5109 The B<Database> block defines one PostgreSQL database for which to collect
5110 statistics. It accepts a single mandatory argument which specifies the
5111 database name. None of the other options are required. PostgreSQL will use
5112 default values as documented in the section "CONNECTING TO A DATABASE" in the
5113 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5114 the user collectd is run as and special environment variables. See the manpage
5115 for details.
5116
5117 =over 4
5118
5119 =item B<Interval> I<seconds>
5120
5121 Specify the interval with which the database should be queried. The default is
5122 to use the global B<Interval> setting.
5123
5124 =item B<CommitInterval> I<seconds>
5125
5126 This option may be used for database connections which have "writers" assigned
5127 (see above). If specified, it causes a writer to put several updates into a
5128 single transaction. This transaction will last for the specified amount of
5129 time. By default, each update will be executed in a separate transaction. Each
5130 transaction generates a fair amount of overhead which can, thus, be reduced by
5131 activating this option. The draw-back is, that data covering the specified
5132 amount of time will be lost, for example, if a single statement within the
5133 transaction fails or if the database server crashes.
5134
5135 =item B<Instance> I<name>
5136
5137 Specify the plugin instance name that should be used instead of the database
5138 name (which is the default, if this option has not been specified). This
5139 allows to query multiple databases of the same name on the same host (e.g.
5140 when running multiple database server versions in parallel).
5141
5142 =item B<Host> I<hostname>
5143
5144 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5145 value begins with a slash, it is interpreted as the directory name in which to
5146 look for the UNIX domain socket.
5147
5148 This option is also used to determine the hostname that is associated with a
5149 collected data set. If it has been omitted or either begins with with a slash
5150 or equals B<localhost> it will be replaced with the global hostname definition
5151 of collectd. Any other value will be passed literally to collectd when
5152 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5153
5154 =item B<Port> I<port>
5155
5156 Specify the TCP port or the local UNIX domain socket file extension of the
5157 server.
5158
5159 =item B<User> I<username>
5160
5161 Specify the username to be used when connecting to the server.
5162
5163 =item B<Password> I<password>
5164
5165 Specify the password to be used when connecting to the server.
5166
5167 =item B<ExpireDelay> I<delay>
5168
5169 Skip expired values in query output.
5170
5171 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5172
5173 Specify whether to use an SSL connection when contacting the server. The
5174 following modes are supported:
5175
5176 =over 4
5177
5178 =item I<disable>
5179
5180 Do not use SSL at all.
5181
5182 =item I<allow>
5183
5184 First, try to connect without using SSL. If that fails, try using SSL.
5185
5186 =item I<prefer> (default)
5187
5188 First, try to connect using SSL. If that fails, try without using SSL.
5189
5190 =item I<require>
5191
5192 Use SSL only.
5193
5194 =back
5195
5196 =item B<Instance> I<name>
5197
5198 Specify the plugin instance name that should be used instead of the database
5199 name (which is the default, if this option has not been specified). This
5200 allows to query multiple databases of the same name on the same host (e.g.
5201 when running multiple database server versions in parallel).
5202
5203 =item B<KRBSrvName> I<kerberos_service_name>
5204
5205 Specify the Kerberos service name to use when authenticating with Kerberos 5
5206 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5207 B<PostgreSQL Documentation> for details.
5208
5209 =item B<Service> I<service_name>
5210
5211 Specify the PostgreSQL service name to use for additional parameters. That
5212 service has to be defined in F<pg_service.conf> and holds additional
5213 connection parameters. See the section "The Connection Service File" in the
5214 B<PostgreSQL Documentation> for details.
5215
5216 =item B<Query> I<query>
5217
5218 Specifies a I<query> which should be executed in the context of the database
5219 connection. This may be any of the predefined or user-defined queries. If no
5220 such option is given, it defaults to "backends", "transactions", "queries",
5221 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5222 has been specified). Else, the specified queries are used only.
5223
5224 =item B<Writer> I<writer>
5225
5226 Assigns the specified I<writer> backend to the database connection. This
5227 causes all collected data to be send to the database using the settings
5228 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5229 below for details on how to selectively send data to certain plugins).
5230
5231 Each writer will register a flush callback which may be used when having long
5232 transactions enabled (see the B<CommitInterval> option above). When issuing
5233 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5234 transaction will be committed right away. Two different kinds of flush
5235 callbacks are available with the C<postgresql> plugin:
5236
5237 =over 4
5238
5239 =item B<postgresql>
5240
5241 Flush all writer backends.
5242
5243 =item B<postgresql->I<database>
5244
5245 Flush all writers of the specified I<database> only.
5246
5247 =back
5248
5249 =back
5250
5251 =head2 Plugin C<powerdns>
5252
5253 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5254 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5255 values, many of which are probably meaningless to most users, but may be useful
5256 for some. So you may chose which values to collect, but if you don't, some
5257 reasonable defaults will be collected.
5258
5259   <Plugin "powerdns">
5260     <Server "server_name">
5261       Collect "latency"
5262       Collect "udp-answers" "udp-queries"
5263       Socket "/var/run/pdns.controlsocket"
5264     </Server>
5265     <Recursor "recursor_name">
5266       Collect "questions"
5267       Collect "cache-hits" "cache-misses"
5268       Socket "/var/run/pdns_recursor.controlsocket"
5269     </Recursor>
5270     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5271   </Plugin>
5272
5273 =over 4
5274
5275 =item B<Server> and B<Recursor> block
5276
5277 The B<Server> block defines one authoritative server to query, the B<Recursor>
5278 does the same for an recursing server. The possible options in both blocks are
5279 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5280 and is required.
5281
5282 =over 4
5283
5284 =item B<Collect> I<Field>
5285
5286 Using the B<Collect> statement you can select which values to collect. Here,
5287 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5288 C<dlg-only-drops>, C<answers10-100>.
5289
5290 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5291 When querying the server a C<SHOW *> command is issued in any case, because
5292 that's the only way of getting multiple values out of the server at once.
5293 collectd then picks out the values you have selected. When querying the
5294 recursor, a command is generated to query exactly these values. So if you
5295 specify invalid fields when querying the recursor, a syntax error may be
5296 returned by the daemon and collectd may not collect any values at all.
5297
5298 If no B<Collect> statement is given, the following B<Server> values will be
5299 collected:
5300
5301 =over 4
5302
5303 =item latency
5304
5305 =item packetcache-hit
5306
5307 =item packetcache-miss
5308
5309 =item packetcache-size
5310
5311 =item query-cache-hit
5312
5313 =item query-cache-miss
5314
5315 =item recursing-answers
5316
5317 =item recursing-questions
5318
5319 =item tcp-answers
5320
5321 =item tcp-queries
5322
5323 =item udp-answers
5324
5325 =item udp-queries
5326
5327 =back
5328
5329 The following B<Recursor> values will be collected by default:
5330
5331 =over 4
5332
5333 =item noerror-answers
5334
5335 =item nxdomain-answers
5336
5337 =item servfail-answers
5338
5339 =item sys-msec
5340
5341 =item user-msec
5342
5343 =item qa-latency
5344
5345 =item cache-entries
5346
5347 =item cache-hits
5348
5349 =item cache-misses
5350
5351 =item questions
5352
5353 =back
5354
5355 Please note that up to that point collectd doesn't know what values are
5356 available on the server and values that are added do not need a change of the
5357 mechanism so far. However, the values must be mapped to collectd's naming
5358 scheme, which is done using a lookup table that lists all known values. If
5359 values are added in the future and collectd does not know about them, you will
5360 get an error much like this:
5361
5362   powerdns plugin: submit: Not found in lookup table: foobar = 42
5363
5364 In this case please file a bug report with the collectd team.
5365
5366 =item B<Socket> I<Path>
5367
5368 Configures the path to the UNIX domain socket to be used when connecting to the
5369 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5370 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5371 will be used for the recursor.
5372
5373 =back
5374
5375 =item B<LocalSocket> I<Path>
5376
5377 Querying the recursor is done using UDP. When using UDP over UNIX domain
5378 sockets, the client socket needs a name in the file system, too. You can set
5379 this local name to I<Path> using the B<LocalSocket> option. The default is
5380 C<I<prefix>/var/run/collectd-powerdns>.
5381
5382 =back
5383
5384 =head2 Plugin C<processes>
5385
5386 =over 4
5387
5388 =item B<Process> I<Name>
5389
5390 Select more detailed statistics of processes matching this name. The statistics
5391 collected for these selected processes are size of the resident segment size
5392 (RSS), user- and system-time used, number of processes and number of threads,
5393 io data (where available) and minor and major pagefaults.
5394
5395 =item B<ProcessMatch> I<name> I<regex>
5396
5397 Similar to the B<Process> option this allows to select more detailed
5398 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5399 details). The statistics of all matching processes are summed up and
5400 dispatched to the daemon using the specified I<name> as an identifier. This
5401 allows to "group" several processes together. I<name> must not contain
5402 slashes.
5403
5404 =back
5405
5406 =head2 Plugin C<protocols>
5407
5408 Collects a lot of information about various network protocols, such as I<IP>,
5409 I<TCP>, I<UDP>, etc.
5410
5411 Available configuration options:
5412
5413 =over 4
5414
5415 =item B<Value> I<Selector>
5416
5417 Selects whether or not to select a specific value. The string being matched is
5418 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5419 plugin instance and I<ValueName> will be used as type instance. An example of
5420 the string being used would be C<Tcp:RetransSegs>.
5421
5422 You can use regular expressions to match a large number of values with just one
5423 configuration option. To select all "extended" I<TCP> values, you could use the
5424 following statement:
5425
5426   Value "/^TcpExt:/"
5427
5428 Whether only matched values are selected or all matched values are ignored
5429 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5430 If no value is configured at all, all values will be selected.
5431
5432 =item B<IgnoreSelected> B<true>|B<false>
5433
5434 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5435 matching values will be ignored.
5436
5437 =back
5438
5439 =head2 Plugin C<python>
5440
5441 This plugin embeds a Python-interpreter into collectd and provides an interface
5442 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5443
5444 =head2 Plugin C<routeros>
5445
5446 The C<routeros> plugin connects to a device running I<RouterOS>, the
5447 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5448 I<librouteros> to connect and reads information about the interfaces and
5449 wireless connections of the device. The configuration supports querying
5450 multiple routers:
5451
5452   <Plugin "routeros">
5453     <Router>
5454       Host "router0.example.com"
5455       User "collectd"
5456       Password "secr3t"
5457       CollectInterface true
5458       CollectCPULoad true
5459       CollectMemory true
5460     </Router>
5461     <Router>
5462       Host "router1.example.com"
5463       User "collectd"
5464       Password "5ecret"
5465       CollectInterface true
5466       CollectRegistrationTable true
5467       CollectDF true
5468       CollectDisk true
5469     </Router>
5470   </Plugin>
5471
5472 As you can see above, the configuration of the I<routeros> plugin consists of
5473 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5474 options are understood:
5475
5476 =over 4
5477
5478 =item B<Host> I<Host>
5479
5480 Hostname or IP-address of the router to connect to.
5481
5482 =item B<Port> I<Port>
5483
5484 Port name or port number used when connecting. If left unspecified, the default
5485 will be chosen by I<librouteros>, currently "8728". This option expects a
5486 string argument, even when a numeric port number is given.
5487
5488 =item B<User> I<User>
5489
5490 Use the user name I<User> to authenticate. Defaults to "admin".
5491
5492 =item B<Password> I<Password>
5493
5494 Set the password used to authenticate.
5495
5496 =item B<CollectInterface> B<true>|B<false>
5497
5498 When set to B<true>, interface statistics will be collected for all interfaces
5499 present on the device. Defaults to B<false>.
5500
5501 =item B<CollectRegistrationTable> B<true>|B<false>
5502
5503 When set to B<true>, information about wireless LAN connections will be
5504 collected. Defaults to B<false>.
5505
5506 =item B<CollectCPULoad> B<true>|B<false>
5507
5508 When set to B<true>, information about the CPU usage will be collected. The
5509 number is a dimensionless value where zero indicates no CPU usage at all.
5510 Defaults to B<false>.
5511
5512 =item B<CollectMemory> B<true>|B<false>
5513
5514 When enabled, the amount of used and free memory will be collected. How used
5515 memory is calculated is unknown, for example whether or not caches are counted
5516 as used space.
5517 Defaults to B<false>.
5518
5519 =item B<CollectDF> B<true>|B<false>
5520
5521 When enabled, the amount of used and free disk space will be collected.
5522 Defaults to B<false>.
5523
5524 =item B<CollectDisk> B<true>|B<false>
5525
5526 When enabled, the number of sectors written and bad blocks will be collected.
5527 Defaults to B<false>.
5528
5529 =back
5530
5531 =head2 Plugin C<redis>
5532
5533 The I<Redis plugin> connects to one or more Redis servers and gathers
5534 information about each server's state. For each server there is a I<Node> block
5535 which configures the connection parameters for this node.
5536
5537   <Plugin redis>
5538     <Node "example">
5539         Host "localhost"
5540         Port "6379"
5541         Timeout 2000
5542         <Query "LLEN myqueue">
5543           Type "queue_length"
5544           Instance "myqueue"
5545         <Query>
5546     </Node>
5547   </Plugin>
5548
5549 The information shown in the synopsis above is the I<default configuration>
5550 which is used by the plugin if no configuration is present.
5551
5552 =over 4
5553
5554 =item B<Node> I<Nodename>
5555
5556 The B<Node> block identifies a new Redis node, that is a new Redis instance
5557 running in an specified host and port. The name for node is a canonical
5558 identifier which is used as I<plugin instance>. It is limited to
5559 64E<nbsp>characters in length.
5560
5561 =item B<Host> I<Hostname>
5562
5563 The B<Host> option is the hostname or IP-address where the Redis instance is
5564 running on.
5565
5566 =item B<Port> I<Port>
5567
5568 The B<Port> option is the TCP port on which the Redis instance accepts
5569 connections. Either a service name of a port number may be given. Please note
5570 that numerical port numbers must be given as a string, too.
5571
5572 =item B<Password> I<Password>
5573
5574 Use I<Password> to authenticate when connecting to I<Redis>.
5575
5576 =item B<Timeout> I<Milliseconds>
5577
5578 The B<Timeout> option set the socket timeout for node response. Since the Redis
5579 read function is blocking, you should keep this value as low as possible. Keep
5580 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5581 than B<Interval> defined globally.
5582
5583 =item B<Query> I<Querystring>
5584
5585 The B<Query> block identifies a query to execute against the redis server.
5586 There may be an arbitrary number of queries to execute.
5587
5588 =item B<Type> I<Collectd type>
5589
5590 Within a query definition, a valid collectd type to use as when submitting
5591 the result of the query. When not supplied, will default to B<gauge>.
5592
5593 =item B<Instance> I<Type instance>
5594
5595 Within a query definition, an optional type instance to use when submitting
5596 the result of the query. When not supplied will default to the escaped
5597 command, up to 64 chars.
5598
5599 =back
5600
5601 =head2 Plugin C<rrdcached>
5602
5603 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5604 to store values to RRD files in an efficient manner. The combination of the
5605 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5606 way the C<rrdtool> plugin works (see below). The added abstraction layer
5607 provides a number of benefits, though: Because the cache is not within
5608 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5609 restarted. This results in much shorter (if any) gaps in graphs, especially
5610 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5611 daemon so that it can flush values to disk automatically when needed. This
5612 allows to integrate automated flushing of values into graphing solutions much
5613 more easily.
5614
5615 There are disadvantages, though: The daemon may reside on a different host, so
5616 it may not be possible for C<collectd> to create the appropriate RRD files
5617 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5618 different base directory, so relative paths may do weird stuff if you're not
5619 careful.
5620
5621 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5622 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5623 setting should be set to an absolute path, so that a changed base directory
5624 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5625
5626 =over 4
5627
5628 =item B<DaemonAddress> I<Address>
5629
5630 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5631 library. See L<rrdcached(1)> for details. Example:
5632
5633   <Plugin "rrdcached">
5634     DaemonAddress "unix:/var/run/rrdcached.sock"
5635   </Plugin>
5636
5637 =item B<DataDir> I<Directory>
5638
5639 Set the base directory in which the RRD files reside. If this is a relative
5640 path, it is relative to the working base directory of the C<rrdcached> daemon!
5641 Use of an absolute path is recommended.
5642
5643 =item B<CreateFiles> B<true>|B<false>
5644
5645 Enables or disables the creation of RRD files. If the daemon is not running
5646 locally, or B<DataDir> is set to a relative path, this will not work as
5647 expected. Default is B<true>.
5648
5649 =item B<CreateFilesAsync> B<false>|B<true>
5650
5651 When enabled, new RRD files are enabled asynchronously, using a separate thread
5652 that runs in the background. This prevents writes to block, which is a problem
5653 especially when many hundreds of files need to be created at once. However,
5654 since the purpose of creating the files asynchronously is I<not> to block until
5655 the file is available, values before the file is available will be discarded.
5656 When disabled (the default) files are created synchronously, blocking for a
5657 short while, while the file is being written.
5658
5659 =item B<StepSize> I<Seconds>
5660
5661 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5662 this setting is unset and the stepsize is set to the interval in which the data
5663 is collected. Do not use this option unless you absolutely have to for some
5664 reason. Setting this option may cause problems with the C<snmp plugin>, the
5665 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5666
5667 =item B<HeartBeat> I<Seconds>
5668
5669 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5670 in which case the heartbeat is set to twice the B<StepSize> which should equal
5671 the interval in which data is collected. Do not set this option unless you have
5672 a very good reason to do so.
5673
5674 =item B<RRARows> I<NumRows>
5675
5676 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5677 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5678 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5679 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5680 week, one month, and one year.
5681
5682 So for each timespan, it calculates how many PDPs need to be consolidated into
5683 one CDP by calculating:
5684   number of PDPs = timespan / (stepsize * rrarows)
5685
5686 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5687 default is 1200.
5688
5689 =item B<RRATimespan> I<Seconds>
5690
5691 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5692 more then one RRA. If this option is never used, the built-in default of (3600,
5693 86400, 604800, 2678400, 31622400) is used.
5694
5695 For more information on how RRA-sizes are calculated see B<RRARows> above.
5696
5697 =item B<XFF> I<Factor>
5698
5699 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5700 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5701 one (exclusive).
5702
5703 =item B<CollectStatistics> B<false>|B<true>
5704
5705 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5706 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5707
5708 Statistics are read via I<rrdcached>s socket using the STATS command.
5709 See L<rrdcached(1)> for details.
5710
5711 =back
5712
5713 =head2 Plugin C<rrdtool>
5714
5715 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5716 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5717 using these settings. If you don't want to dive into the depths of RRDtool, you
5718 can safely ignore these settings.
5719
5720 =over 4
5721
5722 =item B<DataDir> I<Directory>
5723
5724 Set the directory to store RRD files under. By default RRD files are generated
5725 beneath the daemon's working directory, i.e. the B<BaseDir>.
5726
5727 =item B<CreateFilesAsync> B<false>|B<true>
5728
5729 When enabled, new RRD files are enabled asynchronously, using a separate thread
5730 that runs in the background. This prevents writes to block, which is a problem
5731 especially when many hundreds of files need to be created at once. However,
5732 since the purpose of creating the files asynchronously is I<not> to block until
5733 the file is available, values before the file is available will be discarded.
5734 When disabled (the default) files are created synchronously, blocking for a
5735 short while, while the file is being written.
5736
5737 =item B<StepSize> I<Seconds>
5738
5739 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5740 this setting is unset and the stepsize is set to the interval in which the data
5741 is collected. Do not use this option unless you absolutely have to for some
5742 reason. Setting this option may cause problems with the C<snmp plugin>, the
5743 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5744
5745 =item B<HeartBeat> I<Seconds>
5746
5747 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5748 in which case the heartbeat is set to twice the B<StepSize> which should equal
5749 the interval in which data is collected. Do not set this option unless you have
5750 a very good reason to do so.
5751
5752 =item B<RRARows> I<NumRows>
5753
5754 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5755 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5756 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5757 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5758 week, one month, and one year.
5759
5760 So for each timespan, it calculates how many PDPs need to be consolidated into
5761 one CDP by calculating:
5762   number of PDPs = timespan / (stepsize * rrarows)
5763
5764 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5765 default is 1200.
5766
5767 =item B<RRATimespan> I<Seconds>
5768
5769 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5770 more then one RRA. If this option is never used, the built-in default of (3600,
5771 86400, 604800, 2678400, 31622400) is used.
5772
5773 For more information on how RRA-sizes are calculated see B<RRARows> above.
5774
5775 =item B<XFF> I<Factor>
5776
5777 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5778 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5779 one (exclusive).
5780
5781 =item B<CacheFlush> I<Seconds>
5782
5783 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5784 it writes all values for a certain RRD-file if the oldest value is older than
5785 (or equal to) the number of seconds specified. If some RRD-file is not updated
5786 anymore for some reason (the computer was shut down, the network is broken,
5787 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5788 entire cache is searched for entries older than B<CacheTimeout> seconds and
5789 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5790 does nothing under normal circumstances, this value should not be too small.
5791 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5792 normally do much harm either.
5793
5794 =item B<CacheTimeout> I<Seconds>
5795
5796 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5797 save values in a cache, as described above. Writing multiple values at once
5798 reduces IO-operations and thus lessens the load produced by updating the files.
5799 The trade off is that the graphs kind of "drag behind" and that more memory is
5800 used.
5801
5802 =item B<WritesPerSecond> I<Updates>
5803
5804 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5805 will run serious performance problems. The B<CacheFlush> setting and the
5806 internal update queue assert that collectd continues to work just fine even
5807 under heavy load, but the system may become very unresponsive and slow. This is
5808 a problem especially if you create graphs from the RRD files on the same
5809 machine, for example using the C<graph.cgi> script included in the
5810 C<contrib/collection3/> directory.
5811
5812 This setting is designed for very large setups. Setting this option to a value
5813 between 25 and 80 updates per second, depending on your hardware, will leave
5814 the server responsive enough to draw graphs even while all the cached values
5815 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5816 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5817 written as fast as possible, so that web frontends have up to date data when
5818 generating graphs.
5819
5820 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5821 updates per second, writing all values to disk will take approximately
5822 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5823 "collection3" you'll end up with a responsive and fast system, up to date
5824 graphs and basically a "backup" of your values every hour.
5825
5826 =item B<RandomTimeout> I<Seconds>
5827
5828 When set, the actual timeout for each value is chosen randomly between
5829 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5830 intention is to avoid high load situations that appear when many values timeout
5831 at the same time. This is especially a problem shortly after the daemon starts,
5832 because all values were added to the internal cache at roughly the same time.
5833
5834 =back
5835
5836 =head2 Plugin C<sensors>
5837
5838 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5839 that all the needed modules have to be loaded and lm_sensors has to be
5840 configured (most likely by editing F</etc/sensors.conf>. Read
5841 L<sensors.conf(5)> for details.
5842
5843 The B<lm_sensors> homepage can be found at
5844 L<http://secure.netroedge.com/~lm78/>.
5845
5846 =over 4
5847
5848 =item B<SensorConfigFile> I<File>
5849
5850 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5851 the library's default will be used.
5852
5853 =item B<Sensor> I<chip-bus-address/type-feature>
5854
5855 Selects the name of the sensor which you want to collect or ignore, depending
5856 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5857 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5858 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5859
5860 =item B<IgnoreSelected> I<true>|I<false>
5861
5862 If no configuration if given, the B<sensors>-plugin will collect data from all
5863 sensors. This may not be practical, especially for uninteresting sensors.
5864 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5865 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5866 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5867 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5868 and all other sensors are collected.
5869
5870 =back
5871
5872 =head2 Plugin C<sigrok>
5873
5874 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5875 supported by the L<sigrok|http://sigrok.org/> project.
5876
5877 B<Synopsis>
5878
5879  <Plugin sigrok>
5880    LogLevel 3
5881    <Device "AC Voltage">
5882       Driver "fluke-dmm"
5883       MinimumInterval 10
5884       Conn "/dev/ttyUSB2"
5885    </Device>
5886    <Device "Sound Level">
5887       Driver "cem-dt-885x"
5888       Conn "/dev/ttyUSB1"
5889    </Device>
5890  </Plugin>
5891
5892 =over 4
5893
5894 =item B<LogLevel> B<0-5>
5895
5896 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5897 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5898 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5899 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5900 their level, are always submitted to I<collectd> at its INFO log level.
5901
5902 =item E<lt>B<Device> I<Name>E<gt>
5903
5904 A sigrok-supported device, uniquely identified by this section's options. The
5905 I<Name> is passed to I<collectd> as the I<plugin instance>.
5906
5907 =item B<Driver> I<DriverName>
5908
5909 The sigrok driver to use for this device.
5910
5911 =item B<Conn> I<ConnectionSpec>
5912
5913 If the device cannot be auto-discovered, or more than one might be discovered
5914 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5915 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5916 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5917 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5918 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5919
5920 =item B<SerialComm> I<SerialSpec>
5921
5922 For serial devices with non-standard port settings, this option can be used
5923 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5924 This should not be necessary; drivers know how to communicate with devices they
5925 support.
5926
5927 =item B<MinimumInterval> I<Seconds>
5928
5929 Specifies the minimum time between measurement dispatches to I<collectd>, in
5930 seconds. Since some I<sigrok> supported devices can acquire measurements many
5931 times per second, it may be necessary to throttle these. For example, the
5932 I<RRD plugin> cannot process writes more than once per second.
5933
5934 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5935 device are always dispatched to I<collectd>. When throttled, unused
5936 measurements are discarded.
5937
5938 =back
5939
5940 =head2 Plugin C<smart>
5941
5942 The C<smart> plugin collects SMART information from physical
5943 disks. Values collectd include temperature, power cycle count, poweron
5944 time and bad sectors. Also, all SMART attributes are collected along
5945 with the normalized current value, the worst value, the threshold and
5946 a human readable value.
5947
5948 Using the following two options you can ignore some disks or configure the
5949 collection only of specific disks.
5950
5951 =over 4
5952
5953 =item B<Disk> I<Name>
5954
5955 Select the disk I<Name>. Whether it is collected or ignored depends on the
5956 B<IgnoreSelected> setting, see below. As with other plugins that use the
5957 daemon's ignorelist functionality, a string that starts and ends with a slash
5958 is interpreted as a regular expression. Examples:
5959
5960   Disk "sdd"
5961   Disk "/hda[34]/"
5962
5963 =item B<IgnoreSelected> B<true>|B<false>
5964
5965 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
5966 statements, are ignored or if all other disks are ignored. The behavior
5967 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
5968 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
5969 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
5970 is set to B<true>, all disks are collected B<except> the ones matched.
5971
5972 =back
5973
5974 =head2 Plugin C<snmp>
5975
5976 Since the configuration of the C<snmp plugin> is a little more complicated than
5977 other plugins, its documentation has been moved to an own manpage,
5978 L<collectd-snmp(5)>. Please see there for details.
5979
5980 =head2 Plugin C<statsd>
5981
5982 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5983 protocol and dispatches rates or other aggregates of these numbers
5984 periodically.
5985
5986 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5987 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5988 C<objects> respectively.
5989
5990 The following configuration options are valid:
5991
5992 =over 4
5993
5994 =item B<Host> I<Host>
5995
5996 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5997 "any" address, i.e. accept packets sent to any of the hosts addresses.
5998
5999 =item B<Port> I<Port>
6000
6001 UDP port to listen to. This can be either a service name or a port number.
6002 Defaults to C<8125>.
6003
6004 =item B<DeleteCounters> B<false>|B<true>
6005
6006 =item B<DeleteTimers> B<false>|B<true>
6007
6008 =item B<DeleteGauges> B<false>|B<true>
6009
6010 =item B<DeleteSets> B<false>|B<true>
6011
6012 These options control what happens if metrics are not updated in an interval.
6013 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6014 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6015 are unchanged. If set to B<True>, the such metrics are not dispatched and
6016 removed from the internal cache.
6017
6018 =item B<TimerPercentile> I<Percent>
6019
6020 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6021 that I<Percent> of all reported timers are smaller than or equal to the
6022 computed latency. This is useful for cutting off the long tail latency, as it's
6023 often done in I<Service Level Agreements> (SLAs).
6024
6025 Different percentiles can be calculated by setting this option several times.
6026 If none are specified, no percentiles are calculated / dispatched.
6027
6028 =item B<TimerLower> B<false>|B<true>
6029
6030 =item B<TimerUpper> B<false>|B<true>
6031
6032 =item B<TimerSum> B<false>|B<true>
6033
6034 =item B<TimerCount> B<false>|B<true>
6035
6036 Calculate and dispatch various values out of I<Timer> metrics received during
6037 an interval. If set to B<False>, the default, these values aren't calculated /
6038 dispatched.
6039
6040 =back
6041
6042 =head2 Plugin C<swap>
6043
6044 The I<Swap plugin> collects information about used and available swap space. On
6045 I<Linux> and I<Solaris>, the following options are available:
6046
6047 =over 4
6048
6049 =item B<ReportByDevice> B<false>|B<true>
6050
6051 Configures how to report physical swap devices. If set to B<false> (the
6052 default), the summary over all swap devices is reported only, i.e. the globally
6053 used and available space over all devices. If B<true> is configured, the used
6054 and available space of each device will be reported separately.
6055
6056 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6057 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6058
6059 =item B<ReportBytes> B<false>|B<true>
6060
6061 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6062 I<swap I/O> is reported in pages. This option is available under Linux only.
6063
6064 =item B<ValuesAbsolute> B<true>|B<false>
6065
6066 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6067 available and used. Defaults to B<true>.
6068
6069 =item B<ValuesPercentage> B<false>|B<true>
6070
6071 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6072 available and free. Defaults to B<false>.
6073
6074 This is useful for deploying I<collectd> in a heterogeneous environment, where
6075 swap sizes differ and you want to specify generic thresholds or similar.
6076
6077 =back
6078
6079 =head2 Plugin C<syslog>
6080
6081 =over 4
6082
6083 =item B<LogLevel> B<debug|info|notice|warning|err>
6084
6085 Sets the log-level. If, for example, set to B<notice>, then all events with
6086 severity B<notice>, B<warning>, or B<err> will be submitted to the
6087 syslog-daemon.
6088
6089 Please note that B<debug> is only available if collectd has been compiled with
6090 debugging support.
6091
6092 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6093
6094 Controls which notifications should be sent to syslog. The default behaviour is
6095 not to send any. Less severe notifications always imply logging more severe
6096 notifications: Setting this to B<OKAY> means all notifications will be sent to
6097 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6098 notifications but will dismiss B<OKAY> notifications. Setting this option to
6099 B<FAILURE> will only send failures to syslog.
6100
6101 =back
6102
6103 =head2 Plugin C<table>
6104
6105 The C<table plugin> provides generic means to parse tabular data and dispatch
6106 user specified values. Values are selected based on column numbers. For
6107 example, this plugin may be used to get values from the Linux L<proc(5)>
6108 filesystem or CSV (comma separated values) files.
6109
6110   <Plugin table>
6111     <Table "/proc/slabinfo">
6112       Instance "slabinfo"
6113       Separator " "
6114       <Result>
6115         Type gauge
6116         InstancePrefix "active_objs"
6117         InstancesFrom 0
6118         ValuesFrom 1
6119       </Result>
6120       <Result>
6121         Type gauge
6122         InstancePrefix "objperslab"
6123         InstancesFrom 0
6124         ValuesFrom 4
6125       </Result>
6126     </Table>
6127   </Plugin>
6128
6129 The configuration consists of one or more B<Table> blocks, each of which
6130 configures one file to parse. Within each B<Table> block, there are one or
6131 more B<Result> blocks, which configure which data to select and how to
6132 interpret it.
6133
6134 The following options are available inside a B<Table> block:
6135
6136 =over 4
6137
6138 =item B<Instance> I<instance>
6139
6140 If specified, I<instance> is used as the plugin instance. So, in the above
6141 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6142 filename of the table is used instead, with all special characters replaced
6143 with an underscore (C<_>).
6144
6145 =item B<Separator> I<string>
6146
6147 Any character of I<string> is interpreted as a delimiter between the different
6148 columns of the table. A sequence of two or more contiguous delimiters in the
6149 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6150 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6151 of a table - see its documentation for more details. This option is mandatory.
6152
6153 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6154 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6155 required because of collectd's config parsing.
6156
6157 =back
6158
6159 The following options are available inside a B<Result> block:
6160
6161 =over 4
6162
6163 =item B<Type> I<type>
6164
6165 Sets the type used to dispatch the values to the daemon. Detailed information
6166 about types and their configuration can be found in L<types.db(5)>. This
6167 option is mandatory.
6168
6169 =item B<InstancePrefix> I<prefix>
6170
6171 If specified, prepend I<prefix> to the type instance. If omitted, only the
6172 B<InstancesFrom> option is considered for the type instance.
6173
6174 =item B<InstancesFrom> I<column0> [I<column1> ...]
6175
6176 If specified, the content of the given columns (identified by the column
6177 number starting at zero) will be used to create the type instance for each
6178 row. Multiple values (and the instance prefix) will be joined together with
6179 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6180 option is considered for the type instance.
6181
6182 The plugin itself does not check whether or not all built instances are
6183 different. It’s your responsibility to assure that each is unique. This is
6184 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6185 sure that the table only contains one row.
6186
6187 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6188 will be empty.
6189
6190 =item B<ValuesFrom> I<column0> [I<column1> ...]
6191
6192 Specifies the columns (identified by the column numbers starting at zero)
6193 whose content is used as the actual data for the data sets that are dispatched
6194 to the daemon. How many such columns you need is determined by the B<Type>
6195 setting above. If you specify too many or not enough columns, the plugin will
6196 complain about that and no data will be submitted to the daemon. The plugin
6197 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6198 respectively, so anything supported by those functions is supported by the
6199 plugin as well. This option is mandatory.
6200
6201 =back
6202
6203 =head2 Plugin C<tail>
6204
6205 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6206 each line and dispatches found values. What is matched can be configured by the
6207 user using (extended) regular expressions, as described in L<regex(7)>.
6208
6209   <Plugin "tail">
6210     <File "/var/log/exim4/mainlog">
6211       Instance "exim"
6212       Interval 60
6213       <Match>
6214         Regex "S=([1-9][0-9]*)"
6215         DSType "CounterAdd"
6216         Type "ipt_bytes"
6217         Instance "total"
6218       </Match>
6219       <Match>
6220         Regex "\\<R=local_user\\>"
6221         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6222         DSType "CounterInc"
6223         Type "counter"
6224         Instance "local_user"
6225       </Match>
6226     </File>
6227   </Plugin>
6228
6229 The config consists of one or more B<File> blocks, each of which configures one
6230 logfile to parse. Within each B<File> block, there are one or more B<Match>
6231 blocks, which configure a regular expression to search for.
6232
6233 The B<Instance> option in the B<File> block may be used to set the plugin
6234 instance. So in the above example the plugin name C<tail-foo> would be used.
6235 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6236 next B<Instance> option. This way you can extract several plugin instances from
6237 one logfile, handy when parsing syslog and the like.
6238
6239 The B<Interval> option allows you to define the length of time between reads. If
6240 this is not set, the default Interval will be used.
6241
6242 Each B<Match> block has the following options to describe how the match should
6243 be performed:
6244
6245 =over 4
6246
6247 =item B<Regex> I<regex>
6248
6249 Sets the regular expression to use for matching against a line. The first
6250 subexpression has to match something that can be turned into a number by
6251 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6252 below. Because B<extended> regular expressions are used, you do not need to use
6253 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6254 collectd's config parsing you need to escape backslashes, though. So if you
6255 want to match literal parentheses you need to do the following:
6256
6257   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6258
6259 =item B<ExcludeRegex> I<regex>
6260
6261 Sets an optional regular expression to use for excluding lines from the match.
6262 An example which excludes all connections from localhost from the match:
6263
6264   ExcludeRegex "127\\.0\\.0\\.1"
6265
6266 =item B<DSType> I<Type>
6267
6268 Sets how the values are cumulated. I<Type> is one of:
6269
6270 =over 4
6271
6272 =item B<GaugeAverage>
6273
6274 Calculate the average.
6275
6276 =item B<GaugeMin>
6277
6278 Use the smallest number only.
6279
6280 =item B<GaugeMax>
6281
6282 Use the greatest number only.
6283
6284 =item B<GaugeLast>
6285
6286 Use the last number found.
6287
6288 =item B<CounterSet>
6289
6290 =item B<DeriveSet>
6291
6292 =item B<AbsoluteSet>
6293
6294 The matched number is a counter. Simply I<sets> the internal counter to this
6295 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6296
6297 =item B<GaugeAdd>
6298
6299 =item B<CounterAdd>
6300
6301 =item B<DeriveAdd>
6302
6303 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6304 matched number may be negative, which will effectively subtract from the
6305 internal counter.
6306
6307 =item B<GaugeInc>
6308
6309 =item B<CounterInc>
6310
6311 =item B<DeriveInc>
6312
6313 Increase the internal counter by one. These B<DSType> are the only ones that do
6314 not use the matched subexpression, but simply count the number of matched
6315 lines. Thus, you may use a regular expression without submatch in this case.
6316
6317 =back
6318
6319 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6320 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6321 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6322 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6323 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6324 case.
6325
6326 =item B<Type> I<Type>
6327
6328 Sets the type used to dispatch this value. Detailed information about types and
6329 their configuration can be found in L<types.db(5)>.
6330
6331 =item B<Instance> I<TypeInstance>
6332
6333 This optional setting sets the type instance to use.
6334
6335 =back
6336
6337 =head2 Plugin C<tail_csv>
6338
6339 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6340 written by I<Snort>.
6341
6342 B<Synopsis:>
6343
6344  <Plugin "tail_csv">
6345    <Metric "snort-dropped">
6346        Type "percent"
6347        Instance "dropped"
6348        Index 1
6349    </Metric>
6350    <File "/var/log/snort/snort.stats">
6351        Instance "snort-eth0"
6352        Interval 600
6353        Collect "snort-dropped"
6354    </File>
6355  </Plugin>
6356
6357 The configuration consists of one or more B<Metric> blocks that define an index
6358 into the line of the CSV file and how this value is mapped to I<collectd's>
6359 internal representation. These are followed by one or more B<Instance> blocks
6360 which configure which file to read, in which interval and which metrics to
6361 extract.
6362
6363 =over 4
6364
6365 =item E<lt>B<Metric> I<Name>E<gt>
6366
6367 The B<Metric> block configures a new metric to be extracted from the statistics
6368 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6369 only used inside the B<Instance> blocks to refer to this block, so you can use
6370 one B<Metric> block for multiple CSV files.
6371
6372 =over 4
6373
6374 =item B<Type> I<Type>
6375
6376 Configures which I<Type> to use when dispatching this metric. Types are defined
6377 in the L<types.db(5)> file, see the appropriate manual page for more
6378 information on specifying types. Only types with a single I<data source> are
6379 supported by the I<tail_csv plugin>. The information whether the value is an
6380 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6381 I<Type's> definition.
6382
6383 =item B<Instance> I<TypeInstance>
6384
6385 If set, I<TypeInstance> is used to populate the type instance field of the
6386 created value lists. Otherwise, no type instance is used.
6387
6388 =item B<ValueFrom> I<Index>
6389
6390 Configure to read the value from the field with the zero-based index I<Index>.
6391 If the value is parsed as signed integer, unsigned integer or double depends on
6392 the B<Type> setting, see above.
6393
6394 =back
6395
6396 =item E<lt>B<File> I<Path>E<gt>
6397
6398 Each B<File> block represents one CSV file to read. There must be at least one
6399 I<File> block but there can be multiple if you have multiple CSV files.
6400
6401 =over 4
6402
6403 =item B<Instance> I<PluginInstance>
6404
6405 Sets the I<plugin instance> used when dispatching the values.
6406
6407 =item B<Collect> I<Metric>
6408
6409 Specifies which I<Metric> to collect. This option must be specified at least
6410 once, and you can use this option multiple times to specify more than one
6411 metric to be extracted from this statistic file.
6412
6413 =item B<Interval> I<Seconds>
6414
6415 Configures the interval in which to read values from this instance / file.
6416 Defaults to the plugin's default interval.
6417
6418 =item B<TimeFrom> I<Index>
6419
6420 Rather than using the local time when dispatching a value, read the timestamp
6421 from the field with the zero-based index I<Index>. The value is interpreted as
6422 seconds since epoch. The value is parsed as a double and may be factional.
6423
6424 =back
6425
6426 =back
6427
6428 =head2 Plugin C<teamspeak2>
6429
6430 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6431 polls interesting global and virtual server data. The plugin can query only one
6432 physical server but unlimited virtual servers. You can use the following
6433 options to configure it:
6434
6435 =over 4
6436
6437 =item B<Host> I<hostname/ip>
6438
6439 The hostname or ip which identifies the physical server.
6440 Default: 127.0.0.1
6441
6442 =item B<Port> I<port>
6443
6444 The query port of the physical server. This needs to be a string.
6445 Default: "51234"
6446
6447 =item B<Server> I<port>
6448
6449 This option has to be added once for every virtual server the plugin should
6450 query. If you want to query the virtual server on port 8767 this is what the
6451 option would look like:
6452
6453   Server "8767"
6454
6455 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6456 use quotes around it! If no such statement is given only global information
6457 will be collected.
6458
6459 =back
6460
6461 =head2 Plugin C<ted>
6462
6463 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6464 measure power consumption. These devices are usually connected to a serial
6465 (RS232) or USB port. The plugin opens a configured device and tries to read the
6466 current energy readings. For more information on TED, visit
6467 L<http://www.theenergydetective.com/>.
6468
6469 Available configuration options:
6470
6471 =over 4
6472
6473 =item B<Device> I<Path>
6474
6475 Path to the device on which TED is connected. collectd will need read and write
6476 permissions on that file.
6477
6478 Default: B</dev/ttyUSB0>
6479
6480 =item B<Retries> I<Num>
6481
6482 Apparently reading from TED is not that reliable. You can therefore configure a
6483 number of retries here. You only configure the I<retries> here, to if you
6484 specify zero, one reading will be performed (but no retries if that fails); if
6485 you specify three, a maximum of four readings are performed. Negative values
6486 are illegal.
6487
6488 Default: B<0>
6489
6490 =back
6491
6492 =head2 Plugin C<tcpconns>
6493
6494 The C<tcpconns plugin> counts the number of currently established TCP
6495 connections based on the local port and/or the remote port. Since there may be
6496 a lot of connections the default if to count all connections with a local port,
6497 for which a listening socket is opened. You can use the following options to
6498 fine-tune the ports you are interested in:
6499
6500 =over 4
6501
6502 =item B<ListeningPorts> I<true>|I<false>
6503
6504 If this option is set to I<true>, statistics for all local ports for which a
6505 listening socket exists are collected. The default depends on B<LocalPort> and
6506 B<RemotePort> (see below): If no port at all is specifically selected, the
6507 default is to collect listening ports. If specific ports (no matter if local or
6508 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6509 the selected ports will be collected unless this option is set to I<true>
6510 specifically.
6511
6512 =item B<LocalPort> I<Port>
6513
6514 Count the connections to a specific local port. This can be used to see how
6515 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6516 You have to specify the port in numeric form, so for the mailserver example
6517 you'd need to set B<25>.
6518
6519 =item B<RemotePort> I<Port>
6520
6521 Count the connections to a specific remote port. This is useful to see how
6522 much a remote service is used. This is most useful if you want to know how many
6523 connections a local service has opened to remote services, e.E<nbsp>g. how many
6524 connections a mail server or news server has to other mail or news servers, or
6525 how many connections a web proxy holds to web servers. You have to give the
6526 port in numeric form.
6527
6528 =item B<AllPortsSummary> I<true>|I<false>
6529
6530 If this option is set to I<true> a summary of statistics from all connections
6531 are collectd. This option defaults to I<false>.
6532
6533 =back
6534
6535 =head2 Plugin C<thermal>
6536
6537 =over 4
6538
6539 =item B<ForceUseProcfs> I<true>|I<false>
6540
6541 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6542 C<sysfs> interface. If that is not available, the plugin falls back to the
6543 C<procfs> interface. By setting this option to I<true>, you can force the
6544 plugin to use the latter. This option defaults to I<false>.
6545
6546 =item B<Device> I<Device>
6547
6548 Selects the name of the thermal device that you want to collect or ignore,
6549 depending on the value of the B<IgnoreSelected> option. This option may be
6550 used multiple times to specify a list of devices.
6551
6552 =item B<IgnoreSelected> I<true>|I<false>
6553
6554 Invert the selection: If set to true, all devices B<except> the ones that
6555 match the device names specified by the B<Device> option are collected. By
6556 default only selected devices are collected if a selection is made. If no
6557 selection is configured at all, B<all> devices are selected.
6558
6559 =back
6560
6561 =head2 Plugin C<threshold>
6562
6563 The I<Threshold plugin> checks values collected or received by I<collectd>
6564 against a configurable I<threshold> and issues I<notifications> if values are
6565 out of bounds.
6566
6567 Documentation for this plugin is available in the L<collectd-threshold(5)>
6568 manual page.
6569
6570 =head2 Plugin C<tokyotyrant>
6571
6572 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6573 couple metrics: number of records, and database size on disk.
6574
6575 =over 4
6576
6577 =item B<Host> I<Hostname/IP>
6578
6579 The hostname or ip which identifies the server.
6580 Default: B<127.0.0.1>
6581
6582 =item B<Port> I<Service/Port>
6583
6584 The query port of the server. This needs to be a string, even if the port is
6585 given in its numeric form.
6586 Default: B<1978>
6587
6588 =back
6589
6590 =head2 Plugin C<unixsock>
6591
6592 =over 4
6593
6594 =item B<SocketFile> I<Path>
6595
6596 Sets the socket-file which is to be created.
6597
6598 =item B<SocketGroup> I<Group>
6599
6600 If running as root change the group of the UNIX-socket after it has been
6601 created. Defaults to B<collectd>.
6602
6603 =item B<SocketPerms> I<Permissions>
6604
6605 Change the file permissions of the UNIX-socket after it has been created. The
6606 permissions must be given as a numeric, octal value as you would pass to
6607 L<chmod(1)>. Defaults to B<0770>.
6608
6609 =item B<DeleteSocket> B<false>|B<true>
6610
6611 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6612 with the given name already exists. If I<collectd> crashes a socket file may be
6613 left over, preventing the daemon from opening a new socket when restarted.
6614 Since this is potentially dangerous, this defaults to B<false>.
6615
6616 =back
6617
6618 =head2 Plugin C<uuid>
6619
6620 This plugin, if loaded, causes the Hostname to be taken from the machine's
6621 UUID. The UUID is a universally unique designation for the machine, usually
6622 taken from the machine's BIOS. This is most useful if the machine is running in
6623 a virtual environment such as Xen, in which case the UUID is preserved across
6624 shutdowns and migration.
6625
6626 The following methods are used to find the machine's UUID, in order:
6627
6628 =over 4
6629
6630 =item
6631
6632 Check I</etc/uuid> (or I<UUIDFile>).
6633
6634 =item
6635
6636 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6637 present.
6638
6639 =item
6640
6641 Check for UUID from C<dmidecode> / SMBIOS.
6642
6643 =item
6644
6645 Check for UUID from Xen hypervisor.
6646
6647 =back
6648
6649 If no UUID can be found then the hostname is not modified.
6650
6651 =over 4
6652
6653 =item B<UUIDFile> I<Path>
6654
6655 Take the UUID from the given file (default I</etc/uuid>).
6656
6657 =back
6658
6659 =head2 Plugin C<varnish>
6660
6661 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6662 It collects a subset of the values displayed by L<varnishstat(1)>, and
6663 organizes them in categories which can be enabled or disabled. Currently only
6664 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6665 meaning of each metric can be found in L<varnish-counters(7)>.
6666
6667 Synopsis:
6668
6669  <Plugin "varnish">
6670    <Instance "example">
6671      CollectBackend     true
6672      CollectBan         false
6673      CollectCache       true
6674      CollectConnections true
6675      CollectDirectorDNS false
6676      CollectESI         false
6677      CollectFetch       false
6678      CollectHCB         false
6679      CollectObjects     false
6680      CollectPurge       false
6681      CollectSession     false
6682      CollectSHM         true
6683      CollectSMA         false
6684      CollectSMS         false
6685      CollectSM          false
6686      CollectStruct      false
6687      CollectTotals      false
6688      CollectUptime      false
6689      CollectVCL         false
6690      CollectVSM         false
6691      CollectWorkers     false
6692    </Instance>
6693  </Plugin>
6694
6695 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6696 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6697 will collectd statistics from the default "varnishd" instance (this should work
6698 fine in most cases).
6699
6700 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6701
6702 =over 4
6703
6704 =item B<CollectBackend> B<true>|B<false>
6705
6706 Back-end connection statistics, such as successful, reused,
6707 and closed connections. True by default.
6708
6709 =item B<CollectBan> B<true>|B<false>
6710
6711 Statistics about ban operations, such as number of bans added, retired, and
6712 number of objects tested against ban operations. Only available with Varnish
6713 3.x and above. False by default.
6714
6715 =item B<CollectCache> B<true>|B<false>
6716
6717 Cache hits and misses. True by default.
6718
6719 =item B<CollectConnections> B<true>|B<false>
6720
6721 Number of client connections received, accepted and dropped. True by default.
6722
6723 =item B<CollectDirectorDNS> B<true>|B<false>
6724
6725 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6726 default.
6727
6728 =item B<CollectESI> B<true>|B<false>
6729
6730 Edge Side Includes (ESI) parse statistics. False by default.
6731
6732 =item B<CollectFetch> B<true>|B<false>
6733
6734 Statistics about fetches (HTTP requests sent to the backend). False by default.
6735
6736 =item B<CollectHCB> B<true>|B<false>
6737
6738 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6739 divided into locked and unlocked look-ups. False by default.
6740
6741 =item B<CollectObjects> B<true>|B<false>
6742
6743 Statistics on cached objects: number of objects expired, nuked (prematurely
6744 expired), saved, moved, etc. False by default.
6745
6746 =item B<CollectPurge> B<true>|B<false>
6747
6748 Statistics about purge operations, such as number of purges added, retired, and
6749 number of objects tested against purge operations. Only available with Varnish
6750 2.x. False by default.
6751
6752 =item B<CollectSession> B<true>|B<false>
6753
6754 Client session statistics. Number of past and current sessions, session herd and
6755 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6756 metrics found in the Connections and Threads sections with previous versions of
6757 Varnish have been moved here.
6758
6759 =item B<CollectSHM> B<true>|B<false>
6760
6761 Statistics about the shared memory log, a memory region to store
6762 log messages which is flushed to disk when full. True by default.
6763
6764 =item B<CollectSMA> B<true>|B<false>
6765
6766 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6767 component is Solaris specific. Only available with Varnish 2.x. False by
6768 default.
6769
6770 =item B<CollectSMS> B<true>|B<false>
6771
6772 synth (synthetic content) storage statistics. This storage
6773 component is used internally only. False by default.
6774
6775 =item B<CollectSM> B<true>|B<false>
6776
6777 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6778 False by default.
6779
6780 =item B<CollectStruct> B<true>|B<false>
6781
6782 Current varnish internal state statistics. Number of current sessions, objects
6783 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6784 default.
6785
6786 =item B<CollectTotals> B<true>|B<false>
6787
6788 Collects overview counters, such as the number of sessions created,
6789 the number of requests and bytes transferred. False by default.
6790
6791 =item B<CollectUptime> B<true>|B<false>
6792
6793 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6794
6795 =item B<CollectVCL> B<true>|B<false>
6796
6797 Number of total (available + discarded) VCL (config files). False by default.
6798
6799 =item B<CollectVSM> B<true>|B<false>
6800
6801 Collect statistics about Varnish's shared memory usage (used by the logging and
6802 statistics subsystems). Only available with Varnish 4.x. False by default.
6803
6804 =item B<CollectWorkers> B<true>|B<false>
6805
6806 Collect statistics about worker threads. False by default.
6807
6808 =back
6809
6810 =head2 Plugin C<virt>
6811
6812 This plugin allows CPU, disk and network load to be collected for virtualized
6813 guests on the machine. This means that these metrics can be collected for guest
6814 systems without installing any software on them - I<collectd> only runs on the
6815 host system. The statistics are collected through libvirt
6816 (L<http://libvirt.org/>).
6817
6818 Only I<Connection> is required.
6819
6820 =over 4
6821
6822 =item B<Connection> I<uri>
6823
6824 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6825
6826  Connection "xen:///"
6827
6828 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6829
6830 =item B<RefreshInterval> I<seconds>
6831
6832 Refresh the list of domains and devices every I<seconds>. The default is 60
6833 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6834 the list of domains and devices to be refreshed on every iteration.
6835
6836 Refreshing the devices in particular is quite a costly operation, so if your
6837 virtualization setup is static you might consider increasing this. If this
6838 option is set to 0, refreshing is disabled completely.
6839
6840 =item B<Domain> I<name>
6841
6842 =item B<BlockDevice> I<name:dev>
6843
6844 =item B<InterfaceDevice> I<name:dev>
6845
6846 =item B<IgnoreSelected> B<true>|B<false>
6847
6848 Select which domains and devices are collected.
6849
6850 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6851 disk/network devices are collected.
6852
6853 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6854 domains and disk/network devices are ignored, while the rest are collected.
6855
6856 The domain name and device names may use a regular expression, if the name is
6857 surrounded by I</.../> and collectd was compiled with support for regexps.
6858
6859 The default is to collect statistics for all domains and all their devices.
6860
6861 Example:
6862
6863  BlockDevice "/:hdb/"
6864  IgnoreSelected "true"
6865
6866 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
6867 will be collected.
6868
6869 =item B<HostnameFormat> B<name|uuid|hostname|...>
6870
6871 When the virt plugin logs data, it sets the hostname of the collected data
6872 according to this setting. The default is to use the guest name as provided by
6873 the hypervisor, which is equal to setting B<name>.
6874
6875 B<uuid> means use the guest's UUID. This is useful if you want to track the
6876 same guest across migrations.
6877
6878 B<hostname> means to use the global B<Hostname> setting, which is probably not
6879 useful on its own because all guests will appear to have the same name.
6880
6881 You can also specify combinations of these fields. For example B<name uuid>
6882 means to concatenate the guest name and UUID (with a literal colon character
6883 between, thus I<"foo:1234-1234-1234-1234">).
6884
6885 =item B<InterfaceFormat> B<name>|B<address>
6886
6887 When the virt plugin logs interface data, it sets the name of the collected
6888 data according to this setting. The default is to use the path as provided by
6889 the hypervisor (the "dev" property of the target node), which is equal to
6890 setting B<name>.
6891
6892 B<address> means use the interface's mac address. This is useful since the
6893 interface path might change between reboots of a guest or across migrations.
6894
6895 =item B<PluginInstanceFormat> B<name|uuid>
6896
6897 When the virt plugin logs data, it sets the plugin_instance of the collected
6898 data according to this setting. The default is to use the guest name as provided
6899 by the hypervisor, which is equal to setting B<name>.
6900
6901 B<uuid> means use the guest's UUID.
6902
6903 =back
6904
6905 =head2 Plugin C<vmem>
6906
6907 The C<vmem> plugin collects information about the usage of virtual memory.
6908 Since the statistics provided by the Linux kernel are very detailed, they are
6909 collected very detailed. However, to get all the details, you have to switch
6910 them on manually. Most people just want an overview over, such as the number of
6911 pages read from swap space.
6912
6913 =over 4
6914
6915 =item B<Verbose> B<true>|B<false>
6916
6917 Enables verbose collection of information. This will start collecting page
6918 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6919 Part of these statistics are collected on a "per zone" basis.
6920
6921 =back
6922
6923 =head2 Plugin C<vserver>
6924
6925 This plugin doesn't have any options. B<VServer> support is only available for
6926 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6927 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6928 need to apply the patches and compile your own kernel, which will then provide
6929 the F</proc/virtual> filesystem that is required by this plugin.
6930
6931 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6932
6933 B<Note>: The traffic collected by this plugin accounts for the amount of
6934 traffic passing a socket which might be a lot less than the actual on-wire
6935 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6936 collect on-wire traffic you could, for example, use the logging facilities of
6937 iptables to feed data for the guest IPs into the iptables plugin.
6938
6939 =head2 Plugin C<write_graphite>
6940
6941 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6942 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6943 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6944 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6945 of at most 1428 bytes to minimize the number of network packets.
6946
6947 Synopsis:
6948
6949  <Plugin write_graphite>
6950    <Node "example">
6951      Host "localhost"
6952      Port "2003"
6953      Protocol "tcp"
6954      LogSendErrors true
6955      Prefix "collectd"
6956    </Node>
6957  </Plugin>
6958
6959 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6960 blocks. Inside the B<Node> blocks, the following options are recognized:
6961
6962 =over 4
6963
6964 =item B<Host> I<Address>
6965
6966 Hostname or address to connect to. Defaults to C<localhost>.
6967
6968 =item B<Port> I<Service>
6969
6970 Service name or port number to connect to. Defaults to C<2003>.
6971
6972 =item B<Protocol> I<String>
6973
6974 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6975
6976 =item B<LogSendErrors> B<false>|B<true>
6977
6978 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6979 If set to B<false>, it will not log the errors. This is especially useful when
6980 using Protocol UDP since many times we want to use the "fire-and-forget"
6981 approach and logging errors fills syslog with unneeded messages.
6982
6983 =item B<Prefix> I<String>
6984
6985 When set, I<String> is added in front of the host name. Dots and whitespace are
6986 I<not> escaped in this string (see B<EscapeCharacter> below).
6987
6988 =item B<Postfix> I<String>
6989
6990 When set, I<String> is appended to the host name. Dots and whitespace are
6991 I<not> escaped in this string (see B<EscapeCharacter> below).
6992
6993 =item B<EscapeCharacter> I<Char>
6994
6995 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6996 in the identifier. The B<EscapeCharacter> option determines which character
6997 dots, whitespace and control characters are replaced with. Defaults to
6998 underscore (C<_>).
6999
7000 =item B<StoreRates> B<false>|B<true>
7001
7002 If set to B<true> (the default), convert counter values to rates. If set to
7003 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7004 number.
7005
7006 =item B<SeparateInstances> B<false>|B<true>
7007
7008 If set to B<true>, the plugin instance and type instance will be in their own
7009 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7010 default), the plugin and plugin instance (and likewise the type and type
7011 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7012
7013 =item B<AlwaysAppendDS> B<false>|B<true>
7014
7015 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7016 identifier. If set to B<false> (the default), this is only done when there is
7017 more than one DS.
7018
7019 =back
7020
7021 =head2 Plugin C<write_tsdb>
7022
7023 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7024 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7025 state daemon that ingests metrics and stores them in HBase. The plugin uses
7026 I<TCP> over the "line based" protocol with a default port 4242. The data will
7027 be sent in blocks of at most 1428 bytes to minimize the number of network
7028 packets.
7029
7030 Synopsis:
7031
7032  <Plugin write_tsdb>
7033    <Node "example">
7034      Host "tsd-1.my.domain"
7035      Port "4242"
7036      HostTags "status=production"
7037    </Node>
7038  </Plugin>
7039
7040 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7041 blocks. Inside the B<Node> blocks, the following options are recognized:
7042
7043 =over 4
7044
7045 =item B<Host> I<Address>
7046
7047 Hostname or address to connect to. Defaults to C<localhost>.
7048
7049 =item B<Port> I<Service>
7050
7051 Service name or port number to connect to. Defaults to C<4242>.
7052
7053
7054 =item B<HostTags> I<String>
7055
7056 When set, I<HostTags> is added to the end of the metric. It is intended to be
7057 used for name=value pairs that the TSD will tag the metric with. Dots and
7058 whitespace are I<not> escaped in this string.
7059
7060 =item B<StoreRates> B<false>|B<true>
7061
7062 If set to B<true>, convert counter values to rates. If set to B<false>
7063 (the default) counter values are stored as is, as an increasing
7064 integer number.
7065
7066 =item B<AlwaysAppendDS> B<false>|B<true>
7067
7068 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7069 identifier. If set to B<false> (the default), this is only done when there is
7070 more than one DS.
7071
7072 =back
7073
7074 =head2 Plugin C<write_mongodb>
7075
7076 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7077 NoSQL database.
7078
7079 B<Synopsis:>
7080
7081  <Plugin "write_mongodb">
7082    <Node "default">
7083      Host "localhost"
7084      Port "27017"
7085      Timeout 1000
7086      StoreRates true
7087    </Node>
7088  </Plugin>
7089
7090 The plugin can send values to multiple instances of I<MongoDB> by specifying
7091 one B<Node> block for each instance. Within the B<Node> blocks, the following
7092 options are available:
7093
7094 =over 4
7095
7096 =item B<Host> I<Address>
7097
7098 Hostname or address to connect to. Defaults to C<localhost>.
7099
7100 =item B<Port> I<Service>
7101
7102 Service name or port number to connect to. Defaults to C<27017>.
7103
7104 =item B<Timeout> I<Milliseconds>
7105
7106 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7107 Setting this option to zero means no timeout, which is the default.
7108
7109 =item B<StoreRates> B<false>|B<true>
7110
7111 If set to B<true> (the default), convert counter values to rates. If set to
7112 B<false> counter values are stored as is, i.e. as an increasing integer
7113 number.
7114
7115 =item B<Database> I<Database>
7116
7117 =item B<User> I<User>
7118
7119 =item B<Password> I<Password>
7120
7121 Sets the information used when authenticating to a I<MongoDB> database. The
7122 fields are optional (in which case no authentication is attempted), but if you
7123 want to use authentication all three fields must be set.
7124
7125 =back
7126
7127 =head2 Plugin C<write_http>
7128
7129 This output plugin submits values to an HTTP server using POST requests and
7130 encoding metrics with JSON or using the C<PUTVAL> command described in
7131 L<collectd-unixsock(5)>.
7132
7133 Synopsis:
7134
7135  <Plugin "write_http">
7136    <Node "example">
7137      URL "http://example.com/post-collectd"
7138      User "collectd"
7139      Password "weCh3ik0"
7140      Format JSON
7141    </Node>
7142  </Plugin>
7143
7144 The plugin can send values to multiple HTTP servers by specifying one
7145 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7146 block, the following options are available:
7147
7148 =over 4
7149
7150 =item B<URL> I<URL>
7151
7152 URL to which the values are submitted to. Mandatory.
7153
7154 =item B<User> I<Username>
7155
7156 Optional user name needed for authentication.
7157
7158 =item B<Password> I<Password>
7159
7160 Optional password needed for authentication.
7161
7162 =item B<VerifyPeer> B<true>|B<false>
7163
7164 Enable or disable peer SSL certificate verification. See
7165 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7166
7167 =item B<VerifyHost> B<true|false>
7168
7169 Enable or disable peer host name verification. If enabled, the plugin checks if
7170 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7171 matches the host name provided by the B<URL> option. If this identity check
7172 fails, the connection is aborted. Obviously, only works when connecting to a
7173 SSL enabled server. Enabled by default.
7174
7175 =item B<CACert> I<File>
7176
7177 File that holds one or more SSL certificates. If you want to use HTTPS you will
7178 possibly need this option. What CA certificates come bundled with C<libcurl>
7179 and are checked by default depends on the distribution you use.
7180
7181 =item B<CAPath> I<Directory>
7182
7183 Directory holding one or more CA certificate files. You can use this if for
7184 some reason all the needed CA certificates aren't in the same file and can't be
7185 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7186 OpenSSL.
7187
7188 =item B<ClientKey> I<File>
7189
7190 File that holds the private key in PEM format to be used for certificate-based
7191 authentication.
7192
7193 =item B<ClientCert> I<File>
7194
7195 File that holds the SSL certificate to be used for certificate-based
7196 authentication.
7197
7198 =item B<ClientKeyPass> I<Password>
7199
7200 Password required to load the private key in B<ClientKey>.
7201
7202 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7203
7204 Define which SSL protocol version must be used. By default C<libcurl> will
7205 attempt to figure out the remote SSL protocol version. See
7206 L<curl_easy_setopt(3)> for more details.
7207
7208 =item B<Format> B<Command>|B<JSON>
7209
7210 Format of the output to generate. If set to B<Command>, will create output that
7211 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7212 create output in the I<JavaScript Object Notation> (JSON).
7213
7214 Defaults to B<Command>.
7215
7216 =item B<StoreRates> B<true|false>
7217
7218 If set to B<true>, convert counter values to rates. If set to B<false> (the
7219 default) counter values are stored as is, i.e. as an increasing integer number.
7220
7221 =item B<BufferSize> I<Bytes>
7222
7223 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7224 requests will be generated, but more metrics will be batched / metrics are
7225 cached for longer before being sent, introducing additional delay until they
7226 are available on the server side. I<Bytes> must be at least 1024 and cannot
7227 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7228 Defaults to C<4096>.
7229
7230 =item B<LowSpeedLimit> I<Bytes per Second>
7231
7232 Sets the minimal transfer rate in I<Bytes per Second> below which the
7233 connection with the HTTP server will be considered too slow and aborted. All
7234 the data submitted over this connection will probably be lost. Defaults to 0,
7235 which means no minimum transfer rate is enforced.
7236
7237 =item B<Timeout> I<Timeout>
7238
7239 Sets the maximum time in milliseconds given for HTTP POST operations to
7240 complete. When this limit is reached, the POST operation will be aborted, and
7241 all the data in the current send buffer will probably be lost. Defaults to 0,
7242 which means the connection never times out.
7243
7244 The C<write_http> plugin regularly submits the collected values to the HTTP
7245 server. How frequently this happens depends on how much data you are collecting
7246 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
7247 slightly below this interval, which you can estimate by monitoring the network
7248 traffic between collectd and the HTTP server.
7249
7250 =back
7251
7252 =head2 Plugin C<write_kafka>
7253
7254 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7255 queue.
7256 Synopsis:
7257
7258  <Plugin "write_kafka">
7259    Property "metadata.broker.list" "broker1:9092,broker2:9092"
7260    <Topic "collectd">
7261      Format JSON
7262    </Topic>
7263  </Plugin>
7264
7265 The following options are understood by the I<write_kafka plugin>:
7266
7267 =over 4
7268
7269 =item E<lt>B<Topic> I<Name>E<gt>
7270
7271 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7272 is given a unique I<Name> and specifies one kafka producer.
7273 Inside the B<Topic> block, the following per-topic options are
7274 understood:
7275
7276 =over 4
7277
7278 =item B<Property> I<String> I<String>
7279
7280 Configure the named property for the current topic. Properties are
7281 forwarded to the kafka producer library B<librdkafka>.
7282
7283 =item B<Key> I<String>
7284
7285 Use the specified string as a partioning key for the topic. Kafka breaks
7286 topic into partitions and guarantees that for a given topology, the same
7287 consumer will be used for a specific key. The special (case insensitive)
7288 string B<Random> can be used to specify that an arbitrary partition should
7289 be used.
7290
7291 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7292
7293 Selects the format in which messages are sent to the broker. If set to
7294 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7295 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7296
7297 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7298 an easy and straight forward exchange format.
7299
7300 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7301 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7302
7303 =item B<StoreRates> B<true>|B<false>
7304
7305 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7306 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7307 default), no conversion is performed. Otherwise the conversion is performed
7308 using the internal value cache.
7309
7310 Please note that currently this option is only used if the B<Format> option has
7311 been set to B<JSON>.
7312
7313 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7314
7315 A prefix can be added in the metric name when outputting in the I<Graphite>
7316 format. It's added before the I<Host> name.
7317 Metric name will be
7318 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>>
7319
7320 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7321
7322 A postfix can be added in the metric name when outputting in the I<Graphite>
7323 format. It's added after the I<Host> name.
7324 Metric name will be
7325 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>>
7326
7327 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7328
7329 Specify a character to replace dots (.) in the host part of the metric name.
7330 In I<Graphite> metric name, dots are used as separators between different
7331 metric parts (host, plugin, type).
7332 Default is C<_> (I<Underscore>).
7333
7334 =item B<GraphiteSeparateInstances> B<false>|B<true>
7335
7336 If set to B<true>, the plugin instance and type instance will be in their own
7337 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7338 default), the plugin and plugin instance (and likewise the type and type
7339 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7340
7341 =item B<StoreRates> B<true>|B<false>
7342
7343 If set to B<true> (the default), convert counter values to rates. If set to
7344 B<false> counter values are stored as is, i.e. as an increasing integer number.
7345
7346 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7347 converted values will have "rate" appended to the data source type, e.g.
7348 C<ds_type:derive:rate>.
7349
7350 =back
7351
7352 =item B<Property> I<String> I<String>
7353
7354 Configure the kafka producer through properties, you almost always will
7355 want to set B<metadata.broker.list> to your Kafka broker list.
7356
7357 =back
7358
7359 =head2 Plugin C<write_redis>
7360
7361 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7362
7363 Synopsis:
7364
7365   <Plugin "write_redis">
7366     <Node "example">
7367         Host "localhost"
7368         Port "6379"
7369         Timeout 1000
7370     </Node>
7371   </Plugin>
7372
7373 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7374 the timestamp as the score. Retrieving a date range can then be done using the
7375 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
7376 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7377 retrieved using the C<SMEMBERS> I<Redis> command. See
7378 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7379 details.
7380
7381 The information shown in the synopsis above is the I<default configuration>
7382 which is used by the plugin if no configuration is present.
7383
7384 The plugin can send values to multiple instances of I<Redis> by specifying
7385 one B<Node> block for each instance. Within the B<Node> blocks, the following
7386 options are available:
7387
7388 =over 4
7389
7390 =item B<Node> I<Nodename>
7391
7392 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7393 instance running in an specified host and port. The name for node is a
7394 canonical identifier which is used as I<plugin instance>. It is limited to
7395 64E<nbsp>characters in length.
7396
7397 =item B<Host> I<Hostname>
7398
7399 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7400 running on.
7401
7402 =item B<Port> I<Port>
7403
7404 The B<Port> option is the TCP port on which the Redis instance accepts
7405 connections. Either a service name of a port number may be given. Please note
7406 that numerical port numbers must be given as a string, too.
7407
7408 =item B<Timeout> I<Milliseconds>
7409
7410 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7411
7412 =back
7413
7414 =head2 Plugin C<write_riemann>
7415
7416 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7417 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7418 I<Riemann> using UDP packets.
7419
7420 Synopsis:
7421
7422  <Plugin "write_riemann">
7423    <Node "example">
7424      Host "localhost"
7425      Port "5555"
7426      Protocol UDP
7427      StoreRates true
7428      AlwaysAppendDS false
7429      TTLFactor 2.0
7430    </Node>
7431    Tag "foobar"
7432    Attribute "foo" "bar"
7433  </Plugin>
7434
7435 The following options are understood by the I<write_riemann plugin>:
7436
7437 =over 4
7438
7439 =item E<lt>B<Node> I<Name>E<gt>
7440
7441 The plugin's configuration consists of one or more B<Node> blocks. Each block
7442 is given a unique I<Name> and specifies one connection to an instance of
7443 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7444 understood:
7445
7446 =over 4
7447
7448 =item B<Host> I<Address>
7449
7450 Hostname or address to connect to. Defaults to C<localhost>.
7451
7452 =item B<Port> I<Service>
7453
7454 Service name or port number to connect to. Defaults to C<5555>.
7455
7456 =item B<Protocol> B<UDP>|B<TCP>
7457
7458 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7459 B<TCP>.
7460
7461 =item B<Batch> B<true>|B<false>
7462
7463 If set to B<true> and B<Protocol> is set to B<TCP>,
7464 events will be batched in memory and flushed at
7465 regular intervals or when B<BatchMaxSize> is exceeded.
7466
7467 Notifications are not batched and sent as soon as possible.
7468
7469 When enabled, it can occur that events get processed by the Riemann server
7470 close to or after their expiration time. Tune the B<TTLFactor> and
7471 B<BatchMaxSize> settings according to the amount of values collected, if this
7472 is an issue.
7473
7474 Defaults to true
7475
7476 =item B<BatchMaxSize> I<size>
7477
7478 Maximum payload size for a riemann packet. Defaults to 8192
7479
7480 =item B<StoreRates> B<true>|B<false>
7481
7482 If set to B<true> (the default), convert counter values to rates. If set to
7483 B<false> counter values are stored as is, i.e. as an increasing integer number.
7484
7485 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7486 converted values will have "rate" appended to the data source type, e.g.
7487 C<ds_type:derive:rate>.
7488
7489 =item B<AlwaysAppendDS> B<false>|B<true>
7490
7491 If set the B<true>, append the name of the I<Data Source> (DS) to the
7492 "service", i.e. the field that, together with the "host" field, uniquely
7493 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7494 only done when there is more than one DS.
7495
7496 =item B<TTLFactor> I<Factor>
7497
7498 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7499 event is considered active. I<collectd> populates this field based on the
7500 metrics interval setting. This setting controls the factor with which the
7501 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7502 know exactly what you're doing, you should only increase this setting from its
7503 default value.
7504
7505 =item B<Notifications> B<false>|B<true>
7506
7507 If set to B<true>, create riemann events for notifications. This is B<true>
7508 by default. When processing thresholds from write_riemann, it might prove
7509 useful to avoid getting notification events.
7510
7511 =item B<CheckThresholds> B<false>|B<true>
7512
7513 If set to B<true>, attach state to events based on thresholds defined
7514 in the B<Threshold> plugin. Defaults to B<false>.
7515
7516 =item B<EventServicePrefix> I<String>
7517
7518 Add the given string as a prefix to the event service name.
7519 If B<EventServicePrefix> not set or set to an empty string (""),
7520 no prefix will be used.
7521
7522 =back
7523
7524 =item B<Tag> I<String>
7525
7526 Add the given string as an additional tag to the metric being sent to
7527 I<Riemann>.
7528
7529 =item B<Attribute> I<String> I<String>
7530
7531 Consider the two given strings to be the key and value of an additional
7532 attribute for each metric being sent out to I<Riemann>.
7533
7534 =back
7535
7536 =head2 Plugin C<write_sensu>
7537
7538 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
7539 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
7540 a local I<Sensu> client using a TCP socket.
7541
7542 At the moment, the I<write_sensu plugin> does not send over a collectd_host
7543 parameter so it is not possible to use one collectd instance as a gateway for
7544 others. Each collectd host must pair with one I<Sensu> client.
7545
7546 Synopsis:
7547
7548  <Plugin "write_sensu">
7549    <Node "example">
7550      Host "localhost"
7551      Port "3030"
7552      StoreRates true
7553      AlwaysAppendDS false
7554      MetricHandler "influx"
7555      MetricHandler "default"
7556      NotificationHandler "flapjack"
7557      NotificationHandler "howling_monkey"
7558      Notifications true
7559    </Node>
7560    Tag "foobar"
7561    Attribute "foo" "bar"
7562  </Plugin>
7563
7564 The following options are understood by the I<write_sensu plugin>:
7565
7566 =over 4
7567
7568 =item E<lt>B<Node> I<Name>E<gt>
7569
7570 The plugin's configuration consists of one or more B<Node> blocks. Each block
7571 is given a unique I<Name> and specifies one connection to an instance of
7572 I<Sensu>. Inside the B<Node> block, the following per-connection options are
7573 understood:
7574
7575 =over 4
7576
7577 =item B<Host> I<Address>
7578
7579 Hostname or address to connect to. Defaults to C<localhost>.
7580
7581 =item B<Port> I<Service>
7582
7583 Service name or port number to connect to. Defaults to C<3030>.
7584
7585 =item B<StoreRates> B<true>|B<false>
7586
7587 If set to B<true> (the default), convert counter values to rates. If set to
7588 B<false> counter values are stored as is, i.e. as an increasing integer number.
7589
7590 This will be reflected in the C<collectd_data_source_type> tag: If
7591 B<StoreRates> is enabled, converted values will have "rate" appended to the
7592 data source type, e.g.  C<collectd_data_source_type:derive:rate>.
7593
7594 =item B<AlwaysAppendDS> B<false>|B<true>
7595
7596 If set the B<true>, append the name of the I<Data Source> (DS) to the
7597 "service", i.e. the field that, together with the "host" field, uniquely
7598 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
7599 only done when there is more than one DS.
7600
7601 =item B<Notifications> B<false>|B<true>
7602
7603 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
7604 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7605
7606 =item B<Metrics> B<false>|B<true>
7607
7608 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
7609 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7610
7611
7612 =item B<Separator> I<String>
7613
7614 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
7615
7616 =item B<MetricHandler> I<String>
7617
7618 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
7619 several of them, one per line. Defaults to no handler.
7620
7621 =item B<NotificationHandler> I<String>
7622
7623 Add a handler that will be set when notifications are sent to I<Sensu>. You can
7624 add several of them, one per line. Defaults to no handler.
7625
7626 =item B<EventServicePrefix> I<String>
7627
7628 Add the given string as a prefix to the event service name.
7629 If B<EventServicePrefix> not set or set to an empty string (""),
7630 no prefix will be used.
7631
7632 =back
7633
7634 =item B<Tag> I<String>
7635
7636 Add the given string as an additional tag to the metric being sent to
7637 I<Sensu>.
7638
7639 =item B<Attribute> I<String> I<String>
7640
7641 Consider the two given strings to be the key and value of an additional
7642 attribute for each metric being sent out to I<Sensu>.
7643
7644 =back
7645
7646 =head2 Plugin C<zookeeper>
7647
7648 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7649 using the mntr command.  It requires Zookeeper 3.4.0+ and access to the
7650 client port.
7651
7652 B<Synopsis:>
7653
7654  <Plugin "zookeeper">
7655    Host "127.0.0.1"
7656    Port "2181"
7657  </Plugin>
7658
7659 =over 4
7660
7661 =item B<Host> I<Address>
7662
7663 Hostname or address to connect to. Defaults to C<localhost>.
7664
7665 =item B<Port> I<Service>
7666
7667 Service name or port number to connect to. Defaults to C<2181>.
7668
7669 =back
7670
7671 =head1 THRESHOLD CONFIGURATION
7672
7673 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7674 we mean that the values are not only stored or sent somewhere, but that they
7675 are judged and, if a problem is recognized, acted upon. The only action
7676 collectd takes itself is to generate and dispatch a "notification". Plugins can
7677 register to receive notifications and perform appropriate further actions.
7678
7679 Since systems and what you expect them to do differ a lot, you can configure
7680 B<thresholds> for your values freely. This gives you a lot of flexibility but
7681 also a lot of responsibility.
7682
7683 Every time a value is out of range a notification is dispatched. This means
7684 that the idle percentage of your CPU needs to be less then the configured
7685 threshold only once for a notification to be generated. There's no such thing
7686 as a moving average or similar - at least not now.
7687
7688 Also, all values that match a threshold are considered to be relevant or
7689 "interesting". As a consequence collectd will issue a notification if they are
7690 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7691 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7692 "2" (the default) and some hosts sends it's CPU statistics to the server every
7693 60 seconds, a notification will be dispatched after about 120 seconds. It may
7694 take a little longer because the timeout is checked only once each B<Interval>
7695 on the server.
7696
7697 When a value comes within range again or is received after it was missing, an
7698 "OKAY-notification" is dispatched.
7699
7700 Here is a configuration example to get you started. Read below for more
7701 information.
7702
7703  <Plugin threshold>
7704    <Type "foo">
7705      WarningMin    0.00
7706      WarningMax 1000.00
7707      FailureMin    0.00
7708      FailureMax 1200.00
7709      Invert false
7710      Instance "bar"
7711    </Type>
7712
7713    <Plugin "interface">
7714      Instance "eth0"
7715      <Type "if_octets">
7716        FailureMax 10000000
7717        DataSource "rx"
7718      </Type>
7719    </Plugin>
7720
7721    <Host "hostname">
7722      <Type "cpu">
7723        Instance "idle"
7724        FailureMin 10
7725      </Type>
7726
7727      <Plugin "memory">
7728        <Type "memory">
7729          Instance "cached"
7730          WarningMin 100000000
7731        </Type>
7732      </Plugin>
7733    </Host>
7734  </Plugin>
7735
7736 There are basically two types of configuration statements: The C<Host>,
7737 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7738 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7739 C<Instance> option. You can combine the block by nesting the blocks, though
7740 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7741 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7742 C<Type> may not contain other blocks. If multiple blocks apply to the same
7743 value the most specific block is used.
7744
7745 The other statements specify the threshold to configure. They B<must> be
7746 included in a C<Type> block. Currently the following statements are recognized:
7747
7748 =over 4
7749
7750 =item B<FailureMax> I<Value>
7751
7752 =item B<WarningMax> I<Value>
7753
7754 Sets the upper bound of acceptable values. If unset defaults to positive
7755 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7756 will be created. If the value is greater than B<WarningMax> but less than (or
7757 equal to) B<FailureMax> a B<WARNING> notification will be created.
7758
7759 =item B<FailureMin> I<Value>
7760
7761 =item B<WarningMin> I<Value>
7762
7763 Sets the lower bound of acceptable values. If unset defaults to negative
7764 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7765 be created. If the value is less than B<WarningMin> but greater than (or equal
7766 to) B<FailureMin> a B<WARNING> notification will be created.
7767
7768 =item B<DataSource> I<DSName>
7769
7770 Some data sets have more than one "data source". Interesting examples are the
7771 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7772 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7773 system load data set, C<load>, even has three data sources: C<shortterm>,
7774 C<midterm>, and C<longterm>.
7775
7776 Normally, all data sources are checked against a configured threshold. If this
7777 is undesirable, or if you want to specify different limits for each data
7778 source, you can use the B<DataSource> option to have a threshold apply only to
7779 one data source.
7780
7781 =item B<Invert> B<true>|B<false>
7782
7783 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7784 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7785 B<WarningMax>) are not okay. Defaults to B<false>.
7786
7787 =item B<Persist> B<true>|B<false>
7788
7789 Sets how often notifications are generated. If set to B<true> one notification
7790 will be generated for each value that is out of the acceptable range. If set to
7791 B<false> (the default) then a notification is only generated if a value is out
7792 of range but the previous value was okay.
7793
7794 This applies to missing values, too: If set to B<true> a notification about a
7795 missing value is generated once every B<Interval> seconds. If set to B<false>
7796 only one such notification is generated until the value appears again.
7797
7798 =item B<Percentage> B<true>|B<false>
7799
7800 If set to B<true>, the minimum and maximum values given are interpreted as
7801 percentage value, relative to the other data sources. This is helpful for
7802 example for the "df" type, where you may want to issue a warning when less than
7803 5E<nbsp>% of the total space is available. Defaults to B<false>.
7804
7805 =item B<Hits> I<Number>
7806
7807 Delay creating the notification until the threshold has been passed I<Number>
7808 times. When a notification has been generated, or when a subsequent value is
7809 inside the threshold, the counter is reset. If, for example, a value is
7810 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7811 will be dispatched at most once every 30E<nbsp>seconds.
7812
7813 This is useful when short bursts are not a problem. If, for example, 100% CPU
7814 usage for up to a minute is normal (and data is collected every
7815 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7816
7817 =item B<Hysteresis> I<Number>
7818
7819 When set to non-zero, a hysteresis value is applied when checking minimum and
7820 maximum bounds. This is useful for values that increase slowly and fluctuate a
7821 bit while doing so. When these values come close to the threshold, they may
7822 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7823
7824 If, for example, the threshold is configures as
7825
7826   WarningMax 100.0
7827   Hysteresis 1.0
7828
7829 then a I<Warning> notification is created when the value exceeds I<101> and the
7830 corresponding I<Okay> notification is only created once the value falls below
7831 I<99>, thus avoiding the "flapping".
7832
7833 =back
7834
7835 =head1 FILTER CONFIGURATION
7836
7837 Starting with collectd 4.6 there is a powerful filtering infrastructure
7838 implemented in the daemon. The concept has mostly been copied from
7839 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7840 terminology, so that users that are familiar with iptables feel right at home.
7841
7842 =head2 Terminology
7843
7844 The following are the terms used in the remainder of the filter configuration
7845 documentation. For an ASCII-art schema of the mechanism, see
7846 L<"General structure"> below.
7847
7848 =over 4
7849
7850 =item B<Match>
7851
7852 A I<match> is a criteria to select specific values. Examples are, of course, the
7853 name of the value or it's current value.
7854
7855 Matches are implemented in plugins which you have to load prior to using the
7856 match. The name of such plugins starts with the "match_" prefix.
7857
7858 =item B<Target>
7859
7860 A I<target> is some action that is to be performed with data. Such actions
7861 could, for example, be to change part of the value's identifier or to ignore
7862 the value completely.
7863
7864 Some of these targets are built into the daemon, see L<"Built-in targets">
7865 below. Other targets are implemented in plugins which you have to load prior to
7866 using the target. The name of such plugins starts with the "target_" prefix.
7867
7868 =item B<Rule>
7869
7870 The combination of any number of matches and at least one target is called a
7871 I<rule>. The target actions will be performed for all values for which B<all>
7872 matches apply. If the rule does not have any matches associated with it, the
7873 target action will be performed for all values.
7874
7875 =item B<Chain>
7876
7877 A I<chain> is a list of rules and possibly default targets. The rules are tried
7878 in order and if one matches, the associated target will be called. If a value
7879 is handled by a rule, it depends on the target whether or not any subsequent
7880 rules are considered or if traversal of the chain is aborted, see
7881 L<"Flow control"> below. After all rules have been checked, the default targets
7882 will be executed.
7883
7884 =back
7885
7886 =head2 General structure
7887
7888 The following shows the resulting structure:
7889
7890  +---------+
7891  ! Chain   !
7892  +---------+
7893       !
7894       V
7895  +---------+  +---------+  +---------+  +---------+
7896  ! Rule    !->! Match   !->! Match   !->! Target  !
7897  +---------+  +---------+  +---------+  +---------+
7898       !
7899       V
7900  +---------+  +---------+  +---------+
7901  ! Rule    !->! Target  !->! Target  !
7902  +---------+  +---------+  +---------+
7903       !
7904       V
7905       :
7906       :
7907       !
7908       V
7909  +---------+  +---------+  +---------+
7910  ! Rule    !->! Match   !->! Target  !
7911  +---------+  +---------+  +---------+
7912       !
7913       V
7914  +---------+
7915  ! Default !
7916  ! Target  !
7917  +---------+
7918
7919 =head2 Flow control
7920
7921 There are four ways to control which way a value takes through the filter
7922 mechanism:
7923
7924 =over 4
7925
7926 =item B<jump>
7927
7928 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7929 process the value with another chain. When the called chain finishes, usually
7930 the next target or rule after the jump is executed.
7931
7932 =item B<stop>
7933
7934 The stop condition, signaled for example by the built-in target B<stop>, causes
7935 all processing of the value to be stopped immediately.
7936
7937 =item B<return>
7938
7939 Causes processing in the current chain to be aborted, but processing of the
7940 value generally will continue. This means that if the chain was called via
7941 B<Jump>, the next target or rule after the jump will be executed. If the chain
7942 was not called by another chain, control will be returned to the daemon and it
7943 may pass the value to another chain.
7944
7945 =item B<continue>
7946
7947 Most targets will signal the B<continue> condition, meaning that processing
7948 should continue normally. There is no special built-in target for this
7949 condition.
7950
7951 =back
7952
7953 =head2 Synopsis
7954
7955 The configuration reflects this structure directly:
7956
7957  PostCacheChain "PostCache"
7958  <Chain "PostCache">
7959    <Rule "ignore_mysql_show">
7960      <Match "regex">
7961        Plugin "^mysql$"
7962        Type "^mysql_command$"
7963        TypeInstance "^show_"
7964      </Match>
7965      <Target "stop">
7966      </Target>
7967    </Rule>
7968    <Target "write">
7969      Plugin "rrdtool"
7970    </Target>
7971  </Chain>
7972
7973 The above configuration example will ignore all values where the plugin field
7974 is "mysql", the type is "mysql_command" and the type instance begins with
7975 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7976 default target of the chain. Since this chain is run after the value has been
7977 added to the cache, the MySQL C<show_*> command statistics will be available
7978 via the C<unixsock> plugin.
7979
7980 =head2 List of configuration options
7981
7982 =over 4
7983
7984 =item B<PreCacheChain> I<ChainName>
7985
7986 =item B<PostCacheChain> I<ChainName>
7987
7988 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7989 argument is the name of a I<chain> that should be executed before and/or after
7990 the values have been added to the cache.
7991
7992 To understand the implications, it's important you know what is going on inside
7993 I<collectd>. The following diagram shows how values are passed from the
7994 read-plugins to the write-plugins:
7995
7996    +---------------+
7997    !  Read-Plugin  !
7998    +-------+-------+
7999            !
8000  + - - - - V - - - - +
8001  : +---------------+ :
8002  : !   Pre-Cache   ! :
8003  : !     Chain     ! :
8004  : +-------+-------+ :
8005  :         !         :
8006  :         V         :
8007  : +-------+-------+ :  +---------------+
8008  : !     Cache     !--->!  Value Cache  !
8009  : !     insert    ! :  +---+---+-------+
8010  : +-------+-------+ :      !   !
8011  :         !   ,------------'   !
8012  :         V   V     :          V
8013  : +-------+---+---+ :  +-------+-------+
8014  : !  Post-Cache   +--->! Write-Plugins !
8015  : !     Chain     ! :  +---------------+
8016  : +---------------+ :
8017  :                   :
8018  :  dispatch values  :
8019  + - - - - - - - - - +
8020
8021 After the values are passed from the "read" plugins to the dispatch functions,
8022 the pre-cache chain is run first. The values are added to the internal cache
8023 afterwards. The post-cache chain is run after the values have been added to the
8024 cache. So why is it such a huge deal if chains are run before or after the
8025 values have been added to this cache?
8026
8027 Targets that change the identifier of a value list should be executed before
8028 the values are added to the cache, so that the name in the cache matches the
8029 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8030 this cache to receive a list of all available values. If you change the
8031 identifier after the value list has been added to the cache, this may easily
8032 lead to confusion, but it's not forbidden of course.
8033
8034 The cache is also used to convert counter values to rates. These rates are, for
8035 example, used by the C<value> match (see below). If you use the rate stored in
8036 the cache B<before> the new value is added, you will use the old, B<previous>
8037 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8038 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8039 command.
8040
8041 Last but not last, the B<stop> target makes a difference: If the pre-cache
8042 chain returns the stop condition, the value will not be added to the cache and
8043 the post-cache chain will not be run.
8044
8045 =item B<Chain> I<Name>
8046
8047 Adds a new chain with a certain name. This name can be used to refer to a
8048 specific chain, for example to jump to it.
8049
8050 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8051
8052 =item B<Rule> [I<Name>]
8053
8054 Adds a new rule to the current chain. The name of the rule is optional and
8055 currently has no meaning for the daemon.
8056
8057 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8058 must be at least one B<Target> block.
8059
8060 =item B<Match> I<Name>
8061
8062 Adds a match to a B<Rule> block. The name specifies what kind of match should
8063 be performed. Available matches depend on the plugins that have been loaded.
8064
8065 The arguments inside the B<Match> block are passed to the plugin implementing
8066 the match, so which arguments are valid here depends on the plugin being used.
8067 If you do not need any to pass any arguments to a match, you can use the
8068 shorter syntax:
8069
8070  Match "foobar"
8071
8072 Which is equivalent to:
8073
8074  <Match "foobar">
8075  </Match>
8076
8077 =item B<Target> I<Name>
8078
8079 Add a target to a rule or a default target to a chain. The name specifies what
8080 kind of target is to be added. Which targets are available depends on the
8081 plugins being loaded.
8082
8083 The arguments inside the B<Target> block are passed to the plugin implementing
8084 the target, so which arguments are valid here depends on the plugin being used.
8085 If you do not need any to pass any arguments to a target, you can use the
8086 shorter syntax:
8087
8088  Target "stop"
8089
8090 This is the same as writing:
8091
8092  <Target "stop">
8093  </Target>
8094
8095 =back
8096
8097 =head2 Built-in targets
8098
8099 The following targets are built into the core daemon and therefore need no
8100 plugins to be loaded:
8101
8102 =over 4
8103
8104 =item B<return>
8105
8106 Signals the "return" condition, see the L<"Flow control"> section above. This
8107 causes the current chain to stop processing the value and returns control to
8108 the calling chain. The calling chain will continue processing targets and rules
8109 just after the B<jump> target (see below). This is very similar to the
8110 B<RETURN> target of iptables, see L<iptables(8)>.
8111
8112 This target does not have any options.
8113
8114 Example:
8115
8116  Target "return"
8117
8118 =item B<stop>
8119
8120 Signals the "stop" condition, see the L<"Flow control"> section above. This
8121 causes processing of the value to be aborted immediately. This is similar to
8122 the B<DROP> target of iptables, see L<iptables(8)>.
8123
8124 This target does not have any options.
8125
8126 Example:
8127
8128  Target "stop"
8129
8130 =item B<write>
8131
8132 Sends the value to "write" plugins.
8133
8134 Available options:
8135
8136 =over 4
8137
8138 =item B<Plugin> I<Name>
8139
8140 Name of the write plugin to which the data should be sent. This option may be
8141 given multiple times to send the data to more than one write plugin. If the
8142 plugin supports multiple instances, the plugin's instance(s) must also be
8143 specified.
8144
8145 =back
8146
8147 If no plugin is explicitly specified, the values will be sent to all available
8148 write plugins.
8149
8150 Single-instance plugin example:
8151
8152  <Target "write">
8153    Plugin "rrdtool"
8154  </Target>
8155
8156 Multi-instance plugin example:
8157
8158  <Plugin "write_graphite">
8159    <Node "foo">
8160    ...
8161    </Node>
8162    <Node "bar">
8163    ...
8164    </Node>
8165  </Plugin>
8166   ...
8167  <Target "write">
8168    Plugin "write_graphite/foo"
8169  </Target>
8170
8171 =item B<jump>
8172
8173 Starts processing the rules of another chain, see L<"Flow control"> above. If
8174 the end of that chain is reached, or a stop condition is encountered,
8175 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
8176 next target or the next rule. This is similar to the B<-j> command line option
8177 of iptables, see L<iptables(8)>.
8178
8179 Available options:
8180
8181 =over 4
8182
8183 =item B<Chain> I<Name>
8184
8185 Jumps to the chain I<Name>. This argument is required and may appear only once.
8186
8187 =back
8188
8189 Example:
8190
8191  <Target "jump">
8192    Chain "foobar"
8193  </Target>
8194
8195 =back
8196
8197 =head2 Available matches
8198
8199 =over 4
8200
8201 =item B<regex>
8202
8203 Matches a value using regular expressions.
8204
8205 Available options:
8206
8207 =over 4
8208
8209 =item B<Host> I<Regex>
8210
8211 =item B<Plugin> I<Regex>
8212
8213 =item B<PluginInstance> I<Regex>
8214
8215 =item B<Type> I<Regex>
8216
8217 =item B<TypeInstance> I<Regex>
8218
8219 Match values where the given regular expressions match the various fields of
8220 the identifier of a value. If multiple regular expressions are given, B<all>
8221 regexen must match for a value to match.
8222
8223 =item B<Invert> B<false>|B<true>
8224
8225 When set to B<true>, the result of the match is inverted, i.e. all value lists
8226 where all regular expressions apply are not matched, all other value lists are
8227 matched. Defaults to B<false>.
8228
8229 =back
8230
8231 Example:
8232
8233  <Match "regex">
8234    Host "customer[0-9]+"
8235    Plugin "^foobar$"
8236  </Match>
8237
8238 =item B<timediff>
8239
8240 Matches values that have a time which differs from the time on the server.
8241
8242 This match is mainly intended for servers that receive values over the
8243 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8244 is very sensitive to the timestamp used when updating the RRD files. In
8245 particular, the time must be ever increasing. If a misbehaving client sends one
8246 packet with a timestamp far in the future, all further packets with a correct
8247 time will be ignored because of that one packet. What's worse, such corrupted
8248 RRD files are hard to fix.
8249
8250 This match lets one match all values B<outside> a specified time range
8251 (relative to the server's time), so you can use the B<stop> target (see below)
8252 to ignore the value, for example.
8253
8254 Available options:
8255
8256 =over 4
8257
8258 =item B<Future> I<Seconds>
8259
8260 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8261 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8262 non-zero.
8263
8264 =item B<Past> I<Seconds>
8265
8266 Matches all values that are I<behind> of the server's time by I<Seconds> or
8267 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8268 non-zero.
8269
8270 =back
8271
8272 Example:
8273
8274  <Match "timediff">
8275    Future  300
8276    Past   3600
8277  </Match>
8278
8279 This example matches all values that are five minutes or more ahead of the
8280 server or one hour (or more) lagging behind.
8281
8282 =item B<value>
8283
8284 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8285 values. If a data-set consists of more than one data-source, all data-sources
8286 must match the specified ranges for a positive match.
8287
8288 Available options:
8289
8290 =over 4
8291
8292 =item B<Min> I<Value>
8293
8294 Sets the smallest value which still results in a match. If unset, behaves like
8295 negative infinity.
8296
8297 =item B<Max> I<Value>
8298
8299 Sets the largest value which still results in a match. If unset, behaves like
8300 positive infinity.
8301
8302 =item B<Invert> B<true>|B<false>
8303
8304 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8305 no-match is returned and vice versa. Please note that the B<Invert> setting
8306 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8307 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8308
8309 =item B<DataSource> I<DSName> [I<DSName> ...]
8310
8311 Select one or more of the data sources. If no data source is configured, all
8312 data sources will be checked. If the type handled by the match does not have a
8313 data source of the specified name(s), this will always result in no match
8314 (independent of the B<Invert> setting).
8315
8316 =item B<Satisfy> B<Any>|B<All>
8317
8318 Specifies how checking with several data sources is performed. If set to
8319 B<Any>, the match succeeds if one of the data sources is in the configured
8320 range. If set to B<All> the match only succeeds if all data sources are within
8321 the configured range. Default is B<All>.
8322
8323 Usually B<All> is used for positive matches, B<Any> is used for negative
8324 matches. This means that with B<All> you usually check that all values are in a
8325 "good" range, while with B<Any> you check if any value is within a "bad" range
8326 (or outside the "good" range).
8327
8328 =back
8329
8330 Either B<Min> or B<Max>, but not both, may be unset.
8331
8332 Example:
8333
8334  # Match all values smaller than or equal to 100. Matches only if all data
8335  # sources are below 100.
8336  <Match "value">
8337    Max 100
8338    Satisfy "All"
8339  </Match>
8340
8341  # Match if the value of any data source is outside the range of 0 - 100.
8342  <Match "value">
8343    Min   0
8344    Max 100
8345    Invert true
8346    Satisfy "Any"
8347  </Match>
8348
8349 =item B<empty_counter>
8350
8351 Matches all values with one or more data sources of type B<COUNTER> and where
8352 all counter values are zero. These counters usually I<never> increased since
8353 they started existing (and are therefore uninteresting), or got reset recently
8354 or overflowed and you had really, I<really> bad luck.
8355
8356 Please keep in mind that ignoring such counters can result in confusing
8357 behavior: Counters which hardly ever increase will be zero for long periods of
8358 time. If the counter is reset for some reason (machine or service restarted,
8359 usually), the graph will be empty (NAN) for a long time. People may not
8360 understand why.
8361
8362 =item B<hashed>
8363
8364 Calculates a hash value of the host name and matches values according to that
8365 hash value. This makes it possible to divide all hosts into groups and match
8366 only values that are in a specific group. The intended use is in load
8367 balancing, where you want to handle only part of all data and leave the rest
8368 for other servers.
8369
8370 The hashing function used tries to distribute the hosts evenly. First, it
8371 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8372
8373   hash_value = 0;
8374   for (i = 0; host[i] != 0; i++)
8375     hash_value = (hash_value * 251) + host[i];
8376
8377 The constant 251 is a prime number which is supposed to make this hash value
8378 more random. The code then checks the group for this host according to the
8379 I<Total> and I<Match> arguments:
8380
8381   if ((hash_value % Total) == Match)
8382     matches;
8383   else
8384     does not match;
8385
8386 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8387 groups), then the least significant bit of the hash value will be the XOR of
8388 all least significant bits in the host name. One consequence is that when you
8389 have two hosts, "server0.example.com" and "server1.example.com", where the host
8390 name differs in one digit only and the digits differ by one, those hosts will
8391 never end up in the same group.
8392
8393 Available options:
8394
8395 =over 4
8396
8397 =item B<Match> I<Match> I<Total>
8398
8399 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8400 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8401 be smaller than I<Total>. I<Total> must be at least one, although only values
8402 greater than one really do make any sense.
8403
8404 You can repeat this option to match multiple groups, for example:
8405
8406   Match 3 7
8407   Match 5 7
8408
8409 The above config will divide the data into seven groups and match groups three
8410 and five. One use would be to keep every value on two hosts so that if one
8411 fails the missing data can later be reconstructed from the second host.
8412
8413 =back
8414
8415 Example:
8416
8417  # Operate on the pre-cache chain, so that ignored values are not even in the
8418  # global cache.
8419  <Chain "PreCache">
8420    <Rule>
8421      <Match "hashed">
8422        # Divide all received hosts in seven groups and accept all hosts in
8423        # group three.
8424        Match 3 7
8425      </Match>
8426      # If matched: Return and continue.
8427      Target "return"
8428    </Rule>
8429    # If not matched: Return and stop.
8430    Target "stop"
8431  </Chain>
8432
8433 =back
8434
8435 =head2 Available targets
8436
8437 =over 4
8438
8439 =item B<notification>
8440
8441 Creates and dispatches a notification.
8442
8443 Available options:
8444
8445 =over 4
8446
8447 =item B<Message> I<String>
8448
8449 This required option sets the message of the notification. The following
8450 placeholders will be replaced by an appropriate value:
8451
8452 =over 4
8453
8454 =item B<%{host}>
8455
8456 =item B<%{plugin}>
8457
8458 =item B<%{plugin_instance}>
8459
8460 =item B<%{type}>
8461
8462 =item B<%{type_instance}>
8463
8464 These placeholders are replaced by the identifier field of the same name.
8465
8466 =item B<%{ds:>I<name>B<}>
8467
8468 These placeholders are replaced by a (hopefully) human readable representation
8469 of the current rate of this data source. If you changed the instance name
8470 (using the B<set> or B<replace> targets, see below), it may not be possible to
8471 convert counter values to rates.
8472
8473 =back
8474
8475 Please note that these placeholders are B<case sensitive>!
8476
8477 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8478
8479 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8480 used.
8481
8482 =back
8483
8484 Example:
8485
8486   <Target "notification">
8487     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8488     Severity "WARNING"
8489   </Target>
8490
8491 =item B<replace>
8492
8493 Replaces parts of the identifier using regular expressions.
8494
8495 Available options:
8496
8497 =over 4
8498
8499 =item B<Host> I<Regex> I<Replacement>
8500
8501 =item B<Plugin> I<Regex> I<Replacement>
8502
8503 =item B<PluginInstance> I<Regex> I<Replacement>
8504
8505 =item B<TypeInstance> I<Regex> I<Replacement>
8506
8507 Match the appropriate field with the given regular expression I<Regex>. If the
8508 regular expression matches, that part that matches is replaced with
8509 I<Replacement>. If multiple places of the input buffer match a given regular
8510 expression, only the first occurrence will be replaced.
8511
8512 You can specify each option multiple times to use multiple regular expressions
8513 one after another.
8514
8515 =back
8516
8517 Example:
8518
8519  <Target "replace">
8520    # Replace "example.net" with "example.com"
8521    Host "\\<example.net\\>" "example.com"
8522
8523    # Strip "www." from hostnames
8524    Host "\\<www\\." ""
8525  </Target>
8526
8527 =item B<set>
8528
8529 Sets part of the identifier of a value to a given string.
8530
8531 Available options:
8532
8533 =over 4
8534
8535 =item B<Host> I<String>
8536
8537 =item B<Plugin> I<String>
8538
8539 =item B<PluginInstance> I<String>
8540
8541 =item B<TypeInstance> I<String>
8542
8543 Set the appropriate field to the given string. The strings for plugin instance
8544 and type instance may be empty, the strings for host and plugin may not be
8545 empty. It's currently not possible to set the type of a value this way.
8546
8547 =back
8548
8549 Example:
8550
8551  <Target "set">
8552    PluginInstance "coretemp"
8553    TypeInstance "core3"
8554  </Target>
8555
8556 =back
8557
8558 =head2 Backwards compatibility
8559
8560 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8561 B<Chain> block, it will behave as it used to. This is equivalent to the
8562 following configuration:
8563
8564  <Chain "PostCache">
8565    Target "write"
8566  </Chain>
8567
8568 If you specify a B<PostCacheChain>, the B<write> target will not be added
8569 anywhere and you will have to make sure that it is called where appropriate. We
8570 suggest to add the above snippet as default target to your "PostCache" chain.
8571
8572 =head2 Examples
8573
8574 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8575 be an FQDN.
8576
8577  <Chain "PreCache">
8578    <Rule "no_fqdn">
8579      <Match "regex">
8580        Host "^[^\.]*$"
8581      </Match>
8582      Target "stop"
8583    </Rule>
8584    Target "write"
8585  </Chain>
8586
8587 =head1 SEE ALSO
8588
8589 L<collectd(1)>,
8590 L<collectd-exec(5)>,
8591 L<collectd-perl(5)>,
8592 L<collectd-unixsock(5)>,
8593 L<types.db(5)>,
8594 L<hddtemp(8)>,
8595 L<iptables(8)>,
8596 L<kstat(3KSTAT)>,
8597 L<mbmon(1)>,
8598 L<psql(1)>,
8599 L<regex(7)>,
8600 L<rrdtool(1)>,
8601 L<sensors(1)>
8602
8603 =head1 AUTHOR
8604
8605 Florian Forster E<lt>octo@collectd.orgE<gt>
8606
8607 =cut