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