1 =encoding UTF-8
3 =head1 NAME
5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
7 =head1 SYNOPSIS
9 BaseDir "/var/lib/collectd"
10 PIDFile "/run/collectd.pid"
11 Interval 10.0
13 LoadPlugin cpu
14 LoadPlugin load
16 <LoadPlugin df>
17 Interval 3600
18 </LoadPlugin>
19 <Plugin df>
20 ValuesPercentage true
21 </Plugin>
23 LoadPlugin ping
24 <Plugin ping>
25 Host "example.org"
26 Host "provider.net"
27 </Plugin>
29 =head1 DESCRIPTION
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.
38 The syntax of this config file is similar to the config file of the famous
39 I<Apache> webserver. Each line contains either an option (a key and a list of
40 one or more values) or a section-start or -end. Empty lines and everything
41 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
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.
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.
67 =head1 GLOBAL OPTIONS
69 =over 4
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
77 =item B<LoadPlugin> I<Plugin>
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.
83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
84 effect. This is useful when you want to split up the configuration into smaller
85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
86 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
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:
95 LoadPlugin "cpu"
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
100 <LoadPlugin perl>
101 Interval 60
102 </LoadPlugin>
104 The following options are valid inside B<LoadPlugin> blocks:
106 =over 4
108 =item B<Globals> B<true|false>
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.
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.
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.
127 =item B<Interval> I<Seconds>
129 Sets a plugin-specific interval for collecting metrics. This overrides the
130 global B<Interval> setting. If a plugin provides own support for specifying an
131 interval, that setting will take precedence.
133 =back
135 =item B<AutoLoadPlugin> B<false>|B<true>
137 When set to B<false> (the default), each plugin needs to be loaded explicitly,
138 using the B<LoadPlugin> statement documented above. If a
139 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
140 handling callback for this plugin has been registered, a warning is logged and
141 the block is ignored.
143 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
144 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
145 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
146 plugins that don't provide any configuration, e.g. the I<Load plugin>.
148 =item B<CollectInternalStats> B<false>|B<true>
150 When set to B<true>, various statistics about the I<collectd> daemon will be
151 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
153 The "write_queue" I<plugin instance> reports the number of elements currently
154 queued and the number of elements dropped off the queue by the
155 B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> mechanism.
157 The "cache" I<plugin instance> reports the number of elements in the value list
158 cache (the cache you can interact with using L<collectd-unixsock(5)>).
160 =item B<Include> I<Path> [I<pattern>]
162 If I<Path> points to a file, includes that file. If I<Path> points to a
163 directory, recursively includes all files within that directory and its
164 subdirectories. If the C<wordexp> function is available on your system,
165 shell-like wildcards are expanded before files are included. This means you can
166 use statements like the following:
168 Include "/etc/collectd.d/*.conf"
170 Starting with version 5.3, this may also be a block in which further options
171 affecting the behavior of B<Include> may be specified. The following option is
172 currently allowed:
174 <Include "/etc/collectd.d">
175 Filter "*.conf"
176 </Include>
178 =over 4
180 =item B<Filter> I<pattern>
182 If the C<fnmatch> function is available on your system, a shell-like wildcard
183 I<pattern> may be specified to filter which files to include. This may be used
184 in combination with recursively including a directory to easily be able to
185 arbitrarily mix configuration files and other documents (e.g. README files).
186 The given example is similar to the first example above but includes all files
187 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
189 Include "/etc/collectd.d" "*.conf"
191 =back
193 If more than one files are included by a single B<Include> option, the files
194 will be included in lexicographical order (as defined by the C<strcmp>
195 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
196 order in which the files are loaded.
198 To prevent loops and shooting yourself in the foot in interesting ways the
199 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
200 most uses. Since symlinks are followed it is still possible to crash the daemon
201 by looping symlinks. In our opinion significant stupidity should result in an
202 appropriate amount of pain.
204 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
205 file, but you cannot include files from within blocks.
207 =item B<PIDFile> I<File>
209 Sets where to write the PID file to. This file is overwritten when it exists
210 and deleted when the program is stopped. Some init-scripts might override this
211 setting using the B<-P> command-line option.
213 =item B<PluginDir> I<Directory>
215 Path to the plugins (shared objects) of collectd.
217 =item B<TypesDB> I<File> [I<File> ...]
219 Set one or more files that contain the data-set descriptions. See
220 L<types.db(5)> for a description of the format of this file.
222 =item B<Interval> I<Seconds>
224 Configures the interval in which to query the read plugins. Obviously smaller
225 values lead to a higher system load produced by collectd, while higher values
226 lead to more coarse statistics.
228 B<Warning:> You should set this once and then never touch it again. If you do,
229 I<you will have to delete all your RRD files> or know some serious RRDtool
230 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
232 =item B<MaxReadInterval> I<Seconds>
234 Read plugin doubles interval between queries after each failed attempt
235 to get data.
237 This options limits the maximum value of the interval. The default value is
238 B<86400>.
240 =item B<Timeout> I<Iterations>
242 Consider a value list "missing" when no update has been read or received for
243 I<Iterations> iterations. By default, I<collectd> considers a value list
244 missing when no update has been received for twice the update interval. Since
245 this setting uses iterations, the maximum allowed time without update depends
246 on the I<Interval> information contained in each value list. This is used in
247 the I<Threshold> configuration to dispatch notifications about missing values,
248 see L<collectd-threshold(5)> for details.
250 =item B<ReadThreads> I<Num>
252 Number of threads to start for reading plugins. The default value is B<5>, but
253 you may want to increase this if you have more than five plugins that take a
254 long time to read. Mostly those are plugins that do network-IO. Setting this to
255 a value higher than the number of registered read callbacks is not recommended.
257 =item B<WriteThreads> I<Num>
259 Number of threads to start for dispatching value lists to write plugins. The
260 default value is B<5>, but you may want to increase this if you have more than
261 five plugins that may take relatively long to write to.
263 =item B<WriteQueueLimitHigh> I<HighNum>
265 =item B<WriteQueueLimitLow> I<LowNum>
267 Metrics are read by the I<read threads> and then put into a queue to be handled
268 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
269 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
270 running into memory issues in such a case, you can limit the size of this
271 queue.
273 By default, there is no limit and memory may grow indefinitely. This is most
274 likely not an issue for clients, i.e. instances that only handle the local
275 metrics. For servers it is recommended to set this to a non-zero value, though.
277 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
278 Each of them takes a numerical argument which is the number of metrics in the
279 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
280 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
281 I<will> be enqueued. If the number of metrics currently in the queue is between
282 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
283 proportional to the number of metrics in the queue (i.e. it increases linearly
284 until it reaches 100%.)
286 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
287 unset, the latter will default to half of B<WriteQueueLimitHigh>.
289 If you do not want to randomly drop values when the queue size is between
290 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
291 to the same value.
293 Enabling the B<CollectInternalStats> option is of great help to figure out the
294 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
296 =item B<Hostname> I<Name>
298 Sets the hostname that identifies a host. If you omit this setting, the
299 hostname will be determined using the L<gethostname(2)> system call.
301 =item B<FQDNLookup> B<true|false>
303 If B<Hostname> is determined automatically this setting controls whether or not
304 the daemon should try to figure out the "fully qualified domain name", FQDN.
305 This is done using a lookup of the name returned by C<gethostname>. This option
306 is enabled by default.
308 =item B<PreCacheChain> I<ChainName>
310 =item B<PostCacheChain> I<ChainName>
312 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
313 see L<FILTER CONFIGURATION> below on information on chains and how these
314 setting change the daemon's behavior.
316 =back
318 =head1 PLUGIN OPTIONS
320 Some plugins may register own options. These options must be enclosed in a
321 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
322 require external configuration, too. The C<apache plugin>, for example,
323 required C<mod_status> to be configured in the webserver you're going to
324 collect data from. These plugins are listed below as well, even if they don't
325 require any configuration within collectd's configuration file.
327 A list of all plugins and a short summary for each plugin can be found in the
328 F<README> file shipped with the sourcecode and hopefully binary packets as
329 well.
331 =head2 Plugin C<aggregation>
333 The I<Aggregation plugin> makes it possible to aggregate several values into
334 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
335 This can be put to a wide variety of uses, e.g. average and total CPU
336 statistics for your entire fleet.
338 The grouping is powerful but, as with many powerful tools, may be a bit
339 difficult to wrap your head around. The grouping will therefore be
340 demonstrated using an example: The average and sum of the CPU usage across
341 all CPUs of each host is to be calculated.
343 To select all the affected values for our example, set C<Plugin cpu> and
344 C<Type cpu>. The other values are left unspecified, meaning "all values". The
345 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
346 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
347 statement.
349 Plugin "cpu"
350 Type "cpu"
352 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
353 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
354 example, the intention is to have a new value for each host / type instance
355 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
356 It can be specified multiple times to group by more than one field.
358 GroupBy "Host"
359 GroupBy "TypeInstance"
361 We do neither specify nor group by I<plugin instance> (the CPU number), so all
362 metrics that differ in the CPU number only will be aggregated. Each
363 aggregation needs I<at least one> such field, otherwise no aggregation would
364 take place.
366 The full example configuration looks like this:
368 <Plugin "aggregation">
369 <Aggregation>
370 Plugin "cpu"
371 Type "cpu"
373 GroupBy "Host"
374 GroupBy "TypeInstance"
376 CalculateSum true
377 CalculateAverage true
378 </Aggregation>
379 </Plugin>
381 There are a couple of limitations you should be aware of:
383 =over 4
385 =item
387 The I<Type> cannot be left unspecified, because it is not reasonable to add
388 apples to oranges. Also, the internal lookup structure won't work if you try
389 to group by type.
391 =item
393 There must be at least one unspecified, ungrouped field. Otherwise nothing
394 will be aggregated.
396 =back
398 As you can see in the example above, each aggregation has its own
399 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
400 blocks may match the same values, i.e. one value list can update multiple
401 aggregations. The following options are valid inside B<Aggregation> blocks:
403 =over 4
405 =item B<Host> I<Host>
407 =item B<Plugin> I<Plugin>
409 =item B<PluginInstance> I<PluginInstance>
411 =item B<Type> I<Type>
413 =item B<TypeInstance> I<TypeInstance>
415 Selects the value lists to be added to this aggregation. B<Type> must be a
416 valid data set name, see L<types.db(5)> for details.
418 If the string starts with and ends with a slash (C</>), the string is
419 interpreted as a I<regular expression>. The regex flavor used are POSIX
420 extended regular expressions as described in L<regex(7)>. Example usage:
422 Host "/^db[0-9]\\.example\\.com$/"
424 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
426 Group valued by the specified field. The B<GroupBy> option may be repeated to
427 group by multiple fields.
429 =item B<SetHost> I<Host>
431 =item B<SetPlugin> I<Plugin>
433 =item B<SetPluginInstance> I<PluginInstance>
435 =item B<SetTypeInstance> I<TypeInstance>
437 Sets the appropriate part of the identifier to the provided string.
439 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
440 will be replaced with the aggregation function, e.g. "average". Not including
441 the placeholder will result in duplication warnings and/or messed up values if
442 more than one aggregation function are enabled.
444 The following example calculates the average usage of all "even" CPUs:
446 <Plugin "aggregation">
447 <Aggregation>
448 Plugin "cpu"
449 PluginInstance "/[0,2,4,6,8]$/"
450 Type "cpu"
452 SetPlugin "cpu"
453 SetPluginInstance "even-%{aggregation}"
455 GroupBy "Host"
456 GroupBy "TypeInstance"
458 CalculateAverage true
459 </Aggregation>
460 </Plugin>
462 This will create the files:
464 =over 4
466 =item
468 foo.example.com/cpu-even-average/cpu-idle
470 =item
472 foo.example.com/cpu-even-average/cpu-system
474 =item
476 foo.example.com/cpu-even-average/cpu-user
478 =item
480 ...
482 =back
484 =item B<CalculateNum> B<true>|B<false>
486 =item B<CalculateSum> B<true>|B<false>
488 =item B<CalculateAverage> B<true>|B<false>
490 =item B<CalculateMinimum> B<true>|B<false>
492 =item B<CalculateMaximum> B<true>|B<false>
494 =item B<CalculateStddev> B<true>|B<false>
496 Boolean options for enabling calculation of the number of value lists, their
497 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
498 are disabled by default.
500 =back
502 =head2 Plugin C<amqp>
504 The I<AMQP plugin> can be used to communicate with other instances of
505 I<collectd> or third party applications using an AMQP message broker. Values
506 are sent to or received from the broker, which handles routing, queueing and
507 possibly filtering or messages.
509 <Plugin "amqp">
510 # Send values to an AMQP broker
511 <Publish "some_name">
512 Host "localhost"
513 Port "5672"
514 VHost "/"
515 User "guest"
516 Password "guest"
517 Exchange "amq.fanout"
518 # ExchangeType "fanout"
519 # RoutingKey "collectd"
520 # Persistent false
521 # ConnectionRetryDelay 0
522 # Format "command"
523 # StoreRates false
524 # GraphitePrefix "collectd."
525 # GraphiteEscapeChar "_"
526 # GraphiteSeparateInstances false
527 # GraphiteAlwaysAppendDS false
528 </Publish>
530 # Receive values from an AMQP broker
531 <Subscribe "some_name">
532 Host "localhost"
533 Port "5672"
534 VHost "/"
535 User "guest"
536 Password "guest"
537 Exchange "amq.fanout"
538 # ExchangeType "fanout"
539 # Queue "queue_name"
540 # QueueDurable false
541 # QueueAutoDelete true
542 # RoutingKey "collectd.#"
543 # ConnectionRetryDelay 0
544 </Subscribe>
545 </Plugin>
547 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
548 blocks, which configure sending and receiving of values respectively. The two
549 blocks are very similar, so unless otherwise noted, an option can be used in
550 either block. The name given in the blocks starting tag is only used for
551 reporting messages, but may be used to support I<flushing> of certain
552 I<Publish> blocks in the future.
554 =over 4
556 =item B<Host> I<Host>
558 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
559 the underlying communications library, I<rabbitmq-c>, which is "localhost".
561 =item B<Port> I<Port>
563 Service name or port number on which the AMQP broker accepts connections. This
564 argument must be a string, even if the numeric form is used. Defaults to
565 "5672".
567 =item B<VHost> I<VHost>
569 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
571 =item B<User> I<User>
573 =item B<Password> I<Password>
575 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
576 is used.
578 =item B<Exchange> I<Exchange>
580 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
581 By default, "amq.fanout" will be used.
583 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
584 the given exchange and the I<queue> is created, using the I<routing key> if
585 configured. See the B<Queue> and B<RoutingKey> options below.
587 =item B<ExchangeType> I<Type>
589 If given, the plugin will try to create the configured I<exchange> with this
590 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
591 be bound to this exchange.
593 =item B<Queue> I<Queue> (Subscribe only)
595 Configures the I<queue> name to subscribe to. If no queue name was configured
596 explicitly, a unique queue name will be created by the broker.
598 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
600 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
601 or transient (will disappear if the AMQP broker is restarted). Defaults to
602 "false".
604 This option should be used in conjunction with the I<Persistent> option on the
605 publish side.
607 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
609 Defines if the I<queue> subscribed to will be deleted once the last consumer
610 unsubscribes. Defaults to "true".
612 =item B<RoutingKey> I<Key>
614 In I<Publish> blocks, this configures the routing key to set on all outgoing
615 messages. If not given, the routing key will be computed from the I<identifier>
616 of the value. The host, plugin, type and the two instances are concatenated
617 together using dots as the separator and all containing dots replaced with
618 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
619 possible to receive only specific values using a "topic" exchange.
621 In I<Subscribe> blocks, configures the I<routing key> used when creating a
622 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
623 used to filter messages when using a "topic" exchange. If you're only
624 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
625 for example.
627 =item B<Persistent> B<true>|B<false> (Publish only)
629 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
630 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
631 default), the I<transient> delivery mode will be used, i.e. messages may be
632 lost due to high load, overflowing queues or similar issues.
634 =item B<ConnectionRetryDelay> I<Delay>
636 When the connection to the AMQP broker is lost, defines the time in seconds to
637 wait before attempting to reconnect. Defaults to 0, which implies collectd will
638 attempt to reconnect at each read interval (in Subscribe mode) or each time
639 values are ready for submission (in Publish mode).
641 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
643 Selects the format in which messages are sent to the broker. If set to
644 B<Command> (the default), values are sent as C<PUTVAL> commands which are
645 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
646 case, the C<Content-Type> header field will be set to C<text/collectd>.
648 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
649 an easy and straight forward exchange format. The C<Content-Type> header field
650 will be set to C<application/json>.
652 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
653 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
654 C<text/graphite>.
656 A subscribing client I<should> use the C<Content-Type> header field to
657 determine how to decode the values. Currently, the I<AMQP plugin> itself can
658 only decode the B<Command> format.
660 =item B<StoreRates> B<true>|B<false> (Publish only)
662 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
663 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
664 default), no conversion is performed. Otherwise the conversion is performed
665 using the internal value cache.
667 Please note that currently this option is only used if the B<Format> option has
668 been set to B<JSON>.
670 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
672 A prefix can be added in the metric name when outputting in the I<Graphite> format.
673 It's added before the I<Host> name.
674 Metric name will be "<prefix><host><postfix><plugin><type><name>"
676 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
678 A postfix can be added in the metric name when outputting in the I<Graphite> format.
679 It's added after the I<Host> name.
680 Metric name will be "<prefix><host><postfix><plugin><type><name>"
682 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
684 Specify a character to replace dots (.) in the host part of the metric name.
685 In I<Graphite> metric name, dots are used as separators between different
686 metric parts (host, plugin, type).
687 Default is "_" (I<Underscore>).
689 =item B<GraphiteSeparateInstances> B<true>|B<false>
691 If set to B<true>, the plugin instance and type instance will be in their own
692 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
693 default), the plugin and plugin instance (and likewise the type and type
694 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
696 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
698 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
699 identifier. If set to B<false> (the default), this is only done when there is
700 more than one DS.
702 =back
704 =head2 Plugin C<apache>
706 To configure the C<apache>-plugin you first need to configure the Apache
707 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
708 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
709 the following snipped to base your Apache config upon:
711 ExtendedStatus on
712 <IfModule mod_status.c>
713 <Location /mod_status>
714 SetHandler server-status
715 </Location>
716 </IfModule>
718 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
719 also supported. It introduces a new field, called C<BusyServers>, to count the
720 number of currently connected clients. This field is also supported.
722 The configuration of the I<Apache> plugin consists of one or more
723 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
724 as the instance name. For example:
726 <Plugin "apache">
727 <Instance "www1">
728 URL "http://www1.example.com/mod_status?auto"
729 </Instance>
730 <Instance "www2">
731 URL "http://www2.example.com/mod_status?auto"
732 </Instance>
733 </Plugin>
735 The instance name will be used as the I<plugin instance>. To emulate the old
736 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
737 plugin to work correctly, each instance name must be unique. This is not
738 enforced by the plugin and it is your responsibility to ensure it.
740 The following options are accepted within each I<Instance> block:
742 =over 4
744 =item B<URL> I<http://host/mod_status?auto>
746 Sets the URL of the C<mod_status> output. This needs to be the output generated
747 by C<ExtendedStatus on> and it needs to be the machine readable output
748 generated by appending the C<?auto> argument. This option is I<mandatory>.
750 =item B<User> I<Username>
752 Optional user name needed for authentication.
754 =item B<Password> I<Password>
756 Optional password needed for authentication.
758 =item B<VerifyPeer> B<true|false>
760 Enable or disable peer SSL certificate verification. See
761 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
763 =item B<VerifyHost> B<true|false>
765 Enable or disable peer host name verification. If enabled, the plugin checks
766 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
767 certificate matches the host name provided by the B<URL> option. If this
768 identity check fails, the connection is aborted. Obviously, only works when
769 connecting to a SSL enabled server. Enabled by default.
771 =item B<CACert> I<File>
773 File that holds one or more SSL certificates. If you want to use HTTPS you will
774 possibly need this option. What CA certificates come bundled with C<libcurl>
775 and are checked by default depends on the distribution you use.
777 =item B<SSLCiphers> I<list of ciphers>
779 Specifies which ciphers to use in the connection. The list of ciphers
780 must specify valid ciphers. See
781 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
783 =item B<Timeout> I<Milliseconds>
785 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
786 milliseconds. By default, the configured B<Interval> is used to set the
787 timeout.
789 =back
791 =head2 Plugin C<apcups>
793 =over 4
795 =item B<Host> I<Hostname>
797 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
798 that IPv6 support has been disabled unless someone can confirm or decline that
799 B<apcupsd> can handle it.
801 =item B<Port> I<Port>
803 TCP-Port to connect to. Defaults to B<3551>.
805 =item B<ReportSeconds> B<true|false>
807 If set to B<true>, the time reported in the C<timeleft> metric will be
808 converted to seconds. This is the recommended setting. If set to B<false>, the
809 default for backwards compatibility, the time will be reported in minutes.
811 =back
813 =head2 Plugin C<aquaero>
815 This plugin collects the value of the available sensors in an
816 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
817 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
818 connection for monitoring and configuration. The board can handle multiple
819 temperature sensors, fans, water pumps and water level sensors and adjust the
820 output settings such as fan voltage or power used by the water pump based on
821 the available inputs using a configurable controller included in the board.
822 This plugin collects all the available inputs as well as some of the output
823 values chosen by this controller. The plugin is based on the I<libaquaero5>
824 library provided by I<aquatools-ng>.
826 =over 4
828 =item B<Device> I<DevicePath>
830 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
831 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
832 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
834 =back
836 =head2 Plugin C<ascent>
838 This plugin collects information about an Ascent server, a free server for the
839 "World of Warcraft" game. This plugin gathers the information by fetching the
840 XML status page using C<libcurl> and parses it using C<libxml2>.
842 The configuration options are the same as for the C<apache> plugin above:
844 =over 4
846 =item B<URL> I<http://localhost/ascent/status/>
848 Sets the URL of the XML status output.
850 =item B<User> I<Username>
852 Optional user name needed for authentication.
854 =item B<Password> I<Password>
856 Optional password needed for authentication.
858 =item B<VerifyPeer> B<true|false>
860 Enable or disable peer SSL certificate verification. See
861 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
863 =item B<VerifyHost> B<true|false>
865 Enable or disable peer host name verification. If enabled, the plugin checks
866 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
867 certificate matches the host name provided by the B<URL> option. If this
868 identity check fails, the connection is aborted. Obviously, only works when
869 connecting to a SSL enabled server. Enabled by default.
871 =item B<CACert> I<File>
873 File that holds one or more SSL certificates. If you want to use HTTPS you will
874 possibly need this option. What CA certificates come bundled with C<libcurl>
875 and are checked by default depends on the distribution you use.
877 =item B<Timeout> I<Milliseconds>
879 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
880 milliseconds. By default, the configured B<Interval> is used to set the
881 timeout.
883 =back
885 =head2 Plugin C<barometer>
887 This plugin reads absolute air pressure using digital barometer sensor on a I2C
888 bus. Supported sensors are:
890 =over 5
892 =item I<MPL115A2> from Freescale,
893 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
896 =item I<MPL3115> from Freescale
897 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
900 =item I<BMP085> from Bosch Sensortec
902 =back
904 The sensor type - one of the above - is detected automatically by the plugin
905 and indicated in the plugin_instance (you will see subdirectory
906 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
907 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
908 (only one sensor can be used by the plugin).
910 The plugin provides absolute barometric pressure, air pressure reduced to sea
911 level (several possible approximations) and as an auxiliary value also internal
912 sensor temperature. It uses (expects/provides) typical metric units - pressure
913 in [hPa], temperature in [C], altitude in [m].
915 It was developed and tested under Linux only. The only platform dependency is
916 the standard Linux i2c-dev interface (the particular bus driver has to
917 support the SM Bus command subset).
919 The reduction or normalization to mean sea level pressure requires (depending
920 on selected method/approximation) also altitude and reference to temperature
921 sensor(s). When multiple temperature sensors are configured the minumum of
922 their values is always used (expecting that the warmer ones are affected by
923 e.g. direct sun light at that moment).
925 Synopsis:
927 <Plugin "barometer">
928 Device "/dev/i2c-0";
929 Oversampling 512
930 PressureOffset 0.0
931 TemperatureOffset 0.0
932 Normalization 2
933 Altitude 238.0
934 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
935 </Plugin>
937 =over 4
939 =item B<Device> I<device>
941 The only mandatory configuration parameter.
943 Device name of the I2C bus to which the sensor is connected. Note that
944 typically you need to have loaded the i2c-dev module.
945 Using i2c-tools you can check/list i2c buses available on your system by:
947 i2cdetect -l
949 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
951 i2cdetect -y -a 0
953 This way you should be able to verify that the pressure sensor (either type) is
954 connected and detected on address 0x60.
956 =item B<Oversampling> I<value>
958 Optional parameter controlling the oversampling/accuracy. Default value
959 is 1 providing fastest and least accurate reading.
961 For I<MPL115> this is the size of the averaging window. To filter out sensor
962 noise a simple averaging using floating window of this configurable size is
963 used. The plugin will use average of the last C<value> measurements (value of 1
964 means no averaging). Minimal size is 1, maximal 1024.
966 For I<MPL3115> this is the oversampling value. The actual oversampling is
967 performed by the sensor and the higher value the higher accuracy and longer
968 conversion time (although nothing to worry about in the collectd context).
969 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
970 adjusted by the plugin to the closest supported one.
972 For I<BMP085> this is the oversampling value. The actual oversampling is
973 performed by the sensor and the higher value the higher accuracy and longer
974 conversion time (although nothing to worry about in the collectd context).
975 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
976 the closest supported one.
978 =item B<PressureOffset> I<offset>
980 Optional parameter for MPL3115 only.
982 You can further calibrate the sensor by supplying pressure and/or temperature
983 offsets. This is added to the measured/caclulated value (i.e. if the measured
984 value is too high then use negative offset).
985 In hPa, default is 0.0.
987 =item B<TemperatureOffset> I<offset>
989 Optional parameter for MPL3115 only.
991 You can further calibrate the sensor by supplying pressure and/or temperature
992 offsets. This is added to the measured/caclulated value (i.e. if the measured
993 value is too high then use negative offset).
994 In C, default is 0.0.
996 =item B<Normalization> I<method>
998 Optional parameter, default value is 0.
1000 Normalization method - what approximation/model is used to compute the mean sea
1001 level pressure from the air absolute pressure.
1003 Supported values of the C<method> (integer between from 0 to 2) are:
1005 =over 5
1007 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1008 do not need to configure C<Altitude> or C<TemperatureSensor>.
1010 =item B<1> - international formula for conversion ,
1011 See
1012 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1013 For this method you have to configure C<Altitude> but do not need
1014 C<TemperatureSensor> (uses fixed global temperature average instead).
1016 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1017 Meteorological Service).
1018 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1019 For this method you have to configure both C<Altitude> and
1020 C<TemperatureSensor>.
1022 =back
1025 =item B<Altitude> I<altitude>
1027 The altitude (in meters) of the location where you meassure the pressure.
1029 =item B<TemperatureSensor> I<reference>
1031 Temperature sensor(s) which should be used as a reference when normalizing the
1032 pressure using C<Normalization> method 2.
1033 When specified more sensors a minumum is found and used each time. The
1034 temperature reading directly from this pressure sensor/plugin is typically not
1035 suitable as the pressure sensor will be probably inside while we want outside
1036 temperature. The collectd reference name is something like
1037 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1038 (<type_instance> is usually omitted when there is just single value type). Or
1039 you can figure it out from the path of the output data files.
1041 =back
1043 =head2 Plugin C<battery>
1045 The I<battery plugin> reports the remaining capacity, power and voltage of
1046 laptop batteries.
1048 =over 4
1050 =item B<ValuesPercentage> B<false>|B<true>
1052 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1053 capacity remaining". Otherwise the capacity is stored as reported by the
1054 battery, most likely in "Wh". This option does not work with all input methods,
1055 in particular when only C</proc/pmu> is available on an old Linux system.
1056 Defaults to B<false>.
1058 =item B<ReportDegraded> B<false>|B<true>
1060 Typical laptop batteries degrade over time, meaning the capacity decreases with
1061 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1062 "last full capacity" and used to determine that a battery is "fully charged".
1064 When this option is set to B<false>, the default, the I<battery plugin> will
1065 only report the remaining capacity. If the B<ValuesPercentage> option is
1066 enabled, the relative remaining capacity is calculated as the ratio of the
1067 "remaining capacity" and the "last full capacity". This is what most tools,
1068 such as the status bar of desktop environments, also do.
1070 When set to B<true>, the battery plugin will report three values: B<charged>
1071 (remaining capacity), B<discharged> (difference between "last full capacity"
1072 and "remaining capacity") and B<degraded> (difference between "design capacity"
1073 and "last full capacity").
1075 =back
1077 =head2 Plugin C<bind>
1079 Starting with BIND 9.5.0, the most widely used DNS server software provides
1080 extensive statistics about queries, responses and lots of other information.
1081 The bind plugin retrieves this information that's encoded in XML and provided
1082 via HTTP and submits the values to collectd.
1084 To use this plugin, you first need to tell BIND to make this information
1085 available. This is done with the C<statistics-channels> configuration option:
1087 statistics-channels {
1088 inet localhost port 8053;
1089 };
1091 The configuration follows the grouping that can be seen when looking at the
1092 data with an XSLT compatible viewer, such as a modern web browser. It's
1093 probably a good idea to make yourself familiar with the provided values, so you
1094 can understand what the collected statistics actually mean.
1096 Synopsis:
1098 <Plugin "bind">
1099 URL "http://localhost:8053/"
1100 ParseTime false
1101 OpCodes true
1102 QTypes true
1104 ServerStats true
1105 ZoneMaintStats true
1106 ResolverStats false
1107 MemoryStats true
1109 <View "_default">
1110 QTypes true
1111 ResolverStats true
1112 CacheRRSets true
1114 Zone "127.in-addr.arpa/IN"
1115 </View>
1116 </Plugin>
1118 The bind plugin accepts the following configuration options:
1120 =over 4
1122 =item B<URL> I<URL>
1124 URL from which to retrieve the XML data. If not specified,
1125 C<http://localhost:8053/> will be used.
1127 =item B<ParseTime> B<true>|B<false>
1129 When set to B<true>, the time provided by BIND will be parsed and used to
1130 dispatch the values. When set to B<false>, the local time source is queried.
1132 This setting is set to B<true> by default for backwards compatibility; setting
1133 this to B<false> is I<recommended> to avoid problems with timezones and
1134 localization.
1136 =item B<OpCodes> B<true>|B<false>
1138 When enabled, statistics about the I<"OpCodes">, for example the number of
1139 C<QUERY> packets, are collected.
1141 Default: Enabled.
1143 =item B<QTypes> B<true>|B<false>
1145 When enabled, the number of I<incoming> queries by query types (for example
1146 C<A>, C<MX>, C<AAAA>) is collected.
1148 Default: Enabled.
1150 =item B<ServerStats> B<true>|B<false>
1152 Collect global server statistics, such as requests received over IPv4 and IPv6,
1153 successful queries, and failed updates.
1155 Default: Enabled.
1157 =item B<ZoneMaintStats> B<true>|B<false>
1159 Collect zone maintenance statistics, mostly information about notifications
1160 (zone updates) and zone transfers.
1162 Default: Enabled.
1164 =item B<ResolverStats> B<true>|B<false>
1166 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1167 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1168 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1169 default. Use the B<ResolverStats> option within a B<View "_default"> block
1170 instead for the same functionality.
1172 Default: Disabled.
1174 =item B<MemoryStats>
1176 Collect global memory statistics.
1178 Default: Enabled.
1180 =item B<Timeout> I<Milliseconds>
1182 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1183 milliseconds. By default, the configured B<Interval> is used to set the
1184 timeout.
1186 =item B<View> I<Name>
1188 Collect statistics about a specific I<"view">. BIND can behave different,
1189 mostly depending on the source IP-address of the request. These different
1190 configurations are called "views". If you don't use this feature, you most
1191 likely are only interested in the C<_default> view.
1193 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1194 information you want to collect about a view. If no B<View> block is
1195 configured, no detailed view statistics will be collected.
1197 =over 4
1199 =item B<QTypes> B<true>|B<false>
1201 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1202 C<MX>) is collected.
1204 Default: Enabled.
1206 =item B<ResolverStats> B<true>|B<false>
1208 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1209 (e.E<nbsp>g. queries over IPv4, lame servers).
1211 Default: Enabled.
1213 =item B<CacheRRSets> B<true>|B<false>
1215 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1216 type is collected. Negative entries (queries which resulted in an error, for
1217 example names that do not exist) are reported with a leading exclamation mark,
1218 e.E<nbsp>g. "!A".
1220 Default: Enabled.
1222 =item B<Zone> I<Name>
1224 When given, collect detailed information about the given zone in the view. The
1225 information collected if very similar to the global B<ServerStats> information
1226 (see above).
1228 You can repeat this option to collect detailed information about multiple
1229 zones.
1231 By default no detailed zone information is collected.
1233 =back
1235 =back
1237 =head2 Plugin C<ceph>
1239 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1240 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1242 A separate B<Daemon> block must be configured for each ceph daemon to be
1243 monitored. The following example will read daemon statistics from four
1244 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1246 <Plugin ceph>
1247 LongRunAvgLatency false
1248 ConvertSpecialMetricTypes true
1249 <Daemon "osd.0">
1250 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1251 </Daemon>
1252 <Daemon "osd.1">
1253 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1254 </Daemon>
1255 <Daemon "mon.a">
1256 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1257 </Daemon>
1258 <Daemon "mds.a">
1259 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1260 </Daemon>
1261 </Plugin>
1263 The ceph plugin accepts the following configuration options:
1265 =over 4
1267 =item B<LongRunAvgLatency> B<true>|B<false>
1269 If enabled, latency values(sum,count pairs) are calculated as the long run
1270 average - average since the ceph daemon was started = (sum / count).
1271 When disabled, latency values are calculated as the average since the last
1272 collection = (sum_now - sum_last) / (count_now - count_last).
1274 Default: Disabled
1276 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1278 If enabled, special metrics (metrics that differ in type from similar counters)
1279 are converted to the type of those similar counters. This currently only
1280 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1281 ceph schema reports this metric type as a sum,count pair while similar counters
1282 are treated as derive types. When converted, the sum is used as the counter
1283 value and is treated as a derive type.
1284 When disabled, all metrics are treated as the types received from the ceph schema.
1286 Default: Enabled
1288 =back
1290 Each B<Daemon> block must have a string argument for the plugin instance name.
1291 A B<SocketPath> is also required for each B<Daemon> block:
1293 =over 4
1295 =item B<Daemon> I<DaemonName>
1297 Name to be used as the instance name for this daemon.
1299 =item B<SocketPath> I<SocketPath>
1301 Specifies the path to the UNIX admin socket of the ceph daemon.
1303 =back
1305 =head2 Plugin C<cgroups>
1307 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1308 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1309 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1311 =over 4
1313 =item B<CGroup> I<Directory>
1315 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1316 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1317 see below.
1319 =item B<IgnoreSelected> B<true>|B<false>
1321 Invert the selection: If set to true, all cgroups I<except> the ones that
1322 match any one of the criteria are collected. By default only selected
1323 cgroups are collected if a selection is made. If no selection is configured
1324 at all, B<all> cgroups are selected.
1326 =back
1328 =head2 Plugin C<conntrack>
1330 This plugin collects IP conntrack statistics.
1332 =over 4
1334 =item B<OldFiles>
1336 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1337 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1339 =back
1341 =head2 Plugin C<cpu>
1343 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1344 as Jiffies, using the C<cpu> type. Two aggregations are available:
1346 =over 4
1348 =item
1350 Sum, per-state, over all CPUs installed in the system; and
1352 =item
1354 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1356 =back
1358 The two aggregations can be combined, leading to I<collectd> only emitting a
1359 single "active" metric for the entire system. As soon as one of these
1360 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1361 rather than Jiffies. In addition, you can request individual, per-state,
1362 per-CPU metrics to be reported as percentage.
1364 The following configuration options are available:
1366 =over 4
1368 =item B<ReportByState> B<true>|B<false>
1370 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1371 "user" and "idle".
1372 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1373 "active" metric.
1375 =item B<ReportByCpu> B<true>|B<false>
1377 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1378 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1379 global sum of CPU states is emitted.
1381 =item B<ValuesPercentage> B<false>|B<true>
1383 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1384 are set to B<true>. In this case, by default, metrics will be reported as
1385 Jiffies. By setting this option to B<true>, you can request percentage values
1386 in the un-aggregated (per-CPU, per-state) mode as well.
1388 =back
1390 =head2 Plugin C<cpufreq>
1392 This plugin doesn't have any options. It reads
1393 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1394 installed) to get the current CPU frequency. If this file does not exist make
1395 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1396 installed and an "cpu governor" (that's a kernel module) is loaded.
1398 =head2 Plugin C<csv>
1400 =over 4
1402 =item B<DataDir> I<Directory>
1404 Set the directory to store CSV-files under. Per default CSV-files are generated
1405 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1406 The special strings B<stdout> and B<stderr> can be used to write to the standard
1407 output and standard error channels, respectively. This, of course, only makes
1408 much sense when collectd is running in foreground- or non-daemon-mode.
1410 =item B<StoreRates> B<true|false>
1412 If set to B<true>, convert counter values to rates. If set to B<false> (the
1413 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1414 number.
1416 =back
1418 =head2 Plugin C<curl>
1420 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1421 and the match infrastructure (the same code used by the tail plugin) to use
1422 regular expressions with the received data.
1424 The following example will read the current value of AMD stock from Google's
1425 finance page and dispatch the value to collectd.
1427 <Plugin curl>
1428 <Page "stock_quotes">
1429 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1430 User "foo"
1431 Password "bar"
1432 Digest false
1433 VerifyPeer true
1434 VerifyHost true
1435 CACert "/path/to/ca.crt"
1436 Header "X-Custom-Header: foobar"
1437 Post "foo=bar"
1439 MeasureResponseTime false
1440 MeasureResponseCode false
1442 <Match>
1443 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1444 DSType "GaugeAverage"
1445 # Note: `stock_value' is not a standard type.
1446 Type "stock_value"
1447 Instance "AMD"
1448 </Match>
1449 </Page>
1450 </Plugin>
1452 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1453 a web page and one or more "matches" to be performed on the returned data. The
1454 string argument to the B<Page> block is used as plugin instance.
1456 The following options are valid within B<Page> blocks:
1458 =over 4
1460 =item B<URL> I<URL>
1462 URL of the web site to retrieve. Since a regular expression will be used to
1463 extract information from this data, non-binary data is a big plus here ;)
1465 =item B<User> I<Name>
1467 Username to use if authorization is required to read the page.
1469 =item B<Password> I<Password>
1471 Password to use if authorization is required to read the page.
1473 =item B<Digest> B<true>|B<false>
1475 Enable HTTP digest authentication.
1477 =item B<VerifyPeer> B<true>|B<false>
1479 Enable or disable peer SSL certificate verification. See
1480 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1482 =item B<VerifyHost> B<true>|B<false>
1484 Enable or disable peer host name verification. If enabled, the plugin checks if
1485 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1486 matches the host name provided by the B<URL> option. If this identity check
1487 fails, the connection is aborted. Obviously, only works when connecting to a
1488 SSL enabled server. Enabled by default.
1490 =item B<CACert> I<file>
1492 File that holds one or more SSL certificates. If you want to use HTTPS you will
1493 possibly need this option. What CA certificates come bundled with C<libcurl>
1494 and are checked by default depends on the distribution you use.
1496 =item B<Header> I<Header>
1498 A HTTP header to add to the request. Multiple headers are added if this option
1499 is specified more than once.
1501 =item B<Post> I<Body>
1503 Specifies that the HTTP operation should be a POST instead of a GET. The
1504 complete data to be posted is given as the argument. This option will usually
1505 need to be accompanied by a B<Header> option to set an appropriate
1506 C<Content-Type> for the post body (e.g. to
1507 C<application/x-www-form-urlencoded>).
1509 =item B<MeasureResponseTime> B<true>|B<false>
1511 Measure response time for the request. If this setting is enabled, B<Match>
1512 blocks (see below) are optional. Disabled by default.
1514 Beware that requests will get aborted if they take too long to complete. Adjust
1515 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1516 requests.
1518 =item B<MeasureResponseCode> B<true>|B<false>
1520 Measure response code for the request. If this setting is enabled, B<Match>
1521 blocks (see below) are optional. Disabled by default.
1523 =item B<E<lt>MatchE<gt>>
1525 One or more B<Match> blocks that define how to match information in the data
1526 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1527 used by the C<tail> plugin, so please see the documentation of the C<tail>
1528 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1529 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1530 optional.
1532 =item B<Timeout> I<Milliseconds>
1534 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1535 milliseconds. By default, the configured B<Interval> is used to set the
1536 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1537 indefinitely. This legacy behaviour can be achieved by setting the value of
1538 B<Timeout> to 0.
1540 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1541 network connection will stall one read thread. Adjust the B<ReadThreads> global
1542 setting accordingly to prevent this from blocking other plugins.
1544 =back
1546 =head2 Plugin C<curl_json>
1548 The B<curl_json plugin> collects values from JSON data to be parsed by
1549 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1550 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1551 unix socket. The former can be used, for example, to collect values
1552 from CouchDB documents (which are stored JSON notation), and the
1553 latter to collect values from a uWSGI stats socket.
1555 The following example will collect several values from the built-in
1556 C<_stats> runtime statistics module of I<CouchDB>
1557 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1559 <Plugin curl_json>
1560 <URL "http://localhost:5984/_stats">
1561 Instance "httpd"
1562 <Key "httpd/requests/count">
1563 Type "http_requests"
1564 </Key>
1566 <Key "httpd_request_methods/*/count">
1567 Type "http_request_methods"
1568 </Key>
1570 <Key "httpd_status_codes/*/count">
1571 Type "http_response_codes"
1572 </Key>
1573 </URL>
1574 </Plugin>
1576 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1578 <Plugin curl_json>
1579 <Sock "/var/run/uwsgi.stats.sock">
1580 Instance "uwsgi"
1581 <Key "workers/*/requests">
1582 Type "http_requests"
1583 </Key>
1585 <Key "workers/*/apps/*/requests">
1586 Type "http_requests"
1587 </Key>
1588 </Sock>
1589 </Plugin>
1591 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1592 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1593 blocks defining a unix socket to read JSON from directly. Each of
1594 these blocks may have one or more B<Key> blocks.
1596 The B<Key> string argument must be in a path format. Each component is
1597 used to match the key from a JSON map or the index of an JSON
1598 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1599 values for all map keys or array indices will be collectd.
1601 The following options are valid within B<URL> blocks:
1603 =over 4
1605 =item B<Instance> I<Instance>
1607 Sets the plugin instance to I<Instance>.
1609 =item B<Interval> I<Interval>
1611 Sets the interval (in seconds) in which the values will be collected from this
1612 URL. By default the global B<Interval> setting will be used.
1614 =item B<User> I<Name>
1616 =item B<Password> I<Password>
1618 =item B<Digest> B<true>|B<false>
1620 =item B<VerifyPeer> B<true>|B<false>
1622 =item B<VerifyHost> B<true>|B<false>
1624 =item B<CACert> I<file>
1626 =item B<Header> I<Header>
1628 =item B<Post> I<Body>
1630 =item B<Timeout> I<Milliseconds>
1632 These options behave exactly equivalent to the appropriate options of the
1633 I<cURL> plugin. Please see there for a detailed description.
1635 =back
1637 The following options are valid within B<Key> blocks:
1639 =over 4
1641 =item B<Type> I<Type>
1643 Sets the type used to dispatch the values to the daemon. Detailed information
1644 about types and their configuration can be found in L<types.db(5)>. This
1645 option is mandatory.
1647 =item B<Instance> I<Instance>
1649 Type-instance to use. Defaults to the current map key or current string array element value.
1651 =back
1653 =head2 Plugin C<curl_xml>
1655 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1656 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1658 <Plugin "curl_xml">
1659 <URL "http://localhost/stats.xml">
1660 Host "my_host"
1661 Instance "some_instance"
1662 User "collectd"
1663 Password "thaiNg0I"
1664 VerifyPeer true
1665 VerifyHost true
1666 CACert "/path/to/ca.crt"
1667 Header "X-Custom-Header: foobar"
1668 Post "foo=bar"
1670 <XPath "table[@id=\"magic_level\"]/tr">
1671 Type "magic_level"
1672 #InstancePrefix "prefix-"
1673 InstanceFrom "td[1]"
1674 ValuesFrom "td[2]/span[@class=\"level\"]"
1675 </XPath>
1676 </URL>
1677 </Plugin>
1679 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1680 URL to be fetched using libcurl. Within each B<URL> block there are
1681 options which specify the connection parameters, for example authentication
1682 information, and one or more B<XPath> blocks.
1684 Each B<XPath> block specifies how to get one type of information. The
1685 string argument must be a valid XPath expression which returns a list
1686 of "base elements". One value is dispatched for each "base element". The
1687 I<type instance> and values are looked up using further I<XPath> expressions
1688 that should be relative to the base element.
1690 Within the B<URL> block the following options are accepted:
1692 =over 4
1694 =item B<Host> I<Name>
1696 Use I<Name> as the host name when submitting values. Defaults to the global
1697 host name setting.
1699 =item B<Instance> I<Instance>
1701 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1702 empty string (no plugin instance).
1704 =item B<Namespace> I<Prefix> I<URL>
1706 If an XPath expression references namespaces, they must be specified
1707 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1708 I<URL> is the "namespace name", an URI reference uniquely identifying the
1709 namespace. The option can be repeated to register multiple namespaces.
1711 Examples:
1713 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1714 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1716 =item B<User> I<User>
1718 =item B<Password> I<Password>
1720 =item B<Digest> B<true>|B<false>
1722 =item B<VerifyPeer> B<true>|B<false>
1724 =item B<VerifyHost> B<true>|B<false>
1726 =item B<CACert> I<CA Cert File>
1728 =item B<Header> I<Header>
1730 =item B<Post> I<Body>
1732 =item B<Timeout> I<Milliseconds>
1734 These options behave exactly equivalent to the appropriate options of the
1735 I<cURL plugin>. Please see there for a detailed description.
1737 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1739 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1740 B<XPath> block specifies how to get one type of information. The string
1741 argument must be a valid XPath expression which returns a list of "base
1742 elements". One value is dispatched for each "base element".
1744 Within the B<XPath> block the following options are accepted:
1746 =over 4
1748 =item B<Type> I<Type>
1750 Specifies the I<Type> used for submitting patches. This determines the number
1751 of values that are required / expected and whether the strings are parsed as
1752 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1753 This option is required.
1755 =item B<InstancePrefix> I<InstancePrefix>
1757 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1758 concatenated together without any separator.
1759 This option is optional.
1761 =item B<InstanceFrom> I<InstanceFrom>
1763 Specifies a XPath expression to use for determining the I<type instance>. The
1764 XPath expression must return exactly one element. The element's value is then
1765 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1767 This value is required. As a special exception, if the "base XPath expression"
1768 (the argument to the B<XPath> block) returns exactly one argument, then this
1769 option may be omitted.
1771 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1773 Specifies one or more XPath expression to use for reading the values. The
1774 number of XPath expressions must match the number of data sources in the
1775 I<type> specified with B<Type> (see above). Each XPath expression must return
1776 exactly one element. The element's value is then parsed as a number and used as
1777 value for the appropriate value in the value list dispatched to the daemon.
1779 =back
1781 =back
1783 =head2 Plugin C<dbi>
1785 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1786 connect to various databases, execute I<SQL> statements and read back the
1787 results. I<dbi> is an acronym for "database interface" in case you were
1788 wondering about the name. You can configure how each column is to be
1789 interpreted and the plugin will generate one or more data sets from each row
1790 returned according to these rules.
1792 Because the plugin is very generic, the configuration is a little more complex
1793 than those of other plugins. It usually looks something like this:
1795 <Plugin dbi>
1796 <Query "out_of_stock">
1797 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1798 # Use with MySQL 5.0.0 or later
1799 MinVersion 50000
1800 <Result>
1801 Type "gauge"
1802 InstancePrefix "out_of_stock"
1803 InstancesFrom "category"
1804 ValuesFrom "value"
1805 </Result>
1806 </Query>
1807 <Database "product_information">
1808 Driver "mysql"
1809 DriverOption "host" "localhost"
1810 DriverOption "username" "collectd"
1811 DriverOption "password" "aZo6daiw"
1812 DriverOption "dbname" "prod_info"
1813 SelectDB "prod_info"
1814 Query "out_of_stock"
1815 </Database>
1816 </Plugin>
1818 The configuration above defines one query with one result and one database. The
1819 query is then linked to the database with the B<Query> option I<within> the
1820 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1821 and you can also use the B<Include> statement to split up the configuration
1822 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1823 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1824 top to bottom!
1826 The following is a complete list of options:
1828 =head3 B<Query> blocks
1830 Query blocks define I<SQL> statements and how the returned data should be
1831 interpreted. They are identified by the name that is given in the opening line
1832 of the block. Thus the name needs to be unique. Other than that, the name is
1833 not used in collectd.
1835 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1836 define which column holds which value or instance information. You can use
1837 multiple B<Result> blocks to create multiple values from one returned row. This
1838 is especially useful, when queries take a long time and sending almost the same
1839 query again and again is not desirable.
1841 Example:
1843 <Query "environment">
1844 Statement "select station, temperature, humidity from environment"
1845 <Result>
1846 Type "temperature"
1847 # InstancePrefix "foo"
1848 InstancesFrom "station"
1849 ValuesFrom "temperature"
1850 </Result>
1851 <Result>
1852 Type "humidity"
1853 InstancesFrom "station"
1854 ValuesFrom "humidity"
1855 </Result>
1856 </Query>
1858 The following options are accepted:
1860 =over 4
1862 =item B<Statement> I<SQL>
1864 Sets the statement that should be executed on the server. This is B<not>
1865 interpreted by collectd, but simply passed to the database server. Therefore,
1866 the SQL dialect that's used depends on the server collectd is connected to.
1868 The query has to return at least two columns, one for the instance and one
1869 value. You cannot omit the instance, even if the statement is guaranteed to
1870 always return exactly one line. In that case, you can usually specify something
1871 like this:
1873 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1875 (That works with MySQL but may not be valid SQL according to the spec. If you
1876 use a more strict database server, you may have to select from a dummy table or
1877 something.)
1879 Please note that some databases, for example B<Oracle>, will fail if you
1880 include a semicolon at the end of the statement.
1882 =item B<MinVersion> I<Version>
1884 =item B<MaxVersion> I<Value>
1886 Only use this query for the specified database version. You can use these
1887 options to provide multiple queries with the same name but with a slightly
1888 different syntax. The plugin will use only those queries, where the specified
1889 minimum and maximum versions fit the version of the database in use.
1891 The database version is determined by C<dbi_conn_get_engine_version>, see the
1892 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1893 for details. Basically, each part of the version is assumed to be in the range
1894 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1895 "40102", version "5.0.42" becomes "50042".
1897 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1898 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1899 happen. Don't to it! A valid example would be something along these lines:
1901 MinVersion 40000
1902 MaxVersion 49999
1903 ...
1904 MinVersion 50000
1905 MaxVersion 50099
1906 ...
1907 MinVersion 50100
1908 # No maximum
1910 In the above example, there are three ranges that don't overlap. The last one
1911 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1912 before "4.0.0" are not specified.
1914 =item B<Type> I<Type>
1916 The B<type> that's used for each line returned. See L<types.db(5)> for more
1917 details on how types are defined. In short: A type is a predefined layout of
1918 data and the number of values and type of values has to match the type
1919 definition.
1921 If you specify "temperature" here, you need exactly one gauge column. If you
1922 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1923 setting below.
1925 There must be exactly one B<Type> option inside each B<Result> block.
1927 =item B<InstancePrefix> I<prefix>
1929 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1930 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1931 all strings returned in the appropriate columns are concatenated together,
1932 separated by dashes I<("-")>.
1934 =item B<InstancesFrom> I<column0> [I<column1> ...]
1936 Specifies the columns whose values will be used to create the "type-instance"
1937 for each row. If you specify more than one column, the value of all columns
1938 will be joined together with dashes I<("-")> as separation characters.
1940 The plugin itself does not check whether or not all built instances are
1941 different. It's your responsibility to assure that each is unique. This is
1942 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1943 sure that only one row is returned in this case.
1945 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1946 will be empty.
1948 =item B<ValuesFrom> I<column0> [I<column1> ...]
1950 Names the columns whose content is used as the actual data for the data sets
1951 that are dispatched to the daemon. How many such columns you need is determined
1952 by the B<Type> setting above. If you specify too many or not enough columns,
1953 the plugin will complain about that and no data will be submitted to the
1954 daemon.
1956 The actual data type in the columns is not that important. The plugin will
1957 automatically cast the values to the right type if it know how to do that. So
1958 it should be able to handle integer an floating point types, as well as strings
1959 (if they include a number at the beginning).
1961 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1963 =item B<MetadataFrom> [I<column0> I<column1> ...]
1965 Names the columns whose content is used as metadata for the data sets
1966 that are dispatched to the daemon.
1968 The actual data type in the columns is not that important. The plugin will
1969 automatically cast the values to the right type if it know how to do that. So
1970 it should be able to handle integer an floating point types, as well as strings
1971 (if they include a number at the beginning).
1973 =back
1975 =head3 B<Database> blocks
1977 Database blocks define a connection to a database and which queries should be
1978 sent to that database. Since the used "dbi" library can handle a wide variety
1979 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1980 documentationE<nbsp>- we stick as close to the terminology used there.
1982 Each database needs a "name" as string argument in the starting tag of the
1983 block. This name will be used as "PluginInstance" in the values submitted to
1984 the daemon. Other than that, that name is not used.
1986 =over 4
1988 =item B<Driver> I<Driver>
1990 Specifies the driver to use to connect to the database. In many cases those
1991 drivers are named after the database they can connect to, but this is not a
1992 technical necessity. These drivers are sometimes referred to as "DBD",
1993 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1994 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1995 project at L<http://libdbi-drivers.sourceforge.net/>.
1997 You need to give the driver name as expected by the "dbi" library here. You
1998 should be able to find that in the documentation for each driver. If you
1999 mistype the driver name, the plugin will dump a list of all known driver names
2000 to the log.
2002 =item B<DriverOption> I<Key> I<Value>
2004 Sets driver-specific options. What option a driver supports can be found in the
2005 documentation for each driver, somewhere at
2006 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2007 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2009 DBDs can register two types of options: String options and numeric options. The
2010 plugin will use the C<dbi_conn_set_option> function when the configuration
2011 provides a string and the C<dbi_conn_require_option_numeric> function when the
2012 configuration provides a number. So these two lines will actually result in
2013 different calls being used:
2015 DriverOption "Port" 1234 # numeric
2016 DriverOption "Port" "1234" # string
2018 Unfortunately, drivers are not too keen to report errors when an unknown option
2019 is passed to them, so invalid settings here may go unnoticed. This is not the
2020 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2021 the driver. If a driver complains about an option, the plugin will dump a
2022 complete list of all options understood by that driver to the log. There is no
2023 way to programatically find out if an option expects a string or a numeric
2024 argument, so you will have to refer to the appropriate DBD's documentation to
2025 find this out. Sorry.
2027 =item B<SelectDB> I<Database>
2029 In some cases, the database name you connect with is not the database name you
2030 want to use for querying data. If this option is set, the plugin will "select"
2031 (switch to) that database after the connection is established.
2033 =item B<Query> I<QueryName>
2035 Associates the query named I<QueryName> with this database connection. The
2036 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2037 blocks you want to refer to must be placed above the database block you want to
2038 refer to them from.
2040 =item B<Host> I<Hostname>
2042 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2043 values. Defaults to the global hostname setting.
2045 =back
2047 =head2 Plugin C<df>
2049 =over 4
2051 =item B<Device> I<Device>
2053 Select partitions based on the devicename.
2055 =item B<MountPoint> I<Directory>
2057 Select partitions based on the mountpoint.
2059 =item B<FSType> I<FSType>
2061 Select partitions based on the filesystem type.
2063 =item B<IgnoreSelected> B<true>|B<false>
2065 Invert the selection: If set to true, all partitions B<except> the ones that
2066 match any one of the criteria are collected. By default only selected
2067 partitions are collected if a selection is made. If no selection is configured
2068 at all, B<all> partitions are selected.
2070 =item B<ReportByDevice> B<true>|B<false>
2072 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2073 (the default), it will report a disk as "root", but with it I<true>, it will be
2074 "sda1" (or whichever).
2076 =item B<ReportInodes> B<true>|B<false>
2078 Enables or disables reporting of free, reserved and used inodes. Defaults to
2079 inode collection being disabled.
2081 Enable this option if inodes are a scarce resource for you, usually because
2082 many small files are stored on the disk. This is a usual scenario for mail
2083 transfer agents and web caches.
2085 =item B<ValuesAbsolute> B<true>|B<false>
2087 Enables or disables reporting of free and used disk space in 1K-blocks.
2088 Defaults to B<true>.
2090 =item B<ValuesPercentage> B<false>|B<true>
2092 Enables or disables reporting of free and used disk space in percentage.
2093 Defaults to B<false>.
2095 This is useful for deploying I<collectd> on the cloud, where machines with
2096 different disk size may exist. Then it is more practical to configure
2097 thresholds based on relative disk size.
2099 =back
2101 =head2 Plugin C<disk>
2103 The C<disk> plugin collects information about the usage of physical disks and
2104 logical disks (partitions). Values collected are the number of octets written
2105 to and read from a disk or partition, the number of read/write operations
2106 issued to the disk and a rather complex "time" it took for these commands to be
2107 issued.
2109 Using the following two options you can ignore some disks or configure the
2110 collection only of specific disks.
2112 =over 4
2114 =item B<Disk> I<Name>
2116 Select the disk I<Name>. Whether it is collected or ignored depends on the
2117 B<IgnoreSelected> setting, see below. As with other plugins that use the
2118 daemon's ignorelist functionality, a string that starts and ends with a slash
2119 is interpreted as a regular expression. Examples:
2121 Disk "sdd"
2122 Disk "/hda[34]/"
2124 =item B<IgnoreSelected> B<true>|B<false>
2126 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2127 statements, are ignored or if all other disks are ignored. The behavior
2128 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2129 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2130 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2131 is set to B<true>, all disks are collected B<except> the ones matched.
2133 =item B<UseBSDName> B<true>|B<false>
2135 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2136 default major/minor numbers. Requires collectd to be built with Apple's
2137 IOKitLib support.
2139 =item B<UdevNameAttr> I<Attribute>
2141 Attempt to override disk instance name with the value of a specified udev
2142 attribute when built with B<libudev>. If the attribute is not defined for the
2143 given device, the default name is used. Example:
2145 UdevNameAttr "DM_NAME"
2147 =back
2149 =head2 Plugin C<dns>
2151 =over 4
2153 =item B<Interface> I<Interface>
2155 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2156 option sets the interface that should be used. If this option is not set, or
2157 set to "any", the plugin will try to get packets from B<all> interfaces. This
2158 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2160 =item B<IgnoreSource> I<IP-address>
2162 Ignore packets that originate from this address.
2164 =item B<SelectNumericQueryTypes> B<true>|B<false>
2166 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2168 =back
2170 =head2 Plugin C<email>
2172 =over 4
2174 =item B<SocketFile> I<Path>
2176 Sets the socket-file which is to be created.
2178 =item B<SocketGroup> I<Group>
2180 If running as root change the group of the UNIX-socket after it has been
2181 created. Defaults to B<collectd>.
2183 =item B<SocketPerms> I<Permissions>
2185 Change the file permissions of the UNIX-socket after it has been created. The
2186 permissions must be given as a numeric, octal value as you would pass to
2187 L<chmod(1)>. Defaults to B<0770>.
2189 =item B<MaxConns> I<Number>
2191 Sets the maximum number of connections that can be handled in parallel. Since
2192 this many threads will be started immediately setting this to a very high
2193 value will waste valuable resources. Defaults to B<5> and will be forced to be
2194 at most B<16384> to prevent typos and dumb mistakes.
2196 =back
2198 =head2 Plugin C<ethstat>
2200 The I<ethstat plugin> collects information about network interface cards (NICs)
2201 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2203 B<Synopsis:>
2205 <Plugin "ethstat">
2206 Interface "eth0"
2207 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2208 Map "multicast" "if_multicast"
2209 </Plugin>
2211 B<Options:>
2213 =over 4
2215 =item B<Interface> I<Name>
2217 Collect statistical information about interface I<Name>.
2219 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2221 By default, the plugin will submit values as type C<derive> and I<type
2222 instance> set to I<Name>, the name of the metric as reported by the driver. If
2223 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2224 I<TypeInstance> will be used.
2226 =item B<MappedOnly> B<true>|B<false>
2228 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2229 collected, all other metrics will be ignored. Defaults to B<false>.
2231 =back
2233 =head2 Plugin C<exec>
2235 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2236 contains valuable information on when the executable is executed and the
2237 output that is expected from it.
2239 =over 4
2241 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2243 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2245 Execute the executable I<Executable> as user I<User>. If the user name is
2246 followed by a colon and a group name, the effective group is set to that group.
2247 The real group and saved-set group will be set to the default group of that
2248 user. If no group is given the effective group ID will be the same as the real
2249 group ID.
2251 Please note that in order to change the user and/or group the daemon needs
2252 superuser privileges. If the daemon is run as an unprivileged user you must
2253 specify the same user/group here. If the daemon is run with superuser
2254 privileges, you must supply a non-root user here.
2256 The executable may be followed by optional arguments that are passed to the
2257 program. Please note that due to the configuration parsing numbers and boolean
2258 values may be changed. If you want to be absolutely sure that something is
2259 passed as-is please enclose it in quotes.
2261 The B<Exec> and B<NotificationExec> statements change the semantics of the
2262 programs executed, i.E<nbsp>e. the data passed to them and the response
2263 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2265 =back
2267 =head2 Plugin C<fhcount>
2269 The C<fhcount> plugin provides statistics about used, unused and total number of
2270 file handles.
2272 The I<fhcount plugin> provides the following configuration options:
2274 =over 4
2276 =item B<ValuesAbsolute> B<true>|B<false>
2278 Enables or disables reporting of file handles usage in absolute numbers,
2279 e.g. file handles used. Defaults to B<true>.
2281 =item B<ValuesPercentage> B<false>|B<true>
2283 Enables or disables reporting of file handles usage in percentages, e.g.
2284 percent of file handles used. Defaults to B<false>.
2286 =back
2288 =head2 Plugin C<filecount>
2290 The C<filecount> plugin counts the number of files in a certain directory (and
2291 its subdirectories) and their combined size. The configuration is very straight
2292 forward:
2294 <Plugin "filecount">
2295 <Directory "/var/qmail/queue/mess">
2296 Instance "qmail-message"
2297 </Directory>
2298 <Directory "/var/qmail/queue/todo">
2299 Instance "qmail-todo"
2300 </Directory>
2301 <Directory "/var/lib/php5">
2302 Instance "php5-sessions"
2303 Name "sess_*"
2304 </Directory>
2305 </Plugin>
2307 The example above counts the number of files in QMail's queue directories and
2308 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2309 QMail has not yet looked at, the "message" queue holds the messages that were
2310 classified into "local" and "remote".
2312 As you can see, the configuration consists of one or more C<Directory> blocks,
2313 each of which specifies a directory in which to count the files. Within those
2314 blocks, the following options are recognized:
2316 =over 4
2318 =item B<Instance> I<Instance>
2320 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2321 it's your responsibility, the plugin doesn't check for that. If not given, the
2322 instance is set to the directory name with all slashes replaced by underscores
2323 and all leading underscores removed.
2325 =item B<Name> I<Pattern>
2327 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2328 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2329 against the pattern, not the entire path. In case this makes it easier for you:
2330 This option has been named after the B<-name> parameter to L<find(1)>.
2332 =item B<MTime> I<Age>
2334 Count only files of a specific age: If I<Age> is greater than zero, only files
2335 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2336 a negative number, this is inversed. For example, if B<-60> is specified, only
2337 files that have been modified in the last minute will be counted.
2339 The number can also be followed by a "multiplier" to easily specify a larger
2340 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2341 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2342 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2343 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2344 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2345 B<"12h">.
2347 =item B<Size> I<Size>
2349 Count only files of a specific size. When I<Size> is a positive number, only
2350 files that are at least this big are counted. If I<Size> is a negative number,
2351 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2352 I<Size> are counted.
2354 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2355 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2356 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2357 note that there are 1000 bytes in a kilobyte, not 1024.
2359 =item B<Recursive> I<true>|I<false>
2361 Controls whether or not to recurse into subdirectories. Enabled by default.
2363 =item B<IncludeHidden> I<true>|I<false>
2365 Controls whether or not to include "hidden" files and directories in the count.
2366 "Hidden" files and directories are those, whose name begins with a dot.
2367 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2369 =back
2371 =head2 Plugin C<GenericJMX>
2373 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2374 L<collectd-java(5)>.
2376 =head2 Plugin C<gmond>
2378 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2379 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2380 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2382 Synopsis:
2384 <Plugin "gmond">
2385 MCReceiveFrom "239.2.11.71" "8649"
2386 <Metric "swap_total">
2387 Type "swap"
2388 TypeInstance "total"
2389 DataSource "value"
2390 </Metric>
2391 <Metric "swap_free">
2392 Type "swap"
2393 TypeInstance "free"
2394 DataSource "value"
2395 </Metric>
2396 </Plugin>
2398 The following metrics are built-in:
2400 =over 4
2402 =item *
2404 load_one, load_five, load_fifteen
2406 =item *
2408 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2410 =item *
2412 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2414 =item *
2416 bytes_in, bytes_out
2418 =item *
2420 pkts_in, pkts_out
2422 =back
2424 Available configuration options:
2426 =over 4
2428 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2430 Sets sets the multicast group and UDP port to which to subscribe.
2432 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2434 =item E<lt>B<Metric> I<Name>E<gt>
2436 These blocks add a new metric conversion to the internal table. I<Name>, the
2437 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2439 =over 4
2441 =item B<Type> I<Type>
2443 Type to map this metric to. Required.
2445 =item B<TypeInstance> I<Instance>
2447 Type-instance to use. Optional.
2449 =item B<DataSource> I<Name>
2451 Data source to map this metric to. If the configured type has exactly one data
2452 source, this is optional. Otherwise the option is required.
2454 =back
2456 =back
2458 =head2 Plugin C<hddtemp>
2460 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2461 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2462 default values, see below. C<hddtemp> has to be running to work correctly. If
2463 C<hddtemp> is not running timeouts may appear which may interfere with other
2464 statistics..
2466 The B<hddtemp> homepage can be found at
2467 L<http://www.guzu.net/linux/hddtemp.php>.
2469 =over 4
2471 =item B<Host> I<Hostname>
2473 Hostname to connect to. Defaults to B<127.0.0.1>.
2475 =item B<Port> I<Port>
2477 TCP-Port to connect to. Defaults to B<7634>.
2479 =back
2481 =head2 Plugin C<interface>
2483 =over 4
2485 =item B<Interface> I<Interface>
2487 Select this interface. By default these interfaces will then be collected. For
2488 a more detailed description see B<IgnoreSelected> below.
2490 =item B<IgnoreSelected> I<true>|I<false>
2492 If no configuration if given, the B<traffic>-plugin will collect data from
2493 all interfaces. This may not be practical, especially for loopback- and
2494 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2495 interfaces you're interested in. Sometimes, however, it's easier/preferred
2496 to collect all interfaces I<except> a few ones. This option enables you to
2497 do that: By setting B<IgnoreSelected> to I<true> the effect of
2498 B<Interface> is inverted: All selected interfaces are ignored and all
2499 other interfaces are collected.
2501 =back
2503 =head2 Plugin C<ipmi>
2505 =over 4
2507 =item B<Sensor> I<Sensor>
2509 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2511 =item B<IgnoreSelected> I<true>|I<false>
2513 If no configuration if given, the B<ipmi> plugin will collect data from all
2514 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2515 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2516 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2517 all other sensors are collected.
2519 =item B<NotifySensorAdd> I<true>|I<false>
2521 If a sensor appears after initialization time of a minute a notification
2522 is sent.
2524 =item B<NotifySensorRemove> I<true>|I<false>
2526 If a sensor disappears a notification is sent.
2528 =item B<NotifySensorNotPresent> I<true>|I<false>
2530 If you have for example dual power supply and one of them is (un)plugged then
2531 a notification is sent.
2533 =back
2535 =head2 Plugin C<iptables>
2537 =over 4
2539 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2541 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2542 will collect the counters of all rules which have a comment-match. The comment
2543 is then used as type-instance.
2545 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2546 the I<n>th rule will be collected. Again, the comment (or the number) will be
2547 used as the type-instance.
2549 If I<Name> is supplied, it will be used as the type-instance instead of the
2550 comment or the number.
2552 =back
2554 =head2 Plugin C<irq>
2556 =over 4
2558 =item B<Irq> I<Irq>
2560 Select this irq. By default these irqs will then be collected. For a more
2561 detailed description see B<IgnoreSelected> below.
2563 =item B<IgnoreSelected> I<true>|I<false>
2565 If no configuration if given, the B<irq>-plugin will collect data from all
2566 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2567 can use the B<Irq>-option to pick the interrupt you're interested in.
2568 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2569 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2570 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2571 and all other interrupts are collected.
2573 =back
2575 =head2 Plugin C<java>
2577 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2578 This section only discusses the syntax and semantic of the configuration
2579 options. For more in-depth information on the I<Java> plugin, please read
2580 L<collectd-java(5)>.
2582 Synopsis:
2584 <Plugin "java">
2585 JVMArg "-verbose:jni"
2586 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2587 LoadPlugin "org.collectd.java.Foobar"
2588 <Plugin "org.collectd.java.Foobar">
2589 # To be parsed by the plugin
2590 </Plugin>
2591 </Plugin>
2593 Available configuration options:
2595 =over 4
2597 =item B<JVMArg> I<Argument>
2599 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2600 exactly the way the arguments to the I<java> binary on the command line work.
2601 Execute C<javaE<nbsp>--help> for details.
2603 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2604 any other options! When another option is found, the JVM will be started and
2605 later options will have to be ignored!
2607 =item B<LoadPlugin> I<JavaClass>
2609 Instantiates a new I<JavaClass> object. The constructor of this object very
2610 likely then registers one or more callback methods with the server.
2612 See L<collectd-java(5)> for details.
2614 When the first such option is found, the virtual machine (JVM) is created. This
2615 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2616 B<LoadPlugin> options!
2618 =item B<Plugin> I<Name>
2620 The entire block is passed to the Java plugin as an
2621 I<org.collectd.api.OConfigItem> object.
2623 For this to work, the plugin has to register a configuration callback first,
2624 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2625 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2626 depends on the (Java) plugin registering the callback and is completely
2627 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2629 =back
2631 =head2 Plugin C<load>
2633 The I<Load plugin> collects the system load. These numbers give a rough overview
2634 over the utilization of a machine. The system load is defined as the number of
2635 runnable tasks in the run-queue and is provided by many operating systems as a
2636 one, five or fifteen minute average.
2638 The following configuration options are available:
2640 =over 4
2642 =item B<ReportRelative> B<false>|B<true>
2644 When enabled, system load divided by number of available CPU cores is reported
2645 for intervals 1 min, 5 min and 15 min. Defaults to false.
2647 =back
2650 =head2 Plugin C<logfile>
2652 =over 4
2654 =item B<LogLevel> B<debug|info|notice|warning|err>
2656 Sets the log-level. If, for example, set to B<notice>, then all events with
2657 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2659 Please note that B<debug> is only available if collectd has been compiled with
2660 debugging support.
2662 =item B<File> I<File>
2664 Sets the file to write log messages to. The special strings B<stdout> and
2665 B<stderr> can be used to write to the standard output and standard error
2666 channels, respectively. This, of course, only makes much sense when I<collectd>
2667 is running in foreground- or non-daemon-mode.
2669 =item B<Timestamp> B<true>|B<false>
2671 Prefix all lines printed by the current time. Defaults to B<true>.
2673 =item B<PrintSeverity> B<true>|B<false>
2675 When enabled, all lines are prefixed by the severity of the log message, for
2676 example "warning". Defaults to B<false>.
2678 =back
2680 B<Note>: There is no need to notify the daemon after moving or removing the
2681 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2682 for each line it writes.
2684 =head2 Plugin C<log_logstash>
2686 The I<log logstash plugin> behaves like the logfile plugin but formats
2687 messages as JSON events for logstash to parse and input.
2689 =over 4
2691 =item B<LogLevel> B<debug|info|notice|warning|err>
2693 Sets the log-level. If, for example, set to B<notice>, then all events with
2694 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2696 Please note that B<debug> is only available if collectd has been compiled with
2697 debugging support.
2699 =item B<File> I<File>
2701 Sets the file to write log messages to. The special strings B<stdout> and
2702 B<stderr> can be used to write to the standard output and standard error
2703 channels, respectively. This, of course, only makes much sense when I<collectd>
2704 is running in foreground- or non-daemon-mode.
2706 =back
2708 B<Note>: There is no need to notify the daemon after moving or removing the
2709 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2710 for each line it writes.
2712 =head2 Plugin C<lpar>
2714 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2715 virtualization technique for IBM POWER processors. It takes into account CPU
2716 time stolen from or donated to a partition, in addition to the usual user,
2717 system, I/O statistics.
2719 The following configuration options are available:
2721 =over 4
2723 =item B<CpuPoolStats> B<false>|B<true>
2725 When enabled, statistics about the processor pool are read, too. The partition
2726 needs to have pool authority in order to be able to acquire this information.
2727 Defaults to false.
2729 =item B<ReportBySerial> B<false>|B<true>
2731 If enabled, the serial of the physical machine the partition is currently
2732 running on is reported as I<hostname> and the logical hostname of the machine
2733 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2734 used (just like other plugins) and the I<plugin instance> will be empty.
2735 Defaults to false.
2737 =back
2739 =head2 Plugin C<mbmon>
2741 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2743 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2744 B<Host> and B<Port> options can be used to change these values, see below.
2745 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2746 timeouts may appear which may interfere with other statistics..
2748 C<mbmon> must be run with the -r option ("print TAG and Value format");
2749 Debian's F</etc/init.d/mbmon> script already does this, other people
2750 will need to ensure that this is the case.
2752 =over 4
2754 =item B<Host> I<Hostname>
2756 Hostname to connect to. Defaults to B<127.0.0.1>.
2758 =item B<Port> I<Port>
2760 TCP-Port to connect to. Defaults to B<411>.
2762 =back
2764 =head2 Plugin C<md>
2766 The C<md plugin> collects information from Linux Software-RAID devices (md).
2768 All reported values are of the type C<md_disks>. Reported type instances are
2769 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2770 I<missing> (physically absent) disks.
2772 =over 4
2774 =item B<Device> I<Device>
2776 Select md devices based on device name. The I<device name> is the basename of
2777 the device, i.e. the name of the block device without the leading C</dev/>.
2778 See B<IgnoreSelected> for more details.
2780 =item B<IgnoreSelected> B<true>|B<false>
2782 Invert device selection: If set to B<true>, all md devices B<except> those
2783 listed using B<Device> are collected. If B<false> (the default), only those
2784 listed are collected. If no configuration is given, the B<md> plugin will
2785 collect data from all md devices.
2787 =back
2789 =head2 Plugin C<memcachec>
2791 The C<memcachec plugin> connects to a memcached server, queries one or more
2792 given I<pages> and parses the returned data according to user specification.
2793 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2794 plugins.
2796 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2797 library. Please note that there is another library with a very similar name,
2798 libmemcache (notice the missing `d'), which is not applicable.
2800 Synopsis of the configuration:
2802 <Plugin "memcachec">
2803 <Page "plugin_instance">
2804 Server "localhost"
2805 Key "page_key"
2806 <Match>
2807 Regex "(\\d+) bytes sent"
2808 DSType CounterAdd
2809 Type "ipt_octets"
2810 Instance "type_instance"
2811 </Match>
2812 </Page>
2813 </Plugin>
2815 The configuration options are:
2817 =over 4
2819 =item E<lt>B<Page> I<Name>E<gt>
2821 Each B<Page> block defines one I<page> to be queried from the memcached server.
2822 The block requires one string argument which is used as I<plugin instance>.
2824 =item B<Server> I<Address>
2826 Sets the server address to connect to when querying the page. Must be inside a
2827 B<Page> block.
2829 =item B<Key> I<Key>
2831 When connected to the memcached server, asks for the page I<Key>.
2833 =item E<lt>B<Match>E<gt>
2835 Match blocks define which strings to look for and how matches substrings are
2836 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2838 =back
2840 =head2 Plugin C<memcached>
2842 The B<memcached plugin> connects to a memcached server and queries statistics
2843 about cache utilization, memory and bandwidth used.
2844 L<http://www.danga.com/memcached/>
2846 <Plugin "memcached">
2847 <Instance "name">
2848 Host "memcache.example.com"
2849 Port 11211
2850 </Instance>
2851 </Plugin>
2853 The plugin configuration consists of one or more B<Instance> blocks which
2854 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2855 following options are allowed:
2857 =over 4
2859 =item B<Host> I<Hostname>
2861 Hostname to connect to. Defaults to B<127.0.0.1>.
2863 =item B<Port> I<Port>
2865 TCP-Port to connect to. Defaults to B<11211>.
2867 =item B<Socket> I<Path>
2869 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2870 setting is given, the B<Host> and B<Port> settings are ignored.
2872 =back
2874 =head2 Plugin C<mic>
2876 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2877 Intel's Many Integrated Core (MIC) systems.
2879 B<Synopsis:>
2881 <Plugin mic>
2882 ShowCPU true
2883 ShowCPUCores true
2884 ShowMemory true
2886 ShowTemperatures true
2887 Temperature vddg
2888 Temperature vddq
2889 IgnoreSelectedTemperature true
2891 ShowPower true
2892 Power total0
2893 Power total1
2894 IgnoreSelectedPower true
2895 </Plugin>
2897 The following options are valid inside the B<PluginE<nbsp>mic> block:
2899 =over 4
2901 =item B<ShowCPU> B<true>|B<false>
2903 If enabled (the default) a sum of the CPU usage across all cores is reported.
2905 =item B<ShowCPUCores> B<true>|B<false>
2907 If enabled (the default) per-core CPU usage is reported.
2909 =item B<ShowMemory> B<true>|B<false>
2911 If enabled (the default) the physical memory usage of the MIC system is
2912 reported.
2914 =item B<ShowTemperatures> B<true>|B<false>
2916 If enabled (the default) various temperatures of the MIC system are reported.
2918 =item B<Temperature> I<Name>
2920 This option controls which temperatures are being reported. Whether matching
2921 temperatures are being ignored or I<only> matching temperatures are reported
2922 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2923 temperatures are reported.
2925 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2927 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2928 (the default) only temperatures matching a B<Temperature> option are reported
2929 or, if no B<Temperature> option is specified, all temperatures are reported. If
2930 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2931 are reported.
2933 Known temperature names are:
2935 =over 4
2937 =item die
2939 Die of the CPU
2941 =item devmem
2943 Device Memory
2945 =item fin
2947 Fan In
2949 =item fout
2951 Fan Out
2953 =item vccp
2955 Voltage ccp
2957 =item vddg
2959 Voltage ddg
2961 =item vddq
2963 Voltage ddq
2965 =back
2967 =item B<ShowPower> B<true>|B<false>
2969 If enabled (the default) various temperatures of the MIC system are reported.
2971 =item B<Power> I<Name>
2973 This option controls which power readings are being reported. Whether matching
2974 power readings are being ignored or I<only> matching power readings are reported
2975 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2976 power readings are reported.
2978 =item B<IgnoreSelectedPower> B<false>|B<true>
2980 Controls the behavior of the B<Power> setting above. If set to B<false>
2981 (the default) only power readings matching a B<Power> option are reported
2982 or, if no B<Power> option is specified, all power readings are reported. If
2983 set to B<true>, matching power readings are I<ignored> and all other power readings
2984 are reported.
2986 Known power names are:
2988 =over 4
2990 =item total0
2992 Total power utilization averaged over Time Window 0 (uWatts).
2994 =item total1
2996 Total power utilization averaged over Time Window 0 (uWatts).
2998 =item inst
3000 Instantaneous power (uWatts).
3002 =item imax
3004 Max instantaneous power (uWatts).
3006 =item pcie
3008 PCI-E connector power (uWatts).
3010 =item c2x3
3012 2x3 connector power (uWatts).
3014 =item c2x4
3016 2x4 connector power (uWatts).
3018 =item vccp
3020 Core rail (uVolts).
3022 =item vddg
3024 Uncore rail (uVolts).
3026 =item vddq
3028 Memory subsystem rail (uVolts).
3030 =back
3032 =back
3034 =head2 Plugin C<memory>
3036 The I<memory plugin> provides the following configuration options:
3038 =over 4
3040 =item B<ValuesAbsolute> B<true>|B<false>
3042 Enables or disables reporting of physical memory usage in absolute numbers,
3043 i.e. bytes. Defaults to B<true>.
3045 =item B<ValuesPercentage> B<false>|B<true>
3047 Enables or disables reporting of physical memory usage in percentages, e.g.
3048 percent of physical memory used. Defaults to B<false>.
3050 This is useful for deploying I<collectd> in a heterogeneous environment in
3051 which the sizes of physical memory vary.
3053 =back
3055 =head2 Plugin C<modbus>
3057 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3058 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3059 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3060 values (two registers interpreted as IEEE floats in big endian notation).
3062 B<Synopsis:>
3064 <Data "voltage-input-1">
3065 RegisterBase 0
3066 RegisterType float
3067 RegisterCmd ReadHolding
3068 Type voltage
3069 Instance "input-1"
3070 </Data>
3072 <Data "voltage-input-2">
3073 RegisterBase 2
3074 RegisterType float
3075 RegisterCmd ReadHolding
3076 Type voltage
3077 Instance "input-2"
3078 </Data>
3080 <Data "supply-temperature-1">
3081 RegisterBase 0
3082 RegisterType Int16
3083 RegisterCmd ReadHolding
3084 Type temperature
3085 Instance "temp-1"
3086 </Data>
3088 <Host "modbus.example.com">
3089 Address "192.168.0.42"
3090 Port "502"
3091 Interval 60
3093 <Slave 1>
3094 Instance "power-supply"
3095 Collect "voltage-input-1"
3096 Collect "voltage-input-2"
3097 </Slave>
3098 </Host>
3100 <Host "localhost">
3101 Device "/dev/ttyUSB0"
3102 Baudrate 38400
3103 Interval 20
3105 <Slave 1>
3106 Instance "temperature"
3107 Collect "supply-temperature-1"
3108 </Slave>
3109 </Host>
3111 =over 4
3113 =item E<lt>B<Data> I<Name>E<gt> blocks
3115 Data blocks define a mapping between register numbers and the "types" used by
3116 I<collectd>.
3118 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3120 =over 4
3122 =item B<RegisterBase> I<Number>
3124 Configures the base register to read from the device. If the option
3125 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3126 register will be read (the register number is increased by one).
3128 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3130 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3131 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3132 combined into one value. Defaults to B<Uint16>.
3134 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3136 Specifies register type to be collected from device. Works only with libmodbus
3137 2.9.2 or higher. Defaults to B<ReadHolding>.
3139 =item B<Type> I<Type>
3141 Specifies the "type" (data set) to use when dispatching the value to
3142 I<collectd>. Currently, only data sets with exactly one data source are
3143 supported.
3145 =item B<Instance> I<Instance>
3147 Sets the type instance to use when dispatching the value to I<collectd>. If
3148 unset, an empty string (no type instance) is used.
3150 =back
3152 =item E<lt>B<Host> I<Name>E<gt> blocks
3154 Host blocks are used to specify to which hosts to connect and what data to read
3155 from their "slaves". The string argument I<Name> is used as hostname when
3156 dispatching the values to I<collectd>.
3158 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3160 =over 4
3162 =item B<Address> I<Hostname>
3164 For Modbus/TCP, specifies the node name (the actual network address) used to
3165 connect to the host. This may be an IP address or a hostname. Please note that
3166 the used I<libmodbus> library only supports IPv4 at the moment.
3168 =item B<Port> I<Service>
3170 for Modbus/TCP, specifies the port used to connect to the host. The port can
3171 either be given as a number or as a service name. Please note that the
3172 I<Service> argument must be a string, even if ports are given in their numerical
3173 form. Defaults to "502".
3175 =item B<Device> I<Devicenode>
3177 For Modbus/RTU, specifies the path to the serial device being used.
3179 =item B<Baudrate> I<Baudrate>
3181 For Modbus/RTU, specifies the baud rate of the serial device.
3182 Note, connections currently support only 8/N/1.
3184 =item B<Interval> I<Interval>
3186 Sets the interval (in seconds) in which the values will be collected from this
3187 host. By default the global B<Interval> setting will be used.
3189 =item E<lt>B<Slave> I<ID>E<gt>
3191 Over each connection, multiple Modbus devices may be reached. The slave ID
3192 is used to specify which device should be addressed. For each device you want
3193 to query, one B<Slave> block must be given.
3195 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3197 =over 4
3199 =item B<Instance> I<Instance>
3201 Specify the plugin instance to use when dispatching the values to I<collectd>.
3202 By default "slave_I<ID>" is used.
3204 =item B<Collect> I<DataName>
3206 Specifies which data to retrieve from the device. I<DataName> must be the same
3207 string as the I<Name> argument passed to a B<Data> block. You can specify this
3208 option multiple times to collect more than one value from a slave. At least one
3209 B<Collect> option is mandatory.
3211 =back
3213 =back
3215 =back
3217 =head2 Plugin C<mysql>
3219 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3220 one or more databases when started and keeps the connection up as long as
3221 possible. When the connection is interrupted for whatever reason it will try
3222 to re-connect. The plugin will complain loudly in case anything goes wrong.
3224 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3225 and collects information about MySQL network traffic, executed statements,
3226 requests, the query cache and threads by evaluating the
3227 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3228 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3229 Status Variables> for an explanation of these values.
3231 Optionally, master and slave statistics may be collected in a MySQL
3232 replication setup. In that case, information about the synchronization state
3233 of the nodes are collected by evaluating the C<Position> return value of the
3234 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3235 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3236 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3237 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3238 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3240 Synopsis:
3242 <Plugin mysql>
3243 <Database foo>
3244 Host "hostname"
3245 User "username"
3246 Password "password"
3247 Port "3306"
3248 MasterStats true
3249 ConnectTimeout 10
3250 </Database>
3252 <Database bar>
3253 Alias "squeeze"
3254 Host "localhost"
3255 Socket "/var/run/mysql/mysqld.sock"
3256 SlaveStats true
3257 SlaveNotifications true
3258 </Database>
3259 </Plugin>
3261 A B<Database> block defines one connection to a MySQL database. It accepts a
3262 single argument which specifies the name of the database. None of the other
3263 options are required. MySQL will use default values as documented in the
3264 section "mysql_real_connect()" in the B<MySQL reference manual>.
3266 =over 4
3268 =item B<Alias> I<Alias>
3270 Alias to use as sender instead of hostname when reporting. This may be useful
3271 when having cryptic hostnames.
3273 =item B<Host> I<Hostname>
3275 Hostname of the database server. Defaults to B<localhost>.
3277 =item B<User> I<Username>
3279 Username to use when connecting to the database. The user does not have to be
3280 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3281 unless you want to collectd replication statistics (see B<MasterStats> and
3282 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3283 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3285 =item B<Password> I<Password>
3287 Password needed to log into the database.
3289 =item B<Database> I<Database>
3291 Select this database. Defaults to I<no database> which is a perfectly reasonable
3292 option for what this plugin does.
3294 =item B<Port> I<Port>
3296 TCP-port to connect to. The port must be specified in its numeric form, but it
3297 must be passed as a string nonetheless. For example:
3299 Port "3306"
3301 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3302 See the documentation for the C<mysql_real_connect> function for details.
3304 =item B<Socket> I<Socket>
3306 Specifies the path to the UNIX domain socket of the MySQL server. This option
3307 only has any effect, if B<Host> is set to B<localhost> (the default).
3308 Otherwise, use the B<Port> option above. See the documentation for the
3309 C<mysql_real_connect> function for details.
3311 =item B<InnodbStats> I<true|false>
3313 If enabled, metrics about the InnoDB storage engine are collected.
3314 Disabled by default.
3316 =item B<MasterStats> I<true|false>
3318 =item B<SlaveStats> I<true|false>
3320 Enable the collection of master / slave statistics in a replication setup. In
3321 order to be able to get access to these statistics, the user needs special
3322 privileges. See the B<User> documentation above. Defaults to B<false>.
3324 =item B<SlaveNotifications> I<true|false>
3326 If enabled, the plugin sends a notification if the replication slave I/O and /
3327 or SQL threads are not running. Defaults to B<false>.
3329 =item B<ConnectTimeout> I<Seconds>
3331 Sets the connect timeout for the MySQL client.
3333 =back
3335 =head2 Plugin C<netapp>
3337 The netapp plugin can collect various performance and capacity information
3338 from a NetApp filer using the NetApp API.
3340 Please note that NetApp has a wide line of products and a lot of different
3341 software versions for each of these products. This plugin was developed for a
3342 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3343 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3344 model and software version but it is very hard to test this.
3345 If you have used this plugin with other models and/or software version, feel
3346 free to send us a mail to tell us about the results, even if it's just a short
3347 "It works".
3349 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3350 basic authentication.
3352 B<Do not use a regular user for this!> Create a special collectd user with just
3353 the minimum of capabilities needed. The user only needs the "login-http-admin"
3354 capability as well as a few more depending on which data will be collected.
3355 Required capabilities are documented below.
3357 =head3 Synopsis
3359 <Plugin "netapp">
3360 <Host "netapp1.example.com">
3361 Protocol "https"
3362 Address "10.0.0.1"
3363 Port 443
3364 User "username"
3365 Password "aef4Aebe"
3366 Interval 30
3368 <WAFL>
3369 Interval 30
3370 GetNameCache true
3371 GetDirCache true
3372 GetBufferCache true
3373 GetInodeCache true
3374 </WAFL>
3376 <Disks>
3377 Interval 30
3378 GetBusy true
3379 </Disks>
3381 <VolumePerf>
3382 Interval 30
3383 GetIO "volume0"
3384 IgnoreSelectedIO false
3385 GetOps "volume0"
3386 IgnoreSelectedOps false
3387 GetLatency "volume0"
3388 IgnoreSelectedLatency false
3389 </VolumePerf>
3391 <VolumeUsage>
3392 Interval 30
3393 GetCapacity "vol0"
3394 GetCapacity "vol1"
3395 IgnoreSelectedCapacity false
3396 GetSnapshot "vol1"
3397 GetSnapshot "vol3"
3398 IgnoreSelectedSnapshot false
3399 </VolumeUsage>
3401 <Quota>
3402 Interval 60
3403 </Quota>
3405 <Snapvault>
3406 Interval 30
3407 </Snapvault>
3409 <System>
3410 Interval 30
3411 GetCPULoad true
3412 GetInterfaces true
3413 GetDiskOps true
3414 GetDiskIO true
3415 </System>
3417 <VFiler vfilerA>
3418 Interval 60
3420 SnapVault true
3421 # ...
3422 </VFiler>
3423 </Host>
3424 </Plugin>
3426 The netapp plugin accepts the following configuration options:
3428 =over 4
3430 =item B<Host> I<Name>
3432 A host block defines one NetApp filer. It will appear in collectd with the name
3433 you specify here which does not have to be its real name nor its hostname (see
3434 the B<Address> option below).
3436 =item B<VFiler> I<Name>
3438 A B<VFiler> block may only be used inside a host block. It accepts all the
3439 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3440 will execute all NetApp API commands in the context of the specified
3441 VFiler(R). It will appear in collectd with the name you specify here which
3442 does not have to be its real name. The VFiler name may be specified using the
3443 B<VFilerName> option. If this is not specified, it will default to the name
3444 you specify here.
3446 The VFiler block inherits all connection related settings from the surrounding
3447 B<Host> block (which appear before the B<VFiler> block) but they may be
3448 overwritten inside the B<VFiler> block.
3450 This feature is useful, for example, when using a VFiler as SnapVault target
3451 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3452 available in the host filer (vfiler0) but only in the respective VFiler
3453 context.
3455 =item B<Protocol> B<httpd>|B<http>
3457 The protocol collectd will use to query this host.
3459 Optional
3461 Type: string
3463 Default: https
3465 Valid options: http, https
3467 =item B<Address> I<Address>
3469 The hostname or IP address of the host.
3471 Optional
3473 Type: string
3475 Default: The "host" block's name.
3477 =item B<Port> I<Port>
3479 The TCP port to connect to on the host.
3481 Optional
3483 Type: integer
3485 Default: 80 for protocol "http", 443 for protocol "https"
3487 =item B<User> I<User>
3489 =item B<Password> I<Password>
3491 The username and password to use to login to the NetApp.
3493 Mandatory
3495 Type: string
3497 =item B<VFilerName> I<Name>
3499 The name of the VFiler in which context to execute API commands. If not
3500 specified, the name provided to the B<VFiler> block will be used instead.
3502 Optional
3504 Type: string
3506 Default: name of the B<VFiler> block
3508 B<Note:> This option may only be used inside B<VFiler> blocks.
3510 =item B<Interval> I<Interval>
3512 B<TODO>
3514 =back
3516 The following options decide what kind of data will be collected. You can
3517 either use them as a block and fine tune various parameters inside this block,
3518 use them as a single statement to just accept all default values, or omit it to
3519 not collect any data.
3521 The following options are valid inside all blocks:
3523 =over 4
3525 =item B<Interval> I<Seconds>
3527 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3528 host specific setting.
3530 =back
3532 =head3 The System block
3534 This will collect various performance data about the whole system.
3536 B<Note:> To get this data the collectd user needs the
3537 "api-perf-object-get-instances" capability.
3539 =over 4
3541 =item B<Interval> I<Seconds>
3543 Collect disk statistics every I<Seconds> seconds.
3545 =item B<GetCPULoad> B<true>|B<false>
3547 If you set this option to true the current CPU usage will be read. This will be
3548 the average usage between all CPUs in your NetApp without any information about
3549 individual CPUs.
3551 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3552 returns in the "CPU" field.
3554 Optional
3556 Type: boolean
3558 Default: true
3560 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3562 =item B<GetInterfaces> B<true>|B<false>
3564 If you set this option to true the current traffic of the network interfaces
3565 will be read. This will be the total traffic over all interfaces of your NetApp
3566 without any information about individual interfaces.
3568 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3569 in the "Net kB/s" field.
3571 B<Or is it?>
3573 Optional
3575 Type: boolean
3577 Default: true
3579 Result: One value list of type "if_octects".
3581 =item B<GetDiskIO> B<true>|B<false>
3583 If you set this option to true the current IO throughput will be read. This
3584 will be the total IO of your NetApp without any information about individual
3585 disks, volumes or aggregates.
3587 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3588 in the "DiskE<nbsp>kB/s" field.
3590 Optional
3592 Type: boolean
3594 Default: true
3596 Result: One value list of type "disk_octets".
3598 =item B<GetDiskOps> B<true>|B<false>
3600 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3601 iSCSI, etc. operations will be read. This will be the total number of
3602 operations on your NetApp without any information about individual volumes or
3603 aggregates.
3605 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3606 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3608 Optional
3610 Type: boolean
3612 Default: true
3614 Result: A variable number of value lists of type "disk_ops_complex". Each type
3615 of operation will result in one value list with the name of the operation as
3616 type instance.
3618 =back
3620 =head3 The WAFL block
3622 This will collect various performance data about the WAFL file system. At the
3623 moment this just means cache performance.
3625 B<Note:> To get this data the collectd user needs the
3626 "api-perf-object-get-instances" capability.
3628 B<Note:> The interface to get these values is classified as "Diagnostics" by
3629 NetApp. This means that it is not guaranteed to be stable even between minor
3630 releases.
3632 =over 4
3634 =item B<Interval> I<Seconds>
3636 Collect disk statistics every I<Seconds> seconds.
3638 =item B<GetNameCache> B<true>|B<false>
3640 Optional
3642 Type: boolean
3644 Default: true
3646 Result: One value list of type "cache_ratio" and type instance
3647 "name_cache_hit".
3649 =item B<GetDirCache> B<true>|B<false>
3651 Optional
3653 Type: boolean
3655 Default: true
3657 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3659 =item B<GetInodeCache> B<true>|B<false>
3661 Optional
3663 Type: boolean
3665 Default: true
3667 Result: One value list of type "cache_ratio" and type instance
3668 "inode_cache_hit".
3670 =item B<GetBufferCache> B<true>|B<false>
3672 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3673 in the "Cache hit" field.
3675 Optional
3677 Type: boolean
3679 Default: true
3681 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3683 =back
3685 =head3 The Disks block
3687 This will collect performance data about the individual disks in the NetApp.
3689 B<Note:> To get this data the collectd user needs the
3690 "api-perf-object-get-instances" capability.
3692 =over 4
3694 =item B<Interval> I<Seconds>
3696 Collect disk statistics every I<Seconds> seconds.
3698 =item B<GetBusy> B<true>|B<false>
3700 If you set this option to true the busy time of all disks will be calculated
3701 and the value of the busiest disk in the system will be written.
3703 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3704 in the "Disk util" field. Probably.
3706 Optional
3708 Type: boolean
3710 Default: true
3712 Result: One value list of type "percent" and type instance "disk_busy".
3714 =back
3716 =head3 The VolumePerf block
3718 This will collect various performance data about the individual volumes.
3720 You can select which data to collect about which volume using the following
3721 options. They follow the standard ignorelist semantic.
3723 B<Note:> To get this data the collectd user needs the
3724 I<api-perf-object-get-instances> capability.
3726 =over 4
3728 =item B<Interval> I<Seconds>
3730 Collect volume performance data every I<Seconds> seconds.
3732 =item B<GetIO> I<Volume>
3734 =item B<GetOps> I<Volume>
3736 =item B<GetLatency> I<Volume>
3738 Select the given volume for IO, operations or latency statistics collection.
3739 The argument is the name of the volume without the C</vol/> prefix.
3741 Since the standard ignorelist functionality is used here, you can use a string
3742 starting and ending with a slash to specify regular expression matching: To
3743 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3744 expression:
3746 GetIO "/^vol[027]$/"
3748 If no regular expression is specified, an exact match is required. Both,
3749 regular and exact matching are case sensitive.
3751 If no volume was specified at all for either of the three options, that data
3752 will be collected for all available volumes.
3754 =item B<IgnoreSelectedIO> B<true>|B<false>
3756 =item B<IgnoreSelectedOps> B<true>|B<false>
3758 =item B<IgnoreSelectedLatency> B<true>|B<false>
3760 When set to B<true>, the volumes selected for IO, operations or latency
3761 statistics collection will be ignored and the data will be collected for all
3762 other volumes.
3764 When set to B<false>, data will only be collected for the specified volumes and
3765 all other volumes will be ignored.
3767 If no volumes have been specified with the above B<Get*> options, all volumes
3768 will be collected regardless of the B<IgnoreSelected*> option.
3770 Defaults to B<false>
3772 =back
3774 =head3 The VolumeUsage block
3776 This will collect capacity data about the individual volumes.
3778 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3779 capability.
3781 =over 4
3783 =item B<Interval> I<Seconds>
3785 Collect volume usage statistics every I<Seconds> seconds.
3787 =item B<GetCapacity> I<VolumeName>
3789 The current capacity of the volume will be collected. This will result in two
3790 to four value lists, depending on the configuration of the volume. All data
3791 sources are of type "df_complex" with the name of the volume as
3792 plugin_instance.
3794 There will be type_instances "used" and "free" for the number of used and
3795 available bytes on the volume. If the volume has some space reserved for
3796 snapshots, a type_instance "snap_reserved" will be available. If the volume
3797 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3798 number of bytes saved by the SIS feature.
3800 B<Note:> The current NetApp API has a bug that results in this value being
3801 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3802 number which works most of the time. If you see strange values here, bug
3803 NetApp support to fix this.
3805 Repeat this option to specify multiple volumes.
3807 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3809 Specify whether to collect only the volumes selected by the B<GetCapacity>
3810 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3811 B<false>. However, if no B<GetCapacity> option is specified at all, all
3812 capacities will be selected anyway.
3814 =item B<GetSnapshot> I<VolumeName>
3816 Select volumes from which to collect snapshot information.
3818 Usually, the space used for snapshots is included in the space reported as
3819 "used". If snapshot information is collected as well, the space used for
3820 snapshots is subtracted from the used space.
3822 To make things even more interesting, it is possible to reserve space to be
3823 used for snapshots. If the space required for snapshots is less than that
3824 reserved space, there is "reserved free" and "reserved used" space in addition
3825 to "free" and "used". If the space required for snapshots exceeds the reserved
3826 space, that part allocated in the normal space is subtracted from the "used"
3827 space again.
3829 Repeat this option to specify multiple volumes.
3831 =item B<IgnoreSelectedSnapshot>
3833 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3834 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3835 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3836 capacities will be selected anyway.
3838 =back
3840 =head3 The Quota block
3842 This will collect (tree) quota statistics (used disk space and number of used
3843 files). This mechanism is useful to get usage information for single qtrees.
3844 In case the quotas are not used for any other purpose, an entry similar to the
3845 following in C</etc/quotas> would be sufficient:
3847 /vol/volA/some_qtree tree - - - - -
3849 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3851 =over 4
3853 =item B<Interval> I<Seconds>
3855 Collect SnapVault(R) statistics every I<Seconds> seconds.
3857 =back
3859 =head3 The SnapVault block
3861 This will collect statistics about the time and traffic of SnapVault(R)
3862 transfers.
3864 =over 4
3866 =item B<Interval> I<Seconds>
3868 Collect SnapVault(R) statistics every I<Seconds> seconds.
3870 =back
3872 =head2 Plugin C<netlink>
3874 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3875 statistics of various interface and routing aspects.
3877 =over 4
3879 =item B<Interface> I<Interface>
3881 =item B<VerboseInterface> I<Interface>
3883 Instruct the plugin to collect interface statistics. This is basically the same
3884 as the statistics provided by the C<interface> plugin (see above) but
3885 potentially much more detailed.
3887 When configuring with B<Interface> only the basic statistics will be collected,
3888 namely octets, packets, and errors. These statistics are collected by
3889 the C<interface> plugin, too, so using both at the same time is no benefit.
3891 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3892 so that no data needs to be collected twice if you use the C<interface> plugin.
3893 This includes dropped packets, received multicast packets, collisions and a
3894 whole zoo of differentiated RX and TX errors. You can try the following command
3895 to get an idea of what awaits you:
3897 ip -s -s link list
3899 If I<Interface> is B<All>, all interfaces will be selected.
3901 =item B<QDisc> I<Interface> [I<QDisc>]
3903 =item B<Class> I<Interface> [I<Class>]
3905 =item B<Filter> I<Interface> [I<Filter>]
3907 Collect the octets and packets that pass a certain qdisc, class or filter.
3909 QDiscs and classes are identified by their type and handle (or classid).
3910 Filters don't necessarily have a handle, therefore the parent's handle is used.
3911 The notation used in collectd differs from that used in tc(1) in that it
3912 doesn't skip the major or minor number if it's zero and doesn't print special
3913 ids by their name. So, for example, a qdisc may be identified by
3914 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3915 thus not displayed by tc(1).
3917 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3918 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3919 associated with that interface will be collected.
3921 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3922 used. This may lead to problems when more than one filter is attached to a
3923 qdisc or class. This isn't nice, but we don't know how this could be done any
3924 better. If you have a idea, please don't hesitate to tell us.
3926 As with the B<Interface> option you can specify B<All> as the interface,
3927 meaning all interfaces.
3929 Here are some examples to help you understand the above text more easily:
3931 <Plugin netlink>
3932 VerboseInterface "All"
3933 QDisc "eth0" "pfifo_fast-1:0"
3934 QDisc "ppp0"
3935 Class "ppp0" "htb-1:10"
3936 Filter "ppp0" "u32-1:0"
3937 </Plugin>
3939 =item B<IgnoreSelected>
3941 The behavior is the same as with all other similar plugins: If nothing is
3942 selected at all, everything is collected. If some things are selected using the
3943 options described above, only these statistics are collected. If you set
3944 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3945 specified statistics will not be collected.
3947 =back
3949 =head2 Plugin C<network>
3951 The Network plugin sends data to a remote instance of collectd, receives data
3952 from a remote instance, or both at the same time. Data which has been received
3953 from the network is usually not transmitted again, but this can be activated, see
3954 the B<Forward> option below.
3956 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3957 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3959 Both, B<Server> and B<Listen> can be used as single option or as block. When
3960 used as block, given options are valid for this socket only. The following
3961 example will export the metrics twice: Once to an "internal" server (without
3962 encryption and signing) and one to an external server (with cryptographic
3963 signature):
3965 <Plugin "network">
3966 # Export to an internal server
3967 # (demonstrates usage without additional options)
3968 Server "collectd.internal.tld"
3970 # Export to an external server
3971 # (demonstrates usage with signature options)
3972 <Server "collectd.external.tld">
3973 SecurityLevel "sign"
3974 Username "myhostname"
3975 Password "ohl0eQue"
3976 </Server>
3977 </Plugin>
3979 =over 4
3981 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3983 The B<Server> statement/block sets the server to send datagrams to. The
3984 statement may occur multiple times to send each datagram to multiple
3985 destinations.
3987 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3988 optional second argument specifies a port number or a service name. If not
3989 given, the default, B<25826>, is used.
3991 The following options are recognized within B<Server> blocks:
3993 =over 4
3995 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3997 Set the security you require for network communication. When the security level
3998 has been set to B<Encrypt>, data sent over the network will be encrypted using
3999 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4000 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4001 authentication code. When set to B<None>, data is sent without any security.
4003 This feature is only available if the I<network> plugin was linked with
4004 I<libgcrypt>.
4006 =item B<Username> I<Username>
4008 Sets the username to transmit. This is used by the server to lookup the
4009 password. See B<AuthFile> below. All security levels except B<None> require
4010 this setting.
4012 This feature is only available if the I<network> plugin was linked with
4013 I<libgcrypt>.
4015 =item B<Password> I<Password>
4017 Sets a password (shared secret) for this socket. All security levels except
4018 B<None> require this setting.
4020 This feature is only available if the I<network> plugin was linked with
4021 I<libgcrypt>.
4023 =item B<Interface> I<Interface name>
4025 Set the outgoing interface for IP packets. This applies at least
4026 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4027 undefined or a non-existent interface name is specified, the default
4028 behavior is to let the kernel choose the appropriate interface. Be warned
4029 that the manual selection of an interface for unicast traffic is only
4030 necessary in rare cases.
4032 =item B<ResolveInterval> I<Seconds>
4034 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4035 useful to force a regular DNS lookup to support a high availability setup. If
4036 not specified, re-resolves are never attempted.
4038 =back
4040 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4042 The B<Listen> statement sets the interfaces to bind to. When multiple
4043 statements are found the daemon will bind to multiple interfaces.
4045 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4046 the argument is a multicast address the daemon will join that multicast group.
4047 The optional second argument specifies a port number or a service name. If not
4048 given, the default, B<25826>, is used.
4050 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4052 =over 4
4054 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4056 Set the security you require for network communication. When the security level
4057 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4058 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4059 signed and encrypted data is accepted. When set to B<None>, all data will be
4060 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4061 decrypted if possible.
4063 This feature is only available if the I<network> plugin was linked with
4064 I<libgcrypt>.
4066 =item B<AuthFile> I<Filename>
4068 Sets a file in which usernames are mapped to passwords. These passwords are
4069 used to verify signatures and to decrypt encrypted network packets. If
4070 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4071 verified and encrypted packets are decrypted. Otherwise, signed data is
4072 accepted without checking the signature and encrypted data cannot be decrypted.
4073 For the other security levels this option is mandatory.
4075 The file format is very simple: Each line consists of a username followed by a
4076 colon and any number of spaces followed by the password. To demonstrate, an
4077 example file could look like this:
4079 user0: foo
4080 user1: bar
4082 Each time a packet is received, the modification time of the file is checked
4083 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4084 the file is being read, it is locked using L<fcntl(2)>.
4086 =item B<Interface> I<Interface name>
4088 Set the incoming interface for IP packets explicitly. This applies at least
4089 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4090 undefined or a non-existent interface name is specified, the default
4091 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4092 traffic gets only accepted, if it arrives on the given interface.
4094 =back
4096 =item B<TimeToLive> I<1-255>
4098 Set the time-to-live of sent packets. This applies to all, unicast and
4099 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4100 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4101 operating systems.
4103 =item B<MaxPacketSize> I<1024-65535>
4105 Set the maximum size for datagrams received over the network. Packets larger
4106 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4107 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4108 UDP.
4110 On the server side, this limit should be set to the largest value used on
4111 I<any> client. Likewise, the value on the client must not be larger than the
4112 value on the server, or data will be lost.
4114 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4115 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4116 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4117 server.
4119 =item B<Forward> I<true|false>
4121 If set to I<true>, write packets that were received via the network plugin to
4122 the sending sockets. This should only be activated when the B<Listen>- and
4123 B<Server>-statements differ. Otherwise packets may be send multiple times to
4124 the same multicast group. While this results in more network traffic than
4125 necessary it's not a huge problem since the plugin has a duplicate detection,
4126 so the values will not loop.
4128 =item B<ReportStats> B<true>|B<false>
4130 The network plugin cannot only receive and send statistics, it can also create
4131 statistics about itself. Collected data included the number of received and
4132 sent octets and packets, the length of the receive queue and the number of
4133 values handled. When set to B<true>, the I<Network plugin> will make these
4134 statistics available. Defaults to B<false>.
4136 =back
4138 =head2 Plugin C<nginx>
4140 This plugin collects the number of connections and requests handled by the
4141 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4142 queries the page provided by the C<ngx_http_stub_status_module> module, which
4143 isn't compiled by default. Please refer to
4144 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4145 how to compile and configure nginx and this module.
4147 The following options are accepted by the C<nginx plugin>:
4149 =over 4
4151 =item B<URL> I<http://host/nginx_status>
4153 Sets the URL of the C<ngx_http_stub_status_module> output.
4155 =item B<User> I<Username>
4157 Optional user name needed for authentication.
4159 =item B<Password> I<Password>
4161 Optional password needed for authentication.
4163 =item B<VerifyPeer> B<true|false>
4165 Enable or disable peer SSL certificate verification. See
4166 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4168 =item B<VerifyHost> B<true|false>
4170 Enable or disable peer host name verification. If enabled, the plugin checks
4171 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4172 certificate matches the host name provided by the B<URL> option. If this
4173 identity check fails, the connection is aborted. Obviously, only works when
4174 connecting to a SSL enabled server. Enabled by default.
4176 =item B<CACert> I<File>
4178 File that holds one or more SSL certificates. If you want to use HTTPS you will
4179 possibly need this option. What CA certificates come bundled with C<libcurl>
4180 and are checked by default depends on the distribution you use.
4182 =item B<Timeout> I<Milliseconds>
4184 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4185 milliseconds. By default, the configured B<Interval> is used to set the
4186 timeout.
4188 =back
4190 =head2 Plugin C<notify_desktop>
4192 This plugin sends a desktop notification to a notification daemon, as defined
4193 in the Desktop Notification Specification. To actually display the
4194 notifications, B<notification-daemon> is required and B<collectd> has to be
4195 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4196 environment variables have to be set correctly) and the D-Bus message bus.
4198 The Desktop Notification Specification can be found at
4199 L<http://www.galago-project.org/specs/notification/>.
4201 =over 4
4203 =item B<OkayTimeout> I<timeout>
4205 =item B<WarningTimeout> I<timeout>
4207 =item B<FailureTimeout> I<timeout>
4209 Set the I<timeout>, in milliseconds, after which to expire the notification
4210 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4211 been specified, the displayed notification will not be closed at all - the
4212 user has to do so herself. These options default to 5000. If a negative number
4213 has been specified, the default is used as well.
4215 =back
4217 =head2 Plugin C<notify_email>
4219 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4220 configured email address.
4222 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4224 Available configuration options:
4226 =over 4
4228 =item B<From> I<Address>
4230 Email address from which the emails should appear to come from.
4232 Default: C<root@localhost>
4234 =item B<Recipient> I<Address>
4236 Configures the email address(es) to which the notifications should be mailed.
4237 May be repeated to send notifications to multiple addresses.
4239 At least one B<Recipient> must be present for the plugin to work correctly.
4241 =item B<SMTPServer> I<Hostname>
4243 Hostname of the SMTP server to connect to.
4245 Default: C<localhost>
4247 =item B<SMTPPort> I<Port>
4249 TCP port to connect to.
4251 Default: C<25>
4253 =item B<SMTPUser> I<Username>
4255 Username for ASMTP authentication. Optional.
4257 =item B<SMTPPassword> I<Password>
4259 Password for ASMTP authentication. Optional.
4261 =item B<Subject> I<Subject>
4263 Subject-template to use when sending emails. There must be exactly two
4264 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4265 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4266 with the hostname.
4268 Default: C<Collectd notify: %s@%s>
4270 =back
4272 =head2 Plugin C<ntpd>
4274 =over 4
4276 =item B<Host> I<Hostname>
4278 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4280 =item B<Port> I<Port>
4282 UDP-Port to connect to. Defaults to B<123>.
4284 =item B<ReverseLookups> B<true>|B<false>
4286 Sets whether or not to perform reverse lookups on peers. Since the name or
4287 IP-address may be used in a filename it is recommended to disable reverse
4288 lookups. The default is to do reverse lookups to preserve backwards
4289 compatibility, though.
4291 =item B<IncludeUnitID> B<true>|B<false>
4293 When a peer is a refclock, include the unit ID in the I<type instance>.
4294 Defaults to B<false> for backward compatibility.
4296 If two refclock peers use the same driver and this is B<false>, the plugin will
4297 try to write simultaneous measurements from both to the same type instance.
4298 This will result in error messages in the log and only one set of measurements
4299 making it through.
4301 =back
4303 =head2 Plugin C<nut>
4305 =over 4
4307 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4309 Add a UPS to collect data from. The format is identical to the one accepted by
4310 L<upsc(8)>.
4312 =back
4314 =head2 Plugin C<olsrd>
4316 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4317 the Optimized Link State Routing daemon and reads information about the current
4318 state of the meshed network.
4320 The following configuration options are understood:
4322 =over 4
4324 =item B<Host> I<Host>
4326 Connect to I<Host>. Defaults to B<"localhost">.
4328 =item B<Port> I<Port>
4330 Specifies the port to connect to. This must be a string, even if you give the
4331 port as a number rather than a service name. Defaults to B<"2006">.
4333 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4335 Specifies what information to collect about links, i.E<nbsp>e. direct
4336 connections of the daemon queried. If set to B<No>, no information is
4337 collected. If set to B<Summary>, the number of links and the average of all
4338 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4339 If set to B<Detail> LQ and NLQ are collected per link.
4341 Defaults to B<Detail>.
4343 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4345 Specifies what information to collect about routes of the daemon queried. If
4346 set to B<No>, no information is collected. If set to B<Summary>, the number of
4347 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4348 metric and ETX are collected per route.
4350 Defaults to B<Summary>.
4352 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4354 Specifies what information to collect about the global topology. If set to
4355 B<No>, no information is collected. If set to B<Summary>, the number of links
4356 in the entire topology and the average I<link quality> (LQ) is calculated.
4357 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4359 Defaults to B<Summary>.
4361 =back
4363 =head2 Plugin C<onewire>
4365 B<EXPERIMENTAL!> See notes below.
4367 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4368 L<http://owfs.org/> to read sensors connected via the onewire bus.
4370 It can be used in two possible modes - standard or advanced.
4372 In the standard mode only temperature sensors (sensors with the family code
4373 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4374 other sensors you would like to have included, please send a sort request to
4375 the mailing list. You can select sensors to be read or to be ignored depending
4376 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4377 walked and all sensors are read.
4379 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4380 experimental, below.
4382 In the advanced mode you can configure any sensor to be read (only numerical
4383 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4384 In this mode you have to list all the sensors. Neither default bus walk nor
4385 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4386 the path automatically and should produce compatible structure with the "standard"
4387 mode (basically the path is expected as for example
4388 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4389 "F10FCA000800" and the rest after the slash is considered the type - here
4390 "temperature").
4391 There are two advantages to this mode - you can access virtually any sensor
4392 (not just temperature), select whether to use cached or directly read values
4393 and it is slighlty faster. The downside is more complex configuration.
4395 The two modes are distinguished automatically by the format of the address.
4396 It is not possible to mix the two modes. Once a full path is detected in any
4397 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4398 (and as standard addresses will fail parsing they will be ignored).
4400 =over 4
4402 =item B<Device> I<Device>
4404 Sets the device to read the values from. This can either be a "real" hardware
4405 device, such as a serial port or an USB port, or the address of the
4406 L<owserver(1)> socket, usually B<localhost:4304>.
4408 Though the documentation claims to automatically recognize the given address
4409 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4410 with that version, the following configuration worked for us:
4412 <Plugin onewire>
4413 Device "-s localhost:4304"
4414 </Plugin>
4416 This directive is B<required> and does not have a default value.
4418 =item B<Sensor> I<Sensor>
4420 In the standard mode selects sensors to collect or to ignore
4421 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4422 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4423 and B<not> include the leading C<10.> family byte and point.
4424 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4425 sensors (see above) are read.
4427 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4428 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4429 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4431 As there can be multiple devices on the bus you can list multiple sensor (use
4432 multiple B<Sensor> elements).
4434 =item B<IgnoreSelected> I<true>|I<false>
4436 If no configuration is given, the B<onewire> plugin will collect data from all
4437 sensors found. This may not be practical, especially if sensors are added and
4438 removed regularly. Sometimes, however, it's easier/preferred to collect only
4439 specific sensors or all sensors I<except> a few specified ones. This option
4440 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4441 B<Sensor> is inverted: All selected interfaces are ignored and all other
4442 interfaces are collected.
4444 Used only in the standard mode - see above.
4446 =item B<Interval> I<Seconds>
4448 Sets the interval in which all sensors should be read. If not specified, the
4449 global B<Interval> setting is used.
4451 =back
4453 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4454 work with big setups. It works with one sensor being attached to one
4455 controller, but as soon as you throw in a couple more senors and maybe a hub
4456 or two, reading all values will take more than ten seconds (the default
4457 interval). We will probably add some separate thread for reading the sensors
4458 and some cache or something like that, but it's not done yet. We will try to
4459 maintain backwards compatibility in the future, but we can't promise. So in
4460 short: If it works for you: Great! But keep in mind that the config I<might>
4461 change, though this is unlikely. Oh, and if you want to help improving this
4462 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4464 =head2 Plugin C<openldap>
4466 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4467 server correctly. The backend database C<monitor> needs to be loaded and
4468 working. See slapd-monitor(5) for the details.
4470 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4471 blocks. Each block requires one string argument as the instance name. For
4472 example:
4474 <Plugin "openldap">
4475 <Instance "foo">
4476 URL "ldap://localhost/"
4477 </Instance>
4478 <Instance "bar">
4479 URL "ldaps://localhost/"
4480 </Instance>
4481 </Plugin>
4483 The instance name will be used as the I<plugin instance>. To emulate the old
4484 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4485 plugin to work correctly, each instance name must be unique. This is not
4486 enforced by the plugin and it is your responsibility to ensure it is.
4488 The following options are accepted within each B<Instance> block:
4490 =over 4
4492 =item B<URL> I<ldap://host/binddn>
4494 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4495 I<mandatory>.
4497 =item B<StartTLS> B<true|false>
4499 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4500 Disabled by default.
4502 =item B<VerifyHost> B<true|false>
4504 Enables or disables peer host name verification. If enabled, the plugin checks
4505 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4506 certificate matches the host name provided by the B<URL> option. If this
4507 identity check fails, the connection is aborted. Enabled by default.
4509 =item B<CACert> I<File>
4511 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4512 may possibly need this option. What CA certificates are checked by default
4513 depends on the distribution you use and can be changed with the usual ldap
4514 client configuration mechanisms. See ldap.conf(5) for the details.
4516 =item B<Timeout> I<Seconds>
4518 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4519 an infinite timeout.
4521 =item B<Version> I<Version>
4523 An integer which sets the LDAP protocol version number to use when connecting
4524 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4526 =back
4528 =head2 Plugin C<openvpn>
4530 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4531 traffic statistics about connected clients.
4533 To set up OpenVPN to write to the status file periodically, use the
4534 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4535 you need to set the required format, too. This is done by setting
4536 B<--status-version> to B<2>.
4538 So, in a nutshell you need:
4540 openvpn $OTHER_OPTIONS \
4541 --status "/var/run/openvpn-status" 10 \
4542 --status-version 2
4544 Available options:
4546 =over 4
4548 =item B<StatusFile> I<File>
4550 Specifies the location of the status file.
4552 =item B<ImprovedNamingSchema> B<true>|B<false>
4554 When enabled, the filename of the status file will be used as plugin instance
4555 and the client's "common name" will be used as type instance. This is required
4556 when reading multiple status files. Enabling this option is recommended, but to
4557 maintain backwards compatibility this option is disabled by default.
4559 =item B<CollectCompression> B<true>|B<false>
4561 Sets whether or not statistics about the compression used by OpenVPN should be
4562 collected. This information is only available in I<single> mode. Enabled by
4563 default.
4565 =item B<CollectIndividualUsers> B<true>|B<false>
4567 Sets whether or not traffic information is collected for each connected client
4568 individually. If set to false, currently no traffic data is collected at all
4569 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4571 =item B<CollectUserCount> B<true>|B<false>
4573 When enabled, the number of currently connected clients or users is collected.
4574 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4575 can be configured independently from that option. Defaults to B<false>.
4577 =back
4579 =head2 Plugin C<oracle>
4581 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4582 Oracle® Database and lets you execute SQL statements there. It is very similar
4583 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4584 plugin's documentation above for details.
4586 <Plugin oracle>
4587 <Query "out_of_stock">
4588 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4589 <Result>
4590 Type "gauge"
4591 # InstancePrefix "foo"
4592 InstancesFrom "category"
4593 ValuesFrom "value"
4594 </Result>
4595 </Query>
4596 <Database "product_information">
4597 ConnectID "db01"
4598 Username "oracle"
4599 Password "secret"
4600 Query "out_of_stock"
4601 </Database>
4602 </Plugin>
4604 =head3 B<Query> blocks
4606 The Query blocks are handled identically to the Query blocks of the "dbi"
4607 plugin. Please see its documentation above for details on how to specify
4608 queries.
4610 =head3 B<Database> blocks
4612 Database blocks define a connection to a database and which queries should be
4613 sent to that database. Each database needs a "name" as string argument in the
4614 starting tag of the block. This name will be used as "PluginInstance" in the
4615 values submitted to the daemon. Other than that, that name is not used.
4617 =over 4
4619 =item B<ConnectID> I<ID>
4621 Defines the "database alias" or "service name" to connect to. Usually, these
4622 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4624 =item B<Host> I<Host>
4626 Hostname to use when dispatching values for this database. Defaults to using
4627 the global hostname of the I<collectd> instance.
4629 =item B<Username> I<Username>
4631 Username used for authentication.
4633 =item B<Password> I<Password>
4635 Password used for authentication.
4637 =item B<Query> I<QueryName>
4639 Associates the query named I<QueryName> with this database connection. The
4640 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4641 blocks you want to refer to must be placed above the database block you want to
4642 refer to them from.
4644 =back
4646 =head2 Plugin C<perl>
4648 This plugin embeds a Perl-interpreter into collectd and provides an interface
4649 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4651 =head2 Plugin C<pinba>
4653 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4654 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4655 PHP-based webpage has been delivered, the extension will send a UDP packet
4656 containing timing information, peak memory usage and so on. The plugin will
4657 wait for such packets, parse them and account the provided information, which
4658 is then dispatched to the daemon once per interval.
4660 Synopsis:
4662 <Plugin pinba>
4663 Address "::0"
4664 Port "30002"
4665 # Overall statistics for the website.
4666 <View "www-total">
4667 Server "www.example.com"
4668 </View>
4669 # Statistics for www-a only
4670 <View "www-a">
4671 Host "www-a.example.com"
4672 Server "www.example.com"
4673 </View>
4674 # Statistics for www-b only
4675 <View "www-b">
4676 Host "www-b.example.com"
4677 Server "www.example.com"
4678 </View>
4679 </Plugin>
4681 The plugin provides the following configuration options:
4683 =over 4
4685 =item B<Address> I<Node>
4687 Configures the address used to open a listening socket. By default, plugin will
4688 bind to the I<any> address C<::0>.
4690 =item B<Port> I<Service>
4692 Configures the port (service) to bind to. By default the default Pinba port
4693 "30002" will be used. The option accepts service names in addition to port
4694 numbers and thus requires a I<string> argument.
4696 =item E<lt>B<View> I<Name>E<gt> block
4698 The packets sent by the Pinba extension include the hostname of the server, the
4699 server name (the name of the virtual host) and the script that was executed.
4700 Using B<View> blocks it is possible to separate the data into multiple groups
4701 to get more meaningful statistics. Each packet is added to all matching groups,
4702 so that a packet may be accounted for more than once.
4704 =over 4
4706 =item B<Host> I<Host>
4708 Matches the hostname of the system the webserver / script is running on. This
4709 will contain the result of the L<gethostname(2)> system call. If not
4710 configured, all hostnames will be accepted.
4712 =item B<Server> I<Server>
4714 Matches the name of the I<virtual host>, i.e. the contents of the
4715 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4716 server names will be accepted.
4718 =item B<Script> I<Script>
4720 Matches the name of the I<script name>, i.e. the contents of the
4721 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4722 script names will be accepted.
4724 =back
4726 =back
4728 =head2 Plugin C<ping>
4730 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4731 configured hosts periodically and measures the network latency. Whenever the
4732 C<read> function of the plugin is called, it submits the average latency, the
4733 standard deviation and the drop rate for each host.
4735 Available configuration options:
4737 =over 4
4739 =item B<Host> I<IP-address>
4741 Host to ping periodically. This option may be repeated several times to ping
4742 multiple hosts.
4744 =item B<Interval> I<Seconds>
4746 Sets the interval in which to send ICMP echo packets to the configured hosts.
4747 This is B<not> the interval in which statistics are queries from the plugin but
4748 the interval in which the hosts are "pinged". Therefore, the setting here
4749 should be smaller than or equal to the global B<Interval> setting. Fractional
4750 times, such as "1.24" are allowed.
4752 Default: B<1.0>
4754 =item B<Timeout> I<Seconds>
4756 Time to wait for a response from the host to which an ICMP packet had been
4757 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4758 to be down or the packet to be dropped. This setting must be smaller than the
4759 B<Interval> setting above for the plugin to work correctly. Fractional
4760 arguments are accepted.
4762 Default: B<0.9>
4764 =item B<TTL> I<0-255>
4766 Sets the Time-To-Live of generated ICMP packets.
4768 =item B<SourceAddress> I<host>
4770 Sets the source address to use. I<host> may either be a numerical network
4771 address or a network hostname.
4773 =item B<Device> I<name>
4775 Sets the outgoing network device to be used. I<name> has to specify an
4776 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4777 operating systems.
4779 =item B<MaxMissed> I<Packets>
4781 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4782 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4784 Default: B<-1> (disabled)
4786 =back
4788 =head2 Plugin C<postgresql>
4790 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4791 keeps a persistent connection to all configured databases and tries to
4792 reconnect if the connection has been interrupted. A database is configured by
4793 specifying a B<Database> block as described below. The default statistics are
4794 collected from PostgreSQL's B<statistics collector> which thus has to be
4795 enabled for this plugin to work correctly. This should usually be the case by
4796 default. See the section "The Statistics Collector" of the B<PostgreSQL
4797 Documentation> for details.
4799 By specifying custom database queries using a B<Query> block as described
4800 below, you may collect any data that is available from some PostgreSQL
4801 database. This way, you are able to access statistics of external daemons
4802 which are available in a PostgreSQL database or use future or special
4803 statistics provided by PostgreSQL without the need to upgrade your collectd
4804 installation.
4806 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4807 PostgreSQL databases as well. This has been implemented in a generic way. You
4808 need to specify an SQL statement which will then be executed by collectd in
4809 order to write the data (see below for details). The benefit of that approach
4810 is that there is no fixed database layout. Rather, the layout may be optimized
4811 for the current setup.
4813 The B<PostgreSQL Documentation> manual can be found at
4814 L<http://www.postgresql.org/docs/manuals/>.
4816 <Plugin postgresql>
4817 <Query magic>
4818 Statement "SELECT magic FROM wizard WHERE host = $1;"
4819 Param hostname
4820 <Result>
4821 Type gauge
4822 InstancePrefix "magic"
4823 ValuesFrom magic
4824 </Result>
4825 </Query>
4827 <Query rt36_tickets>
4828 Statement "SELECT COUNT(type) AS count, type \
4829 FROM (SELECT CASE \
4830 WHEN resolved = 'epoch' THEN 'open' \
4831 ELSE 'resolved' END AS type \
4832 FROM tickets) type \
4833 GROUP BY type;"
4834 <Result>
4835 Type counter
4836 InstancePrefix "rt36_tickets"
4837 InstancesFrom "type"
4838 ValuesFrom "count"
4839 </Result>
4840 </Query>
4842 <Writer sqlstore>
4843 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4844 StoreRates true
4845 </Writer>
4847 <Database foo>
4848 Host "hostname"
4849 Port "5432"
4850 User "username"
4851 Password "secret"
4852 SSLMode "prefer"
4853 KRBSrvName "kerberos_service_name"
4854 Query magic
4855 </Database>
4857 <Database bar>
4858 Interval 300
4859 Service "service_name"
4860 Query backend # predefined
4861 Query rt36_tickets
4862 </Database>
4864 <Database qux>
4865 # ...
4866 Writer sqlstore
4867 CommitInterval 10
4868 </Database>
4869 </Plugin>
4871 The B<Query> block defines one database query which may later be used by a
4872 database definition. It accepts a single mandatory argument which specifies
4873 the name of the query. The names of all queries have to be unique (see the
4874 B<MinVersion> and B<MaxVersion> options below for an exception to this
4875 rule). The following configuration options are available to define the query:
4877 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4878 blocks define how to handle the values returned from the query. They define
4879 which column holds which value and how to dispatch that value to the daemon.
4880 Multiple B<Result> blocks may be used to extract multiple values from a single
4881 query.
4883 =over 4
4885 =item B<Statement> I<sql query statement>
4887 Specify the I<sql query statement> which the plugin should execute. The string
4888 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4889 first, second, etc. parameter. The value of the parameters is specified by the
4890 B<Param> configuration option - see below for details. To include a literal
4891 B<$> character followed by a number, surround it with single quotes (B<'>).
4893 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4894 allowed. Note, however, that only a single command may be used. Semicolons are
4895 allowed as long as a single non-empty command has been specified only.
4897 The returned lines will be handled separately one after another.
4899 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4901 Specify the parameters which should be passed to the SQL query. The parameters
4902 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4903 they appear in the configuration file. The value of the parameter is
4904 determined depending on the value of the B<Param> option as follows:
4906 =over 4
4908 =item I<hostname>
4910 The configured hostname of the database connection. If a UNIX domain socket is
4911 used, the parameter expands to "localhost".
4913 =item I<database>
4915 The name of the database of the current connection.
4917 =item I<instance>
4919 The name of the database plugin instance. See the B<Instance> option of the
4920 database specification below for details.
4922 =item I<username>
4924 The username used to connect to the database.
4926 =item I<interval>
4928 The interval with which this database is queried (as specified by the database
4929 specific or global B<Interval> options).
4931 =back
4933 Please note that parameters are only supported by PostgreSQL's protocol
4934 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4936 =item B<Type> I<type>
4938 The I<type> name to be used when dispatching the values. The type describes
4939 how to handle the data and where to store it. See L<types.db(5)> for more
4940 details on types and their configuration. The number and type of values (as
4941 selected by the B<ValuesFrom> option) has to match the type of the given name.
4943 This option is required inside a B<Result> block.
4945 =item B<InstancePrefix> I<prefix>
4947 =item B<InstancesFrom> I<column0> [I<column1> ...]
4949 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4950 B<InstancePrefix> defines a static prefix that will be prepended to all type
4951 instances. B<InstancesFrom> defines the column names whose values will be used
4952 to create the type instance. Multiple values will be joined together using the
4953 hyphen (C<->) as separation character.
4955 The plugin itself does not check whether or not all built instances are
4956 different. It is your responsibility to assure that each is unique.
4958 Both options are optional. If none is specified, the type instance will be
4959 empty.
4961 =item B<ValuesFrom> I<column0> [I<column1> ...]
4963 Names the columns whose content is used as the actual data for the data sets
4964 that are dispatched to the daemon. How many such columns you need is
4965 determined by the B<Type> setting as explained above. If you specify too many
4966 or not enough columns, the plugin will complain about that and no data will be
4967 submitted to the daemon.
4969 The actual data type, as seen by PostgreSQL, is not that important as long as
4970 it represents numbers. The plugin will automatically cast the values to the
4971 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4972 L<strtod(3)> functions, so anything supported by those functions is supported
4973 by the plugin as well.
4975 This option is required inside a B<Result> block and may be specified multiple
4976 times. If multiple B<ValuesFrom> options are specified, the columns are read
4977 in the given order.
4979 =item B<MinVersion> I<version>
4981 =item B<MaxVersion> I<version>
4983 Specify the minimum or maximum version of PostgreSQL that this query should be
4984 used with. Some statistics might only be available with certain versions of
4985 PostgreSQL. This allows you to specify multiple queries with the same name but
4986 which apply to different versions, thus allowing you to use the same
4987 configuration in a heterogeneous environment.
4989 The I<version> has to be specified as the concatenation of the major, minor
4990 and patch-level versions, each represented as two-decimal-digit numbers. For
4991 example, version 8.2.3 will become 80203.
4993 =back
4995 The following predefined queries are available (the definitions can be found
4996 in the F<postgresql_default.conf> file which, by default, is available at
4997 C<I<prefix>/share/collectd/>):
4999 =over 4
5001 =item B<backends>
5003 This query collects the number of backends, i.E<nbsp>e. the number of
5004 connected clients.
5006 =item B<transactions>
5008 This query collects the numbers of committed and rolled-back transactions of
5009 the user tables.
5011 =item B<queries>
5013 This query collects the numbers of various table modifications (i.E<nbsp>e.
5014 insertions, updates, deletions) of the user tables.
5016 =item B<query_plans>
5018 This query collects the numbers of various table scans and returned tuples of
5019 the user tables.
5021 =item B<table_states>
5023 This query collects the numbers of live and dead rows in the user tables.
5025 =item B<disk_io>
5027 This query collects disk block access counts for user tables.
5029 =item B<disk_usage>
5031 This query collects the on-disk size of the database in bytes.
5033 =back
5035 In addition, the following detailed queries are available by default. Please
5036 note that each of those queries collects information B<by table>, thus,
5037 potentially producing B<a lot> of data. For details see the description of the
5038 non-by_table queries above.
5040 =over 4
5042 =item B<queries_by_table>
5044 =item B<query_plans_by_table>
5046 =item B<table_states_by_table>
5048 =item B<disk_io_by_table>
5050 =back
5052 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5053 mandatory argument specifying the name of the writer. This will then be used
5054 in the B<Database> specification in order to activate the writer instance. The
5055 names of all writers have to be unique. The following options may be
5056 specified:
5058 =over 4
5060 =item B<Statement> I<sql statement>
5062 This mandatory option specifies the SQL statement that will be executed for
5063 each submitted value. A single SQL statement is allowed only. Anything after
5064 the first semicolon will be ignored.
5066 Nine parameters will be passed to the statement and should be specified as
5067 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5068 values are made available through those parameters:
5070 =over 4
5072 =item B<$1>
5074 The timestamp of the queried value as a floating point number.
5076 =item B<$2>
5078 The hostname of the queried value.
5080 =item B<$3>
5082 The plugin name of the queried value.
5084 =item B<$4>
5086 The plugin instance of the queried value. This value may be B<NULL> if there
5087 is no plugin instance.
5089 =item B<$5>
5091 The type of the queried value (cf. L<types.db(5)>).
5093 =item B<$6>
5095 The type instance of the queried value. This value may be B<NULL> if there is
5096 no type instance.
5098 =item B<$7>
5100 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5101 sources of the submitted value-list).
5103 =item B<$8>
5105 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5106 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5107 B<StoreRates> is enabled (which is the default, see below), all types will be
5108 C<gauge>.
5110 =item B<$9>
5112 An array of the submitted values. The dimensions of the value name and value
5113 arrays match.
5115 =back
5117 In general, it is advisable to create and call a custom function in the
5118 PostgreSQL database for this purpose. Any procedural language supported by
5119 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5120 for details).
5122 =item B<StoreRates> B<false>|B<true>
5124 If set to B<true> (the default), convert counter values to rates. If set to
5125 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5126 number.
5128 =back
5130 The B<Database> block defines one PostgreSQL database for which to collect
5131 statistics. It accepts a single mandatory argument which specifies the
5132 database name. None of the other options are required. PostgreSQL will use
5133 default values as documented in the section "CONNECTING TO A DATABASE" in the
5134 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5135 the user collectd is run as and special environment variables. See the manpage
5136 for details.
5138 =over 4
5140 =item B<Interval> I<seconds>
5142 Specify the interval with which the database should be queried. The default is
5143 to use the global B<Interval> setting.
5145 =item B<CommitInterval> I<seconds>
5147 This option may be used for database connections which have "writers" assigned
5148 (see above). If specified, it causes a writer to put several updates into a
5149 single transaction. This transaction will last for the specified amount of
5150 time. By default, each update will be executed in a separate transaction. Each
5151 transaction generates a fair amount of overhead which can, thus, be reduced by
5152 activating this option. The draw-back is, that data covering the specified
5153 amount of time will be lost, for example, if a single statement within the
5154 transaction fails or if the database server crashes.
5156 =item B<Instance> I<name>
5158 Specify the plugin instance name that should be used instead of the database
5159 name (which is the default, if this option has not been specified). This
5160 allows to query multiple databases of the same name on the same host (e.g.
5161 when running multiple database server versions in parallel).
5163 =item B<Host> I<hostname>
5165 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5166 value begins with a slash, it is interpreted as the directory name in which to
5167 look for the UNIX domain socket.
5169 This option is also used to determine the hostname that is associated with a
5170 collected data set. If it has been omitted or either begins with with a slash
5171 or equals B<localhost> it will be replaced with the global hostname definition
5172 of collectd. Any other value will be passed literally to collectd when
5173 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5175 =item B<Port> I<port>
5177 Specify the TCP port or the local UNIX domain socket file extension of the
5178 server.
5180 =item B<User> I<username>
5182 Specify the username to be used when connecting to the server.
5184 =item B<Password> I<password>
5186 Specify the password to be used when connecting to the server.
5188 =item B<ExpireDelay> I<delay>
5190 Skip expired values in query output.
5192 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5194 Specify whether to use an SSL connection when contacting the server. The
5195 following modes are supported:
5197 =over 4
5199 =item I<disable>
5201 Do not use SSL at all.
5203 =item I<allow>
5205 First, try to connect without using SSL. If that fails, try using SSL.
5207 =item I<prefer> (default)
5209 First, try to connect using SSL. If that fails, try without using SSL.
5211 =item I<require>
5213 Use SSL only.
5215 =back
5217 =item B<Instance> I<name>
5219 Specify the plugin instance name that should be used instead of the database
5220 name (which is the default, if this option has not been specified). This
5221 allows to query multiple databases of the same name on the same host (e.g.
5222 when running multiple database server versions in parallel).
5224 =item B<KRBSrvName> I<kerberos_service_name>
5226 Specify the Kerberos service name to use when authenticating with Kerberos 5
5227 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5228 B<PostgreSQL Documentation> for details.
5230 =item B<Service> I<service_name>
5232 Specify the PostgreSQL service name to use for additional parameters. That
5233 service has to be defined in F<pg_service.conf> and holds additional
5234 connection parameters. See the section "The Connection Service File" in the
5235 B<PostgreSQL Documentation> for details.
5237 =item B<Query> I<query>
5239 Specifies a I<query> which should be executed in the context of the database
5240 connection. This may be any of the predefined or user-defined queries. If no
5241 such option is given, it defaults to "backends", "transactions", "queries",
5242 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5243 has been specified). Else, the specified queries are used only.
5245 =item B<Writer> I<writer>
5247 Assigns the specified I<writer> backend to the database connection. This
5248 causes all collected data to be send to the database using the settings
5249 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5250 below for details on how to selectively send data to certain plugins).
5252 Each writer will register a flush callback which may be used when having long
5253 transactions enabled (see the B<CommitInterval> option above). When issuing
5254 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5255 transaction will be committed right away. Two different kinds of flush
5256 callbacks are available with the C<postgresql> plugin:
5258 =over 4
5260 =item B<postgresql>
5262 Flush all writer backends.
5264 =item B<postgresql->I<database>
5266 Flush all writers of the specified I<database> only.
5268 =back
5270 =back
5272 =head2 Plugin C<powerdns>
5274 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5275 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5276 values, many of which are probably meaningless to most users, but may be useful
5277 for some. So you may chose which values to collect, but if you don't, some
5278 reasonable defaults will be collected.
5280 <Plugin "powerdns">
5281 <Server "server_name">
5282 Collect "latency"
5283 Collect "udp-answers" "udp-queries"
5284 Socket "/var/run/pdns.controlsocket"
5285 </Server>
5286 <Recursor "recursor_name">
5287 Collect "questions"
5288 Collect "cache-hits" "cache-misses"
5289 Socket "/var/run/pdns_recursor.controlsocket"
5290 </Recursor>
5291 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5292 </Plugin>
5294 =over 4
5296 =item B<Server> and B<Recursor> block
5298 The B<Server> block defines one authoritative server to query, the B<Recursor>
5299 does the same for an recursing server. The possible options in both blocks are
5300 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5301 and is required.
5303 =over 4
5305 =item B<Collect> I<Field>
5307 Using the B<Collect> statement you can select which values to collect. Here,
5308 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5309 C<dlg-only-drops>, C<answers10-100>.
5311 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5312 When querying the server a C<SHOW *> command is issued in any case, because
5313 that's the only way of getting multiple values out of the server at once.
5314 collectd then picks out the values you have selected. When querying the
5315 recursor, a command is generated to query exactly these values. So if you
5316 specify invalid fields when querying the recursor, a syntax error may be
5317 returned by the daemon and collectd may not collect any values at all.
5319 If no B<Collect> statement is given, the following B<Server> values will be
5320 collected:
5322 =over 4
5324 =item latency
5326 =item packetcache-hit
5328 =item packetcache-miss
5330 =item packetcache-size
5332 =item query-cache-hit
5334 =item query-cache-miss
5336 =item recursing-answers
5338 =item recursing-questions
5340 =item tcp-answers
5342 =item tcp-queries
5344 =item udp-answers
5346 =item udp-queries
5348 =back
5350 The following B<Recursor> values will be collected by default:
5352 =over 4
5354 =item noerror-answers
5356 =item nxdomain-answers
5358 =item servfail-answers
5360 =item sys-msec
5362 =item user-msec
5364 =item qa-latency
5366 =item cache-entries
5368 =item cache-hits
5370 =item cache-misses
5372 =item questions
5374 =back
5376 Please note that up to that point collectd doesn't know what values are
5377 available on the server and values that are added do not need a change of the
5378 mechanism so far. However, the values must be mapped to collectd's naming
5379 scheme, which is done using a lookup table that lists all known values. If
5380 values are added in the future and collectd does not know about them, you will
5381 get an error much like this:
5383 powerdns plugin: submit: Not found in lookup table: foobar = 42
5385 In this case please file a bug report with the collectd team.
5387 =item B<Socket> I<Path>
5389 Configures the path to the UNIX domain socket to be used when connecting to the
5390 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5391 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5392 will be used for the recursor.
5394 =back
5396 =item B<LocalSocket> I<Path>
5398 Querying the recursor is done using UDP. When using UDP over UNIX domain
5399 sockets, the client socket needs a name in the file system, too. You can set
5400 this local name to I<Path> using the B<LocalSocket> option. The default is
5401 C<I<prefix>/var/run/collectd-powerdns>.
5403 =back
5405 =head2 Plugin C<processes>
5407 =over 4
5409 =item B<Process> I<Name>
5411 Select more detailed statistics of processes matching this name. The statistics
5412 collected for these selected processes are size of the resident segment size
5413 (RSS), user- and system-time used, number of processes and number of threads,
5414 io data (where available) and minor and major pagefaults.
5416 =item B<ProcessMatch> I<name> I<regex>
5418 Similar to the B<Process> option this allows to select more detailed
5419 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5420 details). The statistics of all matching processes are summed up and
5421 dispatched to the daemon using the specified I<name> as an identifier. This
5422 allows to "group" several processes together. I<name> must not contain
5423 slashes.
5425 =back
5427 =head2 Plugin C<protocols>
5429 Collects a lot of information about various network protocols, such as I<IP>,
5430 I<TCP>, I<UDP>, etc.
5432 Available configuration options:
5434 =over 4
5436 =item B<Value> I<Selector>
5438 Selects whether or not to select a specific value. The string being matched is
5439 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5440 plugin instance and I<ValueName> will be used as type instance. An example of
5441 the string being used would be C<Tcp:RetransSegs>.
5443 You can use regular expressions to match a large number of values with just one
5444 configuration option. To select all "extended" I<TCP> values, you could use the
5445 following statement:
5447 Value "/^TcpExt:/"
5449 Whether only matched values are selected or all matched values are ignored
5450 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5451 If no value is configured at all, all values will be selected.
5453 =item B<IgnoreSelected> B<true>|B<false>
5455 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5456 matching values will be ignored.
5458 =back
5460 =head2 Plugin C<python>
5462 This plugin embeds a Python-interpreter into collectd and provides an interface
5463 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5465 =head2 Plugin C<routeros>
5467 The C<routeros> plugin connects to a device running I<RouterOS>, the
5468 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5469 I<librouteros> to connect and reads information about the interfaces and
5470 wireless connections of the device. The configuration supports querying
5471 multiple routers:
5473 <Plugin "routeros">
5474 <Router>
5475 Host "router0.example.com"
5476 User "collectd"
5477 Password "secr3t"
5478 CollectInterface true
5479 CollectCPULoad true
5480 CollectMemory true
5481 </Router>
5482 <Router>
5483 Host "router1.example.com"
5484 User "collectd"
5485 Password "5ecret"
5486 CollectInterface true
5487 CollectRegistrationTable true
5488 CollectDF true
5489 CollectDisk true
5490 </Router>
5491 </Plugin>
5493 As you can see above, the configuration of the I<routeros> plugin consists of
5494 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5495 options are understood:
5497 =over 4
5499 =item B<Host> I<Host>
5501 Hostname or IP-address of the router to connect to.
5503 =item B<Port> I<Port>
5505 Port name or port number used when connecting. If left unspecified, the default
5506 will be chosen by I<librouteros>, currently "8728". This option expects a
5507 string argument, even when a numeric port number is given.
5509 =item B<User> I<User>
5511 Use the user name I<User> to authenticate. Defaults to "admin".
5513 =item B<Password> I<Password>
5515 Set the password used to authenticate.
5517 =item B<CollectInterface> B<true>|B<false>
5519 When set to B<true>, interface statistics will be collected for all interfaces
5520 present on the device. Defaults to B<false>.
5522 =item B<CollectRegistrationTable> B<true>|B<false>
5524 When set to B<true>, information about wireless LAN connections will be
5525 collected. Defaults to B<false>.
5527 =item B<CollectCPULoad> B<true>|B<false>
5529 When set to B<true>, information about the CPU usage will be collected. The
5530 number is a dimensionless value where zero indicates no CPU usage at all.
5531 Defaults to B<false>.
5533 =item B<CollectMemory> B<true>|B<false>
5535 When enabled, the amount of used and free memory will be collected. How used
5536 memory is calculated is unknown, for example whether or not caches are counted
5537 as used space.
5538 Defaults to B<false>.
5540 =item B<CollectDF> B<true>|B<false>
5542 When enabled, the amount of used and free disk space will be collected.
5543 Defaults to B<false>.
5545 =item B<CollectDisk> B<true>|B<false>
5547 When enabled, the number of sectors written and bad blocks will be collected.
5548 Defaults to B<false>.
5550 =back
5552 =head2 Plugin C<redis>
5554 The I<Redis plugin> connects to one or more Redis servers and gathers
5555 information about each server's state. For each server there is a I<Node> block
5556 which configures the connection parameters for this node.
5558 <Plugin redis>
5559 <Node "example">
5560 Host "localhost"
5561 Port "6379"
5562 Timeout 2000
5563 <Query "LLEN myqueue">
5564 Type "queue_length"
5565 Instance "myqueue"
5566 <Query>
5567 </Node>
5568 </Plugin>
5570 The information shown in the synopsis above is the I<default configuration>
5571 which is used by the plugin if no configuration is present.
5573 =over 4
5575 =item B<Node> I<Nodename>
5577 The B<Node> block identifies a new Redis node, that is a new Redis instance
5578 running in an specified host and port. The name for node is a canonical
5579 identifier which is used as I<plugin instance>. It is limited to
5580 64E<nbsp>characters in length.
5582 =item B<Host> I<Hostname>
5584 The B<Host> option is the hostname or IP-address where the Redis instance is
5585 running on.
5587 =item B<Port> I<Port>
5589 The B<Port> option is the TCP port on which the Redis instance accepts
5590 connections. Either a service name of a port number may be given. Please note
5591 that numerical port numbers must be given as a string, too.
5593 =item B<Password> I<Password>
5595 Use I<Password> to authenticate when connecting to I<Redis>.
5597 =item B<Timeout> I<Milliseconds>
5599 The B<Timeout> option set the socket timeout for node response. Since the Redis
5600 read function is blocking, you should keep this value as low as possible. Keep
5601 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5602 than B<Interval> defined globally.
5604 =item B<Query> I<Querystring>
5606 The B<Query> block identifies a query to execute against the redis server.
5607 There may be an arbitrary number of queries to execute.
5609 =item B<Type> I<Collectd type>
5611 Within a query definition, a valid collectd type to use as when submitting
5612 the result of the query. When not supplied, will default to B<gauge>.
5614 =item B<Instance> I<Type instance>
5616 Within a query definition, an optional type instance to use when submitting
5617 the result of the query. When not supplied will default to the escaped
5618 command, up to 64 chars.
5620 =back
5622 =head2 Plugin C<rrdcached>
5624 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5625 to store values to RRD files in an efficient manner. The combination of the
5626 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5627 way the C<rrdtool> plugin works (see below). The added abstraction layer
5628 provides a number of benefits, though: Because the cache is not within
5629 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5630 restarted. This results in much shorter (if any) gaps in graphs, especially
5631 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5632 daemon so that it can flush values to disk automatically when needed. This
5633 allows to integrate automated flushing of values into graphing solutions much
5634 more easily.
5636 There are disadvantages, though: The daemon may reside on a different host, so
5637 it may not be possible for C<collectd> to create the appropriate RRD files
5638 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5639 different base directory, so relative paths may do weird stuff if you're not
5640 careful.
5642 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5643 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5644 setting should be set to an absolute path, so that a changed base directory
5645 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5647 =over 4
5649 =item B<DaemonAddress> I<Address>
5651 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5652 library. See L<rrdcached(1)> for details. Example:
5654 <Plugin "rrdcached">
5655 DaemonAddress "unix:/var/run/rrdcached.sock"
5656 </Plugin>
5658 =item B<DataDir> I<Directory>
5660 Set the base directory in which the RRD files reside. If this is a relative
5661 path, it is relative to the working base directory of the C<rrdcached> daemon!
5662 Use of an absolute path is recommended.
5664 =item B<CreateFiles> B<true>|B<false>
5666 Enables or disables the creation of RRD files. If the daemon is not running
5667 locally, or B<DataDir> is set to a relative path, this will not work as
5668 expected. Default is B<true>.
5670 =item B<CreateFilesAsync> B<false>|B<true>
5672 When enabled, new RRD files are enabled asynchronously, using a separate thread
5673 that runs in the background. This prevents writes to block, which is a problem
5674 especially when many hundreds of files need to be created at once. However,
5675 since the purpose of creating the files asynchronously is I<not> to block until
5676 the file is available, values before the file is available will be discarded.
5677 When disabled (the default) files are created synchronously, blocking for a
5678 short while, while the file is being written.
5680 =item B<StepSize> I<Seconds>
5682 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5683 this setting is unset and the stepsize is set to the interval in which the data
5684 is collected. Do not use this option unless you absolutely have to for some
5685 reason. Setting this option may cause problems with the C<snmp plugin>, the
5686 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5688 =item B<HeartBeat> I<Seconds>
5690 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5691 in which case the heartbeat is set to twice the B<StepSize> which should equal
5692 the interval in which data is collected. Do not set this option unless you have
5693 a very good reason to do so.
5695 =item B<RRARows> I<NumRows>
5697 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5698 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5699 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5700 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5701 week, one month, and one year.
5703 So for each timespan, it calculates how many PDPs need to be consolidated into
5704 one CDP by calculating:
5705 number of PDPs = timespan / (stepsize * rrarows)
5707 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5708 default is 1200.
5710 =item B<RRATimespan> I<Seconds>
5712 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5713 more then one RRA. If this option is never used, the built-in default of (3600,
5714 86400, 604800, 2678400, 31622400) is used.
5716 For more information on how RRA-sizes are calculated see B<RRARows> above.
5718 =item B<XFF> I<Factor>
5720 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5721 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5722 one (exclusive).
5724 =item B<CollectStatistics> B<false>|B<true>
5726 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5727 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5729 Statistics are read via I<rrdcached>s socket using the STATS command.
5730 See L<rrdcached(1)> for details.
5732 =back
5734 =head2 Plugin C<rrdtool>
5736 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5737 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5738 using these settings. If you don't want to dive into the depths of RRDtool, you
5739 can safely ignore these settings.
5741 =over 4
5743 =item B<DataDir> I<Directory>
5745 Set the directory to store RRD files under. By default RRD files are generated
5746 beneath the daemon's working directory, i.e. the B<BaseDir>.
5748 =item B<CreateFilesAsync> B<false>|B<true>
5750 When enabled, new RRD files are enabled asynchronously, using a separate thread
5751 that runs in the background. This prevents writes to block, which is a problem
5752 especially when many hundreds of files need to be created at once. However,
5753 since the purpose of creating the files asynchronously is I<not> to block until
5754 the file is available, values before the file is available will be discarded.
5755 When disabled (the default) files are created synchronously, blocking for a
5756 short while, while the file is being written.
5758 =item B<StepSize> I<Seconds>
5760 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5761 this setting is unset and the stepsize is set to the interval in which the data
5762 is collected. Do not use this option unless you absolutely have to for some
5763 reason. Setting this option may cause problems with the C<snmp plugin>, the
5764 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5766 =item B<HeartBeat> I<Seconds>
5768 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5769 in which case the heartbeat is set to twice the B<StepSize> which should equal
5770 the interval in which data is collected. Do not set this option unless you have
5771 a very good reason to do so.
5773 =item B<RRARows> I<NumRows>
5775 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5776 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5777 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5778 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5779 week, one month, and one year.
5781 So for each timespan, it calculates how many PDPs need to be consolidated into
5782 one CDP by calculating:
5783 number of PDPs = timespan / (stepsize * rrarows)
5785 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5786 default is 1200.
5788 =item B<RRATimespan> I<Seconds>
5790 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5791 more then one RRA. If this option is never used, the built-in default of (3600,
5792 86400, 604800, 2678400, 31622400) is used.
5794 For more information on how RRA-sizes are calculated see B<RRARows> above.
5796 =item B<XFF> I<Factor>
5798 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5799 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5800 one (exclusive).
5802 =item B<CacheFlush> I<Seconds>
5804 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5805 it writes all values for a certain RRD-file if the oldest value is older than
5806 (or equal to) the number of seconds specified. If some RRD-file is not updated
5807 anymore for some reason (the computer was shut down, the network is broken,
5808 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5809 entire cache is searched for entries older than B<CacheTimeout> seconds and
5810 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5811 does nothing under normal circumstances, this value should not be too small.
5812 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5813 normally do much harm either.
5815 =item B<CacheTimeout> I<Seconds>
5817 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5818 save values in a cache, as described above. Writing multiple values at once
5819 reduces IO-operations and thus lessens the load produced by updating the files.
5820 The trade off is that the graphs kind of "drag behind" and that more memory is
5821 used.
5823 =item B<WritesPerSecond> I<Updates>
5825 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5826 will run serious performance problems. The B<CacheFlush> setting and the
5827 internal update queue assert that collectd continues to work just fine even
5828 under heavy load, but the system may become very unresponsive and slow. This is
5829 a problem especially if you create graphs from the RRD files on the same
5830 machine, for example using the C<graph.cgi> script included in the
5831 C<contrib/collection3/> directory.
5833 This setting is designed for very large setups. Setting this option to a value
5834 between 25 and 80 updates per second, depending on your hardware, will leave
5835 the server responsive enough to draw graphs even while all the cached values
5836 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5837 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5838 written as fast as possible, so that web frontends have up to date data when
5839 generating graphs.
5841 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5842 updates per second, writing all values to disk will take approximately
5843 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5844 "collection3" you'll end up with a responsive and fast system, up to date
5845 graphs and basically a "backup" of your values every hour.
5847 =item B<RandomTimeout> I<Seconds>
5849 When set, the actual timeout for each value is chosen randomly between
5850 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5851 intention is to avoid high load situations that appear when many values timeout
5852 at the same time. This is especially a problem shortly after the daemon starts,
5853 because all values were added to the internal cache at roughly the same time.
5855 =back
5857 =head2 Plugin C<sensors>
5859 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5860 that all the needed modules have to be loaded and lm_sensors has to be
5861 configured (most likely by editing F</etc/sensors.conf>. Read
5862 L<sensors.conf(5)> for details.
5864 The B<lm_sensors> homepage can be found at
5865 L<http://secure.netroedge.com/~lm78/>.
5867 =over 4
5869 =item B<SensorConfigFile> I<File>
5871 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5872 the library's default will be used.
5874 =item B<Sensor> I<chip-bus-address/type-feature>
5876 Selects the name of the sensor which you want to collect or ignore, depending
5877 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5878 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5879 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5881 =item B<IgnoreSelected> I<true>|I<false>
5883 If no configuration if given, the B<sensors>-plugin will collect data from all
5884 sensors. This may not be practical, especially for uninteresting sensors.
5885 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5886 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5887 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5888 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5889 and all other sensors are collected.
5891 =back
5893 =head2 Plugin C<sigrok>
5895 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5896 supported by the L<sigrok|http://sigrok.org/> project.
5898 B<Synopsis>
5900 <Plugin sigrok>
5901 LogLevel 3
5902 <Device "AC Voltage">
5903 Driver "fluke-dmm"
5904 MinimumInterval 10
5905 Conn "/dev/ttyUSB2"
5906 </Device>
5907 <Device "Sound Level">
5908 Driver "cem-dt-885x"
5909 Conn "/dev/ttyUSB1"
5910 </Device>
5911 </Plugin>
5913 =over 4
5915 =item B<LogLevel> B<0-5>
5917 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5918 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5919 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5920 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5921 their level, are always submitted to I<collectd> at its INFO log level.
5923 =item E<lt>B<Device> I<Name>E<gt>
5925 A sigrok-supported device, uniquely identified by this section's options. The
5926 I<Name> is passed to I<collectd> as the I<plugin instance>.
5928 =item B<Driver> I<DriverName>
5930 The sigrok driver to use for this device.
5932 =item B<Conn> I<ConnectionSpec>
5934 If the device cannot be auto-discovered, or more than one might be discovered
5935 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5936 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5937 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5938 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5939 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5941 =item B<SerialComm> I<SerialSpec>
5943 For serial devices with non-standard port settings, this option can be used
5944 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5945 This should not be necessary; drivers know how to communicate with devices they
5946 support.
5948 =item B<MinimumInterval> I<Seconds>
5950 Specifies the minimum time between measurement dispatches to I<collectd>, in
5951 seconds. Since some I<sigrok> supported devices can acquire measurements many
5952 times per second, it may be necessary to throttle these. For example, the
5953 I<RRD plugin> cannot process writes more than once per second.
5955 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5956 device are always dispatched to I<collectd>. When throttled, unused
5957 measurements are discarded.
5959 =back
5961 =head2 Plugin C<smart>
5963 The C<smart> plugin collects SMART information from physical
5964 disks. Values collectd include temperature, power cycle count, poweron
5965 time and bad sectors. Also, all SMART attributes are collected along
5966 with the normalized current value, the worst value, the threshold and
5967 a human readable value.
5969 Using the following two options you can ignore some disks or configure the
5970 collection only of specific disks.
5972 =over 4
5974 =item B<Disk> I<Name>
5976 Select the disk I<Name>. Whether it is collected or ignored depends on the
5977 B<IgnoreSelected> setting, see below. As with other plugins that use the
5978 daemon's ignorelist functionality, a string that starts and ends with a slash
5979 is interpreted as a regular expression. Examples:
5981 Disk "sdd"
5982 Disk "/hda[34]/"
5984 =item B<IgnoreSelected> B<true>|B<false>
5986 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
5987 statements, are ignored or if all other disks are ignored. The behavior
5988 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
5989 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
5990 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
5991 is set to B<true>, all disks are collected B<except> the ones matched.
5993 =back
5995 =head2 Plugin C<snmp>
5997 Since the configuration of the C<snmp plugin> is a little more complicated than
5998 other plugins, its documentation has been moved to an own manpage,
5999 L<collectd-snmp(5)>. Please see there for details.
6001 =head2 Plugin C<statsd>
6003 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
6004 protocol and dispatches rates or other aggregates of these numbers
6005 periodically.
6007 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
6008 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
6009 C<objects> respectively.
6011 The following configuration options are valid:
6013 =over 4
6015 =item B<Host> I<Host>
6017 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
6018 "any" address, i.e. accept packets sent to any of the hosts addresses.
6020 =item B<Port> I<Port>
6022 UDP port to listen to. This can be either a service name or a port number.
6023 Defaults to C<8125>.
6025 =item B<DeleteCounters> B<false>|B<true>
6027 =item B<DeleteTimers> B<false>|B<true>
6029 =item B<DeleteGauges> B<false>|B<true>
6031 =item B<DeleteSets> B<false>|B<true>
6033 These options control what happens if metrics are not updated in an interval.
6034 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6035 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6036 are unchanged. If set to B<True>, the such metrics are not dispatched and
6037 removed from the internal cache.
6039 =item B<TimerPercentile> I<Percent>
6041 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6042 that I<Percent> of all reported timers are smaller than or equal to the
6043 computed latency. This is useful for cutting off the long tail latency, as it's
6044 often done in I<Service Level Agreements> (SLAs).
6046 Different percentiles can be calculated by setting this option several times.
6047 If none are specified, no percentiles are calculated / dispatched.
6049 =item B<TimerLower> B<false>|B<true>
6051 =item B<TimerUpper> B<false>|B<true>
6053 =item B<TimerSum> B<false>|B<true>
6055 =item B<TimerCount> B<false>|B<true>
6057 Calculate and dispatch various values out of I<Timer> metrics received during
6058 an interval. If set to B<False>, the default, these values aren't calculated /
6059 dispatched.
6061 =back
6063 =head2 Plugin C<swap>
6065 The I<Swap plugin> collects information about used and available swap space. On
6066 I<Linux> and I<Solaris>, the following options are available:
6068 =over 4
6070 =item B<ReportByDevice> B<false>|B<true>
6072 Configures how to report physical swap devices. If set to B<false> (the
6073 default), the summary over all swap devices is reported only, i.e. the globally
6074 used and available space over all devices. If B<true> is configured, the used
6075 and available space of each device will be reported separately.
6077 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6078 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6080 =item B<ReportBytes> B<false>|B<true>
6082 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6083 I<swap I/O> is reported in pages. This option is available under Linux only.
6085 =item B<ValuesAbsolute> B<true>|B<false>
6087 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6088 available and used. Defaults to B<true>.
6090 =item B<ValuesPercentage> B<false>|B<true>
6092 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6093 available and free. Defaults to B<false>.
6095 This is useful for deploying I<collectd> in a heterogeneous environment, where
6096 swap sizes differ and you want to specify generic thresholds or similar.
6098 =back
6100 =head2 Plugin C<syslog>
6102 =over 4
6104 =item B<LogLevel> B<debug|info|notice|warning|err>
6106 Sets the log-level. If, for example, set to B<notice>, then all events with
6107 severity B<notice>, B<warning>, or B<err> will be submitted to the
6108 syslog-daemon.
6110 Please note that B<debug> is only available if collectd has been compiled with
6111 debugging support.
6113 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6115 Controls which notifications should be sent to syslog. The default behaviour is
6116 not to send any. Less severe notifications always imply logging more severe
6117 notifications: Setting this to B<OKAY> means all notifications will be sent to
6118 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6119 notifications but will dismiss B<OKAY> notifications. Setting this option to
6120 B<FAILURE> will only send failures to syslog.
6122 =back
6124 =head2 Plugin C<table>
6126 The C<table plugin> provides generic means to parse tabular data and dispatch
6127 user specified values. Values are selected based on column numbers. For
6128 example, this plugin may be used to get values from the Linux L<proc(5)>
6129 filesystem or CSV (comma separated values) files.
6131 <Plugin table>
6132 <Table "/proc/slabinfo">
6133 Instance "slabinfo"
6134 Separator " "
6135 <Result>
6136 Type gauge
6137 InstancePrefix "active_objs"
6138 InstancesFrom 0
6139 ValuesFrom 1
6140 </Result>
6141 <Result>
6142 Type gauge
6143 InstancePrefix "objperslab"
6144 InstancesFrom 0
6145 ValuesFrom 4
6146 </Result>
6147 </Table>
6148 </Plugin>
6150 The configuration consists of one or more B<Table> blocks, each of which
6151 configures one file to parse. Within each B<Table> block, there are one or
6152 more B<Result> blocks, which configure which data to select and how to
6153 interpret it.
6155 The following options are available inside a B<Table> block:
6157 =over 4
6159 =item B<Instance> I<instance>
6161 If specified, I<instance> is used as the plugin instance. So, in the above
6162 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6163 filename of the table is used instead, with all special characters replaced
6164 with an underscore (C<_>).
6166 =item B<Separator> I<string>
6168 Any character of I<string> is interpreted as a delimiter between the different
6169 columns of the table. A sequence of two or more contiguous delimiters in the
6170 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6171 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6172 of a table - see its documentation for more details. This option is mandatory.
6174 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6175 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6176 required because of collectd's config parsing.
6178 =back
6180 The following options are available inside a B<Result> block:
6182 =over 4
6184 =item B<Type> I<type>
6186 Sets the type used to dispatch the values to the daemon. Detailed information
6187 about types and their configuration can be found in L<types.db(5)>. This
6188 option is mandatory.
6190 =item B<InstancePrefix> I<prefix>
6192 If specified, prepend I<prefix> to the type instance. If omitted, only the
6193 B<InstancesFrom> option is considered for the type instance.
6195 =item B<InstancesFrom> I<column0> [I<column1> ...]
6197 If specified, the content of the given columns (identified by the column
6198 number starting at zero) will be used to create the type instance for each
6199 row. Multiple values (and the instance prefix) will be joined together with
6200 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6201 option is considered for the type instance.
6203 The plugin itself does not check whether or not all built instances are
6204 different. It’s your responsibility to assure that each is unique. This is
6205 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6206 sure that the table only contains one row.
6208 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6209 will be empty.
6211 =item B<ValuesFrom> I<column0> [I<column1> ...]
6213 Specifies the columns (identified by the column numbers starting at zero)
6214 whose content is used as the actual data for the data sets that are dispatched
6215 to the daemon. How many such columns you need is determined by the B<Type>
6216 setting above. If you specify too many or not enough columns, the plugin will
6217 complain about that and no data will be submitted to the daemon. The plugin
6218 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6219 respectively, so anything supported by those functions is supported by the
6220 plugin as well. This option is mandatory.
6222 =back
6224 =head2 Plugin C<tail>
6226 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6227 each line and dispatches found values. What is matched can be configured by the
6228 user using (extended) regular expressions, as described in L<regex(7)>.
6230 <Plugin "tail">
6231 <File "/var/log/exim4/mainlog">
6232 Instance "exim"
6233 Interval 60
6234 <Match>
6235 Regex "S=([1-9][0-9]*)"
6236 DSType "CounterAdd"
6237 Type "ipt_bytes"
6238 Instance "total"
6239 </Match>
6240 <Match>
6241 Regex "\\<R=local_user\\>"
6242 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6243 DSType "CounterInc"
6244 Type "counter"
6245 Instance "local_user"
6246 </Match>
6247 </File>
6248 </Plugin>
6250 The config consists of one or more B<File> blocks, each of which configures one
6251 logfile to parse. Within each B<File> block, there are one or more B<Match>
6252 blocks, which configure a regular expression to search for.
6254 The B<Instance> option in the B<File> block may be used to set the plugin
6255 instance. So in the above example the plugin name C<tail-foo> would be used.
6256 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6257 next B<Instance> option. This way you can extract several plugin instances from
6258 one logfile, handy when parsing syslog and the like.
6260 The B<Interval> option allows you to define the length of time between reads. If
6261 this is not set, the default Interval will be used.
6263 Each B<Match> block has the following options to describe how the match should
6264 be performed:
6266 =over 4
6268 =item B<Regex> I<regex>
6270 Sets the regular expression to use for matching against a line. The first
6271 subexpression has to match something that can be turned into a number by
6272 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6273 below. Because B<extended> regular expressions are used, you do not need to use
6274 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6275 collectd's config parsing you need to escape backslashes, though. So if you
6276 want to match literal parentheses you need to do the following:
6278 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6280 =item B<ExcludeRegex> I<regex>
6282 Sets an optional regular expression to use for excluding lines from the match.
6283 An example which excludes all connections from localhost from the match:
6285 ExcludeRegex "127\\.0\\.0\\.1"
6287 =item B<DSType> I<Type>
6289 Sets how the values are cumulated. I<Type> is one of:
6291 =over 4
6293 =item B<GaugeAverage>
6295 Calculate the average.
6297 =item B<GaugeMin>
6299 Use the smallest number only.
6301 =item B<GaugeMax>
6303 Use the greatest number only.
6305 =item B<GaugeLast>
6307 Use the last number found.
6309 =item B<CounterSet>
6311 =item B<DeriveSet>
6313 =item B<AbsoluteSet>
6315 The matched number is a counter. Simply I<sets> the internal counter to this
6316 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6318 =item B<GaugeAdd>
6320 =item B<CounterAdd>
6322 =item B<DeriveAdd>
6324 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6325 matched number may be negative, which will effectively subtract from the
6326 internal counter.
6328 =item B<GaugeInc>
6330 =item B<CounterInc>
6332 =item B<DeriveInc>
6334 Increase the internal counter by one. These B<DSType> are the only ones that do
6335 not use the matched subexpression, but simply count the number of matched
6336 lines. Thus, you may use a regular expression without submatch in this case.
6338 =back
6340 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6341 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6342 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6343 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6344 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6345 case.
6347 =item B<Type> I<Type>
6349 Sets the type used to dispatch this value. Detailed information about types and
6350 their configuration can be found in L<types.db(5)>.
6352 =item B<Instance> I<TypeInstance>
6354 This optional setting sets the type instance to use.
6356 =back
6358 =head2 Plugin C<tail_csv>
6360 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6361 written by I<Snort>.
6363 B<Synopsis:>
6365 <Plugin "tail_csv">
6366 <Metric "snort-dropped">
6367 Type "percent"
6368 Instance "dropped"
6369 Index 1
6370 </Metric>
6371 <File "/var/log/snort/snort.stats">
6372 Instance "snort-eth0"
6373 Interval 600
6374 Collect "snort-dropped"
6375 </File>
6376 </Plugin>
6378 The configuration consists of one or more B<Metric> blocks that define an index
6379 into the line of the CSV file and how this value is mapped to I<collectd's>
6380 internal representation. These are followed by one or more B<Instance> blocks
6381 which configure which file to read, in which interval and which metrics to
6382 extract.
6384 =over 4
6386 =item E<lt>B<Metric> I<Name>E<gt>
6388 The B<Metric> block configures a new metric to be extracted from the statistics
6389 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6390 only used inside the B<Instance> blocks to refer to this block, so you can use
6391 one B<Metric> block for multiple CSV files.
6393 =over 4
6395 =item B<Type> I<Type>
6397 Configures which I<Type> to use when dispatching this metric. Types are defined
6398 in the L<types.db(5)> file, see the appropriate manual page for more
6399 information on specifying types. Only types with a single I<data source> are
6400 supported by the I<tail_csv plugin>. The information whether the value is an
6401 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6402 I<Type's> definition.
6404 =item B<Instance> I<TypeInstance>
6406 If set, I<TypeInstance> is used to populate the type instance field of the
6407 created value lists. Otherwise, no type instance is used.
6409 =item B<ValueFrom> I<Index>
6411 Configure to read the value from the field with the zero-based index I<Index>.
6412 If the value is parsed as signed integer, unsigned integer or double depends on
6413 the B<Type> setting, see above.
6415 =back
6417 =item E<lt>B<File> I<Path>E<gt>
6419 Each B<File> block represents one CSV file to read. There must be at least one
6420 I<File> block but there can be multiple if you have multiple CSV files.
6422 =over 4
6424 =item B<Instance> I<PluginInstance>
6426 Sets the I<plugin instance> used when dispatching the values.
6428 =item B<Collect> I<Metric>
6430 Specifies which I<Metric> to collect. This option must be specified at least
6431 once, and you can use this option multiple times to specify more than one
6432 metric to be extracted from this statistic file.
6434 =item B<Interval> I<Seconds>
6436 Configures the interval in which to read values from this instance / file.
6437 Defaults to the plugin's default interval.
6439 =item B<TimeFrom> I<Index>
6441 Rather than using the local time when dispatching a value, read the timestamp
6442 from the field with the zero-based index I<Index>. The value is interpreted as
6443 seconds since epoch. The value is parsed as a double and may be factional.
6445 =back
6447 =back
6449 =head2 Plugin C<teamspeak2>
6451 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6452 polls interesting global and virtual server data. The plugin can query only one
6453 physical server but unlimited virtual servers. You can use the following
6454 options to configure it:
6456 =over 4
6458 =item B<Host> I<hostname/ip>
6460 The hostname or ip which identifies the physical server.
6461 Default: 127.0.0.1
6463 =item B<Port> I<port>
6465 The query port of the physical server. This needs to be a string.
6466 Default: "51234"
6468 =item B<Server> I<port>
6470 This option has to be added once for every virtual server the plugin should
6471 query. If you want to query the virtual server on port 8767 this is what the
6472 option would look like:
6474 Server "8767"
6476 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6477 use quotes around it! If no such statement is given only global information
6478 will be collected.
6480 =back
6482 =head2 Plugin C<ted>
6484 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6485 measure power consumption. These devices are usually connected to a serial
6486 (RS232) or USB port. The plugin opens a configured device and tries to read the
6487 current energy readings. For more information on TED, visit
6488 L<http://www.theenergydetective.com/>.
6490 Available configuration options:
6492 =over 4
6494 =item B<Device> I<Path>
6496 Path to the device on which TED is connected. collectd will need read and write
6497 permissions on that file.
6499 Default: B</dev/ttyUSB0>
6501 =item B<Retries> I<Num>
6503 Apparently reading from TED is not that reliable. You can therefore configure a
6504 number of retries here. You only configure the I<retries> here, to if you
6505 specify zero, one reading will be performed (but no retries if that fails); if
6506 you specify three, a maximum of four readings are performed. Negative values
6507 are illegal.
6509 Default: B<0>
6511 =back
6513 =head2 Plugin C<tcpconns>
6515 The C<tcpconns plugin> counts the number of currently established TCP
6516 connections based on the local port and/or the remote port. Since there may be
6517 a lot of connections the default if to count all connections with a local port,
6518 for which a listening socket is opened. You can use the following options to
6519 fine-tune the ports you are interested in:
6521 =over 4
6523 =item B<ListeningPorts> I<true>|I<false>
6525 If this option is set to I<true>, statistics for all local ports for which a
6526 listening socket exists are collected. The default depends on B<LocalPort> and
6527 B<RemotePort> (see below): If no port at all is specifically selected, the
6528 default is to collect listening ports. If specific ports (no matter if local or
6529 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6530 the selected ports will be collected unless this option is set to I<true>
6531 specifically.
6533 =item B<LocalPort> I<Port>
6535 Count the connections to a specific local port. This can be used to see how
6536 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6537 You have to specify the port in numeric form, so for the mailserver example
6538 you'd need to set B<25>.
6540 =item B<RemotePort> I<Port>
6542 Count the connections to a specific remote port. This is useful to see how
6543 much a remote service is used. This is most useful if you want to know how many
6544 connections a local service has opened to remote services, e.E<nbsp>g. how many
6545 connections a mail server or news server has to other mail or news servers, or
6546 how many connections a web proxy holds to web servers. You have to give the
6547 port in numeric form.
6549 =item B<AllPortsSummary> I<true>|I<false>
6551 If this option is set to I<true> a summary of statistics from all connections
6552 are collectd. This option defaults to I<false>.
6554 =back
6556 =head2 Plugin C<thermal>
6558 =over 4
6560 =item B<ForceUseProcfs> I<true>|I<false>
6562 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6563 C<sysfs> interface. If that is not available, the plugin falls back to the
6564 C<procfs> interface. By setting this option to I<true>, you can force the
6565 plugin to use the latter. This option defaults to I<false>.
6567 =item B<Device> I<Device>
6569 Selects the name of the thermal device that you want to collect or ignore,
6570 depending on the value of the B<IgnoreSelected> option. This option may be
6571 used multiple times to specify a list of devices.
6573 =item B<IgnoreSelected> I<true>|I<false>
6575 Invert the selection: If set to true, all devices B<except> the ones that
6576 match the device names specified by the B<Device> option are collected. By
6577 default only selected devices are collected if a selection is made. If no
6578 selection is configured at all, B<all> devices are selected.
6580 =back
6582 =head2 Plugin C<threshold>
6584 The I<Threshold plugin> checks values collected or received by I<collectd>
6585 against a configurable I<threshold> and issues I<notifications> if values are
6586 out of bounds.
6588 Documentation for this plugin is available in the L<collectd-threshold(5)>
6589 manual page.
6591 =head2 Plugin C<tokyotyrant>
6593 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6594 couple metrics: number of records, and database size on disk.
6596 =over 4
6598 =item B<Host> I<Hostname/IP>
6600 The hostname or ip which identifies the server.
6601 Default: B<127.0.0.1>
6603 =item B<Port> I<Service/Port>
6605 The query port of the server. This needs to be a string, even if the port is
6606 given in its numeric form.
6607 Default: B<1978>
6609 =back
6611 =head2 Plugin C<turbostat>
6613 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
6614 Intel processors by using the new Model Specific Registers.
6616 =over 4
6618 =item B<CoreCstates> I<Bitmask(Integer)>
6620 Bitmask of the list of core C states supported by the processor.
6621 This option should only be used if the automated detection fails.
6622 Default value extracted from the cpu model and family.
6624 Currently supported C-states (by this plugin): 3, 6, 7
6626 Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
6628 =item B<PackageCstates> I<Bitmask(Integer)>
6630 Bitmask of the list of pacages C states supported by the processor.
6631 This option should only be used if the automated detection fails.
6632 Default value extracted from the cpu model and family.
6634 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
6636 Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7
6638 =item B<SystemManagementInterrupt> I<true>|I<false>
6640 Boolean enabling the collection of the I/O System-Management Interrupt
6641 counter'. This option should only be used if the automated detection
6642 fails or if you want to disable this feature.
6644 =item B<DigitalTemperatureSensor> I<true>|I<false>
6646 Boolean enabling the collection of the temperature of each core.
6647 This option should only be used if the automated detectionfails or
6648 if you want to disable this feature.
6650 =item B<DigitalTemperatureSensor> I<true>|I<false>
6652 Boolean enabling the collection of the temperature of each package.
6653 This option should only be used if the automated detectionfails or
6654 if you want to disable this feature.
6656 =item B<TCCActivationTemp> I<Temperature>
6658 Thermal Control Circuit Activation Temperature of the installed
6659 CPU. This temperature is used when collecting the temperature of
6660 cores or packages. This option should only be used if the automated
6661 detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
6663 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
6665 Bitmask of the list of elements to be thermally monitored. This option
6666 should only be used if the automated detection fails or if you want to
6667 disable some collections. The different bits of this bitmask accepted
6668 by this plugin are:
6670 =over 4
6672 =item 0 ('1'): Package
6674 =item 1 ('2'): DRAM
6676 =item 2 ('4'): Cores
6678 =item 3 ('8'): Embedded graphic device
6680 =back
6682 =back
6684 =head2 Plugin C<unixsock>
6686 =over 4
6688 =item B<SocketFile> I<Path>
6690 Sets the socket-file which is to be created.
6692 =item B<SocketGroup> I<Group>
6694 If running as root change the group of the UNIX-socket after it has been
6695 created. Defaults to B<collectd>.
6697 =item B<SocketPerms> I<Permissions>
6699 Change the file permissions of the UNIX-socket after it has been created. The
6700 permissions must be given as a numeric, octal value as you would pass to
6701 L<chmod(1)>. Defaults to B<0770>.
6703 =item B<DeleteSocket> B<false>|B<true>
6705 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6706 with the given name already exists. If I<collectd> crashes a socket file may be
6707 left over, preventing the daemon from opening a new socket when restarted.
6708 Since this is potentially dangerous, this defaults to B<false>.
6710 =back
6712 =head2 Plugin C<uuid>
6714 This plugin, if loaded, causes the Hostname to be taken from the machine's
6715 UUID. The UUID is a universally unique designation for the machine, usually
6716 taken from the machine's BIOS. This is most useful if the machine is running in
6717 a virtual environment such as Xen, in which case the UUID is preserved across
6718 shutdowns and migration.
6720 The following methods are used to find the machine's UUID, in order:
6722 =over 4
6724 =item
6726 Check I</etc/uuid> (or I<UUIDFile>).
6728 =item
6730 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6731 present.
6733 =item
6735 Check for UUID from C<dmidecode> / SMBIOS.
6737 =item
6739 Check for UUID from Xen hypervisor.
6741 =back
6743 If no UUID can be found then the hostname is not modified.
6745 =over 4
6747 =item B<UUIDFile> I<Path>
6749 Take the UUID from the given file (default I</etc/uuid>).
6751 =back
6753 =head2 Plugin C<varnish>
6755 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6756 It collects a subset of the values displayed by L<varnishstat(1)>, and
6757 organizes them in categories which can be enabled or disabled. Currently only
6758 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6759 meaning of each metric can be found in L<varnish-counters(7)>.
6761 Synopsis:
6763 <Plugin "varnish">
6764 <Instance "example">
6765 CollectBackend true
6766 CollectBan false
6767 CollectCache true
6768 CollectConnections true
6769 CollectDirectorDNS false
6770 CollectESI false
6771 CollectFetch false
6772 CollectHCB false
6773 CollectObjects false
6774 CollectPurge false
6775 CollectSession false
6776 CollectSHM true
6777 CollectSMA false
6778 CollectSMS false
6779 CollectSM false
6780 CollectStruct false
6781 CollectTotals false
6782 CollectUptime false
6783 CollectVCL false
6784 CollectVSM false
6785 CollectWorkers false
6786 </Instance>
6787 </Plugin>
6789 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6790 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6791 will collectd statistics from the default "varnishd" instance (this should work
6792 fine in most cases).
6794 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6796 =over 4
6798 =item B<CollectBackend> B<true>|B<false>
6800 Back-end connection statistics, such as successful, reused,
6801 and closed connections. True by default.
6803 =item B<CollectBan> B<true>|B<false>
6805 Statistics about ban operations, such as number of bans added, retired, and
6806 number of objects tested against ban operations. Only available with Varnish
6807 3.x and above. False by default.
6809 =item B<CollectCache> B<true>|B<false>
6811 Cache hits and misses. True by default.
6813 =item B<CollectConnections> B<true>|B<false>
6815 Number of client connections received, accepted and dropped. True by default.
6817 =item B<CollectDirectorDNS> B<true>|B<false>
6819 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6820 default.
6822 =item B<CollectESI> B<true>|B<false>
6824 Edge Side Includes (ESI) parse statistics. False by default.
6826 =item B<CollectFetch> B<true>|B<false>
6828 Statistics about fetches (HTTP requests sent to the backend). False by default.
6830 =item B<CollectHCB> B<true>|B<false>
6832 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6833 divided into locked and unlocked look-ups. False by default.
6835 =item B<CollectObjects> B<true>|B<false>
6837 Statistics on cached objects: number of objects expired, nuked (prematurely
6838 expired), saved, moved, etc. False by default.
6840 =item B<CollectPurge> B<true>|B<false>
6842 Statistics about purge operations, such as number of purges added, retired, and
6843 number of objects tested against purge operations. Only available with Varnish
6844 2.x. False by default.
6846 =item B<CollectSession> B<true>|B<false>
6848 Client session statistics. Number of past and current sessions, session herd and
6849 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6850 metrics found in the Connections and Threads sections with previous versions of
6851 Varnish have been moved here.
6853 =item B<CollectSHM> B<true>|B<false>
6855 Statistics about the shared memory log, a memory region to store
6856 log messages which is flushed to disk when full. True by default.
6858 =item B<CollectSMA> B<true>|B<false>
6860 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6861 component is Solaris specific. Only available with Varnish 2.x. False by
6862 default.
6864 =item B<CollectSMS> B<true>|B<false>
6866 synth (synthetic content) storage statistics. This storage
6867 component is used internally only. False by default.
6869 =item B<CollectSM> B<true>|B<false>
6871 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6872 False by default.
6874 =item B<CollectStruct> B<true>|B<false>
6876 Current varnish internal state statistics. Number of current sessions, objects
6877 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6878 default.
6880 =item B<CollectTotals> B<true>|B<false>
6882 Collects overview counters, such as the number of sessions created,
6883 the number of requests and bytes transferred. False by default.
6885 =item B<CollectUptime> B<true>|B<false>
6887 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6889 =item B<CollectVCL> B<true>|B<false>
6891 Number of total (available + discarded) VCL (config files). False by default.
6893 =item B<CollectVSM> B<true>|B<false>
6895 Collect statistics about Varnish's shared memory usage (used by the logging and
6896 statistics subsystems). Only available with Varnish 4.x. False by default.
6898 =item B<CollectWorkers> B<true>|B<false>
6900 Collect statistics about worker threads. False by default.
6902 =back
6904 =head2 Plugin C<virt>
6906 This plugin allows CPU, disk and network load to be collected for virtualized
6907 guests on the machine. This means that these metrics can be collected for guest
6908 systems without installing any software on them - I<collectd> only runs on the
6909 host system. The statistics are collected through libvirt
6910 (L<http://libvirt.org/>).
6912 Only I<Connection> is required.
6914 =over 4
6916 =item B<Connection> I<uri>
6918 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6920 Connection "xen:///"
6922 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6924 =item B<RefreshInterval> I<seconds>
6926 Refresh the list of domains and devices every I<seconds>. The default is 60
6927 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6928 the list of domains and devices to be refreshed on every iteration.
6930 Refreshing the devices in particular is quite a costly operation, so if your
6931 virtualization setup is static you might consider increasing this. If this
6932 option is set to 0, refreshing is disabled completely.
6934 =item B<Domain> I<name>
6936 =item B<BlockDevice> I<name:dev>
6938 =item B<InterfaceDevice> I<name:dev>
6940 =item B<IgnoreSelected> B<true>|B<false>
6942 Select which domains and devices are collected.
6944 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6945 disk/network devices are collected.
6947 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6948 domains and disk/network devices are ignored, while the rest are collected.
6950 The domain name and device names may use a regular expression, if the name is
6951 surrounded by I</.../> and collectd was compiled with support for regexps.
6953 The default is to collect statistics for all domains and all their devices.
6955 Example:
6957 BlockDevice "/:hdb/"
6958 IgnoreSelected "true"
6960 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
6961 will be collected.
6963 =item B<HostnameFormat> B<name|uuid|hostname|...>
6965 When the virt plugin logs data, it sets the hostname of the collected data
6966 according to this setting. The default is to use the guest name as provided by
6967 the hypervisor, which is equal to setting B<name>.
6969 B<uuid> means use the guest's UUID. This is useful if you want to track the
6970 same guest across migrations.
6972 B<hostname> means to use the global B<Hostname> setting, which is probably not
6973 useful on its own because all guests will appear to have the same name.
6975 You can also specify combinations of these fields. For example B<name uuid>
6976 means to concatenate the guest name and UUID (with a literal colon character
6977 between, thus I<"foo:1234-1234-1234-1234">).
6979 At the moment of writing (collectd-5.5), hostname string is limited to 62
6980 characters. In case when combination of fields exceeds 62 characters,
6981 hostname will be truncated without a warning.
6983 =item B<InterfaceFormat> B<name>|B<address>
6985 When the virt plugin logs interface data, it sets the name of the collected
6986 data according to this setting. The default is to use the path as provided by
6987 the hypervisor (the "dev" property of the target node), which is equal to
6988 setting B<name>.
6990 B<address> means use the interface's mac address. This is useful since the
6991 interface path might change between reboots of a guest or across migrations.
6993 =item B<PluginInstanceFormat> B<name|uuid>
6995 When the virt plugin logs data, it sets the plugin_instance of the collected
6996 data according to this setting. The default is to use the guest name as provided
6997 by the hypervisor, which is equal to setting B<name>.
6999 B<uuid> means use the guest's UUID.
7001 =back
7003 =head2 Plugin C<vmem>
7005 The C<vmem> plugin collects information about the usage of virtual memory.
7006 Since the statistics provided by the Linux kernel are very detailed, they are
7007 collected very detailed. However, to get all the details, you have to switch
7008 them on manually. Most people just want an overview over, such as the number of
7009 pages read from swap space.
7011 =over 4
7013 =item B<Verbose> B<true>|B<false>
7015 Enables verbose collection of information. This will start collecting page
7016 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
7017 Part of these statistics are collected on a "per zone" basis.
7019 =back
7021 =head2 Plugin C<vserver>
7023 This plugin doesn't have any options. B<VServer> support is only available for
7024 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
7025 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
7026 need to apply the patches and compile your own kernel, which will then provide
7027 the F</proc/virtual> filesystem that is required by this plugin.
7029 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
7031 B<Note>: The traffic collected by this plugin accounts for the amount of
7032 traffic passing a socket which might be a lot less than the actual on-wire
7033 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
7034 collect on-wire traffic you could, for example, use the logging facilities of
7035 iptables to feed data for the guest IPs into the iptables plugin.
7037 =head2 Plugin C<write_graphite>
7039 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
7040 storage and graphing project. The plugin connects to I<Carbon>, the data layer
7041 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
7042 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
7043 of at most 1428 bytes to minimize the number of network packets.
7045 Synopsis:
7047 <Plugin write_graphite>
7048 <Node "example">
7049 Host "localhost"
7050 Port "2003"
7051 Protocol "tcp"
7052 LogSendErrors true
7053 Prefix "collectd"
7054 </Node>
7055 </Plugin>
7057 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7058 blocks. Inside the B<Node> blocks, the following options are recognized:
7060 =over 4
7062 =item B<Host> I<Address>
7064 Hostname or address to connect to. Defaults to C<localhost>.
7066 =item B<Port> I<Service>
7068 Service name or port number to connect to. Defaults to C<2003>.
7070 =item B<Protocol> I<String>
7072 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
7074 =item B<LogSendErrors> B<false>|B<true>
7076 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
7077 If set to B<false>, it will not log the errors. This is especially useful when
7078 using Protocol UDP since many times we want to use the "fire-and-forget"
7079 approach and logging errors fills syslog with unneeded messages.
7081 =item B<Prefix> I<String>
7083 When set, I<String> is added in front of the host name. Dots and whitespace are
7084 I<not> escaped in this string (see B<EscapeCharacter> below).
7086 =item B<Postfix> I<String>
7088 When set, I<String> is appended to the host name. Dots and whitespace are
7089 I<not> escaped in this string (see B<EscapeCharacter> below).
7091 =item B<EscapeCharacter> I<Char>
7093 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
7094 in the identifier. The B<EscapeCharacter> option determines which character
7095 dots, whitespace and control characters are replaced with. Defaults to
7096 underscore (C<_>).
7098 =item B<StoreRates> B<false>|B<true>
7100 If set to B<true> (the default), convert counter values to rates. If set to
7101 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7102 number.
7104 =item B<SeparateInstances> B<false>|B<true>
7106 If set to B<true>, the plugin instance and type instance will be in their own
7107 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7108 default), the plugin and plugin instance (and likewise the type and type
7109 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7111 =item B<AlwaysAppendDS> B<false>|B<true>
7113 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7114 identifier. If set to B<false> (the default), this is only done when there is
7115 more than one DS.
7117 =back
7119 =head2 Plugin C<write_tsdb>
7121 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7122 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7123 state daemon that ingests metrics and stores them in HBase. The plugin uses
7124 I<TCP> over the "line based" protocol with a default port 4242. The data will
7125 be sent in blocks of at most 1428 bytes to minimize the number of network
7126 packets.
7128 Synopsis:
7130 <Plugin write_tsdb>
7131 <Node "example">
7132 Host "tsd-1.my.domain"
7133 Port "4242"
7134 HostTags "status=production"
7135 </Node>
7136 </Plugin>
7138 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7139 blocks. Inside the B<Node> blocks, the following options are recognized:
7141 =over 4
7143 =item B<Host> I<Address>
7145 Hostname or address to connect to. Defaults to C<localhost>.
7147 =item B<Port> I<Service>
7149 Service name or port number to connect to. Defaults to C<4242>.
7152 =item B<HostTags> I<String>
7154 When set, I<HostTags> is added to the end of the metric. It is intended to be
7155 used for name=value pairs that the TSD will tag the metric with. Dots and
7156 whitespace are I<not> escaped in this string.
7158 =item B<StoreRates> B<false>|B<true>
7160 If set to B<true>, convert counter values to rates. If set to B<false>
7161 (the default) counter values are stored as is, as an increasing
7162 integer number.
7164 =item B<AlwaysAppendDS> B<false>|B<true>
7166 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7167 identifier. If set to B<false> (the default), this is only done when there is
7168 more than one DS.
7170 =back
7172 =head2 Plugin C<write_mongodb>
7174 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7175 NoSQL database.
7177 B<Synopsis:>
7179 <Plugin "write_mongodb">
7180 <Node "default">
7181 Host "localhost"
7182 Port "27017"
7183 Timeout 1000
7184 StoreRates true
7185 </Node>
7186 </Plugin>
7188 The plugin can send values to multiple instances of I<MongoDB> by specifying
7189 one B<Node> block for each instance. Within the B<Node> blocks, the following
7190 options are available:
7192 =over 4
7194 =item B<Host> I<Address>
7196 Hostname or address to connect to. Defaults to C<localhost>.
7198 =item B<Port> I<Service>
7200 Service name or port number to connect to. Defaults to C<27017>.
7202 =item B<Timeout> I<Milliseconds>
7204 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7205 Setting this option to zero means no timeout, which is the default.
7207 =item B<StoreRates> B<false>|B<true>
7209 If set to B<true> (the default), convert counter values to rates. If set to
7210 B<false> counter values are stored as is, i.e. as an increasing integer
7211 number.
7213 =item B<Database> I<Database>
7215 =item B<User> I<User>
7217 =item B<Password> I<Password>
7219 Sets the information used when authenticating to a I<MongoDB> database. The
7220 fields are optional (in which case no authentication is attempted), but if you
7221 want to use authentication all three fields must be set.
7223 =back
7225 =head2 Plugin C<write_http>
7227 This output plugin submits values to an HTTP server using POST requests and
7228 encoding metrics with JSON or using the C<PUTVAL> command described in
7229 L<collectd-unixsock(5)>.
7231 Synopsis:
7233 <Plugin "write_http">
7234 <Node "example">
7235 URL "http://example.com/post-collectd"
7236 User "collectd"
7237 Password "weCh3ik0"
7238 Format JSON
7239 </Node>
7240 </Plugin>
7242 The plugin can send values to multiple HTTP servers by specifying one
7243 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7244 block, the following options are available:
7246 =over 4
7248 =item B<URL> I<URL>
7250 URL to which the values are submitted to. Mandatory.
7252 =item B<User> I<Username>
7254 Optional user name needed for authentication.
7256 =item B<Password> I<Password>
7258 Optional password needed for authentication.
7260 =item B<VerifyPeer> B<true>|B<false>
7262 Enable or disable peer SSL certificate verification. See
7263 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7265 =item B<VerifyHost> B<true|false>
7267 Enable or disable peer host name verification. If enabled, the plugin checks if
7268 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7269 matches the host name provided by the B<URL> option. If this identity check
7270 fails, the connection is aborted. Obviously, only works when connecting to a
7271 SSL enabled server. Enabled by default.
7273 =item B<CACert> I<File>
7275 File that holds one or more SSL certificates. If you want to use HTTPS you will
7276 possibly need this option. What CA certificates come bundled with C<libcurl>
7277 and are checked by default depends on the distribution you use.
7279 =item B<CAPath> I<Directory>
7281 Directory holding one or more CA certificate files. You can use this if for
7282 some reason all the needed CA certificates aren't in the same file and can't be
7283 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7284 OpenSSL.
7286 =item B<ClientKey> I<File>
7288 File that holds the private key in PEM format to be used for certificate-based
7289 authentication.
7291 =item B<ClientCert> I<File>
7293 File that holds the SSL certificate to be used for certificate-based
7294 authentication.
7296 =item B<ClientKeyPass> I<Password>
7298 Password required to load the private key in B<ClientKey>.
7300 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7302 Define which SSL protocol version must be used. By default C<libcurl> will
7303 attempt to figure out the remote SSL protocol version. See
7304 L<curl_easy_setopt(3)> for more details.
7306 =item B<Format> B<Command>|B<JSON>
7308 Format of the output to generate. If set to B<Command>, will create output that
7309 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7310 create output in the I<JavaScript Object Notation> (JSON).
7312 Defaults to B<Command>.
7314 =item B<StoreRates> B<true|false>
7316 If set to B<true>, convert counter values to rates. If set to B<false> (the
7317 default) counter values are stored as is, i.e. as an increasing integer number.
7319 =item B<BufferSize> I<Bytes>
7321 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7322 requests will be generated, but more metrics will be batched / metrics are
7323 cached for longer before being sent, introducing additional delay until they
7324 are available on the server side. I<Bytes> must be at least 1024 and cannot
7325 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7326 Defaults to C<4096>.
7328 =item B<LowSpeedLimit> I<Bytes per Second>
7330 Sets the minimal transfer rate in I<Bytes per Second> below which the
7331 connection with the HTTP server will be considered too slow and aborted. All
7332 the data submitted over this connection will probably be lost. Defaults to 0,
7333 which means no minimum transfer rate is enforced.
7335 =item B<Timeout> I<Timeout>
7337 Sets the maximum time in milliseconds given for HTTP POST operations to
7338 complete. When this limit is reached, the POST operation will be aborted, and
7339 all the data in the current send buffer will probably be lost. Defaults to 0,
7340 which means the connection never times out.
7342 The C<write_http> plugin regularly submits the collected values to the HTTP
7343 server. How frequently this happens depends on how much data you are collecting
7344 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
7345 slightly below this interval, which you can estimate by monitoring the network
7346 traffic between collectd and the HTTP server.
7348 =back
7350 =head2 Plugin C<write_kafka>
7352 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7353 queue.
7354 Synopsis:
7356 <Plugin "write_kafka">
7357 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7358 <Topic "collectd">
7359 Format JSON
7360 </Topic>
7361 </Plugin>
7363 The following options are understood by the I<write_kafka plugin>:
7365 =over 4
7367 =item E<lt>B<Topic> I<Name>E<gt>
7369 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7370 is given a unique I<Name> and specifies one kafka producer.
7371 Inside the B<Topic> block, the following per-topic options are
7372 understood:
7374 =over 4
7376 =item B<Property> I<String> I<String>
7378 Configure the named property for the current topic. Properties are
7379 forwarded to the kafka producer library B<librdkafka>.
7381 =item B<Key> I<String>
7383 Use the specified string as a partioning key for the topic. Kafka breaks
7384 topic into partitions and guarantees that for a given topology, the same
7385 consumer will be used for a specific key. The special (case insensitive)
7386 string B<Random> can be used to specify that an arbitrary partition should
7387 be used.
7389 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7391 Selects the format in which messages are sent to the broker. If set to
7392 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7393 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7395 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7396 an easy and straight forward exchange format.
7398 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7399 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7401 =item B<StoreRates> B<true>|B<false>
7403 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7404 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7405 default), no conversion is performed. Otherwise the conversion is performed
7406 using the internal value cache.
7408 Please note that currently this option is only used if the B<Format> option has
7409 been set to B<JSON>.
7411 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7413 A prefix can be added in the metric name when outputting in the I<Graphite>
7414 format. It's added before the I<Host> name.
7415 Metric name will be
7416 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>>
7418 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7420 A postfix can be added in the metric name when outputting in the I<Graphite>
7421 format. It's added after the I<Host> name.
7422 Metric name will be
7423 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>>
7425 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7427 Specify a character to replace dots (.) in the host part of the metric name.
7428 In I<Graphite> metric name, dots are used as separators between different
7429 metric parts (host, plugin, type).
7430 Default is C<_> (I<Underscore>).
7432 =item B<GraphiteSeparateInstances> B<false>|B<true>
7434 If set to B<true>, the plugin instance and type instance will be in their own
7435 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7436 default), the plugin and plugin instance (and likewise the type and type
7437 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7439 =item B<StoreRates> B<true>|B<false>
7441 If set to B<true> (the default), convert counter values to rates. If set to
7442 B<false> counter values are stored as is, i.e. as an increasing integer number.
7444 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7445 converted values will have "rate" appended to the data source type, e.g.
7446 C<ds_type:derive:rate>.
7448 =back
7450 =item B<Property> I<String> I<String>
7452 Configure the kafka producer through properties, you almost always will
7453 want to set B<metadata.broker.list> to your Kafka broker list.
7455 =back
7457 =head2 Plugin C<write_redis>
7459 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7461 Synopsis:
7463 <Plugin "write_redis">
7464 <Node "example">
7465 Host "localhost"
7466 Port "6379"
7467 Timeout 1000
7468 </Node>
7469 </Plugin>
7471 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7472 the timestamp as the score. Retrieving a date range can then be done using the
7473 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
7474 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7475 retrieved using the C<SMEMBERS> I<Redis> command. See
7476 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7477 details.
7479 The information shown in the synopsis above is the I<default configuration>
7480 which is used by the plugin if no configuration is present.
7482 The plugin can send values to multiple instances of I<Redis> by specifying
7483 one B<Node> block for each instance. Within the B<Node> blocks, the following
7484 options are available:
7486 =over 4
7488 =item B<Node> I<Nodename>
7490 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7491 instance running in an specified host and port. The name for node is a
7492 canonical identifier which is used as I<plugin instance>. It is limited to
7493 64E<nbsp>characters in length.
7495 =item B<Host> I<Hostname>
7497 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7498 running on.
7500 =item B<Port> I<Port>
7502 The B<Port> option is the TCP port on which the Redis instance accepts
7503 connections. Either a service name of a port number may be given. Please note
7504 that numerical port numbers must be given as a string, too.
7506 =item B<Timeout> I<Milliseconds>
7508 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7510 =back
7512 =head2 Plugin C<write_riemann>
7514 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7515 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7516 I<Riemann> using UDP packets.
7518 Synopsis:
7520 <Plugin "write_riemann">
7521 <Node "example">
7522 Host "localhost"
7523 Port "5555"
7524 Protocol UDP
7525 StoreRates true
7526 AlwaysAppendDS false
7527 TTLFactor 2.0
7528 </Node>
7529 Tag "foobar"
7530 Attribute "foo" "bar"
7531 </Plugin>
7533 The following options are understood by the I<write_riemann plugin>:
7535 =over 4
7537 =item E<lt>B<Node> I<Name>E<gt>
7539 The plugin's configuration consists of one or more B<Node> blocks. Each block
7540 is given a unique I<Name> and specifies one connection to an instance of
7541 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7542 understood:
7544 =over 4
7546 =item B<Host> I<Address>
7548 Hostname or address to connect to. Defaults to C<localhost>.
7550 =item B<Port> I<Service>
7552 Service name or port number to connect to. Defaults to C<5555>.
7554 =item B<Protocol> B<UDP>|B<TCP>
7556 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7557 B<TCP>.
7559 =item B<Batch> B<true>|B<false>
7561 If set to B<true> and B<Protocol> is set to B<TCP>,
7562 events will be batched in memory and flushed at
7563 regular intervals or when B<BatchMaxSize> is exceeded.
7565 Notifications are not batched and sent as soon as possible.
7567 When enabled, it can occur that events get processed by the Riemann server
7568 close to or after their expiration time. Tune the B<TTLFactor> and
7569 B<BatchMaxSize> settings according to the amount of values collected, if this
7570 is an issue.
7572 Defaults to true
7574 =item B<BatchMaxSize> I<size>
7576 Maximum payload size for a riemann packet. Defaults to 8192
7578 =item B<StoreRates> B<true>|B<false>
7580 If set to B<true> (the default), convert counter values to rates. If set to
7581 B<false> counter values are stored as is, i.e. as an increasing integer number.
7583 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7584 converted values will have "rate" appended to the data source type, e.g.
7585 C<ds_type:derive:rate>.
7587 =item B<AlwaysAppendDS> B<false>|B<true>
7589 If set the B<true>, append the name of the I<Data Source> (DS) to the
7590 "service", i.e. the field that, together with the "host" field, uniquely
7591 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7592 only done when there is more than one DS.
7594 =item B<TTLFactor> I<Factor>
7596 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7597 event is considered active. I<collectd> populates this field based on the
7598 metrics interval setting. This setting controls the factor with which the
7599 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7600 know exactly what you're doing, you should only increase this setting from its
7601 default value.
7603 =item B<Notifications> B<false>|B<true>
7605 If set to B<true>, create riemann events for notifications. This is B<true>
7606 by default. When processing thresholds from write_riemann, it might prove
7607 useful to avoid getting notification events.
7609 =item B<CheckThresholds> B<false>|B<true>
7611 If set to B<true>, attach state to events based on thresholds defined
7612 in the B<Threshold> plugin. Defaults to B<false>.
7614 =item B<EventServicePrefix> I<String>
7616 Add the given string as a prefix to the event service name.
7617 If B<EventServicePrefix> not set or set to an empty string (""),
7618 no prefix will be used.
7620 =back
7622 =item B<Tag> I<String>
7624 Add the given string as an additional tag to the metric being sent to
7625 I<Riemann>.
7627 =item B<Attribute> I<String> I<String>
7629 Consider the two given strings to be the key and value of an additional
7630 attribute for each metric being sent out to I<Riemann>.
7632 =back
7634 =head2 Plugin C<write_sensu>
7636 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
7637 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
7638 a local I<Sensu> client using a TCP socket.
7640 At the moment, the I<write_sensu plugin> does not send over a collectd_host
7641 parameter so it is not possible to use one collectd instance as a gateway for
7642 others. Each collectd host must pair with one I<Sensu> client.
7644 Synopsis:
7646 <Plugin "write_sensu">
7647 <Node "example">
7648 Host "localhost"
7649 Port "3030"
7650 StoreRates true
7651 AlwaysAppendDS false
7652 MetricHandler "influx"
7653 MetricHandler "default"
7654 NotificationHandler "flapjack"
7655 NotificationHandler "howling_monkey"
7656 Notifications true
7657 </Node>
7658 Tag "foobar"
7659 Attribute "foo" "bar"
7660 </Plugin>
7662 The following options are understood by the I<write_sensu plugin>:
7664 =over 4
7666 =item E<lt>B<Node> I<Name>E<gt>
7668 The plugin's configuration consists of one or more B<Node> blocks. Each block
7669 is given a unique I<Name> and specifies one connection to an instance of
7670 I<Sensu>. Inside the B<Node> block, the following per-connection options are
7671 understood:
7673 =over 4
7675 =item B<Host> I<Address>
7677 Hostname or address to connect to. Defaults to C<localhost>.
7679 =item B<Port> I<Service>
7681 Service name or port number to connect to. Defaults to C<3030>.
7683 =item B<StoreRates> B<true>|B<false>
7685 If set to B<true> (the default), convert counter values to rates. If set to
7686 B<false> counter values are stored as is, i.e. as an increasing integer number.
7688 This will be reflected in the C<collectd_data_source_type> tag: If
7689 B<StoreRates> is enabled, converted values will have "rate" appended to the
7690 data source type, e.g. C<collectd_data_source_type:derive:rate>.
7692 =item B<AlwaysAppendDS> B<false>|B<true>
7694 If set the B<true>, append the name of the I<Data Source> (DS) to the
7695 "service", i.e. the field that, together with the "host" field, uniquely
7696 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
7697 only done when there is more than one DS.
7699 =item B<Notifications> B<false>|B<true>
7701 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
7702 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7704 =item B<Metrics> B<false>|B<true>
7706 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
7707 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7710 =item B<Separator> I<String>
7712 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
7714 =item B<MetricHandler> I<String>
7716 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
7717 several of them, one per line. Defaults to no handler.
7719 =item B<NotificationHandler> I<String>
7721 Add a handler that will be set when notifications are sent to I<Sensu>. You can
7722 add several of them, one per line. Defaults to no handler.
7724 =item B<EventServicePrefix> I<String>
7726 Add the given string as a prefix to the event service name.
7727 If B<EventServicePrefix> not set or set to an empty string (""),
7728 no prefix will be used.
7730 =back
7732 =item B<Tag> I<String>
7734 Add the given string as an additional tag to the metric being sent to
7735 I<Sensu>.
7737 =item B<Attribute> I<String> I<String>
7739 Consider the two given strings to be the key and value of an additional
7740 attribute for each metric being sent out to I<Sensu>.
7742 =back
7744 =head2 Plugin C<zookeeper>
7746 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7747 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
7748 client port.
7750 B<Synopsis:>
7752 <Plugin "zookeeper">
7753 Host "127.0.0.1"
7754 Port "2181"
7755 </Plugin>
7757 =over 4
7759 =item B<Host> I<Address>
7761 Hostname or address to connect to. Defaults to C<localhost>.
7763 =item B<Port> I<Service>
7765 Service name or port number to connect to. Defaults to C<2181>.
7767 =back
7769 =head1 THRESHOLD CONFIGURATION
7771 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7772 we mean that the values are not only stored or sent somewhere, but that they
7773 are judged and, if a problem is recognized, acted upon. The only action
7774 collectd takes itself is to generate and dispatch a "notification". Plugins can
7775 register to receive notifications and perform appropriate further actions.
7777 Since systems and what you expect them to do differ a lot, you can configure
7778 B<thresholds> for your values freely. This gives you a lot of flexibility but
7779 also a lot of responsibility.
7781 Every time a value is out of range a notification is dispatched. This means
7782 that the idle percentage of your CPU needs to be less then the configured
7783 threshold only once for a notification to be generated. There's no such thing
7784 as a moving average or similar - at least not now.
7786 Also, all values that match a threshold are considered to be relevant or
7787 "interesting". As a consequence collectd will issue a notification if they are
7788 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7789 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7790 "2" (the default) and some hosts sends it's CPU statistics to the server every
7791 60 seconds, a notification will be dispatched after about 120 seconds. It may
7792 take a little longer because the timeout is checked only once each B<Interval>
7793 on the server.
7795 When a value comes within range again or is received after it was missing, an
7796 "OKAY-notification" is dispatched.
7798 Here is a configuration example to get you started. Read below for more
7799 information.
7801 <Plugin threshold>
7802 <Type "foo">
7803 WarningMin 0.00
7804 WarningMax 1000.00
7805 FailureMin 0.00
7806 FailureMax 1200.00
7807 Invert false
7808 Instance "bar"
7809 </Type>
7811 <Plugin "interface">
7812 Instance "eth0"
7813 <Type "if_octets">
7814 FailureMax 10000000
7815 DataSource "rx"
7816 </Type>
7817 </Plugin>
7819 <Host "hostname">
7820 <Type "cpu">
7821 Instance "idle"
7822 FailureMin 10
7823 </Type>
7825 <Plugin "memory">
7826 <Type "memory">
7827 Instance "cached"
7828 WarningMin 100000000
7829 </Type>
7830 </Plugin>
7831 </Host>
7832 </Plugin>
7834 There are basically two types of configuration statements: The C<Host>,
7835 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7836 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7837 C<Instance> option. You can combine the block by nesting the blocks, though
7838 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7839 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7840 C<Type> may not contain other blocks. If multiple blocks apply to the same
7841 value the most specific block is used.
7843 The other statements specify the threshold to configure. They B<must> be
7844 included in a C<Type> block. Currently the following statements are recognized:
7846 =over 4
7848 =item B<FailureMax> I<Value>
7850 =item B<WarningMax> I<Value>
7852 Sets the upper bound of acceptable values. If unset defaults to positive
7853 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7854 will be created. If the value is greater than B<WarningMax> but less than (or
7855 equal to) B<FailureMax> a B<WARNING> notification will be created.
7857 =item B<FailureMin> I<Value>
7859 =item B<WarningMin> I<Value>
7861 Sets the lower bound of acceptable values. If unset defaults to negative
7862 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7863 be created. If the value is less than B<WarningMin> but greater than (or equal
7864 to) B<FailureMin> a B<WARNING> notification will be created.
7866 =item B<DataSource> I<DSName>
7868 Some data sets have more than one "data source". Interesting examples are the
7869 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7870 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7871 system load data set, C<load>, even has three data sources: C<shortterm>,
7872 C<midterm>, and C<longterm>.
7874 Normally, all data sources are checked against a configured threshold. If this
7875 is undesirable, or if you want to specify different limits for each data
7876 source, you can use the B<DataSource> option to have a threshold apply only to
7877 one data source.
7879 =item B<Invert> B<true>|B<false>
7881 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7882 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7883 B<WarningMax>) are not okay. Defaults to B<false>.
7885 =item B<Persist> B<true>|B<false>
7887 Sets how often notifications are generated. If set to B<true> one notification
7888 will be generated for each value that is out of the acceptable range. If set to
7889 B<false> (the default) then a notification is only generated if a value is out
7890 of range but the previous value was okay.
7892 This applies to missing values, too: If set to B<true> a notification about a
7893 missing value is generated once every B<Interval> seconds. If set to B<false>
7894 only one such notification is generated until the value appears again.
7896 =item B<Percentage> B<true>|B<false>
7898 If set to B<true>, the minimum and maximum values given are interpreted as
7899 percentage value, relative to the other data sources. This is helpful for
7900 example for the "df" type, where you may want to issue a warning when less than
7901 5E<nbsp>% of the total space is available. Defaults to B<false>.
7903 =item B<Hits> I<Number>
7905 Delay creating the notification until the threshold has been passed I<Number>
7906 times. When a notification has been generated, or when a subsequent value is
7907 inside the threshold, the counter is reset. If, for example, a value is
7908 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7909 will be dispatched at most once every 30E<nbsp>seconds.
7911 This is useful when short bursts are not a problem. If, for example, 100% CPU
7912 usage for up to a minute is normal (and data is collected every
7913 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7915 =item B<Hysteresis> I<Number>
7917 When set to non-zero, a hysteresis value is applied when checking minimum and
7918 maximum bounds. This is useful for values that increase slowly and fluctuate a
7919 bit while doing so. When these values come close to the threshold, they may
7920 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7922 If, for example, the threshold is configures as
7924 WarningMax 100.0
7925 Hysteresis 1.0
7927 then a I<Warning> notification is created when the value exceeds I<101> and the
7928 corresponding I<Okay> notification is only created once the value falls below
7929 I<99>, thus avoiding the "flapping".
7931 =back
7933 =head1 FILTER CONFIGURATION
7935 Starting with collectd 4.6 there is a powerful filtering infrastructure
7936 implemented in the daemon. The concept has mostly been copied from
7937 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7938 terminology, so that users that are familiar with iptables feel right at home.
7940 =head2 Terminology
7942 The following are the terms used in the remainder of the filter configuration
7943 documentation. For an ASCII-art schema of the mechanism, see
7944 L<"General structure"> below.
7946 =over 4
7948 =item B<Match>
7950 A I<match> is a criteria to select specific values. Examples are, of course, the
7951 name of the value or it's current value.
7953 Matches are implemented in plugins which you have to load prior to using the
7954 match. The name of such plugins starts with the "match_" prefix.
7956 =item B<Target>
7958 A I<target> is some action that is to be performed with data. Such actions
7959 could, for example, be to change part of the value's identifier or to ignore
7960 the value completely.
7962 Some of these targets are built into the daemon, see L<"Built-in targets">
7963 below. Other targets are implemented in plugins which you have to load prior to
7964 using the target. The name of such plugins starts with the "target_" prefix.
7966 =item B<Rule>
7968 The combination of any number of matches and at least one target is called a
7969 I<rule>. The target actions will be performed for all values for which B<all>
7970 matches apply. If the rule does not have any matches associated with it, the
7971 target action will be performed for all values.
7973 =item B<Chain>
7975 A I<chain> is a list of rules and possibly default targets. The rules are tried
7976 in order and if one matches, the associated target will be called. If a value
7977 is handled by a rule, it depends on the target whether or not any subsequent
7978 rules are considered or if traversal of the chain is aborted, see
7979 L<"Flow control"> below. After all rules have been checked, the default targets
7980 will be executed.
7982 =back
7984 =head2 General structure
7986 The following shows the resulting structure:
7988 +---------+
7989 ! Chain !
7990 +---------+
7991 !
7992 V
7993 +---------+ +---------+ +---------+ +---------+
7994 ! Rule !->! Match !->! Match !->! Target !
7995 +---------+ +---------+ +---------+ +---------+
7996 !
7997 V
7998 +---------+ +---------+ +---------+
7999 ! Rule !->! Target !->! Target !
8000 +---------+ +---------+ +---------+
8001 !
8002 V
8003 :
8004 :
8005 !
8006 V
8007 +---------+ +---------+ +---------+
8008 ! Rule !->! Match !->! Target !
8009 +---------+ +---------+ +---------+
8010 !
8011 V
8012 +---------+
8013 ! Default !
8014 ! Target !
8015 +---------+
8017 =head2 Flow control
8019 There are four ways to control which way a value takes through the filter
8020 mechanism:
8022 =over 4
8024 =item B<jump>
8026 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
8027 process the value with another chain. When the called chain finishes, usually
8028 the next target or rule after the jump is executed.
8030 =item B<stop>
8032 The stop condition, signaled for example by the built-in target B<stop>, causes
8033 all processing of the value to be stopped immediately.
8035 =item B<return>
8037 Causes processing in the current chain to be aborted, but processing of the
8038 value generally will continue. This means that if the chain was called via
8039 B<Jump>, the next target or rule after the jump will be executed. If the chain
8040 was not called by another chain, control will be returned to the daemon and it
8041 may pass the value to another chain.
8043 =item B<continue>
8045 Most targets will signal the B<continue> condition, meaning that processing
8046 should continue normally. There is no special built-in target for this
8047 condition.
8049 =back
8051 =head2 Synopsis
8053 The configuration reflects this structure directly:
8055 PostCacheChain "PostCache"
8056 <Chain "PostCache">
8057 <Rule "ignore_mysql_show">
8058 <Match "regex">
8059 Plugin "^mysql$"
8060 Type "^mysql_command$"
8061 TypeInstance "^show_"
8062 </Match>
8063 <Target "stop">
8064 </Target>
8065 </Rule>
8066 <Target "write">
8067 Plugin "rrdtool"
8068 </Target>
8069 </Chain>
8071 The above configuration example will ignore all values where the plugin field
8072 is "mysql", the type is "mysql_command" and the type instance begins with
8073 "show_". All other values will be sent to the C<rrdtool> write plugin via the
8074 default target of the chain. Since this chain is run after the value has been
8075 added to the cache, the MySQL C<show_*> command statistics will be available
8076 via the C<unixsock> plugin.
8078 =head2 List of configuration options
8080 =over 4
8082 =item B<PreCacheChain> I<ChainName>
8084 =item B<PostCacheChain> I<ChainName>
8086 Configure the name of the "pre-cache chain" and the "post-cache chain". The
8087 argument is the name of a I<chain> that should be executed before and/or after
8088 the values have been added to the cache.
8090 To understand the implications, it's important you know what is going on inside
8091 I<collectd>. The following diagram shows how values are passed from the
8092 read-plugins to the write-plugins:
8094 +---------------+
8095 ! Read-Plugin !
8096 +-------+-------+
8097 !
8098 + - - - - V - - - - +
8099 : +---------------+ :
8100 : ! Pre-Cache ! :
8101 : ! Chain ! :
8102 : +-------+-------+ :
8103 : ! :
8104 : V :
8105 : +-------+-------+ : +---------------+
8106 : ! Cache !--->! Value Cache !
8107 : ! insert ! : +---+---+-------+
8108 : +-------+-------+ : ! !
8109 : ! ,------------' !
8110 : V V : V
8111 : +-------+---+---+ : +-------+-------+
8112 : ! Post-Cache +--->! Write-Plugins !
8113 : ! Chain ! : +---------------+
8114 : +---------------+ :
8115 : :
8116 : dispatch values :
8117 + - - - - - - - - - +
8119 After the values are passed from the "read" plugins to the dispatch functions,
8120 the pre-cache chain is run first. The values are added to the internal cache
8121 afterwards. The post-cache chain is run after the values have been added to the
8122 cache. So why is it such a huge deal if chains are run before or after the
8123 values have been added to this cache?
8125 Targets that change the identifier of a value list should be executed before
8126 the values are added to the cache, so that the name in the cache matches the
8127 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8128 this cache to receive a list of all available values. If you change the
8129 identifier after the value list has been added to the cache, this may easily
8130 lead to confusion, but it's not forbidden of course.
8132 The cache is also used to convert counter values to rates. These rates are, for
8133 example, used by the C<value> match (see below). If you use the rate stored in
8134 the cache B<before> the new value is added, you will use the old, B<previous>
8135 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8136 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8137 command.
8139 Last but not last, the B<stop> target makes a difference: If the pre-cache
8140 chain returns the stop condition, the value will not be added to the cache and
8141 the post-cache chain will not be run.
8143 =item B<Chain> I<Name>
8145 Adds a new chain with a certain name. This name can be used to refer to a
8146 specific chain, for example to jump to it.
8148 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8150 =item B<Rule> [I<Name>]
8152 Adds a new rule to the current chain. The name of the rule is optional and
8153 currently has no meaning for the daemon.
8155 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8156 must be at least one B<Target> block.
8158 =item B<Match> I<Name>
8160 Adds a match to a B<Rule> block. The name specifies what kind of match should
8161 be performed. Available matches depend on the plugins that have been loaded.
8163 The arguments inside the B<Match> block are passed to the plugin implementing
8164 the match, so which arguments are valid here depends on the plugin being used.
8165 If you do not need any to pass any arguments to a match, you can use the
8166 shorter syntax:
8168 Match "foobar"
8170 Which is equivalent to:
8172 <Match "foobar">
8173 </Match>
8175 =item B<Target> I<Name>
8177 Add a target to a rule or a default target to a chain. The name specifies what
8178 kind of target is to be added. Which targets are available depends on the
8179 plugins being loaded.
8181 The arguments inside the B<Target> block are passed to the plugin implementing
8182 the target, so which arguments are valid here depends on the plugin being used.
8183 If you do not need any to pass any arguments to a target, you can use the
8184 shorter syntax:
8186 Target "stop"
8188 This is the same as writing:
8190 <Target "stop">
8191 </Target>
8193 =back
8195 =head2 Built-in targets
8197 The following targets are built into the core daemon and therefore need no
8198 plugins to be loaded:
8200 =over 4
8202 =item B<return>
8204 Signals the "return" condition, see the L<"Flow control"> section above. This
8205 causes the current chain to stop processing the value and returns control to
8206 the calling chain. The calling chain will continue processing targets and rules
8207 just after the B<jump> target (see below). This is very similar to the
8208 B<RETURN> target of iptables, see L<iptables(8)>.
8210 This target does not have any options.
8212 Example:
8214 Target "return"
8216 =item B<stop>
8218 Signals the "stop" condition, see the L<"Flow control"> section above. This
8219 causes processing of the value to be aborted immediately. This is similar to
8220 the B<DROP> target of iptables, see L<iptables(8)>.
8222 This target does not have any options.
8224 Example:
8226 Target "stop"
8228 =item B<write>
8230 Sends the value to "write" plugins.
8232 Available options:
8234 =over 4
8236 =item B<Plugin> I<Name>
8238 Name of the write plugin to which the data should be sent. This option may be
8239 given multiple times to send the data to more than one write plugin. If the
8240 plugin supports multiple instances, the plugin's instance(s) must also be
8241 specified.
8243 =back
8245 If no plugin is explicitly specified, the values will be sent to all available
8246 write plugins.
8248 Single-instance plugin example:
8250 <Target "write">
8251 Plugin "rrdtool"
8252 </Target>
8254 Multi-instance plugin example:
8256 <Plugin "write_graphite">
8257 <Node "foo">
8258 ...
8259 </Node>
8260 <Node "bar">
8261 ...
8262 </Node>
8263 </Plugin>
8264 ...
8265 <Target "write">
8266 Plugin "write_graphite/foo"
8267 </Target>
8269 =item B<jump>
8271 Starts processing the rules of another chain, see L<"Flow control"> above. If
8272 the end of that chain is reached, or a stop condition is encountered,
8273 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
8274 next target or the next rule. This is similar to the B<-j> command line option
8275 of iptables, see L<iptables(8)>.
8277 Available options:
8279 =over 4
8281 =item B<Chain> I<Name>
8283 Jumps to the chain I<Name>. This argument is required and may appear only once.
8285 =back
8287 Example:
8289 <Target "jump">
8290 Chain "foobar"
8291 </Target>
8293 =back
8295 =head2 Available matches
8297 =over 4
8299 =item B<regex>
8301 Matches a value using regular expressions.
8303 Available options:
8305 =over 4
8307 =item B<Host> I<Regex>
8309 =item B<Plugin> I<Regex>
8311 =item B<PluginInstance> I<Regex>
8313 =item B<Type> I<Regex>
8315 =item B<TypeInstance> I<Regex>
8317 Match values where the given regular expressions match the various fields of
8318 the identifier of a value. If multiple regular expressions are given, B<all>
8319 regexen must match for a value to match.
8321 =item B<Invert> B<false>|B<true>
8323 When set to B<true>, the result of the match is inverted, i.e. all value lists
8324 where all regular expressions apply are not matched, all other value lists are
8325 matched. Defaults to B<false>.
8327 =back
8329 Example:
8331 <Match "regex">
8332 Host "customer[0-9]+"
8333 Plugin "^foobar$"
8334 </Match>
8336 =item B<timediff>
8338 Matches values that have a time which differs from the time on the server.
8340 This match is mainly intended for servers that receive values over the
8341 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8342 is very sensitive to the timestamp used when updating the RRD files. In
8343 particular, the time must be ever increasing. If a misbehaving client sends one
8344 packet with a timestamp far in the future, all further packets with a correct
8345 time will be ignored because of that one packet. What's worse, such corrupted
8346 RRD files are hard to fix.
8348 This match lets one match all values B<outside> a specified time range
8349 (relative to the server's time), so you can use the B<stop> target (see below)
8350 to ignore the value, for example.
8352 Available options:
8354 =over 4
8356 =item B<Future> I<Seconds>
8358 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8359 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8360 non-zero.
8362 =item B<Past> I<Seconds>
8364 Matches all values that are I<behind> of the server's time by I<Seconds> or
8365 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8366 non-zero.
8368 =back
8370 Example:
8372 <Match "timediff">
8373 Future 300
8374 Past 3600
8375 </Match>
8377 This example matches all values that are five minutes or more ahead of the
8378 server or one hour (or more) lagging behind.
8380 =item B<value>
8382 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8383 values. If a data-set consists of more than one data-source, all data-sources
8384 must match the specified ranges for a positive match.
8386 Available options:
8388 =over 4
8390 =item B<Min> I<Value>
8392 Sets the smallest value which still results in a match. If unset, behaves like
8393 negative infinity.
8395 =item B<Max> I<Value>
8397 Sets the largest value which still results in a match. If unset, behaves like
8398 positive infinity.
8400 =item B<Invert> B<true>|B<false>
8402 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8403 no-match is returned and vice versa. Please note that the B<Invert> setting
8404 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8405 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8407 =item B<DataSource> I<DSName> [I<DSName> ...]
8409 Select one or more of the data sources. If no data source is configured, all
8410 data sources will be checked. If the type handled by the match does not have a
8411 data source of the specified name(s), this will always result in no match
8412 (independent of the B<Invert> setting).
8414 =item B<Satisfy> B<Any>|B<All>
8416 Specifies how checking with several data sources is performed. If set to
8417 B<Any>, the match succeeds if one of the data sources is in the configured
8418 range. If set to B<All> the match only succeeds if all data sources are within
8419 the configured range. Default is B<All>.
8421 Usually B<All> is used for positive matches, B<Any> is used for negative
8422 matches. This means that with B<All> you usually check that all values are in a
8423 "good" range, while with B<Any> you check if any value is within a "bad" range
8424 (or outside the "good" range).
8426 =back
8428 Either B<Min> or B<Max>, but not both, may be unset.
8430 Example:
8432 # Match all values smaller than or equal to 100. Matches only if all data
8433 # sources are below 100.
8434 <Match "value">
8435 Max 100
8436 Satisfy "All"
8437 </Match>
8439 # Match if the value of any data source is outside the range of 0 - 100.
8440 <Match "value">
8441 Min 0
8442 Max 100
8443 Invert true
8444 Satisfy "Any"
8445 </Match>
8447 =item B<empty_counter>
8449 Matches all values with one or more data sources of type B<COUNTER> and where
8450 all counter values are zero. These counters usually I<never> increased since
8451 they started existing (and are therefore uninteresting), or got reset recently
8452 or overflowed and you had really, I<really> bad luck.
8454 Please keep in mind that ignoring such counters can result in confusing
8455 behavior: Counters which hardly ever increase will be zero for long periods of
8456 time. If the counter is reset for some reason (machine or service restarted,
8457 usually), the graph will be empty (NAN) for a long time. People may not
8458 understand why.
8460 =item B<hashed>
8462 Calculates a hash value of the host name and matches values according to that
8463 hash value. This makes it possible to divide all hosts into groups and match
8464 only values that are in a specific group. The intended use is in load
8465 balancing, where you want to handle only part of all data and leave the rest
8466 for other servers.
8468 The hashing function used tries to distribute the hosts evenly. First, it
8469 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8471 hash_value = 0;
8472 for (i = 0; host[i] != 0; i++)
8473 hash_value = (hash_value * 251) + host[i];
8475 The constant 251 is a prime number which is supposed to make this hash value
8476 more random. The code then checks the group for this host according to the
8477 I<Total> and I<Match> arguments:
8479 if ((hash_value % Total) == Match)
8480 matches;
8481 else
8482 does not match;
8484 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8485 groups), then the least significant bit of the hash value will be the XOR of
8486 all least significant bits in the host name. One consequence is that when you
8487 have two hosts, "server0.example.com" and "server1.example.com", where the host
8488 name differs in one digit only and the digits differ by one, those hosts will
8489 never end up in the same group.
8491 Available options:
8493 =over 4
8495 =item B<Match> I<Match> I<Total>
8497 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8498 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8499 be smaller than I<Total>. I<Total> must be at least one, although only values
8500 greater than one really do make any sense.
8502 You can repeat this option to match multiple groups, for example:
8504 Match 3 7
8505 Match 5 7
8507 The above config will divide the data into seven groups and match groups three
8508 and five. One use would be to keep every value on two hosts so that if one
8509 fails the missing data can later be reconstructed from the second host.
8511 =back
8513 Example:
8515 # Operate on the pre-cache chain, so that ignored values are not even in the
8516 # global cache.
8517 <Chain "PreCache">
8518 <Rule>
8519 <Match "hashed">
8520 # Divide all received hosts in seven groups and accept all hosts in
8521 # group three.
8522 Match 3 7
8523 </Match>
8524 # If matched: Return and continue.
8525 Target "return"
8526 </Rule>
8527 # If not matched: Return and stop.
8528 Target "stop"
8529 </Chain>
8531 =back
8533 =head2 Available targets
8535 =over 4
8537 =item B<notification>
8539 Creates and dispatches a notification.
8541 Available options:
8543 =over 4
8545 =item B<Message> I<String>
8547 This required option sets the message of the notification. The following
8548 placeholders will be replaced by an appropriate value:
8550 =over 4
8552 =item B<%{host}>
8554 =item B<%{plugin}>
8556 =item B<%{plugin_instance}>
8558 =item B<%{type}>
8560 =item B<%{type_instance}>
8562 These placeholders are replaced by the identifier field of the same name.
8564 =item B<%{ds:>I<name>B<}>
8566 These placeholders are replaced by a (hopefully) human readable representation
8567 of the current rate of this data source. If you changed the instance name
8568 (using the B<set> or B<replace> targets, see below), it may not be possible to
8569 convert counter values to rates.
8571 =back
8573 Please note that these placeholders are B<case sensitive>!
8575 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8577 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8578 used.
8580 =back
8582 Example:
8584 <Target "notification">
8585 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8586 Severity "WARNING"
8587 </Target>
8589 =item B<replace>
8591 Replaces parts of the identifier using regular expressions.
8593 Available options:
8595 =over 4
8597 =item B<Host> I<Regex> I<Replacement>
8599 =item B<Plugin> I<Regex> I<Replacement>
8601 =item B<PluginInstance> I<Regex> I<Replacement>
8603 =item B<TypeInstance> I<Regex> I<Replacement>
8605 Match the appropriate field with the given regular expression I<Regex>. If the
8606 regular expression matches, that part that matches is replaced with
8607 I<Replacement>. If multiple places of the input buffer match a given regular
8608 expression, only the first occurrence will be replaced.
8610 You can specify each option multiple times to use multiple regular expressions
8611 one after another.
8613 =back
8615 Example:
8617 <Target "replace">
8618 # Replace "example.net" with "example.com"
8619 Host "\\<example.net\\>" "example.com"
8621 # Strip "www." from hostnames
8622 Host "\\<www\\." ""
8623 </Target>
8625 =item B<set>
8627 Sets part of the identifier of a value to a given string.
8629 Available options:
8631 =over 4
8633 =item B<Host> I<String>
8635 =item B<Plugin> I<String>
8637 =item B<PluginInstance> I<String>
8639 =item B<TypeInstance> I<String>
8641 Set the appropriate field to the given string. The strings for plugin instance
8642 and type instance may be empty, the strings for host and plugin may not be
8643 empty. It's currently not possible to set the type of a value this way.
8645 =back
8647 Example:
8649 <Target "set">
8650 PluginInstance "coretemp"
8651 TypeInstance "core3"
8652 </Target>
8654 =back
8656 =head2 Backwards compatibility
8658 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8659 B<Chain> block, it will behave as it used to. This is equivalent to the
8660 following configuration:
8662 <Chain "PostCache">
8663 Target "write"
8664 </Chain>
8666 If you specify a B<PostCacheChain>, the B<write> target will not be added
8667 anywhere and you will have to make sure that it is called where appropriate. We
8668 suggest to add the above snippet as default target to your "PostCache" chain.
8670 =head2 Examples
8672 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8673 be an FQDN.
8675 <Chain "PreCache">
8676 <Rule "no_fqdn">
8677 <Match "regex">
8678 Host "^[^\.]*$"
8679 </Match>
8680 Target "stop"
8681 </Rule>
8682 Target "write"
8683 </Chain>
8685 =head1 SEE ALSO
8687 L<collectd(1)>,
8688 L<collectd-exec(5)>,
8689 L<collectd-perl(5)>,
8690 L<collectd-unixsock(5)>,
8691 L<types.db(5)>,
8692 L<hddtemp(8)>,
8693 L<iptables(8)>,
8694 L<kstat(3KSTAT)>,
8695 L<mbmon(1)>,
8696 L<psql(1)>,
8697 L<regex(7)>,
8698 L<rrdtool(1)>,
8699 L<sensors(1)>
8701 =head1 AUTHOR
8703 Florian Forster E<lt>octo@collectd.orgE<gt>
8705 =cut