Fix collecdmon not start collectd
[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 =item B<VerifyPeer> B<true>|B<false>
3098
3099 When enabled, a valid client certificate is required to connect to the server.
3100 When disabled, a client certifiacte is not requested and any unsolicited client
3101 certificate is accepted.
3102 Enabled by default.
3103
3104 =back
3105
3106 =back
3107
3108 =head2 Plugin C<hddtemp>
3109
3110 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3111 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3112 default values, see below. C<hddtemp> has to be running to work correctly. If
3113 C<hddtemp> is not running timeouts may appear which may interfere with other
3114 statistics..
3115
3116 The B<hddtemp> homepage can be found at
3117 L<http://www.guzu.net/linux/hddtemp.php>.
3118
3119 =over 4
3120
3121 =item B<Host> I<Hostname>
3122
3123 Hostname to connect to. Defaults to B<127.0.0.1>.
3124
3125 =item B<Port> I<Port>
3126
3127 TCP-Port to connect to. Defaults to B<7634>.
3128
3129 =back
3130
3131 =head2 Plugin C<hugepages>
3132
3133 To collect B<hugepages> information, collectd reads directories
3134 "/sys/devices/system/node/*/hugepages" and
3135 "/sys/kernel/mm/hugepages".
3136 Reading of these directories can be disabled by the following
3137 options (default is enabled).
3138
3139 =over 4
3140
3141 =item B<ReportPerNodeHP> B<true>|B<false>
3142
3143 If enabled, information will be collected from the hugepage
3144 counters in "/sys/devices/system/node/*/hugepages".
3145 This is used to check the per-node hugepage statistics on
3146 a NUMA system.
3147
3148 =item B<ReportRootHP> B<true>|B<false>
3149
3150 If enabled, information will be collected from the hugepage
3151 counters in "/sys/kernel/mm/hugepages".
3152 This can be used on both NUMA and non-NUMA systems to check
3153 the overall hugepage statistics.
3154
3155 =item B<ValuesPages> B<true>|B<false>
3156
3157 Whether to report hugepages metrics in number of pages.
3158 Defaults to B<true>.
3159
3160 =item B<ValuesBytes> B<false>|B<true>
3161
3162 Whether to report hugepages metrics in bytes.
3163 Defaults to B<false>.
3164
3165 =item B<ValuesPercentage> B<false>|B<true>
3166
3167 Whether to report hugepages metrics as percentage.
3168 Defaults to B<false>.
3169
3170 =back
3171
3172 =head2 Plugin C<intel_pmu>
3173
3174 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3175 Linux perf interface. All events are reported on a per core basis.
3176
3177 B<Synopsis:>
3178
3179   <Plugin intel_pmu>
3180     ReportHardwareCacheEvents true
3181     ReportKernelPMUEvents true
3182     ReportSoftwareEvents true
3183     EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3184     HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3185   </Plugin>
3186
3187 B<Options:>
3188
3189 =over 4
3190
3191 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3192
3193 Enable or disable measuring of hardware CPU cache events:
3194   - L1-dcache-loads
3195   - L1-dcache-load-misses
3196   - L1-dcache-stores
3197   - L1-dcache-store-misses
3198   - L1-dcache-prefetches
3199   - L1-dcache-prefetch-misses
3200   - L1-icache-loads
3201   - L1-icache-load-misses
3202   - L1-icache-prefetches
3203   - L1-icache-prefetch-misses
3204   - LLC-loads
3205   - LLC-load-misses
3206   - LLC-stores
3207   - LLC-store-misses
3208   - LLC-prefetches
3209   - LLC-prefetch-misses
3210   - dTLB-loads
3211   - dTLB-load-misses
3212   - dTLB-stores
3213   - dTLB-store-misses
3214   - dTLB-prefetches
3215   - dTLB-prefetch-misses
3216   - iTLB-loads
3217   - iTLB-load-misses
3218   - branch-loads
3219   - branch-load-misses
3220
3221 =item B<ReportKernelPMUEvents> B<false>|B<true>
3222
3223 Enable or disable measuring of the following events:
3224   - cpu-cycles
3225   - instructions
3226   - cache-references
3227   - cache-misses
3228   - branches
3229   - branch-misses
3230   - bus-cycles
3231
3232 =item B<ReportSoftwareEvents> B<false>|B<true>
3233
3234 Enable or disable measuring of software events provided by kernel:
3235   - cpu-clock
3236   - task-clock
3237   - context-switches
3238   - cpu-migrations
3239   - page-faults
3240   - minor-faults
3241   - major-faults
3242   - alignment-faults
3243   - emulation-faults
3244
3245 =item B<EventList> I<filename>
3246
3247 JSON performance counter event list file name. To be able to monitor all Intel
3248 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3249 event_download.py script to download event list for current CPU.
3250
3251 =item B<HardwareEvents> I<events>
3252
3253 This field is a list of event names or groups of comma separated event names.
3254 This option requires B<EventList> option to be configured.
3255
3256 =back
3257
3258 =head2 Plugin C<intel_rdt>
3259
3260 The I<intel_rdt> plugin collects information provided by monitoring features of
3261 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3262 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3263 information about utilization of shared resources. CMT monitors last level cache
3264 occupancy (LLC). MBM supports two types of events reporting local and remote
3265 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3266 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3267 reports the bandwidth of accessing the remote socket. Also this technology
3268 allows to monitor instructions per clock (IPC).
3269 Monitor events are hardware dependant. Monitoring capabilities are detected on
3270 plugin initialization and only supported events are monitored.
3271
3272 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3273 require an additional capability to be enabled if collectd is run as a service.
3274 Please refer to I<contrib/systemd.collectd.service> file for more details.
3275
3276 B<Synopsis:>
3277
3278   <Plugin "intel_rdt">
3279     Cores "0-2" "3,4,6" "8-10,15"
3280   </Plugin>
3281
3282 B<Options:>
3283
3284 =over 4
3285
3286 =item B<Interval> I<seconds>
3287
3288 The interval within which to retrieve statistics on monitored events in seconds.
3289 For milliseconds divide the time by 1000 for example if the desired interval
3290 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3291 recommended to set interval higher than 1 sec.
3292
3293 =item B<Cores> I<cores groups>
3294
3295 All events are reported on a per core basis. Monitoring of the events can be
3296 configured for group of cores (aggregated statistics). This field defines groups
3297 of cores on which to monitor supported events. The field is represented as list
3298 of strings with core group values. Each string represents a list of cores in a
3299 group. Allowed formats are:
3300     0,1,2,3
3301     0-10,20-18
3302     1,3,5-8,10,0x10-12
3303
3304 If an empty string is provided as value for this field default cores
3305 configuration is applied - a separate group is created for each core.
3306
3307 =back
3308
3309 B<Note:> By default global interval is used to retrieve statistics on monitored
3310 events. To configure a plugin specific interval use B<Interval> option of the
3311 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3312 example if the desired interval is 50ms, set interval to 0.05.
3313 Due to limited capacity of counters it is not recommended to set interval higher
3314 than 1 sec.
3315
3316 =head2 Plugin C<interface>
3317
3318 =over 4
3319
3320 =item B<Interface> I<Interface>
3321
3322 Select this interface. By default these interfaces will then be collected. For
3323 a more detailed description see B<IgnoreSelected> below.
3324
3325 See F</"IGNORELISTS"> for details.
3326
3327 =item B<IgnoreSelected> I<true>|I<false>
3328
3329 If no configuration is given, the B<interface>-plugin will collect data from
3330 all interfaces. This may not be practical, especially for loopback- and
3331 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3332 interfaces you're interested in. Sometimes, however, it's easier/preferred
3333 to collect all interfaces I<except> a few ones. This option enables you to
3334 do that: By setting B<IgnoreSelected> to I<true> the effect of
3335 B<Interface> is inverted: All selected interfaces are ignored and all
3336 other interfaces are collected.
3337
3338 It is possible to use regular expressions to match interface names, if the
3339 name is surrounded by I</.../> and collectd was compiled with support for
3340 regexps. This is useful if there's a need to collect (or ignore) data
3341 for a group of interfaces that are similarly named, without the need to
3342 explicitly list all of them (especially useful if the list is dynamic).
3343 Example:
3344
3345  Interface "lo"
3346  Interface "/^veth/"
3347  Interface "/^tun[0-9]+/"
3348  IgnoreSelected "true"
3349
3350 This will ignore the loopback interface, all interfaces with names starting
3351 with I<veth> and all interfaces with names starting with I<tun> followed by
3352 at least one digit.
3353
3354 =item B<ReportInactive> I<true>|I<false>
3355
3356 When set to I<false>, only interfaces with non-zero traffic will be
3357 reported. Note that the check is done by looking into whether a
3358 package was sent at any time from boot and the corresponding counter
3359 is non-zero. So, if the interface has been sending data in the past
3360 since boot, but not during the reported time-interval, it will still
3361 be reported.
3362
3363 The default value is I<true> and results in collection of the data
3364 from all interfaces that are selected by B<Interface> and
3365 B<IgnoreSelected> options.
3366
3367 =item B<UniqueName> I<true>|I<false>
3368
3369 Interface name is not unique on Solaris (KSTAT), interface name is unique
3370 only within a module/instance. Following tuple is considered unique:
3371    (ks_module, ks_instance, ks_name)
3372 If this option is set to true, interface name contains above three fields
3373 separated by an underscore. For more info on KSTAT, visit
3374 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3375
3376 This option is only available on Solaris.
3377
3378 =back
3379
3380 =head2 Plugin C<ipmi>
3381
3382 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3383 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3384
3385 The plugin configuration consists of one or more B<Instance> blocks which
3386 specify one I<ipmi> connection each. Each block requires one unique string
3387 argument as the instance name. If instances are not configured, an instance with
3388 the default option values will be created.
3389
3390 For backwards compatibility, any option other than B<Instance> block will trigger
3391 legacy config handling and it will be treated as an option within B<Instance>
3392 block. This support will go away in the next major version of Collectd.
3393
3394 Within the B<Instance> blocks, the following options are allowed:
3395
3396 =over 4
3397
3398 =item B<Address> I<Address>
3399
3400 Hostname or IP to connect to. If not specified, plugin will try to connect to
3401 local management controller (BMC).
3402
3403 =item B<Username> I<Username>
3404
3405 =item B<Password> I<Password>
3406
3407 The username and the password to use for the connection to remote BMC.
3408
3409 =item B<AuthType> I<MD5>|I<rmcp+>
3410
3411 Forces the authentication type to use for the connection to remote BMC.
3412 By default most secure type is seleted.
3413
3414 =item B<Host> I<Hostname>
3415
3416 Sets the B<host> field of dispatched values. Defaults to the global hostname
3417 setting.
3418
3419 =item B<Sensor> I<Sensor>
3420
3421 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3422
3423 See F</"IGNORELISTS"> for details.
3424
3425 =item B<IgnoreSelected> I<true>|I<false>
3426
3427 If no configuration if given, the B<ipmi> plugin will collect data from all
3428 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3429 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3430 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3431 all other sensors are collected.
3432
3433 =item B<NotifySensorAdd> I<true>|I<false>
3434
3435 If a sensor appears after initialization time of a minute a notification
3436 is sent.
3437
3438 =item B<NotifySensorRemove> I<true>|I<false>
3439
3440 If a sensor disappears a notification is sent.
3441
3442 =item B<NotifySensorNotPresent> I<true>|I<false>
3443
3444 If you have for example dual power supply and one of them is (un)plugged then
3445 a notification is sent.
3446
3447 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3448
3449 If a IPMI connection state changes after initialization time of a minute
3450 a notification is sent. Defaults to B<false>.
3451
3452 =item B<SELEnabled> I<true>|I<false>
3453
3454 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3455 and discrete events. When event is received the notification is sent.
3456 Defaults to B<false>.
3457
3458 =item B<SELClearEvent> I<true>|I<false>
3459
3460 If SEL clear event is enabled, plugin will delete event from SEL list after
3461 it is received and successfully handled. In this case other tools that are
3462 subscribed for SEL events will receive an empty event.
3463 Defaults to B<false>.
3464
3465 =back
3466
3467 =head2 Plugin C<iptables>
3468
3469 =over 4
3470
3471 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3472
3473 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3474
3475 Select the iptables/ip6tables filter rules to count packets and bytes from.
3476
3477 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3478 of all rules which have a comment-match. The comment is then used as
3479 type-instance.
3480
3481 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3482 the I<n>th rule will be collected. Again, the comment (or the number) will be
3483 used as the type-instance.
3484
3485 If I<Name> is supplied, it will be used as the type-instance instead of the
3486 comment or the number.
3487
3488 =back
3489
3490 =head2 Plugin C<irq>
3491
3492 =over 4
3493
3494 =item B<Irq> I<Irq>
3495
3496 Select this irq. By default these irqs will then be collected. For a more
3497 detailed description see B<IgnoreSelected> below.
3498
3499 See F</"IGNORELISTS"> for details.
3500
3501 =item B<IgnoreSelected> I<true>|I<false>
3502
3503 If no configuration if given, the B<irq>-plugin will collect data from all
3504 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3505 can use the B<Irq>-option to pick the interrupt you're interested in.
3506 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3507 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3508 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3509 and all other interrupts are collected.
3510
3511 =back
3512
3513 =head2 Plugin C<java>
3514
3515 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3516 This section only discusses the syntax and semantic of the configuration
3517 options. For more in-depth information on the I<Java> plugin, please read
3518 L<collectd-java(5)>.
3519
3520 Synopsis:
3521
3522  <Plugin "java">
3523    JVMArg "-verbose:jni"
3524    JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3525    LoadPlugin "org.collectd.java.Foobar"
3526    <Plugin "org.collectd.java.Foobar">
3527      # To be parsed by the plugin
3528    </Plugin>
3529  </Plugin>
3530
3531 Available configuration options:
3532
3533 =over 4
3534
3535 =item B<JVMArg> I<Argument>
3536
3537 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3538 exactly the way the arguments to the I<java> binary on the command line work.
3539 Execute C<javaE<nbsp>--help> for details.
3540
3541 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3542 any other options! When another option is found, the JVM will be started and
3543 later options will have to be ignored!
3544
3545 =item B<LoadPlugin> I<JavaClass>
3546
3547 Instantiates a new I<JavaClass> object. The constructor of this object very
3548 likely then registers one or more callback methods with the server.
3549
3550 See L<collectd-java(5)> for details.
3551
3552 When the first such option is found, the virtual machine (JVM) is created. This
3553 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3554 B<LoadPlugin> options!
3555
3556 =item B<Plugin> I<Name>
3557
3558 The entire block is passed to the Java plugin as an
3559 I<org.collectd.api.OConfigItem> object.
3560
3561 For this to work, the plugin has to register a configuration callback first,
3562 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3563 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3564 depends on the (Java) plugin registering the callback and is completely
3565 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3566
3567 =back
3568
3569 =head2 Plugin C<load>
3570
3571 The I<Load plugin> collects the system load. These numbers give a rough overview
3572 over the utilization of a machine. The system load is defined as the number of
3573 runnable tasks in the run-queue and is provided by many operating systems as a
3574 one, five or fifteen minute average.
3575
3576 The following configuration options are available:
3577
3578 =over 4
3579
3580 =item B<ReportRelative> B<false>|B<true>
3581
3582 When enabled, system load divided by number of available CPU cores is reported
3583 for intervals 1 min, 5 min and 15 min. Defaults to false.
3584
3585 =back
3586
3587
3588 =head2 Plugin C<logfile>
3589
3590 =over 4
3591
3592 =item B<LogLevel> B<debug|info|notice|warning|err>
3593
3594 Sets the log-level. If, for example, set to B<notice>, then all events with
3595 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3596
3597 Please note that B<debug> is only available if collectd has been compiled with
3598 debugging support.
3599
3600 =item B<File> I<File>
3601
3602 Sets the file to write log messages to. The special strings B<stdout> and
3603 B<stderr> can be used to write to the standard output and standard error
3604 channels, respectively. This, of course, only makes much sense when I<collectd>
3605 is running in foreground- or non-daemon-mode.
3606
3607 =item B<Timestamp> B<true>|B<false>
3608
3609 Prefix all lines printed by the current time. Defaults to B<true>.
3610
3611 =item B<PrintSeverity> B<true>|B<false>
3612
3613 When enabled, all lines are prefixed by the severity of the log message, for
3614 example "warning". Defaults to B<false>.
3615
3616 =back
3617
3618 B<Note>: There is no need to notify the daemon after moving or removing the
3619 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3620 for each line it writes.
3621
3622 =head2 Plugin C<log_logstash>
3623
3624 The I<log logstash plugin> behaves like the logfile plugin but formats
3625 messages as JSON events for logstash to parse and input.
3626
3627 =over 4
3628
3629 =item B<LogLevel> B<debug|info|notice|warning|err>
3630
3631 Sets the log-level. If, for example, set to B<notice>, then all events with
3632 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3633
3634 Please note that B<debug> is only available if collectd has been compiled with
3635 debugging support.
3636
3637 =item B<File> I<File>
3638
3639 Sets the file to write log messages to. The special strings B<stdout> and
3640 B<stderr> can be used to write to the standard output and standard error
3641 channels, respectively. This, of course, only makes much sense when I<collectd>
3642 is running in foreground- or non-daemon-mode.
3643
3644 =back
3645
3646 B<Note>: There is no need to notify the daemon after moving or removing the
3647 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3648 for each line it writes.
3649
3650 =head2 Plugin C<lpar>
3651
3652 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3653 virtualization technique for IBM POWER processors. It takes into account CPU
3654 time stolen from or donated to a partition, in addition to the usual user,
3655 system, I/O statistics.
3656
3657 The following configuration options are available:
3658
3659 =over 4
3660
3661 =item B<CpuPoolStats> B<false>|B<true>
3662
3663 When enabled, statistics about the processor pool are read, too. The partition
3664 needs to have pool authority in order to be able to acquire this information.
3665 Defaults to false.
3666
3667 =item B<ReportBySerial> B<false>|B<true>
3668
3669 If enabled, the serial of the physical machine the partition is currently
3670 running on is reported as I<hostname> and the logical hostname of the machine
3671 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3672 used (just like other plugins) and the I<plugin instance> will be empty.
3673 Defaults to false.
3674
3675 =back
3676
3677 =head2 Plugin C<lua>
3678
3679 This plugin embeds a Lua interpreter into collectd and provides an interface
3680 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3681
3682
3683 =head2 Plugin C<mbmon>
3684
3685 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3686
3687 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3688 B<Host> and B<Port> options can be used to change these values, see below.
3689 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3690 timeouts may appear which may interfere with other statistics..
3691
3692 C<mbmon> must be run with the -r option ("print TAG and Value format");
3693 Debian's F</etc/init.d/mbmon> script already does this, other people
3694 will need to ensure that this is the case.
3695
3696 =over 4
3697
3698 =item B<Host> I<Hostname>
3699
3700 Hostname to connect to. Defaults to B<127.0.0.1>.
3701
3702 =item B<Port> I<Port>
3703
3704 TCP-Port to connect to. Defaults to B<411>.
3705
3706 =back
3707
3708 =head2 Plugin C<mcelog>
3709
3710 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3711
3712 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3713 mcelog server is running. When the server is running, the plugin will tail the
3714 specified logfile to retrieve machine check exception information and send a
3715 notification with the details from the logfile. The plugin will use the mcelog
3716 client protocol to retrieve memory related machine check exceptions. Note that
3717 for memory exceptions, notifications are only sent when there is a change in
3718 the number of corrected/uncorrected memory errors.
3719
3720 =head3 The Memory block
3721
3722 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3723 exclusive.
3724
3725 =over 3
3726
3727 =item B<McelogClientSocket> I<Path>
3728 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3729 Defaults to B<"/var/run/mcelog-client">.
3730
3731 =item B<PersistentNotification> B<true>|B<false>
3732 Override default configuration to only send notifications when sent when there
3733 is a change in the number of corrected/uncorrected memory errors. When set to
3734 true notifications will be sent for every read cycle. Default is false. Does
3735 not affect the stats being dispatched.
3736
3737 =back
3738
3739 =over 4
3740
3741 =item B<McelogLogfile> I<Path>
3742
3743 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3744 cannot be used in conjunction with the memory block options, they are mutually
3745 exclusive.
3746
3747 =back
3748
3749 =head2 Plugin C<md>
3750
3751 The C<md plugin> collects information from Linux Software-RAID devices (md).
3752
3753 All reported values are of the type C<md_disks>. Reported type instances are
3754 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3755 I<missing> (physically absent) disks.
3756
3757 =over 4
3758
3759 =item B<Device> I<Device>
3760
3761 Select md devices based on device name. The I<device name> is the basename of
3762 the device, i.e. the name of the block device without the leading C</dev/>.
3763 See B<IgnoreSelected> for more details.
3764
3765 See F</"IGNORELISTS"> for details.
3766
3767 =item B<IgnoreSelected> B<true>|B<false>
3768
3769 Invert device selection: If set to B<true>, all md devices B<except> those
3770 listed using B<Device> are collected. If B<false> (the default), only those
3771 listed are collected. If no configuration is given, the B<md> plugin will
3772 collect data from all md devices.
3773
3774 =back
3775
3776 =head2 Plugin C<memcachec>
3777
3778 The C<memcachec plugin> connects to a memcached server, queries one or more
3779 given I<pages> and parses the returned data according to user specification.
3780 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3781 plugins.
3782
3783 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3784 library. Please note that there is another library with a very similar name,
3785 libmemcache (notice the missing `d'), which is not applicable.
3786
3787 Synopsis of the configuration:
3788
3789  <Plugin "memcachec">
3790    <Page "plugin_instance">
3791      Server "localhost"
3792      Key "page_key"
3793      Plugin "plugin_name"
3794      <Match>
3795        Regex "(\\d+) bytes sent"
3796        DSType CounterAdd
3797        Type "ipt_octets"
3798        Instance "type_instance"
3799      </Match>
3800    </Page>
3801  </Plugin>
3802
3803 The configuration options are:
3804
3805 =over 4
3806
3807 =item E<lt>B<Page> I<Name>E<gt>
3808
3809 Each B<Page> block defines one I<page> to be queried from the memcached server.
3810 The block requires one string argument which is used as I<plugin instance>.
3811
3812 =item B<Server> I<Address>
3813
3814 Sets the server address to connect to when querying the page. Must be inside a
3815 B<Page> block.
3816
3817 =item B<Key> I<Key>
3818
3819 When connected to the memcached server, asks for the page I<Key>.
3820
3821 =item B<Plugin> I<Plugin>
3822
3823 Use I<Plugin> as the plugin name when submitting values.
3824 Defaults to C<memcachec>.
3825
3826 =item E<lt>B<Match>E<gt>
3827
3828 Match blocks define which strings to look for and how matches substrings are
3829 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3830
3831 =back
3832
3833 =head2 Plugin C<memcached>
3834
3835 The B<memcached plugin> connects to a memcached server and queries statistics
3836 about cache utilization, memory and bandwidth used.
3837 L<http://memcached.org/>
3838
3839  <Plugin "memcached">
3840    <Instance "name">
3841      #Host "memcache.example.com"
3842      Address "127.0.0.1"
3843      Port 11211
3844    </Instance>
3845  </Plugin>
3846
3847 The plugin configuration consists of one or more B<Instance> blocks which
3848 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3849 following options are allowed:
3850
3851 =over 4
3852
3853 =item B<Host> I<Hostname>
3854
3855 Sets the B<host> field of dispatched values. Defaults to the global hostname
3856 setting.
3857 For backwards compatibility, values are also dispatched with the global
3858 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3859 not set.
3860
3861 =item B<Address> I<Address>
3862
3863 Hostname or IP to connect to. For backwards compatibility, defaults to the
3864 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3865
3866 =item B<Port> I<Port>
3867
3868 TCP port to connect to. Defaults to B<11211>.
3869
3870 =item B<Socket> I<Path>
3871
3872 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3873 setting is given, the B<Address> and B<Port> settings are ignored.
3874
3875 =back
3876
3877 =head2 Plugin C<mic>
3878
3879 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3880 Intel's Many Integrated Core (MIC) systems.
3881
3882 B<Synopsis:>
3883
3884  <Plugin mic>
3885    ShowCPU true
3886    ShowCPUCores true
3887    ShowMemory true
3888
3889    ShowTemperatures true
3890    Temperature vddg
3891    Temperature vddq
3892    IgnoreSelectedTemperature true
3893
3894    ShowPower true
3895    Power total0
3896    Power total1
3897    IgnoreSelectedPower true
3898  </Plugin>
3899
3900 The following options are valid inside the B<PluginE<nbsp>mic> block:
3901
3902 =over 4
3903
3904 =item B<ShowCPU> B<true>|B<false>
3905
3906 If enabled (the default) a sum of the CPU usage across all cores is reported.
3907
3908 =item B<ShowCPUCores> B<true>|B<false>
3909
3910 If enabled (the default) per-core CPU usage is reported.
3911
3912 =item B<ShowMemory> B<true>|B<false>
3913
3914 If enabled (the default) the physical memory usage of the MIC system is
3915 reported.
3916
3917 =item B<ShowTemperatures> B<true>|B<false>
3918
3919 If enabled (the default) various temperatures of the MIC system are reported.
3920
3921 =item B<Temperature> I<Name>
3922
3923 This option controls which temperatures are being reported. Whether matching
3924 temperatures are being ignored or I<only> matching temperatures are reported
3925 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3926 temperatures are reported.
3927
3928 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3929
3930 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3931 (the default) only temperatures matching a B<Temperature> option are reported
3932 or, if no B<Temperature> option is specified, all temperatures are reported. If
3933 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3934 are reported.
3935
3936 Known temperature names are:
3937
3938 =over 4
3939
3940 =item die
3941
3942 Die of the CPU
3943
3944 =item devmem
3945
3946 Device Memory
3947
3948 =item fin
3949
3950 Fan In
3951
3952 =item fout
3953
3954 Fan Out
3955
3956 =item vccp
3957
3958 Voltage ccp
3959
3960 =item vddg
3961
3962 Voltage ddg
3963
3964 =item vddq
3965
3966 Voltage ddq
3967
3968 =back
3969
3970 =item B<ShowPower> B<true>|B<false>
3971
3972 If enabled (the default) various temperatures of the MIC system are reported.
3973
3974 =item B<Power> I<Name>
3975
3976 This option controls which power readings are being reported. Whether matching
3977 power readings are being ignored or I<only> matching power readings are reported
3978 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3979 power readings are reported.
3980
3981 =item B<IgnoreSelectedPower> B<false>|B<true>
3982
3983 Controls the behavior of the B<Power> setting above. If set to B<false>
3984 (the default) only power readings matching a B<Power> option are reported
3985 or, if no B<Power> option is specified, all power readings are reported. If
3986 set to B<true>, matching power readings are I<ignored> and all other power readings
3987 are reported.
3988
3989 Known power names are:
3990
3991 =over 4
3992
3993 =item total0
3994
3995 Total power utilization averaged over Time Window 0 (uWatts).
3996
3997 =item total1
3998
3999 Total power utilization averaged over Time Window 0 (uWatts).
4000
4001 =item inst
4002
4003 Instantaneous power (uWatts).
4004
4005 =item imax
4006
4007 Max instantaneous power (uWatts).
4008
4009 =item pcie
4010
4011 PCI-E connector power (uWatts).
4012
4013 =item c2x3
4014
4015 2x3 connector power (uWatts).
4016
4017 =item c2x4
4018
4019 2x4 connector power (uWatts).
4020
4021 =item vccp
4022
4023 Core rail (uVolts).
4024
4025 =item vddg
4026
4027 Uncore rail (uVolts).
4028
4029 =item vddq
4030
4031 Memory subsystem rail (uVolts).
4032
4033 =back
4034
4035 =back
4036
4037 =head2 Plugin C<memory>
4038
4039 The I<memory plugin> provides the following configuration options:
4040
4041 =over 4
4042
4043 =item B<ValuesAbsolute> B<true>|B<false>
4044
4045 Enables or disables reporting of physical memory usage in absolute numbers,
4046 i.e. bytes. Defaults to B<true>.
4047
4048 =item B<ValuesPercentage> B<false>|B<true>
4049
4050 Enables or disables reporting of physical memory usage in percentages, e.g.
4051 percent of physical memory used. Defaults to B<false>.
4052
4053 This is useful for deploying I<collectd> in a heterogeneous environment in
4054 which the sizes of physical memory vary.
4055
4056 =back
4057
4058 =head2 Plugin C<modbus>
4059
4060 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4061 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4062 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
4063 values (two registers interpreted as IEEE floats in big endian notation).
4064
4065 B<Synopsis:>
4066
4067  <Data "voltage-input-1">
4068    RegisterBase 0
4069    RegisterType float
4070    RegisterCmd ReadHolding
4071    Type voltage
4072    Instance "input-1"
4073  </Data>
4074
4075  <Data "voltage-input-2">
4076    RegisterBase 2
4077    RegisterType float
4078    RegisterCmd ReadHolding
4079    Type voltage
4080    Instance "input-2"
4081  </Data>
4082
4083  <Data "supply-temperature-1">
4084    RegisterBase 0
4085    RegisterType Int16
4086    RegisterCmd ReadHolding
4087    Type temperature
4088    Instance "temp-1"
4089  </Data>
4090
4091  <Host "modbus.example.com">
4092    Address "192.168.0.42"
4093    Port    "502"
4094    Interval 60
4095
4096    <Slave 1>
4097      Instance "power-supply"
4098      Collect  "voltage-input-1"
4099      Collect  "voltage-input-2"
4100    </Slave>
4101  </Host>
4102
4103  <Host "localhost">
4104    Device "/dev/ttyUSB0"
4105    Baudrate 38400
4106    Interval 20
4107
4108    <Slave 1>
4109      Instance "temperature"
4110      Collect  "supply-temperature-1"
4111    </Slave>
4112  </Host>
4113
4114 =over 4
4115
4116 =item E<lt>B<Data> I<Name>E<gt> blocks
4117
4118 Data blocks define a mapping between register numbers and the "types" used by
4119 I<collectd>.
4120
4121 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4122
4123 =over 4
4124
4125 =item B<RegisterBase> I<Number>
4126
4127 Configures the base register to read from the device. If the option
4128 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4129 register will be read (the register number is increased by one).
4130
4131 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4132
4133 Specifies what kind of data is returned by the device. This defaults to
4134 B<Uint16>.  If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4135 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4136 and B<RegisterBase+1> will be read and the data is combined into one
4137 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4138 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4139 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4140 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4141 registers are swapped with the most significant 16E<nbsp>bits in
4142 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4143 B<RegisterBase>.
4144
4145 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4146
4147 Specifies register type to be collected from device. Works only with libmodbus
4148 2.9.2 or higher. Defaults to B<ReadHolding>.
4149
4150 =item B<Type> I<Type>
4151
4152 Specifies the "type" (data set) to use when dispatching the value to
4153 I<collectd>. Currently, only data sets with exactly one data source are
4154 supported.
4155
4156 =item B<Instance> I<Instance>
4157
4158 Sets the type instance to use when dispatching the value to I<collectd>. If
4159 unset, an empty string (no type instance) is used.
4160
4161 =back
4162
4163 =item E<lt>B<Host> I<Name>E<gt> blocks
4164
4165 Host blocks are used to specify to which hosts to connect and what data to read
4166 from their "slaves". The string argument I<Name> is used as hostname when
4167 dispatching the values to I<collectd>.
4168
4169 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4170
4171 =over 4
4172
4173 =item B<Address> I<Hostname>
4174
4175 For Modbus/TCP, specifies the node name (the actual network address) used to
4176 connect to the host. This may be an IP address or a hostname. Please note that
4177 the used I<libmodbus> library only supports IPv4 at the moment.
4178
4179 =item B<Port> I<Service>
4180
4181 for Modbus/TCP, specifies the port used to connect to the host. The port can
4182 either be given as a number or as a service name. Please note that the
4183 I<Service> argument must be a string, even if ports are given in their numerical
4184 form. Defaults to "502".
4185
4186 =item B<Device> I<Devicenode>
4187
4188 For Modbus/RTU, specifies the path to the serial device being used.
4189
4190 =item B<Baudrate> I<Baudrate>
4191
4192 For Modbus/RTU, specifies the baud rate of the serial device.
4193 Note, connections currently support only 8/N/1.
4194
4195 =item B<Interval> I<Interval>
4196
4197 Sets the interval (in seconds) in which the values will be collected from this
4198 host. By default the global B<Interval> setting will be used.
4199
4200 =item E<lt>B<Slave> I<ID>E<gt>
4201
4202 Over each connection, multiple Modbus devices may be reached. The slave ID
4203 is used to specify which device should be addressed. For each device you want
4204 to query, one B<Slave> block must be given.
4205
4206 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4207
4208 =over 4
4209
4210 =item B<Instance> I<Instance>
4211
4212 Specify the plugin instance to use when dispatching the values to I<collectd>.
4213 By default "slave_I<ID>" is used.
4214
4215 =item B<Collect> I<DataName>
4216
4217 Specifies which data to retrieve from the device. I<DataName> must be the same
4218 string as the I<Name> argument passed to a B<Data> block. You can specify this
4219 option multiple times to collect more than one value from a slave. At least one
4220 B<Collect> option is mandatory.
4221
4222 =back
4223
4224 =back
4225
4226 =back
4227
4228 =head2 Plugin C<mqtt>
4229
4230 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4231 values from MQTT (B<Subscribe> blocks).
4232
4233 B<Synopsis:>
4234
4235  <Plugin mqtt>
4236    <Publish "name">
4237      Host "mqtt.example.com"
4238      Prefix "collectd"
4239    </Publish>
4240    <Subscribe "name">
4241      Host "mqtt.example.com"
4242      Topic "collectd/#"
4243    </Subscribe>
4244  </Plugin>
4245
4246 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4247 configuring the sending and receiving direction respectively. The plugin will
4248 register a write callback named C<mqtt/I<name>> where I<name> is the string
4249 argument given to the B<Publish> block. Both types of blocks share many but not
4250 all of the following options. If an option is valid in only one of the blocks,
4251 it will be mentioned explicitly.
4252
4253 B<Options:>
4254
4255 =over 4
4256
4257 =item B<Host> I<Hostname>
4258
4259 Hostname of the MQTT broker to connect to.
4260
4261 =item B<Port> I<Service>
4262
4263 Port number or service name of the MQTT broker to connect to.
4264
4265 =item B<User> I<UserName>
4266
4267 Username used when authenticating to the MQTT broker.
4268
4269 =item B<Password> I<Password>
4270
4271 Password used when authenticating to the MQTT broker.
4272
4273 =item B<ClientId> I<ClientId>
4274
4275 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4276
4277 =item B<QoS> [B<0>-B<2>]
4278
4279 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4280
4281 =over 4
4282
4283 =item B<0>
4284
4285 At most once
4286
4287 =item B<1>
4288
4289 At least once
4290
4291 =item B<2>
4292
4293 Exactly once
4294
4295 =back
4296
4297 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4298 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4299 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4300 on a message is larger than the maximum accepted QoS of a subscriber, the
4301 message's QoS will be downgraded.
4302
4303 =item B<Prefix> I<Prefix> (Publish only)
4304
4305 This plugin will use one topic per I<value list> which will looks like a path.
4306 I<Prefix> is used as the first path element and defaults to B<collectd>.
4307
4308 An example topic name would be:
4309
4310  collectd/cpu-0/cpu-user
4311
4312 =item B<Retain> B<false>|B<true> (Publish only)
4313
4314 Controls whether the MQTT broker will retain (keep a copy of) the last message
4315 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4316
4317 =item B<StoreRates> B<true>|B<false> (Publish only)
4318
4319 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4320 before sending. Defaults to B<true>.
4321
4322 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4323
4324 Controls whether the MQTT "cleans" the session up after the subscriber
4325 disconnects or if it maintains the subscriber's subscriptions and all messages
4326 that arrive while the subscriber is disconnected. Defaults to B<true>.
4327
4328 =item B<Topic> I<TopicName> (Subscribe only)
4329
4330 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4331 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4332 the B<collectd> branch.
4333
4334 =item B<CACert> I<file>
4335
4336 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4337 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4338 port of the MQTT broker.
4339 This option enables the use of TLS.
4340
4341 =item B<CertificateFile> I<file>
4342
4343 Path to the PEM-encoded certificate file to use as client certificate when
4344 connecting to the MQTT broker.
4345 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4346
4347 =item B<CertificateKeyFile> I<file>
4348
4349 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4350 Only valid if B<CACert> and B<CertificateFile> are also set.
4351
4352 =item B<TLSProtocol> I<protocol>
4353
4354 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4355 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4356 version is used which depends on the version of OpenSSL the Mosquitto library
4357 was linked against.
4358 Only valid if B<CACert> is set.
4359
4360 =item B<CipherSuite> I<ciphersuite>
4361
4362 A string describing the ciphers available for use. See L<ciphers(1)> and the
4363 C<openssl ciphers> utility for more information. If unset, the default ciphers
4364 will be used.
4365 Only valid if B<CACert> is set.
4366
4367 =back
4368
4369 =head2 Plugin C<mysql>
4370
4371 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4372 one or more databases when started and keeps the connection up as long as
4373 possible. When the connection is interrupted for whatever reason it will try
4374 to re-connect. The plugin will complain loudly in case anything goes wrong.
4375
4376 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4377 and collects information about MySQL network traffic, executed statements,
4378 requests, the query cache and threads by evaluating the
4379 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4380 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4381 Status Variables> for an explanation of these values.
4382
4383 Optionally, master and slave statistics may be collected in a MySQL
4384 replication setup. In that case, information about the synchronization state
4385 of the nodes are collected by evaluating the C<Position> return value of the
4386 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4387 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4388 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4389 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4390 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4391
4392 Synopsis:
4393
4394   <Plugin mysql>
4395     <Database foo>
4396       Host "hostname"
4397       User "username"
4398       Password "password"
4399       Port "3306"
4400       MasterStats true
4401       ConnectTimeout 10
4402       SSLKey "/path/to/key.pem"
4403       SSLCert "/path/to/cert.pem"
4404       SSLCA "/path/to/ca.pem"
4405       SSLCAPath "/path/to/cas/"
4406       SSLCipher "DHE-RSA-AES256-SHA"
4407     </Database>
4408
4409     <Database bar>
4410       Alias "squeeze"
4411       Host "localhost"
4412       Socket "/var/run/mysql/mysqld.sock"
4413       SlaveStats true
4414       SlaveNotifications true
4415     </Database>
4416
4417    <Database galera>
4418       Alias "galera"
4419       Host "localhost"
4420       Socket "/var/run/mysql/mysqld.sock"
4421       WsrepStats true
4422    </Database>
4423   </Plugin>
4424
4425 A B<Database> block defines one connection to a MySQL database. It accepts a
4426 single argument which specifies the name of the database. None of the other
4427 options are required. MySQL will use default values as documented in the
4428 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4429 B<MySQL reference manual>.
4430
4431 =over 4
4432
4433 =item B<Alias> I<Alias>
4434
4435 Alias to use as sender instead of hostname when reporting. This may be useful
4436 when having cryptic hostnames.
4437
4438 =item B<Host> I<Hostname>
4439
4440 Hostname of the database server. Defaults to B<localhost>.
4441
4442 =item B<User> I<Username>
4443
4444 Username to use when connecting to the database. The user does not have to be
4445 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4446 unless you want to collectd replication statistics (see B<MasterStats> and
4447 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4448 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4449
4450 =item B<Password> I<Password>
4451
4452 Password needed to log into the database.
4453
4454 =item B<Database> I<Database>
4455
4456 Select this database. Defaults to I<no database> which is a perfectly reasonable
4457 option for what this plugin does.
4458
4459 =item B<Port> I<Port>
4460
4461 TCP-port to connect to. The port must be specified in its numeric form, but it
4462 must be passed as a string nonetheless. For example:
4463
4464   Port "3306"
4465
4466 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4467 See the documentation for the C<mysql_real_connect> function for details.
4468
4469 =item B<Socket> I<Socket>
4470
4471 Specifies the path to the UNIX domain socket of the MySQL server. This option
4472 only has any effect, if B<Host> is set to B<localhost> (the default).
4473 Otherwise, use the B<Port> option above. See the documentation for the
4474 C<mysql_real_connect> function for details.
4475
4476 =item B<InnodbStats> I<true|false>
4477
4478 If enabled, metrics about the InnoDB storage engine are collected.
4479 Disabled by default.
4480
4481 =item B<MasterStats> I<true|false>
4482
4483 =item B<SlaveStats> I<true|false>
4484
4485 Enable the collection of master / slave statistics in a replication setup. In
4486 order to be able to get access to these statistics, the user needs special
4487 privileges. See the B<User> documentation above. Defaults to B<false>.
4488
4489 =item B<SlaveNotifications> I<true|false>
4490
4491 If enabled, the plugin sends a notification if the replication slave I/O and /
4492 or SQL threads are not running. Defaults to B<false>.
4493
4494 =item B<WsrepStats> I<true|false>
4495
4496  Enable the collection of wsrep plugin statistics, used in Master-Master
4497  replication setups like in MySQL Galera/Percona XtraDB Cluster.
4498  User needs only privileges to execute 'SHOW GLOBAL STATUS'
4499
4500 =item B<ConnectTimeout> I<Seconds>
4501
4502 Sets the connect timeout for the MySQL client.
4503
4504 =item B<SSLKey> I<Path>
4505
4506 If provided, the X509 key in PEM format.
4507
4508 =item B<SSLCert> I<Path>
4509
4510 If provided, the X509 cert in PEM format.
4511
4512 =item B<SSLCA> I<Path>
4513
4514 If provided, the CA file in PEM format (check OpenSSL docs).
4515
4516 =item B<SSLCAPath> I<Path>
4517
4518 If provided, the CA directory (check OpenSSL docs).
4519
4520 =item B<SSLCipher> I<String>
4521
4522 If provided, the SSL cipher to use.
4523
4524 =back
4525
4526 =head2 Plugin C<netapp>
4527
4528 The netapp plugin can collect various performance and capacity information
4529 from a NetApp filer using the NetApp API.
4530
4531 Please note that NetApp has a wide line of products and a lot of different
4532 software versions for each of these products. This plugin was developed for a
4533 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4534 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4535 model and software version but it is very hard to test this.
4536 If you have used this plugin with other models and/or software version, feel
4537 free to send us a mail to tell us about the results, even if it's just a short
4538 "It works".
4539
4540 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4541 basic authentication.
4542
4543 B<Do not use a regular user for this!> Create a special collectd user with just
4544 the minimum of capabilities needed. The user only needs the "login-http-admin"
4545 capability as well as a few more depending on which data will be collected.
4546 Required capabilities are documented below.
4547
4548 =head3 Synopsis
4549
4550  <Plugin "netapp">
4551    <Host "netapp1.example.com">
4552     Protocol      "https"
4553     Address       "10.0.0.1"
4554     Port          443
4555     User          "username"
4556     Password      "aef4Aebe"
4557     Interval      30
4558
4559     <WAFL>
4560       Interval 30
4561       GetNameCache   true
4562       GetDirCache    true
4563       GetBufferCache true
4564       GetInodeCache  true
4565     </WAFL>
4566
4567     <Disks>
4568       Interval 30
4569       GetBusy true
4570     </Disks>
4571
4572     <VolumePerf>
4573       Interval 30
4574       GetIO      "volume0"
4575       IgnoreSelectedIO      false
4576       GetOps     "volume0"
4577       IgnoreSelectedOps     false
4578       GetLatency "volume0"
4579       IgnoreSelectedLatency false
4580     </VolumePerf>
4581
4582     <VolumeUsage>
4583       Interval 30
4584       GetCapacity "vol0"
4585       GetCapacity "vol1"
4586       IgnoreSelectedCapacity false
4587       GetSnapshot "vol1"
4588       GetSnapshot "vol3"
4589       IgnoreSelectedSnapshot false
4590     </VolumeUsage>
4591
4592     <Quota>
4593       Interval 60
4594     </Quota>
4595
4596     <Snapvault>
4597       Interval 30
4598     </Snapvault>
4599
4600     <System>
4601       Interval 30
4602       GetCPULoad     true
4603       GetInterfaces  true
4604       GetDiskOps     true
4605       GetDiskIO      true
4606     </System>
4607
4608     <VFiler vfilerA>
4609       Interval 60
4610
4611       SnapVault true
4612       # ...
4613     </VFiler>
4614    </Host>
4615  </Plugin>
4616
4617 The netapp plugin accepts the following configuration options:
4618
4619 =over 4
4620
4621 =item B<Host> I<Name>
4622
4623 A host block defines one NetApp filer. It will appear in collectd with the name
4624 you specify here which does not have to be its real name nor its hostname (see
4625 the B<Address> option below).
4626
4627 =item B<VFiler> I<Name>
4628
4629 A B<VFiler> block may only be used inside a host block. It accepts all the
4630 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4631 will execute all NetApp API commands in the context of the specified
4632 VFiler(R). It will appear in collectd with the name you specify here which
4633 does not have to be its real name. The VFiler name may be specified using the
4634 B<VFilerName> option. If this is not specified, it will default to the name
4635 you specify here.
4636
4637 The VFiler block inherits all connection related settings from the surrounding
4638 B<Host> block (which appear before the B<VFiler> block) but they may be
4639 overwritten inside the B<VFiler> block.
4640
4641 This feature is useful, for example, when using a VFiler as SnapVault target
4642 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4643 available in the host filer (vfiler0) but only in the respective VFiler
4644 context.
4645
4646 =item B<Protocol> B<httpd>|B<http>
4647
4648 The protocol collectd will use to query this host.
4649
4650 Optional
4651
4652 Type: string
4653
4654 Default: https
4655
4656 Valid options: http, https
4657
4658 =item B<Address> I<Address>
4659
4660 The hostname or IP address of the host.
4661
4662 Optional
4663
4664 Type: string
4665
4666 Default: The "host" block's name.
4667
4668 =item B<Port> I<Port>
4669
4670 The TCP port to connect to on the host.
4671
4672 Optional
4673
4674 Type: integer
4675
4676 Default: 80 for protocol "http", 443 for protocol "https"
4677
4678 =item B<User> I<User>
4679
4680 =item B<Password> I<Password>
4681
4682 The username and password to use to login to the NetApp.
4683
4684 Mandatory
4685
4686 Type: string
4687
4688 =item B<VFilerName> I<Name>
4689
4690 The name of the VFiler in which context to execute API commands. If not
4691 specified, the name provided to the B<VFiler> block will be used instead.
4692
4693 Optional
4694
4695 Type: string
4696
4697 Default: name of the B<VFiler> block
4698
4699 B<Note:> This option may only be used inside B<VFiler> blocks.
4700
4701 =item B<Interval> I<Interval>
4702
4703 B<TODO>
4704
4705 =back
4706
4707 The following options decide what kind of data will be collected. You can
4708 either use them as a block and fine tune various parameters inside this block,
4709 use them as a single statement to just accept all default values, or omit it to
4710 not collect any data.
4711
4712 The following options are valid inside all blocks:
4713
4714 =over 4
4715
4716 =item B<Interval> I<Seconds>
4717
4718 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4719 host specific setting.
4720
4721 =back
4722
4723 =head3 The System block
4724
4725 This will collect various performance data about the whole system.
4726
4727 B<Note:> To get this data the collectd user needs the
4728 "api-perf-object-get-instances" capability.
4729
4730 =over 4
4731
4732 =item B<Interval> I<Seconds>
4733
4734 Collect disk statistics every I<Seconds> seconds.
4735
4736 =item B<GetCPULoad> B<true>|B<false>
4737
4738 If you set this option to true the current CPU usage will be read. This will be
4739 the average usage between all CPUs in your NetApp without any information about
4740 individual CPUs.
4741
4742 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4743 returns in the "CPU" field.
4744
4745 Optional
4746
4747 Type: boolean
4748
4749 Default: true
4750
4751 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4752
4753 =item B<GetInterfaces> B<true>|B<false>
4754
4755 If you set this option to true the current traffic of the network interfaces
4756 will be read. This will be the total traffic over all interfaces of your NetApp
4757 without any information about individual interfaces.
4758
4759 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4760 in the "Net kB/s" field.
4761
4762 B<Or is it?>
4763
4764 Optional
4765
4766 Type: boolean
4767
4768 Default: true
4769
4770 Result: One value list of type "if_octects".
4771
4772 =item B<GetDiskIO> B<true>|B<false>
4773
4774 If you set this option to true the current IO throughput will be read. This
4775 will be the total IO of your NetApp without any information about individual
4776 disks, volumes or aggregates.
4777
4778 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4779 in the "DiskE<nbsp>kB/s" field.
4780
4781 Optional
4782
4783 Type: boolean
4784
4785 Default: true
4786
4787 Result: One value list of type "disk_octets".
4788
4789 =item B<GetDiskOps> B<true>|B<false>
4790
4791 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4792 iSCSI, etc. operations will be read. This will be the total number of
4793 operations on your NetApp without any information about individual volumes or
4794 aggregates.
4795
4796 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4797 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4798
4799 Optional
4800
4801 Type: boolean
4802
4803 Default: true
4804
4805 Result: A variable number of value lists of type "disk_ops_complex". Each type
4806 of operation will result in one value list with the name of the operation as
4807 type instance.
4808
4809 =back
4810
4811 =head3 The WAFL block
4812
4813 This will collect various performance data about the WAFL file system. At the
4814 moment this just means cache performance.
4815
4816 B<Note:> To get this data the collectd user needs the
4817 "api-perf-object-get-instances" capability.
4818
4819 B<Note:> The interface to get these values is classified as "Diagnostics" by
4820 NetApp. This means that it is not guaranteed to be stable even between minor
4821 releases.
4822
4823 =over 4
4824
4825 =item B<Interval> I<Seconds>
4826
4827 Collect disk statistics every I<Seconds> seconds.
4828
4829 =item B<GetNameCache> B<true>|B<false>
4830
4831 Optional
4832
4833 Type: boolean
4834
4835 Default: true
4836
4837 Result: One value list of type "cache_ratio" and type instance
4838 "name_cache_hit".
4839
4840 =item B<GetDirCache> B<true>|B<false>
4841
4842 Optional
4843
4844 Type: boolean
4845
4846 Default: true
4847
4848 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4849
4850 =item B<GetInodeCache> B<true>|B<false>
4851
4852 Optional
4853
4854 Type: boolean
4855
4856 Default: true
4857
4858 Result: One value list of type "cache_ratio" and type instance
4859 "inode_cache_hit".
4860
4861 =item B<GetBufferCache> B<true>|B<false>
4862
4863 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4864 in the "Cache hit" field.
4865
4866 Optional
4867
4868 Type: boolean
4869
4870 Default: true
4871
4872 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4873
4874 =back
4875
4876 =head3 The Disks block
4877
4878 This will collect performance data about the individual disks in the NetApp.
4879
4880 B<Note:> To get this data the collectd user needs the
4881 "api-perf-object-get-instances" capability.
4882
4883 =over 4
4884
4885 =item B<Interval> I<Seconds>
4886
4887 Collect disk statistics every I<Seconds> seconds.
4888
4889 =item B<GetBusy> B<true>|B<false>
4890
4891 If you set this option to true the busy time of all disks will be calculated
4892 and the value of the busiest disk in the system will be written.
4893
4894 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4895 in the "Disk util" field. Probably.
4896
4897 Optional
4898
4899 Type: boolean
4900
4901 Default: true
4902
4903 Result: One value list of type "percent" and type instance "disk_busy".
4904
4905 =back
4906
4907 =head3 The VolumePerf block
4908
4909 This will collect various performance data about the individual volumes.
4910
4911 You can select which data to collect about which volume using the following
4912 options. They follow the standard ignorelist semantic.
4913
4914 B<Note:> To get this data the collectd user needs the
4915 I<api-perf-object-get-instances> capability.
4916
4917 =over 4
4918
4919 =item B<Interval> I<Seconds>
4920
4921 Collect volume performance data every I<Seconds> seconds.
4922
4923 =item B<GetIO> I<Volume>
4924
4925 =item B<GetOps> I<Volume>
4926
4927 =item B<GetLatency> I<Volume>
4928
4929 Select the given volume for IO, operations or latency statistics collection.
4930 The argument is the name of the volume without the C</vol/> prefix.
4931
4932 Since the standard ignorelist functionality is used here, you can use a string
4933 starting and ending with a slash to specify regular expression matching: To
4934 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4935 expression:
4936
4937   GetIO "/^vol[027]$/"
4938
4939 If no regular expression is specified, an exact match is required. Both,
4940 regular and exact matching are case sensitive.
4941
4942 If no volume was specified at all for either of the three options, that data
4943 will be collected for all available volumes.
4944
4945 See F</"IGNORELISTS"> for details.
4946
4947 =item B<IgnoreSelectedIO> B<true>|B<false>
4948
4949 =item B<IgnoreSelectedOps> B<true>|B<false>
4950
4951 =item B<IgnoreSelectedLatency> B<true>|B<false>
4952
4953 When set to B<true>, the volumes selected for IO, operations or latency
4954 statistics collection will be ignored and the data will be collected for all
4955 other volumes.
4956
4957 When set to B<false>, data will only be collected for the specified volumes and
4958 all other volumes will be ignored.
4959
4960 If no volumes have been specified with the above B<Get*> options, all volumes
4961 will be collected regardless of the B<IgnoreSelected*> option.
4962
4963 Defaults to B<false>
4964
4965 =back
4966
4967 =head3 The VolumeUsage block
4968
4969 This will collect capacity data about the individual volumes.
4970
4971 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4972 capability.
4973
4974 =over 4
4975
4976 =item B<Interval> I<Seconds>
4977
4978 Collect volume usage statistics every I<Seconds> seconds.
4979
4980 =item B<GetCapacity> I<VolumeName>
4981
4982 The current capacity of the volume will be collected. This will result in two
4983 to four value lists, depending on the configuration of the volume. All data
4984 sources are of type "df_complex" with the name of the volume as
4985 plugin_instance.
4986
4987 There will be type_instances "used" and "free" for the number of used and
4988 available bytes on the volume.  If the volume has some space reserved for
4989 snapshots, a type_instance "snap_reserved" will be available.  If the volume
4990 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4991 number of bytes saved by the SIS feature.
4992
4993 B<Note:> The current NetApp API has a bug that results in this value being
4994 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4995 number which works most of the time.  If you see strange values here, bug
4996 NetApp support to fix this.
4997
4998 Repeat this option to specify multiple volumes.
4999
5000 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5001
5002 Specify whether to collect only the volumes selected by the B<GetCapacity>
5003 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5004 B<false>. However, if no B<GetCapacity> option is specified at all, all
5005 capacities will be selected anyway.
5006
5007 =item B<GetSnapshot> I<VolumeName>
5008
5009 Select volumes from which to collect snapshot information.
5010
5011 Usually, the space used for snapshots is included in the space reported as
5012 "used". If snapshot information is collected as well, the space used for
5013 snapshots is subtracted from the used space.
5014
5015 To make things even more interesting, it is possible to reserve space to be
5016 used for snapshots. If the space required for snapshots is less than that
5017 reserved space, there is "reserved free" and "reserved used" space in addition
5018 to "free" and "used". If the space required for snapshots exceeds the reserved
5019 space, that part allocated in the normal space is subtracted from the "used"
5020 space again.
5021
5022 Repeat this option to specify multiple volumes.
5023
5024 =item B<IgnoreSelectedSnapshot>
5025
5026 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5027 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5028 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5029 capacities will be selected anyway.
5030
5031 =back
5032
5033 =head3 The Quota block
5034
5035 This will collect (tree) quota statistics (used disk space and number of used
5036 files). This mechanism is useful to get usage information for single qtrees.
5037 In case the quotas are not used for any other purpose, an entry similar to the
5038 following in C</etc/quotas> would be sufficient:
5039
5040   /vol/volA/some_qtree tree - - - - -
5041
5042 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5043
5044 =over 4
5045
5046 =item B<Interval> I<Seconds>
5047
5048 Collect SnapVault(R) statistics every I<Seconds> seconds.
5049
5050 =back
5051
5052 =head3 The SnapVault block
5053
5054 This will collect statistics about the time and traffic of SnapVault(R)
5055 transfers.
5056
5057 =over 4
5058
5059 =item B<Interval> I<Seconds>
5060
5061 Collect SnapVault(R) statistics every I<Seconds> seconds.
5062
5063 =back
5064
5065 =head2 Plugin C<netlink>
5066
5067 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5068 statistics of various interface and routing aspects.
5069
5070 =over 4
5071
5072 =item B<Interface> I<Interface>
5073
5074 =item B<VerboseInterface> I<Interface>
5075
5076 Instruct the plugin to collect interface statistics. This is basically the same
5077 as the statistics provided by the C<interface> plugin (see above) but
5078 potentially much more detailed.
5079
5080 When configuring with B<Interface> only the basic statistics will be collected,
5081 namely octets, packets, and errors. These statistics are collected by
5082 the C<interface> plugin, too, so using both at the same time is no benefit.
5083
5084 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5085 so that no data needs to be collected twice if you use the C<interface> plugin.
5086 This includes dropped packets, received multicast packets, collisions and a
5087 whole zoo of differentiated RX and TX errors. You can try the following command
5088 to get an idea of what awaits you:
5089
5090   ip -s -s link list
5091
5092 If I<Interface> is B<All>, all interfaces will be selected.
5093
5094 =item B<QDisc> I<Interface> [I<QDisc>]
5095
5096 =item B<Class> I<Interface> [I<Class>]
5097
5098 =item B<Filter> I<Interface> [I<Filter>]
5099
5100 Collect the octets and packets that pass a certain qdisc, class or filter.
5101
5102 QDiscs and classes are identified by their type and handle (or classid).
5103 Filters don't necessarily have a handle, therefore the parent's handle is used.
5104 The notation used in collectd differs from that used in tc(1) in that it
5105 doesn't skip the major or minor number if it's zero and doesn't print special
5106 ids by their name. So, for example, a qdisc may be identified by
5107 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5108 thus not displayed by tc(1).
5109
5110 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5111 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5112 associated with that interface will be collected.
5113
5114 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5115 used. This may lead to problems when more than one filter is attached to a
5116 qdisc or class. This isn't nice, but we don't know how this could be done any
5117 better. If you have a idea, please don't hesitate to tell us.
5118
5119 As with the B<Interface> option you can specify B<All> as the interface,
5120 meaning all interfaces.
5121
5122 Here are some examples to help you understand the above text more easily:
5123
5124   <Plugin netlink>
5125     VerboseInterface "All"
5126     QDisc "eth0" "pfifo_fast-1:0"
5127     QDisc "ppp0"
5128     Class "ppp0" "htb-1:10"
5129     Filter "ppp0" "u32-1:0"
5130   </Plugin>
5131
5132 See F</"IGNORELISTS"> for details.
5133
5134 =item B<IgnoreSelected>
5135
5136 The behavior is the same as with all other similar plugins: If nothing is
5137 selected at all, everything is collected. If some things are selected using the
5138 options described above, only these statistics are collected. If you set
5139 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5140 specified statistics will not be collected.
5141
5142 =back
5143
5144 =head2 Plugin C<network>
5145
5146 The Network plugin sends data to a remote instance of collectd, receives data
5147 from a remote instance, or both at the same time. Data which has been received
5148 from the network is usually not transmitted again, but this can be activated, see
5149 the B<Forward> option below.
5150
5151 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5152 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5153
5154 Both, B<Server> and B<Listen> can be used as single option or as block. When
5155 used as block, given options are valid for this socket only. The following
5156 example will export the metrics twice: Once to an "internal" server (without
5157 encryption and signing) and one to an external server (with cryptographic
5158 signature):
5159
5160  <Plugin "network">
5161    # Export to an internal server
5162    # (demonstrates usage without additional options)
5163    Server "collectd.internal.tld"
5164
5165    # Export to an external server
5166    # (demonstrates usage with signature options)
5167    <Server "collectd.external.tld">
5168      SecurityLevel "sign"
5169      Username "myhostname"
5170      Password "ohl0eQue"
5171    </Server>
5172  </Plugin>
5173
5174 =over 4
5175
5176 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5177
5178 The B<Server> statement/block sets the server to send datagrams to. The
5179 statement may occur multiple times to send each datagram to multiple
5180 destinations.
5181
5182 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5183 optional second argument specifies a port number or a service name. If not
5184 given, the default, B<25826>, is used.
5185
5186 The following options are recognized within B<Server> blocks:
5187
5188 =over 4
5189
5190 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5191
5192 Set the security you require for network communication. When the security level
5193 has been set to B<Encrypt>, data sent over the network will be encrypted using
5194 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5195 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5196 authentication code. When set to B<None>, data is sent without any security.
5197
5198 This feature is only available if the I<network> plugin was linked with
5199 I<libgcrypt>.
5200
5201 =item B<Username> I<Username>
5202
5203 Sets the username to transmit. This is used by the server to lookup the
5204 password. See B<AuthFile> below. All security levels except B<None> require
5205 this setting.
5206
5207 This feature is only available if the I<network> plugin was linked with
5208 I<libgcrypt>.
5209
5210 =item B<Password> I<Password>
5211
5212 Sets a password (shared secret) for this socket. All security levels except
5213 B<None> require this setting.
5214
5215 This feature is only available if the I<network> plugin was linked with
5216 I<libgcrypt>.
5217
5218 =item B<Interface> I<Interface name>
5219
5220 Set the outgoing interface for IP packets. This applies at least
5221 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5222 undefined or a non-existent interface name is specified, the default
5223 behavior is to let the kernel choose the appropriate interface. Be warned
5224 that the manual selection of an interface for unicast traffic is only
5225 necessary in rare cases.
5226
5227 =item B<ResolveInterval> I<Seconds>
5228
5229 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5230 useful to force a regular DNS lookup to support a high availability setup. If
5231 not specified, re-resolves are never attempted.
5232
5233 =back
5234
5235 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5236
5237 The B<Listen> statement sets the interfaces to bind to. When multiple
5238 statements are found the daemon will bind to multiple interfaces.
5239
5240 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5241 the argument is a multicast address the daemon will join that multicast group.
5242 The optional second argument specifies a port number or a service name. If not
5243 given, the default, B<25826>, is used.
5244
5245 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5246
5247 =over 4
5248
5249 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5250
5251 Set the security you require for network communication. When the security level
5252 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5253 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5254 signed and encrypted data is accepted. When set to B<None>, all data will be
5255 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5256 decrypted if possible.
5257
5258 This feature is only available if the I<network> plugin was linked with
5259 I<libgcrypt>.
5260
5261 =item B<AuthFile> I<Filename>
5262
5263 Sets a file in which usernames are mapped to passwords. These passwords are
5264 used to verify signatures and to decrypt encrypted network packets. If
5265 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5266 verified and encrypted packets are decrypted. Otherwise, signed data is
5267 accepted without checking the signature and encrypted data cannot be decrypted.
5268 For the other security levels this option is mandatory.
5269
5270 The file format is very simple: Each line consists of a username followed by a
5271 colon and any number of spaces followed by the password. To demonstrate, an
5272 example file could look like this:
5273
5274   user0: foo
5275   user1: bar
5276
5277 Each time a packet is received, the modification time of the file is checked
5278 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5279 the file is being read, it is locked using L<fcntl(2)>.
5280
5281 =item B<Interface> I<Interface name>
5282
5283 Set the incoming interface for IP packets explicitly. This applies at least
5284 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5285 undefined or a non-existent interface name is specified, the default
5286 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5287 traffic gets only accepted, if it arrives on the given interface.
5288
5289 =back
5290
5291 =item B<TimeToLive> I<1-255>
5292
5293 Set the time-to-live of sent packets. This applies to all, unicast and
5294 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5295 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5296 operating systems.
5297
5298 =item B<MaxPacketSize> I<1024-65535>
5299
5300 Set the maximum size for datagrams received over the network. Packets larger
5301 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5302 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5303 UDP.
5304
5305 On the server side, this limit should be set to the largest value used on
5306 I<any> client. Likewise, the value on the client must not be larger than the
5307 value on the server, or data will be lost.
5308
5309 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5310 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5311 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5312 server.
5313
5314 =item B<Forward> I<true|false>
5315
5316 If set to I<true>, write packets that were received via the network plugin to
5317 the sending sockets. This should only be activated when the B<Listen>- and
5318 B<Server>-statements differ. Otherwise packets may be send multiple times to
5319 the same multicast group. While this results in more network traffic than
5320 necessary it's not a huge problem since the plugin has a duplicate detection,
5321 so the values will not loop.
5322
5323 =item B<ReportStats> B<true>|B<false>
5324
5325 The network plugin cannot only receive and send statistics, it can also create
5326 statistics about itself. Collectd data included the number of received and
5327 sent octets and packets, the length of the receive queue and the number of
5328 values handled. When set to B<true>, the I<Network plugin> will make these
5329 statistics available. Defaults to B<false>.
5330
5331 =back
5332
5333 =head2 Plugin C<nfs>
5334
5335 The I<nfs plugin> collects information about the usage of the Network File
5336 System (NFS). It counts the number of procedure calls for each procedure,
5337 grouped by version and whether the system runs as server or client.
5338
5339 It is possibly to omit metrics for a specific NFS version by setting one or
5340 more of the following options to B<false> (all of them default to B<true>).
5341
5342 =over 4
5343
5344 =item B<ReportV2> B<true>|B<false>
5345
5346 =item B<ReportV3> B<true>|B<false>
5347
5348 =item B<ReportV4> B<true>|B<false>
5349
5350 =back
5351
5352 =head2 Plugin C<nginx>
5353
5354 This plugin collects the number of connections and requests handled by the
5355 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5356 queries the page provided by the C<ngx_http_stub_status_module> module, which
5357 isn't compiled by default. Please refer to
5358 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5359 how to compile and configure nginx and this module.
5360
5361 The following options are accepted by the C<nginx plugin>:
5362
5363 =over 4
5364
5365 =item B<URL> I<http://host/nginx_status>
5366
5367 Sets the URL of the C<ngx_http_stub_status_module> output.
5368
5369 =item B<User> I<Username>
5370
5371 Optional user name needed for authentication.
5372
5373 =item B<Password> I<Password>
5374
5375 Optional password needed for authentication.
5376
5377 =item B<VerifyPeer> B<true|false>
5378
5379 Enable or disable peer SSL certificate verification. See
5380 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5381
5382 =item B<VerifyHost> B<true|false>
5383
5384 Enable or disable peer host name verification. If enabled, the plugin checks
5385 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5386 certificate matches the host name provided by the B<URL> option. If this
5387 identity check fails, the connection is aborted. Obviously, only works when
5388 connecting to a SSL enabled server. Enabled by default.
5389
5390 =item B<CACert> I<File>
5391
5392 File that holds one or more SSL certificates. If you want to use HTTPS you will
5393 possibly need this option. What CA certificates come bundled with C<libcurl>
5394 and are checked by default depends on the distribution you use.
5395
5396 =item B<Timeout> I<Milliseconds>
5397
5398 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5399 milliseconds. By default, the configured B<Interval> is used to set the
5400 timeout.
5401
5402 =back
5403
5404 =head2 Plugin C<notify_desktop>
5405
5406 This plugin sends a desktop notification to a notification daemon, as defined
5407 in the Desktop Notification Specification. To actually display the
5408 notifications, B<notification-daemon> is required and B<collectd> has to be
5409 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5410 environment variables have to be set correctly) and the D-Bus message bus.
5411
5412 The Desktop Notification Specification can be found at
5413 L<http://www.galago-project.org/specs/notification/>.
5414
5415 =over 4
5416
5417 =item B<OkayTimeout> I<timeout>
5418
5419 =item B<WarningTimeout> I<timeout>
5420
5421 =item B<FailureTimeout> I<timeout>
5422
5423 Set the I<timeout>, in milliseconds, after which to expire the notification
5424 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5425 been specified, the displayed notification will not be closed at all - the
5426 user has to do so herself. These options default to 5000. If a negative number
5427 has been specified, the default is used as well.
5428
5429 =back
5430
5431 =head2 Plugin C<notify_email>
5432
5433 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5434 configured email address.
5435
5436 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5437
5438 Available configuration options:
5439
5440 =over 4
5441
5442 =item B<From> I<Address>
5443
5444 Email address from which the emails should appear to come from.
5445
5446 Default: C<root@localhost>
5447
5448 =item B<Recipient> I<Address>
5449
5450 Configures the email address(es) to which the notifications should be mailed.
5451 May be repeated to send notifications to multiple addresses.
5452
5453 At least one B<Recipient> must be present for the plugin to work correctly.
5454
5455 =item B<SMTPServer> I<Hostname>
5456
5457 Hostname of the SMTP server to connect to.
5458
5459 Default: C<localhost>
5460
5461 =item B<SMTPPort> I<Port>
5462
5463 TCP port to connect to.
5464
5465 Default: C<25>
5466
5467 =item B<SMTPUser> I<Username>
5468
5469 Username for ASMTP authentication. Optional.
5470
5471 =item B<SMTPPassword> I<Password>
5472
5473 Password for ASMTP authentication. Optional.
5474
5475 =item B<Subject> I<Subject>
5476
5477 Subject-template to use when sending emails. There must be exactly two
5478 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5479 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5480 with the hostname.
5481
5482 Default: C<Collectd notify: %s@%s>
5483
5484 =back
5485
5486 =head2 Plugin C<notify_nagios>
5487
5488 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5489 a I<passive service check result>.
5490
5491 Available configuration options:
5492
5493 =over 4
5494
5495 =item B<CommandFile> I<Path>
5496
5497 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5498
5499 =back
5500
5501 =head2 Plugin C<ntpd>
5502
5503 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5504 dispersion.
5505
5506 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5507 the wire - using B<mode 7> specific requests. This mode is deprecated with
5508 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5509 correctly with them, the ntp daemon must be explicitly configured to
5510 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5511 manual page for details.
5512
5513 Available configuration options for the C<ntpd> plugin:
5514
5515 =over 4
5516
5517 =item B<Host> I<Hostname>
5518
5519 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5520
5521 =item B<Port> I<Port>
5522
5523 UDP-Port to connect to. Defaults to B<123>.
5524
5525 =item B<ReverseLookups> B<true>|B<false>
5526
5527 Sets whether or not to perform reverse lookups on peers. Since the name or
5528 IP-address may be used in a filename it is recommended to disable reverse
5529 lookups. The default is to do reverse lookups to preserve backwards
5530 compatibility, though.
5531
5532 =item B<IncludeUnitID> B<true>|B<false>
5533
5534 When a peer is a refclock, include the unit ID in the I<type instance>.
5535 Defaults to B<false> for backward compatibility.
5536
5537 If two refclock peers use the same driver and this is B<false>, the plugin will
5538 try to write simultaneous measurements from both to the same type instance.
5539 This will result in error messages in the log and only one set of measurements
5540 making it through.
5541
5542 =back
5543
5544 =head2 Plugin C<nut>
5545
5546 =over 4
5547
5548 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5549
5550 Add a UPS to collect data from. The format is identical to the one accepted by
5551 L<upsc(8)>.
5552
5553 =item B<ForceSSL> B<true>|B<false>
5554
5555 Stops connections from falling back to unsecured if an SSL connection
5556 cannot be established. Defaults to false if undeclared.
5557
5558 =item B<VerifyPeer> I<true>|I<false>
5559
5560 If set to true, requires a CAPath be provided. Will use the CAPath to find
5561 certificates to use as Trusted Certificates to validate a upsd server certificate.
5562 If validation of the upsd server certificate fails, the connection will not be
5563 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5564 will override and set ForceSSL to true.
5565
5566 =item B<CAPath> I/path/to/certs/folder
5567
5568 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5569 The folder pointed at must contain certificate(s) named according to their hash.
5570 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5571 occur because two different certs have the same hash value, Y can be  incremented
5572 in order to avoid conflict. To create a symbolic link to a certificate the following
5573 command can be used from within the directory where the cert resides:
5574
5575 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5576
5577 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5578 generate links like the one described above for ALL certs in a given folder.
5579 Example usage:
5580 C<c_rehash /path/to/certs/folder>
5581
5582 =item B<ConnectTimeout> I<Milliseconds>
5583
5584 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5585 By default, the configured B<Interval> is used to set the timeout.
5586
5587 =back
5588
5589 =head2 Plugin C<olsrd>
5590
5591 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5592 the Optimized Link State Routing daemon and reads information about the current
5593 state of the meshed network.
5594
5595 The following configuration options are understood:
5596
5597 =over 4
5598
5599 =item B<Host> I<Host>
5600
5601 Connect to I<Host>. Defaults to B<"localhost">.
5602
5603 =item B<Port> I<Port>
5604
5605 Specifies the port to connect to. This must be a string, even if you give the
5606 port as a number rather than a service name. Defaults to B<"2006">.
5607
5608 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5609
5610 Specifies what information to collect about links, i.E<nbsp>e. direct
5611 connections of the daemon queried. If set to B<No>, no information is
5612 collected. If set to B<Summary>, the number of links and the average of all
5613 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5614 If set to B<Detail> LQ and NLQ are collected per link.
5615
5616 Defaults to B<Detail>.
5617
5618 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5619
5620 Specifies what information to collect about routes of the daemon queried. If
5621 set to B<No>, no information is collected. If set to B<Summary>, the number of
5622 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5623 metric and ETX are collected per route.
5624
5625 Defaults to B<Summary>.
5626
5627 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5628
5629 Specifies what information to collect about the global topology. If set to
5630 B<No>, no information is collected. If set to B<Summary>, the number of links
5631 in the entire topology and the average I<link quality> (LQ) is calculated.
5632 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5633
5634 Defaults to B<Summary>.
5635
5636 =back
5637
5638 =head2 Plugin C<onewire>
5639
5640 B<EXPERIMENTAL!> See notes below.
5641
5642 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5643 L<http://owfs.org/> to read sensors connected via the onewire bus.
5644
5645 It can be used in two possible modes - standard or advanced.
5646
5647 In the standard mode only temperature sensors (sensors with the family code
5648 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5649 other sensors you would like to have included, please send a sort request to
5650 the mailing list. You can select sensors to be read or to be ignored depending
5651 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5652 walked and all sensors are read.
5653
5654 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5655 experimental, below.
5656
5657 In the advanced mode you can configure any sensor to be read (only numerical
5658 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5659 In this mode you have to list all the sensors. Neither default bus walk nor
5660 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5661 the path automatically and should produce compatible structure with the "standard"
5662 mode (basically the path is expected as for example
5663 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5664 "F10FCA000800" and the rest after the slash is considered the type - here
5665 "temperature").
5666 There are two advantages to this mode - you can access virtually any sensor
5667 (not just temperature), select whether to use cached or directly read values
5668 and it is slighlty faster. The downside is more complex configuration.
5669
5670 The two modes are distinguished automatically by the format of the address.
5671 It is not possible to mix the two modes. Once a full path is detected in any
5672 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5673 (and as standard addresses will fail parsing they will be ignored).
5674
5675 =over 4
5676
5677 =item B<Device> I<Device>
5678
5679 Sets the device to read the values from. This can either be a "real" hardware
5680 device, such as a serial port or an USB port, or the address of the
5681 L<owserver(1)> socket, usually B<localhost:4304>.
5682
5683 Though the documentation claims to automatically recognize the given address
5684 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5685 with that version, the following configuration worked for us:
5686
5687   <Plugin onewire>
5688     Device "-s localhost:4304"
5689   </Plugin>
5690
5691 This directive is B<required> and does not have a default value.
5692
5693 =item B<Sensor> I<Sensor>
5694
5695 In the standard mode selects sensors to collect or to ignore
5696 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5697 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5698 and B<not> include the leading C<10.> family byte and point.
5699 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5700 sensors (see above) are read.
5701
5702 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5703 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5704 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5705
5706 As there can be multiple devices on the bus you can list multiple sensor (use
5707 multiple B<Sensor> elements).
5708
5709 See F</"IGNORELISTS"> for details.
5710
5711 =item B<IgnoreSelected> I<true>|I<false>
5712
5713 If no configuration is given, the B<onewire> plugin will collect data from all
5714 sensors found. This may not be practical, especially if sensors are added and
5715 removed regularly. Sometimes, however, it's easier/preferred to collect only
5716 specific sensors or all sensors I<except> a few specified ones. This option
5717 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5718 B<Sensor> is inverted: All selected interfaces are ignored and all other
5719 interfaces are collected.
5720
5721 Used only in the standard mode - see above.
5722
5723 =item B<Interval> I<Seconds>
5724
5725 Sets the interval in which all sensors should be read. If not specified, the
5726 global B<Interval> setting is used.
5727
5728 =back
5729
5730 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5731 work with big setups. It works with one sensor being attached to one
5732 controller, but as soon as you throw in a couple more senors and maybe a hub
5733 or two, reading all values will take more than ten seconds (the default
5734 interval). We will probably add some separate thread for reading the sensors
5735 and some cache or something like that, but it's not done yet. We will try to
5736 maintain backwards compatibility in the future, but we can't promise. So in
5737 short: If it works for you: Great! But keep in mind that the config I<might>
5738 change, though this is unlikely. Oh, and if you want to help improving this
5739 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5740
5741 =head2 Plugin C<openldap>
5742
5743 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5744 server correctly. The backend database C<monitor> needs to be loaded and
5745 working. See slapd-monitor(5) for the details.
5746
5747 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5748 blocks. Each block requires one string argument as the instance name. For
5749 example:
5750
5751  <Plugin "openldap">
5752    <Instance "foo">
5753      URL "ldap://localhost/"
5754    </Instance>
5755    <Instance "bar">
5756      URL "ldaps://localhost/"
5757    </Instance>
5758  </Plugin>
5759
5760 The instance name will be used as the I<plugin instance>. To emulate the old
5761 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5762 plugin to work correctly, each instance name must be unique. This is not
5763 enforced by the plugin and it is your responsibility to ensure it is.
5764
5765 The following options are accepted within each B<Instance> block:
5766
5767 =over 4
5768
5769 =item B<URL> I<ldap://host/binddn>
5770
5771 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5772 I<mandatory>.
5773
5774 =item B<BindDN> I<BindDN>
5775
5776 Name in the form of an LDAP distinguished name intended to be used for
5777 authentication. Defaults to empty string to establish an anonymous authorization.
5778
5779 =item B<Password> I<Password>
5780
5781 Password for simple bind authentication. If this option is not set,
5782 unauthenticated bind operation is used.
5783
5784 =item B<StartTLS> B<true|false>
5785
5786 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5787 Disabled by default.
5788
5789 =item B<VerifyHost> B<true|false>
5790
5791 Enables or disables peer host name verification. If enabled, the plugin checks
5792 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5793 certificate matches the host name provided by the B<URL> option. If this
5794 identity check fails, the connection is aborted. Enabled by default.
5795
5796 =item B<CACert> I<File>
5797
5798 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5799 may possibly need this option. What CA certificates are checked by default
5800 depends on the distribution you use and can be changed with the usual ldap
5801 client configuration mechanisms. See ldap.conf(5) for the details.
5802
5803 =item B<Timeout> I<Seconds>
5804
5805 Sets the timeout value for ldap operations, in seconds. By default, the
5806 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5807 (infinite timeout).
5808
5809 =item B<Version> I<Version>
5810
5811 An integer which sets the LDAP protocol version number to use when connecting
5812 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5813
5814 =back
5815
5816 =head2 Plugin C<openvpn>
5817
5818 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5819 traffic statistics about connected clients.
5820
5821 To set up OpenVPN to write to the status file periodically, use the
5822 B<--status> option of OpenVPN.
5823
5824 So, in a nutshell you need:
5825
5826   openvpn $OTHER_OPTIONS \
5827     --status "/var/run/openvpn-status" 10
5828
5829 Available options:
5830
5831 =over 4
5832
5833 =item B<StatusFile> I<File>
5834
5835 Specifies the location of the status file.
5836
5837 =item B<ImprovedNamingSchema> B<true>|B<false>
5838
5839 When enabled, the filename of the status file will be used as plugin instance
5840 and the client's "common name" will be used as type instance. This is required
5841 when reading multiple status files. Enabling this option is recommended, but to
5842 maintain backwards compatibility this option is disabled by default.
5843
5844 =item B<CollectCompression> B<true>|B<false>
5845
5846 Sets whether or not statistics about the compression used by OpenVPN should be
5847 collected. This information is only available in I<single> mode. Enabled by
5848 default.
5849
5850 =item B<CollectIndividualUsers> B<true>|B<false>
5851
5852 Sets whether or not traffic information is collected for each connected client
5853 individually. If set to false, currently no traffic data is collected at all
5854 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5855
5856 =item B<CollectUserCount> B<true>|B<false>
5857
5858 When enabled, the number of currently connected clients or users is collected.
5859 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5860 can be configured independently from that option. Defaults to B<false>.
5861
5862 =back
5863
5864 =head2 Plugin C<oracle>
5865
5866 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5867 Oracle® Database and lets you execute SQL statements there. It is very similar
5868 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5869 plugin's documentation above for details.
5870
5871   <Plugin oracle>
5872     <Query "out_of_stock">
5873       Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5874       <Result>
5875         Type "gauge"
5876         # InstancePrefix "foo"
5877         InstancesFrom "category"
5878         ValuesFrom "value"
5879       </Result>
5880     </Query>
5881     <Database "product_information">
5882       #Plugin "warehouse"
5883       ConnectID "db01"
5884       Username "oracle"
5885       Password "secret"
5886       Query "out_of_stock"
5887     </Database>
5888   </Plugin>
5889
5890 =head3 B<Query> blocks
5891
5892 The Query blocks are handled identically to the Query blocks of the "dbi"
5893 plugin. Please see its documentation above for details on how to specify
5894 queries.
5895
5896 =head3 B<Database> blocks
5897
5898 Database blocks define a connection to a database and which queries should be
5899 sent to that database. Each database needs a "name" as string argument in the
5900 starting tag of the block. This name will be used as "PluginInstance" in the
5901 values submitted to the daemon. Other than that, that name is not used.
5902
5903 =over 4
5904
5905 =item B<Plugin> I<Plugin>
5906
5907 Use I<Plugin> as the plugin name when submitting query results from
5908 this B<Database>. Defaults to C<oracle>.
5909
5910 =item B<ConnectID> I<ID>
5911
5912 Defines the "database alias" or "service name" to connect to. Usually, these
5913 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5914
5915 =item B<Host> I<Host>
5916
5917 Hostname to use when dispatching values for this database. Defaults to using
5918 the global hostname of the I<collectd> instance.
5919
5920 =item B<Username> I<Username>
5921
5922 Username used for authentication.
5923
5924 =item B<Password> I<Password>
5925
5926 Password used for authentication.
5927
5928 =item B<Query> I<QueryName>
5929
5930 Associates the query named I<QueryName> with this database connection. The
5931 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5932 blocks you want to refer to must be placed above the database block you want to
5933 refer to them from.
5934
5935 =back
5936
5937 =head2 Plugin C<ovs_events>
5938
5939 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5940 connected interfaces, dispatches the values to collectd and sends the
5941 notification whenever the link state change occurs. This plugin uses OVS
5942 database to get a link state change notification.
5943
5944 B<Synopsis:>
5945
5946  <Plugin "ovs_events">
5947    Port 6640
5948    Address "127.0.0.1"
5949    Socket "/var/run/openvswitch/db.sock"
5950    Interfaces "br0" "veth0"
5951    SendNotification true
5952    DispatchValues false
5953  </Plugin>
5954
5955 The plugin provides the following configuration options:
5956
5957 =over 4
5958
5959 =item B<Address> I<node>
5960
5961 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5962 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5963 option. See L<ovsdb-server(1)> for more details. The option may be either
5964 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5965 format. Defaults to C<localhost>.
5966
5967 =item B<Port> I<service>
5968
5969 TCP-port to connect to. Either a service name or a port number may be given.
5970 Defaults to B<6640>.
5971
5972 =item B<Socket> I<path>
5973
5974 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5975 plugin. To enable the interface, the OVS DB daemon should be running with
5976 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5977 option is set, B<Address> and B<Port> options are ignored.
5978
5979 =item B<Interfaces> [I<ifname> ...]
5980
5981 List of interface names to be monitored by this plugin. If this option is not
5982 specified or is empty then all OVS connected interfaces on all bridges are
5983 monitored.
5984
5985 Default: empty (all interfaces on all bridges are monitored)
5986
5987 =item B<SendNotification> I<true|false>
5988
5989 If set to true, OVS link notifications (interface status and OVS DB connection
5990 terminate) are sent to collectd. Default value is true.
5991
5992 =item B<DispatchValues> I<true|false>
5993
5994 Dispatch the OVS DB interface link status value with configured plugin interval.
5995 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
5996 options are false, no OVS information will be provided by the plugin.
5997
5998 =back
5999
6000 B<Note:> By default, the global interval setting is used within which to
6001 retrieve the OVS link status. To configure a plugin-specific interval, please
6002 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6003 simple divide the time by 1000 for example if the desired interval is 50ms, set
6004 interval to 0.05.
6005
6006 =head2 Plugin C<ovs_stats>
6007
6008 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6009 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6010 statistics from OVSDB
6011
6012 B<Synopsis:>
6013
6014  <Plugin "ovs_stats">
6015    Port 6640
6016    Address "127.0.0.1"
6017    Socket "/var/run/openvswitch/db.sock"
6018    Bridges "br0" "br_ext"
6019  </Plugin>
6020
6021 The plugin provides the following configuration options:
6022
6023 =over 4
6024
6025 =item B<Address> I<node>
6026
6027 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6028 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6029 option. See L<ovsdb-server(1)> for more details. The option may be either
6030 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6031 format. Defaults to C<localhost>.
6032
6033 =item B<Port> I<service>
6034
6035 TCP-port to connect to. Either a service name or a port number may be given.
6036 Defaults to B<6640>.
6037
6038 =item B<Socket> I<path>
6039
6040 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6041 plugin. To enable the interface, the OVS DB daemon should be running with
6042 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6043 option is set, B<Address> and B<Port> options are ignored.
6044
6045 =item B<Bridges> [I<brname> ...]
6046
6047 List of OVS bridge names to be monitored by this plugin. If this option is
6048 omitted or is empty then all OVS bridges will be monitored.
6049
6050 Default: empty (monitor all bridges)
6051
6052 =back
6053
6054 =head2 Plugin C<perl>
6055
6056 This plugin embeds a Perl-interpreter into collectd and provides an interface
6057 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6058
6059 =head2 Plugin C<pinba>
6060
6061 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6062 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6063 PHP-based webpage has been delivered, the extension will send a UDP packet
6064 containing timing information, peak memory usage and so on. The plugin will
6065 wait for such packets, parse them and account the provided information, which
6066 is then dispatched to the daemon once per interval.
6067
6068 Synopsis:
6069
6070  <Plugin pinba>
6071    Address "::0"
6072    Port "30002"
6073    # Overall statistics for the website.
6074    <View "www-total">
6075      Server "www.example.com"
6076    </View>
6077    # Statistics for www-a only
6078    <View "www-a">
6079      Host "www-a.example.com"
6080      Server "www.example.com"
6081    </View>
6082    # Statistics for www-b only
6083    <View "www-b">
6084      Host "www-b.example.com"
6085      Server "www.example.com"
6086    </View>
6087  </Plugin>
6088
6089 The plugin provides the following configuration options:
6090
6091 =over 4
6092
6093 =item B<Address> I<Node>
6094
6095 Configures the address used to open a listening socket. By default, plugin will
6096 bind to the I<any> address C<::0>.
6097
6098 =item B<Port> I<Service>
6099
6100 Configures the port (service) to bind to. By default the default Pinba port
6101 "30002" will be used. The option accepts service names in addition to port
6102 numbers and thus requires a I<string> argument.
6103
6104 =item E<lt>B<View> I<Name>E<gt> block
6105
6106 The packets sent by the Pinba extension include the hostname of the server, the
6107 server name (the name of the virtual host) and the script that was executed.
6108 Using B<View> blocks it is possible to separate the data into multiple groups
6109 to get more meaningful statistics. Each packet is added to all matching groups,
6110 so that a packet may be accounted for more than once.
6111
6112 =over 4
6113
6114 =item B<Host> I<Host>
6115
6116 Matches the hostname of the system the webserver / script is running on. This
6117 will contain the result of the L<gethostname(2)> system call. If not
6118 configured, all hostnames will be accepted.
6119
6120 =item B<Server> I<Server>
6121
6122 Matches the name of the I<virtual host>, i.e. the contents of the
6123 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6124 server names will be accepted.
6125
6126 =item B<Script> I<Script>
6127
6128 Matches the name of the I<script name>, i.e. the contents of the
6129 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6130 script names will be accepted.
6131
6132 =back
6133
6134 =back
6135
6136 =head2 Plugin C<ping>
6137
6138 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6139 configured hosts periodically and measures the network latency. Whenever the
6140 C<read> function of the plugin is called, it submits the average latency, the
6141 standard deviation and the drop rate for each host.
6142
6143 Available configuration options:
6144
6145 =over 4
6146
6147 =item B<Host> I<IP-address>
6148
6149 Host to ping periodically. This option may be repeated several times to ping
6150 multiple hosts.
6151
6152 =item B<Interval> I<Seconds>
6153
6154 Sets the interval in which to send ICMP echo packets to the configured hosts.
6155 This is B<not> the interval in which metrics are read from the plugin but the
6156 interval in which the hosts are "pinged". Therefore, the setting here should be
6157 smaller than or equal to the global B<Interval> setting. Fractional times, such
6158 as "1.24" are allowed.
6159
6160 Default: B<1.0>
6161
6162 =item B<Timeout> I<Seconds>
6163
6164 Time to wait for a response from the host to which an ICMP packet had been
6165 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6166 to be down or the packet to be dropped. This setting must be smaller than the
6167 B<Interval> setting above for the plugin to work correctly. Fractional
6168 arguments are accepted.
6169
6170 Default: B<0.9>
6171
6172 =item B<TTL> I<0-255>
6173
6174 Sets the Time-To-Live of generated ICMP packets.
6175
6176 =item B<Size> I<size>
6177
6178 Sets the size of the data payload in ICMP packet to specified I<size> (it
6179 will be filled with regular ASCII pattern). If not set, default 56 byte
6180 long string is used so that the packet size of an ICMPv4 packet is exactly
6181 64 bytes, similar to the behaviour of normal ping(1) command.
6182
6183 =item B<SourceAddress> I<host>
6184
6185 Sets the source address to use. I<host> may either be a numerical network
6186 address or a network hostname.
6187
6188 =item B<AddressFamily> I<af>
6189
6190 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6191 option will be ignored if you set a B<SourceAddress>.
6192
6193 =item B<Device> I<name>
6194
6195 Sets the outgoing network device to be used. I<name> has to specify an
6196 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6197 operating systems.
6198
6199 =item B<MaxMissed> I<Packets>
6200
6201 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6202 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6203
6204 Default: B<-1> (disabled)
6205
6206 =back
6207
6208 =head2 Plugin C<postgresql>
6209
6210 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6211 keeps a persistent connection to all configured databases and tries to
6212 reconnect if the connection has been interrupted. A database is configured by
6213 specifying a B<Database> block as described below. The default statistics are
6214 collected from PostgreSQL's B<statistics collector> which thus has to be
6215 enabled for this plugin to work correctly. This should usually be the case by
6216 default. See the section "The Statistics Collector" of the B<PostgreSQL
6217 Documentation> for details.
6218
6219 By specifying custom database queries using a B<Query> block as described
6220 below, you may collect any data that is available from some PostgreSQL
6221 database. This way, you are able to access statistics of external daemons
6222 which are available in a PostgreSQL database or use future or special
6223 statistics provided by PostgreSQL without the need to upgrade your collectd
6224 installation.
6225
6226 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6227 PostgreSQL databases as well. This has been implemented in a generic way. You
6228 need to specify an SQL statement which will then be executed by collectd in
6229 order to write the data (see below for details). The benefit of that approach
6230 is that there is no fixed database layout. Rather, the layout may be optimized
6231 for the current setup.
6232
6233 The B<PostgreSQL Documentation> manual can be found at
6234 L<http://www.postgresql.org/docs/manuals/>.
6235
6236   <Plugin postgresql>
6237     <Query magic>
6238       Statement "SELECT magic FROM wizard WHERE host = $1;"
6239       Param hostname
6240       <Result>
6241         Type gauge
6242         InstancePrefix "magic"
6243         ValuesFrom magic
6244       </Result>
6245     </Query>
6246
6247     <Query rt36_tickets>
6248       Statement "SELECT COUNT(type) AS count, type \
6249                         FROM (SELECT CASE \
6250                                      WHEN resolved = 'epoch' THEN 'open' \
6251                                      ELSE 'resolved' END AS type \
6252                                      FROM tickets) type \
6253                         GROUP BY type;"
6254       <Result>
6255         Type counter
6256         InstancePrefix "rt36_tickets"
6257         InstancesFrom "type"
6258         ValuesFrom "count"
6259       </Result>
6260     </Query>
6261
6262     <Writer sqlstore>
6263       Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6264       StoreRates true
6265     </Writer>
6266
6267     <Database foo>
6268       Plugin "kingdom"
6269       Host "hostname"
6270       Port "5432"
6271       User "username"
6272       Password "secret"
6273       SSLMode "prefer"
6274       KRBSrvName "kerberos_service_name"
6275       Query magic
6276     </Database>
6277
6278     <Database bar>
6279       Interval 300
6280       Service "service_name"
6281       Query backends # predefined
6282       Query rt36_tickets
6283     </Database>
6284
6285     <Database qux>
6286       # ...
6287       Writer sqlstore
6288       CommitInterval 10
6289     </Database>
6290   </Plugin>
6291
6292 The B<Query> block defines one database query which may later be used by a
6293 database definition. It accepts a single mandatory argument which specifies
6294 the name of the query. The names of all queries have to be unique (see the
6295 B<MinVersion> and B<MaxVersion> options below for an exception to this
6296 rule).
6297
6298 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6299 B<Result> blocks may be used to extract multiple values from a single query.
6300
6301 The following configuration options are available to define the query:
6302
6303 =over 4
6304
6305 =item B<Statement> I<sql query statement>
6306
6307 Specify the I<sql query statement> which the plugin should execute. The string
6308 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6309 first, second, etc. parameter. The value of the parameters is specified by the
6310 B<Param> configuration option - see below for details. To include a literal
6311 B<$> character followed by a number, surround it with single quotes (B<'>).
6312
6313 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6314 allowed. Note, however, that only a single command may be used. Semicolons are
6315 allowed as long as a single non-empty command has been specified only.
6316
6317 The returned lines will be handled separately one after another.
6318
6319 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6320
6321 Specify the parameters which should be passed to the SQL query. The parameters
6322 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6323 they appear in the configuration file. The value of the parameter is
6324 determined depending on the value of the B<Param> option as follows:
6325
6326 =over 4
6327
6328 =item I<hostname>
6329
6330 The configured hostname of the database connection. If a UNIX domain socket is
6331 used, the parameter expands to "localhost".
6332
6333 =item I<database>
6334
6335 The name of the database of the current connection.
6336
6337 =item I<instance>
6338
6339 The name of the database plugin instance. See the B<Instance> option of the
6340 database specification below for details.
6341
6342 =item I<username>
6343
6344 The username used to connect to the database.
6345
6346 =item I<interval>
6347
6348 The interval with which this database is queried (as specified by the database
6349 specific or global B<Interval> options).
6350
6351 =back
6352
6353 Please note that parameters are only supported by PostgreSQL's protocol
6354 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6355
6356 =item B<PluginInstanceFrom> I<column>
6357
6358 Specify how to create the "PluginInstance" for reporting this query results.
6359 Only one column is supported. You may concatenate fields and string values in
6360 the query statement to get the required results.
6361
6362 =item B<MinVersion> I<version>
6363
6364 =item B<MaxVersion> I<version>
6365
6366 Specify the minimum or maximum version of PostgreSQL that this query should be
6367 used with. Some statistics might only be available with certain versions of
6368 PostgreSQL. This allows you to specify multiple queries with the same name but
6369 which apply to different versions, thus allowing you to use the same
6370 configuration in a heterogeneous environment.
6371
6372 The I<version> has to be specified as the concatenation of the major, minor
6373 and patch-level versions, each represented as two-decimal-digit numbers. For
6374 example, version 8.2.3 will become 80203.
6375
6376 =back
6377
6378 The B<Result> block defines how to handle the values returned from the query.
6379 It defines which column holds which value and how to dispatch that value to
6380 the daemon.
6381
6382 =over 4
6383
6384 =item B<Type> I<type>
6385
6386 The I<type> name to be used when dispatching the values. The type describes
6387 how to handle the data and where to store it. See L<types.db(5)> for more
6388 details on types and their configuration. The number and type of values (as
6389 selected by the B<ValuesFrom> option) has to match the type of the given name.
6390
6391 This option is mandatory.
6392
6393 =item B<InstancePrefix> I<prefix>
6394
6395 =item B<InstancesFrom> I<column0> [I<column1> ...]
6396
6397 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6398 B<InstancePrefix> defines a static prefix that will be prepended to all type
6399 instances. B<InstancesFrom> defines the column names whose values will be used
6400 to create the type instance. Multiple values will be joined together using the
6401 hyphen (C<->) as separation character.
6402
6403 The plugin itself does not check whether or not all built instances are
6404 different. It is your responsibility to assure that each is unique.
6405
6406 Both options are optional. If none is specified, the type instance will be
6407 empty.
6408
6409 =item B<ValuesFrom> I<column0> [I<column1> ...]
6410
6411 Names the columns whose content is used as the actual data for the data sets
6412 that are dispatched to the daemon. How many such columns you need is
6413 determined by the B<Type> setting as explained above. If you specify too many
6414 or not enough columns, the plugin will complain about that and no data will be
6415 submitted to the daemon.
6416
6417 The actual data type, as seen by PostgreSQL, is not that important as long as
6418 it represents numbers. The plugin will automatically cast the values to the
6419 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6420 L<strtod(3)> functions, so anything supported by those functions is supported
6421 by the plugin as well.
6422
6423 This option is required inside a B<Result> block and may be specified multiple
6424 times. If multiple B<ValuesFrom> options are specified, the columns are read
6425 in the given order.
6426
6427 =back
6428
6429 The following predefined queries are available (the definitions can be found
6430 in the F<postgresql_default.conf> file which, by default, is available at
6431 C<I<prefix>/share/collectd/>):
6432
6433 =over 4
6434
6435 =item B<backends>
6436
6437 This query collects the number of backends, i.E<nbsp>e. the number of
6438 connected clients.
6439
6440 =item B<transactions>
6441
6442 This query collects the numbers of committed and rolled-back transactions of
6443 the user tables.
6444
6445 =item B<queries>
6446
6447 This query collects the numbers of various table modifications (i.E<nbsp>e.
6448 insertions, updates, deletions) of the user tables.
6449
6450 =item B<query_plans>
6451
6452 This query collects the numbers of various table scans and returned tuples of
6453 the user tables.
6454
6455 =item B<table_states>
6456
6457 This query collects the numbers of live and dead rows in the user tables.
6458
6459 =item B<disk_io>
6460
6461 This query collects disk block access counts for user tables.
6462
6463 =item B<disk_usage>
6464
6465 This query collects the on-disk size of the database in bytes.
6466
6467 =back
6468
6469 In addition, the following detailed queries are available by default. Please
6470 note that each of those queries collects information B<by table>, thus,
6471 potentially producing B<a lot> of data. For details see the description of the
6472 non-by_table queries above.
6473
6474 =over 4
6475
6476 =item B<queries_by_table>
6477
6478 =item B<query_plans_by_table>
6479
6480 =item B<table_states_by_table>
6481
6482 =item B<disk_io_by_table>
6483
6484 =back
6485
6486 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6487 mandatory argument specifying the name of the writer. This will then be used
6488 in the B<Database> specification in order to activate the writer instance. The
6489 names of all writers have to be unique. The following options may be
6490 specified:
6491
6492 =over 4
6493
6494 =item B<Statement> I<sql statement>
6495
6496 This mandatory option specifies the SQL statement that will be executed for
6497 each submitted value. A single SQL statement is allowed only. Anything after
6498 the first semicolon will be ignored.
6499
6500 Nine parameters will be passed to the statement and should be specified as
6501 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6502 values are made available through those parameters:
6503
6504 =over 4
6505
6506 =item B<$1>
6507
6508 The timestamp of the queried value as an RFC 3339-formatted local time.
6509
6510 =item B<$2>
6511
6512 The hostname of the queried value.
6513
6514 =item B<$3>
6515
6516 The plugin name of the queried value.
6517
6518 =item B<$4>
6519
6520 The plugin instance of the queried value. This value may be B<NULL> if there
6521 is no plugin instance.
6522
6523 =item B<$5>
6524
6525 The type of the queried value (cf. L<types.db(5)>).
6526
6527 =item B<$6>
6528
6529 The type instance of the queried value. This value may be B<NULL> if there is
6530 no type instance.
6531
6532 =item B<$7>
6533
6534 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6535 sources of the submitted value-list).
6536
6537 =item B<$8>
6538
6539 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6540 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6541 B<StoreRates> is enabled (which is the default, see below), all types will be
6542 C<gauge>.
6543
6544 =item B<$9>
6545
6546 An array of the submitted values. The dimensions of the value name and value
6547 arrays match.
6548
6549 =back
6550
6551 In general, it is advisable to create and call a custom function in the
6552 PostgreSQL database for this purpose. Any procedural language supported by
6553 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6554 for details).
6555
6556 =item B<StoreRates> B<false>|B<true>
6557
6558 If set to B<true> (the default), convert counter values to rates. If set to
6559 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6560 number.
6561
6562 =back
6563
6564 The B<Database> block defines one PostgreSQL database for which to collect
6565 statistics. It accepts a single mandatory argument which specifies the
6566 database name. None of the other options are required. PostgreSQL will use
6567 default values as documented in the section "CONNECTING TO A DATABASE" in the
6568 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6569 the user collectd is run as and special environment variables. See the manpage
6570 for details.
6571
6572 =over 4
6573
6574 =item B<Interval> I<seconds>
6575
6576 Specify the interval with which the database should be queried. The default is
6577 to use the global B<Interval> setting.
6578
6579 =item B<CommitInterval> I<seconds>
6580
6581 This option may be used for database connections which have "writers" assigned
6582 (see above). If specified, it causes a writer to put several updates into a
6583 single transaction. This transaction will last for the specified amount of
6584 time. By default, each update will be executed in a separate transaction. Each
6585 transaction generates a fair amount of overhead which can, thus, be reduced by
6586 activating this option. The draw-back is, that data covering the specified
6587 amount of time will be lost, for example, if a single statement within the
6588 transaction fails or if the database server crashes.
6589
6590 =item B<Plugin> I<Plugin>
6591
6592 Use I<Plugin> as the plugin name when submitting query results from
6593 this B<Database>. Defaults to C<postgresql>.
6594
6595 =item B<Instance> I<name>
6596
6597 Specify the plugin instance name that should be used instead of the database
6598 name (which is the default, if this option has not been specified). This
6599 allows one to query multiple databases of the same name on the same host (e.g.
6600 when running multiple database server versions in parallel).
6601 The plugin instance name can also be set from the query result using
6602 the B<PluginInstanceFrom> option in B<Query> block.
6603
6604 =item B<Host> I<hostname>
6605
6606 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6607 value begins with a slash, it is interpreted as the directory name in which to
6608 look for the UNIX domain socket.
6609
6610 This option is also used to determine the hostname that is associated with a
6611 collected data set. If it has been omitted or either begins with with a slash
6612 or equals B<localhost> it will be replaced with the global hostname definition
6613 of collectd. Any other value will be passed literally to collectd when
6614 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6615
6616 =item B<Port> I<port>
6617
6618 Specify the TCP port or the local UNIX domain socket file extension of the
6619 server.
6620
6621 =item B<User> I<username>
6622
6623 Specify the username to be used when connecting to the server.
6624
6625 =item B<Password> I<password>
6626
6627 Specify the password to be used when connecting to the server.
6628
6629 =item B<ExpireDelay> I<delay>
6630
6631 Skip expired values in query output.
6632
6633 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6634
6635 Specify whether to use an SSL connection when contacting the server. The
6636 following modes are supported:
6637
6638 =over 4
6639
6640 =item I<disable>
6641
6642 Do not use SSL at all.
6643
6644 =item I<allow>
6645
6646 First, try to connect without using SSL. If that fails, try using SSL.
6647
6648 =item I<prefer> (default)
6649
6650 First, try to connect using SSL. If that fails, try without using SSL.
6651
6652 =item I<require>
6653
6654 Use SSL only.
6655
6656 =back
6657
6658 =item B<Instance> I<name>
6659
6660 Specify the plugin instance name that should be used instead of the database
6661 name (which is the default, if this option has not been specified). This
6662 allows one to query multiple databases of the same name on the same host (e.g.
6663 when running multiple database server versions in parallel).
6664
6665 =item B<KRBSrvName> I<kerberos_service_name>
6666
6667 Specify the Kerberos service name to use when authenticating with Kerberos 5
6668 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6669 B<PostgreSQL Documentation> for details.
6670
6671 =item B<Service> I<service_name>
6672
6673 Specify the PostgreSQL service name to use for additional parameters. That
6674 service has to be defined in F<pg_service.conf> and holds additional
6675 connection parameters. See the section "The Connection Service File" in the
6676 B<PostgreSQL Documentation> for details.
6677
6678 =item B<Query> I<query>
6679
6680 Specifies a I<query> which should be executed in the context of the database
6681 connection. This may be any of the predefined or user-defined queries. If no
6682 such option is given, it defaults to "backends", "transactions", "queries",
6683 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6684 has been specified). Else, the specified queries are used only.
6685
6686 =item B<Writer> I<writer>
6687
6688 Assigns the specified I<writer> backend to the database connection. This
6689 causes all collected data to be send to the database using the settings
6690 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6691 below for details on how to selectively send data to certain plugins).
6692
6693 Each writer will register a flush callback which may be used when having long
6694 transactions enabled (see the B<CommitInterval> option above). When issuing
6695 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6696 transaction will be committed right away. Two different kinds of flush
6697 callbacks are available with the C<postgresql> plugin:
6698
6699 =over 4
6700
6701 =item B<postgresql>
6702
6703 Flush all writer backends.
6704
6705 =item B<postgresql->I<database>
6706
6707 Flush all writers of the specified I<database> only.
6708
6709 =back
6710
6711 =back
6712
6713 =head2 Plugin C<powerdns>
6714
6715 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6716 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6717 values, many of which are probably meaningless to most users, but may be useful
6718 for some. So you may chose which values to collect, but if you don't, some
6719 reasonable defaults will be collected.
6720
6721   <Plugin "powerdns">
6722     <Server "server_name">
6723       Collect "latency"
6724       Collect "udp-answers" "udp-queries"
6725       Socket "/var/run/pdns.controlsocket"
6726     </Server>
6727     <Recursor "recursor_name">
6728       Collect "questions"
6729       Collect "cache-hits" "cache-misses"
6730       Socket "/var/run/pdns_recursor.controlsocket"
6731     </Recursor>
6732     LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6733   </Plugin>
6734
6735 =over 4
6736
6737 =item B<Server> and B<Recursor> block
6738
6739 The B<Server> block defines one authoritative server to query, the B<Recursor>
6740 does the same for an recursing server. The possible options in both blocks are
6741 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6742 and is required.
6743
6744 =over 4
6745
6746 =item B<Collect> I<Field>
6747
6748 Using the B<Collect> statement you can select which values to collect. Here,
6749 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6750 C<dlg-only-drops>, C<answers10-100>.
6751
6752 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6753 When querying the server a C<SHOW *> command is issued in any case, because
6754 that's the only way of getting multiple values out of the server at once.
6755 collectd then picks out the values you have selected. When querying the
6756 recursor, a command is generated to query exactly these values. So if you
6757 specify invalid fields when querying the recursor, a syntax error may be
6758 returned by the daemon and collectd may not collect any values at all.
6759
6760 If no B<Collect> statement is given, the following B<Server> values will be
6761 collected:
6762
6763 =over 4
6764
6765 =item latency
6766
6767 =item packetcache-hit
6768
6769 =item packetcache-miss
6770
6771 =item packetcache-size
6772
6773 =item query-cache-hit
6774
6775 =item query-cache-miss
6776
6777 =item recursing-answers
6778
6779 =item recursing-questions
6780
6781 =item tcp-answers
6782
6783 =item tcp-queries
6784
6785 =item udp-answers
6786
6787 =item udp-queries
6788
6789 =back
6790
6791 The following B<Recursor> values will be collected by default:
6792
6793 =over 4
6794
6795 =item noerror-answers
6796
6797 =item nxdomain-answers
6798
6799 =item servfail-answers
6800
6801 =item sys-msec
6802
6803 =item user-msec
6804
6805 =item qa-latency
6806
6807 =item cache-entries
6808
6809 =item cache-hits
6810
6811 =item cache-misses
6812
6813 =item questions
6814
6815 =back
6816
6817 Please note that up to that point collectd doesn't know what values are
6818 available on the server and values that are added do not need a change of the
6819 mechanism so far. However, the values must be mapped to collectd's naming
6820 scheme, which is done using a lookup table that lists all known values. If
6821 values are added in the future and collectd does not know about them, you will
6822 get an error much like this:
6823
6824   powerdns plugin: submit: Not found in lookup table: foobar = 42
6825
6826 In this case please file a bug report with the collectd team.
6827
6828 =item B<Socket> I<Path>
6829
6830 Configures the path to the UNIX domain socket to be used when connecting to the
6831 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6832 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6833 will be used for the recursor.
6834
6835 =back
6836
6837 =item B<LocalSocket> I<Path>
6838
6839 Querying the recursor is done using UDP. When using UDP over UNIX domain
6840 sockets, the client socket needs a name in the file system, too. You can set
6841 this local name to I<Path> using the B<LocalSocket> option. The default is
6842 C<I<prefix>/var/run/collectd-powerdns>.
6843
6844 =back
6845
6846 =head2 Plugin C<processes>
6847
6848 Collects information about processes of local system.
6849
6850 By default, with no process matches configured, only general statistics is
6851 collected: the number of processes in each state and fork rate.
6852
6853 Process matches can be configured by B<Process> and B<ProcessMatch> options.
6854 These may also be a block in which further options may be specified.
6855
6856 The statistics collected for matched processes are:
6857  - size of the resident segment size (RSS)
6858  - user- and system-time used
6859  - number of processes
6860  - number of threads
6861  - number of open files (under Linux)
6862  - number of memory mapped files (under Linux)
6863  - io data (where available)
6864  - context switches (under Linux)
6865  - minor and major pagefaults
6866  - Delay Accounting information (Linux only, requires libmnl)
6867
6868 B<Synopsis:>
6869
6870  <Plugin processes>
6871    CollectFileDescriptor  true
6872    CollectContextSwitch   true
6873    CollectDelayAccounting false
6874    Process "name"
6875    ProcessMatch "name" "regex"
6876    <Process "collectd">
6877      CollectFileDescriptor  false
6878      CollectContextSwitch   false
6879      CollectDelayAccounting true
6880    </Process>
6881    <ProcessMatch "name" "regex">
6882      CollectFileDescriptor false
6883      CollectContextSwitch true
6884    </ProcessMatch>
6885  </Plugin>
6886
6887 =over 4
6888
6889 =item B<Process> I<Name>
6890
6891 Select more detailed statistics of processes matching this name.
6892
6893 Some platforms have a limit on the length of process names.
6894 I<Name> must stay below this limit.
6895
6896 =item B<ProcessMatch> I<name> I<regex>
6897
6898 Select more detailed statistics of processes matching the specified I<regex>
6899 (see L<regex(7)> for details). The statistics of all matching processes are
6900 summed up and dispatched to the daemon using the specified I<name> as an
6901 identifier. This allows one to "group" several processes together.
6902 I<name> must not contain slashes.
6903
6904 =item B<CollectContextSwitch> I<Boolean>
6905
6906 Collect the number of context switches for matched processes.
6907 Disabled by default.
6908
6909 =item B<CollectDelayAccounting> I<Boolean>
6910
6911 If enabled, collect Linux Delay Accounding information for matching processes.
6912 Delay Accounting provides the time processes wait for the CPU to become
6913 available, for I/O operations to finish, for pages to be swapped in and for
6914 freed pages to be reclaimed. The metrics are reported as "seconds per second"
6915 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
6916 Disabled by default.
6917
6918 This option is only available on Linux, requires the C<libmnl> library and
6919 requires the C<CAP_NET_ADMIN> capability at runtime.
6920
6921 =item B<CollectFileDescriptor> I<Boolean>
6922
6923 Collect number of file descriptors of matched processes.
6924 Disabled by default.
6925
6926 =item B<CollectMemoryMaps> I<Boolean>
6927
6928 Collect the number of memory mapped files of the process.
6929 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
6930 the Linux kernel.
6931
6932 =back
6933
6934 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
6935 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
6936 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
6937 reporting the corresponding processes only. Outside of B<Process> and
6938 B<ProcessMatch> blocks these options set the default value for subsequent
6939 matches.
6940
6941 =head2 Plugin C<protocols>
6942
6943 Collects a lot of information about various network protocols, such as I<IP>,
6944 I<TCP>, I<UDP>, etc.
6945
6946 Available configuration options:
6947
6948 =over 4
6949
6950 =item B<Value> I<Selector>
6951
6952 Selects whether or not to select a specific value. The string being matched is
6953 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6954 plugin instance and I<ValueName> will be used as type instance. An example of
6955 the string being used would be C<Tcp:RetransSegs>.
6956
6957 You can use regular expressions to match a large number of values with just one
6958 configuration option. To select all "extended" I<TCP> values, you could use the
6959 following statement:
6960
6961   Value "/^TcpExt:/"
6962
6963 Whether only matched values are selected or all matched values are ignored
6964 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6965 If no value is configured at all, all values will be selected.
6966
6967 See F</"IGNORELISTS"> for details.
6968
6969 =item B<IgnoreSelected> B<true>|B<false>
6970
6971 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6972 matching values will be ignored.
6973
6974 =back
6975
6976 =head2 Plugin C<python>
6977
6978 This plugin embeds a Python-interpreter into collectd and provides an interface
6979 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6980
6981 =head2 Plugin C<routeros>
6982
6983 The C<routeros> plugin connects to a device running I<RouterOS>, the
6984 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6985 I<librouteros> to connect and reads information about the interfaces and
6986 wireless connections of the device. The configuration supports querying
6987 multiple routers:
6988
6989   <Plugin "routeros">
6990     <Router>
6991       Host "router0.example.com"
6992       User "collectd"
6993       Password "secr3t"
6994       CollectInterface true
6995       CollectCPULoad true
6996       CollectMemory true
6997     </Router>
6998     <Router>
6999       Host "router1.example.com"
7000       User "collectd"
7001       Password "5ecret"
7002       CollectInterface true
7003       CollectRegistrationTable true
7004       CollectDF true
7005       CollectDisk true
7006     </Router>
7007   </Plugin>
7008
7009 As you can see above, the configuration of the I<routeros> plugin consists of
7010 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7011 options are understood:
7012
7013 =over 4
7014
7015 =item B<Host> I<Host>
7016
7017 Hostname or IP-address of the router to connect to.
7018
7019 =item B<Port> I<Port>
7020
7021 Port name or port number used when connecting. If left unspecified, the default
7022 will be chosen by I<librouteros>, currently "8728". This option expects a
7023 string argument, even when a numeric port number is given.
7024
7025 =item B<User> I<User>
7026
7027 Use the user name I<User> to authenticate. Defaults to "admin".
7028
7029 =item B<Password> I<Password>
7030
7031 Set the password used to authenticate.
7032
7033 =item B<CollectInterface> B<true>|B<false>
7034
7035 When set to B<true>, interface statistics will be collected for all interfaces
7036 present on the device. Defaults to B<false>.
7037
7038 =item B<CollectRegistrationTable> B<true>|B<false>
7039
7040 When set to B<true>, information about wireless LAN connections will be
7041 collected. Defaults to B<false>.
7042
7043 =item B<CollectCPULoad> B<true>|B<false>
7044
7045 When set to B<true>, information about the CPU usage will be collected. The
7046 number is a dimensionless value where zero indicates no CPU usage at all.
7047 Defaults to B<false>.
7048
7049 =item B<CollectMemory> B<true>|B<false>
7050
7051 When enabled, the amount of used and free memory will be collected. How used
7052 memory is calculated is unknown, for example whether or not caches are counted
7053 as used space.
7054 Defaults to B<false>.
7055
7056 =item B<CollectDF> B<true>|B<false>
7057
7058 When enabled, the amount of used and free disk space will be collected.
7059 Defaults to B<false>.
7060
7061 =item B<CollectDisk> B<true>|B<false>
7062
7063 When enabled, the number of sectors written and bad blocks will be collected.
7064 Defaults to B<false>.
7065
7066 =back
7067
7068 =head2 Plugin C<redis>
7069
7070 The I<Redis plugin> connects to one or more Redis servers and gathers
7071 information about each server's state. For each server there is a I<Node> block
7072 which configures the connection parameters for this node.
7073
7074   <Plugin redis>
7075     <Node "example">
7076         Host "localhost"
7077         Port "6379"
7078         Timeout 2000
7079         <Query "LLEN myqueue">
7080           Type "queue_length"
7081           Instance "myqueue"
7082         <Query>
7083     </Node>
7084   </Plugin>
7085
7086 The information shown in the synopsis above is the I<default configuration>
7087 which is used by the plugin if no configuration is present.
7088
7089 =over 4
7090
7091 =item B<Node> I<Nodename>
7092
7093 The B<Node> block identifies a new Redis node, that is a new Redis instance
7094 running in an specified host and port. The name for node is a canonical
7095 identifier which is used as I<plugin instance>. It is limited to
7096 64E<nbsp>characters in length.
7097
7098 =item B<Host> I<Hostname>
7099
7100 The B<Host> option is the hostname or IP-address where the Redis instance is
7101 running on.
7102
7103 =item B<Port> I<Port>
7104
7105 The B<Port> option is the TCP port on which the Redis instance accepts
7106 connections. Either a service name of a port number may be given. Please note
7107 that numerical port numbers must be given as a string, too.
7108
7109 =item B<Password> I<Password>
7110
7111 Use I<Password> to authenticate when connecting to I<Redis>.
7112
7113 =item B<Timeout> I<Milliseconds>
7114
7115 The B<Timeout> option set the socket timeout for node response. Since the Redis
7116 read function is blocking, you should keep this value as low as possible. Keep
7117 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
7118 than B<Interval> defined globally.
7119
7120 =item B<Query> I<Querystring>
7121
7122 The B<Query> block identifies a query to execute against the redis server.
7123 There may be an arbitrary number of queries to execute.
7124
7125 =item B<Type> I<Collectd type>
7126
7127 Within a query definition, a valid collectd type to use as when submitting
7128 the result of the query. When not supplied, will default to B<gauge>.
7129
7130 =item B<Instance> I<Type instance>
7131
7132 Within a query definition, an optional type instance to use when submitting
7133 the result of the query. When not supplied will default to the escaped
7134 command, up to 64 chars.
7135
7136 =back
7137
7138 =head2 Plugin C<rrdcached>
7139
7140 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7141 to store values to RRD files in an efficient manner. The combination of the
7142 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7143 way the C<rrdtool> plugin works (see below). The added abstraction layer
7144 provides a number of benefits, though: Because the cache is not within
7145 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7146 restarted. This results in much shorter (if any) gaps in graphs, especially
7147 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7148 daemon so that it can flush values to disk automatically when needed. This
7149 allows one to integrate automated flushing of values into graphing solutions
7150 much more easily.
7151
7152 There are disadvantages, though: The daemon may reside on a different host, so
7153 it may not be possible for C<collectd> to create the appropriate RRD files
7154 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7155 different base directory, so relative paths may do weird stuff if you're not
7156 careful.
7157
7158 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7159 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7160 setting should be set to an absolute path, so that a changed base directory
7161 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7162
7163 =over 4
7164
7165 =item B<DaemonAddress> I<Address>
7166
7167 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7168 library. See L<rrdcached(1)> for details. Example:
7169
7170   <Plugin "rrdcached">
7171     DaemonAddress "unix:/var/run/rrdcached.sock"
7172   </Plugin>
7173
7174 =item B<DataDir> I<Directory>
7175
7176 Set the base directory in which the RRD files reside. If this is a relative
7177 path, it is relative to the working base directory of the C<rrdcached> daemon!
7178 Use of an absolute path is recommended.
7179
7180 =item B<CreateFiles> B<true>|B<false>
7181
7182 Enables or disables the creation of RRD files. If the daemon is not running
7183 locally, or B<DataDir> is set to a relative path, this will not work as
7184 expected. Default is B<true>.
7185
7186 =item B<CreateFilesAsync> B<false>|B<true>
7187
7188 When enabled, new RRD files are enabled asynchronously, using a separate thread
7189 that runs in the background. This prevents writes to block, which is a problem
7190 especially when many hundreds of files need to be created at once. However,
7191 since the purpose of creating the files asynchronously is I<not> to block until
7192 the file is available, values before the file is available will be discarded.
7193 When disabled (the default) files are created synchronously, blocking for a
7194 short while, while the file is being written.
7195
7196 =item B<StepSize> I<Seconds>
7197
7198 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7199 this setting is unset and the stepsize is set to the interval in which the data
7200 is collected. Do not use this option unless you absolutely have to for some
7201 reason. Setting this option may cause problems with the C<snmp plugin>, the
7202 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7203
7204 =item B<HeartBeat> I<Seconds>
7205
7206 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7207 in which case the heartbeat is set to twice the B<StepSize> which should equal
7208 the interval in which data is collected. Do not set this option unless you have
7209 a very good reason to do so.
7210
7211 =item B<RRARows> I<NumRows>
7212
7213 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7214 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7215 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7216 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7217 week, one month, and one year.
7218
7219 So for each timespan, it calculates how many PDPs need to be consolidated into
7220 one CDP by calculating:
7221   number of PDPs = timespan / (stepsize * rrarows)
7222
7223 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7224 default is 1200.
7225
7226 =item B<RRATimespan> I<Seconds>
7227
7228 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7229 more then one RRA. If this option is never used, the built-in default of (3600,
7230 86400, 604800, 2678400, 31622400) is used.
7231
7232 For more information on how RRA-sizes are calculated see B<RRARows> above.
7233
7234 =item B<XFF> I<Factor>
7235
7236 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7237 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7238 one (exclusive).
7239
7240 =item B<CollectStatistics> B<false>|B<true>
7241
7242 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7243 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7244
7245 Statistics are read via I<rrdcached>s socket using the STATS command.
7246 See L<rrdcached(1)> for details.
7247
7248 =back
7249
7250 =head2 Plugin C<rrdtool>
7251
7252 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7253 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7254 using these settings. If you don't want to dive into the depths of RRDtool, you
7255 can safely ignore these settings.
7256
7257 =over 4
7258
7259 =item B<DataDir> I<Directory>
7260
7261 Set the directory to store RRD files under. By default RRD files are generated
7262 beneath the daemon's working directory, i.e. the B<BaseDir>.
7263
7264 =item B<CreateFilesAsync> B<false>|B<true>
7265
7266 When enabled, new RRD files are enabled asynchronously, using a separate thread
7267 that runs in the background. This prevents writes to block, which is a problem
7268 especially when many hundreds of files need to be created at once. However,
7269 since the purpose of creating the files asynchronously is I<not> to block until
7270 the file is available, values before the file is available will be discarded.
7271 When disabled (the default) files are created synchronously, blocking for a
7272 short while, while the file is being written.
7273
7274 =item B<StepSize> I<Seconds>
7275
7276 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7277 this setting is unset and the stepsize is set to the interval in which the data
7278 is collected. Do not use this option unless you absolutely have to for some
7279 reason. Setting this option may cause problems with the C<snmp plugin>, the
7280 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7281
7282 =item B<HeartBeat> I<Seconds>
7283
7284 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7285 in which case the heartbeat is set to twice the B<StepSize> which should equal
7286 the interval in which data is collected. Do not set this option unless you have
7287 a very good reason to do so.
7288
7289 =item B<RRARows> I<NumRows>
7290
7291 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7292 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7293 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7294 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7295 week, one month, and one year.
7296
7297 So for each timespan, it calculates how many PDPs need to be consolidated into
7298 one CDP by calculating:
7299   number of PDPs = timespan / (stepsize * rrarows)
7300
7301 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7302 default is 1200.
7303
7304 =item B<RRATimespan> I<Seconds>
7305
7306 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7307 more then one RRA. If this option is never used, the built-in default of (3600,
7308 86400, 604800, 2678400, 31622400) is used.
7309
7310 For more information on how RRA-sizes are calculated see B<RRARows> above.
7311
7312 =item B<XFF> I<Factor>
7313
7314 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7315 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7316 one (exclusive).
7317
7318 =item B<CacheFlush> I<Seconds>
7319
7320 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7321 it writes all values for a certain RRD-file if the oldest value is older than
7322 (or equal to) the number of seconds specified by B<CacheTimeout>.
7323 That check happens on new values arriwal. If some RRD-file is not updated
7324 anymore for some reason (the computer was shut down, the network is broken,
7325 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7326 every I<Seconds> seconds the entire cache is searched for entries older than
7327 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7328 disk. Since scanning the entire cache is kind of expensive and does nothing
7329 under normal circumstances, this value should not be too small. 900 seconds
7330 might be a good value, though setting this to 7200 seconds doesn't normally
7331 do much harm either.
7332
7333 Defaults to 10x B<CacheTimeout>.
7334 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7335 above default is used.
7336
7337 =item B<CacheTimeout> I<Seconds>
7338
7339 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7340 save values in a cache, as described above. Writing multiple values at once
7341 reduces IO-operations and thus lessens the load produced by updating the files.
7342 The trade off is that the graphs kind of "drag behind" and that more memory is
7343 used.
7344
7345 =item B<WritesPerSecond> I<Updates>
7346
7347 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7348 will run serious performance problems. The B<CacheFlush> setting and the
7349 internal update queue assert that collectd continues to work just fine even
7350 under heavy load, but the system may become very unresponsive and slow. This is
7351 a problem especially if you create graphs from the RRD files on the same
7352 machine, for example using the C<graph.cgi> script included in the
7353 C<contrib/collection3/> directory.
7354
7355 This setting is designed for very large setups. Setting this option to a value
7356 between 25 and 80 updates per second, depending on your hardware, will leave
7357 the server responsive enough to draw graphs even while all the cached values
7358 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7359 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7360 written as fast as possible, so that web frontends have up to date data when
7361 generating graphs.
7362
7363 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7364 updates per second, writing all values to disk will take approximately
7365 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7366 "collection3" you'll end up with a responsive and fast system, up to date
7367 graphs and basically a "backup" of your values every hour.
7368
7369 =item B<RandomTimeout> I<Seconds>
7370
7371 When set, the actual timeout for each value is chosen randomly between
7372 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7373 intention is to avoid high load situations that appear when many values timeout
7374 at the same time. This is especially a problem shortly after the daemon starts,
7375 because all values were added to the internal cache at roughly the same time.
7376
7377 =back
7378
7379 =head2 Plugin C<sensors>
7380
7381 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7382 that all the needed modules have to be loaded and lm_sensors has to be
7383 configured (most likely by editing F</etc/sensors.conf>. Read
7384 L<sensors.conf(5)> for details.
7385
7386 The B<lm_sensors> homepage can be found at
7387 L<http://secure.netroedge.com/~lm78/>.
7388
7389 =over 4
7390
7391 =item B<SensorConfigFile> I<File>
7392
7393 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7394 the library's default will be used.
7395
7396 =item B<Sensor> I<chip-bus-address/type-feature>
7397
7398 Selects the name of the sensor which you want to collect or ignore, depending
7399 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7400 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7401 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7402
7403 See F</"IGNORELISTS"> for details.
7404
7405 =item B<IgnoreSelected> I<true>|I<false>
7406
7407 If no configuration if given, the B<sensors>-plugin will collect data from all
7408 sensors. This may not be practical, especially for uninteresting sensors.
7409 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7410 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7411 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7412 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7413 and all other sensors are collected.
7414
7415 =item B<UseLabels> I<true>|I<false>
7416
7417 Configures how sensor readings are reported. When set to I<true>, sensor
7418 readings are reported using their descriptive label (e.g. "VCore"). When set to
7419 I<false> (the default) the sensor name is used ("in0").
7420
7421 =back
7422
7423 =head2 Plugin C<sigrok>
7424
7425 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7426 supported by the L<sigrok|http://sigrok.org/> project.
7427
7428 B<Synopsis>
7429
7430  <Plugin sigrok>
7431    LogLevel 3
7432    <Device "AC Voltage">
7433       Driver "fluke-dmm"
7434       MinimumInterval 10
7435       Conn "/dev/ttyUSB2"
7436    </Device>
7437    <Device "Sound Level">
7438       Driver "cem-dt-885x"
7439       Conn "/dev/ttyUSB1"
7440    </Device>
7441  </Plugin>
7442
7443 =over 4
7444
7445 =item B<LogLevel> B<0-5>
7446
7447 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7448 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7449 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7450 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7451 their level, are always submitted to I<collectd> at its INFO log level.
7452
7453 =item E<lt>B<Device> I<Name>E<gt>
7454
7455 A sigrok-supported device, uniquely identified by this section's options. The
7456 I<Name> is passed to I<collectd> as the I<plugin instance>.
7457
7458 =item B<Driver> I<DriverName>
7459
7460 The sigrok driver to use for this device.
7461
7462 =item B<Conn> I<ConnectionSpec>
7463
7464 If the device cannot be auto-discovered, or more than one might be discovered
7465 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7466 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7467 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7468 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7469 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7470
7471 =item B<SerialComm> I<SerialSpec>
7472
7473 For serial devices with non-standard port settings, this option can be used
7474 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7475 This should not be necessary; drivers know how to communicate with devices they
7476 support.
7477
7478 =item B<MinimumInterval> I<Seconds>
7479
7480 Specifies the minimum time between measurement dispatches to I<collectd>, in
7481 seconds. Since some I<sigrok> supported devices can acquire measurements many
7482 times per second, it may be necessary to throttle these. For example, the
7483 I<RRD plugin> cannot process writes more than once per second.
7484
7485 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7486 device are always dispatched to I<collectd>. When throttled, unused
7487 measurements are discarded.
7488
7489 =back
7490
7491 =head2 Plugin C<smart>
7492
7493 The C<smart> plugin collects SMART information from physical
7494 disks. Values collectd include temperature, power cycle count, poweron
7495 time and bad sectors. Also, all SMART attributes are collected along
7496 with the normalized current value, the worst value, the threshold and
7497 a human readable value.
7498
7499 Using the following two options you can ignore some disks or configure the
7500 collection only of specific disks.
7501
7502 =over 4
7503
7504 =item B<Disk> I<Name>
7505
7506 Select the disk I<Name>. Whether it is collected or ignored depends on the
7507 B<IgnoreSelected> setting, see below. As with other plugins that use the
7508 daemon's ignorelist functionality, a string that starts and ends with a slash
7509 is interpreted as a regular expression. Examples:
7510
7511   Disk "sdd"
7512   Disk "/hda[34]/"
7513
7514 See F</"IGNORELISTS"> for details.
7515
7516 =item B<IgnoreSelected> B<true>|B<false>
7517
7518 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7519 statements, are ignored or if all other disks are ignored. The behavior
7520 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7521 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7522 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7523 is set to B<true>, all disks are collected B<except> the ones matched.
7524
7525 =item B<IgnoreSleepMode> B<true>|B<false>
7526
7527 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7528 This option disables the sleep mode check and allows the plugin to collect data
7529 from these disks anyway. This is useful in cases where libatasmart mistakenly
7530 reports disks as asleep because it has not been updated to incorporate support
7531 for newer idle states in the ATA spec.
7532
7533 =item B<UseSerial> B<true>|B<false>
7534
7535 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7536 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7537 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7538 storing data. This ensures that the data for a given disk will be kept together
7539 even if the kernel name changes.
7540
7541 =back
7542
7543 =head2 Plugin C<snmp>
7544
7545 Since the configuration of the C<snmp plugin> is a little more complicated than
7546 other plugins, its documentation has been moved to an own manpage,
7547 L<collectd-snmp(5)>. Please see there for details.
7548
7549 =head2 Plugin C<snmp_agent>
7550
7551 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7552 from SNMP master agent and returns the data collected by read plugins.
7553 The I<snmp_agent> plugin handles requests only for OIDs specified in
7554 configuration file. To handle SNMP queries the plugin gets data from collectd
7555 and translates requested values from collectd's internal format to SNMP format.
7556 This plugin is a generic plugin and cannot work without configuration.
7557 For more details on AgentX subagent see
7558 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7559
7560 B<Synopsis:>
7561
7562   <Plugin snmp_agent>
7563     <Data "memAvailReal">
7564       Plugin "memory"
7565       #PluginInstance "some"
7566       Type "memory"
7567       TypeInstance "free"
7568       OIDs "1.3.6.1.4.1.2021.4.6.0"
7569     </Data>
7570     <Table "ifTable">
7571       IndexOID "IF-MIB::ifIndex"
7572       SizeOID "IF-MIB::ifNumber"
7573       <Data "ifDescr">
7574         Instance true
7575         Plugin "interface"
7576         OIDs "IF-MIB::ifDescr"
7577       </Data>
7578       <Data "ifOctets">
7579         Plugin "interface"
7580         Type "if_octets"
7581         TypeInstance ""
7582         OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7583       </Data>
7584     </Table>
7585   </Plugin>
7586
7587 There are two types of blocks that can be contained in the
7588 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7589
7590 =head3 The B<Data> block
7591
7592 The B<Data> block defines a list OIDs that are to be handled. This block can
7593 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7594 block it reperesents table OIDs.
7595 The following options can be set:
7596
7597 =over 4
7598
7599 =item B<Instance> I<true|false>
7600
7601 When B<Instance> is set to B<true>, the value for requested OID is copied from
7602 plugin instance field of corresponding collectd value. If B<Data> block defines
7603 scalar data type B<Instance> has no effect and can be omitted.
7604
7605 =item B<Plugin> I<String>
7606
7607 Read plugin name whose collected data will be mapped to specified OIDs.
7608
7609 =item B<PluginInstance> I<String>
7610
7611 Read plugin instance whose collected data will be mapped to specified OIDs.
7612 The field is optional and by default there is no plugin instance check.
7613 Allowed only if B<Data> block defines scalar data type.
7614
7615 =item B<Type> I<String>
7616
7617 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7618 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7619
7620 =item B<TypeInstance> I<String>
7621
7622 Collectd's type-instance that is to be used for specified OID.
7623
7624 =item B<OIDs> I<OID> [I<OID> ...]
7625
7626 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7627 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7628 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7629 configured should correspond to number of values in specified B<Type>.
7630 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7631 "rx" and "tx" values of "if_octets" type.
7632
7633 =item B<Scale> I<Value>
7634
7635 The values taken from collectd are multiplied by I<Value>. The field is optional
7636 and the default is B<1.0>.
7637
7638 =item B<Shift> I<Value>
7639
7640 I<Value> is added to values from collectd after they have been multiplied by
7641 B<Scale> value. The field is optional and the default value is B<0.0>.
7642
7643 =back
7644
7645 =head3 The B<Table> block
7646
7647 The B<Table> block defines a collection of B<Data> blocks that belong to one
7648 snmp table. In addition to multiple B<Data> blocks the following options can be
7649 set:
7650
7651 =over 4
7652
7653 =item B<IndexOID> I<OID>
7654
7655 OID that is handled by the plugin and is mapped to numerical index value that is
7656 generated by the plugin for each table record.
7657
7658 =item B<SizeOID> I<OID>
7659
7660 OID that is handled by the plugin. Returned value is the number of records in
7661 the table. The field is optional.
7662
7663 =back
7664
7665 =head2 Plugin C<statsd>
7666
7667 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7668 protocol and dispatches rates or other aggregates of these numbers
7669 periodically.
7670
7671 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7672 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7673 C<objects> respectively.
7674
7675 The following configuration options are valid:
7676
7677 =over 4
7678
7679 =item B<Host> I<Host>
7680
7681 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7682 "any" address, i.e. accept packets sent to any of the hosts addresses.
7683
7684 =item B<Port> I<Port>
7685
7686 UDP port to listen to. This can be either a service name or a port number.
7687 Defaults to C<8125>.
7688
7689 =item B<DeleteCounters> B<false>|B<true>
7690
7691 =item B<DeleteTimers> B<false>|B<true>
7692
7693 =item B<DeleteGauges> B<false>|B<true>
7694
7695 =item B<DeleteSets> B<false>|B<true>
7696
7697 These options control what happens if metrics are not updated in an interval.
7698 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7699 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7700 are unchanged. If set to B<True>, the such metrics are not dispatched and
7701 removed from the internal cache.
7702
7703 =item B<CounterSum> B<false>|B<true>
7704
7705 When enabled, creates a C<count> metric which reports the change since the last
7706 read. This option primarily exists for compatibility with the I<statsd>
7707 implementation by Etsy.
7708
7709 =item B<TimerPercentile> I<Percent>
7710
7711 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7712 that I<Percent> of all reported timers are smaller than or equal to the
7713 computed latency. This is useful for cutting off the long tail latency, as it's
7714 often done in I<Service Level Agreements> (SLAs).
7715
7716 Different percentiles can be calculated by setting this option several times.
7717 If none are specified, no percentiles are calculated / dispatched.
7718
7719 =item B<TimerLower> B<false>|B<true>
7720
7721 =item B<TimerUpper> B<false>|B<true>
7722
7723 =item B<TimerSum> B<false>|B<true>
7724
7725 =item B<TimerCount> B<false>|B<true>
7726
7727 Calculate and dispatch various values out of I<Timer> metrics received during
7728 an interval. If set to B<False>, the default, these values aren't calculated /
7729 dispatched.
7730
7731 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
7732
7733 =back
7734
7735 =head2 Plugin C<swap>
7736
7737 The I<Swap plugin> collects information about used and available swap space. On
7738 I<Linux> and I<Solaris>, the following options are available:
7739
7740 =over 4
7741
7742 =item B<ReportByDevice> B<false>|B<true>
7743
7744 Configures how to report physical swap devices. If set to B<false> (the
7745 default), the summary over all swap devices is reported only, i.e. the globally
7746 used and available space over all devices. If B<true> is configured, the used
7747 and available space of each device will be reported separately.
7748
7749 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7750 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7751
7752 =item B<ReportBytes> B<false>|B<true>
7753
7754 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7755 I<swap I/O> is reported in pages. This option is available under Linux only.
7756
7757 =item B<ValuesAbsolute> B<true>|B<false>
7758
7759 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7760 available and used. Defaults to B<true>.
7761
7762 =item B<ValuesPercentage> B<false>|B<true>
7763
7764 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7765 available and free. Defaults to B<false>.
7766
7767 This is useful for deploying I<collectd> in a heterogeneous environment, where
7768 swap sizes differ and you want to specify generic thresholds or similar.
7769
7770 =item B<ReportIO> B<true>|B<false>
7771
7772 Enables or disables reporting swap IO. Defaults to B<true>.
7773
7774 This is useful for the cases when swap IO is not neccessary, is not available,
7775 or is not reliable.
7776
7777 =back
7778
7779 =head2 Plugin C<syslog>
7780
7781 =over 4
7782
7783 =item B<LogLevel> B<debug|info|notice|warning|err>
7784
7785 Sets the log-level. If, for example, set to B<notice>, then all events with
7786 severity B<notice>, B<warning>, or B<err> will be submitted to the
7787 syslog-daemon.
7788
7789 Please note that B<debug> is only available if collectd has been compiled with
7790 debugging support.
7791
7792 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7793
7794 Controls which notifications should be sent to syslog. The default behaviour is
7795 not to send any. Less severe notifications always imply logging more severe
7796 notifications: Setting this to B<OKAY> means all notifications will be sent to
7797 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7798 notifications but will dismiss B<OKAY> notifications. Setting this option to
7799 B<FAILURE> will only send failures to syslog.
7800
7801 =back
7802
7803 =head2 Plugin C<table>
7804
7805 The C<table plugin> provides generic means to parse tabular data and dispatch
7806 user specified values. Values are selected based on column numbers. For
7807 example, this plugin may be used to get values from the Linux L<proc(5)>
7808 filesystem or CSV (comma separated values) files.
7809
7810   <Plugin table>
7811     <Table "/proc/slabinfo">
7812       #Plugin "slab"
7813       Instance "slabinfo"
7814       Separator " "
7815       <Result>
7816         Type gauge
7817         InstancePrefix "active_objs"
7818         InstancesFrom 0
7819         ValuesFrom 1
7820       </Result>
7821       <Result>
7822         Type gauge
7823         InstancePrefix "objperslab"
7824         InstancesFrom 0
7825         ValuesFrom 4
7826       </Result>
7827     </Table>
7828   </Plugin>
7829
7830 The configuration consists of one or more B<Table> blocks, each of which
7831 configures one file to parse. Within each B<Table> block, there are one or
7832 more B<Result> blocks, which configure which data to select and how to
7833 interpret it.
7834
7835 The following options are available inside a B<Table> block:
7836
7837 =over 4
7838
7839 =item B<Plugin> I<Plugin>
7840
7841 If specified, I<Plugin> is used as the plugin name when submitting values.
7842 Defaults to B<table>.
7843
7844 =item B<Instance> I<instance>
7845
7846 If specified, I<instance> is used as the plugin instance. If omitted, the
7847 filename of the table is used instead, with all special characters replaced
7848 with an underscore (C<_>).
7849
7850 =item B<Separator> I<string>
7851
7852 Any character of I<string> is interpreted as a delimiter between the different
7853 columns of the table. A sequence of two or more contiguous delimiters in the
7854 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7855 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7856 of a table - see its documentation for more details. This option is mandatory.
7857
7858 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7859 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7860 required because of collectd's config parsing.
7861
7862 =back
7863
7864 The following options are available inside a B<Result> block:
7865
7866 =over 4
7867
7868 =item B<Type> I<type>
7869
7870 Sets the type used to dispatch the values to the daemon. Detailed information
7871 about types and their configuration can be found in L<types.db(5)>. This
7872 option is mandatory.
7873
7874 =item B<InstancePrefix> I<prefix>
7875
7876 If specified, prepend I<prefix> to the type instance. If omitted, only the
7877 B<InstancesFrom> option is considered for the type instance.
7878
7879 =item B<InstancesFrom> I<column0> [I<column1> ...]
7880
7881 If specified, the content of the given columns (identified by the column
7882 number starting at zero) will be used to create the type instance for each
7883 row. Multiple values (and the instance prefix) will be joined together with
7884 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7885 option is considered for the type instance.
7886
7887 The plugin itself does not check whether or not all built instances are
7888 different. It’s your responsibility to assure that each is unique. This is
7889 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7890 sure that the table only contains one row.
7891
7892 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7893 will be empty.
7894
7895 =item B<ValuesFrom> I<column0> [I<column1> ...]
7896
7897 Specifies the columns (identified by the column numbers starting at zero)
7898 whose content is used as the actual data for the data sets that are dispatched
7899 to the daemon. How many such columns you need is determined by the B<Type>
7900 setting above. If you specify too many or not enough columns, the plugin will
7901 complain about that and no data will be submitted to the daemon. The plugin
7902 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7903 respectively, so anything supported by those functions is supported by the
7904 plugin as well. This option is mandatory.
7905
7906 =back
7907
7908 =head2 Plugin C<tail>
7909
7910 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7911 each line and dispatches found values. What is matched can be configured by the
7912 user using (extended) regular expressions, as described in L<regex(7)>.
7913
7914   <Plugin "tail">
7915     <File "/var/log/exim4/mainlog">
7916       Plugin "mail"
7917       Instance "exim"
7918       Interval 60
7919       <Match>
7920         Regex "S=([1-9][0-9]*)"
7921         DSType "CounterAdd"
7922         Type "ipt_bytes"
7923         Instance "total"
7924       </Match>
7925       <Match>
7926         Regex "\\<R=local_user\\>"
7927         ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7928         DSType "CounterInc"
7929         Type "counter"
7930         Instance "local_user"
7931       </Match>
7932       <Match>
7933         Regex "l=([0-9]*\\.[0-9]*)"
7934         <DSType "Distribution">
7935           Percentile 99
7936           Bucket 0 100
7937           #BucketType "bucket"
7938         </DSType>
7939         Type "latency"
7940         Instance "foo"
7941       </Match>
7942     </File>
7943   </Plugin>
7944
7945 The config consists of one or more B<File> blocks, each of which configures one
7946 logfile to parse. Within each B<File> block, there are one or more B<Match>
7947 blocks, which configure a regular expression to search for.
7948
7949 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
7950 the plugin name and instance respectively. So in the above example the plugin name
7951 C<mail-exim> would be used.
7952
7953 These options are applied for all B<Match> blocks that B<follow> it, until the
7954 next B<Plugin> or B<Instance> option. This way you can extract several plugin
7955 instances from one logfile, handy when parsing syslog and the like.
7956
7957 The B<Interval> option allows you to define the length of time between reads. If
7958 this is not set, the default Interval will be used.
7959
7960 Each B<Match> block has the following options to describe how the match should
7961 be performed:
7962
7963 =over 4
7964
7965 =item B<Regex> I<regex>
7966
7967 Sets the regular expression to use for matching against a line. The first
7968 subexpression has to match something that can be turned into a number by
7969 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7970 below. Because B<extended> regular expressions are used, you do not need to use
7971 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7972 collectd's config parsing you need to escape backslashes, though. So if you
7973 want to match literal parentheses you need to do the following:
7974
7975   Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7976
7977 =item B<ExcludeRegex> I<regex>
7978
7979 Sets an optional regular expression to use for excluding lines from the match.
7980 An example which excludes all connections from localhost from the match:
7981
7982   ExcludeRegex "127\\.0\\.0\\.1"
7983
7984 =item B<DSType> I<Type>
7985
7986 Sets how the values are cumulated. I<Type> is one of:
7987
7988 =over 4
7989
7990 =item B<GaugeAverage>
7991
7992 Calculate the average.
7993
7994 =item B<GaugeMin>
7995
7996 Use the smallest number only.
7997
7998 =item B<GaugeMax>
7999
8000 Use the greatest number only.
8001
8002 =item B<GaugeLast>
8003
8004 Use the last number found.
8005
8006 =item B<GaugePersist>
8007
8008 Use the last number found. The number is not reset at the end of an interval.
8009 It is continously reported until another number is matched. This is intended
8010 for cases in which only state changes are reported, for example a thermometer
8011 that only reports the temperature when it changes.
8012
8013 =item B<CounterSet>
8014
8015 =item B<DeriveSet>
8016
8017 =item B<AbsoluteSet>
8018
8019 The matched number is a counter. Simply I<sets> the internal counter to this
8020 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8021
8022 =item B<GaugeAdd>
8023
8024 =item B<CounterAdd>
8025
8026 =item B<DeriveAdd>
8027
8028 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8029 matched number may be negative, which will effectively subtract from the
8030 internal counter.
8031
8032 =item B<GaugeInc>
8033
8034 =item B<CounterInc>
8035
8036 =item B<DeriveInc>
8037
8038 Increase the internal counter by one. These B<DSType> are the only ones that do
8039 not use the matched subexpression, but simply count the number of matched
8040 lines. Thus, you may use a regular expression without submatch in this case.
8041
8042 =item B<Distribution>
8043
8044 Type to do calculations based on the distribution of values, primarily
8045 calculating percentiles. This is primarily geared towards latency, but can be
8046 used for other metrics as well. The range of values tracked with this setting
8047 must be in the range (0–2^34) and can be fractional. Please note that neither
8048 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8049 distribution.
8050
8051 This option must be used together with the B<Percentile> and/or B<Bucket>
8052 options.
8053
8054 B<Synopsis:>
8055
8056   <DSType "Distribution">
8057     Percentile 99
8058     Bucket 0 100
8059     BucketType "bucket"
8060   </DSType>
8061
8062 =over 4
8063
8064 =item B<Percentile> I<Percent>
8065
8066 Calculate and dispatch the configured percentile, i.e. compute the value, so
8067 that I<Percent> of all matched values are smaller than or equal to the computed
8068 latency.
8069
8070 Metrics are reported with the I<type> B<Type> (the value of the above option)
8071 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8072
8073 This option may be repeated to calculate more than one percentile.
8074
8075 =item B<Bucket> I<lower_bound> I<upper_bound>
8076
8077 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8078 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8079 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8080 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8081 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8082 lower/upper bound.
8083
8084 To export the entire (0–inf) range without overlap, use the upper bound of the
8085 previous range as the lower bound of the following range. In other words, use
8086 the following schema:
8087
8088   Bucket   0   1
8089   Bucket   1   2
8090   Bucket   2   5
8091   Bucket   5  10
8092   Bucket  10  20
8093   Bucket  20  50
8094   Bucket  50   0
8095
8096 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket> 
8097 by default) and the I<type instance>
8098 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8099
8100 This option may be repeated to calculate more than one rate.
8101
8102 =item B<BucketType> I<Type>
8103
8104 Sets the type used to dispatch B<Bucket> metrics.
8105 Optional, by default C<bucket> will be used.
8106
8107 =back
8108
8109 =back
8110
8111 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8112 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8113 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8114 B<Derive*> types interpret the submatch as a signed integer using
8115 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8116 and it may be omitted in this case.
8117
8118 =item B<Type> I<Type>
8119
8120 Sets the type used to dispatch this value. Detailed information about types and
8121 their configuration can be found in L<types.db(5)>.
8122
8123 =item B<Instance> I<TypeInstance>
8124
8125 This optional setting sets the type instance to use.
8126
8127 =back
8128
8129 =head2 Plugin C<tail_csv>
8130
8131 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8132 written by I<Snort>.
8133
8134 B<Synopsis:>
8135
8136  <Plugin "tail_csv">
8137    <Metric "snort-dropped">
8138        Type "percent"
8139        Instance "dropped"
8140        Index 1
8141    </Metric>
8142    <File "/var/log/snort/snort.stats">
8143        Plugin "snortstats"
8144        Instance "eth0"
8145        Interval 600
8146        Collect "snort-dropped"
8147    </File>
8148  </Plugin>
8149
8150 The configuration consists of one or more B<Metric> blocks that define an index
8151 into the line of the CSV file and how this value is mapped to I<collectd's>
8152 internal representation. These are followed by one or more B<Instance> blocks
8153 which configure which file to read, in which interval and which metrics to
8154 extract.
8155
8156 =over 4
8157
8158 =item E<lt>B<Metric> I<Name>E<gt>
8159
8160 The B<Metric> block configures a new metric to be extracted from the statistics
8161 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8162 only used inside the B<Instance> blocks to refer to this block, so you can use
8163 one B<Metric> block for multiple CSV files.
8164
8165 =over 4
8166
8167 =item B<Type> I<Type>
8168
8169 Configures which I<Type> to use when dispatching this metric. Types are defined
8170 in the L<types.db(5)> file, see the appropriate manual page for more
8171 information on specifying types. Only types with a single I<data source> are
8172 supported by the I<tail_csv plugin>. The information whether the value is an
8173 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8174 I<Type's> definition.
8175
8176 =item B<Instance> I<TypeInstance>
8177
8178 If set, I<TypeInstance> is used to populate the type instance field of the
8179 created value lists. Otherwise, no type instance is used.
8180
8181 =item B<ValueFrom> I<Index>
8182
8183 Configure to read the value from the field with the zero-based index I<Index>.
8184 If the value is parsed as signed integer, unsigned integer or double depends on
8185 the B<Type> setting, see above.
8186
8187 =back
8188
8189 =item E<lt>B<File> I<Path>E<gt>
8190
8191 Each B<File> block represents one CSV file to read. There must be at least one
8192 I<File> block but there can be multiple if you have multiple CSV files.
8193
8194 =over 4
8195
8196 =item B<Plugin> I<Plugin>
8197
8198 Use I<Plugin> as the plugin name when submitting values.
8199 Defaults to C<tail_csv>.
8200
8201 =item B<Instance> I<PluginInstance>
8202
8203 Sets the I<plugin instance> used when dispatching the values.
8204
8205 =item B<Collect> I<Metric>
8206
8207 Specifies which I<Metric> to collect. This option must be specified at least
8208 once, and you can use this option multiple times to specify more than one
8209 metric to be extracted from this statistic file.
8210
8211 =item B<Interval> I<Seconds>
8212
8213 Configures the interval in which to read values from this instance / file.
8214 Defaults to the plugin's default interval.
8215
8216 =item B<TimeFrom> I<Index>
8217
8218 Rather than using the local time when dispatching a value, read the timestamp
8219 from the field with the zero-based index I<Index>. The value is interpreted as
8220 seconds since epoch. The value is parsed as a double and may be factional.
8221
8222 =back
8223
8224 =back
8225
8226 =head2 Plugin C<teamspeak2>
8227
8228 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8229 polls interesting global and virtual server data. The plugin can query only one
8230 physical server but unlimited virtual servers. You can use the following
8231 options to configure it:
8232
8233 =over 4
8234
8235 =item B<Host> I<hostname/ip>
8236
8237 The hostname or ip which identifies the physical server.
8238 Default: 127.0.0.1
8239
8240 =item B<Port> I<port>
8241
8242 The query port of the physical server. This needs to be a string.
8243 Default: "51234"
8244
8245 =item B<Server> I<port>
8246
8247 This option has to be added once for every virtual server the plugin should
8248 query. If you want to query the virtual server on port 8767 this is what the
8249 option would look like:
8250
8251   Server "8767"
8252
8253 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8254 use quotes around it! If no such statement is given only global information
8255 will be collected.
8256
8257 =back
8258
8259 =head2 Plugin C<ted>
8260
8261 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8262 measure power consumption. These devices are usually connected to a serial
8263 (RS232) or USB port. The plugin opens a configured device and tries to read the
8264 current energy readings. For more information on TED, visit
8265 L<http://www.theenergydetective.com/>.
8266
8267 Available configuration options:
8268
8269 =over 4
8270
8271 =item B<Device> I<Path>
8272
8273 Path to the device on which TED is connected. collectd will need read and write
8274 permissions on that file.
8275
8276 Default: B</dev/ttyUSB0>
8277
8278 =item B<Retries> I<Num>
8279
8280 Apparently reading from TED is not that reliable. You can therefore configure a
8281 number of retries here. You only configure the I<retries> here, to if you
8282 specify zero, one reading will be performed (but no retries if that fails); if
8283 you specify three, a maximum of four readings are performed. Negative values
8284 are illegal.
8285
8286 Default: B<0>
8287
8288 =back
8289
8290 =head2 Plugin C<tcpconns>
8291
8292 The C<tcpconns plugin> counts the number of currently established TCP
8293 connections based on the local port and/or the remote port. Since there may be
8294 a lot of connections the default if to count all connections with a local port,
8295 for which a listening socket is opened. You can use the following options to
8296 fine-tune the ports you are interested in:
8297
8298 =over 4
8299
8300 =item B<ListeningPorts> I<true>|I<false>
8301
8302 If this option is set to I<true>, statistics for all local ports for which a
8303 listening socket exists are collected. The default depends on B<LocalPort> and
8304 B<RemotePort> (see below): If no port at all is specifically selected, the
8305 default is to collect listening ports. If specific ports (no matter if local or
8306 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8307 the selected ports will be collected unless this option is set to I<true>
8308 specifically.
8309
8310 =item B<LocalPort> I<Port>
8311
8312 Count the connections to a specific local port. This can be used to see how
8313 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8314 You have to specify the port in numeric form, so for the mailserver example
8315 you'd need to set B<25>.
8316
8317 =item B<RemotePort> I<Port>
8318
8319 Count the connections to a specific remote port. This is useful to see how
8320 much a remote service is used. This is most useful if you want to know how many
8321 connections a local service has opened to remote services, e.E<nbsp>g. how many
8322 connections a mail server or news server has to other mail or news servers, or
8323 how many connections a web proxy holds to web servers. You have to give the
8324 port in numeric form.
8325
8326 =item B<AllPortsSummary> I<true>|I<false>
8327
8328 If this option is set to I<true> a summary of statistics from all connections
8329 are collected. This option defaults to I<false>.
8330
8331 =back
8332
8333 =head2 Plugin C<thermal>
8334
8335 =over 4
8336
8337 =item B<ForceUseProcfs> I<true>|I<false>
8338
8339 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8340 C<sysfs> interface. If that is not available, the plugin falls back to the
8341 C<procfs> interface. By setting this option to I<true>, you can force the
8342 plugin to use the latter. This option defaults to I<false>.
8343
8344 =item B<Device> I<Device>
8345
8346 Selects the name of the thermal device that you want to collect or ignore,
8347 depending on the value of the B<IgnoreSelected> option. This option may be
8348 used multiple times to specify a list of devices.
8349
8350 See F</"IGNORELISTS"> for details.
8351
8352 =item B<IgnoreSelected> I<true>|I<false>
8353
8354 Invert the selection: If set to true, all devices B<except> the ones that
8355 match the device names specified by the B<Device> option are collected. By
8356 default only selected devices are collected if a selection is made. If no
8357 selection is configured at all, B<all> devices are selected.
8358
8359 =back
8360
8361 =head2 Plugin C<threshold>
8362
8363 The I<Threshold plugin> checks values collected or received by I<collectd>
8364 against a configurable I<threshold> and issues I<notifications> if values are
8365 out of bounds.
8366
8367 Documentation for this plugin is available in the L<collectd-threshold(5)>
8368 manual page.
8369
8370 =head2 Plugin C<tokyotyrant>
8371
8372 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8373 couple metrics: number of records, and database size on disk.
8374
8375 =over 4
8376
8377 =item B<Host> I<Hostname/IP>
8378
8379 The hostname or IP which identifies the server.
8380 Default: B<127.0.0.1>
8381
8382 =item B<Port> I<Service/Port>
8383
8384 The query port of the server. This needs to be a string, even if the port is
8385 given in its numeric form.
8386 Default: B<1978>
8387
8388 =back
8389
8390 =head2 Plugin C<turbostat>
8391
8392 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8393 Intel processors by using I<Model Specific Registers>.
8394
8395 =over 4
8396
8397 =item B<CoreCstates> I<Bitmask(Integer)>
8398
8399 Bit mask of the list of core C-states supported by the processor.
8400 This option should only be used if the automated detection fails.
8401 Default value extracted from the CPU model and family.
8402
8403 Currently supported C-states (by this plugin): 3, 6, 7
8404
8405 B<Example:>
8406
8407   All states (3, 6 and 7):
8408   (1<<3) + (1<<6) + (1<<7) = 392
8409
8410 =item B<PackageCstates> I<Bitmask(Integer)>
8411
8412 Bit mask of the list of packages C-states supported by the processor. This
8413 option should only be used if the automated detection fails. Default value
8414 extracted from the CPU model and family.
8415
8416 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8417
8418 B<Example:>
8419
8420   States 2, 3, 6 and 7:
8421   (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8422
8423 =item B<SystemManagementInterrupt> I<true>|I<false>
8424
8425 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8426 This option should only be used if the automated detection fails or if you want
8427 to disable this feature.
8428
8429 =item B<DigitalTemperatureSensor> I<true>|I<false>
8430
8431 Boolean enabling the collection of the temperature of each core. This option
8432 should only be used if the automated detection fails or if you want to disable
8433 this feature.
8434
8435 =item B<TCCActivationTemp> I<Temperature>
8436
8437 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8438 temperature is used when collecting the temperature of cores or packages. This
8439 option should only be used if the automated detection fails. Default value
8440 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8441
8442 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8443
8444 Bit mask of the list of elements to be thermally monitored. This option should
8445 only be used if the automated detection fails or if you want to disable some
8446 collections. The different bits of this bit mask accepted by this plugin are:
8447
8448 =over 4
8449
8450 =item 0 ('1'): Package
8451
8452 =item 1 ('2'): DRAM
8453
8454 =item 2 ('4'): Cores
8455
8456 =item 3 ('8'): Embedded graphic device
8457
8458 =back
8459
8460 =item B<LogicalCoreNames> I<true>|I<false>
8461
8462 Boolean enabling the use of logical core numbering for per core statistics.
8463 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8464 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8465 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8466 more than one, where I<n> is the n-th core of package I<m>.
8467
8468 =back
8469
8470 =head2 Plugin C<unixsock>
8471
8472 =over 4
8473
8474 =item B<SocketFile> I<Path>
8475
8476 Sets the socket-file which is to be created.
8477
8478 =item B<SocketGroup> I<Group>
8479
8480 If running as root change the group of the UNIX-socket after it has been
8481 created. Defaults to B<collectd>.
8482
8483 =item B<SocketPerms> I<Permissions>
8484
8485 Change the file permissions of the UNIX-socket after it has been created. The
8486 permissions must be given as a numeric, octal value as you would pass to
8487 L<chmod(1)>. Defaults to B<0770>.
8488
8489 =item B<DeleteSocket> B<false>|B<true>
8490
8491 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8492 with the given name already exists. If I<collectd> crashes a socket file may be
8493 left over, preventing the daemon from opening a new socket when restarted.
8494 Since this is potentially dangerous, this defaults to B<false>.
8495
8496 =back
8497
8498 =head2 Plugin C<uuid>
8499
8500 This plugin, if loaded, causes the Hostname to be taken from the machine's
8501 UUID. The UUID is a universally unique designation for the machine, usually
8502 taken from the machine's BIOS. This is most useful if the machine is running in
8503 a virtual environment such as Xen, in which case the UUID is preserved across
8504 shutdowns and migration.
8505
8506 The following methods are used to find the machine's UUID, in order:
8507
8508 =over 4
8509
8510 =item *
8511
8512 Check I</etc/uuid> (or I<UUIDFile>).
8513
8514 =item *
8515
8516 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8517 present.
8518
8519 =item *
8520
8521 Check for UUID from C<dmidecode> / SMBIOS.
8522
8523 =item *
8524
8525 Check for UUID from Xen hypervisor.
8526
8527 =back
8528
8529 If no UUID can be found then the hostname is not modified.
8530
8531 =over 4
8532
8533 =item B<UUIDFile> I<Path>
8534
8535 Take the UUID from the given file (default I</etc/uuid>).
8536
8537 =back
8538
8539 =head2 Plugin C<varnish>
8540
8541 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8542 It collects a subset of the values displayed by L<varnishstat(1)>, and
8543 organizes them in categories which can be enabled or disabled. Currently only
8544 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8545 meaning of each metric can be found in L<varnish-counters(7)>.
8546
8547 Synopsis:
8548
8549  <Plugin "varnish">
8550    <Instance "example">
8551      CollectBackend     true
8552      CollectBan         false
8553      CollectCache       true
8554      CollectConnections true
8555      CollectDirectorDNS false
8556      CollectESI         false
8557      CollectFetch       false
8558      CollectHCB         false
8559      CollectObjects     false
8560      CollectPurge       false
8561      CollectSession     false
8562      CollectSHM         true
8563      CollectSMA         false
8564      CollectSMS         false
8565      CollectSM          false
8566      CollectStruct      false
8567      CollectTotals      false
8568      CollectUptime      false
8569      CollectVCL         false
8570      CollectVSM         false
8571      CollectWorkers     false
8572      CollectLock        false
8573      CollectMempool     false
8574      CollectManagement  false
8575      CollectSMF         false
8576      CollectVBE         false
8577      CollectMSE         false
8578    </Instance>
8579  </Plugin>
8580
8581 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8582 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8583 will collectd statistics from the default "varnishd" instance (this should work
8584 fine in most cases).
8585
8586 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8587
8588 =over 4
8589
8590 =item B<CollectBackend> B<true>|B<false>
8591
8592 Back-end connection statistics, such as successful, reused,
8593 and closed connections. True by default.
8594
8595 =item B<CollectBan> B<true>|B<false>
8596
8597 Statistics about ban operations, such as number of bans added, retired, and
8598 number of objects tested against ban operations. Only available with Varnish
8599 3.x and above. False by default.
8600
8601 =item B<CollectCache> B<true>|B<false>
8602
8603 Cache hits and misses. True by default.
8604
8605 =item B<CollectConnections> B<true>|B<false>
8606
8607 Number of client connections received, accepted and dropped. True by default.
8608
8609 =item B<CollectDirectorDNS> B<true>|B<false>
8610
8611 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8612 default.
8613
8614 =item B<CollectESI> B<true>|B<false>
8615
8616 Edge Side Includes (ESI) parse statistics. False by default.
8617
8618 =item B<CollectFetch> B<true>|B<false>
8619
8620 Statistics about fetches (HTTP requests sent to the backend). False by default.
8621
8622 =item B<CollectHCB> B<true>|B<false>
8623
8624 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8625 divided into locked and unlocked look-ups. False by default.
8626
8627 =item B<CollectObjects> B<true>|B<false>
8628
8629 Statistics on cached objects: number of objects expired, nuked (prematurely
8630 expired), saved, moved, etc. False by default.
8631
8632 =item B<CollectPurge> B<true>|B<false>
8633
8634 Statistics about purge operations, such as number of purges added, retired, and
8635 number of objects tested against purge operations. Only available with Varnish
8636 2.x. False by default.
8637
8638 =item B<CollectSession> B<true>|B<false>
8639
8640 Client session statistics. Number of past and current sessions, session herd and
8641 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8642 metrics found in the Connections and Threads sections with previous versions of
8643 Varnish have been moved here.
8644
8645 =item B<CollectSHM> B<true>|B<false>
8646
8647 Statistics about the shared memory log, a memory region to store
8648 log messages which is flushed to disk when full. True by default.
8649
8650 =item B<CollectSMA> B<true>|B<false>
8651
8652 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8653 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
8654 only the one used by the Varnish instance. Only available with Varnish 2.x.
8655 False by default.
8656
8657 =item B<CollectSMS> B<true>|B<false>
8658
8659 synth (synthetic content) storage statistics. This storage
8660 component is used internally only. False by default.
8661
8662 =item B<CollectSM> B<true>|B<false>
8663
8664 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8665 in varnish 4.x. use CollectSMF.
8666 False by default.
8667
8668 =item B<CollectStruct> B<true>|B<false>
8669
8670 Current varnish internal state statistics. Number of current sessions, objects
8671 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8672 default.
8673
8674 =item B<CollectTotals> B<true>|B<false>
8675
8676 Collects overview counters, such as the number of sessions created,
8677 the number of requests and bytes transferred. False by default.
8678
8679 =item B<CollectUptime> B<true>|B<false>
8680
8681 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8682
8683 =item B<CollectVCL> B<true>|B<false>
8684
8685 Number of total (available + discarded) VCL (config files). False by default.
8686
8687 =item B<CollectVSM> B<true>|B<false>
8688
8689 Collect statistics about Varnish's shared memory usage (used by the logging and
8690 statistics subsystems). Only available with Varnish 4.x. False by default.
8691
8692 =item B<CollectWorkers> B<true>|B<false>
8693
8694 Collect statistics about worker threads. False by default.
8695
8696 =item B<CollectVBE> B<true>|B<false>
8697
8698 Backend counters. Only available with Varnish 4.x. False by default.
8699
8700 =item B<CollectSMF> B<true>|B<false>
8701
8702 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
8703 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
8704 instance. Used to be called SM in Varnish 2.x. False by default.
8705
8706 =item B<CollectManagement> B<true>|B<false>
8707
8708 Management process counters. Only available with Varnish 4.x. False by default.
8709
8710 =item B<CollectLock> B<true>|B<false>
8711
8712 Lock counters. Only available with Varnish 4.x. False by default.
8713
8714 =item B<CollectMempool> B<true>|B<false>
8715
8716 Memory pool counters. Only available with Varnish 4.x. False by default.
8717
8718 =item B<CollectMSE> B<true>|B<false>
8719
8720 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
8721 Varnish, replacing the traditional malloc and file storages. Only available
8722 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
8723 one used by the Varnish instance. False by default.
8724
8725 =back
8726
8727 =head2 Plugin C<virt>
8728
8729 This plugin allows CPU, disk, network load and other metrics to be collected for
8730 virtualized guests on the machine. The statistics are collected through libvirt
8731 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8732 installing any additional software on guests, especially I<collectd>, which runs
8733 only on the host system.
8734
8735 Only I<Connection> is required.
8736
8737 =over 4
8738
8739 =item B<Connection> I<uri>
8740
8741 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8742
8743  Connection "xen:///"
8744
8745 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8746
8747 =item B<RefreshInterval> I<seconds>
8748
8749 Refresh the list of domains and devices every I<seconds>. The default is 60
8750 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8751 the list of domains and devices to be refreshed on every iteration.
8752
8753 Refreshing the devices in particular is quite a costly operation, so if your
8754 virtualization setup is static you might consider increasing this. If this
8755 option is set to 0, refreshing is disabled completely.
8756
8757 =item B<Domain> I<name>
8758
8759 =item B<BlockDevice> I<name:dev>
8760
8761 =item B<InterfaceDevice> I<name:dev>
8762
8763 =item B<IgnoreSelected> B<true>|B<false>
8764
8765 Select which domains and devices are collected.
8766
8767 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8768 disk/network devices are collected.
8769
8770 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8771 domains and disk/network devices are ignored, while the rest are collected.
8772
8773 The domain name and device names may use a regular expression, if the name is
8774 surrounded by I</.../> and collectd was compiled with support for regexps.
8775
8776 The default is to collect statistics for all domains and all their devices.
8777
8778 Example:
8779
8780  BlockDevice "/:hdb/"
8781  IgnoreSelected "true"
8782
8783 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8784 will be collected.
8785
8786 =item B<BlockDeviceFormat> B<target>|B<source>
8787
8788 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8789 seen by the guest will be used for reporting metrics.
8790 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8791 domain.
8792
8793 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8794 using the path of the source, e.g. an image file.
8795 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8796 domain.
8797
8798 B<Example:>
8799
8800 If the domain XML have the following device defined:
8801
8802   <disk type='block' device='disk'>
8803     <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8804     <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8805     <target dev='sda' bus='scsi'/>
8806     <boot order='2'/>
8807     <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8808   </disk>
8809
8810 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8811 to C<sda>.
8812 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8813 to C<var_lib_libvirt_images_image1.qcow2>.
8814
8815 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8816
8817 The B<BlockDeviceFormatBasename> controls whether the full path or the
8818 L<basename(1)> of the source is being used as the I<type instance> when
8819 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8820
8821 B<Example:>
8822
8823 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8824 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8825 be set to C<var_lib_libvirt_images_image1.qcow2>.
8826 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8827 set to C<image1.qcow2>.
8828
8829 =item B<HostnameFormat> B<name|uuid|hostname|...>
8830
8831 When the virt plugin logs data, it sets the hostname of the collected data
8832 according to this setting. The default is to use the guest name as provided by
8833 the hypervisor, which is equal to setting B<name>.
8834
8835 B<uuid> means use the guest's UUID. This is useful if you want to track the
8836 same guest across migrations.
8837
8838 B<hostname> means to use the global B<Hostname> setting, which is probably not
8839 useful on its own because all guests will appear to have the same name.
8840
8841 You can also specify combinations of these fields. For example B<name uuid>
8842 means to concatenate the guest name and UUID (with a literal colon character
8843 between, thus I<"foo:1234-1234-1234-1234">).
8844
8845 At the moment of writing (collectd-5.5), hostname string is limited to 62
8846 characters. In case when combination of fields exceeds 62 characters,
8847 hostname will be truncated without a warning.
8848
8849 =item B<InterfaceFormat> B<name>|B<address>
8850
8851 When the virt plugin logs interface data, it sets the name of the collected
8852 data according to this setting. The default is to use the path as provided by
8853 the hypervisor (the "dev" property of the target node), which is equal to
8854 setting B<name>.
8855
8856 B<address> means use the interface's mac address. This is useful since the
8857 interface path might change between reboots of a guest or across migrations.
8858
8859 =item B<PluginInstanceFormat> B<name|uuid|none>
8860
8861 When the virt plugin logs data, it sets the plugin_instance of the collected
8862 data according to this setting. The default is to not set the plugin_instance.
8863
8864 B<name> means use the guest's name as provided by the hypervisor.
8865 B<uuid> means use the guest's UUID.
8866
8867 You can also specify combinations of the B<name> and B<uuid> fields.
8868 For example B<name uuid> means to concatenate the guest name and UUID
8869 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8870
8871 =item B<Instances> B<integer>
8872
8873 How many read instances you want to use for this plugin. The default is one,
8874 and the sensible setting is a multiple of the B<ReadThreads> value.
8875 If you are not sure, just use the default setting.
8876
8877 =item B<ExtraStats> B<string>
8878
8879 Report additional extra statistics. The default is no extra statistics, preserving
8880 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8881 allows the plugin to reported more detailed statistics about the behaviour of
8882 Virtual Machines. The argument is a space-separated list of selectors.
8883
8884 Currently supported selectors are:
8885
8886 =over 4
8887
8888 =item B<cpu_util>: report CPU utilization per domain in percentage.
8889
8890 =item B<disk>: report extra statistics like number of flush operations and total
8891 service time for read, write and flush operations. Requires libvirt API version
8892 I<0.9.5> or later.
8893
8894 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8895 I<0.9.10> or later.
8896
8897 =item B<domain_state>: report domain state and reason in human-readable format as
8898 a notification. If libvirt API version I<0.9.2> or later is available, domain
8899 reason will be included in notification.
8900
8901 =item B<fs_info>: report file system information as a notification. Requires
8902 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8903 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8904 version supports retrieving  file system information.
8905
8906 =item B<job_stats_background>: report statistics about progress of a background
8907 job on a domain. Only one type of job statistics can be collected at the same time.
8908 Requires libvirt API version I<1.2.9> or later.
8909
8910 =item B<job_stats_completed>: report statistics about a recently completed job on
8911 a domain. Only one type of job statistics can be collected at the same time.
8912 Requires libvirt API version I<1.2.9> or later.
8913
8914 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8915 Requires libvirt API version I<0.9.11> or later.
8916
8917 =item B<perf>: report performance monitoring events. To collect performance
8918 metrics they must be enabled for domain and supported by the platform. Requires
8919 libvirt API version I<1.3.3> or later.
8920 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8921
8922 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8923
8924 =back
8925
8926 =back
8927
8928 =head2 Plugin C<vmem>
8929
8930 The C<vmem> plugin collects information about the usage of virtual memory.
8931 Since the statistics provided by the Linux kernel are very detailed, they are
8932 collected very detailed. However, to get all the details, you have to switch
8933 them on manually. Most people just want an overview over, such as the number of
8934 pages read from swap space.
8935
8936 =over 4
8937
8938 =item B<Verbose> B<true>|B<false>
8939
8940 Enables verbose collection of information. This will start collecting page
8941 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8942 Part of these statistics are collected on a "per zone" basis.
8943
8944 =back
8945
8946 =head2 Plugin C<vserver>
8947
8948 This plugin doesn't have any options. B<VServer> support is only available for
8949 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8950 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8951 need to apply the patches and compile your own kernel, which will then provide
8952 the F</proc/virtual> filesystem that is required by this plugin.
8953
8954 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8955
8956 B<Note>: The traffic collected by this plugin accounts for the amount of
8957 traffic passing a socket which might be a lot less than the actual on-wire
8958 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8959 collect on-wire traffic you could, for example, use the logging facilities of
8960 iptables to feed data for the guest IPs into the iptables plugin.
8961
8962 =head2 Plugin C<write_graphite>
8963
8964 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8965 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8966 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8967 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8968 of at most 1428 bytes to minimize the number of network packets.
8969
8970 Synopsis:
8971
8972  <Plugin write_graphite>
8973    <Node "example">
8974      Host "localhost"
8975      Port "2003"
8976      Protocol "tcp"
8977      LogSendErrors true
8978      Prefix "collectd"
8979    </Node>
8980  </Plugin>
8981
8982 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8983 blocks. Inside the B<Node> blocks, the following options are recognized:
8984
8985 =over 4
8986
8987 =item B<Host> I<Address>
8988
8989 Hostname or address to connect to. Defaults to C<localhost>.
8990
8991 =item B<Port> I<Service>
8992
8993 Service name or port number to connect to. Defaults to C<2003>.
8994
8995 =item B<Protocol> I<String>
8996
8997 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
8998
8999 =item B<ReconnectInterval> I<Seconds>
9000
9001 When set to non-zero, forces the connection to the Graphite backend to be
9002 closed and re-opend periodically. This behavior is desirable in environments
9003 where the connection to the Graphite backend is done through load balancers,
9004 for example. When set to zero, the default, the connetion is kept open for as
9005 long as possible.
9006
9007 =item B<LogSendErrors> B<false>|B<true>
9008
9009 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9010 If set to B<false>, it will not log the errors. This is especially useful when
9011 using Protocol UDP since many times we want to use the "fire-and-forget"
9012 approach and logging errors fills syslog with unneeded messages.
9013
9014 =item B<Prefix> I<String>
9015
9016 When set, I<String> is added in front of the host name. Dots and whitespace are
9017 I<not> escaped in this string (see B<EscapeCharacter> below).
9018
9019 =item B<Postfix> I<String>
9020
9021 When set, I<String> is appended to the host name. Dots and whitespace are
9022 I<not> escaped in this string (see B<EscapeCharacter> below).
9023
9024 =item B<EscapeCharacter> I<Char>
9025
9026 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9027 in the identifier. The B<EscapeCharacter> option determines which character
9028 dots, whitespace and control characters are replaced with. Defaults to
9029 underscore (C<_>).
9030
9031 =item B<StoreRates> B<false>|B<true>
9032
9033 If set to B<true> (the default), convert counter values to rates. If set to
9034 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9035 number.
9036
9037 =item B<SeparateInstances> B<false>|B<true>
9038
9039 If set to B<true>, the plugin instance and type instance will be in their own
9040 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9041 default), the plugin and plugin instance (and likewise the type and type
9042 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9043
9044 =item B<AlwaysAppendDS> B<false>|B<true>
9045
9046 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9047 identifier. If set to B<false> (the default), this is only done when there is
9048 more than one DS.
9049
9050 =item B<PreserveSeparator> B<false>|B<true>
9051
9052 If set to B<false> (the default) the C<.> (dot) character is replaced with
9053 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9054 is preserved, i.e. passed through.
9055
9056 =item B<DropDuplicateFields> B<false>|B<true>
9057
9058 If set to B<true>, detect and remove duplicate components in Graphite metric
9059 names. For example, the metric name  C<host.load.load.shortterm> will
9060 be shortened to C<host.load.shortterm>.
9061
9062 =back
9063
9064 =head2 Plugin C<write_log>
9065
9066 The C<write_log> plugin writes metrics as INFO log messages.
9067
9068 This plugin supports two output formats: I<Graphite> and I<JSON>.
9069
9070 Synopsis:
9071
9072  <Plugin write_log>
9073    Format Graphite
9074  </Plugin>
9075
9076 =over 4
9077
9078 =item B<Format> I<Format>
9079
9080 The output format to use. Can be one of C<Graphite> or C<JSON>.
9081
9082 =back
9083
9084 =head2 Plugin C<write_tsdb>
9085
9086 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9087 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9088 state daemon that ingests metrics and stores them in HBase. The plugin uses
9089 I<TCP> over the "line based" protocol with a default port 4242. The data will
9090 be sent in blocks of at most 1428 bytes to minimize the number of network
9091 packets.
9092
9093 Synopsis:
9094
9095  <Plugin write_tsdb>
9096    ResolveInterval 60
9097    ResolveJitter 60
9098    <Node "example">
9099      Host "tsd-1.my.domain"
9100      Port "4242"
9101      HostTags "status=production"
9102    </Node>
9103  </Plugin>
9104
9105 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9106 blocks and global directives.
9107
9108 Global directives are:
9109
9110 =over 4
9111
9112 =item B<ResolveInterval> I<seconds>
9113
9114 =item B<ResolveJitter> I<seconds>
9115
9116 When I<collectd> connects to a TSDB node, it will request the hostname from
9117 DNS. This can become a problem if the TSDB node is unavailable or badly
9118 configured because collectd will request DNS in order to reconnect for every
9119 metric, which can flood your DNS. So you can cache the last value for
9120 I<ResolveInterval> seconds.
9121 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9122
9123 You can also define a jitter, a random interval to wait in addition to
9124 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9125 hostname at the same time when the connection fails.
9126 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9127
9128 B<Note:> If the DNS resolution has already been successful when the socket
9129 closes, the plugin will try to reconnect immediately with the cached
9130 information. DNS is queried only when the socket is closed for a longer than
9131 I<ResolveInterval> + I<ResolveJitter> seconds.
9132
9133 =back
9134
9135 Inside the B<Node> blocks, the following options are recognized:
9136
9137 =over 4
9138
9139 =item B<Host> I<Address>
9140
9141 Hostname or address to connect to. Defaults to C<localhost>.
9142
9143 =item B<Port> I<Service>
9144
9145 Service name or port number to connect to. Defaults to C<4242>.
9146
9147
9148 =item B<HostTags> I<String>
9149
9150 When set, I<HostTags> is added to the end of the metric. It is intended to be
9151 used for name=value pairs that the TSD will tag the metric with. Dots and
9152 whitespace are I<not> escaped in this string.
9153
9154 =item B<StoreRates> B<false>|B<true>
9155
9156 If set to B<true>, convert counter values to rates. If set to B<false>
9157 (the default) counter values are stored as is, as an increasing
9158 integer number.
9159
9160 =item B<AlwaysAppendDS> B<false>|B<true>
9161
9162 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9163 identifier. If set to B<false> (the default), this is only done when there is
9164 more than one DS.
9165
9166 =back
9167
9168 =head2 Plugin C<write_mongodb>
9169
9170 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9171 NoSQL database.
9172
9173 B<Synopsis:>
9174
9175  <Plugin "write_mongodb">
9176    <Node "default">
9177      Host "localhost"
9178      Port "27017"
9179      Timeout 1000
9180      StoreRates true
9181    </Node>
9182  </Plugin>
9183
9184 The plugin can send values to multiple instances of I<MongoDB> by specifying
9185 one B<Node> block for each instance. Within the B<Node> blocks, the following
9186 options are available:
9187
9188 =over 4
9189
9190 =item B<Host> I<Address>
9191
9192 Hostname or address to connect to. Defaults to C<localhost>.
9193
9194 =item B<Port> I<Service>
9195
9196 Service name or port number to connect to. Defaults to C<27017>.
9197
9198 =item B<Timeout> I<Milliseconds>
9199
9200 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9201 Setting this option to zero means no timeout, which is the default.
9202
9203 =item B<StoreRates> B<false>|B<true>
9204
9205 If set to B<true> (the default), convert counter values to rates. If set to
9206 B<false> counter values are stored as is, i.e. as an increasing integer
9207 number.
9208
9209 =item B<Database> I<Database>
9210
9211 =item B<User> I<User>
9212
9213 =item B<Password> I<Password>
9214
9215 Sets the information used when authenticating to a I<MongoDB> database. The
9216 fields are optional (in which case no authentication is attempted), but if you
9217 want to use authentication all three fields must be set.
9218
9219 =back
9220
9221 =head2 Plugin C<write_prometheus>
9222
9223 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9224 using I<Prometheus>.
9225
9226 B<Options:>
9227
9228 =over 4
9229
9230 =item B<Port> I<Port>
9231
9232 Port the embedded webserver should listen on. Defaults to B<9103>.
9233
9234 =item B<StalenessDelta> I<Seconds>
9235
9236 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9237 hasn't seen any update for it. This value must match the setting in Prometheus.
9238 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9239
9240 B<Background:>
9241
9242 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9243 which time a metric without updates is considered "stale". This setting
9244 effectively puts an upper limit on the interval in which metrics are reported.
9245
9246 When the I<write_prometheus plugin> encounters a metric with an interval
9247 exceeding this limit, it will inform you, the user, and provide the metric to
9248 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9249 metric "fresh" each time it is scraped, with the time of the scrape being
9250 considered the time of the update. The result is that there appear more
9251 datapoints in I<Prometheus> than were actually created, but at least the metric
9252 doesn't disappear periodically.
9253
9254 =back
9255
9256 =head2 Plugin C<write_http>
9257
9258 This output plugin submits values to an HTTP server using POST requests and
9259 encoding metrics with JSON or using the C<PUTVAL> command described in
9260 L<collectd-unixsock(5)>.
9261
9262 Synopsis:
9263
9264  <Plugin "write_http">
9265    <Node "example">
9266      URL "http://example.com/post-collectd"
9267      User "collectd"
9268      Password "weCh3ik0"
9269      Format JSON
9270    </Node>
9271  </Plugin>
9272
9273 The plugin can send values to multiple HTTP servers by specifying one
9274 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9275 block, the following options are available:
9276
9277 =over 4
9278
9279 =item B<URL> I<URL>
9280
9281 URL to which the values are submitted to. Mandatory.
9282
9283 =item B<User> I<Username>
9284
9285 Optional user name needed for authentication.
9286
9287 =item B<Password> I<Password>
9288
9289 Optional password needed for authentication.
9290
9291 =item B<VerifyPeer> B<true>|B<false>
9292
9293 Enable or disable peer SSL certificate verification. See
9294 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9295
9296 =item B<VerifyHost> B<true|false>
9297
9298 Enable or disable peer host name verification. If enabled, the plugin checks if
9299 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9300 matches the host name provided by the B<URL> option. If this identity check
9301 fails, the connection is aborted. Obviously, only works when connecting to a
9302 SSL enabled server. Enabled by default.
9303
9304 =item B<CACert> I<File>
9305
9306 File that holds one or more SSL certificates. If you want to use HTTPS you will
9307 possibly need this option. What CA certificates come bundled with C<libcurl>
9308 and are checked by default depends on the distribution you use.
9309
9310 =item B<CAPath> I<Directory>
9311
9312 Directory holding one or more CA certificate files. You can use this if for
9313 some reason all the needed CA certificates aren't in the same file and can't be
9314 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9315 OpenSSL.
9316
9317 =item B<ClientKey> I<File>
9318
9319 File that holds the private key in PEM format to be used for certificate-based
9320 authentication.
9321
9322 =item B<ClientCert> I<File>
9323
9324 File that holds the SSL certificate to be used for certificate-based
9325 authentication.
9326
9327 =item B<ClientKeyPass> I<Password>
9328
9329 Password required to load the private key in B<ClientKey>.
9330
9331 =item B<Header> I<Header>
9332
9333 A HTTP header to add to the request.  Multiple headers are added if this option is specified more than once.  Example:
9334
9335   Header "X-Custom-Header: custom_value"
9336
9337 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9338
9339 Define which SSL protocol version must be used. By default C<libcurl> will
9340 attempt to figure out the remote SSL protocol version. See
9341 L<curl_easy_setopt(3)> for more details.
9342
9343 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9344
9345 Format of the output to generate. If set to B<Command>, will create output that
9346 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9347 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9348 , will create output in the KairosDB format.
9349
9350 Defaults to B<Command>.
9351
9352 =item B<Attribute> I<String> I<String>
9353
9354 Only available for the KAIROSDB output format.
9355
9356 Consider the two given strings to be the key and value of an additional tag for
9357 each metric being sent out.
9358
9359 You can add multiple B<Attribute>.
9360
9361 =item B<TTL> I<Int>
9362
9363 Only available for the KAIROSDB output format.
9364
9365 Sets the Cassandra ttl for the data points.
9366
9367 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9368
9369 =item B<Prefix> I<String>
9370
9371 Only available for the KAIROSDB output format.
9372
9373 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9374
9375 =item B<Metrics> B<true>|B<false>
9376
9377 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9378
9379 =item B<Notifications> B<false>|B<true>
9380
9381 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9382
9383 =item B<StoreRates> B<true|false>
9384
9385 If set to B<true>, convert counter values to rates. If set to B<false> (the
9386 default) counter values are stored as is, i.e. as an increasing integer number.
9387
9388 =item B<BufferSize> I<Bytes>
9389
9390 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9391 requests will be generated, but more metrics will be batched / metrics are
9392 cached for longer before being sent, introducing additional delay until they
9393 are available on the server side. I<Bytes> must be at least 1024 and cannot
9394 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9395 Defaults to C<4096>.
9396
9397 =item B<LowSpeedLimit> I<Bytes per Second>
9398
9399 Sets the minimal transfer rate in I<Bytes per Second> below which the
9400 connection with the HTTP server will be considered too slow and aborted. All
9401 the data submitted over this connection will probably be lost. Defaults to 0,
9402 which means no minimum transfer rate is enforced.
9403
9404 =item B<Timeout> I<Timeout>
9405
9406 Sets the maximum time in milliseconds given for HTTP POST operations to
9407 complete. When this limit is reached, the POST operation will be aborted, and
9408 all the data in the current send buffer will probably be lost. Defaults to 0,
9409 which means the connection never times out.
9410
9411 =item B<LogHttpError> B<false>|B<true>
9412
9413 Enables printing of HTTP error code to log. Turned off by default.
9414
9415 The C<write_http> plugin regularly submits the collected values to the HTTP
9416 server. How frequently this happens depends on how much data you are collecting
9417 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9418 slightly below this interval, which you can estimate by monitoring the network
9419 traffic between collectd and the HTTP server.
9420
9421 =back
9422
9423 =head2 Plugin C<write_kafka>
9424
9425 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9426 queue.
9427 Synopsis:
9428
9429  <Plugin "write_kafka">
9430    Property "metadata.broker.list" "broker1:9092,broker2:9092"
9431    <Topic "collectd">
9432      Format JSON
9433    </Topic>
9434  </Plugin>
9435
9436 The following options are understood by the I<write_kafka plugin>:
9437
9438 =over 4
9439
9440 =item E<lt>B<Topic> I<Name>E<gt>
9441
9442 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9443 is given a unique I<Name> and specifies one kafka producer.
9444 Inside the B<Topic> block, the following per-topic options are
9445 understood:
9446
9447 =over 4
9448
9449 =item B<Property> I<String> I<String>
9450
9451 Configure the named property for the current topic. Properties are
9452 forwarded to the kafka producer library B<librdkafka>.
9453
9454 =item B<Key> I<String>
9455
9456 Use the specified string as a partitioning key for the topic. Kafka breaks
9457 topic into partitions and guarantees that for a given topology, the same
9458 consumer will be used for a specific key. The special (case insensitive)
9459 string B<Random> can be used to specify that an arbitrary partition should
9460 be used.
9461
9462 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9463
9464 Selects the format in which messages are sent to the broker. If set to
9465 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9466 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9467
9468 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9469 an easy and straight forward exchange format.
9470
9471 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9472 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9473
9474 =item B<StoreRates> B<true>|B<false>
9475
9476 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9477 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9478 default), no conversion is performed. Otherwise the conversion is performed
9479 using the internal value cache.
9480
9481 Please note that currently this option is only used if the B<Format> option has
9482 been set to B<JSON>.
9483
9484 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9485
9486 A prefix can be added in the metric name when outputting in the I<Graphite>
9487 format. It's added before the I<Host> name.
9488 Metric name will be
9489 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>>
9490
9491 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9492
9493 A postfix can be added in the metric name when outputting in the I<Graphite>
9494 format. It's added after the I<Host> name.
9495 Metric name will be
9496 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>>
9497
9498 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9499
9500 Specify a character to replace dots (.) in the host part of the metric name.
9501 In I<Graphite> metric name, dots are used as separators between different
9502 metric parts (host, plugin, type).
9503 Default is C<_> (I<Underscore>).
9504
9505 =item B<GraphiteSeparateInstances> B<false>|B<true>
9506
9507 If set to B<true>, the plugin instance and type instance will be in their own
9508 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9509 default), the plugin and plugin instance (and likewise the type and type
9510 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9511
9512 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9513
9514 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9515 identifier. If set to B<false> (the default), this is only done when there is
9516 more than one DS.
9517
9518 =item B<GraphitePreserveSeparator> B<false>|B<true>
9519
9520 If set to B<false> (the default) the C<.> (dot) character is replaced with
9521 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9522 is preserved, i.e. passed through.
9523
9524 =item B<StoreRates> B<true>|B<false>
9525
9526 If set to B<true> (the default), convert counter values to rates. If set to
9527 B<false> counter values are stored as is, i.e. as an increasing integer number.
9528
9529 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9530 converted values will have "rate" appended to the data source type, e.g.
9531 C<ds_type:derive:rate>.
9532
9533 =back
9534
9535 =item B<Property> I<String> I<String>
9536
9537 Configure the kafka producer through properties, you almost always will
9538 want to set B<metadata.broker.list> to your Kafka broker list.
9539
9540 =back
9541
9542 =head2 Plugin C<write_redis>
9543
9544 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9545
9546 Synopsis:
9547
9548   <Plugin "write_redis">
9549     <Node "example">
9550         Host "localhost"
9551         Port "6379"
9552         Timeout 1000
9553         Prefix "collectd/"
9554         Database 1
9555         MaxSetSize -1
9556         MaxSetDuration -1
9557         StoreRates true
9558     </Node>
9559   </Plugin>
9560
9561 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9562 the timestamp as the score. Retrieving a date range can then be done using the
9563 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9564 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9565 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9566 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9567 with the B<Database> parameter (default is C<0>). See
9568 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9569 details.
9570
9571 The information shown in the synopsis above is the I<default configuration>
9572 which is used by the plugin if no configuration is present.
9573
9574 The plugin can send values to multiple instances of I<Redis> by specifying
9575 one B<Node> block for each instance. Within the B<Node> blocks, the following
9576 options are available:
9577
9578 =over 4
9579
9580 =item B<Node> I<Nodename>
9581
9582 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9583 instance running on a specified host and port. The node name is a
9584 canonical identifier which is used as I<plugin instance>. It is limited to
9585 51E<nbsp>characters in length.
9586
9587 =item B<Host> I<Hostname>
9588
9589 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9590 running on.
9591
9592 =item B<Port> I<Port>
9593
9594 The B<Port> option is the TCP port on which the Redis instance accepts
9595 connections. Either a service name of a port number may be given. Please note
9596 that numerical port numbers must be given as a string, too.
9597
9598 =item B<Timeout> I<Milliseconds>
9599
9600 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9601
9602 =item B<Prefix> I<Prefix>
9603
9604 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9605 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9606 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9607 is recommended but not required to include a trailing slash in I<Prefix>.
9608
9609 =item B<Database> I<Index>
9610
9611 This index selects the redis database to use for writing operations. Defaults
9612 to C<0>.
9613
9614 =item B<MaxSetSize> I<Items>
9615
9616 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9617 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9618
9619 =item B<MaxSetDuration> I<Seconds>
9620
9621 The B<MaxSetDuration> option limits the duration of items that the
9622 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9623 is the default behavior.
9624
9625 =item B<StoreRates> B<true>|B<false>
9626
9627 If set to B<true> (the default), convert counter values to rates. If set to
9628 B<false> counter values are stored as is, i.e. as an increasing integer number.
9629
9630 =back
9631
9632 =head2 Plugin C<write_riemann>
9633
9634 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9635 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9636 I<Riemann> using UDP packets.
9637
9638 Synopsis:
9639
9640  <Plugin "write_riemann">
9641    <Node "example">
9642      Host "localhost"
9643      Port "5555"
9644      Protocol UDP
9645      StoreRates true
9646      AlwaysAppendDS false
9647      TTLFactor 2.0
9648    </Node>
9649    Tag "foobar"
9650    Attribute "foo" "bar"
9651  </Plugin>
9652
9653 The following options are understood by the I<write_riemann plugin>:
9654
9655 =over 4
9656
9657 =item E<lt>B<Node> I<Name>E<gt>
9658
9659 The plugin's configuration consists of one or more B<Node> blocks. Each block
9660 is given a unique I<Name> and specifies one connection to an instance of
9661 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9662 understood:
9663
9664 =over 4
9665
9666 =item B<Host> I<Address>
9667
9668 Hostname or address to connect to. Defaults to C<localhost>.
9669
9670 =item B<Port> I<Service>
9671
9672 Service name or port number to connect to. Defaults to C<5555>.
9673
9674 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9675
9676 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9677 B<TCP>.
9678
9679 =item B<TLSCertFile> I<Path>
9680
9681 When using the B<TLS> protocol, path to a PEM certificate to present
9682 to remote host.
9683
9684 =item B<TLSCAFile> I<Path>
9685
9686 When using the B<TLS> protocol, path to a PEM CA certificate to
9687 use to validate the remote hosts's identity.
9688
9689 =item B<TLSKeyFile> I<Path>
9690
9691 When using the B<TLS> protocol, path to a PEM private key associated
9692 with the certificate defined by B<TLSCertFile>.
9693
9694 =item B<Batch> B<true>|B<false>
9695
9696 If set to B<true> and B<Protocol> is set to B<TCP>,
9697 events will be batched in memory and flushed at
9698 regular intervals or when B<BatchMaxSize> is exceeded.
9699
9700 Notifications are not batched and sent as soon as possible.
9701
9702 When enabled, it can occur that events get processed by the Riemann server
9703 close to or after their expiration time. Tune the B<TTLFactor> and
9704 B<BatchMaxSize> settings according to the amount of values collected, if this
9705 is an issue.
9706
9707 Defaults to true
9708
9709 =item B<BatchMaxSize> I<size>
9710
9711 Maximum payload size for a riemann packet. Defaults to 8192
9712
9713 =item B<BatchFlushTimeout> I<seconds>
9714
9715 Maximum amount of seconds to wait in between to batch flushes.
9716 No timeout by default.
9717
9718 =item B<StoreRates> B<true>|B<false>
9719
9720 If set to B<true> (the default), convert counter values to rates. If set to
9721 B<false> counter values are stored as is, i.e. as an increasing integer number.
9722
9723 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9724 converted values will have "rate" appended to the data source type, e.g.
9725 C<ds_type:derive:rate>.
9726
9727 =item B<AlwaysAppendDS> B<false>|B<true>
9728
9729 If set to B<true>, append the name of the I<Data Source> (DS) to the
9730 "service", i.e. the field that, together with the "host" field, uniquely
9731 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9732 only done when there is more than one DS.
9733
9734 =item B<TTLFactor> I<Factor>
9735
9736 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9737 event is considered active. I<collectd> populates this field based on the
9738 metrics interval setting. This setting controls the factor with which the
9739 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9740 know exactly what you're doing, you should only increase this setting from its
9741 default value.
9742
9743 =item B<Notifications> B<false>|B<true>
9744
9745 If set to B<true>, create riemann events for notifications. This is B<true>
9746 by default. When processing thresholds from write_riemann, it might prove
9747 useful to avoid getting notification events.
9748
9749 =item B<CheckThresholds> B<false>|B<true>
9750
9751 If set to B<true>, attach state to events based on thresholds defined
9752 in the B<Threshold> plugin. Defaults to B<false>.
9753
9754 =item B<EventServicePrefix> I<String>
9755
9756 Add the given string as a prefix to the event service name.
9757 If B<EventServicePrefix> not set or set to an empty string (""),
9758 no prefix will be used.
9759
9760 =back
9761
9762 =item B<Tag> I<String>
9763
9764 Add the given string as an additional tag to the metric being sent to
9765 I<Riemann>.
9766
9767 =item B<Attribute> I<String> I<String>
9768
9769 Consider the two given strings to be the key and value of an additional
9770 attribute for each metric being sent out to I<Riemann>.
9771
9772 =back
9773
9774 =head2 Plugin C<write_sensu>
9775
9776 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9777 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9778 a local I<Sensu> client using a TCP socket.
9779
9780 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9781 parameter so it is not possible to use one collectd instance as a gateway for
9782 others. Each collectd host must pair with one I<Sensu> client.
9783
9784 Synopsis:
9785
9786  <Plugin "write_sensu">
9787    <Node "example">
9788      Host "localhost"
9789      Port "3030"
9790      StoreRates true
9791      AlwaysAppendDS false
9792      MetricHandler "influx"
9793      MetricHandler "default"
9794      NotificationHandler "flapjack"
9795      NotificationHandler "howling_monkey"
9796      Notifications true
9797    </Node>
9798    Tag "foobar"
9799    Attribute "foo" "bar"
9800  </Plugin>
9801
9802 The following options are understood by the I<write_sensu plugin>:
9803
9804 =over 4
9805
9806 =item E<lt>B<Node> I<Name>E<gt>
9807
9808 The plugin's configuration consists of one or more B<Node> blocks. Each block
9809 is given a unique I<Name> and specifies one connection to an instance of
9810 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9811 understood:
9812
9813 =over 4
9814
9815 =item B<Host> I<Address>
9816
9817 Hostname or address to connect to. Defaults to C<localhost>.
9818
9819 =item B<Port> I<Service>
9820
9821 Service name or port number to connect to. Defaults to C<3030>.
9822
9823 =item B<StoreRates> B<true>|B<false>
9824
9825 If set to B<true> (the default), convert counter values to rates. If set to
9826 B<false> counter values are stored as is, i.e. as an increasing integer number.
9827
9828 This will be reflected in the C<collectd_data_source_type> tag: If
9829 B<StoreRates> is enabled, converted values will have "rate" appended to the
9830 data source type, e.g.  C<collectd_data_source_type:derive:rate>.
9831
9832 =item B<AlwaysAppendDS> B<false>|B<true>
9833
9834 If set the B<true>, append the name of the I<Data Source> (DS) to the
9835 "service", i.e. the field that, together with the "host" field, uniquely
9836 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9837 only done when there is more than one DS.
9838
9839 =item B<Notifications> B<false>|B<true>
9840
9841 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9842 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9843
9844 =item B<Metrics> B<false>|B<true>
9845
9846 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9847 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9848
9849
9850 =item B<Separator> I<String>
9851
9852 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9853
9854 =item B<MetricHandler> I<String>
9855
9856 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9857 several of them, one per line. Defaults to no handler.
9858
9859 =item B<NotificationHandler> I<String>
9860
9861 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9862 add several of them, one per line. Defaults to no handler.
9863
9864 =item B<EventServicePrefix> I<String>
9865
9866 Add the given string as a prefix to the event service name.
9867 If B<EventServicePrefix> not set or set to an empty string (""),
9868 no prefix will be used.
9869
9870 =back
9871
9872 =item B<Tag> I<String>
9873
9874 Add the given string as an additional tag to the metric being sent to
9875 I<Sensu>.
9876
9877 =item B<Attribute> I<String> I<String>
9878
9879 Consider the two given strings to be the key and value of an additional
9880 attribute for each metric being sent out to I<Sensu>.
9881
9882 =back
9883
9884 =head2 Plugin C<xencpu>
9885
9886 This plugin collects metrics of hardware CPU load for machine running Xen
9887 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9888 Result is reported using the C<percent> type, for each CPU (core).
9889
9890 This plugin doesn't have any options (yet).
9891
9892 =head2 Plugin C<zookeeper>
9893
9894 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9895 using the mntr command.  It requires Zookeeper 3.4.0+ and access to the
9896 client port.
9897
9898 B<Synopsis:>
9899
9900  <Plugin "zookeeper">
9901    Host "127.0.0.1"
9902    Port "2181"
9903  </Plugin>
9904
9905 =over 4
9906
9907 =item B<Host> I<Address>
9908
9909 Hostname or address to connect to. Defaults to C<localhost>.
9910
9911 =item B<Port> I<Service>
9912
9913 Service name or port number to connect to. Defaults to C<2181>.
9914
9915 =back
9916
9917 =head1 THRESHOLD CONFIGURATION
9918
9919 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9920 we mean that the values are not only stored or sent somewhere, but that they
9921 are judged and, if a problem is recognized, acted upon. The only action
9922 collectd takes itself is to generate and dispatch a "notification". Plugins can
9923 register to receive notifications and perform appropriate further actions.
9924
9925 Since systems and what you expect them to do differ a lot, you can configure
9926 B<thresholds> for your values freely. This gives you a lot of flexibility but
9927 also a lot of responsibility.
9928
9929 Every time a value is out of range a notification is dispatched. This means
9930 that the idle percentage of your CPU needs to be less then the configured
9931 threshold only once for a notification to be generated. There's no such thing
9932 as a moving average or similar - at least not now.
9933
9934 Also, all values that match a threshold are considered to be relevant or
9935 "interesting". As a consequence collectd will issue a notification if they are
9936 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9937 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9938 "2" (the default) and some hosts sends it's CPU statistics to the server every
9939 60 seconds, a notification will be dispatched after about 120 seconds. It may
9940 take a little longer because the timeout is checked only once each B<Interval>
9941 on the server.
9942
9943 When a value comes within range again or is received after it was missing, an
9944 "OKAY-notification" is dispatched.
9945
9946 Here is a configuration example to get you started. Read below for more
9947 information.
9948
9949  <Plugin threshold>
9950    <Type "foo">
9951      WarningMin    0.00
9952      WarningMax 1000.00
9953      FailureMin    0.00
9954      FailureMax 1200.00
9955      Invert false
9956      Instance "bar"
9957    </Type>
9958
9959    <Plugin "interface">
9960      Instance "eth0"
9961      <Type "if_octets">
9962        FailureMax 10000000
9963        DataSource "rx"
9964      </Type>
9965    </Plugin>
9966
9967    <Host "hostname">
9968      <Type "cpu">
9969        Instance "idle"
9970        FailureMin 10
9971      </Type>
9972
9973      <Plugin "memory">
9974        <Type "memory">
9975          Instance "cached"
9976          WarningMin 100000000
9977        </Type>
9978      </Plugin>
9979    </Host>
9980  </Plugin>
9981
9982 There are basically two types of configuration statements: The C<Host>,
9983 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
9984 configured. The C<Plugin> and C<Type> blocks may be specified further using the
9985 C<Instance> option. You can combine the block by nesting the blocks, though
9986 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
9987 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
9988 C<Type> may not contain other blocks. If multiple blocks apply to the same
9989 value the most specific block is used.
9990
9991 The other statements specify the threshold to configure. They B<must> be
9992 included in a C<Type> block. Currently the following statements are recognized:
9993
9994 =over 4
9995
9996 =item B<FailureMax> I<Value>
9997
9998 =item B<WarningMax> I<Value>
9999
10000 Sets the upper bound of acceptable values. If unset defaults to positive
10001 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10002 will be created. If the value is greater than B<WarningMax> but less than (or
10003 equal to) B<FailureMax> a B<WARNING> notification will be created.
10004
10005 =item B<FailureMin> I<Value>
10006
10007 =item B<WarningMin> I<Value>
10008
10009 Sets the lower bound of acceptable values. If unset defaults to negative
10010 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10011 be created. If the value is less than B<WarningMin> but greater than (or equal
10012 to) B<FailureMin> a B<WARNING> notification will be created.
10013
10014 =item B<DataSource> I<DSName>
10015
10016 Some data sets have more than one "data source". Interesting examples are the
10017 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10018 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10019 system load data set, C<load>, even has three data sources: C<shortterm>,
10020 C<midterm>, and C<longterm>.
10021
10022 Normally, all data sources are checked against a configured threshold. If this
10023 is undesirable, or if you want to specify different limits for each data
10024 source, you can use the B<DataSource> option to have a threshold apply only to
10025 one data source.
10026
10027 =item B<Invert> B<true>|B<false>
10028
10029 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10030 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10031 B<WarningMax>) are not okay. Defaults to B<false>.
10032
10033 =item B<Persist> B<true>|B<false>
10034
10035 Sets how often notifications are generated. If set to B<true> one notification
10036 will be generated for each value that is out of the acceptable range. If set to
10037 B<false> (the default) then a notification is only generated if a value is out
10038 of range but the previous value was okay.
10039
10040 This applies to missing values, too: If set to B<true> a notification about a
10041 missing value is generated once every B<Interval> seconds. If set to B<false>
10042 only one such notification is generated until the value appears again.
10043
10044 =item B<Percentage> B<true>|B<false>
10045
10046 If set to B<true>, the minimum and maximum values given are interpreted as
10047 percentage value, relative to the other data sources. This is helpful for
10048 example for the "df" type, where you may want to issue a warning when less than
10049 5E<nbsp>% of the total space is available. Defaults to B<false>.
10050
10051 =item B<Hits> I<Number>
10052
10053 Delay creating the notification until the threshold has been passed I<Number>
10054 times. When a notification has been generated, or when a subsequent value is
10055 inside the threshold, the counter is reset. If, for example, a value is
10056 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10057 will be dispatched at most once every 30E<nbsp>seconds.
10058
10059 This is useful when short bursts are not a problem. If, for example, 100% CPU
10060 usage for up to a minute is normal (and data is collected every
10061 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10062
10063 =item B<Hysteresis> I<Number>
10064
10065 When set to non-zero, a hysteresis value is applied when checking minimum and
10066 maximum bounds. This is useful for values that increase slowly and fluctuate a
10067 bit while doing so. When these values come close to the threshold, they may
10068 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10069
10070 If, for example, the threshold is configures as
10071
10072   WarningMax 100.0
10073   Hysteresis 1.0
10074
10075 then a I<Warning> notification is created when the value exceeds I<101> and the
10076 corresponding I<Okay> notification is only created once the value falls below
10077 I<99>, thus avoiding the "flapping".
10078
10079 =back
10080
10081 =head1 FILTER CONFIGURATION
10082
10083 Starting with collectd 4.6 there is a powerful filtering infrastructure
10084 implemented in the daemon. The concept has mostly been copied from
10085 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10086 terminology, so that users that are familiar with iptables feel right at home.
10087
10088 =head2 Terminology
10089
10090 The following are the terms used in the remainder of the filter configuration
10091 documentation. For an ASCII-art schema of the mechanism, see
10092 L<"General structure"> below.
10093
10094 =over 4
10095
10096 =item B<Match>
10097
10098 A I<match> is a criteria to select specific values. Examples are, of course, the
10099 name of the value or it's current value.
10100
10101 Matches are implemented in plugins which you have to load prior to using the
10102 match. The name of such plugins starts with the "match_" prefix.
10103
10104 =item B<Target>
10105
10106 A I<target> is some action that is to be performed with data. Such actions
10107 could, for example, be to change part of the value's identifier or to ignore
10108 the value completely.
10109
10110 Some of these targets are built into the daemon, see L<"Built-in targets">
10111 below. Other targets are implemented in plugins which you have to load prior to
10112 using the target. The name of such plugins starts with the "target_" prefix.
10113
10114 =item B<Rule>
10115
10116 The combination of any number of matches and at least one target is called a
10117 I<rule>. The target actions will be performed for all values for which B<all>
10118 matches apply. If the rule does not have any matches associated with it, the
10119 target action will be performed for all values.
10120
10121 =item B<Chain>
10122
10123 A I<chain> is a list of rules and possibly default targets. The rules are tried
10124 in order and if one matches, the associated target will be called. If a value
10125 is handled by a rule, it depends on the target whether or not any subsequent
10126 rules are considered or if traversal of the chain is aborted, see
10127 L<"Flow control"> below. After all rules have been checked, the default targets
10128 will be executed.
10129
10130 =back
10131
10132 =head2 General structure
10133
10134 The following shows the resulting structure:
10135
10136  +---------+
10137  ! Chain   !
10138  +---------+
10139       !
10140       V
10141  +---------+  +---------+  +---------+  +---------+
10142  ! Rule    !->! Match   !->! Match   !->! Target  !
10143  +---------+  +---------+  +---------+  +---------+
10144       !
10145       V
10146  +---------+  +---------+  +---------+
10147  ! Rule    !->! Target  !->! Target  !
10148  +---------+  +---------+  +---------+
10149       !
10150       V
10151       :
10152       :
10153       !
10154       V
10155  +---------+  +---------+  +---------+
10156  ! Rule    !->! Match   !->! Target  !
10157  +---------+  +---------+  +---------+
10158       !
10159       V
10160  +---------+
10161  ! Default !
10162  ! Target  !
10163  +---------+
10164
10165 =head2 Flow control
10166
10167 There are four ways to control which way a value takes through the filter
10168 mechanism:
10169
10170 =over 4
10171
10172 =item B<jump>
10173
10174 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10175 process the value with another chain. When the called chain finishes, usually
10176 the next target or rule after the jump is executed.
10177
10178 =item B<stop>
10179
10180 The stop condition, signaled for example by the built-in target B<stop>, causes
10181 all processing of the value to be stopped immediately.
10182
10183 =item B<return>
10184
10185 Causes processing in the current chain to be aborted, but processing of the
10186 value generally will continue. This means that if the chain was called via
10187 B<Jump>, the next target or rule after the jump will be executed. If the chain
10188 was not called by another chain, control will be returned to the daemon and it
10189 may pass the value to another chain.
10190
10191 =item B<continue>
10192
10193 Most targets will signal the B<continue> condition, meaning that processing
10194 should continue normally. There is no special built-in target for this
10195 condition.
10196
10197 =back
10198
10199 =head2 Synopsis
10200
10201 The configuration reflects this structure directly:
10202
10203  PostCacheChain "PostCache"
10204  <Chain "PostCache">
10205    <Rule "ignore_mysql_show">
10206      <Match "regex">
10207        Plugin "^mysql$"
10208        Type "^mysql_command$"
10209        TypeInstance "^show_"
10210      </Match>
10211      <Target "stop">
10212      </Target>
10213    </Rule>
10214    <Target "write">
10215      Plugin "rrdtool"
10216    </Target>
10217  </Chain>
10218
10219 The above configuration example will ignore all values where the plugin field
10220 is "mysql", the type is "mysql_command" and the type instance begins with
10221 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10222 default target of the chain. Since this chain is run after the value has been
10223 added to the cache, the MySQL C<show_*> command statistics will be available
10224 via the C<unixsock> plugin.
10225
10226 =head2 List of configuration options
10227
10228 =over 4
10229
10230 =item B<PreCacheChain> I<ChainName>
10231
10232 =item B<PostCacheChain> I<ChainName>
10233
10234 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10235 argument is the name of a I<chain> that should be executed before and/or after
10236 the values have been added to the cache.
10237
10238 To understand the implications, it's important you know what is going on inside
10239 I<collectd>. The following diagram shows how values are passed from the
10240 read-plugins to the write-plugins:
10241
10242    +---------------+
10243    !  Read-Plugin  !
10244    +-------+-------+
10245            !
10246  + - - - - V - - - - +
10247  : +---------------+ :
10248  : !   Pre-Cache   ! :
10249  : !     Chain     ! :
10250  : +-------+-------+ :
10251  :         !         :
10252  :         V         :
10253  : +-------+-------+ :  +---------------+
10254  : !     Cache     !--->!  Value Cache  !
10255  : !     insert    ! :  +---+---+-------+
10256  : +-------+-------+ :      !   !
10257  :         !   ,------------'   !
10258  :         V   V     :          V
10259  : +-------+---+---+ :  +-------+-------+
10260  : !  Post-Cache   +--->! Write-Plugins !
10261  : !     Chain     ! :  +---------------+
10262  : +---------------+ :
10263  :                   :
10264  :  dispatch values  :
10265  + - - - - - - - - - +
10266
10267 After the values are passed from the "read" plugins to the dispatch functions,
10268 the pre-cache chain is run first. The values are added to the internal cache
10269 afterwards. The post-cache chain is run after the values have been added to the
10270 cache. So why is it such a huge deal if chains are run before or after the
10271 values have been added to this cache?
10272
10273 Targets that change the identifier of a value list should be executed before
10274 the values are added to the cache, so that the name in the cache matches the
10275 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10276 this cache to receive a list of all available values. If you change the
10277 identifier after the value list has been added to the cache, this may easily
10278 lead to confusion, but it's not forbidden of course.
10279
10280 The cache is also used to convert counter values to rates. These rates are, for
10281 example, used by the C<value> match (see below). If you use the rate stored in
10282 the cache B<before> the new value is added, you will use the old, B<previous>
10283 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10284 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10285 command.
10286
10287 Last but not last, the B<stop> target makes a difference: If the pre-cache
10288 chain returns the stop condition, the value will not be added to the cache and
10289 the post-cache chain will not be run.
10290
10291 =item B<Chain> I<Name>
10292
10293 Adds a new chain with a certain name. This name can be used to refer to a
10294 specific chain, for example to jump to it.
10295
10296 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10297
10298 =item B<Rule> [I<Name>]
10299
10300 Adds a new rule to the current chain. The name of the rule is optional and
10301 currently has no meaning for the daemon.
10302
10303 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10304 must be at least one B<Target> block.
10305
10306 =item B<Match> I<Name>
10307
10308 Adds a match to a B<Rule> block. The name specifies what kind of match should
10309 be performed. Available matches depend on the plugins that have been loaded.
10310
10311 The arguments inside the B<Match> block are passed to the plugin implementing
10312 the match, so which arguments are valid here depends on the plugin being used.
10313 If you do not need any to pass any arguments to a match, you can use the
10314 shorter syntax:
10315
10316  Match "foobar"
10317
10318 Which is equivalent to:
10319
10320  <Match "foobar">
10321  </Match>
10322
10323 =item B<Target> I<Name>
10324
10325 Add a target to a rule or a default target to a chain. The name specifies what
10326 kind of target is to be added. Which targets are available depends on the
10327 plugins being loaded.
10328
10329 The arguments inside the B<Target> block are passed to the plugin implementing
10330 the target, so which arguments are valid here depends on the plugin being used.
10331 If you do not need any to pass any arguments to a target, you can use the
10332 shorter syntax:
10333
10334  Target "stop"
10335
10336 This is the same as writing:
10337
10338  <Target "stop">
10339  </Target>
10340
10341 =back
10342
10343 =head2 Built-in targets
10344
10345 The following targets are built into the core daemon and therefore need no
10346 plugins to be loaded:
10347
10348 =over 4
10349
10350 =item B<return>
10351
10352 Signals the "return" condition, see the L<"Flow control"> section above. This
10353 causes the current chain to stop processing the value and returns control to
10354 the calling chain. The calling chain will continue processing targets and rules
10355 just after the B<jump> target (see below). This is very similar to the
10356 B<RETURN> target of iptables, see L<iptables(8)>.
10357
10358 This target does not have any options.
10359
10360 Example:
10361
10362  Target "return"
10363
10364 =item B<stop>
10365
10366 Signals the "stop" condition, see the L<"Flow control"> section above. This
10367 causes processing of the value to be aborted immediately. This is similar to
10368 the B<DROP> target of iptables, see L<iptables(8)>.
10369
10370 This target does not have any options.
10371
10372 Example:
10373
10374  Target "stop"
10375
10376 =item B<write>
10377
10378 Sends the value to "write" plugins.
10379
10380 Available options:
10381
10382 =over 4
10383
10384 =item B<Plugin> I<Name>
10385
10386 Name of the write plugin to which the data should be sent. This option may be
10387 given multiple times to send the data to more than one write plugin. If the
10388 plugin supports multiple instances, the plugin's instance(s) must also be
10389 specified.
10390
10391 =back
10392
10393 If no plugin is explicitly specified, the values will be sent to all available
10394 write plugins.
10395
10396 Single-instance plugin example:
10397
10398  <Target "write">
10399    Plugin "rrdtool"
10400  </Target>
10401
10402 Multi-instance plugin example:
10403
10404  <Plugin "write_graphite">
10405    <Node "foo">
10406    ...
10407    </Node>
10408    <Node "bar">
10409    ...
10410    </Node>
10411  </Plugin>
10412   ...
10413  <Target "write">
10414    Plugin "write_graphite/foo"
10415  </Target>
10416
10417 =item B<jump>
10418
10419 Starts processing the rules of another chain, see L<"Flow control"> above. If
10420 the end of that chain is reached, or a stop condition is encountered,
10421 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10422 next target or the next rule. This is similar to the B<-j> command line option
10423 of iptables, see L<iptables(8)>.
10424
10425 Available options:
10426
10427 =over 4
10428
10429 =item B<Chain> I<Name>
10430
10431 Jumps to the chain I<Name>. This argument is required and may appear only once.
10432
10433 =back
10434
10435 Example:
10436
10437  <Target "jump">
10438    Chain "foobar"
10439  </Target>
10440
10441 =back
10442
10443 =head2 Available matches
10444
10445 =over 4
10446
10447 =item B<regex>
10448
10449 Matches a value using regular expressions.
10450
10451 Available options:
10452
10453 =over 4
10454
10455 =item B<Host> I<Regex>
10456
10457 =item B<Plugin> I<Regex>
10458
10459 =item B<PluginInstance> I<Regex>
10460
10461 =item B<Type> I<Regex>
10462
10463 =item B<TypeInstance> I<Regex>
10464
10465 =item B<MetaData> I<String> I<Regex>
10466
10467 Match values where the given regular expressions match the various fields of
10468 the identifier of a value. If multiple regular expressions are given, B<all>
10469 regexen must match for a value to match.
10470
10471 =item B<Invert> B<false>|B<true>
10472
10473 When set to B<true>, the result of the match is inverted, i.e. all value lists
10474 where all regular expressions apply are not matched, all other value lists are
10475 matched. Defaults to B<false>.
10476
10477 =back
10478
10479 Example:
10480
10481  <Match "regex">
10482    Host "customer[0-9]+"
10483    Plugin "^foobar$"
10484  </Match>
10485
10486 =item B<timediff>
10487
10488 Matches values that have a time which differs from the time on the server.
10489
10490 This match is mainly intended for servers that receive values over the
10491 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10492 is very sensitive to the timestamp used when updating the RRD files. In
10493 particular, the time must be ever increasing. If a misbehaving client sends one
10494 packet with a timestamp far in the future, all further packets with a correct
10495 time will be ignored because of that one packet. What's worse, such corrupted
10496 RRD files are hard to fix.
10497
10498 This match lets one match all values B<outside> a specified time range
10499 (relative to the server's time), so you can use the B<stop> target (see below)
10500 to ignore the value, for example.
10501
10502 Available options:
10503
10504 =over 4
10505
10506 =item B<Future> I<Seconds>
10507
10508 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10509 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10510 non-zero.
10511
10512 =item B<Past> I<Seconds>
10513
10514 Matches all values that are I<behind> of the server's time by I<Seconds> or
10515 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10516 non-zero.
10517
10518 =back
10519
10520 Example:
10521
10522  <Match "timediff">
10523    Future  300
10524    Past   3600
10525  </Match>
10526
10527 This example matches all values that are five minutes or more ahead of the
10528 server or one hour (or more) lagging behind.
10529
10530 =item B<value>
10531
10532 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10533 values. If a data-set consists of more than one data-source, all data-sources
10534 must match the specified ranges for a positive match.
10535
10536 Available options:
10537
10538 =over 4
10539
10540 =item B<Min> I<Value>
10541
10542 Sets the smallest value which still results in a match. If unset, behaves like
10543 negative infinity.
10544
10545 =item B<Max> I<Value>
10546
10547 Sets the largest value which still results in a match. If unset, behaves like
10548 positive infinity.
10549
10550 =item B<Invert> B<true>|B<false>
10551
10552 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10553 no-match is returned and vice versa. Please note that the B<Invert> setting
10554 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10555 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10556
10557 =item B<DataSource> I<DSName> [I<DSName> ...]
10558
10559 Select one or more of the data sources. If no data source is configured, all
10560 data sources will be checked. If the type handled by the match does not have a
10561 data source of the specified name(s), this will always result in no match
10562 (independent of the B<Invert> setting).
10563
10564 =item B<Satisfy> B<Any>|B<All>
10565
10566 Specifies how checking with several data sources is performed. If set to
10567 B<Any>, the match succeeds if one of the data sources is in the configured
10568 range. If set to B<All> the match only succeeds if all data sources are within
10569 the configured range. Default is B<All>.
10570
10571 Usually B<All> is used for positive matches, B<Any> is used for negative
10572 matches. This means that with B<All> you usually check that all values are in a
10573 "good" range, while with B<Any> you check if any value is within a "bad" range
10574 (or outside the "good" range).
10575
10576 =back
10577
10578 Either B<Min> or B<Max>, but not both, may be unset.
10579
10580 Example:
10581
10582  # Match all values smaller than or equal to 100. Matches only if all data
10583  # sources are below 100.
10584  <Match "value">
10585    Max 100
10586    Satisfy "All"
10587  </Match>
10588
10589  # Match if the value of any data source is outside the range of 0 - 100.
10590  <Match "value">
10591    Min   0
10592    Max 100
10593    Invert true
10594    Satisfy "Any"
10595  </Match>
10596
10597 =item B<empty_counter>
10598
10599 Matches all values with one or more data sources of type B<COUNTER> and where
10600 all counter values are zero. These counters usually I<never> increased since
10601 they started existing (and are therefore uninteresting), or got reset recently
10602 or overflowed and you had really, I<really> bad luck.
10603
10604 Please keep in mind that ignoring such counters can result in confusing
10605 behavior: Counters which hardly ever increase will be zero for long periods of
10606 time. If the counter is reset for some reason (machine or service restarted,
10607 usually), the graph will be empty (NAN) for a long time. People may not
10608 understand why.
10609
10610 =item B<hashed>
10611
10612 Calculates a hash value of the host name and matches values according to that
10613 hash value. This makes it possible to divide all hosts into groups and match
10614 only values that are in a specific group. The intended use is in load
10615 balancing, where you want to handle only part of all data and leave the rest
10616 for other servers.
10617
10618 The hashing function used tries to distribute the hosts evenly. First, it
10619 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10620
10621   hash_value = 0;
10622   for (i = 0; host[i] != 0; i++)
10623     hash_value = (hash_value * 251) + host[i];
10624
10625 The constant 251 is a prime number which is supposed to make this hash value
10626 more random. The code then checks the group for this host according to the
10627 I<Total> and I<Match> arguments:
10628
10629   if ((hash_value % Total) == Match)
10630     matches;
10631   else
10632     does not match;
10633
10634 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10635 groups), then the least significant bit of the hash value will be the XOR of
10636 all least significant bits in the host name. One consequence is that when you
10637 have two hosts, "server0.example.com" and "server1.example.com", where the host
10638 name differs in one digit only and the digits differ by one, those hosts will
10639 never end up in the same group.
10640
10641 Available options:
10642
10643 =over 4
10644
10645 =item B<Match> I<Match> I<Total>
10646
10647 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10648 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10649 be smaller than I<Total>. I<Total> must be at least one, although only values
10650 greater than one really do make any sense.
10651
10652 You can repeat this option to match multiple groups, for example:
10653
10654   Match 3 7
10655   Match 5 7
10656
10657 The above config will divide the data into seven groups and match groups three
10658 and five. One use would be to keep every value on two hosts so that if one
10659 fails the missing data can later be reconstructed from the second host.
10660
10661 =back
10662
10663 Example:
10664
10665  # Operate on the pre-cache chain, so that ignored values are not even in the
10666  # global cache.
10667  <Chain "PreCache">
10668    <Rule>
10669      <Match "hashed">
10670        # Divide all received hosts in seven groups and accept all hosts in
10671        # group three.
10672        Match 3 7
10673      </Match>
10674      # If matched: Return and continue.
10675      Target "return"
10676    </Rule>
10677    # If not matched: Return and stop.
10678    Target "stop"
10679  </Chain>
10680
10681 =back
10682
10683 =head2 Available targets
10684
10685 =over 4
10686
10687 =item B<notification>
10688
10689 Creates and dispatches a notification.
10690
10691 Available options:
10692
10693 =over 4
10694
10695 =item B<Message> I<String>
10696
10697 This required option sets the message of the notification. The following
10698 placeholders will be replaced by an appropriate value:
10699
10700 =over 4
10701
10702 =item B<%{host}>
10703
10704 =item B<%{plugin}>
10705
10706 =item B<%{plugin_instance}>
10707
10708 =item B<%{type}>
10709
10710 =item B<%{type_instance}>
10711
10712 These placeholders are replaced by the identifier field of the same name.
10713
10714 =item B<%{ds:>I<name>B<}>
10715
10716 These placeholders are replaced by a (hopefully) human readable representation
10717 of the current rate of this data source. If you changed the instance name
10718 (using the B<set> or B<replace> targets, see below), it may not be possible to
10719 convert counter values to rates.
10720
10721 =back
10722
10723 Please note that these placeholders are B<case sensitive>!
10724
10725 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10726
10727 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10728 used.
10729
10730 =back
10731
10732 Example:
10733
10734   <Target "notification">
10735     Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10736     Severity "WARNING"
10737   </Target>
10738
10739 =item B<replace>
10740
10741 Replaces parts of the identifier using regular expressions.
10742
10743 Available options:
10744
10745 =over 4
10746
10747 =item B<Host> I<Regex> I<Replacement>
10748
10749 =item B<Plugin> I<Regex> I<Replacement>
10750
10751 =item B<PluginInstance> I<Regex> I<Replacement>
10752
10753 =item B<TypeInstance> I<Regex> I<Replacement>
10754
10755 =item B<MetaData> I<String> I<Regex> I<Replacement>
10756
10757 =item B<DeleteMetaData> I<String> I<Regex>
10758
10759 Match the appropriate field with the given regular expression I<Regex>. If the
10760 regular expression matches, that part that matches is replaced with
10761 I<Replacement>. If multiple places of the input buffer match a given regular
10762 expression, only the first occurrence will be replaced.
10763
10764 You can specify each option multiple times to use multiple regular expressions
10765 one after another.
10766
10767 =back
10768
10769 Example:
10770
10771  <Target "replace">
10772    # Replace "example.net" with "example.com"
10773    Host "\\<example.net\\>" "example.com"
10774
10775    # Strip "www." from hostnames
10776    Host "\\<www\\." ""
10777  </Target>
10778
10779 =item B<set>
10780
10781 Sets part of the identifier of a value to a given string.
10782
10783 Available options:
10784
10785 =over 4
10786
10787 =item B<Host> I<String>
10788
10789 =item B<Plugin> I<String>
10790
10791 =item B<PluginInstance> I<String>
10792
10793 =item B<TypeInstance> I<String>
10794
10795 =item B<MetaData> I<String> I<String>
10796
10797 Set the appropriate field to the given string. The strings for plugin instance,
10798 type instance, and meta data may be empty, the strings for host and plugin may
10799 not be empty. It's currently not possible to set the type of a value this way.
10800
10801 The following placeholders will be replaced by an appropriate value:
10802
10803 =over 4
10804
10805 =item B<%{host}>
10806
10807 =item B<%{plugin}>
10808
10809 =item B<%{plugin_instance}>
10810
10811 =item B<%{type}>
10812
10813 =item B<%{type_instance}>
10814
10815 These placeholders are replaced by the identifier field of the same name.
10816
10817 =item B<%{meta:>I<name>B<}>
10818
10819 These placeholders are replaced by the meta data value with the given name.
10820
10821 =back
10822
10823 Please note that these placeholders are B<case sensitive>!
10824
10825 =item B<DeleteMetaData> I<String>
10826
10827 Delete the named meta data field.
10828
10829 =back
10830
10831 Example:
10832
10833  <Target "set">
10834    PluginInstance "coretemp"
10835    TypeInstance "core3"
10836  </Target>
10837
10838 =back
10839
10840 =head2 Backwards compatibility
10841
10842 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10843 B<Chain> block, it will behave as it used to. This is equivalent to the
10844 following configuration:
10845
10846  <Chain "PostCache">
10847    Target "write"
10848  </Chain>
10849
10850 If you specify a B<PostCacheChain>, the B<write> target will not be added
10851 anywhere and you will have to make sure that it is called where appropriate. We
10852 suggest to add the above snippet as default target to your "PostCache" chain.
10853
10854 =head2 Examples
10855
10856 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10857 be an FQDN.
10858
10859  <Chain "PreCache">
10860    <Rule "no_fqdn">
10861      <Match "regex">
10862        Host "^[^\.]*$"
10863      </Match>
10864      Target "stop"
10865    </Rule>
10866    Target "write"
10867  </Chain>
10868
10869 =head1 IGNORELISTS
10870
10871 B<Ignorelists> are a generic framework to either ignore some metrics or report
10872 specific metircs only. Plugins usually provide one or more options to specify
10873 the items (mounts points, devices, ...) and the boolean option
10874 C<IgnoreSelected>.
10875
10876 =over 4
10877
10878 =item B<Select> I<String>
10879
10880 Selects the item I<String>. This option often has a plugin specific name, e.g.
10881 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10882 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10883 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10884
10885 By default, this option is doing a case-sensitive full-string match. The
10886 following config will match C<foo>, but not C<Foo>:
10887
10888   Select "foo"
10889
10890 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10891 I<regular expression>. For example, so match all item starting with C<foo>, use
10892 could use the following syntax:
10893
10894   Select "/^foo/"
10895
10896 The regular expression is I<not> anchored, i.e. the following config will match
10897 C<foobar>, C<barfoo> and C<AfooZ>:
10898
10899   Select "/foo/"
10900
10901 The B<Select> option may be repeated to select multiple items.
10902
10903 =item B<IgnoreSelected> B<true>|B<false>
10904
10905 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10906 collected. If set to B<false>, matching metrics are I<collected> and all other
10907 metrics are ignored.
10908
10909 =back
10910
10911 =head1 SEE ALSO
10912
10913 L<collectd(1)>,
10914 L<collectd-exec(5)>,
10915 L<collectd-perl(5)>,
10916 L<collectd-unixsock(5)>,
10917 L<types.db(5)>,
10918 L<hddtemp(8)>,
10919 L<iptables(8)>,
10920 L<kstat(3KSTAT)>,
10921 L<mbmon(1)>,
10922 L<psql(1)>,
10923 L<regex(7)>,
10924 L<rrdtool(1)>,
10925 L<sensors(1)>
10926
10927 =head1 AUTHOR
10928
10929 Florian Forster E<lt>octo@collectd.orgE<gt>
10930
10931 =cut