5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/var/lib/collectd"
10 PIDFile "/run/collectd.pid"
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<#>) are ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
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.
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath which all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
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> the appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
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:
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
104 The following options are valid inside B<LoadPlugin> blocks:
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 its own support for specifying
131 an interval, that setting will take precedence.
133 =item B<FlushInterval> I<Seconds>
135 Specifies the interval, in seconds, to call the flush callback if it's
136 defined in this plugin. By default, this is disabled.
138 =item B<FlushTimeout> I<Seconds>
140 Specifies the value of the timeout argument of the flush callback.
144 =item B<AutoLoadPlugin> B<false>|B<true>
146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
147 using the B<LoadPlugin> statement documented above. If a
148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
149 handling callback for this plugin has been registered, a warning is logged and
150 the block is ignored.
152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
157 =item B<CollectInternalStats> B<false>|B<true>
159 When set to B<true>, various statistics about the I<collectd> daemon will be
160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
162 The following metrics are reported:
166 =item C<collectd-write_queue/queue_length>
168 The number of metrics currently in the write queue. You can limit the queue
169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
171 =item C<collectd-write_queue/derive-dropped>
173 The number of metrics dropped due to a queue length limitation.
174 If this value is non-zero, your system can't handle all incoming metrics and
175 protects itself against overload by dropping metrics.
177 =item C<collectd-cache/cache_size>
179 The number of elements in the metric cache (the cache you can interact with
180 using L<collectd-unixsock(5)>).
184 =item B<Include> I<Path> [I<pattern>]
186 If I<Path> points to a file, includes that file. If I<Path> points to a
187 directory, recursively includes all files within that directory and its
188 subdirectories. If the C<wordexp> function is available on your system,
189 shell-like wildcards are expanded before files are included. This means you can
190 use statements like the following:
192 Include "/etc/collectd.d/*.conf"
194 Starting with version 5.3, this may also be a block in which further options
195 affecting the behavior of B<Include> may be specified. The following option is
198 <Include "/etc/collectd.d">
204 =item B<Filter> I<pattern>
206 If the C<fnmatch> function is available on your system, a shell-like wildcard
207 I<pattern> may be specified to filter which files to include. This may be used
208 in combination with recursively including a directory to easily be able to
209 arbitrarily mix configuration files and other documents (e.g. README files).
210 The given example is similar to the first example above but includes all files
211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
215 If more than one file is included by a single B<Include> option, the files
216 will be included in lexicographical order (as defined by the C<strcmp>
217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
218 order in which the files are loaded.
220 To prevent loops and shooting yourself in the foot in interesting ways the
221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
222 most uses. Since symlinks are followed it is still possible to crash the daemon
223 by looping symlinks. In our opinion significant stupidity should result in an
224 appropriate amount of pain.
226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
227 file, but you cannot include files from within blocks.
229 =item B<PIDFile> I<File>
231 Sets where to write the PID file to. This file is overwritten when it exists
232 and deleted when the program is stopped. Some init-scripts might override this
233 setting using the B<-P> command-line option.
235 =item B<PluginDir> I<Directory>
237 Path to the plugins (shared objects) of collectd.
239 =item B<TypesDB> I<File> [I<File> ...]
241 Set one or more files that contain the data-set descriptions. See
242 L<types.db(5)> for a description of the format of this file.
244 If this option is not specified, a default file is read. If you need to define
245 custom types in addition to the types defined in the default file, you need to
246 explicitly load both. In other words, if the B<TypesDB> option is encountered
247 the default behavior is disabled and if you need the default types you have to
248 also explicitly load them.
250 =item B<Interval> I<Seconds>
252 Configures the interval in which to query the read plugins. Obviously smaller
253 values lead to a higher system load produced by collectd, while higher values
254 lead to more coarse statistics.
256 B<Warning:> You should set this once and then never touch it again. If you do,
257 I<you will have to delete all your RRD files> or know some serious RRDtool
258 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
260 =item B<MaxReadInterval> I<Seconds>
262 A read plugin doubles the interval between queries after each failed attempt
265 This options limits the maximum value of the interval. The default value is
268 =item B<Timeout> I<Iterations>
270 Consider a value list "missing" when no update has been read or received for
271 I<Iterations> iterations. By default, I<collectd> considers a value list
272 missing when no update has been received for twice the update interval. Since
273 this setting uses iterations, the maximum allowed time without update depends
274 on the I<Interval> information contained in each value list. This is used in
275 the I<Threshold> configuration to dispatch notifications about missing values,
276 see L<collectd-threshold(5)> for details.
278 =item B<ReadThreads> I<Num>
280 Number of threads to start for reading plugins. The default value is B<5>, but
281 you may want to increase this if you have more than five plugins that take a
282 long time to read. Mostly those are plugins that do network-IO. Setting this to
283 a value higher than the number of registered read callbacks is not recommended.
285 =item B<WriteThreads> I<Num>
287 Number of threads to start for dispatching value lists to write plugins. The
288 default value is B<5>, but you may want to increase this if you have more than
289 five plugins that may take relatively long to write to.
291 =item B<WriteQueueLimitHigh> I<HighNum>
293 =item B<WriteQueueLimitLow> I<LowNum>
295 Metrics are read by the I<read threads> and then put into a queue to be handled
296 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
297 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
298 running into memory issues in such a case, you can limit the size of this
301 By default, there is no limit and memory may grow indefinitely. This is most
302 likely not an issue for clients, i.e. instances that only handle the local
303 metrics. For servers it is recommended to set this to a non-zero value, though.
305 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
306 Each of them takes a numerical argument which is the number of metrics in the
307 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
308 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
309 I<will> be enqueued. If the number of metrics currently in the queue is between
310 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
311 proportional to the number of metrics in the queue (i.e. it increases linearly
312 until it reaches 100%.)
314 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
315 unset, the latter will default to half of B<WriteQueueLimitHigh>.
317 If you do not want to randomly drop values when the queue size is between
318 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
321 Enabling the B<CollectInternalStats> option is of great help to figure out the
322 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
324 =item B<Hostname> I<Name>
326 Sets the hostname that identifies a host. If you omit this setting, the
327 hostname will be determined using the L<gethostname(2)> system call.
329 =item B<FQDNLookup> B<true|false>
331 If B<Hostname> is determined automatically this setting controls whether or not
332 the daemon should try to figure out the "fully qualified domain name", FQDN.
333 This is done using a lookup of the name returned by C<gethostname>. This option
334 is enabled by default.
336 =item B<PreCacheChain> I<ChainName>
338 =item B<PostCacheChain> I<ChainName>
340 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
341 see L</"FILTER CONFIGURATION"> below on information on chains and how these
342 setting change the daemon's behavior.
346 =head1 PLUGIN OPTIONS
348 Some plugins may register own options. These options must be enclosed in a
349 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
350 require external configuration, too. The C<apache plugin>, for example,
351 required C<mod_status> to be configured in the webserver you're going to
352 collect data from. These plugins are listed below as well, even if they don't
353 require any configuration within collectd's configuration file.
355 A list of all plugins and a short summary for each plugin can be found in the
356 F<README> file shipped with the sourcecode and hopefully binary packets as
359 =head2 Plugin C<aggregation>
361 The I<Aggregation plugin> makes it possible to aggregate several values into
362 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
363 This can be put to a wide variety of uses, e.g. average and total CPU
364 statistics for your entire fleet.
366 The grouping is powerful but, as with many powerful tools, may be a bit
367 difficult to wrap your head around. The grouping will therefore be
368 demonstrated using an example: The average and sum of the CPU usage across
369 all CPUs of each host is to be calculated.
371 To select all the affected values for our example, set C<Plugin cpu> and
372 C<Type cpu>. The other values are left unspecified, meaning "all values". The
373 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
374 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
380 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
381 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
382 example, the intention is to have a new value for each host / type instance
383 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
384 It can be specified multiple times to group by more than one field.
387 GroupBy "TypeInstance"
389 We do neither specify nor group by I<plugin instance> (the CPU number), so all
390 metrics that differ in the CPU number only will be aggregated. Each
391 aggregation needs I<at least one> such field, otherwise no aggregation would
394 The full example configuration looks like this:
396 <Plugin "aggregation">
402 GroupBy "TypeInstance"
405 CalculateAverage true
409 There are a couple of limitations you should be aware of:
415 The I<Type> cannot be left unspecified, because it is not reasonable to add
416 apples to oranges. Also, the internal lookup structure won't work if you try
421 There must be at least one unspecified, ungrouped field. Otherwise nothing
426 As you can see in the example above, each aggregation has its own
427 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
428 blocks may match the same values, i.e. one value list can update multiple
429 aggregations. The following options are valid inside B<Aggregation> blocks:
433 =item B<Host> I<Host>
435 =item B<Plugin> I<Plugin>
437 =item B<PluginInstance> I<PluginInstance>
439 =item B<Type> I<Type>
441 =item B<TypeInstance> I<TypeInstance>
443 Selects the value lists to be added to this aggregation. B<Type> must be a
444 valid data set name, see L<types.db(5)> for details.
446 If the string starts with and ends with a slash (C</>), the string is
447 interpreted as a I<regular expression>. The regex flavor used are POSIX
448 extended regular expressions as described in L<regex(7)>. Example usage:
450 Host "/^db[0-9]\\.example\\.com$/"
452 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
454 Group valued by the specified field. The B<GroupBy> option may be repeated to
455 group by multiple fields.
457 =item B<SetHost> I<Host>
459 =item B<SetPlugin> I<Plugin>
461 =item B<SetPluginInstance> I<PluginInstance>
463 =item B<SetTypeInstance> I<TypeInstance>
465 Sets the appropriate part of the identifier to the provided string.
467 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
468 will be replaced with the aggregation function, e.g. "average". Not including
469 the placeholder will result in duplication warnings and/or messed up values if
470 more than one aggregation function are enabled.
472 The following example calculates the average usage of all "even" CPUs:
474 <Plugin "aggregation">
477 PluginInstance "/[0,2,4,6,8]$/"
481 SetPluginInstance "even-%{aggregation}"
484 GroupBy "TypeInstance"
486 CalculateAverage true
490 This will create the files:
496 foo.example.com/cpu-even-average/cpu-idle
500 foo.example.com/cpu-even-average/cpu-system
504 foo.example.com/cpu-even-average/cpu-user
512 =item B<CalculateNum> B<true>|B<false>
514 =item B<CalculateSum> B<true>|B<false>
516 =item B<CalculateAverage> B<true>|B<false>
518 =item B<CalculateMinimum> B<true>|B<false>
520 =item B<CalculateMaximum> B<true>|B<false>
522 =item B<CalculateStddev> B<true>|B<false>
524 Boolean options for enabling calculation of the number of value lists, their
525 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
526 are disabled by default.
530 =head2 Plugin C<amqp>
532 The I<AMQP plugin> can be used to communicate with other instances of
533 I<collectd> or third party applications using an AMQP message broker. Values
534 are sent to or received from the broker, which handles routing, queueing and
535 possibly filtering out messages.
540 # Send values to an AMQP broker
541 <Publish "some_name">
547 Exchange "amq.fanout"
548 # ExchangeType "fanout"
549 # RoutingKey "collectd"
551 # ConnectionRetryDelay 0
554 # GraphitePrefix "collectd."
555 # GraphiteEscapeChar "_"
556 # GraphiteSeparateInstances false
557 # GraphiteAlwaysAppendDS false
558 # GraphitePreserveSeparator false
561 # Receive values from an AMQP broker
562 <Subscribe "some_name">
568 Exchange "amq.fanout"
569 # ExchangeType "fanout"
572 # QueueAutoDelete true
573 # RoutingKey "collectd.#"
574 # ConnectionRetryDelay 0
578 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
579 blocks, which configure sending and receiving of values respectively. The two
580 blocks are very similar, so unless otherwise noted, an option can be used in
581 either block. The name given in the blocks starting tag is only used for
582 reporting messages, but may be used to support I<flushing> of certain
583 I<Publish> blocks in the future.
587 =item B<Host> I<Host>
589 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
590 the underlying communications library, I<rabbitmq-c>, which is "localhost".
592 =item B<Port> I<Port>
594 Service name or port number on which the AMQP broker accepts connections. This
595 argument must be a string, even if the numeric form is used. Defaults to
598 =item B<VHost> I<VHost>
600 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
602 =item B<User> I<User>
604 =item B<Password> I<Password>
606 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
609 =item B<Exchange> I<Exchange>
611 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
612 By default, "amq.fanout" will be used.
614 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
615 the given exchange and the I<queue> is created, using the I<routing key> if
616 configured. See the B<Queue> and B<RoutingKey> options below.
618 =item B<ExchangeType> I<Type>
620 If given, the plugin will try to create the configured I<exchange> with this
621 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
622 be bound to this exchange.
624 =item B<Queue> I<Queue> (Subscribe only)
626 Configures the I<queue> name to subscribe to. If no queue name was configured
627 explicitly, a unique queue name will be created by the broker.
629 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
631 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
632 or transient (will disappear if the AMQP broker is restarted). Defaults to
635 This option should be used in conjunction with the I<Persistent> option on the
638 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
640 Defines if the I<queue> subscribed to will be deleted once the last consumer
641 unsubscribes. Defaults to "true".
643 =item B<RoutingKey> I<Key>
645 In I<Publish> blocks, this configures the routing key to set on all outgoing
646 messages. If not given, the routing key will be computed from the I<identifier>
647 of the value. The host, plugin, type and the two instances are concatenated
648 together using dots as the separator and all containing dots replaced with
649 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
650 possible to receive only specific values using a "topic" exchange.
652 In I<Subscribe> blocks, configures the I<routing key> used when creating a
653 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
654 used to filter messages when using a "topic" exchange. If you're only
655 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
658 =item B<Persistent> B<true>|B<false> (Publish only)
660 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
661 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
662 default), the I<transient> delivery mode will be used, i.e. messages may be
663 lost due to high load, overflowing queues or similar issues.
665 =item B<ConnectionRetryDelay> I<Delay>
667 When the connection to the AMQP broker is lost, defines the time in seconds to
668 wait before attempting to reconnect. Defaults to 0, which implies collectd will
669 attempt to reconnect at each read interval (in Subscribe mode) or each time
670 values are ready for submission (in Publish mode).
672 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
674 Selects the format in which messages are sent to the broker. If set to
675 B<Command> (the default), values are sent as C<PUTVAL> commands which are
676 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
677 case, the C<Content-Type> header field will be set to C<text/collectd>.
679 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
680 an easy and straight forward exchange format. The C<Content-Type> header field
681 will be set to C<application/json>.
683 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
684 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
687 A subscribing client I<should> use the C<Content-Type> header field to
688 determine how to decode the values. Currently, the I<AMQP plugin> itself can
689 only decode the B<Command> format.
691 =item B<StoreRates> B<true>|B<false> (Publish only)
693 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
694 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
695 default), no conversion is performed. Otherwise the conversion is performed
696 using the internal value cache.
698 Please note that currently this option is only used if the B<Format> option has
701 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
703 A prefix can be added in the metric name when outputting in the I<Graphite> format.
704 It's added before the I<Host> name.
705 Metric name will be "<prefix><host><postfix><plugin><type><name>"
707 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
709 A postfix can be added in the metric name when outputting in the I<Graphite> format.
710 It's added after the I<Host> name.
711 Metric name will be "<prefix><host><postfix><plugin><type><name>"
713 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
715 Specify a character to replace dots (.) in the host part of the metric name.
716 In I<Graphite> metric name, dots are used as separators between different
717 metric parts (host, plugin, type).
718 Default is "_" (I<Underscore>).
720 =item B<GraphiteSeparateInstances> B<true>|B<false>
722 If set to B<true>, the plugin instance and type instance will be in their own
723 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
724 default), the plugin and plugin instance (and likewise the type and type
725 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
727 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
729 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
730 identifier. If set to B<false> (the default), this is only done when there is
733 =item B<GraphitePreserveSeparator> B<false>|B<true>
735 If set to B<false> (the default) the C<.> (dot) character is replaced with
736 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
737 is preserved, i.e. passed through.
741 =head2 Plugin C<apache>
743 To configure the C<apache>-plugin you first need to configure the Apache
744 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
745 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
746 the following snipped to base your Apache config upon:
749 <IfModule mod_status.c>
750 <Location /mod_status>
751 SetHandler server-status
755 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
756 also supported. It introduces a new field, called C<BusyServers>, to count the
757 number of currently connected clients. This field is also supported.
759 The configuration of the I<Apache> plugin consists of one or more
760 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
761 as the instance name. For example:
765 URL "http://www1.example.com/mod_status?auto"
768 URL "http://www2.example.com/mod_status?auto"
772 The instance name will be used as the I<plugin instance>. To emulate the old
773 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
774 plugin to work correctly, each instance name must be unique. This is not
775 enforced by the plugin and it is your responsibility to ensure it.
777 The following options are accepted within each I<Instance> block:
781 =item B<URL> I<http://host/mod_status?auto>
783 Sets the URL of the C<mod_status> output. This needs to be the output generated
784 by C<ExtendedStatus on> and it needs to be the machine readable output
785 generated by appending the C<?auto> argument. This option is I<mandatory>.
787 =item B<User> I<Username>
789 Optional user name needed for authentication.
791 =item B<Password> I<Password>
793 Optional password needed for authentication.
795 =item B<VerifyPeer> B<true|false>
797 Enable or disable peer SSL certificate verification. See
798 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
800 =item B<VerifyHost> B<true|false>
802 Enable or disable peer host name verification. If enabled, the plugin checks
803 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
804 certificate matches the host name provided by the B<URL> option. If this
805 identity check fails, the connection is aborted. Obviously, only works when
806 connecting to a SSL enabled server. Enabled by default.
808 =item B<CACert> I<File>
810 File that holds one or more SSL certificates. If you want to use HTTPS you will
811 possibly need this option. What CA certificates come bundled with C<libcurl>
812 and are checked by default depends on the distribution you use.
814 =item B<SSLCiphers> I<list of ciphers>
816 Specifies which ciphers to use in the connection. The list of ciphers
817 must specify valid ciphers. See
818 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
820 =item B<Timeout> I<Milliseconds>
822 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
823 milliseconds. By default, the configured B<Interval> is used to set the
828 =head2 Plugin C<apcups>
832 =item B<Host> I<Hostname>
834 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
835 that IPv6 support has been disabled unless someone can confirm or decline that
836 B<apcupsd> can handle it.
838 =item B<Port> I<Port>
840 TCP-Port to connect to. Defaults to B<3551>.
842 =item B<ReportSeconds> B<true>|B<false>
844 If set to B<true>, the time reported in the C<timeleft> metric will be
845 converted to seconds. This is the recommended setting. If set to B<false>, the
846 default for backwards compatibility, the time will be reported in minutes.
848 =item B<PersistentConnection> B<true>|B<false>
850 The plugin is designed to keep the connection to I<apcupsd> open between reads.
851 If plugin poll interval is greater than 15 seconds (hardcoded socket close
852 timeout in I<apcupsd> NIS), then this option is B<false> by default.
854 You can instruct the plugin to close the connection after each read by setting
855 this option to B<false> or force keeping the connection by setting it to B<true>.
857 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
858 the plugin will try to detect this problem and switch to an open-read-close mode.
862 =head2 Plugin C<aquaero>
864 This plugin collects the value of the available sensors in an
865 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
866 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
867 connection for monitoring and configuration. The board can handle multiple
868 temperature sensors, fans, water pumps and water level sensors and adjust the
869 output settings such as fan voltage or power used by the water pump based on
870 the available inputs using a configurable controller included in the board.
871 This plugin collects all the available inputs as well as some of the output
872 values chosen by this controller. The plugin is based on the I<libaquaero5>
873 library provided by I<aquatools-ng>.
877 =item B<Device> I<DevicePath>
879 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
880 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
881 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
885 =head2 Plugin C<ascent>
887 This plugin collects information about an Ascent server, a free server for the
888 "World of Warcraft" game. This plugin gathers the information by fetching the
889 XML status page using C<libcurl> and parses it using C<libxml2>.
891 The configuration options are the same as for the C<apache> plugin above:
895 =item B<URL> I<http://localhost/ascent/status/>
897 Sets the URL of the XML status output.
899 =item B<User> I<Username>
901 Optional user name needed for authentication.
903 =item B<Password> I<Password>
905 Optional password needed for authentication.
907 =item B<VerifyPeer> B<true|false>
909 Enable or disable peer SSL certificate verification. See
910 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
912 =item B<VerifyHost> B<true|false>
914 Enable or disable peer host name verification. If enabled, the plugin checks
915 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
916 certificate matches the host name provided by the B<URL> option. If this
917 identity check fails, the connection is aborted. Obviously, only works when
918 connecting to a SSL enabled server. Enabled by default.
920 =item B<CACert> I<File>
922 File that holds one or more SSL certificates. If you want to use HTTPS you will
923 possibly need this option. What CA certificates come bundled with C<libcurl>
924 and are checked by default depends on the distribution you use.
926 =item B<Timeout> I<Milliseconds>
928 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
929 milliseconds. By default, the configured B<Interval> is used to set the
934 =head2 Plugin C<barometer>
936 This plugin reads absolute air pressure using digital barometer sensor on a I2C
937 bus. Supported sensors are:
941 =item I<MPL115A2> from Freescale,
942 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
945 =item I<MPL3115> from Freescale
946 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
949 =item I<BMP085> from Bosch Sensortec
953 The sensor type - one of the above - is detected automatically by the plugin
954 and indicated in the plugin_instance (you will see subdirectory
955 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
956 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
957 (only one sensor can be used by the plugin).
959 The plugin provides absolute barometric pressure, air pressure reduced to sea
960 level (several possible approximations) and as an auxiliary value also internal
961 sensor temperature. It uses (expects/provides) typical metric units - pressure
962 in [hPa], temperature in [C], altitude in [m].
964 It was developed and tested under Linux only. The only platform dependency is
965 the standard Linux i2c-dev interface (the particular bus driver has to
966 support the SM Bus command subset).
968 The reduction or normalization to mean sea level pressure requires (depending
969 on selected method/approximation) also altitude and reference to temperature
970 sensor(s). When multiple temperature sensors are configured the minimum of
971 their values is always used (expecting that the warmer ones are affected by
972 e.g. direct sun light at that moment).
980 TemperatureOffset 0.0
983 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
988 =item B<Device> I<device>
990 The only mandatory configuration parameter.
992 Device name of the I2C bus to which the sensor is connected. Note that
993 typically you need to have loaded the i2c-dev module.
994 Using i2c-tools you can check/list i2c buses available on your system by:
998 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1002 This way you should be able to verify that the pressure sensor (either type) is
1003 connected and detected on address 0x60.
1005 =item B<Oversampling> I<value>
1007 Optional parameter controlling the oversampling/accuracy. Default value
1008 is 1 providing fastest and least accurate reading.
1010 For I<MPL115> this is the size of the averaging window. To filter out sensor
1011 noise a simple averaging using floating window of this configurable size is
1012 used. The plugin will use average of the last C<value> measurements (value of 1
1013 means no averaging). Minimal size is 1, maximal 1024.
1015 For I<MPL3115> this is the oversampling value. The actual oversampling is
1016 performed by the sensor and the higher value the higher accuracy and longer
1017 conversion time (although nothing to worry about in the collectd context).
1018 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1019 adjusted by the plugin to the closest supported one.
1021 For I<BMP085> this is the oversampling value. The actual oversampling is
1022 performed by the sensor and the higher value the higher accuracy and longer
1023 conversion time (although nothing to worry about in the collectd context).
1024 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1025 the closest supported one.
1027 =item B<PressureOffset> I<offset>
1029 Optional parameter for MPL3115 only.
1031 You can further calibrate the sensor by supplying pressure and/or temperature
1032 offsets. This is added to the measured/caclulated value (i.e. if the measured
1033 value is too high then use negative offset).
1034 In hPa, default is 0.0.
1036 =item B<TemperatureOffset> I<offset>
1038 Optional parameter for MPL3115 only.
1040 You can further calibrate the sensor by supplying pressure and/or temperature
1041 offsets. This is added to the measured/caclulated value (i.e. if the measured
1042 value is too high then use negative offset).
1043 In C, default is 0.0.
1045 =item B<Normalization> I<method>
1047 Optional parameter, default value is 0.
1049 Normalization method - what approximation/model is used to compute the mean sea
1050 level pressure from the air absolute pressure.
1052 Supported values of the C<method> (integer between from 0 to 2) are:
1056 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1057 do not need to configure C<Altitude> or C<TemperatureSensor>.
1059 =item B<1> - international formula for conversion ,
1061 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1062 For this method you have to configure C<Altitude> but do not need
1063 C<TemperatureSensor> (uses fixed global temperature average instead).
1065 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1066 Meteorological Service).
1067 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1068 For this method you have to configure both C<Altitude> and
1069 C<TemperatureSensor>.
1074 =item B<Altitude> I<altitude>
1076 The altitude (in meters) of the location where you meassure the pressure.
1078 =item B<TemperatureSensor> I<reference>
1080 Temperature sensor(s) which should be used as a reference when normalizing the
1081 pressure using C<Normalization> method 2.
1082 When specified more sensors a minimum is found and used each time. The
1083 temperature reading directly from this pressure sensor/plugin is typically not
1084 suitable as the pressure sensor will be probably inside while we want outside
1085 temperature. The collectd reference name is something like
1086 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1087 (<type_instance> is usually omitted when there is just single value type). Or
1088 you can figure it out from the path of the output data files.
1092 =head2 Plugin C<battery>
1094 The I<battery plugin> reports the remaining capacity, power and voltage of
1099 =item B<ValuesPercentage> B<false>|B<true>
1101 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1102 capacity remaining". Otherwise the capacity is stored as reported by the
1103 battery, most likely in "Wh". This option does not work with all input methods,
1104 in particular when only C</proc/pmu> is available on an old Linux system.
1105 Defaults to B<false>.
1107 =item B<ReportDegraded> B<false>|B<true>
1109 Typical laptop batteries degrade over time, meaning the capacity decreases with
1110 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1111 "last full capacity" and used to determine that a battery is "fully charged".
1113 When this option is set to B<false>, the default, the I<battery plugin> will
1114 only report the remaining capacity. If the B<ValuesPercentage> option is
1115 enabled, the relative remaining capacity is calculated as the ratio of the
1116 "remaining capacity" and the "last full capacity". This is what most tools,
1117 such as the status bar of desktop environments, also do.
1119 When set to B<true>, the battery plugin will report three values: B<charged>
1120 (remaining capacity), B<discharged> (difference between "last full capacity"
1121 and "remaining capacity") and B<degraded> (difference between "design capacity"
1122 and "last full capacity").
1124 =item B<QueryStateFS> B<false>|B<true>
1126 When set to B<true>, the battery plugin will only read statistics
1127 related to battery performance as exposed by StateFS at
1128 /run/state. StateFS is used in Mer-based Sailfish OS, for
1133 =head2 Plugin C<bind>
1135 Starting with BIND 9.5.0, the most widely used DNS server software provides
1136 extensive statistics about queries, responses and lots of other information.
1137 The bind plugin retrieves this information that's encoded in XML and provided
1138 via HTTP and submits the values to collectd.
1140 To use this plugin, you first need to tell BIND to make this information
1141 available. This is done with the C<statistics-channels> configuration option:
1143 statistics-channels {
1144 inet localhost port 8053;
1147 The configuration follows the grouping that can be seen when looking at the
1148 data with an XSLT compatible viewer, such as a modern web browser. It's
1149 probably a good idea to make yourself familiar with the provided values, so you
1150 can understand what the collected statistics actually mean.
1155 URL "http://localhost:8053/"
1170 Zone "127.in-addr.arpa/IN"
1174 The bind plugin accepts the following configuration options:
1180 URL from which to retrieve the XML data. If not specified,
1181 C<http://localhost:8053/> will be used.
1183 =item B<ParseTime> B<true>|B<false>
1185 When set to B<true>, the time provided by BIND will be parsed and used to
1186 dispatch the values. When set to B<false>, the local time source is queried.
1188 This setting is set to B<true> by default for backwards compatibility; setting
1189 this to B<false> is I<recommended> to avoid problems with timezones and
1192 =item B<OpCodes> B<true>|B<false>
1194 When enabled, statistics about the I<"OpCodes">, for example the number of
1195 C<QUERY> packets, are collected.
1199 =item B<QTypes> B<true>|B<false>
1201 When enabled, the number of I<incoming> queries by query types (for example
1202 C<A>, C<MX>, C<AAAA>) is collected.
1206 =item B<ServerStats> B<true>|B<false>
1208 Collect global server statistics, such as requests received over IPv4 and IPv6,
1209 successful queries, and failed updates.
1213 =item B<ZoneMaintStats> B<true>|B<false>
1215 Collect zone maintenance statistics, mostly information about notifications
1216 (zone updates) and zone transfers.
1220 =item B<ResolverStats> B<true>|B<false>
1222 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1223 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1224 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1225 default. Use the B<ResolverStats> option within a B<View "_default"> block
1226 instead for the same functionality.
1230 =item B<MemoryStats>
1232 Collect global memory statistics.
1236 =item B<Timeout> I<Milliseconds>
1238 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1239 milliseconds. By default, the configured B<Interval> is used to set the
1242 =item B<View> I<Name>
1244 Collect statistics about a specific I<"view">. BIND can behave different,
1245 mostly depending on the source IP-address of the request. These different
1246 configurations are called "views". If you don't use this feature, you most
1247 likely are only interested in the C<_default> view.
1249 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1250 information you want to collect about a view. If no B<View> block is
1251 configured, no detailed view statistics will be collected.
1255 =item B<QTypes> B<true>|B<false>
1257 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1258 C<MX>) is collected.
1262 =item B<ResolverStats> B<true>|B<false>
1264 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1265 (e.E<nbsp>g. queries over IPv4, lame servers).
1269 =item B<CacheRRSets> B<true>|B<false>
1271 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1272 type is collected. Negative entries (queries which resulted in an error, for
1273 example names that do not exist) are reported with a leading exclamation mark,
1278 =item B<Zone> I<Name>
1280 When given, collect detailed information about the given zone in the view. The
1281 information collected if very similar to the global B<ServerStats> information
1284 You can repeat this option to collect detailed information about multiple
1287 By default no detailed zone information is collected.
1293 =head2 Plugin C<ceph>
1295 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1296 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1298 A separate B<Daemon> block must be configured for each ceph daemon to be
1299 monitored. The following example will read daemon statistics from four
1300 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1303 LongRunAvgLatency false
1304 ConvertSpecialMetricTypes true
1306 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1309 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1312 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1315 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1319 The ceph plugin accepts the following configuration options:
1323 =item B<LongRunAvgLatency> B<true>|B<false>
1325 If enabled, latency values(sum,count pairs) are calculated as the long run
1326 average - average since the ceph daemon was started = (sum / count).
1327 When disabled, latency values are calculated as the average since the last
1328 collection = (sum_now - sum_last) / (count_now - count_last).
1332 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1334 If enabled, special metrics (metrics that differ in type from similar counters)
1335 are converted to the type of those similar counters. This currently only
1336 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1337 ceph schema reports this metric type as a sum,count pair while similar counters
1338 are treated as derive types. When converted, the sum is used as the counter
1339 value and is treated as a derive type.
1340 When disabled, all metrics are treated as the types received from the ceph schema.
1346 Each B<Daemon> block must have a string argument for the plugin instance name.
1347 A B<SocketPath> is also required for each B<Daemon> block:
1351 =item B<Daemon> I<DaemonName>
1353 Name to be used as the instance name for this daemon.
1355 =item B<SocketPath> I<SocketPath>
1357 Specifies the path to the UNIX admin socket of the ceph daemon.
1361 =head2 Plugin C<cgroups>
1363 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1364 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1365 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1369 =item B<CGroup> I<Directory>
1371 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1372 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1375 See F</"IGNORELISTS"> for details.
1377 =item B<IgnoreSelected> B<true>|B<false>
1379 Invert the selection: If set to true, all cgroups I<except> the ones that
1380 match any one of the criteria are collected. By default only selected
1381 cgroups are collected if a selection is made. If no selection is configured
1382 at all, B<all> cgroups are selected.
1386 =head2 Plugin C<chrony>
1388 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1389 skew and per-peer stratum.
1391 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1394 Available configuration options for the C<chrony> plugin:
1398 =item B<Host> I<Hostname>
1400 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1402 =item B<Port> I<Port>
1404 UDP-Port to connect to. Defaults to B<323>.
1406 =item B<Timeout> I<Timeout>
1408 Connection timeout in seconds. Defaults to B<2>.
1412 =head2 Plugin Connectivity
1414 connectivity - Documentation of collectd's C<connectivity plugin>
1417 LoadPlugin connectivity
1419 <Plugin connectivity>
1423 The C<connectivity plugin> queries interface status using netlink (man 7 netlink) which provides information about network interfaces via the NETLINK_ROUTE family (man 7 rtnetlink). The plugin translates the value it receives to collectd's internal format and, depending on the write plugins you have loaded, it may be written to disk or submitted to another instance.
1424 The plugin listens to interfaces configured in LoadPlugin (see configuration below).
1426 Here this example shows C<connectivity plugin> monitoring 2 interfaces "eth0" and "eth1"
1427 LoadPlugin connectivity
1428 <Plugin connectivity>
1435 =item B<Interface> I<interface_name>
1437 interface(s) to monitor connect to.
1441 If I<Status> is greater than or equal to zero the message indicates interface is up,
1442 if I<Status> is less than zero the message indicates interface is down.
1446 =head2 Plugin C<conntrack>
1448 This plugin collects IP conntrack statistics.
1454 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1455 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1459 =head2 Plugin C<cpu>
1461 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1462 as Jiffies, using the C<cpu> type. Two aggregations are available:
1468 Sum, per-state, over all CPUs installed in the system; and
1472 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1476 The two aggregations can be combined, leading to I<collectd> only emitting a
1477 single "active" metric for the entire system. As soon as one of these
1478 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1479 rather than Jiffies. In addition, you can request individual, per-state,
1480 per-CPU metrics to be reported as percentage.
1482 The following configuration options are available:
1486 =item B<ReportByState> B<true>|B<false>
1488 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1490 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1493 =item B<ReportByCpu> B<true>|B<false>
1495 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1496 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1497 global sum of CPU states is emitted.
1499 =item B<ValuesPercentage> B<false>|B<true>
1501 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1502 are set to B<true>. In this case, by default, metrics will be reported as
1503 Jiffies. By setting this option to B<true>, you can request percentage values
1504 in the un-aggregated (per-CPU, per-state) mode as well.
1506 =item B<ReportNumCpu> B<false>|B<true>
1508 When set to B<true>, reports the number of available CPUs.
1509 Defaults to B<false>.
1511 =item B<ReportGuestState> B<false>|B<true>
1513 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1514 Defaults to B<false>.
1516 =item B<SubtractGuestState> B<false>|B<true>
1518 This option is only considered when B<ReportGuestState> is set to B<true>.
1519 "guest" and "guest_nice" are included in respectively "user" and "nice".
1520 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1521 will be subtracted from "nice".
1522 Defaults to B<true>.
1526 =head2 Plugin C<cpufreq>
1528 This plugin doesn't have any options. It reads
1529 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1530 installed) to get the current CPU frequency. If this file does not exist make
1531 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1532 installed and an "cpu governor" (that's a kernel module) is loaded.
1534 =head2 Plugin C<cpusleep>
1536 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1537 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1538 BOOTTIME clock increments while device is suspended and MONOTONIC
1539 clock does not, the derivative of the difference between these clocks
1540 gives the relative amount of time the device has spent in suspend
1541 state. The recorded value is in milliseconds of sleep per seconds of
1544 =head2 Plugin C<csv>
1548 =item B<DataDir> I<Directory>
1550 Set the directory to store CSV-files under. Per default CSV-files are generated
1551 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1552 The special strings B<stdout> and B<stderr> can be used to write to the standard
1553 output and standard error channels, respectively. This, of course, only makes
1554 much sense when collectd is running in foreground- or non-daemon-mode.
1556 =item B<StoreRates> B<true|false>
1558 If set to B<true>, convert counter values to rates. If set to B<false> (the
1559 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1564 =head2 cURL Statistics
1566 All cURL-based plugins support collection of generic, request-based
1567 statistics. These are disabled by default and can be enabled selectively for
1568 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1569 the documentation of those plugins for specific information. This section
1570 describes the available metrics that can be configured for each plugin. All
1571 options are disabled by default.
1573 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1577 =item B<TotalTime> B<true|false>
1579 Total time of the transfer, including name resolving, TCP connect, etc.
1581 =item B<NamelookupTime> B<true|false>
1583 Time it took from the start until name resolving was completed.
1585 =item B<ConnectTime> B<true|false>
1587 Time it took from the start until the connect to the remote host (or proxy)
1590 =item B<AppconnectTime> B<true|false>
1592 Time it took from the start until the SSL/SSH connect/handshake to the remote
1595 =item B<PretransferTime> B<true|false>
1597 Time it took from the start until just before the transfer begins.
1599 =item B<StarttransferTime> B<true|false>
1601 Time it took from the start until the first byte was received.
1603 =item B<RedirectTime> B<true|false>
1605 Time it took for all redirection steps include name lookup, connect,
1606 pre-transfer and transfer before final transaction was started.
1608 =item B<RedirectCount> B<true|false>
1610 The total number of redirections that were actually followed.
1612 =item B<SizeUpload> B<true|false>
1614 The total amount of bytes that were uploaded.
1616 =item B<SizeDownload> B<true|false>
1618 The total amount of bytes that were downloaded.
1620 =item B<SpeedDownload> B<true|false>
1622 The average download speed that curl measured for the complete download.
1624 =item B<SpeedUpload> B<true|false>
1626 The average upload speed that curl measured for the complete upload.
1628 =item B<HeaderSize> B<true|false>
1630 The total size of all the headers received.
1632 =item B<RequestSize> B<true|false>
1634 The total size of the issued requests.
1636 =item B<ContentLengthDownload> B<true|false>
1638 The content-length of the download.
1640 =item B<ContentLengthUpload> B<true|false>
1642 The specified size of the upload.
1644 =item B<NumConnects> B<true|false>
1646 The number of new connections that were created to achieve the transfer.
1650 =head2 Plugin C<curl>
1652 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1653 and the match infrastructure (the same code used by the tail plugin) to use
1654 regular expressions with the received data.
1656 The following example will read the current value of AMD stock from Google's
1657 finance page and dispatch the value to collectd.
1660 <Page "stock_quotes">
1662 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1668 CACert "/path/to/ca.crt"
1669 Header "X-Custom-Header: foobar"
1672 MeasureResponseTime false
1673 MeasureResponseCode false
1676 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1677 DSType "GaugeAverage"
1678 # Note: `stock_value' is not a standard type.
1685 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1686 a web page and one or more "matches" to be performed on the returned data. The
1687 string argument to the B<Page> block is used as plugin instance.
1689 The following options are valid within B<Page> blocks:
1693 =item B<Plugin> I<Plugin>
1695 Use I<Plugin> as the plugin name when submitting values.
1696 Defaults to C<curl>.
1700 URL of the web site to retrieve. Since a regular expression will be used to
1701 extract information from this data, non-binary data is a big plus here ;)
1703 =item B<User> I<Name>
1705 Username to use if authorization is required to read the page.
1707 =item B<Password> I<Password>
1709 Password to use if authorization is required to read the page.
1711 =item B<Digest> B<true>|B<false>
1713 Enable HTTP digest authentication.
1715 =item B<VerifyPeer> B<true>|B<false>
1717 Enable or disable peer SSL certificate verification. See
1718 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1720 =item B<VerifyHost> B<true>|B<false>
1722 Enable or disable peer host name verification. If enabled, the plugin checks if
1723 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1724 matches the host name provided by the B<URL> option. If this identity check
1725 fails, the connection is aborted. Obviously, only works when connecting to a
1726 SSL enabled server. Enabled by default.
1728 =item B<CACert> I<file>
1730 File that holds one or more SSL certificates. If you want to use HTTPS you will
1731 possibly need this option. What CA certificates come bundled with C<libcurl>
1732 and are checked by default depends on the distribution you use.
1734 =item B<Header> I<Header>
1736 A HTTP header to add to the request. Multiple headers are added if this option
1737 is specified more than once.
1739 =item B<Post> I<Body>
1741 Specifies that the HTTP operation should be a POST instead of a GET. The
1742 complete data to be posted is given as the argument. This option will usually
1743 need to be accompanied by a B<Header> option to set an appropriate
1744 C<Content-Type> for the post body (e.g. to
1745 C<application/x-www-form-urlencoded>).
1747 =item B<MeasureResponseTime> B<true>|B<false>
1749 Measure response time for the request. If this setting is enabled, B<Match>
1750 blocks (see below) are optional. Disabled by default.
1752 Beware that requests will get aborted if they take too long to complete. Adjust
1753 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1756 This option is similar to enabling the B<TotalTime> statistic but it's
1757 measured by collectd instead of cURL.
1759 =item B<MeasureResponseCode> B<true>|B<false>
1761 Measure response code for the request. If this setting is enabled, B<Match>
1762 blocks (see below) are optional. Disabled by default.
1764 =item B<E<lt>StatisticsE<gt>>
1766 One B<Statistics> block can be used to specify cURL statistics to be collected
1767 for each request to the remote web site. See the section "cURL Statistics"
1768 above for details. If this setting is enabled, B<Match> blocks (see below) are
1771 =item B<E<lt>MatchE<gt>>
1773 One or more B<Match> blocks that define how to match information in the data
1774 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1775 used by the C<tail> plugin, so please see the documentation of the C<tail>
1776 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1777 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1780 =item B<Timeout> I<Milliseconds>
1782 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1783 milliseconds. By default, the configured B<Interval> is used to set the
1784 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1785 indefinitely. This legacy behaviour can be achieved by setting the value of
1788 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1789 network connection will stall one read thread. Adjust the B<ReadThreads> global
1790 setting accordingly to prevent this from blocking other plugins.
1794 =head2 Plugin C<curl_json>
1796 The B<curl_json plugin> collects values from JSON data to be parsed by
1797 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1798 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1799 unix socket. The former can be used, for example, to collect values
1800 from CouchDB documents (which are stored JSON notation), and the
1801 latter to collect values from a uWSGI stats socket.
1803 The following example will collect several values from the built-in
1804 C<_stats> runtime statistics module of I<CouchDB>
1805 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1808 <URL "http://localhost:5984/_stats">
1810 <Key "httpd/requests/count">
1811 Type "http_requests"
1814 <Key "httpd_request_methods/*/count">
1815 Type "http_request_methods"
1818 <Key "httpd_status_codes/*/count">
1819 Type "http_response_codes"
1824 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1827 <Sock "/var/run/uwsgi.stats.sock">
1829 <Key "workers/*/requests">
1830 Type "http_requests"
1833 <Key "workers/*/apps/*/requests">
1834 Type "http_requests"
1839 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1840 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1841 blocks defining a unix socket to read JSON from directly. Each of
1842 these blocks may have one or more B<Key> blocks.
1844 The B<Key> string argument must be in a path format. Each component is
1845 used to match the key from a JSON map or the index of an JSON
1846 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1847 values for all map keys or array indices will be collectd.
1849 The following options are valid within B<URL> blocks:
1853 =item B<Host> I<Name>
1855 Use I<Name> as the host name when submitting values. Defaults to the global
1858 =item B<Plugin> I<Plugin>
1860 Use I<Plugin> as the plugin name when submitting values.
1861 Defaults to C<curl_json>.
1863 =item B<Instance> I<Instance>
1865 Sets the plugin instance to I<Instance>.
1867 =item B<Interval> I<Interval>
1869 Sets the interval (in seconds) in which the values will be collected from this
1870 URL. By default the global B<Interval> setting will be used.
1872 =item B<User> I<Name>
1874 =item B<Password> I<Password>
1876 =item B<Digest> B<true>|B<false>
1878 =item B<VerifyPeer> B<true>|B<false>
1880 =item B<VerifyHost> B<true>|B<false>
1882 =item B<CACert> I<file>
1884 =item B<Header> I<Header>
1886 =item B<Post> I<Body>
1888 =item B<Timeout> I<Milliseconds>
1890 These options behave exactly equivalent to the appropriate options of the
1891 I<cURL> plugin. Please see there for a detailed description.
1893 =item B<E<lt>StatisticsE<gt>>
1895 One B<Statistics> block can be used to specify cURL statistics to be collected
1896 for each request to the remote URL. See the section "cURL Statistics" above
1901 The following options are valid within B<Key> blocks:
1905 =item B<Type> I<Type>
1907 Sets the type used to dispatch the values to the daemon. Detailed information
1908 about types and their configuration can be found in L<types.db(5)>. This
1909 option is mandatory.
1911 =item B<Instance> I<Instance>
1913 Type-instance to use. Defaults to the current map key or current string array element value.
1917 =head2 Plugin C<curl_xml>
1919 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1920 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1923 <URL "http://localhost/stats.xml">
1926 Instance "some_instance"
1931 CACert "/path/to/ca.crt"
1932 Header "X-Custom-Header: foobar"
1935 <XPath "table[@id=\"magic_level\"]/tr">
1937 #InstancePrefix "prefix-"
1938 InstanceFrom "td[1]"
1939 #PluginInstanceFrom "td[1]"
1940 ValuesFrom "td[2]/span[@class=\"level\"]"
1945 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1946 URL to be fetched using libcurl. Within each B<URL> block there are
1947 options which specify the connection parameters, for example authentication
1948 information, and one or more B<XPath> blocks.
1950 Each B<XPath> block specifies how to get one type of information. The
1951 string argument must be a valid XPath expression which returns a list
1952 of "base elements". One value is dispatched for each "base element". The
1953 I<type instance> and values are looked up using further I<XPath> expressions
1954 that should be relative to the base element.
1956 Within the B<URL> block the following options are accepted:
1960 =item B<Host> I<Name>
1962 Use I<Name> as the host name when submitting values. Defaults to the global
1965 =item B<Plugin> I<Plugin>
1967 Use I<Plugin> as the plugin name when submitting values.
1968 Defaults to 'curl_xml'.
1970 =item B<Instance> I<Instance>
1972 Use I<Instance> as the plugin instance when submitting values.
1973 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
1974 Defaults to an empty string (no plugin instance).
1976 =item B<Namespace> I<Prefix> I<URL>
1978 If an XPath expression references namespaces, they must be specified
1979 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1980 I<URL> is the "namespace name", an URI reference uniquely identifying the
1981 namespace. The option can be repeated to register multiple namespaces.
1985 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1986 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1988 =item B<User> I<User>
1990 =item B<Password> I<Password>
1992 =item B<Digest> B<true>|B<false>
1994 =item B<VerifyPeer> B<true>|B<false>
1996 =item B<VerifyHost> B<true>|B<false>
1998 =item B<CACert> I<CA Cert File>
2000 =item B<Header> I<Header>
2002 =item B<Post> I<Body>
2004 =item B<Timeout> I<Milliseconds>
2006 These options behave exactly equivalent to the appropriate options of the
2007 I<cURL plugin>. Please see there for a detailed description.
2009 =item B<E<lt>StatisticsE<gt>>
2011 One B<Statistics> block can be used to specify cURL statistics to be collected
2012 for each request to the remote URL. See the section "cURL Statistics" above
2015 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2017 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2018 B<XPath> block specifies how to get one type of information. The string
2019 argument must be a valid XPath expression which returns a list of "base
2020 elements". One value is dispatched for each "base element".
2022 Within the B<XPath> block the following options are accepted:
2026 =item B<Type> I<Type>
2028 Specifies the I<Type> used for submitting patches. This determines the number
2029 of values that are required / expected and whether the strings are parsed as
2030 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2031 This option is required.
2033 =item B<InstancePrefix> I<InstancePrefix>
2035 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2036 concatenated together without any separator.
2037 This option is optional.
2039 =item B<InstanceFrom> I<InstanceFrom>
2041 Specifies a XPath expression to use for determining the I<type instance>. The
2042 XPath expression must return exactly one element. The element's value is then
2043 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2045 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2047 Specifies a XPath expression to use for determining the I<plugin instance>. The
2048 XPath expression must return exactly one element. The element's value is then
2049 used as I<plugin instance>.
2053 If the "base XPath expression" (the argument to the B<XPath> block) returns
2054 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2055 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2059 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2061 Specifies one or more XPath expression to use for reading the values. The
2062 number of XPath expressions must match the number of data sources in the
2063 I<type> specified with B<Type> (see above). Each XPath expression must return
2064 exactly one element. The element's value is then parsed as a number and used as
2065 value for the appropriate value in the value list dispatched to the daemon.
2066 This option is required.
2072 =head2 Plugin C<dbi>
2074 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2075 connect to various databases, execute I<SQL> statements and read back the
2076 results. I<dbi> is an acronym for "database interface" in case you were
2077 wondering about the name. You can configure how each column is to be
2078 interpreted and the plugin will generate one or more data sets from each row
2079 returned according to these rules.
2081 Because the plugin is very generic, the configuration is a little more complex
2082 than those of other plugins. It usually looks something like this:
2085 <Query "out_of_stock">
2086 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2087 # Use with MySQL 5.0.0 or later
2091 InstancePrefix "out_of_stock"
2092 InstancesFrom "category"
2096 <Database "product_information">
2100 DriverOption "host" "localhost"
2101 DriverOption "username" "collectd"
2102 DriverOption "password" "aZo6daiw"
2103 DriverOption "dbname" "prod_info"
2104 SelectDB "prod_info"
2105 Query "out_of_stock"
2109 The configuration above defines one query with one result and one database. The
2110 query is then linked to the database with the B<Query> option I<within> the
2111 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2112 and you can also use the B<Include> statement to split up the configuration
2113 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2114 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2117 The following is a complete list of options:
2119 =head3 B<Query> blocks
2121 Query blocks define I<SQL> statements and how the returned data should be
2122 interpreted. They are identified by the name that is given in the opening line
2123 of the block. Thus the name needs to be unique. Other than that, the name is
2124 not used in collectd.
2126 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2127 define which column holds which value or instance information. You can use
2128 multiple B<Result> blocks to create multiple values from one returned row. This
2129 is especially useful, when queries take a long time and sending almost the same
2130 query again and again is not desirable.
2134 <Query "environment">
2135 Statement "select station, temperature, humidity from environment"
2138 # InstancePrefix "foo"
2139 InstancesFrom "station"
2140 ValuesFrom "temperature"
2144 InstancesFrom "station"
2145 ValuesFrom "humidity"
2149 The following options are accepted:
2153 =item B<Statement> I<SQL>
2155 Sets the statement that should be executed on the server. This is B<not>
2156 interpreted by collectd, but simply passed to the database server. Therefore,
2157 the SQL dialect that's used depends on the server collectd is connected to.
2159 The query has to return at least two columns, one for the instance and one
2160 value. You cannot omit the instance, even if the statement is guaranteed to
2161 always return exactly one line. In that case, you can usually specify something
2164 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2166 (That works with MySQL but may not be valid SQL according to the spec. If you
2167 use a more strict database server, you may have to select from a dummy table or
2170 Please note that some databases, for example B<Oracle>, will fail if you
2171 include a semicolon at the end of the statement.
2173 =item B<MinVersion> I<Version>
2175 =item B<MaxVersion> I<Value>
2177 Only use this query for the specified database version. You can use these
2178 options to provide multiple queries with the same name but with a slightly
2179 different syntax. The plugin will use only those queries, where the specified
2180 minimum and maximum versions fit the version of the database in use.
2182 The database version is determined by C<dbi_conn_get_engine_version>, see the
2183 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2184 for details. Basically, each part of the version is assumed to be in the range
2185 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2186 "40102", version "5.0.42" becomes "50042".
2188 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2189 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2190 happen. Don't to it! A valid example would be something along these lines:
2201 In the above example, there are three ranges that don't overlap. The last one
2202 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2203 before "4.0.0" are not specified.
2205 =item B<Type> I<Type>
2207 The B<type> that's used for each line returned. See L<types.db(5)> for more
2208 details on how types are defined. In short: A type is a predefined layout of
2209 data and the number of values and type of values has to match the type
2212 If you specify "temperature" here, you need exactly one gauge column. If you
2213 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2216 There must be exactly one B<Type> option inside each B<Result> block.
2218 =item B<InstancePrefix> I<prefix>
2220 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2221 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2222 all strings returned in the appropriate columns are concatenated together,
2223 separated by dashes I<("-")>.
2225 =item B<InstancesFrom> I<column0> [I<column1> ...]
2227 Specifies the columns whose values will be used to create the "type-instance"
2228 for each row. If you specify more than one column, the value of all columns
2229 will be joined together with dashes I<("-")> as separation characters.
2231 The plugin itself does not check whether or not all built instances are
2232 different. It's your responsibility to assure that each is unique. This is
2233 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2234 sure that only one row is returned in this case.
2236 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2239 =item B<ValuesFrom> I<column0> [I<column1> ...]
2241 Names the columns whose content is used as the actual data for the data sets
2242 that are dispatched to the daemon. How many such columns you need is determined
2243 by the B<Type> setting above. If you specify too many or not enough columns,
2244 the plugin will complain about that and no data will be submitted to the
2247 The actual data type in the columns is not that important. The plugin will
2248 automatically cast the values to the right type if it know how to do that. So
2249 it should be able to handle integer an floating point types, as well as strings
2250 (if they include a number at the beginning).
2252 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2254 =item B<MetadataFrom> [I<column0> I<column1> ...]
2256 Names the columns whose content is used as metadata for the data sets
2257 that are dispatched to the daemon.
2259 The actual data type in the columns is not that important. The plugin will
2260 automatically cast the values to the right type if it know how to do that. So
2261 it should be able to handle integer an floating point types, as well as strings
2262 (if they include a number at the beginning).
2266 =head3 B<Database> blocks
2268 Database blocks define a connection to a database and which queries should be
2269 sent to that database. Since the used "dbi" library can handle a wide variety
2270 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2271 documentationE<nbsp>- we stick as close to the terminology used there.
2273 Each database needs a "name" as string argument in the starting tag of the
2274 block. This name will be used as "PluginInstance" in the values submitted to
2275 the daemon. Other than that, that name is not used.
2279 =item B<Plugin> I<Plugin>
2281 Use I<Plugin> as the plugin name when submitting query results from
2282 this B<Database>. Defaults to C<dbi>.
2284 =item B<Interval> I<Interval>
2286 Sets the interval (in seconds) in which the values will be collected from this
2287 database. By default the global B<Interval> setting will be used.
2289 =item B<Driver> I<Driver>
2291 Specifies the driver to use to connect to the database. In many cases those
2292 drivers are named after the database they can connect to, but this is not a
2293 technical necessity. These drivers are sometimes referred to as "DBD",
2294 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2295 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2296 project at L<http://libdbi-drivers.sourceforge.net/>.
2298 You need to give the driver name as expected by the "dbi" library here. You
2299 should be able to find that in the documentation for each driver. If you
2300 mistype the driver name, the plugin will dump a list of all known driver names
2303 =item B<DriverOption> I<Key> I<Value>
2305 Sets driver-specific options. What option a driver supports can be found in the
2306 documentation for each driver, somewhere at
2307 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2308 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2310 DBDs can register two types of options: String options and numeric options. The
2311 plugin will use the C<dbi_conn_set_option> function when the configuration
2312 provides a string and the C<dbi_conn_require_option_numeric> function when the
2313 configuration provides a number. So these two lines will actually result in
2314 different calls being used:
2316 DriverOption "Port" 1234 # numeric
2317 DriverOption "Port" "1234" # string
2319 Unfortunately, drivers are not too keen to report errors when an unknown option
2320 is passed to them, so invalid settings here may go unnoticed. This is not the
2321 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2322 the driver. If a driver complains about an option, the plugin will dump a
2323 complete list of all options understood by that driver to the log. There is no
2324 way to programmatically find out if an option expects a string or a numeric
2325 argument, so you will have to refer to the appropriate DBD's documentation to
2326 find this out. Sorry.
2328 =item B<SelectDB> I<Database>
2330 In some cases, the database name you connect with is not the database name you
2331 want to use for querying data. If this option is set, the plugin will "select"
2332 (switch to) that database after the connection is established.
2334 =item B<Query> I<QueryName>
2336 Associates the query named I<QueryName> with this database connection. The
2337 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2338 blocks you want to refer to must be placed above the database block you want to
2341 =item B<Host> I<Hostname>
2343 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2344 values. Defaults to the global hostname setting.
2352 =item B<Device> I<Device>
2354 Select partitions based on the devicename.
2356 See F</"IGNORELISTS"> for details.
2358 =item B<MountPoint> I<Directory>
2360 Select partitions based on the mountpoint.
2362 See F</"IGNORELISTS"> for details.
2364 =item B<FSType> I<FSType>
2366 Select partitions based on the filesystem type.
2368 See F</"IGNORELISTS"> for details.
2370 =item B<IgnoreSelected> B<true>|B<false>
2372 Invert the selection: If set to true, all partitions B<except> the ones that
2373 match any one of the criteria are collected. By default only selected
2374 partitions are collected if a selection is made. If no selection is configured
2375 at all, B<all> partitions are selected.
2377 =item B<ReportByDevice> B<true>|B<false>
2379 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2380 (the default), it will report a disk as "root", but with it I<true>, it will be
2381 "sda1" (or whichever).
2383 =item B<ReportInodes> B<true>|B<false>
2385 Enables or disables reporting of free, reserved and used inodes. Defaults to
2386 inode collection being disabled.
2388 Enable this option if inodes are a scarce resource for you, usually because
2389 many small files are stored on the disk. This is a usual scenario for mail
2390 transfer agents and web caches.
2392 =item B<ValuesAbsolute> B<true>|B<false>
2394 Enables or disables reporting of free and used disk space in 1K-blocks.
2395 Defaults to B<true>.
2397 =item B<ValuesPercentage> B<false>|B<true>
2399 Enables or disables reporting of free and used disk space in percentage.
2400 Defaults to B<false>.
2402 This is useful for deploying I<collectd> on the cloud, where machines with
2403 different disk size may exist. Then it is more practical to configure
2404 thresholds based on relative disk size.
2408 =head2 Plugin C<disk>
2410 The C<disk> plugin collects information about the usage of physical disks and
2411 logical disks (partitions). Values collected are the number of octets written
2412 to and read from a disk or partition, the number of read/write operations
2413 issued to the disk and a rather complex "time" it took for these commands to be
2416 Using the following two options you can ignore some disks or configure the
2417 collection only of specific disks.
2421 =item B<Disk> I<Name>
2423 Select the disk I<Name>. Whether it is collected or ignored depends on the
2424 B<IgnoreSelected> setting, see below. As with other plugins that use the
2425 daemon's ignorelist functionality, a string that starts and ends with a slash
2426 is interpreted as a regular expression. Examples:
2431 See F</"IGNORELISTS"> for details.
2433 =item B<IgnoreSelected> B<true>|B<false>
2435 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2436 statements, are ignored or if all other disks are ignored. The behavior
2437 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2438 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2439 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2440 is set to B<true>, all disks are collected B<except> the ones matched.
2442 =item B<UseBSDName> B<true>|B<false>
2444 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2445 default major/minor numbers. Requires collectd to be built with Apple's
2448 =item B<UdevNameAttr> I<Attribute>
2450 Attempt to override disk instance name with the value of a specified udev
2451 attribute when built with B<libudev>. If the attribute is not defined for the
2452 given device, the default name is used. Example:
2454 UdevNameAttr "DM_NAME"
2458 =head2 Plugin C<dns>
2462 =item B<Interface> I<Interface>
2464 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2465 option sets the interface that should be used. If this option is not set, or
2466 set to "any", the plugin will try to get packets from B<all> interfaces. This
2467 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2469 =item B<IgnoreSource> I<IP-address>
2471 Ignore packets that originate from this address.
2473 =item B<SelectNumericQueryTypes> B<true>|B<false>
2475 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2479 =head2 Plugin C<dpdkevents>
2481 The I<dpdkevents plugin> collects events from DPDK such as link status of
2482 network ports and Keep Alive status of DPDK logical cores.
2483 In order to get Keep Alive events following requirements must be met:
2485 - support for Keep Alive implemented in DPDK application. More details can
2486 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2490 <Plugin "dpdkevents">
2496 <Event "link_status">
2497 SendEventsOnUpdate true
2498 EnabledPortMask 0xffff
2499 PortName "interface1"
2500 PortName "interface2"
2501 SendNotification false
2503 <Event "keep_alive">
2504 SendEventsOnUpdate true
2506 KeepAliveShmName "/dpdk_keepalive_shm_name"
2507 SendNotification false
2514 =head3 The EAL block
2518 =item B<Coremask> I<Mask>
2520 =item B<Memorychannels> I<Channels>
2522 Number of memory channels per processor socket.
2524 =item B<FilePrefix> I<File>
2526 The prefix text used for hugepage filenames. The filename will be set to
2527 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2531 =head3 The Event block
2533 The B<Event> block defines configuration for specific event. It accepts a
2534 single argument which specifies the name of the event.
2536 =head4 Link Status event
2540 =item B<SendEventOnUpdate> I<true|false>
2542 If set to true link status value will be dispatched only when it is
2543 different from previously read value. This is an optional argument - default
2546 =item B<EnabledPortMask> I<Mask>
2548 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2549 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2550 that all ports will be enabled. This is an optional argument - by default
2551 all ports are enabled.
2553 =item B<PortName> I<Name>
2555 A string containing an optional name for the enabled DPDK ports. Each PortName
2556 option should contain only one port name; specify as many PortName options as
2557 desired. Default naming convention will be used if PortName is blank. If there
2558 are less PortName options than there are enabled ports, the default naming
2559 convention will be used for the additional ports.
2561 =item B<SendNotification> I<true|false>
2563 If set to true, link status notifications are sent, instead of link status
2564 being collected as a statistic. This is an optional argument - default
2569 =head4 Keep Alive event
2573 =item B<SendEventOnUpdate> I<true|false>
2575 If set to true keep alive value will be dispatched only when it is
2576 different from previously read value. This is an optional argument - default
2579 =item B<LCoreMask> I<Mask>
2581 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2583 =item B<KeepAliveShmName> I<Name>
2585 Shared memory name identifier that is used by secondary process to monitor
2586 the keep alive cores state.
2588 =item B<SendNotification> I<true|false>
2590 If set to true, keep alive notifications are sent, instead of keep alive
2591 information being collected as a statistic. This is an optional
2592 argument - default value is false.
2596 =head2 Plugin C<dpdkstat>
2598 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2599 extended NIC stats API in DPDK.
2610 RteDriverLibPath "/usr/lib/dpdk-pmd"
2612 SharedMemObj "dpdk_collectd_stats_0"
2613 EnabledPortMask 0xffff
2614 PortName "interface1"
2615 PortName "interface2"
2620 =head3 The EAL block
2624 =item B<Coremask> I<Mask>
2626 A string containing an hexadecimal bit mask of the cores to run on. Note that
2627 core numbering can change between platforms and should be determined beforehand.
2629 =item B<Memorychannels> I<Channels>
2631 A string containing a number of memory channels per processor socket.
2633 =item B<FilePrefix> I<File>
2635 The prefix text used for hugepage filenames. The filename will be set to
2636 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2638 =item B<SocketMemory> I<MB>
2640 A string containing amount of Memory to allocate from hugepages on specific
2641 sockets in MB. This is an optional value.
2643 =item B<LogLevel> I<LogLevel_number>
2645 A string containing log level number. This parameter is optional.
2646 If parameter is not present then default value "7" - (INFO) is used.
2647 Value "8" - (DEBUG) can be set to enable debug traces.
2649 =item B<RteDriverLibPath> I<Path>
2651 A string containing path to shared pmd driver lib or path to directory,
2652 where shared pmd driver libs are available. This parameter is optional.
2653 This parameter enable loading of shared pmd driver libs from defined path.
2654 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2655 or "/usr/lib/dpdk-pmd"
2661 =item B<SharedMemObj> I<Mask>
2663 A string containing the name of the shared memory object that should be used to
2664 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2665 Defaults to dpdk_collectd_stats if no other value is configured.
2667 =item B<EnabledPortMask> I<Mask>
2669 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2670 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2671 that all ports will be enabled. This is an optional argument - default
2672 is all ports enabled.
2674 =item B<PortName> I<Name>
2676 A string containing an optional name for the enabled DPDK ports. Each PortName
2677 option should contain only one port name; specify as many PortName options as
2678 desired. Default naming convention will be used if PortName is blank. If there
2679 are less PortName options than there are enabled ports, the default naming
2680 convention will be used for the additional ports.
2684 =head2 Plugin C<email>
2688 =item B<SocketFile> I<Path>
2690 Sets the socket-file which is to be created.
2692 =item B<SocketGroup> I<Group>
2694 If running as root change the group of the UNIX-socket after it has been
2695 created. Defaults to B<collectd>.
2697 =item B<SocketPerms> I<Permissions>
2699 Change the file permissions of the UNIX-socket after it has been created. The
2700 permissions must be given as a numeric, octal value as you would pass to
2701 L<chmod(1)>. Defaults to B<0770>.
2703 =item B<MaxConns> I<Number>
2705 Sets the maximum number of connections that can be handled in parallel. Since
2706 this many threads will be started immediately setting this to a very high
2707 value will waste valuable resources. Defaults to B<5> and will be forced to be
2708 at most B<16384> to prevent typos and dumb mistakes.
2712 =head2 Plugin C<ethstat>
2714 The I<ethstat plugin> collects information about network interface cards (NICs)
2715 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2721 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2722 Map "multicast" "if_multicast"
2729 =item B<Interface> I<Name>
2731 Collect statistical information about interface I<Name>.
2733 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2735 By default, the plugin will submit values as type C<derive> and I<type
2736 instance> set to I<Name>, the name of the metric as reported by the driver. If
2737 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2738 I<TypeInstance> will be used.
2740 =item B<MappedOnly> B<true>|B<false>
2742 When set to B<true>, only metrics that can be mapped to a I<type> will be
2743 collected, all other metrics will be ignored. Defaults to B<false>.
2747 =head2 Plugin C<exec>
2749 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2750 contains valuable information on when the executable is executed and the
2751 output that is expected from it.
2755 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2757 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2759 Execute the executable I<Executable> as user I<User>. If the user name is
2760 followed by a colon and a group name, the effective group is set to that group.
2761 The real group and saved-set group will be set to the default group of that
2762 user. If no group is given the effective group ID will be the same as the real
2765 Please note that in order to change the user and/or group the daemon needs
2766 superuser privileges. If the daemon is run as an unprivileged user you must
2767 specify the same user/group here. If the daemon is run with superuser
2768 privileges, you must supply a non-root user here.
2770 The executable may be followed by optional arguments that are passed to the
2771 program. Please note that due to the configuration parsing numbers and boolean
2772 values may be changed. If you want to be absolutely sure that something is
2773 passed as-is please enclose it in quotes.
2775 The B<Exec> and B<NotificationExec> statements change the semantics of the
2776 programs executed, i.E<nbsp>e. the data passed to them and the response
2777 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2781 =head2 Plugin C<fhcount>
2783 The C<fhcount> plugin provides statistics about used, unused and total number of
2784 file handles on Linux.
2786 The I<fhcount plugin> provides the following configuration options:
2790 =item B<ValuesAbsolute> B<true>|B<false>
2792 Enables or disables reporting of file handles usage in absolute numbers,
2793 e.g. file handles used. Defaults to B<true>.
2795 =item B<ValuesPercentage> B<false>|B<true>
2797 Enables or disables reporting of file handles usage in percentages, e.g.
2798 percent of file handles used. Defaults to B<false>.
2802 =head2 Plugin C<filecount>
2804 The C<filecount> plugin counts the number of files in a certain directory (and
2805 its subdirectories) and their combined size. The configuration is very straight
2808 <Plugin "filecount">
2809 <Directory "/var/qmail/queue/mess">
2810 Instance "qmail-message"
2812 <Directory "/var/qmail/queue/todo">
2813 Instance "qmail-todo"
2815 <Directory "/var/lib/php5">
2816 Instance "php5-sessions"
2821 The example above counts the number of files in QMail's queue directories and
2822 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2823 QMail has not yet looked at, the "message" queue holds the messages that were
2824 classified into "local" and "remote".
2826 As you can see, the configuration consists of one or more C<Directory> blocks,
2827 each of which specifies a directory in which to count the files. Within those
2828 blocks, the following options are recognized:
2832 =item B<Plugin> I<Plugin>
2834 Use I<Plugin> as the plugin name when submitting values.
2835 Defaults to B<filecount>.
2837 =item B<Instance> I<Instance>
2839 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2840 the directory name with all slashes replaced by underscores and all leading
2841 underscores removed. Empty value is allowed.
2843 =item B<Name> I<Pattern>
2845 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2846 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2847 against the pattern, not the entire path. In case this makes it easier for you:
2848 This option has been named after the B<-name> parameter to L<find(1)>.
2850 =item B<MTime> I<Age>
2852 Count only files of a specific age: If I<Age> is greater than zero, only files
2853 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2854 a negative number, this is inversed. For example, if B<-60> is specified, only
2855 files that have been modified in the last minute will be counted.
2857 The number can also be followed by a "multiplier" to easily specify a larger
2858 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2859 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2860 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2861 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2862 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2865 =item B<Size> I<Size>
2867 Count only files of a specific size. When I<Size> is a positive number, only
2868 files that are at least this big are counted. If I<Size> is a negative number,
2869 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2870 I<Size> are counted.
2872 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2873 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2874 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2875 note that there are 1000 bytes in a kilobyte, not 1024.
2877 =item B<Recursive> I<true>|I<false>
2879 Controls whether or not to recurse into subdirectories. Enabled by default.
2881 =item B<IncludeHidden> I<true>|I<false>
2883 Controls whether or not to include "hidden" files and directories in the count.
2884 "Hidden" files and directories are those, whose name begins with a dot.
2885 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2887 =item B<RegularOnly> I<true>|I<false>
2889 Controls whether or not to include only regular files in the count.
2890 Defaults to I<true>, i.e. by default non regular files are ignored.
2892 =item B<FilesSizeType> I<Type>
2894 Sets the type used to dispatch files combined size. Empty value ("") disables
2895 reporting. Defaults to B<bytes>.
2897 =item B<FilesCountType> I<Type>
2899 Sets the type used to dispatch number of files. Empty value ("") disables
2900 reporting. Defaults to B<files>.
2902 =item B<TypeInstance> I<Instance>
2904 Sets the I<type instance> used to dispatch values. Defaults to an empty string
2905 (no plugin instance).
2909 =head2 Plugin C<GenericJMX>
2911 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2912 L<collectd-java(5)>.
2914 =head2 Plugin C<gmond>
2916 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2917 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2918 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2923 MCReceiveFrom "239.2.11.71" "8649"
2924 <Metric "swap_total">
2926 TypeInstance "total"
2929 <Metric "swap_free">
2936 The following metrics are built-in:
2942 load_one, load_five, load_fifteen
2946 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2950 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2962 Available configuration options:
2966 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2968 Sets sets the multicast group and UDP port to which to subscribe.
2970 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2972 =item E<lt>B<Metric> I<Name>E<gt>
2974 These blocks add a new metric conversion to the internal table. I<Name>, the
2975 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2979 =item B<Type> I<Type>
2981 Type to map this metric to. Required.
2983 =item B<TypeInstance> I<Instance>
2985 Type-instance to use. Optional.
2987 =item B<DataSource> I<Name>
2989 Data source to map this metric to. If the configured type has exactly one data
2990 source, this is optional. Otherwise the option is required.
2996 =head2 Plugin C<gps>
2998 The C<gps plugin> connects to gpsd on the host machine.
2999 The host, port, timeout and pause are configurable.
3001 This is useful if you run an NTP server using a GPS for source and you want to
3004 Mind your GPS must send $--GSA for having the data reported!
3006 The following elements are collected:
3012 Number of satellites used for fix (type instance "used") and in view (type
3013 instance "visible"). 0 means no GPS satellites are visible.
3015 =item B<dilution_of_precision>
3017 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3018 It should be between 0 and 3.
3019 Look at the documentation of your GPS to know more.
3027 # Connect to localhost on gpsd regular port:
3032 # PauseConnect of 5 sec. between connection attempts.
3036 Available configuration options:
3040 =item B<Host> I<Host>
3042 The host on which gpsd daemon runs. Defaults to B<localhost>.
3044 =item B<Port> I<Port>
3046 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3048 =item B<Timeout> I<Seconds>
3050 Timeout in seconds (default 0.015 sec).
3052 The GPS data stream is fetch by the plugin form the daemon.
3053 It waits for data to be available, if none arrives it times out
3054 and loop for another reading.
3055 Mind to put a low value gpsd expects value in the micro-seconds area
3056 (recommended is 500 us) since the waiting function is blocking.
3057 Value must be between 500 us and 5 sec., if outside that range the
3058 default value is applied.
3060 This only applies from gpsd release-2.95.
3062 =item B<PauseConnect> I<Seconds>
3064 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3068 =head2 Plugin C<grpc>
3070 The I<grpc> plugin provides an RPC interface to submit values to or query
3071 values from collectd based on the open source gRPC framework. It exposes an
3072 end-point for dispatching values to the daemon.
3074 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3078 =item B<Server> I<Host> I<Port>
3080 The B<Server> statement sets the address of a server to which to send metrics
3081 via the C<DispatchValues> function.
3083 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3085 Optionally, B<Server> may be specified as a configuration block which supports
3086 the following options:
3090 =item B<EnableSSL> B<false>|B<true>
3092 Whether to require SSL for outgoing connections. Default: false.
3094 =item B<SSLCACertificateFile> I<Filename>
3096 =item B<SSLCertificateFile> I<Filename>
3098 =item B<SSLCertificateKeyFile> I<Filename>
3100 Filenames specifying SSL certificate and key material to be used with SSL
3105 =item B<Listen> I<Host> I<Port>
3107 The B<Listen> statement sets the network address to bind to. When multiple
3108 statements are specified, the daemon will bind to all of them. If none are
3109 specified, it defaults to B<0.0.0.0:50051>.
3111 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3113 Optionally, B<Listen> may be specified as a configuration block which
3114 supports the following options:
3118 =item B<EnableSSL> I<true>|I<false>
3120 Whether to enable SSL for incoming connections. Default: false.
3122 =item B<SSLCACertificateFile> I<Filename>
3124 =item B<SSLCertificateFile> I<Filename>
3126 =item B<SSLCertificateKeyFile> I<Filename>
3128 Filenames specifying SSL certificate and key material to be used with SSL
3131 =item B<VerifyPeer> B<true>|B<false>
3133 When enabled, a valid client certificate is required to connect to the server.
3134 When disabled, a client certifiacte is not requested and any unsolicited client
3135 certificate is accepted.
3142 =head2 Plugin C<hddtemp>
3144 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3145 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3146 default values, see below. C<hddtemp> has to be running to work correctly. If
3147 C<hddtemp> is not running timeouts may appear which may interfere with other
3150 The B<hddtemp> homepage can be found at
3151 L<http://www.guzu.net/linux/hddtemp.php>.
3155 =item B<Host> I<Hostname>
3157 Hostname to connect to. Defaults to B<127.0.0.1>.
3159 =item B<Port> I<Port>
3161 TCP-Port to connect to. Defaults to B<7634>.
3165 =head2 Plugin C<hugepages>
3167 To collect B<hugepages> information, collectd reads directories
3168 "/sys/devices/system/node/*/hugepages" and
3169 "/sys/kernel/mm/hugepages".
3170 Reading of these directories can be disabled by the following
3171 options (default is enabled).
3175 =item B<ReportPerNodeHP> B<true>|B<false>
3177 If enabled, information will be collected from the hugepage
3178 counters in "/sys/devices/system/node/*/hugepages".
3179 This is used to check the per-node hugepage statistics on
3182 =item B<ReportRootHP> B<true>|B<false>
3184 If enabled, information will be collected from the hugepage
3185 counters in "/sys/kernel/mm/hugepages".
3186 This can be used on both NUMA and non-NUMA systems to check
3187 the overall hugepage statistics.
3189 =item B<ValuesPages> B<true>|B<false>
3191 Whether to report hugepages metrics in number of pages.
3192 Defaults to B<true>.
3194 =item B<ValuesBytes> B<false>|B<true>
3196 Whether to report hugepages metrics in bytes.
3197 Defaults to B<false>.
3199 =item B<ValuesPercentage> B<false>|B<true>
3201 Whether to report hugepages metrics as percentage.
3202 Defaults to B<false>.
3206 =head2 Plugin C<intel_pmu>
3208 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3209 Linux perf interface. All events are reported on a per core basis.
3214 ReportHardwareCacheEvents true
3215 ReportKernelPMUEvents true
3216 ReportSoftwareEvents true
3217 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3218 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3225 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3227 Enable or disable measuring of hardware CPU cache events:
3229 - L1-dcache-load-misses
3231 - L1-dcache-store-misses
3232 - L1-dcache-prefetches
3233 - L1-dcache-prefetch-misses
3235 - L1-icache-load-misses
3236 - L1-icache-prefetches
3237 - L1-icache-prefetch-misses
3243 - LLC-prefetch-misses
3249 - dTLB-prefetch-misses
3253 - branch-load-misses
3255 =item B<ReportKernelPMUEvents> B<false>|B<true>
3257 Enable or disable measuring of the following events:
3266 =item B<ReportSoftwareEvents> B<false>|B<true>
3268 Enable or disable measuring of software events provided by kernel:
3279 =item B<EventList> I<filename>
3281 JSON performance counter event list file name. To be able to monitor all Intel
3282 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3283 event_download.py script to download event list for current CPU.
3285 =item B<HardwareEvents> I<events>
3287 This field is a list of event names or groups of comma separated event names.
3288 This option requires B<EventList> option to be configured.
3292 =head2 Plugin C<intel_rdt>
3294 The I<intel_rdt> plugin collects information provided by monitoring features of
3295 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3296 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3297 information about utilization of shared resources. CMT monitors last level cache
3298 occupancy (LLC). MBM supports two types of events reporting local and remote
3299 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3300 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3301 reports the bandwidth of accessing the remote socket. Also this technology
3302 allows to monitor instructions per clock (IPC).
3303 Monitor events are hardware dependant. Monitoring capabilities are detected on
3304 plugin initialization and only supported events are monitored.
3306 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3307 require an additional capability to be enabled if collectd is run as a service.
3308 Please refer to I<contrib/systemd.collectd.service> file for more details.
3312 <Plugin "intel_rdt">
3313 Cores "0-2" "3,4,6" "8-10,15"
3320 =item B<Interval> I<seconds>
3322 The interval within which to retrieve statistics on monitored events in seconds.
3323 For milliseconds divide the time by 1000 for example if the desired interval
3324 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3325 recommended to set interval higher than 1 sec.
3327 =item B<Cores> I<cores groups>
3329 All events are reported on a per core basis. Monitoring of the events can be
3330 configured for group of cores (aggregated statistics). This field defines groups
3331 of cores on which to monitor supported events. The field is represented as list
3332 of strings with core group values. Each string represents a list of cores in a
3333 group. Allowed formats are:
3338 If an empty string is provided as value for this field default cores
3339 configuration is applied - a separate group is created for each core.
3343 B<Note:> By default global interval is used to retrieve statistics on monitored
3344 events. To configure a plugin specific interval use B<Interval> option of the
3345 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3346 example if the desired interval is 50ms, set interval to 0.05.
3347 Due to limited capacity of counters it is not recommended to set interval higher
3350 =head2 Plugin C<interface>
3354 =item B<Interface> I<Interface>
3356 Select this interface. By default these interfaces will then be collected. For
3357 a more detailed description see B<IgnoreSelected> below.
3359 See F</"IGNORELISTS"> for details.
3361 =item B<IgnoreSelected> I<true>|I<false>
3363 If no configuration is given, the B<interface>-plugin will collect data from
3364 all interfaces. This may not be practical, especially for loopback- and
3365 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3366 interfaces you're interested in. Sometimes, however, it's easier/preferred
3367 to collect all interfaces I<except> a few ones. This option enables you to
3368 do that: By setting B<IgnoreSelected> to I<true> the effect of
3369 B<Interface> is inverted: All selected interfaces are ignored and all
3370 other interfaces are collected.
3372 It is possible to use regular expressions to match interface names, if the
3373 name is surrounded by I</.../> and collectd was compiled with support for
3374 regexps. This is useful if there's a need to collect (or ignore) data
3375 for a group of interfaces that are similarly named, without the need to
3376 explicitly list all of them (especially useful if the list is dynamic).
3381 Interface "/^tun[0-9]+/"
3382 IgnoreSelected "true"
3384 This will ignore the loopback interface, all interfaces with names starting
3385 with I<veth> and all interfaces with names starting with I<tun> followed by
3388 =item B<ReportInactive> I<true>|I<false>
3390 When set to I<false>, only interfaces with non-zero traffic will be
3391 reported. Note that the check is done by looking into whether a
3392 package was sent at any time from boot and the corresponding counter
3393 is non-zero. So, if the interface has been sending data in the past
3394 since boot, but not during the reported time-interval, it will still
3397 The default value is I<true> and results in collection of the data
3398 from all interfaces that are selected by B<Interface> and
3399 B<IgnoreSelected> options.
3401 =item B<UniqueName> I<true>|I<false>
3403 Interface name is not unique on Solaris (KSTAT), interface name is unique
3404 only within a module/instance. Following tuple is considered unique:
3405 (ks_module, ks_instance, ks_name)
3406 If this option is set to true, interface name contains above three fields
3407 separated by an underscore. For more info on KSTAT, visit
3408 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3410 This option is only available on Solaris.
3414 =head2 Plugin C<ipmi>
3416 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3417 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3419 The plugin configuration consists of one or more B<Instance> blocks which
3420 specify one I<ipmi> connection each. Each block requires one unique string
3421 argument as the instance name. If instances are not configured, an instance with
3422 the default option values will be created.
3424 For backwards compatibility, any option other than B<Instance> block will trigger
3425 legacy config handling and it will be treated as an option within B<Instance>
3426 block. This support will go away in the next major version of Collectd.
3428 Within the B<Instance> blocks, the following options are allowed:
3432 =item B<Address> I<Address>
3434 Hostname or IP to connect to. If not specified, plugin will try to connect to
3435 local management controller (BMC).
3437 =item B<Username> I<Username>
3439 =item B<Password> I<Password>
3441 The username and the password to use for the connection to remote BMC.
3443 =item B<AuthType> I<MD5>|I<rmcp+>
3445 Forces the authentication type to use for the connection to remote BMC.
3446 By default most secure type is seleted.
3448 =item B<Host> I<Hostname>
3450 Sets the B<host> field of dispatched values. Defaults to the global hostname
3453 =item B<Sensor> I<Sensor>
3455 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3457 See F</"IGNORELISTS"> for details.
3459 =item B<IgnoreSelected> I<true>|I<false>
3461 If no configuration if given, the B<ipmi> plugin will collect data from all
3462 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3463 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3464 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3465 all other sensors are collected.
3467 =item B<NotifySensorAdd> I<true>|I<false>
3469 If a sensor appears after initialization time of a minute a notification
3472 =item B<NotifySensorRemove> I<true>|I<false>
3474 If a sensor disappears a notification is sent.
3476 =item B<NotifySensorNotPresent> I<true>|I<false>
3478 If you have for example dual power supply and one of them is (un)plugged then
3479 a notification is sent.
3481 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3483 If a IPMI connection state changes after initialization time of a minute
3484 a notification is sent. Defaults to B<false>.
3486 =item B<SELEnabled> I<true>|I<false>
3488 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3489 and discrete events. When event is received the notification is sent.
3490 Defaults to B<false>.
3492 =item B<SELClearEvent> I<true>|I<false>
3494 If SEL clear event is enabled, plugin will delete event from SEL list after
3495 it is received and successfully handled. In this case other tools that are
3496 subscribed for SEL events will receive an empty event.
3497 Defaults to B<false>.
3501 =head2 Plugin C<iptables>
3505 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3507 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3509 Select the iptables/ip6tables filter rules to count packets and bytes from.
3511 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3512 of all rules which have a comment-match. The comment is then used as
3515 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3516 the I<n>th rule will be collected. Again, the comment (or the number) will be
3517 used as the type-instance.
3519 If I<Name> is supplied, it will be used as the type-instance instead of the
3520 comment or the number.
3524 =head2 Plugin C<irq>
3530 Select this irq. By default these irqs will then be collected. For a more
3531 detailed description see B<IgnoreSelected> below.
3533 See F</"IGNORELISTS"> for details.
3535 =item B<IgnoreSelected> I<true>|I<false>
3537 If no configuration if given, the B<irq>-plugin will collect data from all
3538 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3539 can use the B<Irq>-option to pick the interrupt you're interested in.
3540 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3541 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3542 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3543 and all other interrupts are collected.
3547 =head2 Plugin C<java>
3549 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3550 This section only discusses the syntax and semantic of the configuration
3551 options. For more in-depth information on the I<Java> plugin, please read
3552 L<collectd-java(5)>.
3557 JVMArg "-verbose:jni"
3558 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3559 LoadPlugin "org.collectd.java.Foobar"
3560 <Plugin "org.collectd.java.Foobar">
3561 # To be parsed by the plugin
3565 Available configuration options:
3569 =item B<JVMArg> I<Argument>
3571 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3572 exactly the way the arguments to the I<java> binary on the command line work.
3573 Execute C<javaE<nbsp>--help> for details.
3575 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3576 any other options! When another option is found, the JVM will be started and
3577 later options will have to be ignored!
3579 =item B<LoadPlugin> I<JavaClass>
3581 Instantiates a new I<JavaClass> object. The constructor of this object very
3582 likely then registers one or more callback methods with the server.
3584 See L<collectd-java(5)> for details.
3586 When the first such option is found, the virtual machine (JVM) is created. This
3587 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3588 B<LoadPlugin> options!
3590 =item B<Plugin> I<Name>
3592 The entire block is passed to the Java plugin as an
3593 I<org.collectd.api.OConfigItem> object.
3595 For this to work, the plugin has to register a configuration callback first,
3596 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3597 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3598 depends on the (Java) plugin registering the callback and is completely
3599 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3603 =head2 Plugin C<load>
3605 The I<Load plugin> collects the system load. These numbers give a rough overview
3606 over the utilization of a machine. The system load is defined as the number of
3607 runnable tasks in the run-queue and is provided by many operating systems as a
3608 one, five or fifteen minute average.
3610 The following configuration options are available:
3614 =item B<ReportRelative> B<false>|B<true>
3616 When enabled, system load divided by number of available CPU cores is reported
3617 for intervals 1 min, 5 min and 15 min. Defaults to false.
3622 =head2 Plugin C<logfile>
3626 =item B<LogLevel> B<debug|info|notice|warning|err>
3628 Sets the log-level. If, for example, set to B<notice>, then all events with
3629 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3631 Please note that B<debug> is only available if collectd has been compiled with
3634 =item B<File> I<File>
3636 Sets the file to write log messages to. The special strings B<stdout> and
3637 B<stderr> can be used to write to the standard output and standard error
3638 channels, respectively. This, of course, only makes much sense when I<collectd>
3639 is running in foreground- or non-daemon-mode.
3641 =item B<Timestamp> B<true>|B<false>
3643 Prefix all lines printed by the current time. Defaults to B<true>.
3645 =item B<PrintSeverity> B<true>|B<false>
3647 When enabled, all lines are prefixed by the severity of the log message, for
3648 example "warning". Defaults to B<false>.
3652 B<Note>: There is no need to notify the daemon after moving or removing the
3653 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3654 for each line it writes.
3656 =head2 Plugin C<log_logstash>
3658 The I<log logstash plugin> behaves like the logfile plugin but formats
3659 messages as JSON events for logstash to parse and input.
3663 =item B<LogLevel> B<debug|info|notice|warning|err>
3665 Sets the log-level. If, for example, set to B<notice>, then all events with
3666 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3668 Please note that B<debug> is only available if collectd has been compiled with
3671 =item B<File> I<File>
3673 Sets the file to write log messages to. The special strings B<stdout> and
3674 B<stderr> can be used to write to the standard output and standard error
3675 channels, respectively. This, of course, only makes much sense when I<collectd>
3676 is running in foreground- or non-daemon-mode.
3680 B<Note>: There is no need to notify the daemon after moving or removing the
3681 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3682 for each line it writes.
3684 =head2 Plugin C<lpar>
3686 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3687 virtualization technique for IBM POWER processors. It takes into account CPU
3688 time stolen from or donated to a partition, in addition to the usual user,
3689 system, I/O statistics.
3691 The following configuration options are available:
3695 =item B<CpuPoolStats> B<false>|B<true>
3697 When enabled, statistics about the processor pool are read, too. The partition
3698 needs to have pool authority in order to be able to acquire this information.
3701 =item B<ReportBySerial> B<false>|B<true>
3703 If enabled, the serial of the physical machine the partition is currently
3704 running on is reported as I<hostname> and the logical hostname of the machine
3705 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3706 used (just like other plugins) and the I<plugin instance> will be empty.
3711 =head2 Plugin C<lua>
3713 This plugin embeds a Lua interpreter into collectd and provides an interface
3714 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3717 =head2 Plugin C<mbmon>
3719 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3721 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3722 B<Host> and B<Port> options can be used to change these values, see below.
3723 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3724 timeouts may appear which may interfere with other statistics..
3726 C<mbmon> must be run with the -r option ("print TAG and Value format");
3727 Debian's F</etc/init.d/mbmon> script already does this, other people
3728 will need to ensure that this is the case.
3732 =item B<Host> I<Hostname>
3734 Hostname to connect to. Defaults to B<127.0.0.1>.
3736 =item B<Port> I<Port>
3738 TCP-Port to connect to. Defaults to B<411>.
3742 =head2 Plugin C<mcelog>
3744 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3746 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3747 mcelog server is running. When the server is running, the plugin will tail the
3748 specified logfile to retrieve machine check exception information and send a
3749 notification with the details from the logfile. The plugin will use the mcelog
3750 client protocol to retrieve memory related machine check exceptions. Note that
3751 for memory exceptions, notifications are only sent when there is a change in
3752 the number of corrected/uncorrected memory errors.
3754 =head3 The Memory block
3756 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3761 =item B<McelogClientSocket> I<Path>
3762 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3763 Defaults to B<"/var/run/mcelog-client">.
3765 =item B<PersistentNotification> B<true>|B<false>
3766 Override default configuration to only send notifications when sent when there
3767 is a change in the number of corrected/uncorrected memory errors. When set to
3768 true notifications will be sent for every read cycle. Default is false. Does
3769 not affect the stats being dispatched.
3775 =item B<McelogLogfile> I<Path>
3777 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3778 cannot be used in conjunction with the memory block options, they are mutually
3785 The C<md plugin> collects information from Linux Software-RAID devices (md).
3787 All reported values are of the type C<md_disks>. Reported type instances are
3788 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3789 I<missing> (physically absent) disks.
3793 =item B<Device> I<Device>
3795 Select md devices based on device name. The I<device name> is the basename of
3796 the device, i.e. the name of the block device without the leading C</dev/>.
3797 See B<IgnoreSelected> for more details.
3799 See F</"IGNORELISTS"> for details.
3801 =item B<IgnoreSelected> B<true>|B<false>
3803 Invert device selection: If set to B<true>, all md devices B<except> those
3804 listed using B<Device> are collected. If B<false> (the default), only those
3805 listed are collected. If no configuration is given, the B<md> plugin will
3806 collect data from all md devices.
3810 =head2 Plugin C<memcachec>
3812 The C<memcachec plugin> connects to a memcached server, queries one or more
3813 given I<pages> and parses the returned data according to user specification.
3814 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3817 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3818 library. Please note that there is another library with a very similar name,
3819 libmemcache (notice the missing `d'), which is not applicable.
3821 Synopsis of the configuration:
3823 <Plugin "memcachec">
3824 <Page "plugin_instance">
3827 Plugin "plugin_name"
3829 Regex "(\\d+) bytes sent"
3832 Instance "type_instance"
3837 The configuration options are:
3841 =item E<lt>B<Page> I<Name>E<gt>
3843 Each B<Page> block defines one I<page> to be queried from the memcached server.
3844 The block requires one string argument which is used as I<plugin instance>.
3846 =item B<Server> I<Address>
3848 Sets the server address to connect to when querying the page. Must be inside a
3853 When connected to the memcached server, asks for the page I<Key>.
3855 =item B<Plugin> I<Plugin>
3857 Use I<Plugin> as the plugin name when submitting values.
3858 Defaults to C<memcachec>.
3860 =item E<lt>B<Match>E<gt>
3862 Match blocks define which strings to look for and how matches substrings are
3863 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3867 =head2 Plugin C<memcached>
3869 The B<memcached plugin> connects to a memcached server and queries statistics
3870 about cache utilization, memory and bandwidth used.
3871 L<http://memcached.org/>
3873 <Plugin "memcached">
3875 #Host "memcache.example.com"
3881 The plugin configuration consists of one or more B<Instance> blocks which
3882 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3883 following options are allowed:
3887 =item B<Host> I<Hostname>
3889 Sets the B<host> field of dispatched values. Defaults to the global hostname
3891 For backwards compatibility, values are also dispatched with the global
3892 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3895 =item B<Address> I<Address>
3897 Hostname or IP to connect to. For backwards compatibility, defaults to the
3898 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3900 =item B<Port> I<Port>
3902 TCP port to connect to. Defaults to B<11211>.
3904 =item B<Socket> I<Path>
3906 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3907 setting is given, the B<Address> and B<Port> settings are ignored.
3911 =head2 Plugin C<mic>
3913 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3914 Intel's Many Integrated Core (MIC) systems.
3923 ShowTemperatures true
3926 IgnoreSelectedTemperature true
3931 IgnoreSelectedPower true
3934 The following options are valid inside the B<PluginE<nbsp>mic> block:
3938 =item B<ShowCPU> B<true>|B<false>
3940 If enabled (the default) a sum of the CPU usage across all cores is reported.
3942 =item B<ShowCPUCores> B<true>|B<false>
3944 If enabled (the default) per-core CPU usage is reported.
3946 =item B<ShowMemory> B<true>|B<false>
3948 If enabled (the default) the physical memory usage of the MIC system is
3951 =item B<ShowTemperatures> B<true>|B<false>
3953 If enabled (the default) various temperatures of the MIC system are reported.
3955 =item B<Temperature> I<Name>
3957 This option controls which temperatures are being reported. Whether matching
3958 temperatures are being ignored or I<only> matching temperatures are reported
3959 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3960 temperatures are reported.
3962 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3964 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3965 (the default) only temperatures matching a B<Temperature> option are reported
3966 or, if no B<Temperature> option is specified, all temperatures are reported. If
3967 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3970 Known temperature names are:
4004 =item B<ShowPower> B<true>|B<false>
4006 If enabled (the default) various temperatures of the MIC system are reported.
4008 =item B<Power> I<Name>
4010 This option controls which power readings are being reported. Whether matching
4011 power readings are being ignored or I<only> matching power readings are reported
4012 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4013 power readings are reported.
4015 =item B<IgnoreSelectedPower> B<false>|B<true>
4017 Controls the behavior of the B<Power> setting above. If set to B<false>
4018 (the default) only power readings matching a B<Power> option are reported
4019 or, if no B<Power> option is specified, all power readings are reported. If
4020 set to B<true>, matching power readings are I<ignored> and all other power readings
4023 Known power names are:
4029 Total power utilization averaged over Time Window 0 (uWatts).
4033 Total power utilization averaged over Time Window 0 (uWatts).
4037 Instantaneous power (uWatts).
4041 Max instantaneous power (uWatts).
4045 PCI-E connector power (uWatts).
4049 2x3 connector power (uWatts).
4053 2x4 connector power (uWatts).
4061 Uncore rail (uVolts).
4065 Memory subsystem rail (uVolts).
4071 =head2 Plugin C<memory>
4073 The I<memory plugin> provides the following configuration options:
4077 =item B<ValuesAbsolute> B<true>|B<false>
4079 Enables or disables reporting of physical memory usage in absolute numbers,
4080 i.e. bytes. Defaults to B<true>.
4082 =item B<ValuesPercentage> B<false>|B<true>
4084 Enables or disables reporting of physical memory usage in percentages, e.g.
4085 percent of physical memory used. Defaults to B<false>.
4087 This is useful for deploying I<collectd> in a heterogeneous environment in
4088 which the sizes of physical memory vary.
4092 =head2 Plugin C<modbus>
4094 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4095 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4096 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
4097 values (two registers interpreted as IEEE floats in big endian notation).
4101 <Data "voltage-input-1">
4104 RegisterCmd ReadHolding
4109 <Data "voltage-input-2">
4112 RegisterCmd ReadHolding
4117 <Data "supply-temperature-1">
4120 RegisterCmd ReadHolding
4125 <Host "modbus.example.com">
4126 Address "192.168.0.42"
4131 Instance "power-supply"
4132 Collect "voltage-input-1"
4133 Collect "voltage-input-2"
4138 Device "/dev/ttyUSB0"
4143 Instance "temperature"
4144 Collect "supply-temperature-1"
4150 =item E<lt>B<Data> I<Name>E<gt> blocks
4152 Data blocks define a mapping between register numbers and the "types" used by
4155 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4159 =item B<RegisterBase> I<Number>
4161 Configures the base register to read from the device. If the option
4162 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4163 register will be read (the register number is increased by one).
4165 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
4167 Specifies what kind of data is returned by the device. If the type is B<Int32>,
4168 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
4169 combined into one value. Defaults to B<Uint16>.
4171 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4173 Specifies register type to be collected from device. Works only with libmodbus
4174 2.9.2 or higher. Defaults to B<ReadHolding>.
4176 =item B<Type> I<Type>
4178 Specifies the "type" (data set) to use when dispatching the value to
4179 I<collectd>. Currently, only data sets with exactly one data source are
4182 =item B<Instance> I<Instance>
4184 Sets the type instance to use when dispatching the value to I<collectd>. If
4185 unset, an empty string (no type instance) is used.
4189 =item E<lt>B<Host> I<Name>E<gt> blocks
4191 Host blocks are used to specify to which hosts to connect and what data to read
4192 from their "slaves". The string argument I<Name> is used as hostname when
4193 dispatching the values to I<collectd>.
4195 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4199 =item B<Address> I<Hostname>
4201 For Modbus/TCP, specifies the node name (the actual network address) used to
4202 connect to the host. This may be an IP address or a hostname. Please note that
4203 the used I<libmodbus> library only supports IPv4 at the moment.
4205 =item B<Port> I<Service>
4207 for Modbus/TCP, specifies the port used to connect to the host. The port can
4208 either be given as a number or as a service name. Please note that the
4209 I<Service> argument must be a string, even if ports are given in their numerical
4210 form. Defaults to "502".
4212 =item B<Device> I<Devicenode>
4214 For Modbus/RTU, specifies the path to the serial device being used.
4216 =item B<Baudrate> I<Baudrate>
4218 For Modbus/RTU, specifies the baud rate of the serial device.
4219 Note, connections currently support only 8/N/1.
4221 =item B<Interval> I<Interval>
4223 Sets the interval (in seconds) in which the values will be collected from this
4224 host. By default the global B<Interval> setting will be used.
4226 =item E<lt>B<Slave> I<ID>E<gt>
4228 Over each connection, multiple Modbus devices may be reached. The slave ID
4229 is used to specify which device should be addressed. For each device you want
4230 to query, one B<Slave> block must be given.
4232 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4236 =item B<Instance> I<Instance>
4238 Specify the plugin instance to use when dispatching the values to I<collectd>.
4239 By default "slave_I<ID>" is used.
4241 =item B<Collect> I<DataName>
4243 Specifies which data to retrieve from the device. I<DataName> must be the same
4244 string as the I<Name> argument passed to a B<Data> block. You can specify this
4245 option multiple times to collect more than one value from a slave. At least one
4246 B<Collect> option is mandatory.
4254 =head2 Plugin C<mqtt>
4256 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4257 values from MQTT (B<Subscribe> blocks).
4263 Host "mqtt.example.com"
4267 Host "mqtt.example.com"
4272 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4273 configuring the sending and receiving direction respectively. The plugin will
4274 register a write callback named C<mqtt/I<name>> where I<name> is the string
4275 argument given to the B<Publish> block. Both types of blocks share many but not
4276 all of the following options. If an option is valid in only one of the blocks,
4277 it will be mentioned explicitly.
4283 =item B<Host> I<Hostname>
4285 Hostname of the MQTT broker to connect to.
4287 =item B<Port> I<Service>
4289 Port number or service name of the MQTT broker to connect to.
4291 =item B<User> I<UserName>
4293 Username used when authenticating to the MQTT broker.
4295 =item B<Password> I<Password>
4297 Password used when authenticating to the MQTT broker.
4299 =item B<ClientId> I<ClientId>
4301 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4303 =item B<QoS> [B<0>-B<2>]
4305 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4323 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4324 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4325 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4326 on a message is larger than the maximum accepted QoS of a subscriber, the
4327 message's QoS will be downgraded.
4329 =item B<Prefix> I<Prefix> (Publish only)
4331 This plugin will use one topic per I<value list> which will looks like a path.
4332 I<Prefix> is used as the first path element and defaults to B<collectd>.
4334 An example topic name would be:
4336 collectd/cpu-0/cpu-user
4338 =item B<Retain> B<false>|B<true> (Publish only)
4340 Controls whether the MQTT broker will retain (keep a copy of) the last message
4341 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4343 =item B<StoreRates> B<true>|B<false> (Publish only)
4345 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4346 before sending. Defaults to B<true>.
4348 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4350 Controls whether the MQTT "cleans" the session up after the subscriber
4351 disconnects or if it maintains the subscriber's subscriptions and all messages
4352 that arrive while the subscriber is disconnected. Defaults to B<true>.
4354 =item B<Topic> I<TopicName> (Subscribe only)
4356 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4357 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4358 the B<collectd> branch.
4360 =item B<CACert> I<file>
4362 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4363 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4364 port of the MQTT broker.
4365 This option enables the use of TLS.
4367 =item B<CertificateFile> I<file>
4369 Path to the PEM-encoded certificate file to use as client certificate when
4370 connecting to the MQTT broker.
4371 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4373 =item B<CertificateKeyFile> I<file>
4375 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4376 Only valid if B<CACert> and B<CertificateFile> are also set.
4378 =item B<TLSProtocol> I<protocol>
4380 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4381 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4382 version is used which depends on the version of OpenSSL the Mosquitto library
4384 Only valid if B<CACert> is set.
4386 =item B<CipherSuite> I<ciphersuite>
4388 A string describing the ciphers available for use. See L<ciphers(1)> and the
4389 C<openssl ciphers> utility for more information. If unset, the default ciphers
4391 Only valid if B<CACert> is set.
4395 =head2 Plugin C<mysql>
4397 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4398 one or more databases when started and keeps the connection up as long as
4399 possible. When the connection is interrupted for whatever reason it will try
4400 to re-connect. The plugin will complain loudly in case anything goes wrong.
4402 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4403 and collects information about MySQL network traffic, executed statements,
4404 requests, the query cache and threads by evaluating the
4405 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4406 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4407 Status Variables> for an explanation of these values.
4409 Optionally, master and slave statistics may be collected in a MySQL
4410 replication setup. In that case, information about the synchronization state
4411 of the nodes are collected by evaluating the C<Position> return value of the
4412 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4413 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4414 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4415 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4416 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4428 SSLKey "/path/to/key.pem"
4429 SSLCert "/path/to/cert.pem"
4430 SSLCA "/path/to/ca.pem"
4431 SSLCAPath "/path/to/cas/"
4432 SSLCipher "DHE-RSA-AES256-SHA"
4438 Socket "/var/run/mysql/mysqld.sock"
4440 SlaveNotifications true
4446 Socket "/var/run/mysql/mysqld.sock"
4451 A B<Database> block defines one connection to a MySQL database. It accepts a
4452 single argument which specifies the name of the database. None of the other
4453 options are required. MySQL will use default values as documented in the
4454 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4455 B<MySQL reference manual>.
4459 =item B<Alias> I<Alias>
4461 Alias to use as sender instead of hostname when reporting. This may be useful
4462 when having cryptic hostnames.
4464 =item B<Host> I<Hostname>
4466 Hostname of the database server. Defaults to B<localhost>.
4468 =item B<User> I<Username>
4470 Username to use when connecting to the database. The user does not have to be
4471 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4472 unless you want to collectd replication statistics (see B<MasterStats> and
4473 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4474 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4476 =item B<Password> I<Password>
4478 Password needed to log into the database.
4480 =item B<Database> I<Database>
4482 Select this database. Defaults to I<no database> which is a perfectly reasonable
4483 option for what this plugin does.
4485 =item B<Port> I<Port>
4487 TCP-port to connect to. The port must be specified in its numeric form, but it
4488 must be passed as a string nonetheless. For example:
4492 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4493 See the documentation for the C<mysql_real_connect> function for details.
4495 =item B<Socket> I<Socket>
4497 Specifies the path to the UNIX domain socket of the MySQL server. This option
4498 only has any effect, if B<Host> is set to B<localhost> (the default).
4499 Otherwise, use the B<Port> option above. See the documentation for the
4500 C<mysql_real_connect> function for details.
4502 =item B<InnodbStats> I<true|false>
4504 If enabled, metrics about the InnoDB storage engine are collected.
4505 Disabled by default.
4507 =item B<MasterStats> I<true|false>
4509 =item B<SlaveStats> I<true|false>
4511 Enable the collection of master / slave statistics in a replication setup. In
4512 order to be able to get access to these statistics, the user needs special
4513 privileges. See the B<User> documentation above. Defaults to B<false>.
4515 =item B<SlaveNotifications> I<true|false>
4517 If enabled, the plugin sends a notification if the replication slave I/O and /
4518 or SQL threads are not running. Defaults to B<false>.
4520 =item B<WsrepStats> I<true|false>
4522 Enable the collection of wsrep plugin statistics, used in Master-Master
4523 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4524 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4526 =item B<ConnectTimeout> I<Seconds>
4528 Sets the connect timeout for the MySQL client.
4530 =item B<SSLKey> I<Path>
4532 If provided, the X509 key in PEM format.
4534 =item B<SSLCert> I<Path>
4536 If provided, the X509 cert in PEM format.
4538 =item B<SSLCA> I<Path>
4540 If provided, the CA file in PEM format (check OpenSSL docs).
4542 =item B<SSLCAPath> I<Path>
4544 If provided, the CA directory (check OpenSSL docs).
4546 =item B<SSLCipher> I<String>
4548 If provided, the SSL cipher to use.
4552 =head2 Plugin C<netapp>
4554 The netapp plugin can collect various performance and capacity information
4555 from a NetApp filer using the NetApp API.
4557 Please note that NetApp has a wide line of products and a lot of different
4558 software versions for each of these products. This plugin was developed for a
4559 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4560 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4561 model and software version but it is very hard to test this.
4562 If you have used this plugin with other models and/or software version, feel
4563 free to send us a mail to tell us about the results, even if it's just a short
4566 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4567 basic authentication.
4569 B<Do not use a regular user for this!> Create a special collectd user with just
4570 the minimum of capabilities needed. The user only needs the "login-http-admin"
4571 capability as well as a few more depending on which data will be collected.
4572 Required capabilities are documented below.
4577 <Host "netapp1.example.com">
4601 IgnoreSelectedIO false
4603 IgnoreSelectedOps false
4604 GetLatency "volume0"
4605 IgnoreSelectedLatency false
4612 IgnoreSelectedCapacity false
4615 IgnoreSelectedSnapshot false
4643 The netapp plugin accepts the following configuration options:
4647 =item B<Host> I<Name>
4649 A host block defines one NetApp filer. It will appear in collectd with the name
4650 you specify here which does not have to be its real name nor its hostname (see
4651 the B<Address> option below).
4653 =item B<VFiler> I<Name>
4655 A B<VFiler> block may only be used inside a host block. It accepts all the
4656 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4657 will execute all NetApp API commands in the context of the specified
4658 VFiler(R). It will appear in collectd with the name you specify here which
4659 does not have to be its real name. The VFiler name may be specified using the
4660 B<VFilerName> option. If this is not specified, it will default to the name
4663 The VFiler block inherits all connection related settings from the surrounding
4664 B<Host> block (which appear before the B<VFiler> block) but they may be
4665 overwritten inside the B<VFiler> block.
4667 This feature is useful, for example, when using a VFiler as SnapVault target
4668 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4669 available in the host filer (vfiler0) but only in the respective VFiler
4672 =item B<Protocol> B<httpd>|B<http>
4674 The protocol collectd will use to query this host.
4682 Valid options: http, https
4684 =item B<Address> I<Address>
4686 The hostname or IP address of the host.
4692 Default: The "host" block's name.
4694 =item B<Port> I<Port>
4696 The TCP port to connect to on the host.
4702 Default: 80 for protocol "http", 443 for protocol "https"
4704 =item B<User> I<User>
4706 =item B<Password> I<Password>
4708 The username and password to use to login to the NetApp.
4714 =item B<VFilerName> I<Name>
4716 The name of the VFiler in which context to execute API commands. If not
4717 specified, the name provided to the B<VFiler> block will be used instead.
4723 Default: name of the B<VFiler> block
4725 B<Note:> This option may only be used inside B<VFiler> blocks.
4727 =item B<Interval> I<Interval>
4733 The following options decide what kind of data will be collected. You can
4734 either use them as a block and fine tune various parameters inside this block,
4735 use them as a single statement to just accept all default values, or omit it to
4736 not collect any data.
4738 The following options are valid inside all blocks:
4742 =item B<Interval> I<Seconds>
4744 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4745 host specific setting.
4749 =head3 The System block
4751 This will collect various performance data about the whole system.
4753 B<Note:> To get this data the collectd user needs the
4754 "api-perf-object-get-instances" capability.
4758 =item B<Interval> I<Seconds>
4760 Collect disk statistics every I<Seconds> seconds.
4762 =item B<GetCPULoad> B<true>|B<false>
4764 If you set this option to true the current CPU usage will be read. This will be
4765 the average usage between all CPUs in your NetApp without any information about
4768 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4769 returns in the "CPU" field.
4777 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4779 =item B<GetInterfaces> B<true>|B<false>
4781 If you set this option to true the current traffic of the network interfaces
4782 will be read. This will be the total traffic over all interfaces of your NetApp
4783 without any information about individual interfaces.
4785 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4786 in the "Net kB/s" field.
4796 Result: One value list of type "if_octects".
4798 =item B<GetDiskIO> B<true>|B<false>
4800 If you set this option to true the current IO throughput will be read. This
4801 will be the total IO of your NetApp without any information about individual
4802 disks, volumes or aggregates.
4804 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4805 in the "DiskE<nbsp>kB/s" field.
4813 Result: One value list of type "disk_octets".
4815 =item B<GetDiskOps> B<true>|B<false>
4817 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4818 iSCSI, etc. operations will be read. This will be the total number of
4819 operations on your NetApp without any information about individual volumes or
4822 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4823 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4831 Result: A variable number of value lists of type "disk_ops_complex". Each type
4832 of operation will result in one value list with the name of the operation as
4837 =head3 The WAFL block
4839 This will collect various performance data about the WAFL file system. At the
4840 moment this just means cache performance.
4842 B<Note:> To get this data the collectd user needs the
4843 "api-perf-object-get-instances" capability.
4845 B<Note:> The interface to get these values is classified as "Diagnostics" by
4846 NetApp. This means that it is not guaranteed to be stable even between minor
4851 =item B<Interval> I<Seconds>
4853 Collect disk statistics every I<Seconds> seconds.
4855 =item B<GetNameCache> B<true>|B<false>
4863 Result: One value list of type "cache_ratio" and type instance
4866 =item B<GetDirCache> B<true>|B<false>
4874 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4876 =item B<GetInodeCache> B<true>|B<false>
4884 Result: One value list of type "cache_ratio" and type instance
4887 =item B<GetBufferCache> B<true>|B<false>
4889 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4890 in the "Cache hit" field.
4898 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4902 =head3 The Disks block
4904 This will collect performance data about the individual disks in the NetApp.
4906 B<Note:> To get this data the collectd user needs the
4907 "api-perf-object-get-instances" capability.
4911 =item B<Interval> I<Seconds>
4913 Collect disk statistics every I<Seconds> seconds.
4915 =item B<GetBusy> B<true>|B<false>
4917 If you set this option to true the busy time of all disks will be calculated
4918 and the value of the busiest disk in the system will be written.
4920 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4921 in the "Disk util" field. Probably.
4929 Result: One value list of type "percent" and type instance "disk_busy".
4933 =head3 The VolumePerf block
4935 This will collect various performance data about the individual volumes.
4937 You can select which data to collect about which volume using the following
4938 options. They follow the standard ignorelist semantic.
4940 B<Note:> To get this data the collectd user needs the
4941 I<api-perf-object-get-instances> capability.
4945 =item B<Interval> I<Seconds>
4947 Collect volume performance data every I<Seconds> seconds.
4949 =item B<GetIO> I<Volume>
4951 =item B<GetOps> I<Volume>
4953 =item B<GetLatency> I<Volume>
4955 Select the given volume for IO, operations or latency statistics collection.
4956 The argument is the name of the volume without the C</vol/> prefix.
4958 Since the standard ignorelist functionality is used here, you can use a string
4959 starting and ending with a slash to specify regular expression matching: To
4960 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4963 GetIO "/^vol[027]$/"
4965 If no regular expression is specified, an exact match is required. Both,
4966 regular and exact matching are case sensitive.
4968 If no volume was specified at all for either of the three options, that data
4969 will be collected for all available volumes.
4971 See F</"IGNORELISTS"> for details.
4973 =item B<IgnoreSelectedIO> B<true>|B<false>
4975 =item B<IgnoreSelectedOps> B<true>|B<false>
4977 =item B<IgnoreSelectedLatency> B<true>|B<false>
4979 When set to B<true>, the volumes selected for IO, operations or latency
4980 statistics collection will be ignored and the data will be collected for all
4983 When set to B<false>, data will only be collected for the specified volumes and
4984 all other volumes will be ignored.
4986 If no volumes have been specified with the above B<Get*> options, all volumes
4987 will be collected regardless of the B<IgnoreSelected*> option.
4989 Defaults to B<false>
4993 =head3 The VolumeUsage block
4995 This will collect capacity data about the individual volumes.
4997 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5002 =item B<Interval> I<Seconds>
5004 Collect volume usage statistics every I<Seconds> seconds.
5006 =item B<GetCapacity> I<VolumeName>
5008 The current capacity of the volume will be collected. This will result in two
5009 to four value lists, depending on the configuration of the volume. All data
5010 sources are of type "df_complex" with the name of the volume as
5013 There will be type_instances "used" and "free" for the number of used and
5014 available bytes on the volume. If the volume has some space reserved for
5015 snapshots, a type_instance "snap_reserved" will be available. If the volume
5016 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5017 number of bytes saved by the SIS feature.
5019 B<Note:> The current NetApp API has a bug that results in this value being
5020 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5021 number which works most of the time. If you see strange values here, bug
5022 NetApp support to fix this.
5024 Repeat this option to specify multiple volumes.
5026 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5028 Specify whether to collect only the volumes selected by the B<GetCapacity>
5029 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5030 B<false>. However, if no B<GetCapacity> option is specified at all, all
5031 capacities will be selected anyway.
5033 =item B<GetSnapshot> I<VolumeName>
5035 Select volumes from which to collect snapshot information.
5037 Usually, the space used for snapshots is included in the space reported as
5038 "used". If snapshot information is collected as well, the space used for
5039 snapshots is subtracted from the used space.
5041 To make things even more interesting, it is possible to reserve space to be
5042 used for snapshots. If the space required for snapshots is less than that
5043 reserved space, there is "reserved free" and "reserved used" space in addition
5044 to "free" and "used". If the space required for snapshots exceeds the reserved
5045 space, that part allocated in the normal space is subtracted from the "used"
5048 Repeat this option to specify multiple volumes.
5050 =item B<IgnoreSelectedSnapshot>
5052 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5053 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5054 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5055 capacities will be selected anyway.
5059 =head3 The Quota block
5061 This will collect (tree) quota statistics (used disk space and number of used
5062 files). This mechanism is useful to get usage information for single qtrees.
5063 In case the quotas are not used for any other purpose, an entry similar to the
5064 following in C</etc/quotas> would be sufficient:
5066 /vol/volA/some_qtree tree - - - - -
5068 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5072 =item B<Interval> I<Seconds>
5074 Collect SnapVault(R) statistics every I<Seconds> seconds.
5078 =head3 The SnapVault block
5080 This will collect statistics about the time and traffic of SnapVault(R)
5085 =item B<Interval> I<Seconds>
5087 Collect SnapVault(R) statistics every I<Seconds> seconds.
5091 =head2 Plugin C<netlink>
5093 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5094 statistics of various interface and routing aspects.
5098 =item B<Interface> I<Interface>
5100 =item B<VerboseInterface> I<Interface>
5102 Instruct the plugin to collect interface statistics. This is basically the same
5103 as the statistics provided by the C<interface> plugin (see above) but
5104 potentially much more detailed.
5106 When configuring with B<Interface> only the basic statistics will be collected,
5107 namely octets, packets, and errors. These statistics are collected by
5108 the C<interface> plugin, too, so using both at the same time is no benefit.
5110 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5111 so that no data needs to be collected twice if you use the C<interface> plugin.
5112 This includes dropped packets, received multicast packets, collisions and a
5113 whole zoo of differentiated RX and TX errors. You can try the following command
5114 to get an idea of what awaits you:
5118 If I<Interface> is B<All>, all interfaces will be selected.
5120 =item B<QDisc> I<Interface> [I<QDisc>]
5122 =item B<Class> I<Interface> [I<Class>]
5124 =item B<Filter> I<Interface> [I<Filter>]
5126 Collect the octets and packets that pass a certain qdisc, class or filter.
5128 QDiscs and classes are identified by their type and handle (or classid).
5129 Filters don't necessarily have a handle, therefore the parent's handle is used.
5130 The notation used in collectd differs from that used in tc(1) in that it
5131 doesn't skip the major or minor number if it's zero and doesn't print special
5132 ids by their name. So, for example, a qdisc may be identified by
5133 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5134 thus not displayed by tc(1).
5136 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5137 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5138 associated with that interface will be collected.
5140 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5141 used. This may lead to problems when more than one filter is attached to a
5142 qdisc or class. This isn't nice, but we don't know how this could be done any
5143 better. If you have a idea, please don't hesitate to tell us.
5145 As with the B<Interface> option you can specify B<All> as the interface,
5146 meaning all interfaces.
5148 Here are some examples to help you understand the above text more easily:
5151 VerboseInterface "All"
5152 QDisc "eth0" "pfifo_fast-1:0"
5154 Class "ppp0" "htb-1:10"
5155 Filter "ppp0" "u32-1:0"
5158 See F</"IGNORELISTS"> for details.
5160 =item B<IgnoreSelected>
5162 The behavior is the same as with all other similar plugins: If nothing is
5163 selected at all, everything is collected. If some things are selected using the
5164 options described above, only these statistics are collected. If you set
5165 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5166 specified statistics will not be collected.
5170 =head2 Plugin C<network>
5172 The Network plugin sends data to a remote instance of collectd, receives data
5173 from a remote instance, or both at the same time. Data which has been received
5174 from the network is usually not transmitted again, but this can be activated, see
5175 the B<Forward> option below.
5177 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5178 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5180 Both, B<Server> and B<Listen> can be used as single option or as block. When
5181 used as block, given options are valid for this socket only. The following
5182 example will export the metrics twice: Once to an "internal" server (without
5183 encryption and signing) and one to an external server (with cryptographic
5187 # Export to an internal server
5188 # (demonstrates usage without additional options)
5189 Server "collectd.internal.tld"
5191 # Export to an external server
5192 # (demonstrates usage with signature options)
5193 <Server "collectd.external.tld">
5194 SecurityLevel "sign"
5195 Username "myhostname"
5202 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5204 The B<Server> statement/block sets the server to send datagrams to. The
5205 statement may occur multiple times to send each datagram to multiple
5208 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5209 optional second argument specifies a port number or a service name. If not
5210 given, the default, B<25826>, is used.
5212 The following options are recognized within B<Server> blocks:
5216 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5218 Set the security you require for network communication. When the security level
5219 has been set to B<Encrypt>, data sent over the network will be encrypted using
5220 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5221 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5222 authentication code. When set to B<None>, data is sent without any security.
5224 This feature is only available if the I<network> plugin was linked with
5227 =item B<Username> I<Username>
5229 Sets the username to transmit. This is used by the server to lookup the
5230 password. See B<AuthFile> below. All security levels except B<None> require
5233 This feature is only available if the I<network> plugin was linked with
5236 =item B<Password> I<Password>
5238 Sets a password (shared secret) for this socket. All security levels except
5239 B<None> require this setting.
5241 This feature is only available if the I<network> plugin was linked with
5244 =item B<Interface> I<Interface name>
5246 Set the outgoing interface for IP packets. This applies at least
5247 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5248 undefined or a non-existent interface name is specified, the default
5249 behavior is to let the kernel choose the appropriate interface. Be warned
5250 that the manual selection of an interface for unicast traffic is only
5251 necessary in rare cases.
5253 =item B<ResolveInterval> I<Seconds>
5255 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5256 useful to force a regular DNS lookup to support a high availability setup. If
5257 not specified, re-resolves are never attempted.
5261 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5263 The B<Listen> statement sets the interfaces to bind to. When multiple
5264 statements are found the daemon will bind to multiple interfaces.
5266 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5267 the argument is a multicast address the daemon will join that multicast group.
5268 The optional second argument specifies a port number or a service name. If not
5269 given, the default, B<25826>, is used.
5271 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5275 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5277 Set the security you require for network communication. When the security level
5278 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5279 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5280 signed and encrypted data is accepted. When set to B<None>, all data will be
5281 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5282 decrypted if possible.
5284 This feature is only available if the I<network> plugin was linked with
5287 =item B<AuthFile> I<Filename>
5289 Sets a file in which usernames are mapped to passwords. These passwords are
5290 used to verify signatures and to decrypt encrypted network packets. If
5291 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5292 verified and encrypted packets are decrypted. Otherwise, signed data is
5293 accepted without checking the signature and encrypted data cannot be decrypted.
5294 For the other security levels this option is mandatory.
5296 The file format is very simple: Each line consists of a username followed by a
5297 colon and any number of spaces followed by the password. To demonstrate, an
5298 example file could look like this:
5303 Each time a packet is received, the modification time of the file is checked
5304 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5305 the file is being read, it is locked using L<fcntl(2)>.
5307 =item B<Interface> I<Interface name>
5309 Set the incoming interface for IP packets explicitly. This applies at least
5310 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5311 undefined or a non-existent interface name is specified, the default
5312 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5313 traffic gets only accepted, if it arrives on the given interface.
5317 =item B<TimeToLive> I<1-255>
5319 Set the time-to-live of sent packets. This applies to all, unicast and
5320 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5321 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5324 =item B<MaxPacketSize> I<1024-65535>
5326 Set the maximum size for datagrams received over the network. Packets larger
5327 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5328 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5331 On the server side, this limit should be set to the largest value used on
5332 I<any> client. Likewise, the value on the client must not be larger than the
5333 value on the server, or data will be lost.
5335 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5336 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5337 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5340 =item B<Forward> I<true|false>
5342 If set to I<true>, write packets that were received via the network plugin to
5343 the sending sockets. This should only be activated when the B<Listen>- and
5344 B<Server>-statements differ. Otherwise packets may be send multiple times to
5345 the same multicast group. While this results in more network traffic than
5346 necessary it's not a huge problem since the plugin has a duplicate detection,
5347 so the values will not loop.
5349 =item B<ReportStats> B<true>|B<false>
5351 The network plugin cannot only receive and send statistics, it can also create
5352 statistics about itself. Collectd data included the number of received and
5353 sent octets and packets, the length of the receive queue and the number of
5354 values handled. When set to B<true>, the I<Network plugin> will make these
5355 statistics available. Defaults to B<false>.
5359 =head2 Plugin C<nfs>
5361 The I<nfs plugin> collects information about the usage of the Network File
5362 System (NFS). It counts the number of procedure calls for each procedure,
5363 grouped by version and whether the system runs as server or client.
5365 It is possibly to omit metrics for a specific NFS version by setting one or
5366 more of the following options to B<false> (all of them default to B<true>).
5370 =item B<ReportV2> B<true>|B<false>
5372 =item B<ReportV3> B<true>|B<false>
5374 =item B<ReportV4> B<true>|B<false>
5378 =head2 Plugin C<nginx>
5380 This plugin collects the number of connections and requests handled by the
5381 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5382 queries the page provided by the C<ngx_http_stub_status_module> module, which
5383 isn't compiled by default. Please refer to
5384 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5385 how to compile and configure nginx and this module.
5387 The following options are accepted by the C<nginx plugin>:
5391 =item B<URL> I<http://host/nginx_status>
5393 Sets the URL of the C<ngx_http_stub_status_module> output.
5395 =item B<User> I<Username>
5397 Optional user name needed for authentication.
5399 =item B<Password> I<Password>
5401 Optional password needed for authentication.
5403 =item B<VerifyPeer> B<true|false>
5405 Enable or disable peer SSL certificate verification. See
5406 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5408 =item B<VerifyHost> B<true|false>
5410 Enable or disable peer host name verification. If enabled, the plugin checks
5411 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5412 certificate matches the host name provided by the B<URL> option. If this
5413 identity check fails, the connection is aborted. Obviously, only works when
5414 connecting to a SSL enabled server. Enabled by default.
5416 =item B<CACert> I<File>
5418 File that holds one or more SSL certificates. If you want to use HTTPS you will
5419 possibly need this option. What CA certificates come bundled with C<libcurl>
5420 and are checked by default depends on the distribution you use.
5422 =item B<Timeout> I<Milliseconds>
5424 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5425 milliseconds. By default, the configured B<Interval> is used to set the
5430 =head2 Plugin C<notify_desktop>
5432 This plugin sends a desktop notification to a notification daemon, as defined
5433 in the Desktop Notification Specification. To actually display the
5434 notifications, B<notification-daemon> is required and B<collectd> has to be
5435 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5436 environment variables have to be set correctly) and the D-Bus message bus.
5438 The Desktop Notification Specification can be found at
5439 L<http://www.galago-project.org/specs/notification/>.
5443 =item B<OkayTimeout> I<timeout>
5445 =item B<WarningTimeout> I<timeout>
5447 =item B<FailureTimeout> I<timeout>
5449 Set the I<timeout>, in milliseconds, after which to expire the notification
5450 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5451 been specified, the displayed notification will not be closed at all - the
5452 user has to do so herself. These options default to 5000. If a negative number
5453 has been specified, the default is used as well.
5457 =head2 Plugin C<notify_email>
5459 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5460 configured email address.
5462 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5464 Available configuration options:
5468 =item B<From> I<Address>
5470 Email address from which the emails should appear to come from.
5472 Default: C<root@localhost>
5474 =item B<Recipient> I<Address>
5476 Configures the email address(es) to which the notifications should be mailed.
5477 May be repeated to send notifications to multiple addresses.
5479 At least one B<Recipient> must be present for the plugin to work correctly.
5481 =item B<SMTPServer> I<Hostname>
5483 Hostname of the SMTP server to connect to.
5485 Default: C<localhost>
5487 =item B<SMTPPort> I<Port>
5489 TCP port to connect to.
5493 =item B<SMTPUser> I<Username>
5495 Username for ASMTP authentication. Optional.
5497 =item B<SMTPPassword> I<Password>
5499 Password for ASMTP authentication. Optional.
5501 =item B<Subject> I<Subject>
5503 Subject-template to use when sending emails. There must be exactly two
5504 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5505 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5508 Default: C<Collectd notify: %s@%s>
5512 =head2 Plugin C<notify_nagios>
5514 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5515 a I<passive service check result>.
5517 Available configuration options:
5521 =item B<CommandFile> I<Path>
5523 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5527 =head2 Plugin C<ntpd>
5529 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5532 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5533 the wire - using B<mode 7> specific requests. This mode is deprecated with
5534 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5535 correctly with them, the ntp daemon must be explicitly configured to
5536 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5537 manual page for details.
5539 Available configuration options for the C<ntpd> plugin:
5543 =item B<Host> I<Hostname>
5545 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5547 =item B<Port> I<Port>
5549 UDP-Port to connect to. Defaults to B<123>.
5551 =item B<ReverseLookups> B<true>|B<false>
5553 Sets whether or not to perform reverse lookups on peers. Since the name or
5554 IP-address may be used in a filename it is recommended to disable reverse
5555 lookups. The default is to do reverse lookups to preserve backwards
5556 compatibility, though.
5558 =item B<IncludeUnitID> B<true>|B<false>
5560 When a peer is a refclock, include the unit ID in the I<type instance>.
5561 Defaults to B<false> for backward compatibility.
5563 If two refclock peers use the same driver and this is B<false>, the plugin will
5564 try to write simultaneous measurements from both to the same type instance.
5565 This will result in error messages in the log and only one set of measurements
5570 =head2 Plugin C<nut>
5574 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5576 Add a UPS to collect data from. The format is identical to the one accepted by
5579 =item B<ForceSSL> B<true>|B<false>
5581 Stops connections from falling back to unsecured if an SSL connection
5582 cannot be established. Defaults to false if undeclared.
5584 =item B<VerifyPeer> I<true>|I<false>
5586 If set to true, requires a CAPath be provided. Will use the CAPath to find
5587 certificates to use as Trusted Certificates to validate a upsd server certificate.
5588 If validation of the upsd server certificate fails, the connection will not be
5589 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5590 will override and set ForceSSL to true.
5592 =item B<CAPath> I/path/to/certs/folder
5594 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5595 The folder pointed at must contain certificate(s) named according to their hash.
5596 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5597 occur because two different certs have the same hash value, Y can be incremented
5598 in order to avoid conflict. To create a symbolic link to a certificate the following
5599 command can be used from within the directory where the cert resides:
5601 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5603 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5604 generate links like the one described above for ALL certs in a given folder.
5606 C<c_rehash /path/to/certs/folder>
5608 =item B<ConnectTimeout> I<Milliseconds>
5610 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5611 By default, the configured B<Interval> is used to set the timeout.
5615 =head2 Plugin C<olsrd>
5617 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5618 the Optimized Link State Routing daemon and reads information about the current
5619 state of the meshed network.
5621 The following configuration options are understood:
5625 =item B<Host> I<Host>
5627 Connect to I<Host>. Defaults to B<"localhost">.
5629 =item B<Port> I<Port>
5631 Specifies the port to connect to. This must be a string, even if you give the
5632 port as a number rather than a service name. Defaults to B<"2006">.
5634 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5636 Specifies what information to collect about links, i.E<nbsp>e. direct
5637 connections of the daemon queried. If set to B<No>, no information is
5638 collected. If set to B<Summary>, the number of links and the average of all
5639 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5640 If set to B<Detail> LQ and NLQ are collected per link.
5642 Defaults to B<Detail>.
5644 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5646 Specifies what information to collect about routes of the daemon queried. If
5647 set to B<No>, no information is collected. If set to B<Summary>, the number of
5648 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5649 metric and ETX are collected per route.
5651 Defaults to B<Summary>.
5653 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5655 Specifies what information to collect about the global topology. If set to
5656 B<No>, no information is collected. If set to B<Summary>, the number of links
5657 in the entire topology and the average I<link quality> (LQ) is calculated.
5658 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5660 Defaults to B<Summary>.
5664 =head2 Plugin C<onewire>
5666 B<EXPERIMENTAL!> See notes below.
5668 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5669 L<http://owfs.org/> to read sensors connected via the onewire bus.
5671 It can be used in two possible modes - standard or advanced.
5673 In the standard mode only temperature sensors (sensors with the family code
5674 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5675 other sensors you would like to have included, please send a sort request to
5676 the mailing list. You can select sensors to be read or to be ignored depending
5677 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5678 walked and all sensors are read.
5680 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5681 experimental, below.
5683 In the advanced mode you can configure any sensor to be read (only numerical
5684 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5685 In this mode you have to list all the sensors. Neither default bus walk nor
5686 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5687 the path automatically and should produce compatible structure with the "standard"
5688 mode (basically the path is expected as for example
5689 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5690 "F10FCA000800" and the rest after the slash is considered the type - here
5692 There are two advantages to this mode - you can access virtually any sensor
5693 (not just temperature), select whether to use cached or directly read values
5694 and it is slighlty faster. The downside is more complex configuration.
5696 The two modes are distinguished automatically by the format of the address.
5697 It is not possible to mix the two modes. Once a full path is detected in any
5698 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5699 (and as standard addresses will fail parsing they will be ignored).
5703 =item B<Device> I<Device>
5705 Sets the device to read the values from. This can either be a "real" hardware
5706 device, such as a serial port or an USB port, or the address of the
5707 L<owserver(1)> socket, usually B<localhost:4304>.
5709 Though the documentation claims to automatically recognize the given address
5710 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5711 with that version, the following configuration worked for us:
5714 Device "-s localhost:4304"
5717 This directive is B<required> and does not have a default value.
5719 =item B<Sensor> I<Sensor>
5721 In the standard mode selects sensors to collect or to ignore
5722 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5723 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5724 and B<not> include the leading C<10.> family byte and point.
5725 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5726 sensors (see above) are read.
5728 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5729 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5730 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5732 As there can be multiple devices on the bus you can list multiple sensor (use
5733 multiple B<Sensor> elements).
5735 See F</"IGNORELISTS"> for details.
5737 =item B<IgnoreSelected> I<true>|I<false>
5739 If no configuration is given, the B<onewire> plugin will collect data from all
5740 sensors found. This may not be practical, especially if sensors are added and
5741 removed regularly. Sometimes, however, it's easier/preferred to collect only
5742 specific sensors or all sensors I<except> a few specified ones. This option
5743 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5744 B<Sensor> is inverted: All selected interfaces are ignored and all other
5745 interfaces are collected.
5747 Used only in the standard mode - see above.
5749 =item B<Interval> I<Seconds>
5751 Sets the interval in which all sensors should be read. If not specified, the
5752 global B<Interval> setting is used.
5756 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5757 work with big setups. It works with one sensor being attached to one
5758 controller, but as soon as you throw in a couple more senors and maybe a hub
5759 or two, reading all values will take more than ten seconds (the default
5760 interval). We will probably add some separate thread for reading the sensors
5761 and some cache or something like that, but it's not done yet. We will try to
5762 maintain backwards compatibility in the future, but we can't promise. So in
5763 short: If it works for you: Great! But keep in mind that the config I<might>
5764 change, though this is unlikely. Oh, and if you want to help improving this
5765 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5767 =head2 Plugin C<openldap>
5769 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5770 server correctly. The backend database C<monitor> needs to be loaded and
5771 working. See slapd-monitor(5) for the details.
5773 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5774 blocks. Each block requires one string argument as the instance name. For
5779 URL "ldap://localhost/"
5782 URL "ldaps://localhost/"
5786 The instance name will be used as the I<plugin instance>. To emulate the old
5787 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5788 plugin to work correctly, each instance name must be unique. This is not
5789 enforced by the plugin and it is your responsibility to ensure it is.
5791 The following options are accepted within each B<Instance> block:
5795 =item B<URL> I<ldap://host/binddn>
5797 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5800 =item B<BindDN> I<BindDN>
5802 Name in the form of an LDAP distinguished name intended to be used for
5803 authentication. Defaults to empty string to establish an anonymous authorization.
5805 =item B<Password> I<Password>
5807 Password for simple bind authentication. If this option is not set,
5808 unauthenticated bind operation is used.
5810 =item B<StartTLS> B<true|false>
5812 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5813 Disabled by default.
5815 =item B<VerifyHost> B<true|false>
5817 Enables or disables peer host name verification. If enabled, the plugin checks
5818 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5819 certificate matches the host name provided by the B<URL> option. If this
5820 identity check fails, the connection is aborted. Enabled by default.
5822 =item B<CACert> I<File>
5824 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5825 may possibly need this option. What CA certificates are checked by default
5826 depends on the distribution you use and can be changed with the usual ldap
5827 client configuration mechanisms. See ldap.conf(5) for the details.
5829 =item B<Timeout> I<Seconds>
5831 Sets the timeout value for ldap operations, in seconds. By default, the
5832 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5835 =item B<Version> I<Version>
5837 An integer which sets the LDAP protocol version number to use when connecting
5838 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5842 =head2 Plugin C<openvpn>
5844 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5845 traffic statistics about connected clients.
5847 To set up OpenVPN to write to the status file periodically, use the
5848 B<--status> option of OpenVPN.
5850 So, in a nutshell you need:
5852 openvpn $OTHER_OPTIONS \
5853 --status "/var/run/openvpn-status" 10
5859 =item B<StatusFile> I<File>
5861 Specifies the location of the status file.
5863 =item B<ImprovedNamingSchema> B<true>|B<false>
5865 When enabled, the filename of the status file will be used as plugin instance
5866 and the client's "common name" will be used as type instance. This is required
5867 when reading multiple status files. Enabling this option is recommended, but to
5868 maintain backwards compatibility this option is disabled by default.
5870 =item B<CollectCompression> B<true>|B<false>
5872 Sets whether or not statistics about the compression used by OpenVPN should be
5873 collected. This information is only available in I<single> mode. Enabled by
5876 =item B<CollectIndividualUsers> B<true>|B<false>
5878 Sets whether or not traffic information is collected for each connected client
5879 individually. If set to false, currently no traffic data is collected at all
5880 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5882 =item B<CollectUserCount> B<true>|B<false>
5884 When enabled, the number of currently connected clients or users is collected.
5885 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5886 can be configured independently from that option. Defaults to B<false>.
5890 =head2 Plugin C<oracle>
5892 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5893 Oracle® Database and lets you execute SQL statements there. It is very similar
5894 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5895 plugin's documentation above for details.
5898 <Query "out_of_stock">
5899 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5902 # InstancePrefix "foo"
5903 InstancesFrom "category"
5907 <Database "product_information">
5912 Query "out_of_stock"
5916 =head3 B<Query> blocks
5918 The Query blocks are handled identically to the Query blocks of the "dbi"
5919 plugin. Please see its documentation above for details on how to specify
5922 =head3 B<Database> blocks
5924 Database blocks define a connection to a database and which queries should be
5925 sent to that database. Each database needs a "name" as string argument in the
5926 starting tag of the block. This name will be used as "PluginInstance" in the
5927 values submitted to the daemon. Other than that, that name is not used.
5931 =item B<Plugin> I<Plugin>
5933 Use I<Plugin> as the plugin name when submitting query results from
5934 this B<Database>. Defaults to C<oracle>.
5936 =item B<ConnectID> I<ID>
5938 Defines the "database alias" or "service name" to connect to. Usually, these
5939 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5941 =item B<Host> I<Host>
5943 Hostname to use when dispatching values for this database. Defaults to using
5944 the global hostname of the I<collectd> instance.
5946 =item B<Username> I<Username>
5948 Username used for authentication.
5950 =item B<Password> I<Password>
5952 Password used for authentication.
5954 =item B<Query> I<QueryName>
5956 Associates the query named I<QueryName> with this database connection. The
5957 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5958 blocks you want to refer to must be placed above the database block you want to
5963 =head2 Plugin C<ovs_events>
5965 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5966 connected interfaces, dispatches the values to collectd and sends the
5967 notification whenever the link state change occurs. This plugin uses OVS
5968 database to get a link state change notification.
5972 <Plugin "ovs_events">
5975 Socket "/var/run/openvswitch/db.sock"
5976 Interfaces "br0" "veth0"
5977 SendNotification true
5978 DispatchValues false
5981 The plugin provides the following configuration options:
5985 =item B<Address> I<node>
5987 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5988 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5989 option. See L<ovsdb-server(1)> for more details. The option may be either
5990 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5991 format. Defaults to C<localhost>.
5993 =item B<Port> I<service>
5995 TCP-port to connect to. Either a service name or a port number may be given.
5996 Defaults to B<6640>.
5998 =item B<Socket> I<path>
6000 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6001 plugin. To enable the interface, the OVS DB daemon should be running with
6002 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6003 option is set, B<Address> and B<Port> options are ignored.
6005 =item B<Interfaces> [I<ifname> ...]
6007 List of interface names to be monitored by this plugin. If this option is not
6008 specified or is empty then all OVS connected interfaces on all bridges are
6011 Default: empty (all interfaces on all bridges are monitored)
6013 =item B<SendNotification> I<true|false>
6015 If set to true, OVS link notifications (interface status and OVS DB connection
6016 terminate) are sent to collectd. Default value is true.
6018 =item B<DispatchValues> I<true|false>
6020 Dispatch the OVS DB interface link status value with configured plugin interval.
6021 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6022 options are false, no OVS information will be provided by the plugin.
6026 B<Note:> By default, the global interval setting is used within which to
6027 retrieve the OVS link status. To configure a plugin-specific interval, please
6028 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6029 simple divide the time by 1000 for example if the desired interval is 50ms, set
6032 =head2 Plugin C<ovs_stats>
6034 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6035 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6036 statistics from OVSDB
6040 <Plugin "ovs_stats">
6043 Socket "/var/run/openvswitch/db.sock"
6044 Bridges "br0" "br_ext"
6047 The plugin provides the following configuration options:
6051 =item B<Address> I<node>
6053 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6054 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6055 option. See L<ovsdb-server(1)> for more details. The option may be either
6056 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6057 format. Defaults to C<localhost>.
6059 =item B<Port> I<service>
6061 TCP-port to connect to. Either a service name or a port number may be given.
6062 Defaults to B<6640>.
6064 =item B<Socket> I<path>
6066 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6067 plugin. To enable the interface, the OVS DB daemon should be running with
6068 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6069 option is set, B<Address> and B<Port> options are ignored.
6071 =item B<Bridges> [I<brname> ...]
6073 List of OVS bridge names to be monitored by this plugin. If this option is
6074 omitted or is empty then all OVS bridges will be monitored.
6076 Default: empty (monitor all bridges)
6080 =head2 Plugin C<perl>
6082 This plugin embeds a Perl-interpreter into collectd and provides an interface
6083 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6085 =head2 Plugin C<pinba>
6087 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6088 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6089 PHP-based webpage has been delivered, the extension will send a UDP packet
6090 containing timing information, peak memory usage and so on. The plugin will
6091 wait for such packets, parse them and account the provided information, which
6092 is then dispatched to the daemon once per interval.
6099 # Overall statistics for the website.
6101 Server "www.example.com"
6103 # Statistics for www-a only
6105 Host "www-a.example.com"
6106 Server "www.example.com"
6108 # Statistics for www-b only
6110 Host "www-b.example.com"
6111 Server "www.example.com"
6115 The plugin provides the following configuration options:
6119 =item B<Address> I<Node>
6121 Configures the address used to open a listening socket. By default, plugin will
6122 bind to the I<any> address C<::0>.
6124 =item B<Port> I<Service>
6126 Configures the port (service) to bind to. By default the default Pinba port
6127 "30002" will be used. The option accepts service names in addition to port
6128 numbers and thus requires a I<string> argument.
6130 =item E<lt>B<View> I<Name>E<gt> block
6132 The packets sent by the Pinba extension include the hostname of the server, the
6133 server name (the name of the virtual host) and the script that was executed.
6134 Using B<View> blocks it is possible to separate the data into multiple groups
6135 to get more meaningful statistics. Each packet is added to all matching groups,
6136 so that a packet may be accounted for more than once.
6140 =item B<Host> I<Host>
6142 Matches the hostname of the system the webserver / script is running on. This
6143 will contain the result of the L<gethostname(2)> system call. If not
6144 configured, all hostnames will be accepted.
6146 =item B<Server> I<Server>
6148 Matches the name of the I<virtual host>, i.e. the contents of the
6149 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6150 server names will be accepted.
6152 =item B<Script> I<Script>
6154 Matches the name of the I<script name>, i.e. the contents of the
6155 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6156 script names will be accepted.
6162 =head2 Plugin C<ping>
6164 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6165 configured hosts periodically and measures the network latency. Whenever the
6166 C<read> function of the plugin is called, it submits the average latency, the
6167 standard deviation and the drop rate for each host.
6169 Available configuration options:
6173 =item B<Host> I<IP-address>
6175 Host to ping periodically. This option may be repeated several times to ping
6178 =item B<Interval> I<Seconds>
6180 Sets the interval in which to send ICMP echo packets to the configured hosts.
6181 This is B<not> the interval in which metrics are read from the plugin but the
6182 interval in which the hosts are "pinged". Therefore, the setting here should be
6183 smaller than or equal to the global B<Interval> setting. Fractional times, such
6184 as "1.24" are allowed.
6188 =item B<Timeout> I<Seconds>
6190 Time to wait for a response from the host to which an ICMP packet had been
6191 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6192 to be down or the packet to be dropped. This setting must be smaller than the
6193 B<Interval> setting above for the plugin to work correctly. Fractional
6194 arguments are accepted.
6198 =item B<TTL> I<0-255>
6200 Sets the Time-To-Live of generated ICMP packets.
6202 =item B<Size> I<size>
6204 Sets the size of the data payload in ICMP packet to specified I<size> (it
6205 will be filled with regular ASCII pattern). If not set, default 56 byte
6206 long string is used so that the packet size of an ICMPv4 packet is exactly
6207 64 bytes, similar to the behaviour of normal ping(1) command.
6209 =item B<SourceAddress> I<host>
6211 Sets the source address to use. I<host> may either be a numerical network
6212 address or a network hostname.
6214 =item B<Device> I<name>
6216 Sets the outgoing network device to be used. I<name> has to specify an
6217 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6220 =item B<MaxMissed> I<Packets>
6222 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6223 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6225 Default: B<-1> (disabled)
6229 =head2 Plugin C<postgresql>
6231 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6232 keeps a persistent connection to all configured databases and tries to
6233 reconnect if the connection has been interrupted. A database is configured by
6234 specifying a B<Database> block as described below. The default statistics are
6235 collected from PostgreSQL's B<statistics collector> which thus has to be
6236 enabled for this plugin to work correctly. This should usually be the case by
6237 default. See the section "The Statistics Collector" of the B<PostgreSQL
6238 Documentation> for details.
6240 By specifying custom database queries using a B<Query> block as described
6241 below, you may collect any data that is available from some PostgreSQL
6242 database. This way, you are able to access statistics of external daemons
6243 which are available in a PostgreSQL database or use future or special
6244 statistics provided by PostgreSQL without the need to upgrade your collectd
6247 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6248 PostgreSQL databases as well. This has been implemented in a generic way. You
6249 need to specify an SQL statement which will then be executed by collectd in
6250 order to write the data (see below for details). The benefit of that approach
6251 is that there is no fixed database layout. Rather, the layout may be optimized
6252 for the current setup.
6254 The B<PostgreSQL Documentation> manual can be found at
6255 L<http://www.postgresql.org/docs/manuals/>.
6259 Statement "SELECT magic FROM wizard WHERE host = $1;"
6263 InstancePrefix "magic"
6268 <Query rt36_tickets>
6269 Statement "SELECT COUNT(type) AS count, type \
6271 WHEN resolved = 'epoch' THEN 'open' \
6272 ELSE 'resolved' END AS type \
6273 FROM tickets) type \
6277 InstancePrefix "rt36_tickets"
6278 InstancesFrom "type"
6284 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6295 KRBSrvName "kerberos_service_name"
6301 Service "service_name"
6302 Query backends # predefined
6313 The B<Query> block defines one database query which may later be used by a
6314 database definition. It accepts a single mandatory argument which specifies
6315 the name of the query. The names of all queries have to be unique (see the
6316 B<MinVersion> and B<MaxVersion> options below for an exception to this
6319 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6320 B<Result> blocks may be used to extract multiple values from a single query.
6322 The following configuration options are available to define the query:
6326 =item B<Statement> I<sql query statement>
6328 Specify the I<sql query statement> which the plugin should execute. The string
6329 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6330 first, second, etc. parameter. The value of the parameters is specified by the
6331 B<Param> configuration option - see below for details. To include a literal
6332 B<$> character followed by a number, surround it with single quotes (B<'>).
6334 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6335 allowed. Note, however, that only a single command may be used. Semicolons are
6336 allowed as long as a single non-empty command has been specified only.
6338 The returned lines will be handled separately one after another.
6340 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6342 Specify the parameters which should be passed to the SQL query. The parameters
6343 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6344 they appear in the configuration file. The value of the parameter is
6345 determined depending on the value of the B<Param> option as follows:
6351 The configured hostname of the database connection. If a UNIX domain socket is
6352 used, the parameter expands to "localhost".
6356 The name of the database of the current connection.
6360 The name of the database plugin instance. See the B<Instance> option of the
6361 database specification below for details.
6365 The username used to connect to the database.
6369 The interval with which this database is queried (as specified by the database
6370 specific or global B<Interval> options).
6374 Please note that parameters are only supported by PostgreSQL's protocol
6375 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6377 =item B<PluginInstanceFrom> I<column>
6379 Specify how to create the "PluginInstance" for reporting this query results.
6380 Only one column is supported. You may concatenate fields and string values in
6381 the query statement to get the required results.
6383 =item B<MinVersion> I<version>
6385 =item B<MaxVersion> I<version>
6387 Specify the minimum or maximum version of PostgreSQL that this query should be
6388 used with. Some statistics might only be available with certain versions of
6389 PostgreSQL. This allows you to specify multiple queries with the same name but
6390 which apply to different versions, thus allowing you to use the same
6391 configuration in a heterogeneous environment.
6393 The I<version> has to be specified as the concatenation of the major, minor
6394 and patch-level versions, each represented as two-decimal-digit numbers. For
6395 example, version 8.2.3 will become 80203.
6399 The B<Result> block defines how to handle the values returned from the query.
6400 It defines which column holds which value and how to dispatch that value to
6405 =item B<Type> I<type>
6407 The I<type> name to be used when dispatching the values. The type describes
6408 how to handle the data and where to store it. See L<types.db(5)> for more
6409 details on types and their configuration. The number and type of values (as
6410 selected by the B<ValuesFrom> option) has to match the type of the given name.
6412 This option is mandatory.
6414 =item B<InstancePrefix> I<prefix>
6416 =item B<InstancesFrom> I<column0> [I<column1> ...]
6418 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6419 B<InstancePrefix> defines a static prefix that will be prepended to all type
6420 instances. B<InstancesFrom> defines the column names whose values will be used
6421 to create the type instance. Multiple values will be joined together using the
6422 hyphen (C<->) as separation character.
6424 The plugin itself does not check whether or not all built instances are
6425 different. It is your responsibility to assure that each is unique.
6427 Both options are optional. If none is specified, the type instance will be
6430 =item B<ValuesFrom> I<column0> [I<column1> ...]
6432 Names the columns whose content is used as the actual data for the data sets
6433 that are dispatched to the daemon. How many such columns you need is
6434 determined by the B<Type> setting as explained above. If you specify too many
6435 or not enough columns, the plugin will complain about that and no data will be
6436 submitted to the daemon.
6438 The actual data type, as seen by PostgreSQL, is not that important as long as
6439 it represents numbers. The plugin will automatically cast the values to the
6440 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6441 L<strtod(3)> functions, so anything supported by those functions is supported
6442 by the plugin as well.
6444 This option is required inside a B<Result> block and may be specified multiple
6445 times. If multiple B<ValuesFrom> options are specified, the columns are read
6450 The following predefined queries are available (the definitions can be found
6451 in the F<postgresql_default.conf> file which, by default, is available at
6452 C<I<prefix>/share/collectd/>):
6458 This query collects the number of backends, i.E<nbsp>e. the number of
6461 =item B<transactions>
6463 This query collects the numbers of committed and rolled-back transactions of
6468 This query collects the numbers of various table modifications (i.E<nbsp>e.
6469 insertions, updates, deletions) of the user tables.
6471 =item B<query_plans>
6473 This query collects the numbers of various table scans and returned tuples of
6476 =item B<table_states>
6478 This query collects the numbers of live and dead rows in the user tables.
6482 This query collects disk block access counts for user tables.
6486 This query collects the on-disk size of the database in bytes.
6490 In addition, the following detailed queries are available by default. Please
6491 note that each of those queries collects information B<by table>, thus,
6492 potentially producing B<a lot> of data. For details see the description of the
6493 non-by_table queries above.
6497 =item B<queries_by_table>
6499 =item B<query_plans_by_table>
6501 =item B<table_states_by_table>
6503 =item B<disk_io_by_table>
6507 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6508 mandatory argument specifying the name of the writer. This will then be used
6509 in the B<Database> specification in order to activate the writer instance. The
6510 names of all writers have to be unique. The following options may be
6515 =item B<Statement> I<sql statement>
6517 This mandatory option specifies the SQL statement that will be executed for
6518 each submitted value. A single SQL statement is allowed only. Anything after
6519 the first semicolon will be ignored.
6521 Nine parameters will be passed to the statement and should be specified as
6522 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6523 values are made available through those parameters:
6529 The timestamp of the queried value as an RFC 3339-formatted local time.
6533 The hostname of the queried value.
6537 The plugin name of the queried value.
6541 The plugin instance of the queried value. This value may be B<NULL> if there
6542 is no plugin instance.
6546 The type of the queried value (cf. L<types.db(5)>).
6550 The type instance of the queried value. This value may be B<NULL> if there is
6555 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6556 sources of the submitted value-list).
6560 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6561 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6562 B<StoreRates> is enabled (which is the default, see below), all types will be
6567 An array of the submitted values. The dimensions of the value name and value
6572 In general, it is advisable to create and call a custom function in the
6573 PostgreSQL database for this purpose. Any procedural language supported by
6574 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6577 =item B<StoreRates> B<false>|B<true>
6579 If set to B<true> (the default), convert counter values to rates. If set to
6580 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6585 The B<Database> block defines one PostgreSQL database for which to collect
6586 statistics. It accepts a single mandatory argument which specifies the
6587 database name. None of the other options are required. PostgreSQL will use
6588 default values as documented in the section "CONNECTING TO A DATABASE" in the
6589 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6590 the user collectd is run as and special environment variables. See the manpage
6595 =item B<Interval> I<seconds>
6597 Specify the interval with which the database should be queried. The default is
6598 to use the global B<Interval> setting.
6600 =item B<CommitInterval> I<seconds>
6602 This option may be used for database connections which have "writers" assigned
6603 (see above). If specified, it causes a writer to put several updates into a
6604 single transaction. This transaction will last for the specified amount of
6605 time. By default, each update will be executed in a separate transaction. Each
6606 transaction generates a fair amount of overhead which can, thus, be reduced by
6607 activating this option. The draw-back is, that data covering the specified
6608 amount of time will be lost, for example, if a single statement within the
6609 transaction fails or if the database server crashes.
6611 =item B<Plugin> I<Plugin>
6613 Use I<Plugin> as the plugin name when submitting query results from
6614 this B<Database>. Defaults to C<postgresql>.
6616 =item B<Instance> I<name>
6618 Specify the plugin instance name that should be used instead of the database
6619 name (which is the default, if this option has not been specified). This
6620 allows one to query multiple databases of the same name on the same host (e.g.
6621 when running multiple database server versions in parallel).
6622 The plugin instance name can also be set from the query result using
6623 the B<PluginInstanceFrom> option in B<Query> block.
6625 =item B<Host> I<hostname>
6627 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6628 value begins with a slash, it is interpreted as the directory name in which to
6629 look for the UNIX domain socket.
6631 This option is also used to determine the hostname that is associated with a
6632 collected data set. If it has been omitted or either begins with with a slash
6633 or equals B<localhost> it will be replaced with the global hostname definition
6634 of collectd. Any other value will be passed literally to collectd when
6635 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6637 =item B<Port> I<port>
6639 Specify the TCP port or the local UNIX domain socket file extension of the
6642 =item B<User> I<username>
6644 Specify the username to be used when connecting to the server.
6646 =item B<Password> I<password>
6648 Specify the password to be used when connecting to the server.
6650 =item B<ExpireDelay> I<delay>
6652 Skip expired values in query output.
6654 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6656 Specify whether to use an SSL connection when contacting the server. The
6657 following modes are supported:
6663 Do not use SSL at all.
6667 First, try to connect without using SSL. If that fails, try using SSL.
6669 =item I<prefer> (default)
6671 First, try to connect using SSL. If that fails, try without using SSL.
6679 =item B<Instance> I<name>
6681 Specify the plugin instance name that should be used instead of the database
6682 name (which is the default, if this option has not been specified). This
6683 allows one to query multiple databases of the same name on the same host (e.g.
6684 when running multiple database server versions in parallel).
6686 =item B<KRBSrvName> I<kerberos_service_name>
6688 Specify the Kerberos service name to use when authenticating with Kerberos 5
6689 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6690 B<PostgreSQL Documentation> for details.
6692 =item B<Service> I<service_name>
6694 Specify the PostgreSQL service name to use for additional parameters. That
6695 service has to be defined in F<pg_service.conf> and holds additional
6696 connection parameters. See the section "The Connection Service File" in the
6697 B<PostgreSQL Documentation> for details.
6699 =item B<Query> I<query>
6701 Specifies a I<query> which should be executed in the context of the database
6702 connection. This may be any of the predefined or user-defined queries. If no
6703 such option is given, it defaults to "backends", "transactions", "queries",
6704 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6705 has been specified). Else, the specified queries are used only.
6707 =item B<Writer> I<writer>
6709 Assigns the specified I<writer> backend to the database connection. This
6710 causes all collected data to be send to the database using the settings
6711 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6712 below for details on how to selectively send data to certain plugins).
6714 Each writer will register a flush callback which may be used when having long
6715 transactions enabled (see the B<CommitInterval> option above). When issuing
6716 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6717 transaction will be committed right away. Two different kinds of flush
6718 callbacks are available with the C<postgresql> plugin:
6724 Flush all writer backends.
6726 =item B<postgresql->I<database>
6728 Flush all writers of the specified I<database> only.
6734 =head2 Plugin C<powerdns>
6736 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6737 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6738 values, many of which are probably meaningless to most users, but may be useful
6739 for some. So you may chose which values to collect, but if you don't, some
6740 reasonable defaults will be collected.
6743 <Server "server_name">
6745 Collect "udp-answers" "udp-queries"
6746 Socket "/var/run/pdns.controlsocket"
6748 <Recursor "recursor_name">
6750 Collect "cache-hits" "cache-misses"
6751 Socket "/var/run/pdns_recursor.controlsocket"
6753 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6758 =item B<Server> and B<Recursor> block
6760 The B<Server> block defines one authoritative server to query, the B<Recursor>
6761 does the same for an recursing server. The possible options in both blocks are
6762 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6767 =item B<Collect> I<Field>
6769 Using the B<Collect> statement you can select which values to collect. Here,
6770 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6771 C<dlg-only-drops>, C<answers10-100>.
6773 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6774 When querying the server a C<SHOW *> command is issued in any case, because
6775 that's the only way of getting multiple values out of the server at once.
6776 collectd then picks out the values you have selected. When querying the
6777 recursor, a command is generated to query exactly these values. So if you
6778 specify invalid fields when querying the recursor, a syntax error may be
6779 returned by the daemon and collectd may not collect any values at all.
6781 If no B<Collect> statement is given, the following B<Server> values will be
6788 =item packetcache-hit
6790 =item packetcache-miss
6792 =item packetcache-size
6794 =item query-cache-hit
6796 =item query-cache-miss
6798 =item recursing-answers
6800 =item recursing-questions
6812 The following B<Recursor> values will be collected by default:
6816 =item noerror-answers
6818 =item nxdomain-answers
6820 =item servfail-answers
6838 Please note that up to that point collectd doesn't know what values are
6839 available on the server and values that are added do not need a change of the
6840 mechanism so far. However, the values must be mapped to collectd's naming
6841 scheme, which is done using a lookup table that lists all known values. If
6842 values are added in the future and collectd does not know about them, you will
6843 get an error much like this:
6845 powerdns plugin: submit: Not found in lookup table: foobar = 42
6847 In this case please file a bug report with the collectd team.
6849 =item B<Socket> I<Path>
6851 Configures the path to the UNIX domain socket to be used when connecting to the
6852 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6853 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6854 will be used for the recursor.
6858 =item B<LocalSocket> I<Path>
6860 Querying the recursor is done using UDP. When using UDP over UNIX domain
6861 sockets, the client socket needs a name in the file system, too. You can set
6862 this local name to I<Path> using the B<LocalSocket> option. The default is
6863 C<I<prefix>/var/run/collectd-powerdns>.
6867 =head2 Plugin C<processes>
6869 Collects information about processes of local system.
6871 By default, with no process matches configured, only general statistics is
6872 collected: the number of processes in each state and fork rate.
6874 Process matches can be configured by B<Process> and B<ProcessMatch> options.
6875 These may also be a block in which further options may be specified.
6877 The statistics collected for matched processes are:
6878 - size of the resident segment size (RSS)
6879 - user- and system-time used
6880 - number of processes
6882 - number of open files (under Linux)
6883 - number of memory mapped files (under Linux)
6884 - io data (where available)
6885 - context switches (under Linux)
6886 - minor and major pagefaults
6887 - Delay Accounting information (Linux only, requires libmnl)
6892 CollectFileDescriptor true
6893 CollectContextSwitch true
6894 CollectDelayAccounting false
6896 ProcessMatch "name" "regex"
6897 <Process "collectd">
6898 CollectFileDescriptor false
6899 CollectContextSwitch false
6900 CollectDelayAccounting true
6902 <ProcessMatch "name" "regex">
6903 CollectFileDescriptor false
6904 CollectContextSwitch true
6910 =item B<Process> I<Name>
6912 Select more detailed statistics of processes matching this name.
6914 Some platforms have a limit on the length of process names.
6915 I<Name> must stay below this limit.
6917 =item B<ProcessMatch> I<name> I<regex>
6919 Select more detailed statistics of processes matching the specified I<regex>
6920 (see L<regex(7)> for details). The statistics of all matching processes are
6921 summed up and dispatched to the daemon using the specified I<name> as an
6922 identifier. This allows one to "group" several processes together.
6923 I<name> must not contain slashes.
6925 =item B<CollectContextSwitch> I<Boolean>
6927 Collect the number of context switches for matched processes.
6928 Disabled by default.
6930 =item B<CollectDelayAccounting> I<Boolean>
6932 If enabled, collect Linux Delay Accounding information for matching processes.
6933 Delay Accounting provides the time processes wait for the CPU to become
6934 available, for I/O operations to finish, for pages to be swapped in and for
6935 freed pages to be reclaimed. The metrics are reported as "seconds per second"
6936 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
6937 Disabled by default.
6939 This option is only available on Linux, requires the C<libmnl> library and
6940 requires the C<CAP_NET_ADMIN> capability at runtime.
6942 =item B<CollectFileDescriptor> I<Boolean>
6944 Collect number of file descriptors of matched processes.
6945 Disabled by default.
6947 =item B<CollectMemoryMaps> I<Boolean>
6949 Collect the number of memory mapped files of the process.
6950 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
6955 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
6956 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
6957 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
6958 reporting the corresponding processes only. Outside of B<Process> and
6959 B<ProcessMatch> blocks these options set the default value for subsequent
6962 =head2 Plugin C<protocols>
6964 Collects a lot of information about various network protocols, such as I<IP>,
6965 I<TCP>, I<UDP>, etc.
6967 Available configuration options:
6971 =item B<Value> I<Selector>
6973 Selects whether or not to select a specific value. The string being matched is
6974 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6975 plugin instance and I<ValueName> will be used as type instance. An example of
6976 the string being used would be C<Tcp:RetransSegs>.
6978 You can use regular expressions to match a large number of values with just one
6979 configuration option. To select all "extended" I<TCP> values, you could use the
6980 following statement:
6984 Whether only matched values are selected or all matched values are ignored
6985 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6986 If no value is configured at all, all values will be selected.
6988 See F</"IGNORELISTS"> for details.
6990 =item B<IgnoreSelected> B<true>|B<false>
6992 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6993 matching values will be ignored.
6997 =head2 Plugin C<python>
6999 This plugin embeds a Python-interpreter into collectd and provides an interface
7000 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7002 =head2 Plugin C<routeros>
7004 The C<routeros> plugin connects to a device running I<RouterOS>, the
7005 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7006 I<librouteros> to connect and reads information about the interfaces and
7007 wireless connections of the device. The configuration supports querying
7012 Host "router0.example.com"
7015 CollectInterface true
7020 Host "router1.example.com"
7023 CollectInterface true
7024 CollectRegistrationTable true
7030 As you can see above, the configuration of the I<routeros> plugin consists of
7031 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7032 options are understood:
7036 =item B<Host> I<Host>
7038 Hostname or IP-address of the router to connect to.
7040 =item B<Port> I<Port>
7042 Port name or port number used when connecting. If left unspecified, the default
7043 will be chosen by I<librouteros>, currently "8728". This option expects a
7044 string argument, even when a numeric port number is given.
7046 =item B<User> I<User>
7048 Use the user name I<User> to authenticate. Defaults to "admin".
7050 =item B<Password> I<Password>
7052 Set the password used to authenticate.
7054 =item B<CollectInterface> B<true>|B<false>
7056 When set to B<true>, interface statistics will be collected for all interfaces
7057 present on the device. Defaults to B<false>.
7059 =item B<CollectRegistrationTable> B<true>|B<false>
7061 When set to B<true>, information about wireless LAN connections will be
7062 collected. Defaults to B<false>.
7064 =item B<CollectCPULoad> B<true>|B<false>
7066 When set to B<true>, information about the CPU usage will be collected. The
7067 number is a dimensionless value where zero indicates no CPU usage at all.
7068 Defaults to B<false>.
7070 =item B<CollectMemory> B<true>|B<false>
7072 When enabled, the amount of used and free memory will be collected. How used
7073 memory is calculated is unknown, for example whether or not caches are counted
7075 Defaults to B<false>.
7077 =item B<CollectDF> B<true>|B<false>
7079 When enabled, the amount of used and free disk space will be collected.
7080 Defaults to B<false>.
7082 =item B<CollectDisk> B<true>|B<false>
7084 When enabled, the number of sectors written and bad blocks will be collected.
7085 Defaults to B<false>.
7089 =head2 Plugin C<redis>
7091 The I<Redis plugin> connects to one or more Redis servers and gathers
7092 information about each server's state. For each server there is a I<Node> block
7093 which configures the connection parameters for this node.
7100 <Query "LLEN myqueue">
7107 The information shown in the synopsis above is the I<default configuration>
7108 which is used by the plugin if no configuration is present.
7112 =item B<Node> I<Nodename>
7114 The B<Node> block identifies a new Redis node, that is a new Redis instance
7115 running in an specified host and port. The name for node is a canonical
7116 identifier which is used as I<plugin instance>. It is limited to
7117 64E<nbsp>characters in length.
7119 =item B<Host> I<Hostname>
7121 The B<Host> option is the hostname or IP-address where the Redis instance is
7124 =item B<Port> I<Port>
7126 The B<Port> option is the TCP port on which the Redis instance accepts
7127 connections. Either a service name of a port number may be given. Please note
7128 that numerical port numbers must be given as a string, too.
7130 =item B<Password> I<Password>
7132 Use I<Password> to authenticate when connecting to I<Redis>.
7134 =item B<Timeout> I<Milliseconds>
7136 The B<Timeout> option set the socket timeout for node response. Since the Redis
7137 read function is blocking, you should keep this value as low as possible. Keep
7138 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
7139 than B<Interval> defined globally.
7141 =item B<Query> I<Querystring>
7143 The B<Query> block identifies a query to execute against the redis server.
7144 There may be an arbitrary number of queries to execute.
7146 =item B<Type> I<Collectd type>
7148 Within a query definition, a valid collectd type to use as when submitting
7149 the result of the query. When not supplied, will default to B<gauge>.
7151 =item B<Instance> I<Type instance>
7153 Within a query definition, an optional type instance to use when submitting
7154 the result of the query. When not supplied will default to the escaped
7155 command, up to 64 chars.
7159 =head2 Plugin C<rrdcached>
7161 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7162 to store values to RRD files in an efficient manner. The combination of the
7163 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7164 way the C<rrdtool> plugin works (see below). The added abstraction layer
7165 provides a number of benefits, though: Because the cache is not within
7166 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7167 restarted. This results in much shorter (if any) gaps in graphs, especially
7168 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7169 daemon so that it can flush values to disk automatically when needed. This
7170 allows one to integrate automated flushing of values into graphing solutions
7173 There are disadvantages, though: The daemon may reside on a different host, so
7174 it may not be possible for C<collectd> to create the appropriate RRD files
7175 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7176 different base directory, so relative paths may do weird stuff if you're not
7179 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7180 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7181 setting should be set to an absolute path, so that a changed base directory
7182 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7186 =item B<DaemonAddress> I<Address>
7188 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7189 library. See L<rrdcached(1)> for details. Example:
7191 <Plugin "rrdcached">
7192 DaemonAddress "unix:/var/run/rrdcached.sock"
7195 =item B<DataDir> I<Directory>
7197 Set the base directory in which the RRD files reside. If this is a relative
7198 path, it is relative to the working base directory of the C<rrdcached> daemon!
7199 Use of an absolute path is recommended.
7201 =item B<CreateFiles> B<true>|B<false>
7203 Enables or disables the creation of RRD files. If the daemon is not running
7204 locally, or B<DataDir> is set to a relative path, this will not work as
7205 expected. Default is B<true>.
7207 =item B<CreateFilesAsync> B<false>|B<true>
7209 When enabled, new RRD files are enabled asynchronously, using a separate thread
7210 that runs in the background. This prevents writes to block, which is a problem
7211 especially when many hundreds of files need to be created at once. However,
7212 since the purpose of creating the files asynchronously is I<not> to block until
7213 the file is available, values before the file is available will be discarded.
7214 When disabled (the default) files are created synchronously, blocking for a
7215 short while, while the file is being written.
7217 =item B<StepSize> I<Seconds>
7219 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7220 this setting is unset and the stepsize is set to the interval in which the data
7221 is collected. Do not use this option unless you absolutely have to for some
7222 reason. Setting this option may cause problems with the C<snmp plugin>, the
7223 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7225 =item B<HeartBeat> I<Seconds>
7227 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7228 in which case the heartbeat is set to twice the B<StepSize> which should equal
7229 the interval in which data is collected. Do not set this option unless you have
7230 a very good reason to do so.
7232 =item B<RRARows> I<NumRows>
7234 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7235 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7236 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7237 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7238 week, one month, and one year.
7240 So for each timespan, it calculates how many PDPs need to be consolidated into
7241 one CDP by calculating:
7242 number of PDPs = timespan / (stepsize * rrarows)
7244 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7247 =item B<RRATimespan> I<Seconds>
7249 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7250 more then one RRA. If this option is never used, the built-in default of (3600,
7251 86400, 604800, 2678400, 31622400) is used.
7253 For more information on how RRA-sizes are calculated see B<RRARows> above.
7255 =item B<XFF> I<Factor>
7257 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7258 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7261 =item B<CollectStatistics> B<false>|B<true>
7263 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7264 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7266 Statistics are read via I<rrdcached>s socket using the STATS command.
7267 See L<rrdcached(1)> for details.
7271 =head2 Plugin C<rrdtool>
7273 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7274 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7275 using these settings. If you don't want to dive into the depths of RRDtool, you
7276 can safely ignore these settings.
7280 =item B<DataDir> I<Directory>
7282 Set the directory to store RRD files under. By default RRD files are generated
7283 beneath the daemon's working directory, i.e. the B<BaseDir>.
7285 =item B<CreateFilesAsync> B<false>|B<true>
7287 When enabled, new RRD files are enabled asynchronously, using a separate thread
7288 that runs in the background. This prevents writes to block, which is a problem
7289 especially when many hundreds of files need to be created at once. However,
7290 since the purpose of creating the files asynchronously is I<not> to block until
7291 the file is available, values before the file is available will be discarded.
7292 When disabled (the default) files are created synchronously, blocking for a
7293 short while, while the file is being written.
7295 =item B<StepSize> I<Seconds>
7297 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7298 this setting is unset and the stepsize is set to the interval in which the data
7299 is collected. Do not use this option unless you absolutely have to for some
7300 reason. Setting this option may cause problems with the C<snmp plugin>, the
7301 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7303 =item B<HeartBeat> I<Seconds>
7305 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7306 in which case the heartbeat is set to twice the B<StepSize> which should equal
7307 the interval in which data is collected. Do not set this option unless you have
7308 a very good reason to do so.
7310 =item B<RRARows> I<NumRows>
7312 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7313 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7314 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7315 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7316 week, one month, and one year.
7318 So for each timespan, it calculates how many PDPs need to be consolidated into
7319 one CDP by calculating:
7320 number of PDPs = timespan / (stepsize * rrarows)
7322 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7325 =item B<RRATimespan> I<Seconds>
7327 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7328 more then one RRA. If this option is never used, the built-in default of (3600,
7329 86400, 604800, 2678400, 31622400) is used.
7331 For more information on how RRA-sizes are calculated see B<RRARows> above.
7333 =item B<XFF> I<Factor>
7335 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7336 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7339 =item B<CacheFlush> I<Seconds>
7341 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7342 it writes all values for a certain RRD-file if the oldest value is older than
7343 (or equal to) the number of seconds specified by B<CacheTimeout>.
7344 That check happens on new values arriwal. If some RRD-file is not updated
7345 anymore for some reason (the computer was shut down, the network is broken,
7346 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7347 every I<Seconds> seconds the entire cache is searched for entries older than
7348 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7349 disk. Since scanning the entire cache is kind of expensive and does nothing
7350 under normal circumstances, this value should not be too small. 900 seconds
7351 might be a good value, though setting this to 7200 seconds doesn't normally
7352 do much harm either.
7354 Defaults to 10x B<CacheTimeout>.
7355 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7356 above default is used.
7358 =item B<CacheTimeout> I<Seconds>
7360 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7361 save values in a cache, as described above. Writing multiple values at once
7362 reduces IO-operations and thus lessens the load produced by updating the files.
7363 The trade off is that the graphs kind of "drag behind" and that more memory is
7366 =item B<WritesPerSecond> I<Updates>
7368 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7369 will run serious performance problems. The B<CacheFlush> setting and the
7370 internal update queue assert that collectd continues to work just fine even
7371 under heavy load, but the system may become very unresponsive and slow. This is
7372 a problem especially if you create graphs from the RRD files on the same
7373 machine, for example using the C<graph.cgi> script included in the
7374 C<contrib/collection3/> directory.
7376 This setting is designed for very large setups. Setting this option to a value
7377 between 25 and 80 updates per second, depending on your hardware, will leave
7378 the server responsive enough to draw graphs even while all the cached values
7379 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7380 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7381 written as fast as possible, so that web frontends have up to date data when
7384 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7385 updates per second, writing all values to disk will take approximately
7386 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7387 "collection3" you'll end up with a responsive and fast system, up to date
7388 graphs and basically a "backup" of your values every hour.
7390 =item B<RandomTimeout> I<Seconds>
7392 When set, the actual timeout for each value is chosen randomly between
7393 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7394 intention is to avoid high load situations that appear when many values timeout
7395 at the same time. This is especially a problem shortly after the daemon starts,
7396 because all values were added to the internal cache at roughly the same time.
7400 =head2 Plugin C<sensors>
7402 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7403 that all the needed modules have to be loaded and lm_sensors has to be
7404 configured (most likely by editing F</etc/sensors.conf>. Read
7405 L<sensors.conf(5)> for details.
7407 The B<lm_sensors> homepage can be found at
7408 L<http://secure.netroedge.com/~lm78/>.
7412 =item B<SensorConfigFile> I<File>
7414 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7415 the library's default will be used.
7417 =item B<Sensor> I<chip-bus-address/type-feature>
7419 Selects the name of the sensor which you want to collect or ignore, depending
7420 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7421 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7422 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7424 See F</"IGNORELISTS"> for details.
7426 =item B<IgnoreSelected> I<true>|I<false>
7428 If no configuration if given, the B<sensors>-plugin will collect data from all
7429 sensors. This may not be practical, especially for uninteresting sensors.
7430 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7431 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7432 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7433 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7434 and all other sensors are collected.
7436 =item B<UseLabels> I<true>|I<false>
7438 Configures how sensor readings are reported. When set to I<true>, sensor
7439 readings are reported using their descriptive label (e.g. "VCore"). When set to
7440 I<false> (the default) the sensor name is used ("in0").
7444 =head2 Plugin C<sigrok>
7446 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7447 supported by the L<sigrok|http://sigrok.org/> project.
7453 <Device "AC Voltage">
7458 <Device "Sound Level">
7459 Driver "cem-dt-885x"
7466 =item B<LogLevel> B<0-5>
7468 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7469 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7470 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7471 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7472 their level, are always submitted to I<collectd> at its INFO log level.
7474 =item E<lt>B<Device> I<Name>E<gt>
7476 A sigrok-supported device, uniquely identified by this section's options. The
7477 I<Name> is passed to I<collectd> as the I<plugin instance>.
7479 =item B<Driver> I<DriverName>
7481 The sigrok driver to use for this device.
7483 =item B<Conn> I<ConnectionSpec>
7485 If the device cannot be auto-discovered, or more than one might be discovered
7486 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7487 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7488 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7489 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7490 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7492 =item B<SerialComm> I<SerialSpec>
7494 For serial devices with non-standard port settings, this option can be used
7495 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7496 This should not be necessary; drivers know how to communicate with devices they
7499 =item B<MinimumInterval> I<Seconds>
7501 Specifies the minimum time between measurement dispatches to I<collectd>, in
7502 seconds. Since some I<sigrok> supported devices can acquire measurements many
7503 times per second, it may be necessary to throttle these. For example, the
7504 I<RRD plugin> cannot process writes more than once per second.
7506 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7507 device are always dispatched to I<collectd>. When throttled, unused
7508 measurements are discarded.
7512 =head2 Plugin C<smart>
7514 The C<smart> plugin collects SMART information from physical
7515 disks. Values collectd include temperature, power cycle count, poweron
7516 time and bad sectors. Also, all SMART attributes are collected along
7517 with the normalized current value, the worst value, the threshold and
7518 a human readable value.
7520 Using the following two options you can ignore some disks or configure the
7521 collection only of specific disks.
7525 =item B<Disk> I<Name>
7527 Select the disk I<Name>. Whether it is collected or ignored depends on the
7528 B<IgnoreSelected> setting, see below. As with other plugins that use the
7529 daemon's ignorelist functionality, a string that starts and ends with a slash
7530 is interpreted as a regular expression. Examples:
7535 See F</"IGNORELISTS"> for details.
7537 =item B<IgnoreSelected> B<true>|B<false>
7539 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7540 statements, are ignored or if all other disks are ignored. The behavior
7541 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7542 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7543 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7544 is set to B<true>, all disks are collected B<except> the ones matched.
7546 =item B<IgnoreSleepMode> B<true>|B<false>
7548 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7549 This option disables the sleep mode check and allows the plugin to collect data
7550 from these disks anyway. This is useful in cases where libatasmart mistakenly
7551 reports disks as asleep because it has not been updated to incorporate support
7552 for newer idle states in the ATA spec.
7554 =item B<UseSerial> B<true>|B<false>
7556 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7557 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7558 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7559 storing data. This ensures that the data for a given disk will be kept together
7560 even if the kernel name changes.
7564 =head2 Plugin C<snmp>
7566 Since the configuration of the C<snmp plugin> is a little more complicated than
7567 other plugins, its documentation has been moved to an own manpage,
7568 L<collectd-snmp(5)>. Please see there for details.
7570 =head2 Plugin C<snmp_agent>
7572 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7573 from SNMP master agent and returns the data collected by read plugins.
7574 The I<snmp_agent> plugin handles requests only for OIDs specified in
7575 configuration file. To handle SNMP queries the plugin gets data from collectd
7576 and translates requested values from collectd's internal format to SNMP format.
7577 This plugin is a generic plugin and cannot work without configuration.
7578 For more details on AgentX subagent see
7579 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7584 <Data "memAvailReal">
7586 #PluginInstance "some"
7589 OIDs "1.3.6.1.4.1.2021.4.6.0"
7592 IndexOID "IF-MIB::ifIndex"
7593 SizeOID "IF-MIB::ifNumber"
7597 OIDs "IF-MIB::ifDescr"
7603 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7608 There are two types of blocks that can be contained in the
7609 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7611 =head3 The B<Data> block
7613 The B<Data> block defines a list OIDs that are to be handled. This block can
7614 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7615 block it reperesents table OIDs.
7616 The following options can be set:
7620 =item B<Instance> I<true|false>
7622 When B<Instance> is set to B<true>, the value for requested OID is copied from
7623 plugin instance field of corresponding collectd value. If B<Data> block defines
7624 scalar data type B<Instance> has no effect and can be omitted.
7626 =item B<Plugin> I<String>
7628 Read plugin name whose collected data will be mapped to specified OIDs.
7630 =item B<PluginInstance> I<String>
7632 Read plugin instance whose collected data will be mapped to specified OIDs.
7633 The field is optional and by default there is no plugin instance check.
7634 Allowed only if B<Data> block defines scalar data type.
7636 =item B<Type> I<String>
7638 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7639 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7641 =item B<TypeInstance> I<String>
7643 Collectd's type-instance that is to be used for specified OID.
7645 =item B<OIDs> I<OID> [I<OID> ...]
7647 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7648 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7649 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7650 configured should correspond to number of values in specified B<Type>.
7651 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7652 "rx" and "tx" values of "if_octets" type.
7654 =item B<Scale> I<Value>
7656 The values taken from collectd are multiplied by I<Value>. The field is optional
7657 and the default is B<1.0>.
7659 =item B<Shift> I<Value>
7661 I<Value> is added to values from collectd after they have been multiplied by
7662 B<Scale> value. The field is optional and the default value is B<0.0>.
7666 =head3 The B<Table> block
7668 The B<Table> block defines a collection of B<Data> blocks that belong to one
7669 snmp table. In addition to multiple B<Data> blocks the following options can be
7674 =item B<IndexOID> I<OID>
7676 OID that is handled by the plugin and is mapped to numerical index value that is
7677 generated by the plugin for each table record.
7679 =item B<SizeOID> I<OID>
7681 OID that is handled by the plugin. Returned value is the number of records in
7682 the table. The field is optional.
7686 =head2 Plugin C<statsd>
7688 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7689 protocol and dispatches rates or other aggregates of these numbers
7692 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7693 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7694 C<objects> respectively.
7696 The following configuration options are valid:
7700 =item B<Host> I<Host>
7702 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7703 "any" address, i.e. accept packets sent to any of the hosts addresses.
7705 =item B<Port> I<Port>
7707 UDP port to listen to. This can be either a service name or a port number.
7708 Defaults to C<8125>.
7710 =item B<DeleteCounters> B<false>|B<true>
7712 =item B<DeleteTimers> B<false>|B<true>
7714 =item B<DeleteGauges> B<false>|B<true>
7716 =item B<DeleteSets> B<false>|B<true>
7718 These options control what happens if metrics are not updated in an interval.
7719 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7720 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7721 are unchanged. If set to B<True>, the such metrics are not dispatched and
7722 removed from the internal cache.
7724 =item B<CounterSum> B<false>|B<true>
7726 When enabled, creates a C<count> metric which reports the change since the last
7727 read. This option primarily exists for compatibility with the I<statsd>
7728 implementation by Etsy.
7730 =item B<TimerPercentile> I<Percent>
7732 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7733 that I<Percent> of all reported timers are smaller than or equal to the
7734 computed latency. This is useful for cutting off the long tail latency, as it's
7735 often done in I<Service Level Agreements> (SLAs).
7737 Different percentiles can be calculated by setting this option several times.
7738 If none are specified, no percentiles are calculated / dispatched.
7740 =item B<TimerLower> B<false>|B<true>
7742 =item B<TimerUpper> B<false>|B<true>
7744 =item B<TimerSum> B<false>|B<true>
7746 =item B<TimerCount> B<false>|B<true>
7748 Calculate and dispatch various values out of I<Timer> metrics received during
7749 an interval. If set to B<False>, the default, these values aren't calculated /
7752 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
7756 =head2 Plugin C<swap>
7758 The I<Swap plugin> collects information about used and available swap space. On
7759 I<Linux> and I<Solaris>, the following options are available:
7763 =item B<ReportByDevice> B<false>|B<true>
7765 Configures how to report physical swap devices. If set to B<false> (the
7766 default), the summary over all swap devices is reported only, i.e. the globally
7767 used and available space over all devices. If B<true> is configured, the used
7768 and available space of each device will be reported separately.
7770 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7771 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7773 =item B<ReportBytes> B<false>|B<true>
7775 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7776 I<swap I/O> is reported in pages. This option is available under Linux only.
7778 =item B<ValuesAbsolute> B<true>|B<false>
7780 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7781 available and used. Defaults to B<true>.
7783 =item B<ValuesPercentage> B<false>|B<true>
7785 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7786 available and free. Defaults to B<false>.
7788 This is useful for deploying I<collectd> in a heterogeneous environment, where
7789 swap sizes differ and you want to specify generic thresholds or similar.
7791 =item B<ReportIO> B<true>|B<false>
7793 Enables or disables reporting swap IO. Defaults to B<true>.
7795 This is useful for the cases when swap IO is not neccessary, is not available,
7800 =head2 Plugin C<syslog>
7804 =item B<LogLevel> B<debug|info|notice|warning|err>
7806 Sets the log-level. If, for example, set to B<notice>, then all events with
7807 severity B<notice>, B<warning>, or B<err> will be submitted to the
7810 Please note that B<debug> is only available if collectd has been compiled with
7813 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7815 Controls which notifications should be sent to syslog. The default behaviour is
7816 not to send any. Less severe notifications always imply logging more severe
7817 notifications: Setting this to B<OKAY> means all notifications will be sent to
7818 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7819 notifications but will dismiss B<OKAY> notifications. Setting this option to
7820 B<FAILURE> will only send failures to syslog.
7824 =head2 Plugin C<table>
7826 The C<table plugin> provides generic means to parse tabular data and dispatch
7827 user specified values. Values are selected based on column numbers. For
7828 example, this plugin may be used to get values from the Linux L<proc(5)>
7829 filesystem or CSV (comma separated values) files.
7832 <Table "/proc/slabinfo">
7838 InstancePrefix "active_objs"
7844 InstancePrefix "objperslab"
7851 The configuration consists of one or more B<Table> blocks, each of which
7852 configures one file to parse. Within each B<Table> block, there are one or
7853 more B<Result> blocks, which configure which data to select and how to
7856 The following options are available inside a B<Table> block:
7860 =item B<Plugin> I<Plugin>
7862 If specified, I<Plugin> is used as the plugin name when submitting values.
7863 Defaults to B<table>.
7865 =item B<Instance> I<instance>
7867 If specified, I<instance> is used as the plugin instance. If omitted, the
7868 filename of the table is used instead, with all special characters replaced
7869 with an underscore (C<_>).
7871 =item B<Separator> I<string>
7873 Any character of I<string> is interpreted as a delimiter between the different
7874 columns of the table. A sequence of two or more contiguous delimiters in the
7875 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7876 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7877 of a table - see its documentation for more details. This option is mandatory.
7879 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7880 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7881 required because of collectd's config parsing.
7885 The following options are available inside a B<Result> block:
7889 =item B<Type> I<type>
7891 Sets the type used to dispatch the values to the daemon. Detailed information
7892 about types and their configuration can be found in L<types.db(5)>. This
7893 option is mandatory.
7895 =item B<InstancePrefix> I<prefix>
7897 If specified, prepend I<prefix> to the type instance. If omitted, only the
7898 B<InstancesFrom> option is considered for the type instance.
7900 =item B<InstancesFrom> I<column0> [I<column1> ...]
7902 If specified, the content of the given columns (identified by the column
7903 number starting at zero) will be used to create the type instance for each
7904 row. Multiple values (and the instance prefix) will be joined together with
7905 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7906 option is considered for the type instance.
7908 The plugin itself does not check whether or not all built instances are
7909 different. It’s your responsibility to assure that each is unique. This is
7910 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7911 sure that the table only contains one row.
7913 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7916 =item B<ValuesFrom> I<column0> [I<column1> ...]
7918 Specifies the columns (identified by the column numbers starting at zero)
7919 whose content is used as the actual data for the data sets that are dispatched
7920 to the daemon. How many such columns you need is determined by the B<Type>
7921 setting above. If you specify too many or not enough columns, the plugin will
7922 complain about that and no data will be submitted to the daemon. The plugin
7923 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7924 respectively, so anything supported by those functions is supported by the
7925 plugin as well. This option is mandatory.
7929 =head2 Plugin C<tail>
7931 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7932 each line and dispatches found values. What is matched can be configured by the
7933 user using (extended) regular expressions, as described in L<regex(7)>.
7936 <File "/var/log/exim4/mainlog">
7941 Regex "S=([1-9][0-9]*)"
7947 Regex "\\<R=local_user\\>"
7948 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7951 Instance "local_user"
7954 Regex "l=([0-9]*\\.[0-9]*)"
7955 <DSType "Distribution">
7958 #BucketType "bucket"
7966 The config consists of one or more B<File> blocks, each of which configures one
7967 logfile to parse. Within each B<File> block, there are one or more B<Match>
7968 blocks, which configure a regular expression to search for.
7970 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
7971 the plugin name and instance respectively. So in the above example the plugin name
7972 C<mail-exim> would be used.
7974 These options are applied for all B<Match> blocks that B<follow> it, until the
7975 next B<Plugin> or B<Instance> option. This way you can extract several plugin
7976 instances from one logfile, handy when parsing syslog and the like.
7978 The B<Interval> option allows you to define the length of time between reads. If
7979 this is not set, the default Interval will be used.
7981 Each B<Match> block has the following options to describe how the match should
7986 =item B<Regex> I<regex>
7988 Sets the regular expression to use for matching against a line. The first
7989 subexpression has to match something that can be turned into a number by
7990 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7991 below. Because B<extended> regular expressions are used, you do not need to use
7992 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7993 collectd's config parsing you need to escape backslashes, though. So if you
7994 want to match literal parentheses you need to do the following:
7996 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7998 =item B<ExcludeRegex> I<regex>
8000 Sets an optional regular expression to use for excluding lines from the match.
8001 An example which excludes all connections from localhost from the match:
8003 ExcludeRegex "127\\.0\\.0\\.1"
8005 =item B<DSType> I<Type>
8007 Sets how the values are cumulated. I<Type> is one of:
8011 =item B<GaugeAverage>
8013 Calculate the average.
8017 Use the smallest number only.
8021 Use the greatest number only.
8025 Use the last number found.
8027 =item B<GaugePersist>
8029 Use the last number found. The number is not reset at the end of an interval.
8030 It is continously reported until another number is matched. This is intended
8031 for cases in which only state changes are reported, for example a thermometer
8032 that only reports the temperature when it changes.
8038 =item B<AbsoluteSet>
8040 The matched number is a counter. Simply I<sets> the internal counter to this
8041 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8049 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8050 matched number may be negative, which will effectively subtract from the
8059 Increase the internal counter by one. These B<DSType> are the only ones that do
8060 not use the matched subexpression, but simply count the number of matched
8061 lines. Thus, you may use a regular expression without submatch in this case.
8063 =item B<Distribution>
8065 Type to do calculations based on the distribution of values, primarily
8066 calculating percentiles. This is primarily geared towards latency, but can be
8067 used for other metrics as well. The range of values tracked with this setting
8068 must be in the range (0–2^34) and can be fractional. Please note that neither
8069 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8072 This option must be used together with the B<Percentile> and/or B<Bucket>
8077 <DSType "Distribution">
8085 =item B<Percentile> I<Percent>
8087 Calculate and dispatch the configured percentile, i.e. compute the value, so
8088 that I<Percent> of all matched values are smaller than or equal to the computed
8091 Metrics are reported with the I<type> B<Type> (the value of the above option)
8092 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8094 This option may be repeated to calculate more than one percentile.
8096 =item B<Bucket> I<lower_bound> I<upper_bound>
8098 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8099 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8100 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8101 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8102 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8105 To export the entire (0–inf) range without overlap, use the upper bound of the
8106 previous range as the lower bound of the following range. In other words, use
8107 the following schema:
8117 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8118 by default) and the I<type instance>
8119 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8121 This option may be repeated to calculate more than one rate.
8123 =item B<BucketType> I<Type>
8125 Sets the type used to dispatch B<Bucket> metrics.
8126 Optional, by default C<bucket> will be used.
8132 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8133 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8134 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8135 B<Derive*> types interpret the submatch as a signed integer using
8136 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8137 and it may be omitted in this case.
8139 =item B<Type> I<Type>
8141 Sets the type used to dispatch this value. Detailed information about types and
8142 their configuration can be found in L<types.db(5)>.
8144 =item B<Instance> I<TypeInstance>
8146 This optional setting sets the type instance to use.
8150 =head2 Plugin C<tail_csv>
8152 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8153 written by I<Snort>.
8158 <Metric "snort-dropped">
8163 <File "/var/log/snort/snort.stats">
8167 Collect "snort-dropped"
8171 The configuration consists of one or more B<Metric> blocks that define an index
8172 into the line of the CSV file and how this value is mapped to I<collectd's>
8173 internal representation. These are followed by one or more B<Instance> blocks
8174 which configure which file to read, in which interval and which metrics to
8179 =item E<lt>B<Metric> I<Name>E<gt>
8181 The B<Metric> block configures a new metric to be extracted from the statistics
8182 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8183 only used inside the B<Instance> blocks to refer to this block, so you can use
8184 one B<Metric> block for multiple CSV files.
8188 =item B<Type> I<Type>
8190 Configures which I<Type> to use when dispatching this metric. Types are defined
8191 in the L<types.db(5)> file, see the appropriate manual page for more
8192 information on specifying types. Only types with a single I<data source> are
8193 supported by the I<tail_csv plugin>. The information whether the value is an
8194 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8195 I<Type's> definition.
8197 =item B<Instance> I<TypeInstance>
8199 If set, I<TypeInstance> is used to populate the type instance field of the
8200 created value lists. Otherwise, no type instance is used.
8202 =item B<ValueFrom> I<Index>
8204 Configure to read the value from the field with the zero-based index I<Index>.
8205 If the value is parsed as signed integer, unsigned integer or double depends on
8206 the B<Type> setting, see above.
8210 =item E<lt>B<File> I<Path>E<gt>
8212 Each B<File> block represents one CSV file to read. There must be at least one
8213 I<File> block but there can be multiple if you have multiple CSV files.
8217 =item B<Plugin> I<Plugin>
8219 Use I<Plugin> as the plugin name when submitting values.
8220 Defaults to C<tail_csv>.
8222 =item B<Instance> I<PluginInstance>
8224 Sets the I<plugin instance> used when dispatching the values.
8226 =item B<Collect> I<Metric>
8228 Specifies which I<Metric> to collect. This option must be specified at least
8229 once, and you can use this option multiple times to specify more than one
8230 metric to be extracted from this statistic file.
8232 =item B<Interval> I<Seconds>
8234 Configures the interval in which to read values from this instance / file.
8235 Defaults to the plugin's default interval.
8237 =item B<TimeFrom> I<Index>
8239 Rather than using the local time when dispatching a value, read the timestamp
8240 from the field with the zero-based index I<Index>. The value is interpreted as
8241 seconds since epoch. The value is parsed as a double and may be factional.
8247 =head2 Plugin C<teamspeak2>
8249 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8250 polls interesting global and virtual server data. The plugin can query only one
8251 physical server but unlimited virtual servers. You can use the following
8252 options to configure it:
8256 =item B<Host> I<hostname/ip>
8258 The hostname or ip which identifies the physical server.
8261 =item B<Port> I<port>
8263 The query port of the physical server. This needs to be a string.
8266 =item B<Server> I<port>
8268 This option has to be added once for every virtual server the plugin should
8269 query. If you want to query the virtual server on port 8767 this is what the
8270 option would look like:
8274 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8275 use quotes around it! If no such statement is given only global information
8280 =head2 Plugin C<ted>
8282 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8283 measure power consumption. These devices are usually connected to a serial
8284 (RS232) or USB port. The plugin opens a configured device and tries to read the
8285 current energy readings. For more information on TED, visit
8286 L<http://www.theenergydetective.com/>.
8288 Available configuration options:
8292 =item B<Device> I<Path>
8294 Path to the device on which TED is connected. collectd will need read and write
8295 permissions on that file.
8297 Default: B</dev/ttyUSB0>
8299 =item B<Retries> I<Num>
8301 Apparently reading from TED is not that reliable. You can therefore configure a
8302 number of retries here. You only configure the I<retries> here, to if you
8303 specify zero, one reading will be performed (but no retries if that fails); if
8304 you specify three, a maximum of four readings are performed. Negative values
8311 =head2 Plugin C<tcpconns>
8313 The C<tcpconns plugin> counts the number of currently established TCP
8314 connections based on the local port and/or the remote port. Since there may be
8315 a lot of connections the default if to count all connections with a local port,
8316 for which a listening socket is opened. You can use the following options to
8317 fine-tune the ports you are interested in:
8321 =item B<ListeningPorts> I<true>|I<false>
8323 If this option is set to I<true>, statistics for all local ports for which a
8324 listening socket exists are collected. The default depends on B<LocalPort> and
8325 B<RemotePort> (see below): If no port at all is specifically selected, the
8326 default is to collect listening ports. If specific ports (no matter if local or
8327 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8328 the selected ports will be collected unless this option is set to I<true>
8331 =item B<LocalPort> I<Port>
8333 Count the connections to a specific local port. This can be used to see how
8334 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8335 You have to specify the port in numeric form, so for the mailserver example
8336 you'd need to set B<25>.
8338 =item B<RemotePort> I<Port>
8340 Count the connections to a specific remote port. This is useful to see how
8341 much a remote service is used. This is most useful if you want to know how many
8342 connections a local service has opened to remote services, e.E<nbsp>g. how many
8343 connections a mail server or news server has to other mail or news servers, or
8344 how many connections a web proxy holds to web servers. You have to give the
8345 port in numeric form.
8347 =item B<AllPortsSummary> I<true>|I<false>
8349 If this option is set to I<true> a summary of statistics from all connections
8350 are collected. This option defaults to I<false>.
8354 =head2 Plugin C<thermal>
8358 =item B<ForceUseProcfs> I<true>|I<false>
8360 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8361 C<sysfs> interface. If that is not available, the plugin falls back to the
8362 C<procfs> interface. By setting this option to I<true>, you can force the
8363 plugin to use the latter. This option defaults to I<false>.
8365 =item B<Device> I<Device>
8367 Selects the name of the thermal device that you want to collect or ignore,
8368 depending on the value of the B<IgnoreSelected> option. This option may be
8369 used multiple times to specify a list of devices.
8371 See F</"IGNORELISTS"> for details.
8373 =item B<IgnoreSelected> I<true>|I<false>
8375 Invert the selection: If set to true, all devices B<except> the ones that
8376 match the device names specified by the B<Device> option are collected. By
8377 default only selected devices are collected if a selection is made. If no
8378 selection is configured at all, B<all> devices are selected.
8382 =head2 Plugin C<threshold>
8384 The I<Threshold plugin> checks values collected or received by I<collectd>
8385 against a configurable I<threshold> and issues I<notifications> if values are
8388 Documentation for this plugin is available in the L<collectd-threshold(5)>
8391 =head2 Plugin C<tokyotyrant>
8393 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8394 couple metrics: number of records, and database size on disk.
8398 =item B<Host> I<Hostname/IP>
8400 The hostname or IP which identifies the server.
8401 Default: B<127.0.0.1>
8403 =item B<Port> I<Service/Port>
8405 The query port of the server. This needs to be a string, even if the port is
8406 given in its numeric form.
8411 =head2 Plugin C<turbostat>
8413 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8414 Intel processors by using I<Model Specific Registers>.
8418 =item B<CoreCstates> I<Bitmask(Integer)>
8420 Bit mask of the list of core C-states supported by the processor.
8421 This option should only be used if the automated detection fails.
8422 Default value extracted from the CPU model and family.
8424 Currently supported C-states (by this plugin): 3, 6, 7
8428 All states (3, 6 and 7):
8429 (1<<3) + (1<<6) + (1<<7) = 392
8431 =item B<PackageCstates> I<Bitmask(Integer)>
8433 Bit mask of the list of packages C-states supported by the processor. This
8434 option should only be used if the automated detection fails. Default value
8435 extracted from the CPU model and family.
8437 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8441 States 2, 3, 6 and 7:
8442 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8444 =item B<SystemManagementInterrupt> I<true>|I<false>
8446 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8447 This option should only be used if the automated detection fails or if you want
8448 to disable this feature.
8450 =item B<DigitalTemperatureSensor> I<true>|I<false>
8452 Boolean enabling the collection of the temperature of each core. This option
8453 should only be used if the automated detection fails or if you want to disable
8456 =item B<TCCActivationTemp> I<Temperature>
8458 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8459 temperature is used when collecting the temperature of cores or packages. This
8460 option should only be used if the automated detection fails. Default value
8461 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8463 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8465 Bit mask of the list of elements to be thermally monitored. This option should
8466 only be used if the automated detection fails or if you want to disable some
8467 collections. The different bits of this bit mask accepted by this plugin are:
8471 =item 0 ('1'): Package
8475 =item 2 ('4'): Cores
8477 =item 3 ('8'): Embedded graphic device
8481 =item B<LogicalCoreNames> I<true>|I<false>
8483 Boolean enabling the use of logical core numbering for per core statistics.
8484 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8485 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8486 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8487 more than one, where I<n> is the n-th core of package I<m>.
8491 =head2 Plugin C<unixsock>
8495 =item B<SocketFile> I<Path>
8497 Sets the socket-file which is to be created.
8499 =item B<SocketGroup> I<Group>
8501 If running as root change the group of the UNIX-socket after it has been
8502 created. Defaults to B<collectd>.
8504 =item B<SocketPerms> I<Permissions>
8506 Change the file permissions of the UNIX-socket after it has been created. The
8507 permissions must be given as a numeric, octal value as you would pass to
8508 L<chmod(1)>. Defaults to B<0770>.
8510 =item B<DeleteSocket> B<false>|B<true>
8512 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8513 with the given name already exists. If I<collectd> crashes a socket file may be
8514 left over, preventing the daemon from opening a new socket when restarted.
8515 Since this is potentially dangerous, this defaults to B<false>.
8519 =head2 Plugin C<uuid>
8521 This plugin, if loaded, causes the Hostname to be taken from the machine's
8522 UUID. The UUID is a universally unique designation for the machine, usually
8523 taken from the machine's BIOS. This is most useful if the machine is running in
8524 a virtual environment such as Xen, in which case the UUID is preserved across
8525 shutdowns and migration.
8527 The following methods are used to find the machine's UUID, in order:
8533 Check I</etc/uuid> (or I<UUIDFile>).
8537 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8542 Check for UUID from C<dmidecode> / SMBIOS.
8546 Check for UUID from Xen hypervisor.
8550 If no UUID can be found then the hostname is not modified.
8554 =item B<UUIDFile> I<Path>
8556 Take the UUID from the given file (default I</etc/uuid>).
8560 =head2 Plugin C<varnish>
8562 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8563 It collects a subset of the values displayed by L<varnishstat(1)>, and
8564 organizes them in categories which can be enabled or disabled. Currently only
8565 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8566 meaning of each metric can be found in L<varnish-counters(7)>.
8571 <Instance "example">
8575 CollectConnections true
8576 CollectDirectorDNS false
8580 CollectObjects false
8582 CollectSession false
8592 CollectWorkers false
8594 CollectMempool false
8595 CollectManagement false
8602 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8603 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8604 will collectd statistics from the default "varnishd" instance (this should work
8605 fine in most cases).
8607 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8611 =item B<CollectBackend> B<true>|B<false>
8613 Back-end connection statistics, such as successful, reused,
8614 and closed connections. True by default.
8616 =item B<CollectBan> B<true>|B<false>
8618 Statistics about ban operations, such as number of bans added, retired, and
8619 number of objects tested against ban operations. Only available with Varnish
8620 3.x and above. False by default.
8622 =item B<CollectCache> B<true>|B<false>
8624 Cache hits and misses. True by default.
8626 =item B<CollectConnections> B<true>|B<false>
8628 Number of client connections received, accepted and dropped. True by default.
8630 =item B<CollectDirectorDNS> B<true>|B<false>
8632 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8635 =item B<CollectESI> B<true>|B<false>
8637 Edge Side Includes (ESI) parse statistics. False by default.
8639 =item B<CollectFetch> B<true>|B<false>
8641 Statistics about fetches (HTTP requests sent to the backend). False by default.
8643 =item B<CollectHCB> B<true>|B<false>
8645 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8646 divided into locked and unlocked look-ups. False by default.
8648 =item B<CollectObjects> B<true>|B<false>
8650 Statistics on cached objects: number of objects expired, nuked (prematurely
8651 expired), saved, moved, etc. False by default.
8653 =item B<CollectPurge> B<true>|B<false>
8655 Statistics about purge operations, such as number of purges added, retired, and
8656 number of objects tested against purge operations. Only available with Varnish
8657 2.x. False by default.
8659 =item B<CollectSession> B<true>|B<false>
8661 Client session statistics. Number of past and current sessions, session herd and
8662 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8663 metrics found in the Connections and Threads sections with previous versions of
8664 Varnish have been moved here.
8666 =item B<CollectSHM> B<true>|B<false>
8668 Statistics about the shared memory log, a memory region to store
8669 log messages which is flushed to disk when full. True by default.
8671 =item B<CollectSMA> B<true>|B<false>
8673 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8674 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
8675 only the one used by the Varnish instance. Only available with Varnish 2.x.
8678 =item B<CollectSMS> B<true>|B<false>
8680 synth (synthetic content) storage statistics. This storage
8681 component is used internally only. False by default.
8683 =item B<CollectSM> B<true>|B<false>
8685 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8686 in varnish 4.x. use CollectSMF.
8689 =item B<CollectStruct> B<true>|B<false>
8691 Current varnish internal state statistics. Number of current sessions, objects
8692 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8695 =item B<CollectTotals> B<true>|B<false>
8697 Collects overview counters, such as the number of sessions created,
8698 the number of requests and bytes transferred. False by default.
8700 =item B<CollectUptime> B<true>|B<false>
8702 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8704 =item B<CollectVCL> B<true>|B<false>
8706 Number of total (available + discarded) VCL (config files). False by default.
8708 =item B<CollectVSM> B<true>|B<false>
8710 Collect statistics about Varnish's shared memory usage (used by the logging and
8711 statistics subsystems). Only available with Varnish 4.x. False by default.
8713 =item B<CollectWorkers> B<true>|B<false>
8715 Collect statistics about worker threads. False by default.
8717 =item B<CollectVBE> B<true>|B<false>
8719 Backend counters. Only available with Varnish 4.x. False by default.
8721 =item B<CollectSMF> B<true>|B<false>
8723 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
8724 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
8725 instance. Used to be called SM in Varnish 2.x. False by default.
8727 =item B<CollectManagement> B<true>|B<false>
8729 Management process counters. Only available with Varnish 4.x. False by default.
8731 =item B<CollectLock> B<true>|B<false>
8733 Lock counters. Only available with Varnish 4.x. False by default.
8735 =item B<CollectMempool> B<true>|B<false>
8737 Memory pool counters. Only available with Varnish 4.x. False by default.
8739 =item B<CollectMSE> B<true>|B<false>
8741 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
8742 Varnish, replacing the traditional malloc and file storages. Only available
8743 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
8744 one used by the Varnish instance. False by default.
8748 =head2 Plugin C<virt>
8750 This plugin allows CPU, disk, network load and other metrics to be collected for
8751 virtualized guests on the machine. The statistics are collected through libvirt
8752 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8753 installing any additional software on guests, especially I<collectd>, which runs
8754 only on the host system.
8756 Only I<Connection> is required.
8760 =item B<Connection> I<uri>
8762 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8764 Connection "xen:///"
8766 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8768 =item B<RefreshInterval> I<seconds>
8770 Refresh the list of domains and devices every I<seconds>. The default is 60
8771 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8772 the list of domains and devices to be refreshed on every iteration.
8774 Refreshing the devices in particular is quite a costly operation, so if your
8775 virtualization setup is static you might consider increasing this. If this
8776 option is set to 0, refreshing is disabled completely.
8778 =item B<Domain> I<name>
8780 =item B<BlockDevice> I<name:dev>
8782 =item B<InterfaceDevice> I<name:dev>
8784 =item B<IgnoreSelected> B<true>|B<false>
8786 Select which domains and devices are collected.
8788 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8789 disk/network devices are collected.
8791 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8792 domains and disk/network devices are ignored, while the rest are collected.
8794 The domain name and device names may use a regular expression, if the name is
8795 surrounded by I</.../> and collectd was compiled with support for regexps.
8797 The default is to collect statistics for all domains and all their devices.
8801 BlockDevice "/:hdb/"
8802 IgnoreSelected "true"
8804 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8807 =item B<BlockDeviceFormat> B<target>|B<source>
8809 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8810 seen by the guest will be used for reporting metrics.
8811 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8814 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8815 using the path of the source, e.g. an image file.
8816 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8821 If the domain XML have the following device defined:
8823 <disk type='block' device='disk'>
8824 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8825 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8826 <target dev='sda' bus='scsi'/>
8828 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8831 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8833 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8834 to C<var_lib_libvirt_images_image1.qcow2>.
8836 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8838 The B<BlockDeviceFormatBasename> controls whether the full path or the
8839 L<basename(1)> of the source is being used as the I<type instance> when
8840 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8844 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8845 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8846 be set to C<var_lib_libvirt_images_image1.qcow2>.
8847 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8848 set to C<image1.qcow2>.
8850 =item B<HostnameFormat> B<name|uuid|hostname|...>
8852 When the virt plugin logs data, it sets the hostname of the collected data
8853 according to this setting. The default is to use the guest name as provided by
8854 the hypervisor, which is equal to setting B<name>.
8856 B<uuid> means use the guest's UUID. This is useful if you want to track the
8857 same guest across migrations.
8859 B<hostname> means to use the global B<Hostname> setting, which is probably not
8860 useful on its own because all guests will appear to have the same name.
8862 You can also specify combinations of these fields. For example B<name uuid>
8863 means to concatenate the guest name and UUID (with a literal colon character
8864 between, thus I<"foo:1234-1234-1234-1234">).
8866 At the moment of writing (collectd-5.5), hostname string is limited to 62
8867 characters. In case when combination of fields exceeds 62 characters,
8868 hostname will be truncated without a warning.
8870 =item B<InterfaceFormat> B<name>|B<address>
8872 When the virt plugin logs interface data, it sets the name of the collected
8873 data according to this setting. The default is to use the path as provided by
8874 the hypervisor (the "dev" property of the target node), which is equal to
8877 B<address> means use the interface's mac address. This is useful since the
8878 interface path might change between reboots of a guest or across migrations.
8880 =item B<PluginInstanceFormat> B<name|uuid|none>
8882 When the virt plugin logs data, it sets the plugin_instance of the collected
8883 data according to this setting. The default is to not set the plugin_instance.
8885 B<name> means use the guest's name as provided by the hypervisor.
8886 B<uuid> means use the guest's UUID.
8888 You can also specify combinations of the B<name> and B<uuid> fields.
8889 For example B<name uuid> means to concatenate the guest name and UUID
8890 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8892 =item B<Instances> B<integer>
8894 How many read instances you want to use for this plugin. The default is one,
8895 and the sensible setting is a multiple of the B<ReadThreads> value.
8896 If you are not sure, just use the default setting.
8898 =item B<ExtraStats> B<string>
8900 Report additional extra statistics. The default is no extra statistics, preserving
8901 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8902 allows the plugin to reported more detailed statistics about the behaviour of
8903 Virtual Machines. The argument is a space-separated list of selectors.
8905 Currently supported selectors are:
8909 =item B<cpu_util>: report CPU utilization per domain in percentage.
8911 =item B<disk>: report extra statistics like number of flush operations and total
8912 service time for read, write and flush operations. Requires libvirt API version
8915 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8918 =item B<domain_state>: report domain state and reason in human-readable format as
8919 a notification. If libvirt API version I<0.9.2> or later is available, domain
8920 reason will be included in notification.
8922 =item B<fs_info>: report file system information as a notification. Requires
8923 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8924 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8925 version supports retrieving file system information.
8927 =item B<job_stats_background>: report statistics about progress of a background
8928 job on a domain. Only one type of job statistics can be collected at the same time.
8929 Requires libvirt API version I<1.2.9> or later.
8931 =item B<job_stats_completed>: report statistics about a recently completed job on
8932 a domain. Only one type of job statistics can be collected at the same time.
8933 Requires libvirt API version I<1.2.9> or later.
8935 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8936 Requires libvirt API version I<0.9.11> or later.
8938 =item B<perf>: report performance monitoring events. To collect performance
8939 metrics they must be enabled for domain and supported by the platform. Requires
8940 libvirt API version I<1.3.3> or later.
8941 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8943 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8949 =head2 Plugin C<vmem>
8951 The C<vmem> plugin collects information about the usage of virtual memory.
8952 Since the statistics provided by the Linux kernel are very detailed, they are
8953 collected very detailed. However, to get all the details, you have to switch
8954 them on manually. Most people just want an overview over, such as the number of
8955 pages read from swap space.
8959 =item B<Verbose> B<true>|B<false>
8961 Enables verbose collection of information. This will start collecting page
8962 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8963 Part of these statistics are collected on a "per zone" basis.
8967 =head2 Plugin C<vserver>
8969 This plugin doesn't have any options. B<VServer> support is only available for
8970 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8971 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8972 need to apply the patches and compile your own kernel, which will then provide
8973 the F</proc/virtual> filesystem that is required by this plugin.
8975 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8977 B<Note>: The traffic collected by this plugin accounts for the amount of
8978 traffic passing a socket which might be a lot less than the actual on-wire
8979 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8980 collect on-wire traffic you could, for example, use the logging facilities of
8981 iptables to feed data for the guest IPs into the iptables plugin.
8983 =head2 Plugin C<write_graphite>
8985 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8986 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8987 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8988 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8989 of at most 1428 bytes to minimize the number of network packets.
8993 <Plugin write_graphite>
9003 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9004 blocks. Inside the B<Node> blocks, the following options are recognized:
9008 =item B<Host> I<Address>
9010 Hostname or address to connect to. Defaults to C<localhost>.
9012 =item B<Port> I<Service>
9014 Service name or port number to connect to. Defaults to C<2003>.
9016 =item B<Protocol> I<String>
9018 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9020 =item B<ReconnectInterval> I<Seconds>
9022 When set to non-zero, forces the connection to the Graphite backend to be
9023 closed and re-opend periodically. This behavior is desirable in environments
9024 where the connection to the Graphite backend is done through load balancers,
9025 for example. When set to zero, the default, the connetion is kept open for as
9028 =item B<LogSendErrors> B<false>|B<true>
9030 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9031 If set to B<false>, it will not log the errors. This is especially useful when
9032 using Protocol UDP since many times we want to use the "fire-and-forget"
9033 approach and logging errors fills syslog with unneeded messages.
9035 =item B<Prefix> I<String>
9037 When set, I<String> is added in front of the host name. Dots and whitespace are
9038 I<not> escaped in this string (see B<EscapeCharacter> below).
9040 =item B<Postfix> I<String>
9042 When set, I<String> is appended to the host name. Dots and whitespace are
9043 I<not> escaped in this string (see B<EscapeCharacter> below).
9045 =item B<EscapeCharacter> I<Char>
9047 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9048 in the identifier. The B<EscapeCharacter> option determines which character
9049 dots, whitespace and control characters are replaced with. Defaults to
9052 =item B<StoreRates> B<false>|B<true>
9054 If set to B<true> (the default), convert counter values to rates. If set to
9055 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9058 =item B<SeparateInstances> B<false>|B<true>
9060 If set to B<true>, the plugin instance and type instance will be in their own
9061 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9062 default), the plugin and plugin instance (and likewise the type and type
9063 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9065 =item B<AlwaysAppendDS> B<false>|B<true>
9067 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9068 identifier. If set to B<false> (the default), this is only done when there is
9071 =item B<PreserveSeparator> B<false>|B<true>
9073 If set to B<false> (the default) the C<.> (dot) character is replaced with
9074 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9075 is preserved, i.e. passed through.
9077 =item B<DropDuplicateFields> B<false>|B<true>
9079 If set to B<true>, detect and remove duplicate components in Graphite metric
9080 names. For example, the metric name C<host.load.load.shortterm> will
9081 be shortened to C<host.load.shortterm>.
9085 =head2 Plugin C<write_log>
9087 The C<write_log> plugin writes metrics as INFO log messages.
9089 This plugin supports two output formats: I<Graphite> and I<JSON>.
9099 =item B<Format> I<Format>
9101 The output format to use. Can be one of C<Graphite> or C<JSON>.
9105 =head2 Plugin C<write_tsdb>
9107 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9108 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9109 state daemon that ingests metrics and stores them in HBase. The plugin uses
9110 I<TCP> over the "line based" protocol with a default port 4242. The data will
9111 be sent in blocks of at most 1428 bytes to minimize the number of network
9120 Host "tsd-1.my.domain"
9122 HostTags "status=production"
9126 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9127 blocks and global directives.
9129 Global directives are:
9133 =item B<ResolveInterval> I<seconds>
9135 =item B<ResolveJitter> I<seconds>
9137 When I<collectd> connects to a TSDB node, it will request the hostname from
9138 DNS. This can become a problem if the TSDB node is unavailable or badly
9139 configured because collectd will request DNS in order to reconnect for every
9140 metric, which can flood your DNS. So you can cache the last value for
9141 I<ResolveInterval> seconds.
9142 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9144 You can also define a jitter, a random interval to wait in addition to
9145 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9146 hostname at the same time when the connection fails.
9147 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9149 B<Note:> If the DNS resolution has already been successful when the socket
9150 closes, the plugin will try to reconnect immediately with the cached
9151 information. DNS is queried only when the socket is closed for a longer than
9152 I<ResolveInterval> + I<ResolveJitter> seconds.
9156 Inside the B<Node> blocks, the following options are recognized:
9160 =item B<Host> I<Address>
9162 Hostname or address to connect to. Defaults to C<localhost>.
9164 =item B<Port> I<Service>
9166 Service name or port number to connect to. Defaults to C<4242>.
9169 =item B<HostTags> I<String>
9171 When set, I<HostTags> is added to the end of the metric. It is intended to be
9172 used for name=value pairs that the TSD will tag the metric with. Dots and
9173 whitespace are I<not> escaped in this string.
9175 =item B<StoreRates> B<false>|B<true>
9177 If set to B<true>, convert counter values to rates. If set to B<false>
9178 (the default) counter values are stored as is, as an increasing
9181 =item B<AlwaysAppendDS> B<false>|B<true>
9183 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9184 identifier. If set to B<false> (the default), this is only done when there is
9189 =head2 Plugin C<write_mongodb>
9191 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9196 <Plugin "write_mongodb">
9205 The plugin can send values to multiple instances of I<MongoDB> by specifying
9206 one B<Node> block for each instance. Within the B<Node> blocks, the following
9207 options are available:
9211 =item B<Host> I<Address>
9213 Hostname or address to connect to. Defaults to C<localhost>.
9215 =item B<Port> I<Service>
9217 Service name or port number to connect to. Defaults to C<27017>.
9219 =item B<Timeout> I<Milliseconds>
9221 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9222 Setting this option to zero means no timeout, which is the default.
9224 =item B<StoreRates> B<false>|B<true>
9226 If set to B<true> (the default), convert counter values to rates. If set to
9227 B<false> counter values are stored as is, i.e. as an increasing integer
9230 =item B<Database> I<Database>
9232 =item B<User> I<User>
9234 =item B<Password> I<Password>
9236 Sets the information used when authenticating to a I<MongoDB> database. The
9237 fields are optional (in which case no authentication is attempted), but if you
9238 want to use authentication all three fields must be set.
9242 =head2 Plugin C<write_prometheus>
9244 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9245 using I<Prometheus>.
9251 =item B<Port> I<Port>
9253 Port the embedded webserver should listen on. Defaults to B<9103>.
9255 =item B<StalenessDelta> I<Seconds>
9257 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9258 hasn't seen any update for it. This value must match the setting in Prometheus.
9259 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9263 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9264 which time a metric without updates is considered "stale". This setting
9265 effectively puts an upper limit on the interval in which metrics are reported.
9267 When the I<write_prometheus plugin> encounters a metric with an interval
9268 exceeding this limit, it will inform you, the user, and provide the metric to
9269 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9270 metric "fresh" each time it is scraped, with the time of the scrape being
9271 considered the time of the update. The result is that there appear more
9272 datapoints in I<Prometheus> than were actually created, but at least the metric
9273 doesn't disappear periodically.
9277 =head2 Plugin C<write_http>
9279 This output plugin submits values to an HTTP server using POST requests and
9280 encoding metrics with JSON or using the C<PUTVAL> command described in
9281 L<collectd-unixsock(5)>.
9285 <Plugin "write_http">
9287 URL "http://example.com/post-collectd"
9294 The plugin can send values to multiple HTTP servers by specifying one
9295 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9296 block, the following options are available:
9302 URL to which the values are submitted to. Mandatory.
9304 =item B<User> I<Username>
9306 Optional user name needed for authentication.
9308 =item B<Password> I<Password>
9310 Optional password needed for authentication.
9312 =item B<VerifyPeer> B<true>|B<false>
9314 Enable or disable peer SSL certificate verification. See
9315 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9317 =item B<VerifyHost> B<true|false>
9319 Enable or disable peer host name verification. If enabled, the plugin checks if
9320 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9321 matches the host name provided by the B<URL> option. If this identity check
9322 fails, the connection is aborted. Obviously, only works when connecting to a
9323 SSL enabled server. Enabled by default.
9325 =item B<CACert> I<File>
9327 File that holds one or more SSL certificates. If you want to use HTTPS you will
9328 possibly need this option. What CA certificates come bundled with C<libcurl>
9329 and are checked by default depends on the distribution you use.
9331 =item B<CAPath> I<Directory>
9333 Directory holding one or more CA certificate files. You can use this if for
9334 some reason all the needed CA certificates aren't in the same file and can't be
9335 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9338 =item B<ClientKey> I<File>
9340 File that holds the private key in PEM format to be used for certificate-based
9343 =item B<ClientCert> I<File>
9345 File that holds the SSL certificate to be used for certificate-based
9348 =item B<ClientKeyPass> I<Password>
9350 Password required to load the private key in B<ClientKey>.
9352 =item B<Header> I<Header>
9354 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9356 Header "X-Custom-Header: custom_value"
9358 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9360 Define which SSL protocol version must be used. By default C<libcurl> will
9361 attempt to figure out the remote SSL protocol version. See
9362 L<curl_easy_setopt(3)> for more details.
9364 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9366 Format of the output to generate. If set to B<Command>, will create output that
9367 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9368 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9369 , will create output in the KairosDB format.
9371 Defaults to B<Command>.
9373 =item B<Attribute> I<String> I<String>
9375 Only available for the KAIROSDB output format.
9377 Consider the two given strings to be the key and value of an additional tag for
9378 each metric being sent out.
9380 You can add multiple B<Attribute>.
9384 Only available for the KAIROSDB output format.
9386 Sets the Cassandra ttl for the data points.
9388 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9390 =item B<Prefix> I<String>
9392 Only available for the KAIROSDB output format.
9394 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9396 =item B<Metrics> B<true>|B<false>
9398 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9400 =item B<Notifications> B<false>|B<true>
9402 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9404 =item B<StoreRates> B<true|false>
9406 If set to B<true>, convert counter values to rates. If set to B<false> (the
9407 default) counter values are stored as is, i.e. as an increasing integer number.
9409 =item B<BufferSize> I<Bytes>
9411 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9412 requests will be generated, but more metrics will be batched / metrics are
9413 cached for longer before being sent, introducing additional delay until they
9414 are available on the server side. I<Bytes> must be at least 1024 and cannot
9415 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9416 Defaults to C<4096>.
9418 =item B<LowSpeedLimit> I<Bytes per Second>
9420 Sets the minimal transfer rate in I<Bytes per Second> below which the
9421 connection with the HTTP server will be considered too slow and aborted. All
9422 the data submitted over this connection will probably be lost. Defaults to 0,
9423 which means no minimum transfer rate is enforced.
9425 =item B<Timeout> I<Timeout>
9427 Sets the maximum time in milliseconds given for HTTP POST operations to
9428 complete. When this limit is reached, the POST operation will be aborted, and
9429 all the data in the current send buffer will probably be lost. Defaults to 0,
9430 which means the connection never times out.
9432 =item B<LogHttpError> B<false>|B<true>
9434 Enables printing of HTTP error code to log. Turned off by default.
9436 The C<write_http> plugin regularly submits the collected values to the HTTP
9437 server. How frequently this happens depends on how much data you are collecting
9438 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9439 slightly below this interval, which you can estimate by monitoring the network
9440 traffic between collectd and the HTTP server.
9444 =head2 Plugin C<write_kafka>
9446 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9450 <Plugin "write_kafka">
9451 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9457 The following options are understood by the I<write_kafka plugin>:
9461 =item E<lt>B<Topic> I<Name>E<gt>
9463 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9464 is given a unique I<Name> and specifies one kafka producer.
9465 Inside the B<Topic> block, the following per-topic options are
9470 =item B<Property> I<String> I<String>
9472 Configure the named property for the current topic. Properties are
9473 forwarded to the kafka producer library B<librdkafka>.
9475 =item B<Key> I<String>
9477 Use the specified string as a partitioning key for the topic. Kafka breaks
9478 topic into partitions and guarantees that for a given topology, the same
9479 consumer will be used for a specific key. The special (case insensitive)
9480 string B<Random> can be used to specify that an arbitrary partition should
9483 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9485 Selects the format in which messages are sent to the broker. If set to
9486 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9487 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9489 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9490 an easy and straight forward exchange format.
9492 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9493 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9495 =item B<StoreRates> B<true>|B<false>
9497 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9498 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9499 default), no conversion is performed. Otherwise the conversion is performed
9500 using the internal value cache.
9502 Please note that currently this option is only used if the B<Format> option has
9503 been set to B<JSON>.
9505 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9507 A prefix can be added in the metric name when outputting in the I<Graphite>
9508 format. It's added before the I<Host> name.
9510 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>>
9512 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9514 A postfix can be added in the metric name when outputting in the I<Graphite>
9515 format. It's added after the I<Host> name.
9517 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>>
9519 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9521 Specify a character to replace dots (.) in the host part of the metric name.
9522 In I<Graphite> metric name, dots are used as separators between different
9523 metric parts (host, plugin, type).
9524 Default is C<_> (I<Underscore>).
9526 =item B<GraphiteSeparateInstances> B<false>|B<true>
9528 If set to B<true>, the plugin instance and type instance will be in their own
9529 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9530 default), the plugin and plugin instance (and likewise the type and type
9531 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9533 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9535 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9536 identifier. If set to B<false> (the default), this is only done when there is
9539 =item B<GraphitePreserveSeparator> B<false>|B<true>
9541 If set to B<false> (the default) the C<.> (dot) character is replaced with
9542 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9543 is preserved, i.e. passed through.
9545 =item B<StoreRates> B<true>|B<false>
9547 If set to B<true> (the default), convert counter values to rates. If set to
9548 B<false> counter values are stored as is, i.e. as an increasing integer number.
9550 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9551 converted values will have "rate" appended to the data source type, e.g.
9552 C<ds_type:derive:rate>.
9556 =item B<Property> I<String> I<String>
9558 Configure the kafka producer through properties, you almost always will
9559 want to set B<metadata.broker.list> to your Kafka broker list.
9563 =head2 Plugin C<write_redis>
9565 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9569 <Plugin "write_redis">
9582 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9583 the timestamp as the score. Retrieving a date range can then be done using the
9584 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9585 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9586 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9587 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9588 with the B<Database> parameter (default is C<0>). See
9589 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9592 The information shown in the synopsis above is the I<default configuration>
9593 which is used by the plugin if no configuration is present.
9595 The plugin can send values to multiple instances of I<Redis> by specifying
9596 one B<Node> block for each instance. Within the B<Node> blocks, the following
9597 options are available:
9601 =item B<Node> I<Nodename>
9603 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9604 instance running on a specified host and port. The node name is a
9605 canonical identifier which is used as I<plugin instance>. It is limited to
9606 51E<nbsp>characters in length.
9608 =item B<Host> I<Hostname>
9610 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9613 =item B<Port> I<Port>
9615 The B<Port> option is the TCP port on which the Redis instance accepts
9616 connections. Either a service name of a port number may be given. Please note
9617 that numerical port numbers must be given as a string, too.
9619 =item B<Timeout> I<Milliseconds>
9621 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9623 =item B<Prefix> I<Prefix>
9625 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9626 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9627 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9628 is recommended but not required to include a trailing slash in I<Prefix>.
9630 =item B<Database> I<Index>
9632 This index selects the redis database to use for writing operations. Defaults
9635 =item B<MaxSetSize> I<Items>
9637 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9638 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9640 =item B<MaxSetDuration> I<Seconds>
9642 The B<MaxSetDuration> option limits the duration of items that the
9643 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9644 is the default behavior.
9646 =item B<StoreRates> B<true>|B<false>
9648 If set to B<true> (the default), convert counter values to rates. If set to
9649 B<false> counter values are stored as is, i.e. as an increasing integer number.
9653 =head2 Plugin C<write_riemann>
9655 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9656 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9657 I<Riemann> using UDP packets.
9661 <Plugin "write_riemann">
9667 AlwaysAppendDS false
9671 Attribute "foo" "bar"
9674 The following options are understood by the I<write_riemann plugin>:
9678 =item E<lt>B<Node> I<Name>E<gt>
9680 The plugin's configuration consists of one or more B<Node> blocks. Each block
9681 is given a unique I<Name> and specifies one connection to an instance of
9682 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9687 =item B<Host> I<Address>
9689 Hostname or address to connect to. Defaults to C<localhost>.
9691 =item B<Port> I<Service>
9693 Service name or port number to connect to. Defaults to C<5555>.
9695 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9697 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9700 =item B<TLSCertFile> I<Path>
9702 When using the B<TLS> protocol, path to a PEM certificate to present
9705 =item B<TLSCAFile> I<Path>
9707 When using the B<TLS> protocol, path to a PEM CA certificate to
9708 use to validate the remote hosts's identity.
9710 =item B<TLSKeyFile> I<Path>
9712 When using the B<TLS> protocol, path to a PEM private key associated
9713 with the certificate defined by B<TLSCertFile>.
9715 =item B<Batch> B<true>|B<false>
9717 If set to B<true> and B<Protocol> is set to B<TCP>,
9718 events will be batched in memory and flushed at
9719 regular intervals or when B<BatchMaxSize> is exceeded.
9721 Notifications are not batched and sent as soon as possible.
9723 When enabled, it can occur that events get processed by the Riemann server
9724 close to or after their expiration time. Tune the B<TTLFactor> and
9725 B<BatchMaxSize> settings according to the amount of values collected, if this
9730 =item B<BatchMaxSize> I<size>
9732 Maximum payload size for a riemann packet. Defaults to 8192
9734 =item B<BatchFlushTimeout> I<seconds>
9736 Maximum amount of seconds to wait in between to batch flushes.
9737 No timeout by default.
9739 =item B<StoreRates> B<true>|B<false>
9741 If set to B<true> (the default), convert counter values to rates. If set to
9742 B<false> counter values are stored as is, i.e. as an increasing integer number.
9744 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9745 converted values will have "rate" appended to the data source type, e.g.
9746 C<ds_type:derive:rate>.
9748 =item B<AlwaysAppendDS> B<false>|B<true>
9750 If set to B<true>, append the name of the I<Data Source> (DS) to the
9751 "service", i.e. the field that, together with the "host" field, uniquely
9752 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9753 only done when there is more than one DS.
9755 =item B<TTLFactor> I<Factor>
9757 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9758 event is considered active. I<collectd> populates this field based on the
9759 metrics interval setting. This setting controls the factor with which the
9760 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9761 know exactly what you're doing, you should only increase this setting from its
9764 =item B<Notifications> B<false>|B<true>
9766 If set to B<true>, create riemann events for notifications. This is B<true>
9767 by default. When processing thresholds from write_riemann, it might prove
9768 useful to avoid getting notification events.
9770 =item B<CheckThresholds> B<false>|B<true>
9772 If set to B<true>, attach state to events based on thresholds defined
9773 in the B<Threshold> plugin. Defaults to B<false>.
9775 =item B<EventServicePrefix> I<String>
9777 Add the given string as a prefix to the event service name.
9778 If B<EventServicePrefix> not set or set to an empty string (""),
9779 no prefix will be used.
9783 =item B<Tag> I<String>
9785 Add the given string as an additional tag to the metric being sent to
9788 =item B<Attribute> I<String> I<String>
9790 Consider the two given strings to be the key and value of an additional
9791 attribute for each metric being sent out to I<Riemann>.
9795 =head2 Plugin C<write_sensu>
9797 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9798 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9799 a local I<Sensu> client using a TCP socket.
9801 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9802 parameter so it is not possible to use one collectd instance as a gateway for
9803 others. Each collectd host must pair with one I<Sensu> client.
9807 <Plugin "write_sensu">
9812 AlwaysAppendDS false
9813 MetricHandler "influx"
9814 MetricHandler "default"
9815 NotificationHandler "flapjack"
9816 NotificationHandler "howling_monkey"
9820 Attribute "foo" "bar"
9823 The following options are understood by the I<write_sensu plugin>:
9827 =item E<lt>B<Node> I<Name>E<gt>
9829 The plugin's configuration consists of one or more B<Node> blocks. Each block
9830 is given a unique I<Name> and specifies one connection to an instance of
9831 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9836 =item B<Host> I<Address>
9838 Hostname or address to connect to. Defaults to C<localhost>.
9840 =item B<Port> I<Service>
9842 Service name or port number to connect to. Defaults to C<3030>.
9844 =item B<StoreRates> B<true>|B<false>
9846 If set to B<true> (the default), convert counter values to rates. If set to
9847 B<false> counter values are stored as is, i.e. as an increasing integer number.
9849 This will be reflected in the C<collectd_data_source_type> tag: If
9850 B<StoreRates> is enabled, converted values will have "rate" appended to the
9851 data source type, e.g. C<collectd_data_source_type:derive:rate>.
9853 =item B<AlwaysAppendDS> B<false>|B<true>
9855 If set the B<true>, append the name of the I<Data Source> (DS) to the
9856 "service", i.e. the field that, together with the "host" field, uniquely
9857 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9858 only done when there is more than one DS.
9860 =item B<Notifications> B<false>|B<true>
9862 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9863 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9865 =item B<Metrics> B<false>|B<true>
9867 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9868 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9871 =item B<Separator> I<String>
9873 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9875 =item B<MetricHandler> I<String>
9877 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9878 several of them, one per line. Defaults to no handler.
9880 =item B<NotificationHandler> I<String>
9882 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9883 add several of them, one per line. Defaults to no handler.
9885 =item B<EventServicePrefix> I<String>
9887 Add the given string as a prefix to the event service name.
9888 If B<EventServicePrefix> not set or set to an empty string (""),
9889 no prefix will be used.
9893 =item B<Tag> I<String>
9895 Add the given string as an additional tag to the metric being sent to
9898 =item B<Attribute> I<String> I<String>
9900 Consider the two given strings to be the key and value of an additional
9901 attribute for each metric being sent out to I<Sensu>.
9905 =head2 Plugin C<xencpu>
9907 This plugin collects metrics of hardware CPU load for machine running Xen
9908 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9909 Result is reported using the C<percent> type, for each CPU (core).
9911 This plugin doesn't have any options (yet).
9913 =head2 Plugin C<zookeeper>
9915 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9916 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9921 <Plugin "zookeeper">
9928 =item B<Host> I<Address>
9930 Hostname or address to connect to. Defaults to C<localhost>.
9932 =item B<Port> I<Service>
9934 Service name or port number to connect to. Defaults to C<2181>.
9938 =head1 THRESHOLD CONFIGURATION
9940 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9941 we mean that the values are not only stored or sent somewhere, but that they
9942 are judged and, if a problem is recognized, acted upon. The only action
9943 collectd takes itself is to generate and dispatch a "notification". Plugins can
9944 register to receive notifications and perform appropriate further actions.
9946 Since systems and what you expect them to do differ a lot, you can configure
9947 B<thresholds> for your values freely. This gives you a lot of flexibility but
9948 also a lot of responsibility.
9950 Every time a value is out of range a notification is dispatched. This means
9951 that the idle percentage of your CPU needs to be less then the configured
9952 threshold only once for a notification to be generated. There's no such thing
9953 as a moving average or similar - at least not now.
9955 Also, all values that match a threshold are considered to be relevant or
9956 "interesting". As a consequence collectd will issue a notification if they are
9957 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9958 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9959 "2" (the default) and some hosts sends it's CPU statistics to the server every
9960 60 seconds, a notification will be dispatched after about 120 seconds. It may
9961 take a little longer because the timeout is checked only once each B<Interval>
9964 When a value comes within range again or is received after it was missing, an
9965 "OKAY-notification" is dispatched.
9967 Here is a configuration example to get you started. Read below for more
9980 <Plugin "interface">
9997 WarningMin 100000000
10003 There are basically two types of configuration statements: The C<Host>,
10004 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10005 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10006 C<Instance> option. You can combine the block by nesting the blocks, though
10007 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10008 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10009 C<Type> may not contain other blocks. If multiple blocks apply to the same
10010 value the most specific block is used.
10012 The other statements specify the threshold to configure. They B<must> be
10013 included in a C<Type> block. Currently the following statements are recognized:
10017 =item B<FailureMax> I<Value>
10019 =item B<WarningMax> I<Value>
10021 Sets the upper bound of acceptable values. If unset defaults to positive
10022 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10023 will be created. If the value is greater than B<WarningMax> but less than (or
10024 equal to) B<FailureMax> a B<WARNING> notification will be created.
10026 =item B<FailureMin> I<Value>
10028 =item B<WarningMin> I<Value>
10030 Sets the lower bound of acceptable values. If unset defaults to negative
10031 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10032 be created. If the value is less than B<WarningMin> but greater than (or equal
10033 to) B<FailureMin> a B<WARNING> notification will be created.
10035 =item B<DataSource> I<DSName>
10037 Some data sets have more than one "data source". Interesting examples are the
10038 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10039 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10040 system load data set, C<load>, even has three data sources: C<shortterm>,
10041 C<midterm>, and C<longterm>.
10043 Normally, all data sources are checked against a configured threshold. If this
10044 is undesirable, or if you want to specify different limits for each data
10045 source, you can use the B<DataSource> option to have a threshold apply only to
10048 =item B<Invert> B<true>|B<false>
10050 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10051 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10052 B<WarningMax>) are not okay. Defaults to B<false>.
10054 =item B<Persist> B<true>|B<false>
10056 Sets how often notifications are generated. If set to B<true> one notification
10057 will be generated for each value that is out of the acceptable range. If set to
10058 B<false> (the default) then a notification is only generated if a value is out
10059 of range but the previous value was okay.
10061 This applies to missing values, too: If set to B<true> a notification about a
10062 missing value is generated once every B<Interval> seconds. If set to B<false>
10063 only one such notification is generated until the value appears again.
10065 =item B<Percentage> B<true>|B<false>
10067 If set to B<true>, the minimum and maximum values given are interpreted as
10068 percentage value, relative to the other data sources. This is helpful for
10069 example for the "df" type, where you may want to issue a warning when less than
10070 5E<nbsp>% of the total space is available. Defaults to B<false>.
10072 =item B<Hits> I<Number>
10074 Delay creating the notification until the threshold has been passed I<Number>
10075 times. When a notification has been generated, or when a subsequent value is
10076 inside the threshold, the counter is reset. If, for example, a value is
10077 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10078 will be dispatched at most once every 30E<nbsp>seconds.
10080 This is useful when short bursts are not a problem. If, for example, 100% CPU
10081 usage for up to a minute is normal (and data is collected every
10082 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10084 =item B<Hysteresis> I<Number>
10086 When set to non-zero, a hysteresis value is applied when checking minimum and
10087 maximum bounds. This is useful for values that increase slowly and fluctuate a
10088 bit while doing so. When these values come close to the threshold, they may
10089 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10091 If, for example, the threshold is configures as
10096 then a I<Warning> notification is created when the value exceeds I<101> and the
10097 corresponding I<Okay> notification is only created once the value falls below
10098 I<99>, thus avoiding the "flapping".
10102 =head1 FILTER CONFIGURATION
10104 Starting with collectd 4.6 there is a powerful filtering infrastructure
10105 implemented in the daemon. The concept has mostly been copied from
10106 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10107 terminology, so that users that are familiar with iptables feel right at home.
10111 The following are the terms used in the remainder of the filter configuration
10112 documentation. For an ASCII-art schema of the mechanism, see
10113 L<"General structure"> below.
10119 A I<match> is a criteria to select specific values. Examples are, of course, the
10120 name of the value or it's current value.
10122 Matches are implemented in plugins which you have to load prior to using the
10123 match. The name of such plugins starts with the "match_" prefix.
10127 A I<target> is some action that is to be performed with data. Such actions
10128 could, for example, be to change part of the value's identifier or to ignore
10129 the value completely.
10131 Some of these targets are built into the daemon, see L<"Built-in targets">
10132 below. Other targets are implemented in plugins which you have to load prior to
10133 using the target. The name of such plugins starts with the "target_" prefix.
10137 The combination of any number of matches and at least one target is called a
10138 I<rule>. The target actions will be performed for all values for which B<all>
10139 matches apply. If the rule does not have any matches associated with it, the
10140 target action will be performed for all values.
10144 A I<chain> is a list of rules and possibly default targets. The rules are tried
10145 in order and if one matches, the associated target will be called. If a value
10146 is handled by a rule, it depends on the target whether or not any subsequent
10147 rules are considered or if traversal of the chain is aborted, see
10148 L<"Flow control"> below. After all rules have been checked, the default targets
10153 =head2 General structure
10155 The following shows the resulting structure:
10162 +---------+ +---------+ +---------+ +---------+
10163 ! Rule !->! Match !->! Match !->! Target !
10164 +---------+ +---------+ +---------+ +---------+
10167 +---------+ +---------+ +---------+
10168 ! Rule !->! Target !->! Target !
10169 +---------+ +---------+ +---------+
10176 +---------+ +---------+ +---------+
10177 ! Rule !->! Match !->! Target !
10178 +---------+ +---------+ +---------+
10186 =head2 Flow control
10188 There are four ways to control which way a value takes through the filter
10195 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10196 process the value with another chain. When the called chain finishes, usually
10197 the next target or rule after the jump is executed.
10201 The stop condition, signaled for example by the built-in target B<stop>, causes
10202 all processing of the value to be stopped immediately.
10206 Causes processing in the current chain to be aborted, but processing of the
10207 value generally will continue. This means that if the chain was called via
10208 B<Jump>, the next target or rule after the jump will be executed. If the chain
10209 was not called by another chain, control will be returned to the daemon and it
10210 may pass the value to another chain.
10214 Most targets will signal the B<continue> condition, meaning that processing
10215 should continue normally. There is no special built-in target for this
10222 The configuration reflects this structure directly:
10224 PostCacheChain "PostCache"
10225 <Chain "PostCache">
10226 <Rule "ignore_mysql_show">
10229 Type "^mysql_command$"
10230 TypeInstance "^show_"
10240 The above configuration example will ignore all values where the plugin field
10241 is "mysql", the type is "mysql_command" and the type instance begins with
10242 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10243 default target of the chain. Since this chain is run after the value has been
10244 added to the cache, the MySQL C<show_*> command statistics will be available
10245 via the C<unixsock> plugin.
10247 =head2 List of configuration options
10251 =item B<PreCacheChain> I<ChainName>
10253 =item B<PostCacheChain> I<ChainName>
10255 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10256 argument is the name of a I<chain> that should be executed before and/or after
10257 the values have been added to the cache.
10259 To understand the implications, it's important you know what is going on inside
10260 I<collectd>. The following diagram shows how values are passed from the
10261 read-plugins to the write-plugins:
10267 + - - - - V - - - - +
10268 : +---------------+ :
10271 : +-------+-------+ :
10274 : +-------+-------+ : +---------------+
10275 : ! Cache !--->! Value Cache !
10276 : ! insert ! : +---+---+-------+
10277 : +-------+-------+ : ! !
10278 : ! ,------------' !
10280 : +-------+---+---+ : +-------+-------+
10281 : ! Post-Cache +--->! Write-Plugins !
10282 : ! Chain ! : +---------------+
10283 : +---------------+ :
10285 : dispatch values :
10286 + - - - - - - - - - +
10288 After the values are passed from the "read" plugins to the dispatch functions,
10289 the pre-cache chain is run first. The values are added to the internal cache
10290 afterwards. The post-cache chain is run after the values have been added to the
10291 cache. So why is it such a huge deal if chains are run before or after the
10292 values have been added to this cache?
10294 Targets that change the identifier of a value list should be executed before
10295 the values are added to the cache, so that the name in the cache matches the
10296 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10297 this cache to receive a list of all available values. If you change the
10298 identifier after the value list has been added to the cache, this may easily
10299 lead to confusion, but it's not forbidden of course.
10301 The cache is also used to convert counter values to rates. These rates are, for
10302 example, used by the C<value> match (see below). If you use the rate stored in
10303 the cache B<before> the new value is added, you will use the old, B<previous>
10304 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10305 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10308 Last but not last, the B<stop> target makes a difference: If the pre-cache
10309 chain returns the stop condition, the value will not be added to the cache and
10310 the post-cache chain will not be run.
10312 =item B<Chain> I<Name>
10314 Adds a new chain with a certain name. This name can be used to refer to a
10315 specific chain, for example to jump to it.
10317 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10319 =item B<Rule> [I<Name>]
10321 Adds a new rule to the current chain. The name of the rule is optional and
10322 currently has no meaning for the daemon.
10324 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10325 must be at least one B<Target> block.
10327 =item B<Match> I<Name>
10329 Adds a match to a B<Rule> block. The name specifies what kind of match should
10330 be performed. Available matches depend on the plugins that have been loaded.
10332 The arguments inside the B<Match> block are passed to the plugin implementing
10333 the match, so which arguments are valid here depends on the plugin being used.
10334 If you do not need any to pass any arguments to a match, you can use the
10339 Which is equivalent to:
10344 =item B<Target> I<Name>
10346 Add a target to a rule or a default target to a chain. The name specifies what
10347 kind of target is to be added. Which targets are available depends on the
10348 plugins being loaded.
10350 The arguments inside the B<Target> block are passed to the plugin implementing
10351 the target, so which arguments are valid here depends on the plugin being used.
10352 If you do not need any to pass any arguments to a target, you can use the
10357 This is the same as writing:
10364 =head2 Built-in targets
10366 The following targets are built into the core daemon and therefore need no
10367 plugins to be loaded:
10373 Signals the "return" condition, see the L<"Flow control"> section above. This
10374 causes the current chain to stop processing the value and returns control to
10375 the calling chain. The calling chain will continue processing targets and rules
10376 just after the B<jump> target (see below). This is very similar to the
10377 B<RETURN> target of iptables, see L<iptables(8)>.
10379 This target does not have any options.
10387 Signals the "stop" condition, see the L<"Flow control"> section above. This
10388 causes processing of the value to be aborted immediately. This is similar to
10389 the B<DROP> target of iptables, see L<iptables(8)>.
10391 This target does not have any options.
10399 Sends the value to "write" plugins.
10405 =item B<Plugin> I<Name>
10407 Name of the write plugin to which the data should be sent. This option may be
10408 given multiple times to send the data to more than one write plugin. If the
10409 plugin supports multiple instances, the plugin's instance(s) must also be
10414 If no plugin is explicitly specified, the values will be sent to all available
10417 Single-instance plugin example:
10423 Multi-instance plugin example:
10425 <Plugin "write_graphite">
10435 Plugin "write_graphite/foo"
10440 Starts processing the rules of another chain, see L<"Flow control"> above. If
10441 the end of that chain is reached, or a stop condition is encountered,
10442 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10443 next target or the next rule. This is similar to the B<-j> command line option
10444 of iptables, see L<iptables(8)>.
10450 =item B<Chain> I<Name>
10452 Jumps to the chain I<Name>. This argument is required and may appear only once.
10464 =head2 Available matches
10470 Matches a value using regular expressions.
10476 =item B<Host> I<Regex>
10478 =item B<Plugin> I<Regex>
10480 =item B<PluginInstance> I<Regex>
10482 =item B<Type> I<Regex>
10484 =item B<TypeInstance> I<Regex>
10486 =item B<MetaData> I<String> I<Regex>
10488 Match values where the given regular expressions match the various fields of
10489 the identifier of a value. If multiple regular expressions are given, B<all>
10490 regexen must match for a value to match.
10492 =item B<Invert> B<false>|B<true>
10494 When set to B<true>, the result of the match is inverted, i.e. all value lists
10495 where all regular expressions apply are not matched, all other value lists are
10496 matched. Defaults to B<false>.
10503 Host "customer[0-9]+"
10509 Matches values that have a time which differs from the time on the server.
10511 This match is mainly intended for servers that receive values over the
10512 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10513 is very sensitive to the timestamp used when updating the RRD files. In
10514 particular, the time must be ever increasing. If a misbehaving client sends one
10515 packet with a timestamp far in the future, all further packets with a correct
10516 time will be ignored because of that one packet. What's worse, such corrupted
10517 RRD files are hard to fix.
10519 This match lets one match all values B<outside> a specified time range
10520 (relative to the server's time), so you can use the B<stop> target (see below)
10521 to ignore the value, for example.
10527 =item B<Future> I<Seconds>
10529 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10530 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10533 =item B<Past> I<Seconds>
10535 Matches all values that are I<behind> of the server's time by I<Seconds> or
10536 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10548 This example matches all values that are five minutes or more ahead of the
10549 server or one hour (or more) lagging behind.
10553 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10554 values. If a data-set consists of more than one data-source, all data-sources
10555 must match the specified ranges for a positive match.
10561 =item B<Min> I<Value>
10563 Sets the smallest value which still results in a match. If unset, behaves like
10566 =item B<Max> I<Value>
10568 Sets the largest value which still results in a match. If unset, behaves like
10571 =item B<Invert> B<true>|B<false>
10573 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10574 no-match is returned and vice versa. Please note that the B<Invert> setting
10575 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10576 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10578 =item B<DataSource> I<DSName> [I<DSName> ...]
10580 Select one or more of the data sources. If no data source is configured, all
10581 data sources will be checked. If the type handled by the match does not have a
10582 data source of the specified name(s), this will always result in no match
10583 (independent of the B<Invert> setting).
10585 =item B<Satisfy> B<Any>|B<All>
10587 Specifies how checking with several data sources is performed. If set to
10588 B<Any>, the match succeeds if one of the data sources is in the configured
10589 range. If set to B<All> the match only succeeds if all data sources are within
10590 the configured range. Default is B<All>.
10592 Usually B<All> is used for positive matches, B<Any> is used for negative
10593 matches. This means that with B<All> you usually check that all values are in a
10594 "good" range, while with B<Any> you check if any value is within a "bad" range
10595 (or outside the "good" range).
10599 Either B<Min> or B<Max>, but not both, may be unset.
10603 # Match all values smaller than or equal to 100. Matches only if all data
10604 # sources are below 100.
10610 # Match if the value of any data source is outside the range of 0 - 100.
10618 =item B<empty_counter>
10620 Matches all values with one or more data sources of type B<COUNTER> and where
10621 all counter values are zero. These counters usually I<never> increased since
10622 they started existing (and are therefore uninteresting), or got reset recently
10623 or overflowed and you had really, I<really> bad luck.
10625 Please keep in mind that ignoring such counters can result in confusing
10626 behavior: Counters which hardly ever increase will be zero for long periods of
10627 time. If the counter is reset for some reason (machine or service restarted,
10628 usually), the graph will be empty (NAN) for a long time. People may not
10633 Calculates a hash value of the host name and matches values according to that
10634 hash value. This makes it possible to divide all hosts into groups and match
10635 only values that are in a specific group. The intended use is in load
10636 balancing, where you want to handle only part of all data and leave the rest
10639 The hashing function used tries to distribute the hosts evenly. First, it
10640 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10643 for (i = 0; host[i] != 0; i++)
10644 hash_value = (hash_value * 251) + host[i];
10646 The constant 251 is a prime number which is supposed to make this hash value
10647 more random. The code then checks the group for this host according to the
10648 I<Total> and I<Match> arguments:
10650 if ((hash_value % Total) == Match)
10655 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10656 groups), then the least significant bit of the hash value will be the XOR of
10657 all least significant bits in the host name. One consequence is that when you
10658 have two hosts, "server0.example.com" and "server1.example.com", where the host
10659 name differs in one digit only and the digits differ by one, those hosts will
10660 never end up in the same group.
10666 =item B<Match> I<Match> I<Total>
10668 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10669 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10670 be smaller than I<Total>. I<Total> must be at least one, although only values
10671 greater than one really do make any sense.
10673 You can repeat this option to match multiple groups, for example:
10678 The above config will divide the data into seven groups and match groups three
10679 and five. One use would be to keep every value on two hosts so that if one
10680 fails the missing data can later be reconstructed from the second host.
10686 # Operate on the pre-cache chain, so that ignored values are not even in the
10691 # Divide all received hosts in seven groups and accept all hosts in
10695 # If matched: Return and continue.
10698 # If not matched: Return and stop.
10704 =head2 Available targets
10708 =item B<notification>
10710 Creates and dispatches a notification.
10716 =item B<Message> I<String>
10718 This required option sets the message of the notification. The following
10719 placeholders will be replaced by an appropriate value:
10727 =item B<%{plugin_instance}>
10731 =item B<%{type_instance}>
10733 These placeholders are replaced by the identifier field of the same name.
10735 =item B<%{ds:>I<name>B<}>
10737 These placeholders are replaced by a (hopefully) human readable representation
10738 of the current rate of this data source. If you changed the instance name
10739 (using the B<set> or B<replace> targets, see below), it may not be possible to
10740 convert counter values to rates.
10744 Please note that these placeholders are B<case sensitive>!
10746 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10748 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10755 <Target "notification">
10756 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10762 Replaces parts of the identifier using regular expressions.
10768 =item B<Host> I<Regex> I<Replacement>
10770 =item B<Plugin> I<Regex> I<Replacement>
10772 =item B<PluginInstance> I<Regex> I<Replacement>
10774 =item B<TypeInstance> I<Regex> I<Replacement>
10776 =item B<MetaData> I<String> I<Regex> I<Replacement>
10778 =item B<DeleteMetaData> I<String> I<Regex>
10780 Match the appropriate field with the given regular expression I<Regex>. If the
10781 regular expression matches, that part that matches is replaced with
10782 I<Replacement>. If multiple places of the input buffer match a given regular
10783 expression, only the first occurrence will be replaced.
10785 You can specify each option multiple times to use multiple regular expressions
10793 # Replace "example.net" with "example.com"
10794 Host "\\<example.net\\>" "example.com"
10796 # Strip "www." from hostnames
10797 Host "\\<www\\." ""
10802 Sets part of the identifier of a value to a given string.
10808 =item B<Host> I<String>
10810 =item B<Plugin> I<String>
10812 =item B<PluginInstance> I<String>
10814 =item B<TypeInstance> I<String>
10816 =item B<MetaData> I<String> I<String>
10818 Set the appropriate field to the given string. The strings for plugin instance,
10819 type instance, and meta data may be empty, the strings for host and plugin may
10820 not be empty. It's currently not possible to set the type of a value this way.
10822 The following placeholders will be replaced by an appropriate value:
10830 =item B<%{plugin_instance}>
10834 =item B<%{type_instance}>
10836 These placeholders are replaced by the identifier field of the same name.
10838 =item B<%{meta:>I<name>B<}>
10840 These placeholders are replaced by the meta data value with the given name.
10844 Please note that these placeholders are B<case sensitive>!
10846 =item B<DeleteMetaData> I<String>
10848 Delete the named meta data field.
10855 PluginInstance "coretemp"
10856 TypeInstance "core3"
10861 =head2 Backwards compatibility
10863 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10864 B<Chain> block, it will behave as it used to. This is equivalent to the
10865 following configuration:
10867 <Chain "PostCache">
10871 If you specify a B<PostCacheChain>, the B<write> target will not be added
10872 anywhere and you will have to make sure that it is called where appropriate. We
10873 suggest to add the above snippet as default target to your "PostCache" chain.
10877 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10892 B<Ignorelists> are a generic framework to either ignore some metrics or report
10893 specific metircs only. Plugins usually provide one or more options to specify
10894 the items (mounts points, devices, ...) and the boolean option
10899 =item B<Select> I<String>
10901 Selects the item I<String>. This option often has a plugin specific name, e.g.
10902 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10903 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10904 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10906 By default, this option is doing a case-sensitive full-string match. The
10907 following config will match C<foo>, but not C<Foo>:
10911 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10912 I<regular expression>. For example, so match all item starting with C<foo>, use
10913 could use the following syntax:
10917 The regular expression is I<not> anchored, i.e. the following config will match
10918 C<foobar>, C<barfoo> and C<AfooZ>:
10922 The B<Select> option may be repeated to select multiple items.
10924 =item B<IgnoreSelected> B<true>|B<false>
10926 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10927 collected. If set to B<false>, matching metrics are I<collected> and all other
10928 metrics are ignored.
10935 L<collectd-exec(5)>,
10936 L<collectd-perl(5)>,
10937 L<collectd-unixsock(5)>,
10950 Florian Forster E<lt>octo@collectd.orgE<gt>