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