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