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 C<conntrack>
1414 This plugin collects IP conntrack statistics.
1420 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1421 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1425 =head2 Plugin C<cpu>
1427 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1428 as Jiffies, using the C<cpu> type. Two aggregations are available:
1434 Sum, per-state, over all CPUs installed in the system; and
1438 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1442 The two aggregations can be combined, leading to I<collectd> only emitting a
1443 single "active" metric for the entire system. As soon as one of these
1444 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1445 rather than Jiffies. In addition, you can request individual, per-state,
1446 per-CPU metrics to be reported as percentage.
1448 The following configuration options are available:
1452 =item B<ReportByState> B<true>|B<false>
1454 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1456 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1459 =item B<ReportByCpu> B<true>|B<false>
1461 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1462 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1463 global sum of CPU states is emitted.
1465 =item B<ValuesPercentage> B<false>|B<true>
1467 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1468 are set to B<true>. In this case, by default, metrics will be reported as
1469 Jiffies. By setting this option to B<true>, you can request percentage values
1470 in the un-aggregated (per-CPU, per-state) mode as well.
1472 =item B<ReportNumCpu> B<false>|B<true>
1474 When set to B<true>, reports the number of available CPUs.
1475 Defaults to B<false>.
1477 =item B<ReportGuestState> B<false>|B<true>
1479 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1480 Defaults to B<false>.
1482 =item B<SubtractGuestState> B<false>|B<true>
1484 This option is only considered when B<ReportGuestState> is set to B<true>.
1485 "guest" and "guest_nice" are included in respectively "user" and "nice".
1486 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1487 will be subtracted from "nice".
1488 Defaults to B<true>.
1492 =head2 Plugin C<cpufreq>
1494 This plugin doesn't have any options. It reads
1495 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1496 installed) to get the current CPU frequency. If this file does not exist make
1497 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1498 installed and an "cpu governor" (that's a kernel module) is loaded.
1500 =head2 Plugin C<cpusleep>
1502 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1503 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1504 BOOTTIME clock increments while device is suspended and MONOTONIC
1505 clock does not, the derivative of the difference between these clocks
1506 gives the relative amount of time the device has spent in suspend
1507 state. The recorded value is in milliseconds of sleep per seconds of
1510 =head2 Plugin C<csv>
1514 =item B<DataDir> I<Directory>
1516 Set the directory to store CSV-files under. Per default CSV-files are generated
1517 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1518 The special strings B<stdout> and B<stderr> can be used to write to the standard
1519 output and standard error channels, respectively. This, of course, only makes
1520 much sense when collectd is running in foreground- or non-daemon-mode.
1522 =item B<StoreRates> B<true|false>
1524 If set to B<true>, convert counter values to rates. If set to B<false> (the
1525 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1530 =head2 cURL Statistics
1532 All cURL-based plugins support collection of generic, request-based
1533 statistics. These are disabled by default and can be enabled selectively for
1534 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1535 the documentation of those plugins for specific information. This section
1536 describes the available metrics that can be configured for each plugin. All
1537 options are disabled by default.
1539 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1543 =item B<TotalTime> B<true|false>
1545 Total time of the transfer, including name resolving, TCP connect, etc.
1547 =item B<NamelookupTime> B<true|false>
1549 Time it took from the start until name resolving was completed.
1551 =item B<ConnectTime> B<true|false>
1553 Time it took from the start until the connect to the remote host (or proxy)
1556 =item B<AppconnectTime> B<true|false>
1558 Time it took from the start until the SSL/SSH connect/handshake to the remote
1561 =item B<PretransferTime> B<true|false>
1563 Time it took from the start until just before the transfer begins.
1565 =item B<StarttransferTime> B<true|false>
1567 Time it took from the start until the first byte was received.
1569 =item B<RedirectTime> B<true|false>
1571 Time it took for all redirection steps include name lookup, connect,
1572 pre-transfer and transfer before final transaction was started.
1574 =item B<RedirectCount> B<true|false>
1576 The total number of redirections that were actually followed.
1578 =item B<SizeUpload> B<true|false>
1580 The total amount of bytes that were uploaded.
1582 =item B<SizeDownload> B<true|false>
1584 The total amount of bytes that were downloaded.
1586 =item B<SpeedDownload> B<true|false>
1588 The average download speed that curl measured for the complete download.
1590 =item B<SpeedUpload> B<true|false>
1592 The average upload speed that curl measured for the complete upload.
1594 =item B<HeaderSize> B<true|false>
1596 The total size of all the headers received.
1598 =item B<RequestSize> B<true|false>
1600 The total size of the issued requests.
1602 =item B<ContentLengthDownload> B<true|false>
1604 The content-length of the download.
1606 =item B<ContentLengthUpload> B<true|false>
1608 The specified size of the upload.
1610 =item B<NumConnects> B<true|false>
1612 The number of new connections that were created to achieve the transfer.
1616 =head2 Plugin C<curl>
1618 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1619 and the match infrastructure (the same code used by the tail plugin) to use
1620 regular expressions with the received data.
1622 The following example will read the current value of AMD stock from Google's
1623 finance page and dispatch the value to collectd.
1626 <Page "stock_quotes">
1628 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1634 CACert "/path/to/ca.crt"
1635 Header "X-Custom-Header: foobar"
1638 MeasureResponseTime false
1639 MeasureResponseCode false
1642 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1643 DSType "GaugeAverage"
1644 # Note: `stock_value' is not a standard type.
1651 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1652 a web page and one or more "matches" to be performed on the returned data. The
1653 string argument to the B<Page> block is used as plugin instance.
1655 The following options are valid within B<Page> blocks:
1659 =item B<Plugin> I<Plugin>
1661 Use I<Plugin> as the plugin name when submitting values.
1662 Defaults to C<curl>.
1666 URL of the web site to retrieve. Since a regular expression will be used to
1667 extract information from this data, non-binary data is a big plus here ;)
1669 =item B<User> I<Name>
1671 Username to use if authorization is required to read the page.
1673 =item B<Password> I<Password>
1675 Password to use if authorization is required to read the page.
1677 =item B<Digest> B<true>|B<false>
1679 Enable HTTP digest authentication.
1681 =item B<VerifyPeer> B<true>|B<false>
1683 Enable or disable peer SSL certificate verification. See
1684 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1686 =item B<VerifyHost> B<true>|B<false>
1688 Enable or disable peer host name verification. If enabled, the plugin checks if
1689 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1690 matches the host name provided by the B<URL> option. If this identity check
1691 fails, the connection is aborted. Obviously, only works when connecting to a
1692 SSL enabled server. Enabled by default.
1694 =item B<CACert> I<file>
1696 File that holds one or more SSL certificates. If you want to use HTTPS you will
1697 possibly need this option. What CA certificates come bundled with C<libcurl>
1698 and are checked by default depends on the distribution you use.
1700 =item B<Header> I<Header>
1702 A HTTP header to add to the request. Multiple headers are added if this option
1703 is specified more than once.
1705 =item B<Post> I<Body>
1707 Specifies that the HTTP operation should be a POST instead of a GET. The
1708 complete data to be posted is given as the argument. This option will usually
1709 need to be accompanied by a B<Header> option to set an appropriate
1710 C<Content-Type> for the post body (e.g. to
1711 C<application/x-www-form-urlencoded>).
1713 =item B<MeasureResponseTime> B<true>|B<false>
1715 Measure response time for the request. If this setting is enabled, B<Match>
1716 blocks (see below) are optional. Disabled by default.
1718 Beware that requests will get aborted if they take too long to complete. Adjust
1719 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1722 This option is similar to enabling the B<TotalTime> statistic but it's
1723 measured by collectd instead of cURL.
1725 =item B<MeasureResponseCode> B<true>|B<false>
1727 Measure response code for the request. If this setting is enabled, B<Match>
1728 blocks (see below) are optional. Disabled by default.
1730 =item B<E<lt>StatisticsE<gt>>
1732 One B<Statistics> block can be used to specify cURL statistics to be collected
1733 for each request to the remote web site. See the section "cURL Statistics"
1734 above for details. If this setting is enabled, B<Match> blocks (see below) are
1737 =item B<E<lt>MatchE<gt>>
1739 One or more B<Match> blocks that define how to match information in the data
1740 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1741 used by the C<tail> plugin, so please see the documentation of the C<tail>
1742 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1743 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1746 =item B<Timeout> I<Milliseconds>
1748 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1749 milliseconds. By default, the configured B<Interval> is used to set the
1750 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1751 indefinitely. This legacy behaviour can be achieved by setting the value of
1754 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1755 network connection will stall one read thread. Adjust the B<ReadThreads> global
1756 setting accordingly to prevent this from blocking other plugins.
1760 =head2 Plugin C<curl_json>
1762 The B<curl_json plugin> collects values from JSON data to be parsed by
1763 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1764 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1765 unix socket. The former can be used, for example, to collect values
1766 from CouchDB documents (which are stored JSON notation), and the
1767 latter to collect values from a uWSGI stats socket.
1769 The following example will collect several values from the built-in
1770 C<_stats> runtime statistics module of I<CouchDB>
1771 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1774 <URL "http://localhost:5984/_stats">
1776 <Key "httpd/requests/count">
1777 Type "http_requests"
1780 <Key "httpd_request_methods/*/count">
1781 Type "http_request_methods"
1784 <Key "httpd_status_codes/*/count">
1785 Type "http_response_codes"
1790 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1793 <Sock "/var/run/uwsgi.stats.sock">
1795 <Key "workers/*/requests">
1796 Type "http_requests"
1799 <Key "workers/*/apps/*/requests">
1800 Type "http_requests"
1805 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1806 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1807 blocks defining a unix socket to read JSON from directly. Each of
1808 these blocks may have one or more B<Key> blocks.
1810 The B<Key> string argument must be in a path format. Each component is
1811 used to match the key from a JSON map or the index of an JSON
1812 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1813 values for all map keys or array indices will be collectd.
1815 The following options are valid within B<URL> blocks:
1819 =item B<Host> I<Name>
1821 Use I<Name> as the host name when submitting values. Defaults to the global
1824 =item B<Plugin> I<Plugin>
1826 Use I<Plugin> as the plugin name when submitting values.
1827 Defaults to C<curl_json>.
1829 =item B<Instance> I<Instance>
1831 Sets the plugin instance to I<Instance>.
1833 =item B<Interval> I<Interval>
1835 Sets the interval (in seconds) in which the values will be collected from this
1836 URL. By default the global B<Interval> setting will be used.
1838 =item B<User> I<Name>
1840 =item B<Password> I<Password>
1842 =item B<Digest> B<true>|B<false>
1844 =item B<VerifyPeer> B<true>|B<false>
1846 =item B<VerifyHost> B<true>|B<false>
1848 =item B<CACert> I<file>
1850 =item B<Header> I<Header>
1852 =item B<Post> I<Body>
1854 =item B<Timeout> I<Milliseconds>
1856 These options behave exactly equivalent to the appropriate options of the
1857 I<cURL> plugin. Please see there for a detailed description.
1859 =item B<E<lt>StatisticsE<gt>>
1861 One B<Statistics> block can be used to specify cURL statistics to be collected
1862 for each request to the remote URL. See the section "cURL Statistics" above
1867 The following options are valid within B<Key> blocks:
1871 =item B<Type> I<Type>
1873 Sets the type used to dispatch the values to the daemon. Detailed information
1874 about types and their configuration can be found in L<types.db(5)>. This
1875 option is mandatory.
1877 =item B<Instance> I<Instance>
1879 Type-instance to use. Defaults to the current map key or current string array element value.
1883 =head2 Plugin C<curl_xml>
1885 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1886 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1889 <URL "http://localhost/stats.xml">
1892 Instance "some_instance"
1897 CACert "/path/to/ca.crt"
1898 Header "X-Custom-Header: foobar"
1901 <XPath "table[@id=\"magic_level\"]/tr">
1903 #InstancePrefix "prefix-"
1904 InstanceFrom "td[1]"
1905 #PluginInstanceFrom "td[1]"
1906 ValuesFrom "td[2]/span[@class=\"level\"]"
1911 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1912 URL to be fetched using libcurl. Within each B<URL> block there are
1913 options which specify the connection parameters, for example authentication
1914 information, and one or more B<XPath> blocks.
1916 Each B<XPath> block specifies how to get one type of information. The
1917 string argument must be a valid XPath expression which returns a list
1918 of "base elements". One value is dispatched for each "base element". The
1919 I<type instance> and values are looked up using further I<XPath> expressions
1920 that should be relative to the base element.
1922 Within the B<URL> block the following options are accepted:
1926 =item B<Host> I<Name>
1928 Use I<Name> as the host name when submitting values. Defaults to the global
1931 =item B<Plugin> I<Plugin>
1933 Use I<Plugin> as the plugin name when submitting values.
1934 Defaults to 'curl_xml'.
1936 =item B<Instance> I<Instance>
1938 Use I<Instance> as the plugin instance when submitting values.
1939 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
1940 Defaults to an empty string (no plugin instance).
1942 =item B<Namespace> I<Prefix> I<URL>
1944 If an XPath expression references namespaces, they must be specified
1945 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1946 I<URL> is the "namespace name", an URI reference uniquely identifying the
1947 namespace. The option can be repeated to register multiple namespaces.
1951 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1952 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1954 =item B<User> I<User>
1956 =item B<Password> I<Password>
1958 =item B<Digest> B<true>|B<false>
1960 =item B<VerifyPeer> B<true>|B<false>
1962 =item B<VerifyHost> B<true>|B<false>
1964 =item B<CACert> I<CA Cert File>
1966 =item B<Header> I<Header>
1968 =item B<Post> I<Body>
1970 =item B<Timeout> I<Milliseconds>
1972 These options behave exactly equivalent to the appropriate options of the
1973 I<cURL plugin>. Please see there for a detailed description.
1975 =item B<E<lt>StatisticsE<gt>>
1977 One B<Statistics> block can be used to specify cURL statistics to be collected
1978 for each request to the remote URL. See the section "cURL Statistics" above
1981 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1983 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1984 B<XPath> block specifies how to get one type of information. The string
1985 argument must be a valid XPath expression which returns a list of "base
1986 elements". One value is dispatched for each "base element".
1988 Within the B<XPath> block the following options are accepted:
1992 =item B<Type> I<Type>
1994 Specifies the I<Type> used for submitting patches. This determines the number
1995 of values that are required / expected and whether the strings are parsed as
1996 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1997 This option is required.
1999 =item B<InstancePrefix> I<InstancePrefix>
2001 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2002 concatenated together without any separator.
2003 This option is optional.
2005 =item B<InstanceFrom> I<InstanceFrom>
2007 Specifies a XPath expression to use for determining the I<type instance>. The
2008 XPath expression must return exactly one element. The element's value is then
2009 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2011 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2013 Specifies a XPath expression to use for determining the I<plugin instance>. The
2014 XPath expression must return exactly one element. The element's value is then
2015 used as I<plugin instance>.
2019 If the "base XPath expression" (the argument to the B<XPath> block) returns
2020 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2021 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2025 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2027 Specifies one or more XPath expression to use for reading the values. The
2028 number of XPath expressions must match the number of data sources in the
2029 I<type> specified with B<Type> (see above). Each XPath expression must return
2030 exactly one element. The element's value is then parsed as a number and used as
2031 value for the appropriate value in the value list dispatched to the daemon.
2032 This option is required.
2038 =head2 Plugin C<dbi>
2040 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2041 connect to various databases, execute I<SQL> statements and read back the
2042 results. I<dbi> is an acronym for "database interface" in case you were
2043 wondering about the name. You can configure how each column is to be
2044 interpreted and the plugin will generate one or more data sets from each row
2045 returned according to these rules.
2047 Because the plugin is very generic, the configuration is a little more complex
2048 than those of other plugins. It usually looks something like this:
2051 <Query "out_of_stock">
2052 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2053 # Use with MySQL 5.0.0 or later
2057 InstancePrefix "out_of_stock"
2058 InstancesFrom "category"
2062 <Database "product_information">
2066 DriverOption "host" "localhost"
2067 DriverOption "username" "collectd"
2068 DriverOption "password" "aZo6daiw"
2069 DriverOption "dbname" "prod_info"
2070 SelectDB "prod_info"
2071 Query "out_of_stock"
2075 The configuration above defines one query with one result and one database. The
2076 query is then linked to the database with the B<Query> option I<within> the
2077 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2078 and you can also use the B<Include> statement to split up the configuration
2079 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2080 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2083 The following is a complete list of options:
2085 =head3 B<Query> blocks
2087 Query blocks define I<SQL> statements and how the returned data should be
2088 interpreted. They are identified by the name that is given in the opening line
2089 of the block. Thus the name needs to be unique. Other than that, the name is
2090 not used in collectd.
2092 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2093 define which column holds which value or instance information. You can use
2094 multiple B<Result> blocks to create multiple values from one returned row. This
2095 is especially useful, when queries take a long time and sending almost the same
2096 query again and again is not desirable.
2100 <Query "environment">
2101 Statement "select station, temperature, humidity from environment"
2104 # InstancePrefix "foo"
2105 InstancesFrom "station"
2106 ValuesFrom "temperature"
2110 InstancesFrom "station"
2111 ValuesFrom "humidity"
2115 The following options are accepted:
2119 =item B<Statement> I<SQL>
2121 Sets the statement that should be executed on the server. This is B<not>
2122 interpreted by collectd, but simply passed to the database server. Therefore,
2123 the SQL dialect that's used depends on the server collectd is connected to.
2125 The query has to return at least two columns, one for the instance and one
2126 value. You cannot omit the instance, even if the statement is guaranteed to
2127 always return exactly one line. In that case, you can usually specify something
2130 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2132 (That works with MySQL but may not be valid SQL according to the spec. If you
2133 use a more strict database server, you may have to select from a dummy table or
2136 Please note that some databases, for example B<Oracle>, will fail if you
2137 include a semicolon at the end of the statement.
2139 =item B<MinVersion> I<Version>
2141 =item B<MaxVersion> I<Value>
2143 Only use this query for the specified database version. You can use these
2144 options to provide multiple queries with the same name but with a slightly
2145 different syntax. The plugin will use only those queries, where the specified
2146 minimum and maximum versions fit the version of the database in use.
2148 The database version is determined by C<dbi_conn_get_engine_version>, see the
2149 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2150 for details. Basically, each part of the version is assumed to be in the range
2151 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2152 "40102", version "5.0.42" becomes "50042".
2154 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2155 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2156 happen. Don't to it! A valid example would be something along these lines:
2167 In the above example, there are three ranges that don't overlap. The last one
2168 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2169 before "4.0.0" are not specified.
2171 =item B<Type> I<Type>
2173 The B<type> that's used for each line returned. See L<types.db(5)> for more
2174 details on how types are defined. In short: A type is a predefined layout of
2175 data and the number of values and type of values has to match the type
2178 If you specify "temperature" here, you need exactly one gauge column. If you
2179 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2182 There must be exactly one B<Type> option inside each B<Result> block.
2184 =item B<InstancePrefix> I<prefix>
2186 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2187 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2188 all strings returned in the appropriate columns are concatenated together,
2189 separated by dashes I<("-")>.
2191 =item B<InstancesFrom> I<column0> [I<column1> ...]
2193 Specifies the columns whose values will be used to create the "type-instance"
2194 for each row. If you specify more than one column, the value of all columns
2195 will be joined together with dashes I<("-")> as separation characters.
2197 The plugin itself does not check whether or not all built instances are
2198 different. It's your responsibility to assure that each is unique. This is
2199 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2200 sure that only one row is returned in this case.
2202 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2205 =item B<ValuesFrom> I<column0> [I<column1> ...]
2207 Names the columns whose content is used as the actual data for the data sets
2208 that are dispatched to the daemon. How many such columns you need is determined
2209 by the B<Type> setting above. If you specify too many or not enough columns,
2210 the plugin will complain about that and no data will be submitted to the
2213 The actual data type in the columns is not that important. The plugin will
2214 automatically cast the values to the right type if it know how to do that. So
2215 it should be able to handle integer an floating point types, as well as strings
2216 (if they include a number at the beginning).
2218 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2220 =item B<MetadataFrom> [I<column0> I<column1> ...]
2222 Names the columns whose content is used as metadata for the data sets
2223 that are dispatched to the daemon.
2225 The actual data type in the columns is not that important. The plugin will
2226 automatically cast the values to the right type if it know how to do that. So
2227 it should be able to handle integer an floating point types, as well as strings
2228 (if they include a number at the beginning).
2232 =head3 B<Database> blocks
2234 Database blocks define a connection to a database and which queries should be
2235 sent to that database. Since the used "dbi" library can handle a wide variety
2236 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2237 documentationE<nbsp>- we stick as close to the terminology used there.
2239 Each database needs a "name" as string argument in the starting tag of the
2240 block. This name will be used as "PluginInstance" in the values submitted to
2241 the daemon. Other than that, that name is not used.
2245 =item B<Plugin> I<Plugin>
2247 Use I<Plugin> as the plugin name when submitting query results from
2248 this B<Database>. Defaults to C<dbi>.
2250 =item B<Interval> I<Interval>
2252 Sets the interval (in seconds) in which the values will be collected from this
2253 database. By default the global B<Interval> setting will be used.
2255 =item B<Driver> I<Driver>
2257 Specifies the driver to use to connect to the database. In many cases those
2258 drivers are named after the database they can connect to, but this is not a
2259 technical necessity. These drivers are sometimes referred to as "DBD",
2260 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2261 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2262 project at L<http://libdbi-drivers.sourceforge.net/>.
2264 You need to give the driver name as expected by the "dbi" library here. You
2265 should be able to find that in the documentation for each driver. If you
2266 mistype the driver name, the plugin will dump a list of all known driver names
2269 =item B<DriverOption> I<Key> I<Value>
2271 Sets driver-specific options. What option a driver supports can be found in the
2272 documentation for each driver, somewhere at
2273 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2274 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2276 DBDs can register two types of options: String options and numeric options. The
2277 plugin will use the C<dbi_conn_set_option> function when the configuration
2278 provides a string and the C<dbi_conn_require_option_numeric> function when the
2279 configuration provides a number. So these two lines will actually result in
2280 different calls being used:
2282 DriverOption "Port" 1234 # numeric
2283 DriverOption "Port" "1234" # string
2285 Unfortunately, drivers are not too keen to report errors when an unknown option
2286 is passed to them, so invalid settings here may go unnoticed. This is not the
2287 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2288 the driver. If a driver complains about an option, the plugin will dump a
2289 complete list of all options understood by that driver to the log. There is no
2290 way to programmatically find out if an option expects a string or a numeric
2291 argument, so you will have to refer to the appropriate DBD's documentation to
2292 find this out. Sorry.
2294 =item B<SelectDB> I<Database>
2296 In some cases, the database name you connect with is not the database name you
2297 want to use for querying data. If this option is set, the plugin will "select"
2298 (switch to) that database after the connection is established.
2300 =item B<Query> I<QueryName>
2302 Associates the query named I<QueryName> with this database connection. The
2303 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2304 blocks you want to refer to must be placed above the database block you want to
2307 =item B<Host> I<Hostname>
2309 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2310 values. Defaults to the global hostname setting.
2318 =item B<Device> I<Device>
2320 Select partitions based on the devicename.
2322 See F</"IGNORELISTS"> for details.
2324 =item B<MountPoint> I<Directory>
2326 Select partitions based on the mountpoint.
2328 See F</"IGNORELISTS"> for details.
2330 =item B<FSType> I<FSType>
2332 Select partitions based on the filesystem type.
2334 See F</"IGNORELISTS"> for details.
2336 =item B<IgnoreSelected> B<true>|B<false>
2338 Invert the selection: If set to true, all partitions B<except> the ones that
2339 match any one of the criteria are collected. By default only selected
2340 partitions are collected if a selection is made. If no selection is configured
2341 at all, B<all> partitions are selected.
2343 =item B<ReportByDevice> B<true>|B<false>
2345 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2346 (the default), it will report a disk as "root", but with it I<true>, it will be
2347 "sda1" (or whichever).
2349 =item B<ReportInodes> B<true>|B<false>
2351 Enables or disables reporting of free, reserved and used inodes. Defaults to
2352 inode collection being disabled.
2354 Enable this option if inodes are a scarce resource for you, usually because
2355 many small files are stored on the disk. This is a usual scenario for mail
2356 transfer agents and web caches.
2358 =item B<ValuesAbsolute> B<true>|B<false>
2360 Enables or disables reporting of free and used disk space in 1K-blocks.
2361 Defaults to B<true>.
2363 =item B<ValuesPercentage> B<false>|B<true>
2365 Enables or disables reporting of free and used disk space in percentage.
2366 Defaults to B<false>.
2368 This is useful for deploying I<collectd> on the cloud, where machines with
2369 different disk size may exist. Then it is more practical to configure
2370 thresholds based on relative disk size.
2374 =head2 Plugin C<disk>
2376 The C<disk> plugin collects information about the usage of physical disks and
2377 logical disks (partitions). Values collected are the number of octets written
2378 to and read from a disk or partition, the number of read/write operations
2379 issued to the disk and a rather complex "time" it took for these commands to be
2382 Using the following two options you can ignore some disks or configure the
2383 collection only of specific disks.
2387 =item B<Disk> I<Name>
2389 Select the disk I<Name>. Whether it is collected or ignored depends on the
2390 B<IgnoreSelected> setting, see below. As with other plugins that use the
2391 daemon's ignorelist functionality, a string that starts and ends with a slash
2392 is interpreted as a regular expression. Examples:
2397 See F</"IGNORELISTS"> for details.
2399 =item B<IgnoreSelected> B<true>|B<false>
2401 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2402 statements, are ignored or if all other disks are ignored. The behavior
2403 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2404 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2405 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2406 is set to B<true>, all disks are collected B<except> the ones matched.
2408 =item B<UseBSDName> B<true>|B<false>
2410 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2411 default major/minor numbers. Requires collectd to be built with Apple's
2414 =item B<UdevNameAttr> I<Attribute>
2416 Attempt to override disk instance name with the value of a specified udev
2417 attribute when built with B<libudev>. If the attribute is not defined for the
2418 given device, the default name is used. Example:
2420 UdevNameAttr "DM_NAME"
2424 =head2 Plugin C<dns>
2428 =item B<Interface> I<Interface>
2430 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2431 option sets the interface that should be used. If this option is not set, or
2432 set to "any", the plugin will try to get packets from B<all> interfaces. This
2433 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2435 =item B<IgnoreSource> I<IP-address>
2437 Ignore packets that originate from this address.
2439 =item B<SelectNumericQueryTypes> B<true>|B<false>
2441 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2445 =head2 Plugin C<dpdkevents>
2447 The I<dpdkevents plugin> collects events from DPDK such as link status of
2448 network ports and Keep Alive status of DPDK logical cores.
2449 In order to get Keep Alive events following requirements must be met:
2451 - support for Keep Alive implemented in DPDK application. More details can
2452 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2456 <Plugin "dpdkevents">
2462 <Event "link_status">
2463 SendEventsOnUpdate true
2464 EnabledPortMask 0xffff
2465 PortName "interface1"
2466 PortName "interface2"
2467 SendNotification false
2469 <Event "keep_alive">
2470 SendEventsOnUpdate true
2472 KeepAliveShmName "/dpdk_keepalive_shm_name"
2473 SendNotification false
2480 =head3 The EAL block
2484 =item B<Coremask> I<Mask>
2486 =item B<Memorychannels> I<Channels>
2488 Number of memory channels per processor socket.
2490 =item B<FilePrefix> I<File>
2492 The prefix text used for hugepage filenames. The filename will be set to
2493 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2497 =head3 The Event block
2499 The B<Event> block defines configuration for specific event. It accepts a
2500 single argument which specifies the name of the event.
2502 =head4 Link Status event
2506 =item B<SendEventOnUpdate> I<true|false>
2508 If set to true link status value will be dispatched only when it is
2509 different from previously read value. This is an optional argument - default
2512 =item B<EnabledPortMask> I<Mask>
2514 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2515 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2516 that all ports will be enabled. This is an optional argument - by default
2517 all ports are enabled.
2519 =item B<PortName> I<Name>
2521 A string containing an optional name for the enabled DPDK ports. Each PortName
2522 option should contain only one port name; specify as many PortName options as
2523 desired. Default naming convention will be used if PortName is blank. If there
2524 are less PortName options than there are enabled ports, the default naming
2525 convention will be used for the additional ports.
2527 =item B<SendNotification> I<true|false>
2529 If set to true, link status notifications are sent, instead of link status
2530 being collected as a statistic. This is an optional argument - default
2535 =head4 Keep Alive event
2539 =item B<SendEventOnUpdate> I<true|false>
2541 If set to true keep alive value will be dispatched only when it is
2542 different from previously read value. This is an optional argument - default
2545 =item B<LCoreMask> I<Mask>
2547 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2549 =item B<KeepAliveShmName> I<Name>
2551 Shared memory name identifier that is used by secondary process to monitor
2552 the keep alive cores state.
2554 =item B<SendNotification> I<true|false>
2556 If set to true, keep alive notifications are sent, instead of keep alive
2557 information being collected as a statistic. This is an optional
2558 argument - default value is false.
2562 =head2 Plugin C<dpdkstat>
2564 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2565 extended NIC stats API in DPDK.
2576 RteDriverLibPath "/usr/lib/dpdk-pmd"
2578 SharedMemObj "dpdk_collectd_stats_0"
2579 EnabledPortMask 0xffff
2580 PortName "interface1"
2581 PortName "interface2"
2586 =head3 The EAL block
2590 =item B<Coremask> I<Mask>
2592 A string containing an hexadecimal bit mask of the cores to run on. Note that
2593 core numbering can change between platforms and should be determined beforehand.
2595 =item B<Memorychannels> I<Channels>
2597 A string containing a number of memory channels per processor socket.
2599 =item B<FilePrefix> I<File>
2601 The prefix text used for hugepage filenames. The filename will be set to
2602 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2604 =item B<SocketMemory> I<MB>
2606 A string containing amount of Memory to allocate from hugepages on specific
2607 sockets in MB. This is an optional value.
2609 =item B<LogLevel> I<LogLevel_number>
2611 A string containing log level number. This parameter is optional.
2612 If parameter is not present then default value "7" - (INFO) is used.
2613 Value "8" - (DEBUG) can be set to enable debug traces.
2615 =item B<RteDriverLibPath> I<Path>
2617 A string containing path to shared pmd driver lib or path to directory,
2618 where shared pmd driver libs are available. This parameter is optional.
2619 This parameter enable loading of shared pmd driver libs from defined path.
2620 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2621 or "/usr/lib/dpdk-pmd"
2627 =item B<SharedMemObj> I<Mask>
2629 A string containing the name of the shared memory object that should be used to
2630 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2631 Defaults to dpdk_collectd_stats if no other value is configured.
2633 =item B<EnabledPortMask> I<Mask>
2635 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2636 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2637 that all ports will be enabled. This is an optional argument - default
2638 is all ports enabled.
2640 =item B<PortName> I<Name>
2642 A string containing an optional name for the enabled DPDK ports. Each PortName
2643 option should contain only one port name; specify as many PortName options as
2644 desired. Default naming convention will be used if PortName is blank. If there
2645 are less PortName options than there are enabled ports, the default naming
2646 convention will be used for the additional ports.
2650 =head2 Plugin C<email>
2654 =item B<SocketFile> I<Path>
2656 Sets the socket-file which is to be created.
2658 =item B<SocketGroup> I<Group>
2660 If running as root change the group of the UNIX-socket after it has been
2661 created. Defaults to B<collectd>.
2663 =item B<SocketPerms> I<Permissions>
2665 Change the file permissions of the UNIX-socket after it has been created. The
2666 permissions must be given as a numeric, octal value as you would pass to
2667 L<chmod(1)>. Defaults to B<0770>.
2669 =item B<MaxConns> I<Number>
2671 Sets the maximum number of connections that can be handled in parallel. Since
2672 this many threads will be started immediately setting this to a very high
2673 value will waste valuable resources. Defaults to B<5> and will be forced to be
2674 at most B<16384> to prevent typos and dumb mistakes.
2678 =head2 Plugin C<ethstat>
2680 The I<ethstat plugin> collects information about network interface cards (NICs)
2681 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2687 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2688 Map "multicast" "if_multicast"
2695 =item B<Interface> I<Name>
2697 Collect statistical information about interface I<Name>.
2699 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2701 By default, the plugin will submit values as type C<derive> and I<type
2702 instance> set to I<Name>, the name of the metric as reported by the driver. If
2703 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2704 I<TypeInstance> will be used.
2706 =item B<MappedOnly> B<true>|B<false>
2708 When set to B<true>, only metrics that can be mapped to a I<type> will be
2709 collected, all other metrics will be ignored. Defaults to B<false>.
2713 =head2 Plugin C<exec>
2715 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2716 contains valuable information on when the executable is executed and the
2717 output that is expected from it.
2721 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2723 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2725 Execute the executable I<Executable> as user I<User>. If the user name is
2726 followed by a colon and a group name, the effective group is set to that group.
2727 The real group and saved-set group will be set to the default group of that
2728 user. If no group is given the effective group ID will be the same as the real
2731 Please note that in order to change the user and/or group the daemon needs
2732 superuser privileges. If the daemon is run as an unprivileged user you must
2733 specify the same user/group here. If the daemon is run with superuser
2734 privileges, you must supply a non-root user here.
2736 The executable may be followed by optional arguments that are passed to the
2737 program. Please note that due to the configuration parsing numbers and boolean
2738 values may be changed. If you want to be absolutely sure that something is
2739 passed as-is please enclose it in quotes.
2741 The B<Exec> and B<NotificationExec> statements change the semantics of the
2742 programs executed, i.E<nbsp>e. the data passed to them and the response
2743 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2747 =head2 Plugin C<fhcount>
2749 The C<fhcount> plugin provides statistics about used, unused and total number of
2750 file handles on Linux.
2752 The I<fhcount plugin> provides the following configuration options:
2756 =item B<ValuesAbsolute> B<true>|B<false>
2758 Enables or disables reporting of file handles usage in absolute numbers,
2759 e.g. file handles used. Defaults to B<true>.
2761 =item B<ValuesPercentage> B<false>|B<true>
2763 Enables or disables reporting of file handles usage in percentages, e.g.
2764 percent of file handles used. Defaults to B<false>.
2768 =head2 Plugin C<filecount>
2770 The C<filecount> plugin counts the number of files in a certain directory (and
2771 its subdirectories) and their combined size. The configuration is very straight
2774 <Plugin "filecount">
2775 <Directory "/var/qmail/queue/mess">
2776 Instance "qmail-message"
2778 <Directory "/var/qmail/queue/todo">
2779 Instance "qmail-todo"
2781 <Directory "/var/lib/php5">
2782 Instance "php5-sessions"
2787 The example above counts the number of files in QMail's queue directories and
2788 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2789 QMail has not yet looked at, the "message" queue holds the messages that were
2790 classified into "local" and "remote".
2792 As you can see, the configuration consists of one or more C<Directory> blocks,
2793 each of which specifies a directory in which to count the files. Within those
2794 blocks, the following options are recognized:
2798 =item B<Plugin> I<Plugin>
2800 Use I<Plugin> as the plugin name when submitting values.
2801 Defaults to B<filecount>.
2803 =item B<Instance> I<Instance>
2805 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2806 the directory name with all slashes replaced by underscores and all leading
2807 underscores removed. Empty value is allowed.
2809 =item B<Name> I<Pattern>
2811 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2812 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2813 against the pattern, not the entire path. In case this makes it easier for you:
2814 This option has been named after the B<-name> parameter to L<find(1)>.
2816 =item B<MTime> I<Age>
2818 Count only files of a specific age: If I<Age> is greater than zero, only files
2819 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2820 a negative number, this is inversed. For example, if B<-60> is specified, only
2821 files that have been modified in the last minute will be counted.
2823 The number can also be followed by a "multiplier" to easily specify a larger
2824 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2825 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2826 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2827 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2828 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2831 =item B<Size> I<Size>
2833 Count only files of a specific size. When I<Size> is a positive number, only
2834 files that are at least this big are counted. If I<Size> is a negative number,
2835 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2836 I<Size> are counted.
2838 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2839 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2840 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2841 note that there are 1000 bytes in a kilobyte, not 1024.
2843 =item B<Recursive> I<true>|I<false>
2845 Controls whether or not to recurse into subdirectories. Enabled by default.
2847 =item B<IncludeHidden> I<true>|I<false>
2849 Controls whether or not to include "hidden" files and directories in the count.
2850 "Hidden" files and directories are those, whose name begins with a dot.
2851 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2853 =item B<RegularOnly> I<true>|I<false>
2855 Controls whether or not to include only regular files in the count.
2856 Defaults to I<true>, i.e. by default non regular files are ignored.
2858 =item B<FilesSizeType> I<Type>
2860 Sets the type used to dispatch files combined size. Empty value ("") disables
2861 reporting. Defaults to B<bytes>.
2863 =item B<FilesCountType> I<Type>
2865 Sets the type used to dispatch number of files. Empty value ("") disables
2866 reporting. Defaults to B<files>.
2868 =item B<TypeInstance> I<Instance>
2870 Sets the I<type instance> used to dispatch values. Defaults to an empty string
2871 (no plugin instance).
2875 =head2 Plugin C<GenericJMX>
2877 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2878 L<collectd-java(5)>.
2880 =head2 Plugin C<gmond>
2882 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2883 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2884 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2889 MCReceiveFrom "239.2.11.71" "8649"
2890 <Metric "swap_total">
2892 TypeInstance "total"
2895 <Metric "swap_free">
2902 The following metrics are built-in:
2908 load_one, load_five, load_fifteen
2912 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2916 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2928 Available configuration options:
2932 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2934 Sets sets the multicast group and UDP port to which to subscribe.
2936 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2938 =item E<lt>B<Metric> I<Name>E<gt>
2940 These blocks add a new metric conversion to the internal table. I<Name>, the
2941 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2945 =item B<Type> I<Type>
2947 Type to map this metric to. Required.
2949 =item B<TypeInstance> I<Instance>
2951 Type-instance to use. Optional.
2953 =item B<DataSource> I<Name>
2955 Data source to map this metric to. If the configured type has exactly one data
2956 source, this is optional. Otherwise the option is required.
2962 =head2 Plugin C<gps>
2964 The C<gps plugin> connects to gpsd on the host machine.
2965 The host, port, timeout and pause are configurable.
2967 This is useful if you run an NTP server using a GPS for source and you want to
2970 Mind your GPS must send $--GSA for having the data reported!
2972 The following elements are collected:
2978 Number of satellites used for fix (type instance "used") and in view (type
2979 instance "visible"). 0 means no GPS satellites are visible.
2981 =item B<dilution_of_precision>
2983 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2984 It should be between 0 and 3.
2985 Look at the documentation of your GPS to know more.
2993 # Connect to localhost on gpsd regular port:
2998 # PauseConnect of 5 sec. between connection attempts.
3002 Available configuration options:
3006 =item B<Host> I<Host>
3008 The host on which gpsd daemon runs. Defaults to B<localhost>.
3010 =item B<Port> I<Port>
3012 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3014 =item B<Timeout> I<Seconds>
3016 Timeout in seconds (default 0.015 sec).
3018 The GPS data stream is fetch by the plugin form the daemon.
3019 It waits for data to be available, if none arrives it times out
3020 and loop for another reading.
3021 Mind to put a low value gpsd expects value in the micro-seconds area
3022 (recommended is 500 us) since the waiting function is blocking.
3023 Value must be between 500 us and 5 sec., if outside that range the
3024 default value is applied.
3026 This only applies from gpsd release-2.95.
3028 =item B<PauseConnect> I<Seconds>
3030 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3034 =head2 Plugin C<grpc>
3036 The I<grpc> plugin provides an RPC interface to submit values to or query
3037 values from collectd based on the open source gRPC framework. It exposes an
3038 end-point for dispatching values to the daemon.
3040 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3044 =item B<Server> I<Host> I<Port>
3046 The B<Server> statement sets the address of a server to which to send metrics
3047 via the C<DispatchValues> function.
3049 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3051 Optionally, B<Server> may be specified as a configuration block which supports
3052 the following options:
3056 =item B<EnableSSL> B<false>|B<true>
3058 Whether to require SSL for outgoing connections. Default: false.
3060 =item B<SSLCACertificateFile> I<Filename>
3062 =item B<SSLCertificateFile> I<Filename>
3064 =item B<SSLCertificateKeyFile> I<Filename>
3066 Filenames specifying SSL certificate and key material to be used with SSL
3071 =item B<Listen> I<Host> I<Port>
3073 The B<Listen> statement sets the network address to bind to. When multiple
3074 statements are specified, the daemon will bind to all of them. If none are
3075 specified, it defaults to B<0.0.0.0:50051>.
3077 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3079 Optionally, B<Listen> may be specified as a configuration block which
3080 supports the following options:
3084 =item B<EnableSSL> I<true>|I<false>
3086 Whether to enable SSL for incoming connections. Default: false.
3088 =item B<SSLCACertificateFile> I<Filename>
3090 =item B<SSLCertificateFile> I<Filename>
3092 =item B<SSLCertificateKeyFile> I<Filename>
3094 Filenames specifying SSL certificate and key material to be used with SSL
3097 =item B<VerifyPeer> B<true>|B<false>
3099 When enabled, a valid client certificate is required to connect to the server.
3100 When disabled, a client certifiacte is not requested and any unsolicited client
3101 certificate is accepted.
3108 =head2 Plugin C<hddtemp>
3110 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3111 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3112 default values, see below. C<hddtemp> has to be running to work correctly. If
3113 C<hddtemp> is not running timeouts may appear which may interfere with other
3116 The B<hddtemp> homepage can be found at
3117 L<http://www.guzu.net/linux/hddtemp.php>.
3121 =item B<Host> I<Hostname>
3123 Hostname to connect to. Defaults to B<127.0.0.1>.
3125 =item B<Port> I<Port>
3127 TCP-Port to connect to. Defaults to B<7634>.
3131 =head2 Plugin C<hugepages>
3133 To collect B<hugepages> information, collectd reads directories
3134 "/sys/devices/system/node/*/hugepages" and
3135 "/sys/kernel/mm/hugepages".
3136 Reading of these directories can be disabled by the following
3137 options (default is enabled).
3141 =item B<ReportPerNodeHP> B<true>|B<false>
3143 If enabled, information will be collected from the hugepage
3144 counters in "/sys/devices/system/node/*/hugepages".
3145 This is used to check the per-node hugepage statistics on
3148 =item B<ReportRootHP> B<true>|B<false>
3150 If enabled, information will be collected from the hugepage
3151 counters in "/sys/kernel/mm/hugepages".
3152 This can be used on both NUMA and non-NUMA systems to check
3153 the overall hugepage statistics.
3155 =item B<ValuesPages> B<true>|B<false>
3157 Whether to report hugepages metrics in number of pages.
3158 Defaults to B<true>.
3160 =item B<ValuesBytes> B<false>|B<true>
3162 Whether to report hugepages metrics in bytes.
3163 Defaults to B<false>.
3165 =item B<ValuesPercentage> B<false>|B<true>
3167 Whether to report hugepages metrics as percentage.
3168 Defaults to B<false>.
3172 =head2 Plugin C<intel_pmu>
3174 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3175 Linux perf interface. All events are reported on a per core basis.
3180 ReportHardwareCacheEvents true
3181 ReportKernelPMUEvents true
3182 ReportSoftwareEvents true
3183 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3184 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3185 Cores "0-3" "4,6" "[12-15]"
3192 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3194 Enable or disable measuring of hardware CPU cache events:
3196 - L1-dcache-load-misses
3198 - L1-dcache-store-misses
3199 - L1-dcache-prefetches
3200 - L1-dcache-prefetch-misses
3202 - L1-icache-load-misses
3203 - L1-icache-prefetches
3204 - L1-icache-prefetch-misses
3210 - LLC-prefetch-misses
3216 - dTLB-prefetch-misses
3220 - branch-load-misses
3222 =item B<ReportKernelPMUEvents> B<false>|B<true>
3224 Enable or disable measuring of the following events:
3233 =item B<ReportSoftwareEvents> B<false>|B<true>
3235 Enable or disable measuring of software events provided by kernel:
3246 =item B<EventList> I<filename>
3248 JSON performance counter event list file name. To be able to monitor all Intel
3249 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3250 event_download.py script to download event list for current CPU.
3252 =item B<HardwareEvents> I<events>
3254 This field is a list of event names or groups of comma separated event names.
3255 This option requires B<EventList> option to be configured.
3257 =item B<Cores> I<cores groups>
3259 All events are reported on a per core basis. Monitoring of the events can be
3260 configured for a group of cores (aggregated statistics). This field defines
3261 groups of cores on which to monitor supported events. The field is represented
3262 as list of strings with core group values. Each string represents a list of
3263 cores in a group. If a group is enclosed in square brackets each core is added
3264 individually to a separate group (that is statistics are not aggregated).
3265 Allowed formats are:
3271 If an empty string is provided as value for this field default cores
3272 configuration is applied - that is separate group is created for each core.
3276 =head2 Plugin C<intel_rdt>
3278 The I<intel_rdt> plugin collects information provided by monitoring features of
3279 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3280 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3281 information about utilization of shared resources. CMT monitors last level cache
3282 occupancy (LLC). MBM supports two types of events reporting local and remote
3283 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3284 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3285 reports the bandwidth of accessing the remote socket. Also this technology
3286 allows to monitor instructions per clock (IPC).
3287 Monitor events are hardware dependant. Monitoring capabilities are detected on
3288 plugin initialization and only supported events are monitored.
3290 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3291 require an additional capability to be enabled if collectd is run as a service.
3292 Please refer to I<contrib/systemd.collectd.service> file for more details.
3296 <Plugin "intel_rdt">
3297 Cores "0-2" "3,4,6" "8-10,15"
3304 =item B<Interval> I<seconds>
3306 The interval within which to retrieve statistics on monitored events in seconds.
3307 For milliseconds divide the time by 1000 for example if the desired interval
3308 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3309 recommended to set interval higher than 1 sec.
3311 =item B<Cores> I<cores groups>
3313 All events are reported on a per core basis. Monitoring of the events can be
3314 configured for group of cores (aggregated statistics). This field defines groups
3315 of cores on which to monitor supported events. The field is represented as list
3316 of strings with core group values. Each string represents a list of cores in a
3317 group. Allowed formats are:
3322 If an empty string is provided as value for this field default cores
3323 configuration is applied - a separate group is created for each core.
3327 B<Note:> By default global interval is used to retrieve statistics on monitored
3328 events. To configure a plugin specific interval use B<Interval> option of the
3329 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3330 example if the desired interval is 50ms, set interval to 0.05.
3331 Due to limited capacity of counters it is not recommended to set interval higher
3334 =head2 Plugin C<interface>
3338 =item B<Interface> I<Interface>
3340 Select this interface. By default these interfaces will then be collected. For
3341 a more detailed description see B<IgnoreSelected> below.
3343 See F</"IGNORELISTS"> for details.
3345 =item B<IgnoreSelected> I<true>|I<false>
3347 If no configuration is given, the B<interface>-plugin will collect data from
3348 all interfaces. This may not be practical, especially for loopback- and
3349 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3350 interfaces you're interested in. Sometimes, however, it's easier/preferred
3351 to collect all interfaces I<except> a few ones. This option enables you to
3352 do that: By setting B<IgnoreSelected> to I<true> the effect of
3353 B<Interface> is inverted: All selected interfaces are ignored and all
3354 other interfaces are collected.
3356 It is possible to use regular expressions to match interface names, if the
3357 name is surrounded by I</.../> and collectd was compiled with support for
3358 regexps. This is useful if there's a need to collect (or ignore) data
3359 for a group of interfaces that are similarly named, without the need to
3360 explicitly list all of them (especially useful if the list is dynamic).
3365 Interface "/^tun[0-9]+/"
3366 IgnoreSelected "true"
3368 This will ignore the loopback interface, all interfaces with names starting
3369 with I<veth> and all interfaces with names starting with I<tun> followed by
3372 =item B<ReportInactive> I<true>|I<false>
3374 When set to I<false>, only interfaces with non-zero traffic will be
3375 reported. Note that the check is done by looking into whether a
3376 package was sent at any time from boot and the corresponding counter
3377 is non-zero. So, if the interface has been sending data in the past
3378 since boot, but not during the reported time-interval, it will still
3381 The default value is I<true> and results in collection of the data
3382 from all interfaces that are selected by B<Interface> and
3383 B<IgnoreSelected> options.
3385 =item B<UniqueName> I<true>|I<false>
3387 Interface name is not unique on Solaris (KSTAT), interface name is unique
3388 only within a module/instance. Following tuple is considered unique:
3389 (ks_module, ks_instance, ks_name)
3390 If this option is set to true, interface name contains above three fields
3391 separated by an underscore. For more info on KSTAT, visit
3392 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3394 This option is only available on Solaris.
3398 =head2 Plugin C<ipmi>
3400 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3401 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3403 The plugin configuration consists of one or more B<Instance> blocks which
3404 specify one I<ipmi> connection each. Each block requires one unique string
3405 argument as the instance name. If instances are not configured, an instance with
3406 the default option values will be created.
3408 For backwards compatibility, any option other than B<Instance> block will trigger
3409 legacy config handling and it will be treated as an option within B<Instance>
3410 block. This support will go away in the next major version of Collectd.
3412 Within the B<Instance> blocks, the following options are allowed:
3416 =item B<Address> I<Address>
3418 Hostname or IP to connect to. If not specified, plugin will try to connect to
3419 local management controller (BMC).
3421 =item B<Username> I<Username>
3423 =item B<Password> I<Password>
3425 The username and the password to use for the connection to remote BMC.
3427 =item B<AuthType> I<MD5>|I<rmcp+>
3429 Forces the authentication type to use for the connection to remote BMC.
3430 By default most secure type is seleted.
3432 =item B<Host> I<Hostname>
3434 Sets the B<host> field of dispatched values. Defaults to the global hostname
3437 =item B<Sensor> I<Sensor>
3439 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3441 See F</"IGNORELISTS"> for details.
3443 =item B<IgnoreSelected> I<true>|I<false>
3445 If no configuration if given, the B<ipmi> plugin will collect data from all
3446 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3447 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3448 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3449 all other sensors are collected.
3451 =item B<NotifySensorAdd> I<true>|I<false>
3453 If a sensor appears after initialization time of a minute a notification
3456 =item B<NotifySensorRemove> I<true>|I<false>
3458 If a sensor disappears a notification is sent.
3460 =item B<NotifySensorNotPresent> I<true>|I<false>
3462 If you have for example dual power supply and one of them is (un)plugged then
3463 a notification is sent.
3465 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3467 If a IPMI connection state changes after initialization time of a minute
3468 a notification is sent. Defaults to B<false>.
3470 =item B<SELEnabled> I<true>|I<false>
3472 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3473 and discrete events. When event is received the notification is sent.
3474 Defaults to B<false>.
3476 =item B<SELClearEvent> I<true>|I<false>
3478 If SEL clear event is enabled, plugin will delete event from SEL list after
3479 it is received and successfully handled. In this case other tools that are
3480 subscribed for SEL events will receive an empty event.
3481 Defaults to B<false>.
3485 =head2 Plugin C<iptables>
3489 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3491 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3493 Select the iptables/ip6tables filter rules to count packets and bytes from.
3495 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3496 of all rules which have a comment-match. The comment is then used as
3499 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3500 the I<n>th rule will be collected. Again, the comment (or the number) will be
3501 used as the type-instance.
3503 If I<Name> is supplied, it will be used as the type-instance instead of the
3504 comment or the number.
3508 =head2 Plugin C<irq>
3514 Select this irq. By default these irqs will then be collected. For a more
3515 detailed description see B<IgnoreSelected> below.
3517 See F</"IGNORELISTS"> for details.
3519 =item B<IgnoreSelected> I<true>|I<false>
3521 If no configuration if given, the B<irq>-plugin will collect data from all
3522 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3523 can use the B<Irq>-option to pick the interrupt you're interested in.
3524 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3525 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3526 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3527 and all other interrupts are collected.
3531 =head2 Plugin C<java>
3533 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3534 This section only discusses the syntax and semantic of the configuration
3535 options. For more in-depth information on the I<Java> plugin, please read
3536 L<collectd-java(5)>.
3541 JVMArg "-verbose:jni"
3542 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3543 LoadPlugin "org.collectd.java.Foobar"
3544 <Plugin "org.collectd.java.Foobar">
3545 # To be parsed by the plugin
3549 Available configuration options:
3553 =item B<JVMArg> I<Argument>
3555 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3556 exactly the way the arguments to the I<java> binary on the command line work.
3557 Execute C<javaE<nbsp>--help> for details.
3559 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3560 any other options! When another option is found, the JVM will be started and
3561 later options will have to be ignored!
3563 =item B<LoadPlugin> I<JavaClass>
3565 Instantiates a new I<JavaClass> object. The constructor of this object very
3566 likely then registers one or more callback methods with the server.
3568 See L<collectd-java(5)> for details.
3570 When the first such option is found, the virtual machine (JVM) is created. This
3571 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3572 B<LoadPlugin> options!
3574 =item B<Plugin> I<Name>
3576 The entire block is passed to the Java plugin as an
3577 I<org.collectd.api.OConfigItem> object.
3579 For this to work, the plugin has to register a configuration callback first,
3580 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3581 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3582 depends on the (Java) plugin registering the callback and is completely
3583 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3587 =head2 Plugin C<load>
3589 The I<Load plugin> collects the system load. These numbers give a rough overview
3590 over the utilization of a machine. The system load is defined as the number of
3591 runnable tasks in the run-queue and is provided by many operating systems as a
3592 one, five or fifteen minute average.
3594 The following configuration options are available:
3598 =item B<ReportRelative> B<false>|B<true>
3600 When enabled, system load divided by number of available CPU cores is reported
3601 for intervals 1 min, 5 min and 15 min. Defaults to false.
3606 =head2 Plugin C<logfile>
3610 =item B<LogLevel> B<debug|info|notice|warning|err>
3612 Sets the log-level. If, for example, set to B<notice>, then all events with
3613 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3615 Please note that B<debug> is only available if collectd has been compiled with
3618 =item B<File> I<File>
3620 Sets the file to write log messages to. The special strings B<stdout> and
3621 B<stderr> can be used to write to the standard output and standard error
3622 channels, respectively. This, of course, only makes much sense when I<collectd>
3623 is running in foreground- or non-daemon-mode.
3625 =item B<Timestamp> B<true>|B<false>
3627 Prefix all lines printed by the current time. Defaults to B<true>.
3629 =item B<PrintSeverity> B<true>|B<false>
3631 When enabled, all lines are prefixed by the severity of the log message, for
3632 example "warning". Defaults to B<false>.
3636 B<Note>: There is no need to notify the daemon after moving or removing the
3637 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3638 for each line it writes.
3640 =head2 Plugin C<log_logstash>
3642 The I<log logstash plugin> behaves like the logfile plugin but formats
3643 messages as JSON events for logstash to parse and input.
3647 =item B<LogLevel> B<debug|info|notice|warning|err>
3649 Sets the log-level. If, for example, set to B<notice>, then all events with
3650 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3652 Please note that B<debug> is only available if collectd has been compiled with
3655 =item B<File> I<File>
3657 Sets the file to write log messages to. The special strings B<stdout> and
3658 B<stderr> can be used to write to the standard output and standard error
3659 channels, respectively. This, of course, only makes much sense when I<collectd>
3660 is running in foreground- or non-daemon-mode.
3664 B<Note>: There is no need to notify the daemon after moving or removing the
3665 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3666 for each line it writes.
3668 =head2 Plugin C<lpar>
3670 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3671 virtualization technique for IBM POWER processors. It takes into account CPU
3672 time stolen from or donated to a partition, in addition to the usual user,
3673 system, I/O statistics.
3675 The following configuration options are available:
3679 =item B<CpuPoolStats> B<false>|B<true>
3681 When enabled, statistics about the processor pool are read, too. The partition
3682 needs to have pool authority in order to be able to acquire this information.
3685 =item B<ReportBySerial> B<false>|B<true>
3687 If enabled, the serial of the physical machine the partition is currently
3688 running on is reported as I<hostname> and the logical hostname of the machine
3689 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3690 used (just like other plugins) and the I<plugin instance> will be empty.
3695 =head2 Plugin C<lua>
3697 This plugin embeds a Lua interpreter into collectd and provides an interface
3698 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3701 =head2 Plugin C<mbmon>
3703 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3705 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3706 B<Host> and B<Port> options can be used to change these values, see below.
3707 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3708 timeouts may appear which may interfere with other statistics..
3710 C<mbmon> must be run with the -r option ("print TAG and Value format");
3711 Debian's F</etc/init.d/mbmon> script already does this, other people
3712 will need to ensure that this is the case.
3716 =item B<Host> I<Hostname>
3718 Hostname to connect to. Defaults to B<127.0.0.1>.
3720 =item B<Port> I<Port>
3722 TCP-Port to connect to. Defaults to B<411>.
3726 =head2 Plugin C<mcelog>
3728 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3730 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3731 mcelog server is running. When the server is running, the plugin will tail the
3732 specified logfile to retrieve machine check exception information and send a
3733 notification with the details from the logfile. The plugin will use the mcelog
3734 client protocol to retrieve memory related machine check exceptions. Note that
3735 for memory exceptions, notifications are only sent when there is a change in
3736 the number of corrected/uncorrected memory errors.
3738 =head3 The Memory block
3740 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3745 =item B<McelogClientSocket> I<Path>
3746 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3747 Defaults to B<"/var/run/mcelog-client">.
3749 =item B<PersistentNotification> B<true>|B<false>
3750 Override default configuration to only send notifications when sent when there
3751 is a change in the number of corrected/uncorrected memory errors. When set to
3752 true notifications will be sent for every read cycle. Default is false. Does
3753 not affect the stats being dispatched.
3759 =item B<McelogLogfile> I<Path>
3761 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3762 cannot be used in conjunction with the memory block options, they are mutually
3769 The C<md plugin> collects information from Linux Software-RAID devices (md).
3771 All reported values are of the type C<md_disks>. Reported type instances are
3772 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3773 I<missing> (physically absent) disks.
3777 =item B<Device> I<Device>
3779 Select md devices based on device name. The I<device name> is the basename of
3780 the device, i.e. the name of the block device without the leading C</dev/>.
3781 See B<IgnoreSelected> for more details.
3783 See F</"IGNORELISTS"> for details.
3785 =item B<IgnoreSelected> B<true>|B<false>
3787 Invert device selection: If set to B<true>, all md devices B<except> those
3788 listed using B<Device> are collected. If B<false> (the default), only those
3789 listed are collected. If no configuration is given, the B<md> plugin will
3790 collect data from all md devices.
3794 =head2 Plugin C<memcachec>
3796 The C<memcachec plugin> connects to a memcached server, queries one or more
3797 given I<pages> and parses the returned data according to user specification.
3798 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3801 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3802 library. Please note that there is another library with a very similar name,
3803 libmemcache (notice the missing `d'), which is not applicable.
3805 Synopsis of the configuration:
3807 <Plugin "memcachec">
3808 <Page "plugin_instance">
3811 Plugin "plugin_name"
3813 Regex "(\\d+) bytes sent"
3816 Instance "type_instance"
3821 The configuration options are:
3825 =item E<lt>B<Page> I<Name>E<gt>
3827 Each B<Page> block defines one I<page> to be queried from the memcached server.
3828 The block requires one string argument which is used as I<plugin instance>.
3830 =item B<Server> I<Address>
3832 Sets the server address to connect to when querying the page. Must be inside a
3837 When connected to the memcached server, asks for the page I<Key>.
3839 =item B<Plugin> I<Plugin>
3841 Use I<Plugin> as the plugin name when submitting values.
3842 Defaults to C<memcachec>.
3844 =item E<lt>B<Match>E<gt>
3846 Match blocks define which strings to look for and how matches substrings are
3847 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3851 =head2 Plugin C<memcached>
3853 The B<memcached plugin> connects to a memcached server and queries statistics
3854 about cache utilization, memory and bandwidth used.
3855 L<http://memcached.org/>
3857 <Plugin "memcached">
3859 #Host "memcache.example.com"
3865 The plugin configuration consists of one or more B<Instance> blocks which
3866 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3867 following options are allowed:
3871 =item B<Host> I<Hostname>
3873 Sets the B<host> field of dispatched values. Defaults to the global hostname
3875 For backwards compatibility, values are also dispatched with the global
3876 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3879 =item B<Address> I<Address>
3881 Hostname or IP to connect to. For backwards compatibility, defaults to the
3882 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3884 =item B<Port> I<Port>
3886 TCP port to connect to. Defaults to B<11211>.
3888 =item B<Socket> I<Path>
3890 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3891 setting is given, the B<Address> and B<Port> settings are ignored.
3895 =head2 Plugin C<mic>
3897 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3898 Intel's Many Integrated Core (MIC) systems.
3907 ShowTemperatures true
3910 IgnoreSelectedTemperature true
3915 IgnoreSelectedPower true
3918 The following options are valid inside the B<PluginE<nbsp>mic> block:
3922 =item B<ShowCPU> B<true>|B<false>
3924 If enabled (the default) a sum of the CPU usage across all cores is reported.
3926 =item B<ShowCPUCores> B<true>|B<false>
3928 If enabled (the default) per-core CPU usage is reported.
3930 =item B<ShowMemory> B<true>|B<false>
3932 If enabled (the default) the physical memory usage of the MIC system is
3935 =item B<ShowTemperatures> B<true>|B<false>
3937 If enabled (the default) various temperatures of the MIC system are reported.
3939 =item B<Temperature> I<Name>
3941 This option controls which temperatures are being reported. Whether matching
3942 temperatures are being ignored or I<only> matching temperatures are reported
3943 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3944 temperatures are reported.
3946 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3948 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3949 (the default) only temperatures matching a B<Temperature> option are reported
3950 or, if no B<Temperature> option is specified, all temperatures are reported. If
3951 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3954 Known temperature names are:
3988 =item B<ShowPower> B<true>|B<false>
3990 If enabled (the default) various temperatures of the MIC system are reported.
3992 =item B<Power> I<Name>
3994 This option controls which power readings are being reported. Whether matching
3995 power readings are being ignored or I<only> matching power readings are reported
3996 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3997 power readings are reported.
3999 =item B<IgnoreSelectedPower> B<false>|B<true>
4001 Controls the behavior of the B<Power> setting above. If set to B<false>
4002 (the default) only power readings matching a B<Power> option are reported
4003 or, if no B<Power> option is specified, all power readings are reported. If
4004 set to B<true>, matching power readings are I<ignored> and all other power readings
4007 Known power names are:
4013 Total power utilization averaged over Time Window 0 (uWatts).
4017 Total power utilization averaged over Time Window 0 (uWatts).
4021 Instantaneous power (uWatts).
4025 Max instantaneous power (uWatts).
4029 PCI-E connector power (uWatts).
4033 2x3 connector power (uWatts).
4037 2x4 connector power (uWatts).
4045 Uncore rail (uVolts).
4049 Memory subsystem rail (uVolts).
4055 =head2 Plugin C<memory>
4057 The I<memory plugin> provides the following configuration options:
4061 =item B<ValuesAbsolute> B<true>|B<false>
4063 Enables or disables reporting of physical memory usage in absolute numbers,
4064 i.e. bytes. Defaults to B<true>.
4066 =item B<ValuesPercentage> B<false>|B<true>
4068 Enables or disables reporting of physical memory usage in percentages, e.g.
4069 percent of physical memory used. Defaults to B<false>.
4071 This is useful for deploying I<collectd> in a heterogeneous environment in
4072 which the sizes of physical memory vary.
4076 =head2 Plugin C<modbus>
4078 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4079 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4080 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
4081 values (two registers interpreted as IEEE floats in big endian notation).
4085 <Data "voltage-input-1">
4088 RegisterCmd ReadHolding
4093 <Data "voltage-input-2">
4096 RegisterCmd ReadHolding
4101 <Data "supply-temperature-1">
4104 RegisterCmd ReadHolding
4109 <Host "modbus.example.com">
4110 Address "192.168.0.42"
4115 Instance "power-supply"
4116 Collect "voltage-input-1"
4117 Collect "voltage-input-2"
4122 Device "/dev/ttyUSB0"
4127 Instance "temperature"
4128 Collect "supply-temperature-1"
4134 =item E<lt>B<Data> I<Name>E<gt> blocks
4136 Data blocks define a mapping between register numbers and the "types" used by
4139 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4143 =item B<RegisterBase> I<Number>
4145 Configures the base register to read from the device. If the option
4146 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4147 register will be read (the register number is increased by one).
4149 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4151 Specifies what kind of data is returned by the device. This defaults to
4152 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4153 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4154 and B<RegisterBase+1> will be read and the data is combined into one
4155 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4156 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4157 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4158 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4159 registers are swapped with the most significant 16E<nbsp>bits in
4160 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4163 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4165 Specifies register type to be collected from device. Works only with libmodbus
4166 2.9.2 or higher. Defaults to B<ReadHolding>.
4168 =item B<Type> I<Type>
4170 Specifies the "type" (data set) to use when dispatching the value to
4171 I<collectd>. Currently, only data sets with exactly one data source are
4174 =item B<Instance> I<Instance>
4176 Sets the type instance to use when dispatching the value to I<collectd>. If
4177 unset, an empty string (no type instance) is used.
4181 =item E<lt>B<Host> I<Name>E<gt> blocks
4183 Host blocks are used to specify to which hosts to connect and what data to read
4184 from their "slaves". The string argument I<Name> is used as hostname when
4185 dispatching the values to I<collectd>.
4187 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4191 =item B<Address> I<Hostname>
4193 For Modbus/TCP, specifies the node name (the actual network address) used to
4194 connect to the host. This may be an IP address or a hostname. Please note that
4195 the used I<libmodbus> library only supports IPv4 at the moment.
4197 =item B<Port> I<Service>
4199 for Modbus/TCP, specifies the port used to connect to the host. The port can
4200 either be given as a number or as a service name. Please note that the
4201 I<Service> argument must be a string, even if ports are given in their numerical
4202 form. Defaults to "502".
4204 =item B<Device> I<Devicenode>
4206 For Modbus/RTU, specifies the path to the serial device being used.
4208 =item B<Baudrate> I<Baudrate>
4210 For Modbus/RTU, specifies the baud rate of the serial device.
4211 Note, connections currently support only 8/N/1.
4213 =item B<Interval> I<Interval>
4215 Sets the interval (in seconds) in which the values will be collected from this
4216 host. By default the global B<Interval> setting will be used.
4218 =item E<lt>B<Slave> I<ID>E<gt>
4220 Over each connection, multiple Modbus devices may be reached. The slave ID
4221 is used to specify which device should be addressed. For each device you want
4222 to query, one B<Slave> block must be given.
4224 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4228 =item B<Instance> I<Instance>
4230 Specify the plugin instance to use when dispatching the values to I<collectd>.
4231 By default "slave_I<ID>" is used.
4233 =item B<Collect> I<DataName>
4235 Specifies which data to retrieve from the device. I<DataName> must be the same
4236 string as the I<Name> argument passed to a B<Data> block. You can specify this
4237 option multiple times to collect more than one value from a slave. At least one
4238 B<Collect> option is mandatory.
4246 =head2 Plugin C<mqtt>
4248 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4249 values from MQTT (B<Subscribe> blocks).
4255 Host "mqtt.example.com"
4259 Host "mqtt.example.com"
4264 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4265 configuring the sending and receiving direction respectively. The plugin will
4266 register a write callback named C<mqtt/I<name>> where I<name> is the string
4267 argument given to the B<Publish> block. Both types of blocks share many but not
4268 all of the following options. If an option is valid in only one of the blocks,
4269 it will be mentioned explicitly.
4275 =item B<Host> I<Hostname>
4277 Hostname of the MQTT broker to connect to.
4279 =item B<Port> I<Service>
4281 Port number or service name of the MQTT broker to connect to.
4283 =item B<User> I<UserName>
4285 Username used when authenticating to the MQTT broker.
4287 =item B<Password> I<Password>
4289 Password used when authenticating to the MQTT broker.
4291 =item B<ClientId> I<ClientId>
4293 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4295 =item B<QoS> [B<0>-B<2>]
4297 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4315 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4316 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4317 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4318 on a message is larger than the maximum accepted QoS of a subscriber, the
4319 message's QoS will be downgraded.
4321 =item B<Prefix> I<Prefix> (Publish only)
4323 This plugin will use one topic per I<value list> which will looks like a path.
4324 I<Prefix> is used as the first path element and defaults to B<collectd>.
4326 An example topic name would be:
4328 collectd/cpu-0/cpu-user
4330 =item B<Retain> B<false>|B<true> (Publish only)
4332 Controls whether the MQTT broker will retain (keep a copy of) the last message
4333 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4335 =item B<StoreRates> B<true>|B<false> (Publish only)
4337 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4338 before sending. Defaults to B<true>.
4340 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4342 Controls whether the MQTT "cleans" the session up after the subscriber
4343 disconnects or if it maintains the subscriber's subscriptions and all messages
4344 that arrive while the subscriber is disconnected. Defaults to B<true>.
4346 =item B<Topic> I<TopicName> (Subscribe only)
4348 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4349 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4350 the B<collectd> branch.
4352 =item B<CACert> I<file>
4354 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4355 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4356 port of the MQTT broker.
4357 This option enables the use of TLS.
4359 =item B<CertificateFile> I<file>
4361 Path to the PEM-encoded certificate file to use as client certificate when
4362 connecting to the MQTT broker.
4363 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4365 =item B<CertificateKeyFile> I<file>
4367 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4368 Only valid if B<CACert> and B<CertificateFile> are also set.
4370 =item B<TLSProtocol> I<protocol>
4372 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4373 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4374 version is used which depends on the version of OpenSSL the Mosquitto library
4376 Only valid if B<CACert> is set.
4378 =item B<CipherSuite> I<ciphersuite>
4380 A string describing the ciphers available for use. See L<ciphers(1)> and the
4381 C<openssl ciphers> utility for more information. If unset, the default ciphers
4383 Only valid if B<CACert> is set.
4387 =head2 Plugin C<mysql>
4389 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4390 one or more databases when started and keeps the connection up as long as
4391 possible. When the connection is interrupted for whatever reason it will try
4392 to re-connect. The plugin will complain loudly in case anything goes wrong.
4394 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4395 and collects information about MySQL network traffic, executed statements,
4396 requests, the query cache and threads by evaluating the
4397 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4398 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4399 Status Variables> for an explanation of these values.
4401 Optionally, master and slave statistics may be collected in a MySQL
4402 replication setup. In that case, information about the synchronization state
4403 of the nodes are collected by evaluating the C<Position> return value of the
4404 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4405 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4406 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4407 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4408 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4420 SSLKey "/path/to/key.pem"
4421 SSLCert "/path/to/cert.pem"
4422 SSLCA "/path/to/ca.pem"
4423 SSLCAPath "/path/to/cas/"
4424 SSLCipher "DHE-RSA-AES256-SHA"
4430 Socket "/var/run/mysql/mysqld.sock"
4432 SlaveNotifications true
4438 Socket "/var/run/mysql/mysqld.sock"
4443 A B<Database> block defines one connection to a MySQL database. It accepts a
4444 single argument which specifies the name of the database. None of the other
4445 options are required. MySQL will use default values as documented in the
4446 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4447 B<MySQL reference manual>.
4451 =item B<Alias> I<Alias>
4453 Alias to use as sender instead of hostname when reporting. This may be useful
4454 when having cryptic hostnames.
4456 =item B<Host> I<Hostname>
4458 Hostname of the database server. Defaults to B<localhost>.
4460 =item B<User> I<Username>
4462 Username to use when connecting to the database. The user does not have to be
4463 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4464 unless you want to collectd replication statistics (see B<MasterStats> and
4465 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4466 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4468 =item B<Password> I<Password>
4470 Password needed to log into the database.
4472 =item B<Database> I<Database>
4474 Select this database. Defaults to I<no database> which is a perfectly reasonable
4475 option for what this plugin does.
4477 =item B<Port> I<Port>
4479 TCP-port to connect to. The port must be specified in its numeric form, but it
4480 must be passed as a string nonetheless. For example:
4484 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4485 See the documentation for the C<mysql_real_connect> function for details.
4487 =item B<Socket> I<Socket>
4489 Specifies the path to the UNIX domain socket of the MySQL server. This option
4490 only has any effect, if B<Host> is set to B<localhost> (the default).
4491 Otherwise, use the B<Port> option above. See the documentation for the
4492 C<mysql_real_connect> function for details.
4494 =item B<InnodbStats> I<true|false>
4496 If enabled, metrics about the InnoDB storage engine are collected.
4497 Disabled by default.
4499 =item B<MasterStats> I<true|false>
4501 =item B<SlaveStats> I<true|false>
4503 Enable the collection of master / slave statistics in a replication setup. In
4504 order to be able to get access to these statistics, the user needs special
4505 privileges. See the B<User> documentation above. Defaults to B<false>.
4507 =item B<SlaveNotifications> I<true|false>
4509 If enabled, the plugin sends a notification if the replication slave I/O and /
4510 or SQL threads are not running. Defaults to B<false>.
4512 =item B<WsrepStats> I<true|false>
4514 Enable the collection of wsrep plugin statistics, used in Master-Master
4515 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4516 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4518 =item B<ConnectTimeout> I<Seconds>
4520 Sets the connect timeout for the MySQL client.
4522 =item B<SSLKey> I<Path>
4524 If provided, the X509 key in PEM format.
4526 =item B<SSLCert> I<Path>
4528 If provided, the X509 cert in PEM format.
4530 =item B<SSLCA> I<Path>
4532 If provided, the CA file in PEM format (check OpenSSL docs).
4534 =item B<SSLCAPath> I<Path>
4536 If provided, the CA directory (check OpenSSL docs).
4538 =item B<SSLCipher> I<String>
4540 If provided, the SSL cipher to use.
4544 =head2 Plugin C<netapp>
4546 The netapp plugin can collect various performance and capacity information
4547 from a NetApp filer using the NetApp API.
4549 Please note that NetApp has a wide line of products and a lot of different
4550 software versions for each of these products. This plugin was developed for a
4551 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4552 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4553 model and software version but it is very hard to test this.
4554 If you have used this plugin with other models and/or software version, feel
4555 free to send us a mail to tell us about the results, even if it's just a short
4558 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4559 basic authentication.
4561 B<Do not use a regular user for this!> Create a special collectd user with just
4562 the minimum of capabilities needed. The user only needs the "login-http-admin"
4563 capability as well as a few more depending on which data will be collected.
4564 Required capabilities are documented below.
4569 <Host "netapp1.example.com">
4593 IgnoreSelectedIO false
4595 IgnoreSelectedOps false
4596 GetLatency "volume0"
4597 IgnoreSelectedLatency false
4604 IgnoreSelectedCapacity false
4607 IgnoreSelectedSnapshot false
4635 The netapp plugin accepts the following configuration options:
4639 =item B<Host> I<Name>
4641 A host block defines one NetApp filer. It will appear in collectd with the name
4642 you specify here which does not have to be its real name nor its hostname (see
4643 the B<Address> option below).
4645 =item B<VFiler> I<Name>
4647 A B<VFiler> block may only be used inside a host block. It accepts all the
4648 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4649 will execute all NetApp API commands in the context of the specified
4650 VFiler(R). It will appear in collectd with the name you specify here which
4651 does not have to be its real name. The VFiler name may be specified using the
4652 B<VFilerName> option. If this is not specified, it will default to the name
4655 The VFiler block inherits all connection related settings from the surrounding
4656 B<Host> block (which appear before the B<VFiler> block) but they may be
4657 overwritten inside the B<VFiler> block.
4659 This feature is useful, for example, when using a VFiler as SnapVault target
4660 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4661 available in the host filer (vfiler0) but only in the respective VFiler
4664 =item B<Protocol> B<httpd>|B<http>
4666 The protocol collectd will use to query this host.
4674 Valid options: http, https
4676 =item B<Address> I<Address>
4678 The hostname or IP address of the host.
4684 Default: The "host" block's name.
4686 =item B<Port> I<Port>
4688 The TCP port to connect to on the host.
4694 Default: 80 for protocol "http", 443 for protocol "https"
4696 =item B<User> I<User>
4698 =item B<Password> I<Password>
4700 The username and password to use to login to the NetApp.
4706 =item B<VFilerName> I<Name>
4708 The name of the VFiler in which context to execute API commands. If not
4709 specified, the name provided to the B<VFiler> block will be used instead.
4715 Default: name of the B<VFiler> block
4717 B<Note:> This option may only be used inside B<VFiler> blocks.
4719 =item B<Interval> I<Interval>
4725 The following options decide what kind of data will be collected. You can
4726 either use them as a block and fine tune various parameters inside this block,
4727 use them as a single statement to just accept all default values, or omit it to
4728 not collect any data.
4730 The following options are valid inside all blocks:
4734 =item B<Interval> I<Seconds>
4736 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4737 host specific setting.
4741 =head3 The System block
4743 This will collect various performance data about the whole system.
4745 B<Note:> To get this data the collectd user needs the
4746 "api-perf-object-get-instances" capability.
4750 =item B<Interval> I<Seconds>
4752 Collect disk statistics every I<Seconds> seconds.
4754 =item B<GetCPULoad> B<true>|B<false>
4756 If you set this option to true the current CPU usage will be read. This will be
4757 the average usage between all CPUs in your NetApp without any information about
4760 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4761 returns in the "CPU" field.
4769 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4771 =item B<GetInterfaces> B<true>|B<false>
4773 If you set this option to true the current traffic of the network interfaces
4774 will be read. This will be the total traffic over all interfaces of your NetApp
4775 without any information about individual interfaces.
4777 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4778 in the "Net kB/s" field.
4788 Result: One value list of type "if_octects".
4790 =item B<GetDiskIO> B<true>|B<false>
4792 If you set this option to true the current IO throughput will be read. This
4793 will be the total IO of your NetApp without any information about individual
4794 disks, volumes or aggregates.
4796 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4797 in the "DiskE<nbsp>kB/s" field.
4805 Result: One value list of type "disk_octets".
4807 =item B<GetDiskOps> B<true>|B<false>
4809 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4810 iSCSI, etc. operations will be read. This will be the total number of
4811 operations on your NetApp without any information about individual volumes or
4814 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4815 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4823 Result: A variable number of value lists of type "disk_ops_complex". Each type
4824 of operation will result in one value list with the name of the operation as
4829 =head3 The WAFL block
4831 This will collect various performance data about the WAFL file system. At the
4832 moment this just means cache performance.
4834 B<Note:> To get this data the collectd user needs the
4835 "api-perf-object-get-instances" capability.
4837 B<Note:> The interface to get these values is classified as "Diagnostics" by
4838 NetApp. This means that it is not guaranteed to be stable even between minor
4843 =item B<Interval> I<Seconds>
4845 Collect disk statistics every I<Seconds> seconds.
4847 =item B<GetNameCache> B<true>|B<false>
4855 Result: One value list of type "cache_ratio" and type instance
4858 =item B<GetDirCache> B<true>|B<false>
4866 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4868 =item B<GetInodeCache> B<true>|B<false>
4876 Result: One value list of type "cache_ratio" and type instance
4879 =item B<GetBufferCache> B<true>|B<false>
4881 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4882 in the "Cache hit" field.
4890 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4894 =head3 The Disks block
4896 This will collect performance data about the individual disks in the NetApp.
4898 B<Note:> To get this data the collectd user needs the
4899 "api-perf-object-get-instances" capability.
4903 =item B<Interval> I<Seconds>
4905 Collect disk statistics every I<Seconds> seconds.
4907 =item B<GetBusy> B<true>|B<false>
4909 If you set this option to true the busy time of all disks will be calculated
4910 and the value of the busiest disk in the system will be written.
4912 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4913 in the "Disk util" field. Probably.
4921 Result: One value list of type "percent" and type instance "disk_busy".
4925 =head3 The VolumePerf block
4927 This will collect various performance data about the individual volumes.
4929 You can select which data to collect about which volume using the following
4930 options. They follow the standard ignorelist semantic.
4932 B<Note:> To get this data the collectd user needs the
4933 I<api-perf-object-get-instances> capability.
4937 =item B<Interval> I<Seconds>
4939 Collect volume performance data every I<Seconds> seconds.
4941 =item B<GetIO> I<Volume>
4943 =item B<GetOps> I<Volume>
4945 =item B<GetLatency> I<Volume>
4947 Select the given volume for IO, operations or latency statistics collection.
4948 The argument is the name of the volume without the C</vol/> prefix.
4950 Since the standard ignorelist functionality is used here, you can use a string
4951 starting and ending with a slash to specify regular expression matching: To
4952 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4955 GetIO "/^vol[027]$/"
4957 If no regular expression is specified, an exact match is required. Both,
4958 regular and exact matching are case sensitive.
4960 If no volume was specified at all for either of the three options, that data
4961 will be collected for all available volumes.
4963 See F</"IGNORELISTS"> for details.
4965 =item B<IgnoreSelectedIO> B<true>|B<false>
4967 =item B<IgnoreSelectedOps> B<true>|B<false>
4969 =item B<IgnoreSelectedLatency> B<true>|B<false>
4971 When set to B<true>, the volumes selected for IO, operations or latency
4972 statistics collection will be ignored and the data will be collected for all
4975 When set to B<false>, data will only be collected for the specified volumes and
4976 all other volumes will be ignored.
4978 If no volumes have been specified with the above B<Get*> options, all volumes
4979 will be collected regardless of the B<IgnoreSelected*> option.
4981 Defaults to B<false>
4985 =head3 The VolumeUsage block
4987 This will collect capacity data about the individual volumes.
4989 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4994 =item B<Interval> I<Seconds>
4996 Collect volume usage statistics every I<Seconds> seconds.
4998 =item B<GetCapacity> I<VolumeName>
5000 The current capacity of the volume will be collected. This will result in two
5001 to four value lists, depending on the configuration of the volume. All data
5002 sources are of type "df_complex" with the name of the volume as
5005 There will be type_instances "used" and "free" for the number of used and
5006 available bytes on the volume. If the volume has some space reserved for
5007 snapshots, a type_instance "snap_reserved" will be available. If the volume
5008 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5009 number of bytes saved by the SIS feature.
5011 B<Note:> The current NetApp API has a bug that results in this value being
5012 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5013 number which works most of the time. If you see strange values here, bug
5014 NetApp support to fix this.
5016 Repeat this option to specify multiple volumes.
5018 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5020 Specify whether to collect only the volumes selected by the B<GetCapacity>
5021 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5022 B<false>. However, if no B<GetCapacity> option is specified at all, all
5023 capacities will be selected anyway.
5025 =item B<GetSnapshot> I<VolumeName>
5027 Select volumes from which to collect snapshot information.
5029 Usually, the space used for snapshots is included in the space reported as
5030 "used". If snapshot information is collected as well, the space used for
5031 snapshots is subtracted from the used space.
5033 To make things even more interesting, it is possible to reserve space to be
5034 used for snapshots. If the space required for snapshots is less than that
5035 reserved space, there is "reserved free" and "reserved used" space in addition
5036 to "free" and "used". If the space required for snapshots exceeds the reserved
5037 space, that part allocated in the normal space is subtracted from the "used"
5040 Repeat this option to specify multiple volumes.
5042 =item B<IgnoreSelectedSnapshot>
5044 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5045 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5046 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5047 capacities will be selected anyway.
5051 =head3 The Quota block
5053 This will collect (tree) quota statistics (used disk space and number of used
5054 files). This mechanism is useful to get usage information for single qtrees.
5055 In case the quotas are not used for any other purpose, an entry similar to the
5056 following in C</etc/quotas> would be sufficient:
5058 /vol/volA/some_qtree tree - - - - -
5060 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5064 =item B<Interval> I<Seconds>
5066 Collect SnapVault(R) statistics every I<Seconds> seconds.
5070 =head3 The SnapVault block
5072 This will collect statistics about the time and traffic of SnapVault(R)
5077 =item B<Interval> I<Seconds>
5079 Collect SnapVault(R) statistics every I<Seconds> seconds.
5083 =head2 Plugin C<netlink>
5085 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5086 statistics of various interface and routing aspects.
5090 =item B<Interface> I<Interface>
5092 =item B<VerboseInterface> I<Interface>
5094 Instruct the plugin to collect interface statistics. This is basically the same
5095 as the statistics provided by the C<interface> plugin (see above) but
5096 potentially much more detailed.
5098 When configuring with B<Interface> only the basic statistics will be collected,
5099 namely octets, packets, and errors. These statistics are collected by
5100 the C<interface> plugin, too, so using both at the same time is no benefit.
5102 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5103 so that no data needs to be collected twice if you use the C<interface> plugin.
5104 This includes dropped packets, received multicast packets, collisions and a
5105 whole zoo of differentiated RX and TX errors. You can try the following command
5106 to get an idea of what awaits you:
5110 If I<Interface> is B<All>, all interfaces will be selected.
5112 =item B<QDisc> I<Interface> [I<QDisc>]
5114 =item B<Class> I<Interface> [I<Class>]
5116 =item B<Filter> I<Interface> [I<Filter>]
5118 Collect the octets and packets that pass a certain qdisc, class or filter.
5120 QDiscs and classes are identified by their type and handle (or classid).
5121 Filters don't necessarily have a handle, therefore the parent's handle is used.
5122 The notation used in collectd differs from that used in tc(1) in that it
5123 doesn't skip the major or minor number if it's zero and doesn't print special
5124 ids by their name. So, for example, a qdisc may be identified by
5125 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5126 thus not displayed by tc(1).
5128 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5129 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5130 associated with that interface will be collected.
5132 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5133 used. This may lead to problems when more than one filter is attached to a
5134 qdisc or class. This isn't nice, but we don't know how this could be done any
5135 better. If you have a idea, please don't hesitate to tell us.
5137 As with the B<Interface> option you can specify B<All> as the interface,
5138 meaning all interfaces.
5140 Here are some examples to help you understand the above text more easily:
5143 VerboseInterface "All"
5144 QDisc "eth0" "pfifo_fast-1:0"
5146 Class "ppp0" "htb-1:10"
5147 Filter "ppp0" "u32-1:0"
5150 See F</"IGNORELISTS"> for details.
5152 =item B<IgnoreSelected>
5154 The behavior is the same as with all other similar plugins: If nothing is
5155 selected at all, everything is collected. If some things are selected using the
5156 options described above, only these statistics are collected. If you set
5157 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5158 specified statistics will not be collected.
5162 =head2 Plugin C<network>
5164 The Network plugin sends data to a remote instance of collectd, receives data
5165 from a remote instance, or both at the same time. Data which has been received
5166 from the network is usually not transmitted again, but this can be activated, see
5167 the B<Forward> option below.
5169 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5170 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5172 Both, B<Server> and B<Listen> can be used as single option or as block. When
5173 used as block, given options are valid for this socket only. The following
5174 example will export the metrics twice: Once to an "internal" server (without
5175 encryption and signing) and one to an external server (with cryptographic
5179 # Export to an internal server
5180 # (demonstrates usage without additional options)
5181 Server "collectd.internal.tld"
5183 # Export to an external server
5184 # (demonstrates usage with signature options)
5185 <Server "collectd.external.tld">
5186 SecurityLevel "sign"
5187 Username "myhostname"
5194 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5196 The B<Server> statement/block sets the server to send datagrams to. The
5197 statement may occur multiple times to send each datagram to multiple
5200 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5201 optional second argument specifies a port number or a service name. If not
5202 given, the default, B<25826>, is used.
5204 The following options are recognized within B<Server> blocks:
5208 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5210 Set the security you require for network communication. When the security level
5211 has been set to B<Encrypt>, data sent over the network will be encrypted using
5212 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5213 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5214 authentication code. When set to B<None>, data is sent without any security.
5216 This feature is only available if the I<network> plugin was linked with
5219 =item B<Username> I<Username>
5221 Sets the username to transmit. This is used by the server to lookup the
5222 password. See B<AuthFile> below. All security levels except B<None> require
5225 This feature is only available if the I<network> plugin was linked with
5228 =item B<Password> I<Password>
5230 Sets a password (shared secret) for this socket. All security levels except
5231 B<None> require this setting.
5233 This feature is only available if the I<network> plugin was linked with
5236 =item B<Interface> I<Interface name>
5238 Set the outgoing interface for IP packets. This applies at least
5239 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5240 undefined or a non-existent interface name is specified, the default
5241 behavior is to let the kernel choose the appropriate interface. Be warned
5242 that the manual selection of an interface for unicast traffic is only
5243 necessary in rare cases.
5245 =item B<ResolveInterval> I<Seconds>
5247 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5248 useful to force a regular DNS lookup to support a high availability setup. If
5249 not specified, re-resolves are never attempted.
5253 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5255 The B<Listen> statement sets the interfaces to bind to. When multiple
5256 statements are found the daemon will bind to multiple interfaces.
5258 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5259 the argument is a multicast address the daemon will join that multicast group.
5260 The optional second argument specifies a port number or a service name. If not
5261 given, the default, B<25826>, is used.
5263 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5267 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5269 Set the security you require for network communication. When the security level
5270 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5271 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5272 signed and encrypted data is accepted. When set to B<None>, all data will be
5273 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5274 decrypted if possible.
5276 This feature is only available if the I<network> plugin was linked with
5279 =item B<AuthFile> I<Filename>
5281 Sets a file in which usernames are mapped to passwords. These passwords are
5282 used to verify signatures and to decrypt encrypted network packets. If
5283 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5284 verified and encrypted packets are decrypted. Otherwise, signed data is
5285 accepted without checking the signature and encrypted data cannot be decrypted.
5286 For the other security levels this option is mandatory.
5288 The file format is very simple: Each line consists of a username followed by a
5289 colon and any number of spaces followed by the password. To demonstrate, an
5290 example file could look like this:
5295 Each time a packet is received, the modification time of the file is checked
5296 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5297 the file is being read, it is locked using L<fcntl(2)>.
5299 =item B<Interface> I<Interface name>
5301 Set the incoming interface for IP packets explicitly. This applies at least
5302 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5303 undefined or a non-existent interface name is specified, the default
5304 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5305 traffic gets only accepted, if it arrives on the given interface.
5309 =item B<TimeToLive> I<1-255>
5311 Set the time-to-live of sent packets. This applies to all, unicast and
5312 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5313 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5316 =item B<MaxPacketSize> I<1024-65535>
5318 Set the maximum size for datagrams received over the network. Packets larger
5319 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5320 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5323 On the server side, this limit should be set to the largest value used on
5324 I<any> client. Likewise, the value on the client must not be larger than the
5325 value on the server, or data will be lost.
5327 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5328 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5329 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5332 =item B<Forward> I<true|false>
5334 If set to I<true>, write packets that were received via the network plugin to
5335 the sending sockets. This should only be activated when the B<Listen>- and
5336 B<Server>-statements differ. Otherwise packets may be send multiple times to
5337 the same multicast group. While this results in more network traffic than
5338 necessary it's not a huge problem since the plugin has a duplicate detection,
5339 so the values will not loop.
5341 =item B<ReportStats> B<true>|B<false>
5343 The network plugin cannot only receive and send statistics, it can also create
5344 statistics about itself. Collectd data included the number of received and
5345 sent octets and packets, the length of the receive queue and the number of
5346 values handled. When set to B<true>, the I<Network plugin> will make these
5347 statistics available. Defaults to B<false>.
5351 =head2 Plugin C<nfs>
5353 The I<nfs plugin> collects information about the usage of the Network File
5354 System (NFS). It counts the number of procedure calls for each procedure,
5355 grouped by version and whether the system runs as server or client.
5357 It is possibly to omit metrics for a specific NFS version by setting one or
5358 more of the following options to B<false> (all of them default to B<true>).
5362 =item B<ReportV2> B<true>|B<false>
5364 =item B<ReportV3> B<true>|B<false>
5366 =item B<ReportV4> B<true>|B<false>
5370 =head2 Plugin C<nginx>
5372 This plugin collects the number of connections and requests handled by the
5373 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5374 queries the page provided by the C<ngx_http_stub_status_module> module, which
5375 isn't compiled by default. Please refer to
5376 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5377 how to compile and configure nginx and this module.
5379 The following options are accepted by the C<nginx plugin>:
5383 =item B<URL> I<http://host/nginx_status>
5385 Sets the URL of the C<ngx_http_stub_status_module> output.
5387 =item B<User> I<Username>
5389 Optional user name needed for authentication.
5391 =item B<Password> I<Password>
5393 Optional password needed for authentication.
5395 =item B<VerifyPeer> B<true|false>
5397 Enable or disable peer SSL certificate verification. See
5398 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5400 =item B<VerifyHost> B<true|false>
5402 Enable or disable peer host name verification. If enabled, the plugin checks
5403 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5404 certificate matches the host name provided by the B<URL> option. If this
5405 identity check fails, the connection is aborted. Obviously, only works when
5406 connecting to a SSL enabled server. Enabled by default.
5408 =item B<CACert> I<File>
5410 File that holds one or more SSL certificates. If you want to use HTTPS you will
5411 possibly need this option. What CA certificates come bundled with C<libcurl>
5412 and are checked by default depends on the distribution you use.
5414 =item B<Timeout> I<Milliseconds>
5416 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5417 milliseconds. By default, the configured B<Interval> is used to set the
5422 =head2 Plugin C<notify_desktop>
5424 This plugin sends a desktop notification to a notification daemon, as defined
5425 in the Desktop Notification Specification. To actually display the
5426 notifications, B<notification-daemon> is required and B<collectd> has to be
5427 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5428 environment variables have to be set correctly) and the D-Bus message bus.
5430 The Desktop Notification Specification can be found at
5431 L<http://www.galago-project.org/specs/notification/>.
5435 =item B<OkayTimeout> I<timeout>
5437 =item B<WarningTimeout> I<timeout>
5439 =item B<FailureTimeout> I<timeout>
5441 Set the I<timeout>, in milliseconds, after which to expire the notification
5442 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5443 been specified, the displayed notification will not be closed at all - the
5444 user has to do so herself. These options default to 5000. If a negative number
5445 has been specified, the default is used as well.
5449 =head2 Plugin C<notify_email>
5451 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5452 configured email address.
5454 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5456 Available configuration options:
5460 =item B<From> I<Address>
5462 Email address from which the emails should appear to come from.
5464 Default: C<root@localhost>
5466 =item B<Recipient> I<Address>
5468 Configures the email address(es) to which the notifications should be mailed.
5469 May be repeated to send notifications to multiple addresses.
5471 At least one B<Recipient> must be present for the plugin to work correctly.
5473 =item B<SMTPServer> I<Hostname>
5475 Hostname of the SMTP server to connect to.
5477 Default: C<localhost>
5479 =item B<SMTPPort> I<Port>
5481 TCP port to connect to.
5485 =item B<SMTPUser> I<Username>
5487 Username for ASMTP authentication. Optional.
5489 =item B<SMTPPassword> I<Password>
5491 Password for ASMTP authentication. Optional.
5493 =item B<Subject> I<Subject>
5495 Subject-template to use when sending emails. There must be exactly two
5496 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5497 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5500 Default: C<Collectd notify: %s@%s>
5504 =head2 Plugin C<notify_nagios>
5506 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5507 a I<passive service check result>.
5509 Available configuration options:
5513 =item B<CommandFile> I<Path>
5515 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5519 =head2 Plugin C<ntpd>
5521 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5524 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5525 the wire - using B<mode 7> specific requests. This mode is deprecated with
5526 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5527 correctly with them, the ntp daemon must be explicitly configured to
5528 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5529 manual page for details.
5531 Available configuration options for the C<ntpd> plugin:
5535 =item B<Host> I<Hostname>
5537 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5539 =item B<Port> I<Port>
5541 UDP-Port to connect to. Defaults to B<123>.
5543 =item B<ReverseLookups> B<true>|B<false>
5545 Sets whether or not to perform reverse lookups on peers. Since the name or
5546 IP-address may be used in a filename it is recommended to disable reverse
5547 lookups. The default is to do reverse lookups to preserve backwards
5548 compatibility, though.
5550 =item B<IncludeUnitID> B<true>|B<false>
5552 When a peer is a refclock, include the unit ID in the I<type instance>.
5553 Defaults to B<false> for backward compatibility.
5555 If two refclock peers use the same driver and this is B<false>, the plugin will
5556 try to write simultaneous measurements from both to the same type instance.
5557 This will result in error messages in the log and only one set of measurements
5562 =head2 Plugin C<nut>
5566 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5568 Add a UPS to collect data from. The format is identical to the one accepted by
5571 =item B<ForceSSL> B<true>|B<false>
5573 Stops connections from falling back to unsecured if an SSL connection
5574 cannot be established. Defaults to false if undeclared.
5576 =item B<VerifyPeer> I<true>|I<false>
5578 If set to true, requires a CAPath be provided. Will use the CAPath to find
5579 certificates to use as Trusted Certificates to validate a upsd server certificate.
5580 If validation of the upsd server certificate fails, the connection will not be
5581 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5582 will override and set ForceSSL to true.
5584 =item B<CAPath> I/path/to/certs/folder
5586 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5587 The folder pointed at must contain certificate(s) named according to their hash.
5588 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5589 occur because two different certs have the same hash value, Y can be incremented
5590 in order to avoid conflict. To create a symbolic link to a certificate the following
5591 command can be used from within the directory where the cert resides:
5593 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5595 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5596 generate links like the one described above for ALL certs in a given folder.
5598 C<c_rehash /path/to/certs/folder>
5600 =item B<ConnectTimeout> I<Milliseconds>
5602 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5603 By default, the configured B<Interval> is used to set the timeout.
5607 =head2 Plugin C<olsrd>
5609 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5610 the Optimized Link State Routing daemon and reads information about the current
5611 state of the meshed network.
5613 The following configuration options are understood:
5617 =item B<Host> I<Host>
5619 Connect to I<Host>. Defaults to B<"localhost">.
5621 =item B<Port> I<Port>
5623 Specifies the port to connect to. This must be a string, even if you give the
5624 port as a number rather than a service name. Defaults to B<"2006">.
5626 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5628 Specifies what information to collect about links, i.E<nbsp>e. direct
5629 connections of the daemon queried. If set to B<No>, no information is
5630 collected. If set to B<Summary>, the number of links and the average of all
5631 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5632 If set to B<Detail> LQ and NLQ are collected per link.
5634 Defaults to B<Detail>.
5636 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5638 Specifies what information to collect about routes of the daemon queried. If
5639 set to B<No>, no information is collected. If set to B<Summary>, the number of
5640 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5641 metric and ETX are collected per route.
5643 Defaults to B<Summary>.
5645 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5647 Specifies what information to collect about the global topology. If set to
5648 B<No>, no information is collected. If set to B<Summary>, the number of links
5649 in the entire topology and the average I<link quality> (LQ) is calculated.
5650 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5652 Defaults to B<Summary>.
5656 =head2 Plugin C<onewire>
5658 B<EXPERIMENTAL!> See notes below.
5660 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5661 L<http://owfs.org/> to read sensors connected via the onewire bus.
5663 It can be used in two possible modes - standard or advanced.
5665 In the standard mode only temperature sensors (sensors with the family code
5666 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5667 other sensors you would like to have included, please send a sort request to
5668 the mailing list. You can select sensors to be read or to be ignored depending
5669 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5670 walked and all sensors are read.
5672 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5673 experimental, below.
5675 In the advanced mode you can configure any sensor to be read (only numerical
5676 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5677 In this mode you have to list all the sensors. Neither default bus walk nor
5678 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5679 the path automatically and should produce compatible structure with the "standard"
5680 mode (basically the path is expected as for example
5681 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5682 "F10FCA000800" and the rest after the slash is considered the type - here
5684 There are two advantages to this mode - you can access virtually any sensor
5685 (not just temperature), select whether to use cached or directly read values
5686 and it is slighlty faster. The downside is more complex configuration.
5688 The two modes are distinguished automatically by the format of the address.
5689 It is not possible to mix the two modes. Once a full path is detected in any
5690 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5691 (and as standard addresses will fail parsing they will be ignored).
5695 =item B<Device> I<Device>
5697 Sets the device to read the values from. This can either be a "real" hardware
5698 device, such as a serial port or an USB port, or the address of the
5699 L<owserver(1)> socket, usually B<localhost:4304>.
5701 Though the documentation claims to automatically recognize the given address
5702 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5703 with that version, the following configuration worked for us:
5706 Device "-s localhost:4304"
5709 This directive is B<required> and does not have a default value.
5711 =item B<Sensor> I<Sensor>
5713 In the standard mode selects sensors to collect or to ignore
5714 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5715 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5716 and B<not> include the leading C<10.> family byte and point.
5717 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5718 sensors (see above) are read.
5720 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5721 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5722 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5724 As there can be multiple devices on the bus you can list multiple sensor (use
5725 multiple B<Sensor> elements).
5727 See F</"IGNORELISTS"> for details.
5729 =item B<IgnoreSelected> I<true>|I<false>
5731 If no configuration is given, the B<onewire> plugin will collect data from all
5732 sensors found. This may not be practical, especially if sensors are added and
5733 removed regularly. Sometimes, however, it's easier/preferred to collect only
5734 specific sensors or all sensors I<except> a few specified ones. This option
5735 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5736 B<Sensor> is inverted: All selected interfaces are ignored and all other
5737 interfaces are collected.
5739 Used only in the standard mode - see above.
5741 =item B<Interval> I<Seconds>
5743 Sets the interval in which all sensors should be read. If not specified, the
5744 global B<Interval> setting is used.
5748 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5749 work with big setups. It works with one sensor being attached to one
5750 controller, but as soon as you throw in a couple more senors and maybe a hub
5751 or two, reading all values will take more than ten seconds (the default
5752 interval). We will probably add some separate thread for reading the sensors
5753 and some cache or something like that, but it's not done yet. We will try to
5754 maintain backwards compatibility in the future, but we can't promise. So in
5755 short: If it works for you: Great! But keep in mind that the config I<might>
5756 change, though this is unlikely. Oh, and if you want to help improving this
5757 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5759 =head2 Plugin C<openldap>
5761 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5762 server correctly. The backend database C<monitor> needs to be loaded and
5763 working. See slapd-monitor(5) for the details.
5765 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5766 blocks. Each block requires one string argument as the instance name. For
5771 URL "ldap://localhost/"
5774 URL "ldaps://localhost/"
5778 The instance name will be used as the I<plugin instance>. To emulate the old
5779 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5780 plugin to work correctly, each instance name must be unique. This is not
5781 enforced by the plugin and it is your responsibility to ensure it is.
5783 The following options are accepted within each B<Instance> block:
5787 =item B<URL> I<ldap://host/binddn>
5789 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5792 =item B<BindDN> I<BindDN>
5794 Name in the form of an LDAP distinguished name intended to be used for
5795 authentication. Defaults to empty string to establish an anonymous authorization.
5797 =item B<Password> I<Password>
5799 Password for simple bind authentication. If this option is not set,
5800 unauthenticated bind operation is used.
5802 =item B<StartTLS> B<true|false>
5804 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5805 Disabled by default.
5807 =item B<VerifyHost> B<true|false>
5809 Enables or disables peer host name verification. If enabled, the plugin checks
5810 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5811 certificate matches the host name provided by the B<URL> option. If this
5812 identity check fails, the connection is aborted. Enabled by default.
5814 =item B<CACert> I<File>
5816 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5817 may possibly need this option. What CA certificates are checked by default
5818 depends on the distribution you use and can be changed with the usual ldap
5819 client configuration mechanisms. See ldap.conf(5) for the details.
5821 =item B<Timeout> I<Seconds>
5823 Sets the timeout value for ldap operations, in seconds. By default, the
5824 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5827 =item B<Version> I<Version>
5829 An integer which sets the LDAP protocol version number to use when connecting
5830 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5834 =head2 Plugin C<openvpn>
5836 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5837 traffic statistics about connected clients.
5839 To set up OpenVPN to write to the status file periodically, use the
5840 B<--status> option of OpenVPN.
5842 So, in a nutshell you need:
5844 openvpn $OTHER_OPTIONS \
5845 --status "/var/run/openvpn-status" 10
5851 =item B<StatusFile> I<File>
5853 Specifies the location of the status file.
5855 =item B<ImprovedNamingSchema> B<true>|B<false>
5857 When enabled, the filename of the status file will be used as plugin instance
5858 and the client's "common name" will be used as type instance. This is required
5859 when reading multiple status files. Enabling this option is recommended, but to
5860 maintain backwards compatibility this option is disabled by default.
5862 =item B<CollectCompression> B<true>|B<false>
5864 Sets whether or not statistics about the compression used by OpenVPN should be
5865 collected. This information is only available in I<single> mode. Enabled by
5868 =item B<CollectIndividualUsers> B<true>|B<false>
5870 Sets whether or not traffic information is collected for each connected client
5871 individually. If set to false, currently no traffic data is collected at all
5872 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5874 =item B<CollectUserCount> B<true>|B<false>
5876 When enabled, the number of currently connected clients or users is collected.
5877 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5878 can be configured independently from that option. Defaults to B<false>.
5882 =head2 Plugin C<oracle>
5884 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5885 Oracle® Database and lets you execute SQL statements there. It is very similar
5886 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5887 plugin's documentation above for details.
5890 <Query "out_of_stock">
5891 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5894 # InstancePrefix "foo"
5895 InstancesFrom "category"
5899 <Database "product_information">
5904 Query "out_of_stock"
5908 =head3 B<Query> blocks
5910 The Query blocks are handled identically to the Query blocks of the "dbi"
5911 plugin. Please see its documentation above for details on how to specify
5914 =head3 B<Database> blocks
5916 Database blocks define a connection to a database and which queries should be
5917 sent to that database. Each database needs a "name" as string argument in the
5918 starting tag of the block. This name will be used as "PluginInstance" in the
5919 values submitted to the daemon. Other than that, that name is not used.
5923 =item B<Plugin> I<Plugin>
5925 Use I<Plugin> as the plugin name when submitting query results from
5926 this B<Database>. Defaults to C<oracle>.
5928 =item B<ConnectID> I<ID>
5930 Defines the "database alias" or "service name" to connect to. Usually, these
5931 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5933 =item B<Host> I<Host>
5935 Hostname to use when dispatching values for this database. Defaults to using
5936 the global hostname of the I<collectd> instance.
5938 =item B<Username> I<Username>
5940 Username used for authentication.
5942 =item B<Password> I<Password>
5944 Password used for authentication.
5946 =item B<Query> I<QueryName>
5948 Associates the query named I<QueryName> with this database connection. The
5949 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5950 blocks you want to refer to must be placed above the database block you want to
5955 =head2 Plugin C<ovs_events>
5957 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5958 connected interfaces, dispatches the values to collectd and sends the
5959 notification whenever the link state change occurs. This plugin uses OVS
5960 database to get a link state change notification.
5964 <Plugin "ovs_events">
5967 Socket "/var/run/openvswitch/db.sock"
5968 Interfaces "br0" "veth0"
5969 SendNotification true
5970 DispatchValues false
5973 The plugin provides the following configuration options:
5977 =item B<Address> I<node>
5979 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5980 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5981 option. See L<ovsdb-server(1)> for more details. The option may be either
5982 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5983 format. Defaults to C<localhost>.
5985 =item B<Port> I<service>
5987 TCP-port to connect to. Either a service name or a port number may be given.
5988 Defaults to B<6640>.
5990 =item B<Socket> I<path>
5992 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5993 plugin. To enable the interface, the OVS DB daemon should be running with
5994 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5995 option is set, B<Address> and B<Port> options are ignored.
5997 =item B<Interfaces> [I<ifname> ...]
5999 List of interface names to be monitored by this plugin. If this option is not
6000 specified or is empty then all OVS connected interfaces on all bridges are
6003 Default: empty (all interfaces on all bridges are monitored)
6005 =item B<SendNotification> I<true|false>
6007 If set to true, OVS link notifications (interface status and OVS DB connection
6008 terminate) are sent to collectd. Default value is true.
6010 =item B<DispatchValues> I<true|false>
6012 Dispatch the OVS DB interface link status value with configured plugin interval.
6013 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6014 options are false, no OVS information will be provided by the plugin.
6018 B<Note:> By default, the global interval setting is used within which to
6019 retrieve the OVS link status. To configure a plugin-specific interval, please
6020 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6021 simple divide the time by 1000 for example if the desired interval is 50ms, set
6024 =head2 Plugin C<ovs_stats>
6026 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6027 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6028 statistics from OVSDB
6032 <Plugin "ovs_stats">
6035 Socket "/var/run/openvswitch/db.sock"
6036 Bridges "br0" "br_ext"
6039 The plugin provides the following configuration options:
6043 =item B<Address> I<node>
6045 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6046 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6047 option. See L<ovsdb-server(1)> for more details. The option may be either
6048 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6049 format. Defaults to C<localhost>.
6051 =item B<Port> I<service>
6053 TCP-port to connect to. Either a service name or a port number may be given.
6054 Defaults to B<6640>.
6056 =item B<Socket> I<path>
6058 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6059 plugin. To enable the interface, the OVS DB daemon should be running with
6060 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6061 option is set, B<Address> and B<Port> options are ignored.
6063 =item B<Bridges> [I<brname> ...]
6065 List of OVS bridge names to be monitored by this plugin. If this option is
6066 omitted or is empty then all OVS bridges will be monitored.
6068 Default: empty (monitor all bridges)
6072 =head2 Plugin C<perl>
6074 This plugin embeds a Perl-interpreter into collectd and provides an interface
6075 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6077 =head2 Plugin C<pinba>
6079 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6080 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6081 PHP-based webpage has been delivered, the extension will send a UDP packet
6082 containing timing information, peak memory usage and so on. The plugin will
6083 wait for such packets, parse them and account the provided information, which
6084 is then dispatched to the daemon once per interval.
6091 # Overall statistics for the website.
6093 Server "www.example.com"
6095 # Statistics for www-a only
6097 Host "www-a.example.com"
6098 Server "www.example.com"
6100 # Statistics for www-b only
6102 Host "www-b.example.com"
6103 Server "www.example.com"
6107 The plugin provides the following configuration options:
6111 =item B<Address> I<Node>
6113 Configures the address used to open a listening socket. By default, plugin will
6114 bind to the I<any> address C<::0>.
6116 =item B<Port> I<Service>
6118 Configures the port (service) to bind to. By default the default Pinba port
6119 "30002" will be used. The option accepts service names in addition to port
6120 numbers and thus requires a I<string> argument.
6122 =item E<lt>B<View> I<Name>E<gt> block
6124 The packets sent by the Pinba extension include the hostname of the server, the
6125 server name (the name of the virtual host) and the script that was executed.
6126 Using B<View> blocks it is possible to separate the data into multiple groups
6127 to get more meaningful statistics. Each packet is added to all matching groups,
6128 so that a packet may be accounted for more than once.
6132 =item B<Host> I<Host>
6134 Matches the hostname of the system the webserver / script is running on. This
6135 will contain the result of the L<gethostname(2)> system call. If not
6136 configured, all hostnames will be accepted.
6138 =item B<Server> I<Server>
6140 Matches the name of the I<virtual host>, i.e. the contents of the
6141 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6142 server names will be accepted.
6144 =item B<Script> I<Script>
6146 Matches the name of the I<script name>, i.e. the contents of the
6147 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6148 script names will be accepted.
6154 =head2 Plugin C<ping>
6156 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6157 configured hosts periodically and measures the network latency. Whenever the
6158 C<read> function of the plugin is called, it submits the average latency, the
6159 standard deviation and the drop rate for each host.
6161 Available configuration options:
6165 =item B<Host> I<IP-address>
6167 Host to ping periodically. This option may be repeated several times to ping
6170 =item B<Interval> I<Seconds>
6172 Sets the interval in which to send ICMP echo packets to the configured hosts.
6173 This is B<not> the interval in which metrics are read from the plugin but the
6174 interval in which the hosts are "pinged". Therefore, the setting here should be
6175 smaller than or equal to the global B<Interval> setting. Fractional times, such
6176 as "1.24" are allowed.
6180 =item B<Timeout> I<Seconds>
6182 Time to wait for a response from the host to which an ICMP packet had been
6183 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6184 to be down or the packet to be dropped. This setting must be smaller than the
6185 B<Interval> setting above for the plugin to work correctly. Fractional
6186 arguments are accepted.
6190 =item B<TTL> I<0-255>
6192 Sets the Time-To-Live of generated ICMP packets.
6194 =item B<Size> I<size>
6196 Sets the size of the data payload in ICMP packet to specified I<size> (it
6197 will be filled with regular ASCII pattern). If not set, default 56 byte
6198 long string is used so that the packet size of an ICMPv4 packet is exactly
6199 64 bytes, similar to the behaviour of normal ping(1) command.
6201 =item B<SourceAddress> I<host>
6203 Sets the source address to use. I<host> may either be a numerical network
6204 address or a network hostname.
6206 =item B<AddressFamily> I<af>
6208 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6209 option will be ignored if you set a B<SourceAddress>.
6211 =item B<Device> I<name>
6213 Sets the outgoing network device to be used. I<name> has to specify an
6214 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6217 =item B<MaxMissed> I<Packets>
6219 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6220 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6222 Default: B<-1> (disabled)
6226 =head2 Plugin C<postgresql>
6228 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6229 keeps a persistent connection to all configured databases and tries to
6230 reconnect if the connection has been interrupted. A database is configured by
6231 specifying a B<Database> block as described below. The default statistics are
6232 collected from PostgreSQL's B<statistics collector> which thus has to be
6233 enabled for this plugin to work correctly. This should usually be the case by
6234 default. See the section "The Statistics Collector" of the B<PostgreSQL
6235 Documentation> for details.
6237 By specifying custom database queries using a B<Query> block as described
6238 below, you may collect any data that is available from some PostgreSQL
6239 database. This way, you are able to access statistics of external daemons
6240 which are available in a PostgreSQL database or use future or special
6241 statistics provided by PostgreSQL without the need to upgrade your collectd
6244 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6245 PostgreSQL databases as well. This has been implemented in a generic way. You
6246 need to specify an SQL statement which will then be executed by collectd in
6247 order to write the data (see below for details). The benefit of that approach
6248 is that there is no fixed database layout. Rather, the layout may be optimized
6249 for the current setup.
6251 The B<PostgreSQL Documentation> manual can be found at
6252 L<http://www.postgresql.org/docs/manuals/>.
6256 Statement "SELECT magic FROM wizard WHERE host = $1;"
6260 InstancePrefix "magic"
6265 <Query rt36_tickets>
6266 Statement "SELECT COUNT(type) AS count, type \
6268 WHEN resolved = 'epoch' THEN 'open' \
6269 ELSE 'resolved' END AS type \
6270 FROM tickets) type \
6274 InstancePrefix "rt36_tickets"
6275 InstancesFrom "type"
6281 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6292 KRBSrvName "kerberos_service_name"
6298 Service "service_name"
6299 Query backends # predefined
6310 The B<Query> block defines one database query which may later be used by a
6311 database definition. It accepts a single mandatory argument which specifies
6312 the name of the query. The names of all queries have to be unique (see the
6313 B<MinVersion> and B<MaxVersion> options below for an exception to this
6316 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6317 B<Result> blocks may be used to extract multiple values from a single query.
6319 The following configuration options are available to define the query:
6323 =item B<Statement> I<sql query statement>
6325 Specify the I<sql query statement> which the plugin should execute. The string
6326 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6327 first, second, etc. parameter. The value of the parameters is specified by the
6328 B<Param> configuration option - see below for details. To include a literal
6329 B<$> character followed by a number, surround it with single quotes (B<'>).
6331 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6332 allowed. Note, however, that only a single command may be used. Semicolons are
6333 allowed as long as a single non-empty command has been specified only.
6335 The returned lines will be handled separately one after another.
6337 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6339 Specify the parameters which should be passed to the SQL query. The parameters
6340 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6341 they appear in the configuration file. The value of the parameter is
6342 determined depending on the value of the B<Param> option as follows:
6348 The configured hostname of the database connection. If a UNIX domain socket is
6349 used, the parameter expands to "localhost".
6353 The name of the database of the current connection.
6357 The name of the database plugin instance. See the B<Instance> option of the
6358 database specification below for details.
6362 The username used to connect to the database.
6366 The interval with which this database is queried (as specified by the database
6367 specific or global B<Interval> options).
6371 Please note that parameters are only supported by PostgreSQL's protocol
6372 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6374 =item B<PluginInstanceFrom> I<column>
6376 Specify how to create the "PluginInstance" for reporting this query results.
6377 Only one column is supported. You may concatenate fields and string values in
6378 the query statement to get the required results.
6380 =item B<MinVersion> I<version>
6382 =item B<MaxVersion> I<version>
6384 Specify the minimum or maximum version of PostgreSQL that this query should be
6385 used with. Some statistics might only be available with certain versions of
6386 PostgreSQL. This allows you to specify multiple queries with the same name but
6387 which apply to different versions, thus allowing you to use the same
6388 configuration in a heterogeneous environment.
6390 The I<version> has to be specified as the concatenation of the major, minor
6391 and patch-level versions, each represented as two-decimal-digit numbers. For
6392 example, version 8.2.3 will become 80203.
6396 The B<Result> block defines how to handle the values returned from the query.
6397 It defines which column holds which value and how to dispatch that value to
6402 =item B<Type> I<type>
6404 The I<type> name to be used when dispatching the values. The type describes
6405 how to handle the data and where to store it. See L<types.db(5)> for more
6406 details on types and their configuration. The number and type of values (as
6407 selected by the B<ValuesFrom> option) has to match the type of the given name.
6409 This option is mandatory.
6411 =item B<InstancePrefix> I<prefix>
6413 =item B<InstancesFrom> I<column0> [I<column1> ...]
6415 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6416 B<InstancePrefix> defines a static prefix that will be prepended to all type
6417 instances. B<InstancesFrom> defines the column names whose values will be used
6418 to create the type instance. Multiple values will be joined together using the
6419 hyphen (C<->) as separation character.
6421 The plugin itself does not check whether or not all built instances are
6422 different. It is your responsibility to assure that each is unique.
6424 Both options are optional. If none is specified, the type instance will be
6427 =item B<ValuesFrom> I<column0> [I<column1> ...]
6429 Names the columns whose content is used as the actual data for the data sets
6430 that are dispatched to the daemon. How many such columns you need is
6431 determined by the B<Type> setting as explained above. If you specify too many
6432 or not enough columns, the plugin will complain about that and no data will be
6433 submitted to the daemon.
6435 The actual data type, as seen by PostgreSQL, is not that important as long as
6436 it represents numbers. The plugin will automatically cast the values to the
6437 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6438 L<strtod(3)> functions, so anything supported by those functions is supported
6439 by the plugin as well.
6441 This option is required inside a B<Result> block and may be specified multiple
6442 times. If multiple B<ValuesFrom> options are specified, the columns are read
6447 The following predefined queries are available (the definitions can be found
6448 in the F<postgresql_default.conf> file which, by default, is available at
6449 C<I<prefix>/share/collectd/>):
6455 This query collects the number of backends, i.E<nbsp>e. the number of
6458 =item B<transactions>
6460 This query collects the numbers of committed and rolled-back transactions of
6465 This query collects the numbers of various table modifications (i.E<nbsp>e.
6466 insertions, updates, deletions) of the user tables.
6468 =item B<query_plans>
6470 This query collects the numbers of various table scans and returned tuples of
6473 =item B<table_states>
6475 This query collects the numbers of live and dead rows in the user tables.
6479 This query collects disk block access counts for user tables.
6483 This query collects the on-disk size of the database in bytes.
6487 In addition, the following detailed queries are available by default. Please
6488 note that each of those queries collects information B<by table>, thus,
6489 potentially producing B<a lot> of data. For details see the description of the
6490 non-by_table queries above.
6494 =item B<queries_by_table>
6496 =item B<query_plans_by_table>
6498 =item B<table_states_by_table>
6500 =item B<disk_io_by_table>
6504 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6505 mandatory argument specifying the name of the writer. This will then be used
6506 in the B<Database> specification in order to activate the writer instance. The
6507 names of all writers have to be unique. The following options may be
6512 =item B<Statement> I<sql statement>
6514 This mandatory option specifies the SQL statement that will be executed for
6515 each submitted value. A single SQL statement is allowed only. Anything after
6516 the first semicolon will be ignored.
6518 Nine parameters will be passed to the statement and should be specified as
6519 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6520 values are made available through those parameters:
6526 The timestamp of the queried value as an RFC 3339-formatted local time.
6530 The hostname of the queried value.
6534 The plugin name of the queried value.
6538 The plugin instance of the queried value. This value may be B<NULL> if there
6539 is no plugin instance.
6543 The type of the queried value (cf. L<types.db(5)>).
6547 The type instance of the queried value. This value may be B<NULL> if there is
6552 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6553 sources of the submitted value-list).
6557 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6558 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6559 B<StoreRates> is enabled (which is the default, see below), all types will be
6564 An array of the submitted values. The dimensions of the value name and value
6569 In general, it is advisable to create and call a custom function in the
6570 PostgreSQL database for this purpose. Any procedural language supported by
6571 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6574 =item B<StoreRates> B<false>|B<true>
6576 If set to B<true> (the default), convert counter values to rates. If set to
6577 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6582 The B<Database> block defines one PostgreSQL database for which to collect
6583 statistics. It accepts a single mandatory argument which specifies the
6584 database name. None of the other options are required. PostgreSQL will use
6585 default values as documented in the section "CONNECTING TO A DATABASE" in the
6586 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6587 the user collectd is run as and special environment variables. See the manpage
6592 =item B<Interval> I<seconds>
6594 Specify the interval with which the database should be queried. The default is
6595 to use the global B<Interval> setting.
6597 =item B<CommitInterval> I<seconds>
6599 This option may be used for database connections which have "writers" assigned
6600 (see above). If specified, it causes a writer to put several updates into a
6601 single transaction. This transaction will last for the specified amount of
6602 time. By default, each update will be executed in a separate transaction. Each
6603 transaction generates a fair amount of overhead which can, thus, be reduced by
6604 activating this option. The draw-back is, that data covering the specified
6605 amount of time will be lost, for example, if a single statement within the
6606 transaction fails or if the database server crashes.
6608 =item B<Plugin> I<Plugin>
6610 Use I<Plugin> as the plugin name when submitting query results from
6611 this B<Database>. Defaults to C<postgresql>.
6613 =item B<Instance> I<name>
6615 Specify the plugin instance name that should be used instead of the database
6616 name (which is the default, if this option has not been specified). This
6617 allows one to query multiple databases of the same name on the same host (e.g.
6618 when running multiple database server versions in parallel).
6619 The plugin instance name can also be set from the query result using
6620 the B<PluginInstanceFrom> option in B<Query> block.
6622 =item B<Host> I<hostname>
6624 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6625 value begins with a slash, it is interpreted as the directory name in which to
6626 look for the UNIX domain socket.
6628 This option is also used to determine the hostname that is associated with a
6629 collected data set. If it has been omitted or either begins with with a slash
6630 or equals B<localhost> it will be replaced with the global hostname definition
6631 of collectd. Any other value will be passed literally to collectd when
6632 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6634 =item B<Port> I<port>
6636 Specify the TCP port or the local UNIX domain socket file extension of the
6639 =item B<User> I<username>
6641 Specify the username to be used when connecting to the server.
6643 =item B<Password> I<password>
6645 Specify the password to be used when connecting to the server.
6647 =item B<ExpireDelay> I<delay>
6649 Skip expired values in query output.
6651 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6653 Specify whether to use an SSL connection when contacting the server. The
6654 following modes are supported:
6660 Do not use SSL at all.
6664 First, try to connect without using SSL. If that fails, try using SSL.
6666 =item I<prefer> (default)
6668 First, try to connect using SSL. If that fails, try without using SSL.
6676 =item B<Instance> I<name>
6678 Specify the plugin instance name that should be used instead of the database
6679 name (which is the default, if this option has not been specified). This
6680 allows one to query multiple databases of the same name on the same host (e.g.
6681 when running multiple database server versions in parallel).
6683 =item B<KRBSrvName> I<kerberos_service_name>
6685 Specify the Kerberos service name to use when authenticating with Kerberos 5
6686 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6687 B<PostgreSQL Documentation> for details.
6689 =item B<Service> I<service_name>
6691 Specify the PostgreSQL service name to use for additional parameters. That
6692 service has to be defined in F<pg_service.conf> and holds additional
6693 connection parameters. See the section "The Connection Service File" in the
6694 B<PostgreSQL Documentation> for details.
6696 =item B<Query> I<query>
6698 Specifies a I<query> which should be executed in the context of the database
6699 connection. This may be any of the predefined or user-defined queries. If no
6700 such option is given, it defaults to "backends", "transactions", "queries",
6701 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6702 has been specified). Else, the specified queries are used only.
6704 =item B<Writer> I<writer>
6706 Assigns the specified I<writer> backend to the database connection. This
6707 causes all collected data to be send to the database using the settings
6708 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6709 below for details on how to selectively send data to certain plugins).
6711 Each writer will register a flush callback which may be used when having long
6712 transactions enabled (see the B<CommitInterval> option above). When issuing
6713 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6714 transaction will be committed right away. Two different kinds of flush
6715 callbacks are available with the C<postgresql> plugin:
6721 Flush all writer backends.
6723 =item B<postgresql->I<database>
6725 Flush all writers of the specified I<database> only.
6731 =head2 Plugin C<powerdns>
6733 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6734 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6735 values, many of which are probably meaningless to most users, but may be useful
6736 for some. So you may chose which values to collect, but if you don't, some
6737 reasonable defaults will be collected.
6740 <Server "server_name">
6742 Collect "udp-answers" "udp-queries"
6743 Socket "/var/run/pdns.controlsocket"
6745 <Recursor "recursor_name">
6747 Collect "cache-hits" "cache-misses"
6748 Socket "/var/run/pdns_recursor.controlsocket"
6750 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6755 =item B<Server> and B<Recursor> block
6757 The B<Server> block defines one authoritative server to query, the B<Recursor>
6758 does the same for an recursing server. The possible options in both blocks are
6759 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6764 =item B<Collect> I<Field>
6766 Using the B<Collect> statement you can select which values to collect. Here,
6767 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6768 C<dlg-only-drops>, C<answers10-100>.
6770 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6771 When querying the server a C<SHOW *> command is issued in any case, because
6772 that's the only way of getting multiple values out of the server at once.
6773 collectd then picks out the values you have selected. When querying the
6774 recursor, a command is generated to query exactly these values. So if you
6775 specify invalid fields when querying the recursor, a syntax error may be
6776 returned by the daemon and collectd may not collect any values at all.
6778 If no B<Collect> statement is given, the following B<Server> values will be
6785 =item packetcache-hit
6787 =item packetcache-miss
6789 =item packetcache-size
6791 =item query-cache-hit
6793 =item query-cache-miss
6795 =item recursing-answers
6797 =item recursing-questions
6809 The following B<Recursor> values will be collected by default:
6813 =item noerror-answers
6815 =item nxdomain-answers
6817 =item servfail-answers
6835 Please note that up to that point collectd doesn't know what values are
6836 available on the server and values that are added do not need a change of the
6837 mechanism so far. However, the values must be mapped to collectd's naming
6838 scheme, which is done using a lookup table that lists all known values. If
6839 values are added in the future and collectd does not know about them, you will
6840 get an error much like this:
6842 powerdns plugin: submit: Not found in lookup table: foobar = 42
6844 In this case please file a bug report with the collectd team.
6846 =item B<Socket> I<Path>
6848 Configures the path to the UNIX domain socket to be used when connecting to the
6849 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6850 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6851 will be used for the recursor.
6855 =item B<LocalSocket> I<Path>
6857 Querying the recursor is done using UDP. When using UDP over UNIX domain
6858 sockets, the client socket needs a name in the file system, too. You can set
6859 this local name to I<Path> using the B<LocalSocket> option. The default is
6860 C<I<prefix>/var/run/collectd-powerdns>.
6864 =head2 Plugin C<processes>
6866 Collects information about processes of local system.
6868 By default, with no process matches configured, only general statistics is
6869 collected: the number of processes in each state and fork rate.
6871 Process matches can be configured by B<Process> and B<ProcessMatch> options.
6872 These may also be a block in which further options may be specified.
6874 The statistics collected for matched processes are:
6875 - size of the resident segment size (RSS)
6876 - user- and system-time used
6877 - number of processes
6879 - number of open files (under Linux)
6880 - number of memory mapped files (under Linux)
6881 - io data (where available)
6882 - context switches (under Linux)
6883 - minor and major pagefaults
6884 - Delay Accounting information (Linux only, requires libmnl)
6889 CollectFileDescriptor true
6890 CollectContextSwitch true
6891 CollectDelayAccounting false
6893 ProcessMatch "name" "regex"
6894 <Process "collectd">
6895 CollectFileDescriptor false
6896 CollectContextSwitch false
6897 CollectDelayAccounting true
6899 <ProcessMatch "name" "regex">
6900 CollectFileDescriptor false
6901 CollectContextSwitch true
6907 =item B<Process> I<Name>
6909 Select more detailed statistics of processes matching this name.
6911 Some platforms have a limit on the length of process names.
6912 I<Name> must stay below this limit.
6914 =item B<ProcessMatch> I<name> I<regex>
6916 Select more detailed statistics of processes matching the specified I<regex>
6917 (see L<regex(7)> for details). The statistics of all matching processes are
6918 summed up and dispatched to the daemon using the specified I<name> as an
6919 identifier. This allows one to "group" several processes together.
6920 I<name> must not contain slashes.
6922 =item B<CollectContextSwitch> I<Boolean>
6924 Collect the number of context switches for matched processes.
6925 Disabled by default.
6927 =item B<CollectDelayAccounting> I<Boolean>
6929 If enabled, collect Linux Delay Accounding information for matching processes.
6930 Delay Accounting provides the time processes wait for the CPU to become
6931 available, for I/O operations to finish, for pages to be swapped in and for
6932 freed pages to be reclaimed. The metrics are reported as "seconds per second"
6933 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
6934 Disabled by default.
6936 This option is only available on Linux, requires the C<libmnl> library and
6937 requires the C<CAP_NET_ADMIN> capability at runtime.
6939 =item B<CollectFileDescriptor> I<Boolean>
6941 Collect number of file descriptors of matched processes.
6942 Disabled by default.
6944 =item B<CollectMemoryMaps> I<Boolean>
6946 Collect the number of memory mapped files of the process.
6947 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
6952 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
6953 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
6954 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
6955 reporting the corresponding processes only. Outside of B<Process> and
6956 B<ProcessMatch> blocks these options set the default value for subsequent
6959 =head2 Plugin C<protocols>
6961 Collects a lot of information about various network protocols, such as I<IP>,
6962 I<TCP>, I<UDP>, etc.
6964 Available configuration options:
6968 =item B<Value> I<Selector>
6970 Selects whether or not to select a specific value. The string being matched is
6971 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6972 plugin instance and I<ValueName> will be used as type instance. An example of
6973 the string being used would be C<Tcp:RetransSegs>.
6975 You can use regular expressions to match a large number of values with just one
6976 configuration option. To select all "extended" I<TCP> values, you could use the
6977 following statement:
6981 Whether only matched values are selected or all matched values are ignored
6982 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6983 If no value is configured at all, all values will be selected.
6985 See F</"IGNORELISTS"> for details.
6987 =item B<IgnoreSelected> B<true>|B<false>
6989 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6990 matching values will be ignored.
6994 =head2 Plugin C<python>
6996 This plugin embeds a Python-interpreter into collectd and provides an interface
6997 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6999 =head2 Plugin C<routeros>
7001 The C<routeros> plugin connects to a device running I<RouterOS>, the
7002 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7003 I<librouteros> to connect and reads information about the interfaces and
7004 wireless connections of the device. The configuration supports querying
7009 Host "router0.example.com"
7012 CollectInterface true
7017 Host "router1.example.com"
7020 CollectInterface true
7021 CollectRegistrationTable true
7027 As you can see above, the configuration of the I<routeros> plugin consists of
7028 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7029 options are understood:
7033 =item B<Host> I<Host>
7035 Hostname or IP-address of the router to connect to.
7037 =item B<Port> I<Port>
7039 Port name or port number used when connecting. If left unspecified, the default
7040 will be chosen by I<librouteros>, currently "8728". This option expects a
7041 string argument, even when a numeric port number is given.
7043 =item B<User> I<User>
7045 Use the user name I<User> to authenticate. Defaults to "admin".
7047 =item B<Password> I<Password>
7049 Set the password used to authenticate.
7051 =item B<CollectInterface> B<true>|B<false>
7053 When set to B<true>, interface statistics will be collected for all interfaces
7054 present on the device. Defaults to B<false>.
7056 =item B<CollectRegistrationTable> B<true>|B<false>
7058 When set to B<true>, information about wireless LAN connections will be
7059 collected. Defaults to B<false>.
7061 =item B<CollectCPULoad> B<true>|B<false>
7063 When set to B<true>, information about the CPU usage will be collected. The
7064 number is a dimensionless value where zero indicates no CPU usage at all.
7065 Defaults to B<false>.
7067 =item B<CollectMemory> B<true>|B<false>
7069 When enabled, the amount of used and free memory will be collected. How used
7070 memory is calculated is unknown, for example whether or not caches are counted
7072 Defaults to B<false>.
7074 =item B<CollectDF> B<true>|B<false>
7076 When enabled, the amount of used and free disk space will be collected.
7077 Defaults to B<false>.
7079 =item B<CollectDisk> B<true>|B<false>
7081 When enabled, the number of sectors written and bad blocks will be collected.
7082 Defaults to B<false>.
7086 =head2 Plugin C<redis>
7088 The I<Redis plugin> connects to one or more Redis servers and gathers
7089 information about each server's state. For each server there is a I<Node> block
7090 which configures the connection parameters for this node.
7097 <Query "LLEN myqueue">
7104 The information shown in the synopsis above is the I<default configuration>
7105 which is used by the plugin if no configuration is present.
7109 =item B<Node> I<Nodename>
7111 The B<Node> block identifies a new Redis node, that is a new Redis instance
7112 running in an specified host and port. The name for node is a canonical
7113 identifier which is used as I<plugin instance>. It is limited to
7114 64E<nbsp>characters in length.
7116 =item B<Host> I<Hostname>
7118 The B<Host> option is the hostname or IP-address where the Redis instance is
7121 =item B<Port> I<Port>
7123 The B<Port> option is the TCP port on which the Redis instance accepts
7124 connections. Either a service name of a port number may be given. Please note
7125 that numerical port numbers must be given as a string, too.
7127 =item B<Password> I<Password>
7129 Use I<Password> to authenticate when connecting to I<Redis>.
7131 =item B<Timeout> I<Milliseconds>
7133 The B<Timeout> option set the socket timeout for node response. Since the Redis
7134 read function is blocking, you should keep this value as low as possible. Keep
7135 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
7136 than B<Interval> defined globally.
7138 =item B<Query> I<Querystring>
7140 The B<Query> block identifies a query to execute against the redis server.
7141 There may be an arbitrary number of queries to execute.
7143 =item B<Type> I<Collectd type>
7145 Within a query definition, a valid collectd type to use as when submitting
7146 the result of the query. When not supplied, will default to B<gauge>.
7148 =item B<Instance> I<Type instance>
7150 Within a query definition, an optional type instance to use when submitting
7151 the result of the query. When not supplied will default to the escaped
7152 command, up to 64 chars.
7156 =head2 Plugin C<rrdcached>
7158 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7159 to store values to RRD files in an efficient manner. The combination of the
7160 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7161 way the C<rrdtool> plugin works (see below). The added abstraction layer
7162 provides a number of benefits, though: Because the cache is not within
7163 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7164 restarted. This results in much shorter (if any) gaps in graphs, especially
7165 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7166 daemon so that it can flush values to disk automatically when needed. This
7167 allows one to integrate automated flushing of values into graphing solutions
7170 There are disadvantages, though: The daemon may reside on a different host, so
7171 it may not be possible for C<collectd> to create the appropriate RRD files
7172 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7173 different base directory, so relative paths may do weird stuff if you're not
7176 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7177 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7178 setting should be set to an absolute path, so that a changed base directory
7179 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7183 =item B<DaemonAddress> I<Address>
7185 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7186 library. See L<rrdcached(1)> for details. Example:
7188 <Plugin "rrdcached">
7189 DaemonAddress "unix:/var/run/rrdcached.sock"
7192 =item B<DataDir> I<Directory>
7194 Set the base directory in which the RRD files reside. If this is a relative
7195 path, it is relative to the working base directory of the C<rrdcached> daemon!
7196 Use of an absolute path is recommended.
7198 =item B<CreateFiles> B<true>|B<false>
7200 Enables or disables the creation of RRD files. If the daemon is not running
7201 locally, or B<DataDir> is set to a relative path, this will not work as
7202 expected. Default is B<true>.
7204 =item B<CreateFilesAsync> B<false>|B<true>
7206 When enabled, new RRD files are enabled asynchronously, using a separate thread
7207 that runs in the background. This prevents writes to block, which is a problem
7208 especially when many hundreds of files need to be created at once. However,
7209 since the purpose of creating the files asynchronously is I<not> to block until
7210 the file is available, values before the file is available will be discarded.
7211 When disabled (the default) files are created synchronously, blocking for a
7212 short while, while the file is being written.
7214 =item B<StepSize> I<Seconds>
7216 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7217 this setting is unset and the stepsize is set to the interval in which the data
7218 is collected. Do not use this option unless you absolutely have to for some
7219 reason. Setting this option may cause problems with the C<snmp plugin>, the
7220 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7222 =item B<HeartBeat> I<Seconds>
7224 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7225 in which case the heartbeat is set to twice the B<StepSize> which should equal
7226 the interval in which data is collected. Do not set this option unless you have
7227 a very good reason to do so.
7229 =item B<RRARows> I<NumRows>
7231 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7232 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7233 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7234 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7235 week, one month, and one year.
7237 So for each timespan, it calculates how many PDPs need to be consolidated into
7238 one CDP by calculating:
7239 number of PDPs = timespan / (stepsize * rrarows)
7241 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7244 =item B<RRATimespan> I<Seconds>
7246 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7247 more then one RRA. If this option is never used, the built-in default of (3600,
7248 86400, 604800, 2678400, 31622400) is used.
7250 For more information on how RRA-sizes are calculated see B<RRARows> above.
7252 =item B<XFF> I<Factor>
7254 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7255 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7258 =item B<CollectStatistics> B<false>|B<true>
7260 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7261 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7263 Statistics are read via I<rrdcached>s socket using the STATS command.
7264 See L<rrdcached(1)> for details.
7268 =head2 Plugin C<rrdtool>
7270 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7271 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7272 using these settings. If you don't want to dive into the depths of RRDtool, you
7273 can safely ignore these settings.
7277 =item B<DataDir> I<Directory>
7279 Set the directory to store RRD files under. By default RRD files are generated
7280 beneath the daemon's working directory, i.e. the B<BaseDir>.
7282 =item B<CreateFilesAsync> B<false>|B<true>
7284 When enabled, new RRD files are enabled asynchronously, using a separate thread
7285 that runs in the background. This prevents writes to block, which is a problem
7286 especially when many hundreds of files need to be created at once. However,
7287 since the purpose of creating the files asynchronously is I<not> to block until
7288 the file is available, values before the file is available will be discarded.
7289 When disabled (the default) files are created synchronously, blocking for a
7290 short while, while the file is being written.
7292 =item B<StepSize> I<Seconds>
7294 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7295 this setting is unset and the stepsize is set to the interval in which the data
7296 is collected. Do not use this option unless you absolutely have to for some
7297 reason. Setting this option may cause problems with the C<snmp plugin>, the
7298 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7300 =item B<HeartBeat> I<Seconds>
7302 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7303 in which case the heartbeat is set to twice the B<StepSize> which should equal
7304 the interval in which data is collected. Do not set this option unless you have
7305 a very good reason to do so.
7307 =item B<RRARows> I<NumRows>
7309 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7310 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7311 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7312 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7313 week, one month, and one year.
7315 So for each timespan, it calculates how many PDPs need to be consolidated into
7316 one CDP by calculating:
7317 number of PDPs = timespan / (stepsize * rrarows)
7319 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7322 =item B<RRATimespan> I<Seconds>
7324 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7325 more then one RRA. If this option is never used, the built-in default of (3600,
7326 86400, 604800, 2678400, 31622400) is used.
7328 For more information on how RRA-sizes are calculated see B<RRARows> above.
7330 =item B<XFF> I<Factor>
7332 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7333 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7336 =item B<CacheFlush> I<Seconds>
7338 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7339 it writes all values for a certain RRD-file if the oldest value is older than
7340 (or equal to) the number of seconds specified by B<CacheTimeout>.
7341 That check happens on new values arriwal. If some RRD-file is not updated
7342 anymore for some reason (the computer was shut down, the network is broken,
7343 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7344 every I<Seconds> seconds the entire cache is searched for entries older than
7345 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7346 disk. Since scanning the entire cache is kind of expensive and does nothing
7347 under normal circumstances, this value should not be too small. 900 seconds
7348 might be a good value, though setting this to 7200 seconds doesn't normally
7349 do much harm either.
7351 Defaults to 10x B<CacheTimeout>.
7352 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7353 above default is used.
7355 =item B<CacheTimeout> I<Seconds>
7357 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7358 save values in a cache, as described above. Writing multiple values at once
7359 reduces IO-operations and thus lessens the load produced by updating the files.
7360 The trade off is that the graphs kind of "drag behind" and that more memory is
7363 =item B<WritesPerSecond> I<Updates>
7365 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7366 will run serious performance problems. The B<CacheFlush> setting and the
7367 internal update queue assert that collectd continues to work just fine even
7368 under heavy load, but the system may become very unresponsive and slow. This is
7369 a problem especially if you create graphs from the RRD files on the same
7370 machine, for example using the C<graph.cgi> script included in the
7371 C<contrib/collection3/> directory.
7373 This setting is designed for very large setups. Setting this option to a value
7374 between 25 and 80 updates per second, depending on your hardware, will leave
7375 the server responsive enough to draw graphs even while all the cached values
7376 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7377 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7378 written as fast as possible, so that web frontends have up to date data when
7381 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7382 updates per second, writing all values to disk will take approximately
7383 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7384 "collection3" you'll end up with a responsive and fast system, up to date
7385 graphs and basically a "backup" of your values every hour.
7387 =item B<RandomTimeout> I<Seconds>
7389 When set, the actual timeout for each value is chosen randomly between
7390 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7391 intention is to avoid high load situations that appear when many values timeout
7392 at the same time. This is especially a problem shortly after the daemon starts,
7393 because all values were added to the internal cache at roughly the same time.
7397 =head2 Plugin C<sensors>
7399 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7400 that all the needed modules have to be loaded and lm_sensors has to be
7401 configured (most likely by editing F</etc/sensors.conf>. Read
7402 L<sensors.conf(5)> for details.
7404 The B<lm_sensors> homepage can be found at
7405 L<http://secure.netroedge.com/~lm78/>.
7409 =item B<SensorConfigFile> I<File>
7411 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7412 the library's default will be used.
7414 =item B<Sensor> I<chip-bus-address/type-feature>
7416 Selects the name of the sensor which you want to collect or ignore, depending
7417 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7418 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7419 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7421 See F</"IGNORELISTS"> for details.
7423 =item B<IgnoreSelected> I<true>|I<false>
7425 If no configuration if given, the B<sensors>-plugin will collect data from all
7426 sensors. This may not be practical, especially for uninteresting sensors.
7427 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7428 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7429 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7430 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7431 and all other sensors are collected.
7433 =item B<UseLabels> I<true>|I<false>
7435 Configures how sensor readings are reported. When set to I<true>, sensor
7436 readings are reported using their descriptive label (e.g. "VCore"). When set to
7437 I<false> (the default) the sensor name is used ("in0").
7441 =head2 Plugin C<sigrok>
7443 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7444 supported by the L<sigrok|http://sigrok.org/> project.
7450 <Device "AC Voltage">
7455 <Device "Sound Level">
7456 Driver "cem-dt-885x"
7463 =item B<LogLevel> B<0-5>
7465 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7466 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7467 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7468 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7469 their level, are always submitted to I<collectd> at its INFO log level.
7471 =item E<lt>B<Device> I<Name>E<gt>
7473 A sigrok-supported device, uniquely identified by this section's options. The
7474 I<Name> is passed to I<collectd> as the I<plugin instance>.
7476 =item B<Driver> I<DriverName>
7478 The sigrok driver to use for this device.
7480 =item B<Conn> I<ConnectionSpec>
7482 If the device cannot be auto-discovered, or more than one might be discovered
7483 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7484 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7485 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7486 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7487 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7489 =item B<SerialComm> I<SerialSpec>
7491 For serial devices with non-standard port settings, this option can be used
7492 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7493 This should not be necessary; drivers know how to communicate with devices they
7496 =item B<MinimumInterval> I<Seconds>
7498 Specifies the minimum time between measurement dispatches to I<collectd>, in
7499 seconds. Since some I<sigrok> supported devices can acquire measurements many
7500 times per second, it may be necessary to throttle these. For example, the
7501 I<RRD plugin> cannot process writes more than once per second.
7503 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7504 device are always dispatched to I<collectd>. When throttled, unused
7505 measurements are discarded.
7509 =head2 Plugin C<smart>
7511 The C<smart> plugin collects SMART information from physical
7512 disks. Values collectd include temperature, power cycle count, poweron
7513 time and bad sectors. Also, all SMART attributes are collected along
7514 with the normalized current value, the worst value, the threshold and
7515 a human readable value.
7517 Using the following two options you can ignore some disks or configure the
7518 collection only of specific disks.
7522 =item B<Disk> I<Name>
7524 Select the disk I<Name>. Whether it is collected or ignored depends on the
7525 B<IgnoreSelected> setting, see below. As with other plugins that use the
7526 daemon's ignorelist functionality, a string that starts and ends with a slash
7527 is interpreted as a regular expression. Examples:
7532 See F</"IGNORELISTS"> for details.
7534 =item B<IgnoreSelected> B<true>|B<false>
7536 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7537 statements, are ignored or if all other disks are ignored. The behavior
7538 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7539 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7540 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7541 is set to B<true>, all disks are collected B<except> the ones matched.
7543 =item B<IgnoreSleepMode> B<true>|B<false>
7545 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7546 This option disables the sleep mode check and allows the plugin to collect data
7547 from these disks anyway. This is useful in cases where libatasmart mistakenly
7548 reports disks as asleep because it has not been updated to incorporate support
7549 for newer idle states in the ATA spec.
7551 =item B<UseSerial> B<true>|B<false>
7553 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7554 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7555 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7556 storing data. This ensures that the data for a given disk will be kept together
7557 even if the kernel name changes.
7561 =head2 Plugin C<snmp>
7563 Since the configuration of the C<snmp plugin> is a little more complicated than
7564 other plugins, its documentation has been moved to an own manpage,
7565 L<collectd-snmp(5)>. Please see there for details.
7567 =head2 Plugin C<snmp_agent>
7569 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7570 from SNMP master agent and returns the data collected by read plugins.
7571 The I<snmp_agent> plugin handles requests only for OIDs specified in
7572 configuration file. To handle SNMP queries the plugin gets data from collectd
7573 and translates requested values from collectd's internal format to SNMP format.
7574 This plugin is a generic plugin and cannot work without configuration.
7575 For more details on AgentX subagent see
7576 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7581 <Data "memAvailReal">
7583 #PluginInstance "some"
7586 OIDs "1.3.6.1.4.1.2021.4.6.0"
7589 IndexOID "IF-MIB::ifIndex"
7590 SizeOID "IF-MIB::ifNumber"
7594 OIDs "IF-MIB::ifDescr"
7600 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7605 There are two types of blocks that can be contained in the
7606 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7608 =head3 The B<Data> block
7610 The B<Data> block defines a list OIDs that are to be handled. This block can
7611 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7612 block it reperesents table OIDs.
7613 The following options can be set:
7617 =item B<Instance> I<true|false>
7619 When B<Instance> is set to B<true>, the value for requested OID is copied from
7620 plugin instance field of corresponding collectd value. If B<Data> block defines
7621 scalar data type B<Instance> has no effect and can be omitted.
7623 =item B<Plugin> I<String>
7625 Read plugin name whose collected data will be mapped to specified OIDs.
7627 =item B<PluginInstance> I<String>
7629 Read plugin instance whose collected data will be mapped to specified OIDs.
7630 The field is optional and by default there is no plugin instance check.
7631 Allowed only if B<Data> block defines scalar data type.
7633 =item B<Type> I<String>
7635 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7636 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7638 =item B<TypeInstance> I<String>
7640 Collectd's type-instance that is to be used for specified OID.
7642 =item B<OIDs> I<OID> [I<OID> ...]
7644 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7645 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7646 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7647 configured should correspond to number of values in specified B<Type>.
7648 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7649 "rx" and "tx" values of "if_octets" type.
7651 =item B<Scale> I<Value>
7653 The values taken from collectd are multiplied by I<Value>. The field is optional
7654 and the default is B<1.0>.
7656 =item B<Shift> I<Value>
7658 I<Value> is added to values from collectd after they have been multiplied by
7659 B<Scale> value. The field is optional and the default value is B<0.0>.
7663 =head3 The B<Table> block
7665 The B<Table> block defines a collection of B<Data> blocks that belong to one
7666 snmp table. In addition to multiple B<Data> blocks the following options can be
7671 =item B<IndexOID> I<OID>
7673 OID that is handled by the plugin and is mapped to numerical index value that is
7674 generated by the plugin for each table record.
7676 =item B<SizeOID> I<OID>
7678 OID that is handled by the plugin. Returned value is the number of records in
7679 the table. The field is optional.
7683 =head2 Plugin C<statsd>
7685 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7686 protocol and dispatches rates or other aggregates of these numbers
7689 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7690 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7691 C<objects> respectively.
7693 The following configuration options are valid:
7697 =item B<Host> I<Host>
7699 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7700 "any" address, i.e. accept packets sent to any of the hosts addresses.
7702 =item B<Port> I<Port>
7704 UDP port to listen to. This can be either a service name or a port number.
7705 Defaults to C<8125>.
7707 =item B<DeleteCounters> B<false>|B<true>
7709 =item B<DeleteTimers> B<false>|B<true>
7711 =item B<DeleteGauges> B<false>|B<true>
7713 =item B<DeleteSets> B<false>|B<true>
7715 These options control what happens if metrics are not updated in an interval.
7716 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7717 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7718 are unchanged. If set to B<True>, the such metrics are not dispatched and
7719 removed from the internal cache.
7721 =item B<CounterSum> B<false>|B<true>
7723 When enabled, creates a C<count> metric which reports the change since the last
7724 read. This option primarily exists for compatibility with the I<statsd>
7725 implementation by Etsy.
7727 =item B<TimerPercentile> I<Percent>
7729 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7730 that I<Percent> of all reported timers are smaller than or equal to the
7731 computed latency. This is useful for cutting off the long tail latency, as it's
7732 often done in I<Service Level Agreements> (SLAs).
7734 Different percentiles can be calculated by setting this option several times.
7735 If none are specified, no percentiles are calculated / dispatched.
7737 =item B<TimerLower> B<false>|B<true>
7739 =item B<TimerUpper> B<false>|B<true>
7741 =item B<TimerSum> B<false>|B<true>
7743 =item B<TimerCount> B<false>|B<true>
7745 Calculate and dispatch various values out of I<Timer> metrics received during
7746 an interval. If set to B<False>, the default, these values aren't calculated /
7749 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
7753 =head2 Plugin C<swap>
7755 The I<Swap plugin> collects information about used and available swap space. On
7756 I<Linux> and I<Solaris>, the following options are available:
7760 =item B<ReportByDevice> B<false>|B<true>
7762 Configures how to report physical swap devices. If set to B<false> (the
7763 default), the summary over all swap devices is reported only, i.e. the globally
7764 used and available space over all devices. If B<true> is configured, the used
7765 and available space of each device will be reported separately.
7767 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7768 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7770 =item B<ReportBytes> B<false>|B<true>
7772 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7773 I<swap I/O> is reported in pages. This option is available under Linux only.
7775 =item B<ValuesAbsolute> B<true>|B<false>
7777 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7778 available and used. Defaults to B<true>.
7780 =item B<ValuesPercentage> B<false>|B<true>
7782 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7783 available and free. Defaults to B<false>.
7785 This is useful for deploying I<collectd> in a heterogeneous environment, where
7786 swap sizes differ and you want to specify generic thresholds or similar.
7788 =item B<ReportIO> B<true>|B<false>
7790 Enables or disables reporting swap IO. Defaults to B<true>.
7792 This is useful for the cases when swap IO is not neccessary, is not available,
7797 =head2 Plugin C<syslog>
7801 =item B<LogLevel> B<debug|info|notice|warning|err>
7803 Sets the log-level. If, for example, set to B<notice>, then all events with
7804 severity B<notice>, B<warning>, or B<err> will be submitted to the
7807 Please note that B<debug> is only available if collectd has been compiled with
7810 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7812 Controls which notifications should be sent to syslog. The default behaviour is
7813 not to send any. Less severe notifications always imply logging more severe
7814 notifications: Setting this to B<OKAY> means all notifications will be sent to
7815 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7816 notifications but will dismiss B<OKAY> notifications. Setting this option to
7817 B<FAILURE> will only send failures to syslog.
7821 =head2 Plugin C<table>
7823 The C<table plugin> provides generic means to parse tabular data and dispatch
7824 user specified values. Values are selected based on column numbers. For
7825 example, this plugin may be used to get values from the Linux L<proc(5)>
7826 filesystem or CSV (comma separated values) files.
7829 <Table "/proc/slabinfo">
7835 InstancePrefix "active_objs"
7841 InstancePrefix "objperslab"
7848 The configuration consists of one or more B<Table> blocks, each of which
7849 configures one file to parse. Within each B<Table> block, there are one or
7850 more B<Result> blocks, which configure which data to select and how to
7853 The following options are available inside a B<Table> block:
7857 =item B<Plugin> I<Plugin>
7859 If specified, I<Plugin> is used as the plugin name when submitting values.
7860 Defaults to B<table>.
7862 =item B<Instance> I<instance>
7864 If specified, I<instance> is used as the plugin instance. If omitted, the
7865 filename of the table is used instead, with all special characters replaced
7866 with an underscore (C<_>).
7868 =item B<Separator> I<string>
7870 Any character of I<string> is interpreted as a delimiter between the different
7871 columns of the table. A sequence of two or more contiguous delimiters in the
7872 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7873 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7874 of a table - see its documentation for more details. This option is mandatory.
7876 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7877 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7878 required because of collectd's config parsing.
7882 The following options are available inside a B<Result> block:
7886 =item B<Type> I<type>
7888 Sets the type used to dispatch the values to the daemon. Detailed information
7889 about types and their configuration can be found in L<types.db(5)>. This
7890 option is mandatory.
7892 =item B<InstancePrefix> I<prefix>
7894 If specified, prepend I<prefix> to the type instance. If omitted, only the
7895 B<InstancesFrom> option is considered for the type instance.
7897 =item B<InstancesFrom> I<column0> [I<column1> ...]
7899 If specified, the content of the given columns (identified by the column
7900 number starting at zero) will be used to create the type instance for each
7901 row. Multiple values (and the instance prefix) will be joined together with
7902 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7903 option is considered for the type instance.
7905 The plugin itself does not check whether or not all built instances are
7906 different. It’s your responsibility to assure that each is unique. This is
7907 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7908 sure that the table only contains one row.
7910 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7913 =item B<ValuesFrom> I<column0> [I<column1> ...]
7915 Specifies the columns (identified by the column numbers starting at zero)
7916 whose content is used as the actual data for the data sets that are dispatched
7917 to the daemon. How many such columns you need is determined by the B<Type>
7918 setting above. If you specify too many or not enough columns, the plugin will
7919 complain about that and no data will be submitted to the daemon. The plugin
7920 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7921 respectively, so anything supported by those functions is supported by the
7922 plugin as well. This option is mandatory.
7926 =head2 Plugin C<tail>
7928 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7929 each line and dispatches found values. What is matched can be configured by the
7930 user using (extended) regular expressions, as described in L<regex(7)>.
7933 <File "/var/log/exim4/mainlog">
7938 Regex "S=([1-9][0-9]*)"
7944 Regex "\\<R=local_user\\>"
7945 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7948 Instance "local_user"
7951 Regex "l=([0-9]*\\.[0-9]*)"
7952 <DSType "Distribution">
7955 #BucketType "bucket"
7963 The config consists of one or more B<File> blocks, each of which configures one
7964 logfile to parse. Within each B<File> block, there are one or more B<Match>
7965 blocks, which configure a regular expression to search for.
7967 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
7968 the plugin name and instance respectively. So in the above example the plugin name
7969 C<mail-exim> would be used.
7971 These options are applied for all B<Match> blocks that B<follow> it, until the
7972 next B<Plugin> or B<Instance> option. This way you can extract several plugin
7973 instances from one logfile, handy when parsing syslog and the like.
7975 The B<Interval> option allows you to define the length of time between reads. If
7976 this is not set, the default Interval will be used.
7978 Each B<Match> block has the following options to describe how the match should
7983 =item B<Regex> I<regex>
7985 Sets the regular expression to use for matching against a line. The first
7986 subexpression has to match something that can be turned into a number by
7987 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7988 below. Because B<extended> regular expressions are used, you do not need to use
7989 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7990 collectd's config parsing you need to escape backslashes, though. So if you
7991 want to match literal parentheses you need to do the following:
7993 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7995 =item B<ExcludeRegex> I<regex>
7997 Sets an optional regular expression to use for excluding lines from the match.
7998 An example which excludes all connections from localhost from the match:
8000 ExcludeRegex "127\\.0\\.0\\.1"
8002 =item B<DSType> I<Type>
8004 Sets how the values are cumulated. I<Type> is one of:
8008 =item B<GaugeAverage>
8010 Calculate the average.
8014 Use the smallest number only.
8018 Use the greatest number only.
8022 Use the last number found.
8024 =item B<GaugePersist>
8026 Use the last number found. The number is not reset at the end of an interval.
8027 It is continously reported until another number is matched. This is intended
8028 for cases in which only state changes are reported, for example a thermometer
8029 that only reports the temperature when it changes.
8035 =item B<AbsoluteSet>
8037 The matched number is a counter. Simply I<sets> the internal counter to this
8038 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8046 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8047 matched number may be negative, which will effectively subtract from the
8056 Increase the internal counter by one. These B<DSType> are the only ones that do
8057 not use the matched subexpression, but simply count the number of matched
8058 lines. Thus, you may use a regular expression without submatch in this case.
8060 =item B<Distribution>
8062 Type to do calculations based on the distribution of values, primarily
8063 calculating percentiles. This is primarily geared towards latency, but can be
8064 used for other metrics as well. The range of values tracked with this setting
8065 must be in the range (0–2^34) and can be fractional. Please note that neither
8066 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8069 This option must be used together with the B<Percentile> and/or B<Bucket>
8074 <DSType "Distribution">
8082 =item B<Percentile> I<Percent>
8084 Calculate and dispatch the configured percentile, i.e. compute the value, so
8085 that I<Percent> of all matched values are smaller than or equal to the computed
8088 Metrics are reported with the I<type> B<Type> (the value of the above option)
8089 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8091 This option may be repeated to calculate more than one percentile.
8093 =item B<Bucket> I<lower_bound> I<upper_bound>
8095 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8096 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8097 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8098 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8099 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8102 To export the entire (0–inf) range without overlap, use the upper bound of the
8103 previous range as the lower bound of the following range. In other words, use
8104 the following schema:
8114 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8115 by default) and the I<type instance>
8116 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8118 This option may be repeated to calculate more than one rate.
8120 =item B<BucketType> I<Type>
8122 Sets the type used to dispatch B<Bucket> metrics.
8123 Optional, by default C<bucket> will be used.
8129 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8130 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8131 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8132 B<Derive*> types interpret the submatch as a signed integer using
8133 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8134 and it may be omitted in this case.
8136 =item B<Type> I<Type>
8138 Sets the type used to dispatch this value. Detailed information about types and
8139 their configuration can be found in L<types.db(5)>.
8141 =item B<Instance> I<TypeInstance>
8143 This optional setting sets the type instance to use.
8147 =head2 Plugin C<tail_csv>
8149 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8150 written by I<Snort>.
8155 <Metric "snort-dropped">
8160 <File "/var/log/snort/snort.stats">
8164 Collect "snort-dropped"
8168 The configuration consists of one or more B<Metric> blocks that define an index
8169 into the line of the CSV file and how this value is mapped to I<collectd's>
8170 internal representation. These are followed by one or more B<Instance> blocks
8171 which configure which file to read, in which interval and which metrics to
8176 =item E<lt>B<Metric> I<Name>E<gt>
8178 The B<Metric> block configures a new metric to be extracted from the statistics
8179 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8180 only used inside the B<Instance> blocks to refer to this block, so you can use
8181 one B<Metric> block for multiple CSV files.
8185 =item B<Type> I<Type>
8187 Configures which I<Type> to use when dispatching this metric. Types are defined
8188 in the L<types.db(5)> file, see the appropriate manual page for more
8189 information on specifying types. Only types with a single I<data source> are
8190 supported by the I<tail_csv plugin>. The information whether the value is an
8191 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8192 I<Type's> definition.
8194 =item B<Instance> I<TypeInstance>
8196 If set, I<TypeInstance> is used to populate the type instance field of the
8197 created value lists. Otherwise, no type instance is used.
8199 =item B<ValueFrom> I<Index>
8201 Configure to read the value from the field with the zero-based index I<Index>.
8202 If the value is parsed as signed integer, unsigned integer or double depends on
8203 the B<Type> setting, see above.
8207 =item E<lt>B<File> I<Path>E<gt>
8209 Each B<File> block represents one CSV file to read. There must be at least one
8210 I<File> block but there can be multiple if you have multiple CSV files.
8214 =item B<Plugin> I<Plugin>
8216 Use I<Plugin> as the plugin name when submitting values.
8217 Defaults to C<tail_csv>.
8219 =item B<Instance> I<PluginInstance>
8221 Sets the I<plugin instance> used when dispatching the values.
8223 =item B<Collect> I<Metric>
8225 Specifies which I<Metric> to collect. This option must be specified at least
8226 once, and you can use this option multiple times to specify more than one
8227 metric to be extracted from this statistic file.
8229 =item B<Interval> I<Seconds>
8231 Configures the interval in which to read values from this instance / file.
8232 Defaults to the plugin's default interval.
8234 =item B<TimeFrom> I<Index>
8236 Rather than using the local time when dispatching a value, read the timestamp
8237 from the field with the zero-based index I<Index>. The value is interpreted as
8238 seconds since epoch. The value is parsed as a double and may be factional.
8244 =head2 Plugin C<teamspeak2>
8246 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8247 polls interesting global and virtual server data. The plugin can query only one
8248 physical server but unlimited virtual servers. You can use the following
8249 options to configure it:
8253 =item B<Host> I<hostname/ip>
8255 The hostname or ip which identifies the physical server.
8258 =item B<Port> I<port>
8260 The query port of the physical server. This needs to be a string.
8263 =item B<Server> I<port>
8265 This option has to be added once for every virtual server the plugin should
8266 query. If you want to query the virtual server on port 8767 this is what the
8267 option would look like:
8271 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8272 use quotes around it! If no such statement is given only global information
8277 =head2 Plugin C<ted>
8279 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8280 measure power consumption. These devices are usually connected to a serial
8281 (RS232) or USB port. The plugin opens a configured device and tries to read the
8282 current energy readings. For more information on TED, visit
8283 L<http://www.theenergydetective.com/>.
8285 Available configuration options:
8289 =item B<Device> I<Path>
8291 Path to the device on which TED is connected. collectd will need read and write
8292 permissions on that file.
8294 Default: B</dev/ttyUSB0>
8296 =item B<Retries> I<Num>
8298 Apparently reading from TED is not that reliable. You can therefore configure a
8299 number of retries here. You only configure the I<retries> here, to if you
8300 specify zero, one reading will be performed (but no retries if that fails); if
8301 you specify three, a maximum of four readings are performed. Negative values
8308 =head2 Plugin C<tcpconns>
8310 The C<tcpconns plugin> counts the number of currently established TCP
8311 connections based on the local port and/or the remote port. Since there may be
8312 a lot of connections the default if to count all connections with a local port,
8313 for which a listening socket is opened. You can use the following options to
8314 fine-tune the ports you are interested in:
8318 =item B<ListeningPorts> I<true>|I<false>
8320 If this option is set to I<true>, statistics for all local ports for which a
8321 listening socket exists are collected. The default depends on B<LocalPort> and
8322 B<RemotePort> (see below): If no port at all is specifically selected, the
8323 default is to collect listening ports. If specific ports (no matter if local or
8324 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8325 the selected ports will be collected unless this option is set to I<true>
8328 =item B<LocalPort> I<Port>
8330 Count the connections to a specific local port. This can be used to see how
8331 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8332 You have to specify the port in numeric form, so for the mailserver example
8333 you'd need to set B<25>.
8335 =item B<RemotePort> I<Port>
8337 Count the connections to a specific remote port. This is useful to see how
8338 much a remote service is used. This is most useful if you want to know how many
8339 connections a local service has opened to remote services, e.E<nbsp>g. how many
8340 connections a mail server or news server has to other mail or news servers, or
8341 how many connections a web proxy holds to web servers. You have to give the
8342 port in numeric form.
8344 =item B<AllPortsSummary> I<true>|I<false>
8346 If this option is set to I<true> a summary of statistics from all connections
8347 are collected. This option defaults to I<false>.
8351 =head2 Plugin C<thermal>
8355 =item B<ForceUseProcfs> I<true>|I<false>
8357 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8358 C<sysfs> interface. If that is not available, the plugin falls back to the
8359 C<procfs> interface. By setting this option to I<true>, you can force the
8360 plugin to use the latter. This option defaults to I<false>.
8362 =item B<Device> I<Device>
8364 Selects the name of the thermal device that you want to collect or ignore,
8365 depending on the value of the B<IgnoreSelected> option. This option may be
8366 used multiple times to specify a list of devices.
8368 See F</"IGNORELISTS"> for details.
8370 =item B<IgnoreSelected> I<true>|I<false>
8372 Invert the selection: If set to true, all devices B<except> the ones that
8373 match the device names specified by the B<Device> option are collected. By
8374 default only selected devices are collected if a selection is made. If no
8375 selection is configured at all, B<all> devices are selected.
8379 =head2 Plugin C<threshold>
8381 The I<Threshold plugin> checks values collected or received by I<collectd>
8382 against a configurable I<threshold> and issues I<notifications> if values are
8385 Documentation for this plugin is available in the L<collectd-threshold(5)>
8388 =head2 Plugin C<tokyotyrant>
8390 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8391 couple metrics: number of records, and database size on disk.
8395 =item B<Host> I<Hostname/IP>
8397 The hostname or IP which identifies the server.
8398 Default: B<127.0.0.1>
8400 =item B<Port> I<Service/Port>
8402 The query port of the server. This needs to be a string, even if the port is
8403 given in its numeric form.
8408 =head2 Plugin C<turbostat>
8410 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8411 Intel processors by using I<Model Specific Registers>.
8415 =item B<CoreCstates> I<Bitmask(Integer)>
8417 Bit mask of the list of core C-states supported by the processor.
8418 This option should only be used if the automated detection fails.
8419 Default value extracted from the CPU model and family.
8421 Currently supported C-states (by this plugin): 3, 6, 7
8425 All states (3, 6 and 7):
8426 (1<<3) + (1<<6) + (1<<7) = 392
8428 =item B<PackageCstates> I<Bitmask(Integer)>
8430 Bit mask of the list of packages C-states supported by the processor. This
8431 option should only be used if the automated detection fails. Default value
8432 extracted from the CPU model and family.
8434 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8438 States 2, 3, 6 and 7:
8439 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8441 =item B<SystemManagementInterrupt> I<true>|I<false>
8443 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8444 This option should only be used if the automated detection fails or if you want
8445 to disable this feature.
8447 =item B<DigitalTemperatureSensor> I<true>|I<false>
8449 Boolean enabling the collection of the temperature of each core. This option
8450 should only be used if the automated detection fails or if you want to disable
8453 =item B<TCCActivationTemp> I<Temperature>
8455 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8456 temperature is used when collecting the temperature of cores or packages. This
8457 option should only be used if the automated detection fails. Default value
8458 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8460 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8462 Bit mask of the list of elements to be thermally monitored. This option should
8463 only be used if the automated detection fails or if you want to disable some
8464 collections. The different bits of this bit mask accepted by this plugin are:
8468 =item 0 ('1'): Package
8472 =item 2 ('4'): Cores
8474 =item 3 ('8'): Embedded graphic device
8478 =item B<LogicalCoreNames> I<true>|I<false>
8480 Boolean enabling the use of logical core numbering for per core statistics.
8481 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8482 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8483 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8484 more than one, where I<n> is the n-th core of package I<m>.
8488 =head2 Plugin C<unixsock>
8492 =item B<SocketFile> I<Path>
8494 Sets the socket-file which is to be created.
8496 =item B<SocketGroup> I<Group>
8498 If running as root change the group of the UNIX-socket after it has been
8499 created. Defaults to B<collectd>.
8501 =item B<SocketPerms> I<Permissions>
8503 Change the file permissions of the UNIX-socket after it has been created. The
8504 permissions must be given as a numeric, octal value as you would pass to
8505 L<chmod(1)>. Defaults to B<0770>.
8507 =item B<DeleteSocket> B<false>|B<true>
8509 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8510 with the given name already exists. If I<collectd> crashes a socket file may be
8511 left over, preventing the daemon from opening a new socket when restarted.
8512 Since this is potentially dangerous, this defaults to B<false>.
8516 =head2 Plugin C<uuid>
8518 This plugin, if loaded, causes the Hostname to be taken from the machine's
8519 UUID. The UUID is a universally unique designation for the machine, usually
8520 taken from the machine's BIOS. This is most useful if the machine is running in
8521 a virtual environment such as Xen, in which case the UUID is preserved across
8522 shutdowns and migration.
8524 The following methods are used to find the machine's UUID, in order:
8530 Check I</etc/uuid> (or I<UUIDFile>).
8534 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8539 Check for UUID from C<dmidecode> / SMBIOS.
8543 Check for UUID from Xen hypervisor.
8547 If no UUID can be found then the hostname is not modified.
8551 =item B<UUIDFile> I<Path>
8553 Take the UUID from the given file (default I</etc/uuid>).
8557 =head2 Plugin C<varnish>
8559 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8560 It collects a subset of the values displayed by L<varnishstat(1)>, and
8561 organizes them in categories which can be enabled or disabled. Currently only
8562 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8563 meaning of each metric can be found in L<varnish-counters(7)>.
8568 <Instance "example">
8572 CollectConnections true
8573 CollectDirectorDNS false
8577 CollectObjects false
8579 CollectSession false
8589 CollectWorkers false
8591 CollectMempool false
8592 CollectManagement false
8599 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8600 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8601 will collectd statistics from the default "varnishd" instance (this should work
8602 fine in most cases).
8604 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8608 =item B<CollectBackend> B<true>|B<false>
8610 Back-end connection statistics, such as successful, reused,
8611 and closed connections. True by default.
8613 =item B<CollectBan> B<true>|B<false>
8615 Statistics about ban operations, such as number of bans added, retired, and
8616 number of objects tested against ban operations. Only available with Varnish
8617 3.x and above. False by default.
8619 =item B<CollectCache> B<true>|B<false>
8621 Cache hits and misses. True by default.
8623 =item B<CollectConnections> B<true>|B<false>
8625 Number of client connections received, accepted and dropped. True by default.
8627 =item B<CollectDirectorDNS> B<true>|B<false>
8629 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8632 =item B<CollectESI> B<true>|B<false>
8634 Edge Side Includes (ESI) parse statistics. False by default.
8636 =item B<CollectFetch> B<true>|B<false>
8638 Statistics about fetches (HTTP requests sent to the backend). False by default.
8640 =item B<CollectHCB> B<true>|B<false>
8642 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8643 divided into locked and unlocked look-ups. False by default.
8645 =item B<CollectObjects> B<true>|B<false>
8647 Statistics on cached objects: number of objects expired, nuked (prematurely
8648 expired), saved, moved, etc. False by default.
8650 =item B<CollectPurge> B<true>|B<false>
8652 Statistics about purge operations, such as number of purges added, retired, and
8653 number of objects tested against purge operations. Only available with Varnish
8654 2.x. False by default.
8656 =item B<CollectSession> B<true>|B<false>
8658 Client session statistics. Number of past and current sessions, session herd and
8659 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8660 metrics found in the Connections and Threads sections with previous versions of
8661 Varnish have been moved here.
8663 =item B<CollectSHM> B<true>|B<false>
8665 Statistics about the shared memory log, a memory region to store
8666 log messages which is flushed to disk when full. True by default.
8668 =item B<CollectSMA> B<true>|B<false>
8670 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8671 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
8672 only the one used by the Varnish instance. Only available with Varnish 2.x.
8675 =item B<CollectSMS> B<true>|B<false>
8677 synth (synthetic content) storage statistics. This storage
8678 component is used internally only. False by default.
8680 =item B<CollectSM> B<true>|B<false>
8682 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8683 in varnish 4.x. use CollectSMF.
8686 =item B<CollectStruct> B<true>|B<false>
8688 Current varnish internal state statistics. Number of current sessions, objects
8689 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8692 =item B<CollectTotals> B<true>|B<false>
8694 Collects overview counters, such as the number of sessions created,
8695 the number of requests and bytes transferred. False by default.
8697 =item B<CollectUptime> B<true>|B<false>
8699 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8701 =item B<CollectVCL> B<true>|B<false>
8703 Number of total (available + discarded) VCL (config files). False by default.
8705 =item B<CollectVSM> B<true>|B<false>
8707 Collect statistics about Varnish's shared memory usage (used by the logging and
8708 statistics subsystems). Only available with Varnish 4.x. False by default.
8710 =item B<CollectWorkers> B<true>|B<false>
8712 Collect statistics about worker threads. False by default.
8714 =item B<CollectVBE> B<true>|B<false>
8716 Backend counters. Only available with Varnish 4.x. False by default.
8718 =item B<CollectSMF> B<true>|B<false>
8720 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
8721 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
8722 instance. Used to be called SM in Varnish 2.x. False by default.
8724 =item B<CollectManagement> B<true>|B<false>
8726 Management process counters. Only available with Varnish 4.x. False by default.
8728 =item B<CollectLock> B<true>|B<false>
8730 Lock counters. Only available with Varnish 4.x. False by default.
8732 =item B<CollectMempool> B<true>|B<false>
8734 Memory pool counters. Only available with Varnish 4.x. False by default.
8736 =item B<CollectMSE> B<true>|B<false>
8738 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
8739 Varnish, replacing the traditional malloc and file storages. Only available
8740 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
8741 one used by the Varnish instance. False by default.
8745 =head2 Plugin C<virt>
8747 This plugin allows CPU, disk, network load and other metrics to be collected for
8748 virtualized guests on the machine. The statistics are collected through libvirt
8749 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8750 installing any additional software on guests, especially I<collectd>, which runs
8751 only on the host system.
8753 Only I<Connection> is required.
8757 =item B<Connection> I<uri>
8759 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8761 Connection "xen:///"
8763 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8765 =item B<RefreshInterval> I<seconds>
8767 Refresh the list of domains and devices every I<seconds>. The default is 60
8768 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8769 the list of domains and devices to be refreshed on every iteration.
8771 Refreshing the devices in particular is quite a costly operation, so if your
8772 virtualization setup is static you might consider increasing this. If this
8773 option is set to 0, refreshing is disabled completely.
8775 =item B<Domain> I<name>
8777 =item B<BlockDevice> I<name:dev>
8779 =item B<InterfaceDevice> I<name:dev>
8781 =item B<IgnoreSelected> B<true>|B<false>
8783 Select which domains and devices are collected.
8785 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8786 disk/network devices are collected.
8788 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8789 domains and disk/network devices are ignored, while the rest are collected.
8791 The domain name and device names may use a regular expression, if the name is
8792 surrounded by I</.../> and collectd was compiled with support for regexps.
8794 The default is to collect statistics for all domains and all their devices.
8798 BlockDevice "/:hdb/"
8799 IgnoreSelected "true"
8801 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8804 =item B<BlockDeviceFormat> B<target>|B<source>
8806 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8807 seen by the guest will be used for reporting metrics.
8808 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8811 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8812 using the path of the source, e.g. an image file.
8813 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8818 If the domain XML have the following device defined:
8820 <disk type='block' device='disk'>
8821 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8822 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8823 <target dev='sda' bus='scsi'/>
8825 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8828 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8830 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8831 to C<var_lib_libvirt_images_image1.qcow2>.
8833 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8835 The B<BlockDeviceFormatBasename> controls whether the full path or the
8836 L<basename(1)> of the source is being used as the I<type instance> when
8837 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8841 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8842 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8843 be set to C<var_lib_libvirt_images_image1.qcow2>.
8844 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8845 set to C<image1.qcow2>.
8847 =item B<HostnameFormat> B<name|uuid|hostname|...>
8849 When the virt plugin logs data, it sets the hostname of the collected data
8850 according to this setting. The default is to use the guest name as provided by
8851 the hypervisor, which is equal to setting B<name>.
8853 B<uuid> means use the guest's UUID. This is useful if you want to track the
8854 same guest across migrations.
8856 B<hostname> means to use the global B<Hostname> setting, which is probably not
8857 useful on its own because all guests will appear to have the same name.
8859 You can also specify combinations of these fields. For example B<name uuid>
8860 means to concatenate the guest name and UUID (with a literal colon character
8861 between, thus I<"foo:1234-1234-1234-1234">).
8863 At the moment of writing (collectd-5.5), hostname string is limited to 62
8864 characters. In case when combination of fields exceeds 62 characters,
8865 hostname will be truncated without a warning.
8867 =item B<InterfaceFormat> B<name>|B<address>
8869 When the virt plugin logs interface data, it sets the name of the collected
8870 data according to this setting. The default is to use the path as provided by
8871 the hypervisor (the "dev" property of the target node), which is equal to
8874 B<address> means use the interface's mac address. This is useful since the
8875 interface path might change between reboots of a guest or across migrations.
8877 =item B<PluginInstanceFormat> B<name|uuid|none>
8879 When the virt plugin logs data, it sets the plugin_instance of the collected
8880 data according to this setting. The default is to not set the plugin_instance.
8882 B<name> means use the guest's name as provided by the hypervisor.
8883 B<uuid> means use the guest's UUID.
8885 You can also specify combinations of the B<name> and B<uuid> fields.
8886 For example B<name uuid> means to concatenate the guest name and UUID
8887 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8889 =item B<Instances> B<integer>
8891 How many read instances you want to use for this plugin. The default is one,
8892 and the sensible setting is a multiple of the B<ReadThreads> value.
8893 If you are not sure, just use the default setting.
8895 =item B<ExtraStats> B<string>
8897 Report additional extra statistics. The default is no extra statistics, preserving
8898 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8899 allows the plugin to reported more detailed statistics about the behaviour of
8900 Virtual Machines. The argument is a space-separated list of selectors.
8902 Currently supported selectors are:
8906 =item B<cpu_util>: report CPU utilization per domain in percentage.
8908 =item B<disk>: report extra statistics like number of flush operations and total
8909 service time for read, write and flush operations. Requires libvirt API version
8912 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8915 =item B<domain_state>: report domain state and reason in human-readable format as
8916 a notification. If libvirt API version I<0.9.2> or later is available, domain
8917 reason will be included in notification.
8919 =item B<fs_info>: report file system information as a notification. Requires
8920 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8921 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8922 version supports retrieving file system information.
8924 =item B<job_stats_background>: report statistics about progress of a background
8925 job on a domain. Only one type of job statistics can be collected at the same time.
8926 Requires libvirt API version I<1.2.9> or later.
8928 =item B<job_stats_completed>: report statistics about a recently completed job on
8929 a domain. Only one type of job statistics can be collected at the same time.
8930 Requires libvirt API version I<1.2.9> or later.
8932 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8933 Requires libvirt API version I<0.9.11> or later.
8935 =item B<perf>: report performance monitoring events. To collect performance
8936 metrics they must be enabled for domain and supported by the platform. Requires
8937 libvirt API version I<1.3.3> or later.
8938 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8940 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8944 =item B<PersistentNotification> B<true>|B<false>
8945 Override default configuration to only send notifications when there is a change
8946 in the lifecycle state of a domain. When set to true notifications will be sent
8947 for every read cycle. Default is false. Does not affect the stats being
8952 =head2 Plugin C<vmem>
8954 The C<vmem> plugin collects information about the usage of virtual memory.
8955 Since the statistics provided by the Linux kernel are very detailed, they are
8956 collected very detailed. However, to get all the details, you have to switch
8957 them on manually. Most people just want an overview over, such as the number of
8958 pages read from swap space.
8962 =item B<Verbose> B<true>|B<false>
8964 Enables verbose collection of information. This will start collecting page
8965 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8966 Part of these statistics are collected on a "per zone" basis.
8970 =head2 Plugin C<vserver>
8972 This plugin doesn't have any options. B<VServer> support is only available for
8973 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8974 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8975 need to apply the patches and compile your own kernel, which will then provide
8976 the F</proc/virtual> filesystem that is required by this plugin.
8978 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8980 B<Note>: The traffic collected by this plugin accounts for the amount of
8981 traffic passing a socket which might be a lot less than the actual on-wire
8982 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8983 collect on-wire traffic you could, for example, use the logging facilities of
8984 iptables to feed data for the guest IPs into the iptables plugin.
8986 =head2 Plugin C<write_graphite>
8988 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8989 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8990 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8991 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8992 of at most 1428 bytes to minimize the number of network packets.
8996 <Plugin write_graphite>
9006 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9007 blocks. Inside the B<Node> blocks, the following options are recognized:
9011 =item B<Host> I<Address>
9013 Hostname or address to connect to. Defaults to C<localhost>.
9015 =item B<Port> I<Service>
9017 Service name or port number to connect to. Defaults to C<2003>.
9019 =item B<Protocol> I<String>
9021 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9023 =item B<ReconnectInterval> I<Seconds>
9025 When set to non-zero, forces the connection to the Graphite backend to be
9026 closed and re-opend periodically. This behavior is desirable in environments
9027 where the connection to the Graphite backend is done through load balancers,
9028 for example. When set to zero, the default, the connetion is kept open for as
9031 =item B<LogSendErrors> B<false>|B<true>
9033 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9034 If set to B<false>, it will not log the errors. This is especially useful when
9035 using Protocol UDP since many times we want to use the "fire-and-forget"
9036 approach and logging errors fills syslog with unneeded messages.
9038 =item B<Prefix> I<String>
9040 When set, I<String> is added in front of the host name. Dots and whitespace are
9041 I<not> escaped in this string (see B<EscapeCharacter> below).
9043 =item B<Postfix> I<String>
9045 When set, I<String> is appended to the host name. Dots and whitespace are
9046 I<not> escaped in this string (see B<EscapeCharacter> below).
9048 =item B<EscapeCharacter> I<Char>
9050 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9051 in the identifier. The B<EscapeCharacter> option determines which character
9052 dots, whitespace and control characters are replaced with. Defaults to
9055 =item B<StoreRates> B<false>|B<true>
9057 If set to B<true> (the default), convert counter values to rates. If set to
9058 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9061 =item B<SeparateInstances> B<false>|B<true>
9063 If set to B<true>, the plugin instance and type instance will be in their own
9064 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9065 default), the plugin and plugin instance (and likewise the type and type
9066 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9068 =item B<AlwaysAppendDS> B<false>|B<true>
9070 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9071 identifier. If set to B<false> (the default), this is only done when there is
9074 =item B<PreserveSeparator> B<false>|B<true>
9076 If set to B<false> (the default) the C<.> (dot) character is replaced with
9077 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9078 is preserved, i.e. passed through.
9080 =item B<DropDuplicateFields> B<false>|B<true>
9082 If set to B<true>, detect and remove duplicate components in Graphite metric
9083 names. For example, the metric name C<host.load.load.shortterm> will
9084 be shortened to C<host.load.shortterm>.
9088 =head2 Plugin C<write_log>
9090 The C<write_log> plugin writes metrics as INFO log messages.
9092 This plugin supports two output formats: I<Graphite> and I<JSON>.
9102 =item B<Format> I<Format>
9104 The output format to use. Can be one of C<Graphite> or C<JSON>.
9108 =head2 Plugin C<write_tsdb>
9110 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9111 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9112 state daemon that ingests metrics and stores them in HBase. The plugin uses
9113 I<TCP> over the "line based" protocol with a default port 4242. The data will
9114 be sent in blocks of at most 1428 bytes to minimize the number of network
9123 Host "tsd-1.my.domain"
9125 HostTags "status=production"
9129 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9130 blocks and global directives.
9132 Global directives are:
9136 =item B<ResolveInterval> I<seconds>
9138 =item B<ResolveJitter> I<seconds>
9140 When I<collectd> connects to a TSDB node, it will request the hostname from
9141 DNS. This can become a problem if the TSDB node is unavailable or badly
9142 configured because collectd will request DNS in order to reconnect for every
9143 metric, which can flood your DNS. So you can cache the last value for
9144 I<ResolveInterval> seconds.
9145 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9147 You can also define a jitter, a random interval to wait in addition to
9148 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9149 hostname at the same time when the connection fails.
9150 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9152 B<Note:> If the DNS resolution has already been successful when the socket
9153 closes, the plugin will try to reconnect immediately with the cached
9154 information. DNS is queried only when the socket is closed for a longer than
9155 I<ResolveInterval> + I<ResolveJitter> seconds.
9159 Inside the B<Node> blocks, the following options are recognized:
9163 =item B<Host> I<Address>
9165 Hostname or address to connect to. Defaults to C<localhost>.
9167 =item B<Port> I<Service>
9169 Service name or port number to connect to. Defaults to C<4242>.
9172 =item B<HostTags> I<String>
9174 When set, I<HostTags> is added to the end of the metric. It is intended to be
9175 used for name=value pairs that the TSD will tag the metric with. Dots and
9176 whitespace are I<not> escaped in this string.
9178 =item B<StoreRates> B<false>|B<true>
9180 If set to B<true>, convert counter values to rates. If set to B<false>
9181 (the default) counter values are stored as is, as an increasing
9184 =item B<AlwaysAppendDS> B<false>|B<true>
9186 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9187 identifier. If set to B<false> (the default), this is only done when there is
9192 =head2 Plugin C<write_mongodb>
9194 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9199 <Plugin "write_mongodb">
9208 The plugin can send values to multiple instances of I<MongoDB> by specifying
9209 one B<Node> block for each instance. Within the B<Node> blocks, the following
9210 options are available:
9214 =item B<Host> I<Address>
9216 Hostname or address to connect to. Defaults to C<localhost>.
9218 =item B<Port> I<Service>
9220 Service name or port number to connect to. Defaults to C<27017>.
9222 =item B<Timeout> I<Milliseconds>
9224 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9225 Setting this option to zero means no timeout, which is the default.
9227 =item B<StoreRates> B<false>|B<true>
9229 If set to B<true> (the default), convert counter values to rates. If set to
9230 B<false> counter values are stored as is, i.e. as an increasing integer
9233 =item B<Database> I<Database>
9235 =item B<User> I<User>
9237 =item B<Password> I<Password>
9239 Sets the information used when authenticating to a I<MongoDB> database. The
9240 fields are optional (in which case no authentication is attempted), but if you
9241 want to use authentication all three fields must be set.
9245 =head2 Plugin C<write_prometheus>
9247 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9248 using I<Prometheus>.
9254 =item B<Port> I<Port>
9256 Port the embedded webserver should listen on. Defaults to B<9103>.
9258 =item B<StalenessDelta> I<Seconds>
9260 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9261 hasn't seen any update for it. This value must match the setting in Prometheus.
9262 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9266 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9267 which time a metric without updates is considered "stale". This setting
9268 effectively puts an upper limit on the interval in which metrics are reported.
9270 When the I<write_prometheus plugin> encounters a metric with an interval
9271 exceeding this limit, it will inform you, the user, and provide the metric to
9272 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9273 metric "fresh" each time it is scraped, with the time of the scrape being
9274 considered the time of the update. The result is that there appear more
9275 datapoints in I<Prometheus> than were actually created, but at least the metric
9276 doesn't disappear periodically.
9280 =head2 Plugin C<write_http>
9282 This output plugin submits values to an HTTP server using POST requests and
9283 encoding metrics with JSON or using the C<PUTVAL> command described in
9284 L<collectd-unixsock(5)>.
9288 <Plugin "write_http">
9290 URL "http://example.com/post-collectd"
9297 The plugin can send values to multiple HTTP servers by specifying one
9298 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9299 block, the following options are available:
9305 URL to which the values are submitted to. Mandatory.
9307 =item B<User> I<Username>
9309 Optional user name needed for authentication.
9311 =item B<Password> I<Password>
9313 Optional password needed for authentication.
9315 =item B<VerifyPeer> B<true>|B<false>
9317 Enable or disable peer SSL certificate verification. See
9318 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9320 =item B<VerifyHost> B<true|false>
9322 Enable or disable peer host name verification. If enabled, the plugin checks if
9323 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9324 matches the host name provided by the B<URL> option. If this identity check
9325 fails, the connection is aborted. Obviously, only works when connecting to a
9326 SSL enabled server. Enabled by default.
9328 =item B<CACert> I<File>
9330 File that holds one or more SSL certificates. If you want to use HTTPS you will
9331 possibly need this option. What CA certificates come bundled with C<libcurl>
9332 and are checked by default depends on the distribution you use.
9334 =item B<CAPath> I<Directory>
9336 Directory holding one or more CA certificate files. You can use this if for
9337 some reason all the needed CA certificates aren't in the same file and can't be
9338 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9341 =item B<ClientKey> I<File>
9343 File that holds the private key in PEM format to be used for certificate-based
9346 =item B<ClientCert> I<File>
9348 File that holds the SSL certificate to be used for certificate-based
9351 =item B<ClientKeyPass> I<Password>
9353 Password required to load the private key in B<ClientKey>.
9355 =item B<Header> I<Header>
9357 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9359 Header "X-Custom-Header: custom_value"
9361 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9363 Define which SSL protocol version must be used. By default C<libcurl> will
9364 attempt to figure out the remote SSL protocol version. See
9365 L<curl_easy_setopt(3)> for more details.
9367 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9369 Format of the output to generate. If set to B<Command>, will create output that
9370 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9371 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9372 , will create output in the KairosDB format.
9374 Defaults to B<Command>.
9376 =item B<Attribute> I<String> I<String>
9378 Only available for the KAIROSDB output format.
9380 Consider the two given strings to be the key and value of an additional tag for
9381 each metric being sent out.
9383 You can add multiple B<Attribute>.
9387 Only available for the KAIROSDB output format.
9389 Sets the Cassandra ttl for the data points.
9391 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9393 =item B<Prefix> I<String>
9395 Only available for the KAIROSDB output format.
9397 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9399 =item B<Metrics> B<true>|B<false>
9401 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9403 =item B<Notifications> B<false>|B<true>
9405 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9407 =item B<StoreRates> B<true|false>
9409 If set to B<true>, convert counter values to rates. If set to B<false> (the
9410 default) counter values are stored as is, i.e. as an increasing integer number.
9412 =item B<BufferSize> I<Bytes>
9414 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9415 requests will be generated, but more metrics will be batched / metrics are
9416 cached for longer before being sent, introducing additional delay until they
9417 are available on the server side. I<Bytes> must be at least 1024 and cannot
9418 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9419 Defaults to C<4096>.
9421 =item B<LowSpeedLimit> I<Bytes per Second>
9423 Sets the minimal transfer rate in I<Bytes per Second> below which the
9424 connection with the HTTP server will be considered too slow and aborted. All
9425 the data submitted over this connection will probably be lost. Defaults to 0,
9426 which means no minimum transfer rate is enforced.
9428 =item B<Timeout> I<Timeout>
9430 Sets the maximum time in milliseconds given for HTTP POST operations to
9431 complete. When this limit is reached, the POST operation will be aborted, and
9432 all the data in the current send buffer will probably be lost. Defaults to 0,
9433 which means the connection never times out.
9435 =item B<LogHttpError> B<false>|B<true>
9437 Enables printing of HTTP error code to log. Turned off by default.
9439 The C<write_http> plugin regularly submits the collected values to the HTTP
9440 server. How frequently this happens depends on how much data you are collecting
9441 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9442 slightly below this interval, which you can estimate by monitoring the network
9443 traffic between collectd and the HTTP server.
9447 =head2 Plugin C<write_kafka>
9449 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9453 <Plugin "write_kafka">
9454 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9460 The following options are understood by the I<write_kafka plugin>:
9464 =item E<lt>B<Topic> I<Name>E<gt>
9466 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9467 is given a unique I<Name> and specifies one kafka producer.
9468 Inside the B<Topic> block, the following per-topic options are
9473 =item B<Property> I<String> I<String>
9475 Configure the named property for the current topic. Properties are
9476 forwarded to the kafka producer library B<librdkafka>.
9478 =item B<Key> I<String>
9480 Use the specified string as a partitioning key for the topic. Kafka breaks
9481 topic into partitions and guarantees that for a given topology, the same
9482 consumer will be used for a specific key. The special (case insensitive)
9483 string B<Random> can be used to specify that an arbitrary partition should
9486 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9488 Selects the format in which messages are sent to the broker. If set to
9489 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9490 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9492 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9493 an easy and straight forward exchange format.
9495 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9496 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9498 =item B<StoreRates> B<true>|B<false>
9500 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9501 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9502 default), no conversion is performed. Otherwise the conversion is performed
9503 using the internal value cache.
9505 Please note that currently this option is only used if the B<Format> option has
9506 been set to B<JSON>.
9508 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9510 A prefix can be added in the metric name when outputting in the I<Graphite>
9511 format. It's added before the I<Host> name.
9513 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>>
9515 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9517 A postfix can be added in the metric name when outputting in the I<Graphite>
9518 format. It's added after the I<Host> name.
9520 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>>
9522 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9524 Specify a character to replace dots (.) in the host part of the metric name.
9525 In I<Graphite> metric name, dots are used as separators between different
9526 metric parts (host, plugin, type).
9527 Default is C<_> (I<Underscore>).
9529 =item B<GraphiteSeparateInstances> B<false>|B<true>
9531 If set to B<true>, the plugin instance and type instance will be in their own
9532 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9533 default), the plugin and plugin instance (and likewise the type and type
9534 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9536 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9538 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9539 identifier. If set to B<false> (the default), this is only done when there is
9542 =item B<GraphitePreserveSeparator> B<false>|B<true>
9544 If set to B<false> (the default) the C<.> (dot) character is replaced with
9545 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9546 is preserved, i.e. passed through.
9548 =item B<StoreRates> B<true>|B<false>
9550 If set to B<true> (the default), convert counter values to rates. If set to
9551 B<false> counter values are stored as is, i.e. as an increasing integer number.
9553 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9554 converted values will have "rate" appended to the data source type, e.g.
9555 C<ds_type:derive:rate>.
9559 =item B<Property> I<String> I<String>
9561 Configure the kafka producer through properties, you almost always will
9562 want to set B<metadata.broker.list> to your Kafka broker list.
9566 =head2 Plugin C<write_redis>
9568 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9572 <Plugin "write_redis">
9585 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9586 the timestamp as the score. Retrieving a date range can then be done using the
9587 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9588 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9589 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9590 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9591 with the B<Database> parameter (default is C<0>). See
9592 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9595 The information shown in the synopsis above is the I<default configuration>
9596 which is used by the plugin if no configuration is present.
9598 The plugin can send values to multiple instances of I<Redis> by specifying
9599 one B<Node> block for each instance. Within the B<Node> blocks, the following
9600 options are available:
9604 =item B<Node> I<Nodename>
9606 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9607 instance running on a specified host and port. The node name is a
9608 canonical identifier which is used as I<plugin instance>. It is limited to
9609 51E<nbsp>characters in length.
9611 =item B<Host> I<Hostname>
9613 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9616 =item B<Port> I<Port>
9618 The B<Port> option is the TCP port on which the Redis instance accepts
9619 connections. Either a service name of a port number may be given. Please note
9620 that numerical port numbers must be given as a string, too.
9622 =item B<Timeout> I<Milliseconds>
9624 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9626 =item B<Prefix> I<Prefix>
9628 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9629 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9630 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9631 is recommended but not required to include a trailing slash in I<Prefix>.
9633 =item B<Database> I<Index>
9635 This index selects the redis database to use for writing operations. Defaults
9638 =item B<MaxSetSize> I<Items>
9640 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9641 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9643 =item B<MaxSetDuration> I<Seconds>
9645 The B<MaxSetDuration> option limits the duration of items that the
9646 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9647 is the default behavior.
9649 =item B<StoreRates> B<true>|B<false>
9651 If set to B<true> (the default), convert counter values to rates. If set to
9652 B<false> counter values are stored as is, i.e. as an increasing integer number.
9656 =head2 Plugin C<write_riemann>
9658 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9659 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9660 I<Riemann> using UDP packets.
9664 <Plugin "write_riemann">
9670 AlwaysAppendDS false
9674 Attribute "foo" "bar"
9677 The following options are understood by the I<write_riemann plugin>:
9681 =item E<lt>B<Node> I<Name>E<gt>
9683 The plugin's configuration consists of one or more B<Node> blocks. Each block
9684 is given a unique I<Name> and specifies one connection to an instance of
9685 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9690 =item B<Host> I<Address>
9692 Hostname or address to connect to. Defaults to C<localhost>.
9694 =item B<Port> I<Service>
9696 Service name or port number to connect to. Defaults to C<5555>.
9698 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9700 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9703 =item B<TLSCertFile> I<Path>
9705 When using the B<TLS> protocol, path to a PEM certificate to present
9708 =item B<TLSCAFile> I<Path>
9710 When using the B<TLS> protocol, path to a PEM CA certificate to
9711 use to validate the remote hosts's identity.
9713 =item B<TLSKeyFile> I<Path>
9715 When using the B<TLS> protocol, path to a PEM private key associated
9716 with the certificate defined by B<TLSCertFile>.
9718 =item B<Batch> B<true>|B<false>
9720 If set to B<true> and B<Protocol> is set to B<TCP>,
9721 events will be batched in memory and flushed at
9722 regular intervals or when B<BatchMaxSize> is exceeded.
9724 Notifications are not batched and sent as soon as possible.
9726 When enabled, it can occur that events get processed by the Riemann server
9727 close to or after their expiration time. Tune the B<TTLFactor> and
9728 B<BatchMaxSize> settings according to the amount of values collected, if this
9733 =item B<BatchMaxSize> I<size>
9735 Maximum payload size for a riemann packet. Defaults to 8192
9737 =item B<BatchFlushTimeout> I<seconds>
9739 Maximum amount of seconds to wait in between to batch flushes.
9740 No timeout by default.
9742 =item B<StoreRates> B<true>|B<false>
9744 If set to B<true> (the default), convert counter values to rates. If set to
9745 B<false> counter values are stored as is, i.e. as an increasing integer number.
9747 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9748 converted values will have "rate" appended to the data source type, e.g.
9749 C<ds_type:derive:rate>.
9751 =item B<AlwaysAppendDS> B<false>|B<true>
9753 If set to B<true>, append the name of the I<Data Source> (DS) to the
9754 "service", i.e. the field that, together with the "host" field, uniquely
9755 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9756 only done when there is more than one DS.
9758 =item B<TTLFactor> I<Factor>
9760 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9761 event is considered active. I<collectd> populates this field based on the
9762 metrics interval setting. This setting controls the factor with which the
9763 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9764 know exactly what you're doing, you should only increase this setting from its
9767 =item B<Notifications> B<false>|B<true>
9769 If set to B<true>, create riemann events for notifications. This is B<true>
9770 by default. When processing thresholds from write_riemann, it might prove
9771 useful to avoid getting notification events.
9773 =item B<CheckThresholds> B<false>|B<true>
9775 If set to B<true>, attach state to events based on thresholds defined
9776 in the B<Threshold> plugin. Defaults to B<false>.
9778 =item B<EventServicePrefix> I<String>
9780 Add the given string as a prefix to the event service name.
9781 If B<EventServicePrefix> not set or set to an empty string (""),
9782 no prefix will be used.
9786 =item B<Tag> I<String>
9788 Add the given string as an additional tag to the metric being sent to
9791 =item B<Attribute> I<String> I<String>
9793 Consider the two given strings to be the key and value of an additional
9794 attribute for each metric being sent out to I<Riemann>.
9798 =head2 Plugin C<write_sensu>
9800 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9801 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9802 a local I<Sensu> client using a TCP socket.
9804 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9805 parameter so it is not possible to use one collectd instance as a gateway for
9806 others. Each collectd host must pair with one I<Sensu> client.
9810 <Plugin "write_sensu">
9815 AlwaysAppendDS false
9816 MetricHandler "influx"
9817 MetricHandler "default"
9818 NotificationHandler "flapjack"
9819 NotificationHandler "howling_monkey"
9823 Attribute "foo" "bar"
9826 The following options are understood by the I<write_sensu plugin>:
9830 =item E<lt>B<Node> I<Name>E<gt>
9832 The plugin's configuration consists of one or more B<Node> blocks. Each block
9833 is given a unique I<Name> and specifies one connection to an instance of
9834 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9839 =item B<Host> I<Address>
9841 Hostname or address to connect to. Defaults to C<localhost>.
9843 =item B<Port> I<Service>
9845 Service name or port number to connect to. Defaults to C<3030>.
9847 =item B<StoreRates> B<true>|B<false>
9849 If set to B<true> (the default), convert counter values to rates. If set to
9850 B<false> counter values are stored as is, i.e. as an increasing integer number.
9852 This will be reflected in the C<collectd_data_source_type> tag: If
9853 B<StoreRates> is enabled, converted values will have "rate" appended to the
9854 data source type, e.g. C<collectd_data_source_type:derive:rate>.
9856 =item B<AlwaysAppendDS> B<false>|B<true>
9858 If set the B<true>, append the name of the I<Data Source> (DS) to the
9859 "service", i.e. the field that, together with the "host" field, uniquely
9860 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9861 only done when there is more than one DS.
9863 =item B<Notifications> B<false>|B<true>
9865 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9866 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9868 =item B<Metrics> B<false>|B<true>
9870 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9871 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9874 =item B<Separator> I<String>
9876 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9878 =item B<MetricHandler> I<String>
9880 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9881 several of them, one per line. Defaults to no handler.
9883 =item B<NotificationHandler> I<String>
9885 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9886 add several of them, one per line. Defaults to no handler.
9888 =item B<EventServicePrefix> I<String>
9890 Add the given string as a prefix to the event service name.
9891 If B<EventServicePrefix> not set or set to an empty string (""),
9892 no prefix will be used.
9896 =item B<Tag> I<String>
9898 Add the given string as an additional tag to the metric being sent to
9901 =item B<Attribute> I<String> I<String>
9903 Consider the two given strings to be the key and value of an additional
9904 attribute for each metric being sent out to I<Sensu>.
9908 =head2 Plugin C<xencpu>
9910 This plugin collects metrics of hardware CPU load for machine running Xen
9911 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9912 Result is reported using the C<percent> type, for each CPU (core).
9914 This plugin doesn't have any options (yet).
9916 =head2 Plugin C<zookeeper>
9918 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9919 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9924 <Plugin "zookeeper">
9931 =item B<Host> I<Address>
9933 Hostname or address to connect to. Defaults to C<localhost>.
9935 =item B<Port> I<Service>
9937 Service name or port number to connect to. Defaults to C<2181>.
9941 =head1 THRESHOLD CONFIGURATION
9943 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9944 we mean that the values are not only stored or sent somewhere, but that they
9945 are judged and, if a problem is recognized, acted upon. The only action
9946 collectd takes itself is to generate and dispatch a "notification". Plugins can
9947 register to receive notifications and perform appropriate further actions.
9949 Since systems and what you expect them to do differ a lot, you can configure
9950 B<thresholds> for your values freely. This gives you a lot of flexibility but
9951 also a lot of responsibility.
9953 Every time a value is out of range a notification is dispatched. This means
9954 that the idle percentage of your CPU needs to be less then the configured
9955 threshold only once for a notification to be generated. There's no such thing
9956 as a moving average or similar - at least not now.
9958 Also, all values that match a threshold are considered to be relevant or
9959 "interesting". As a consequence collectd will issue a notification if they are
9960 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9961 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9962 "2" (the default) and some hosts sends it's CPU statistics to the server every
9963 60 seconds, a notification will be dispatched after about 120 seconds. It may
9964 take a little longer because the timeout is checked only once each B<Interval>
9967 When a value comes within range again or is received after it was missing, an
9968 "OKAY-notification" is dispatched.
9970 Here is a configuration example to get you started. Read below for more
9983 <Plugin "interface">
10000 WarningMin 100000000
10006 There are basically two types of configuration statements: The C<Host>,
10007 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10008 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10009 C<Instance> option. You can combine the block by nesting the blocks, though
10010 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10011 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10012 C<Type> may not contain other blocks. If multiple blocks apply to the same
10013 value the most specific block is used.
10015 The other statements specify the threshold to configure. They B<must> be
10016 included in a C<Type> block. Currently the following statements are recognized:
10020 =item B<FailureMax> I<Value>
10022 =item B<WarningMax> I<Value>
10024 Sets the upper bound of acceptable values. If unset defaults to positive
10025 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10026 will be created. If the value is greater than B<WarningMax> but less than (or
10027 equal to) B<FailureMax> a B<WARNING> notification will be created.
10029 =item B<FailureMin> I<Value>
10031 =item B<WarningMin> I<Value>
10033 Sets the lower bound of acceptable values. If unset defaults to negative
10034 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10035 be created. If the value is less than B<WarningMin> but greater than (or equal
10036 to) B<FailureMin> a B<WARNING> notification will be created.
10038 =item B<DataSource> I<DSName>
10040 Some data sets have more than one "data source". Interesting examples are the
10041 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10042 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10043 system load data set, C<load>, even has three data sources: C<shortterm>,
10044 C<midterm>, and C<longterm>.
10046 Normally, all data sources are checked against a configured threshold. If this
10047 is undesirable, or if you want to specify different limits for each data
10048 source, you can use the B<DataSource> option to have a threshold apply only to
10051 =item B<Invert> B<true>|B<false>
10053 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10054 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10055 B<WarningMax>) are not okay. Defaults to B<false>.
10057 =item B<Persist> B<true>|B<false>
10059 Sets how often notifications are generated. If set to B<true> one notification
10060 will be generated for each value that is out of the acceptable range. If set to
10061 B<false> (the default) then a notification is only generated if a value is out
10062 of range but the previous value was okay.
10064 This applies to missing values, too: If set to B<true> a notification about a
10065 missing value is generated once every B<Interval> seconds. If set to B<false>
10066 only one such notification is generated until the value appears again.
10068 =item B<Percentage> B<true>|B<false>
10070 If set to B<true>, the minimum and maximum values given are interpreted as
10071 percentage value, relative to the other data sources. This is helpful for
10072 example for the "df" type, where you may want to issue a warning when less than
10073 5E<nbsp>% of the total space is available. Defaults to B<false>.
10075 =item B<Hits> I<Number>
10077 Delay creating the notification until the threshold has been passed I<Number>
10078 times. When a notification has been generated, or when a subsequent value is
10079 inside the threshold, the counter is reset. If, for example, a value is
10080 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10081 will be dispatched at most once every 30E<nbsp>seconds.
10083 This is useful when short bursts are not a problem. If, for example, 100% CPU
10084 usage for up to a minute is normal (and data is collected every
10085 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10087 =item B<Hysteresis> I<Number>
10089 When set to non-zero, a hysteresis value is applied when checking minimum and
10090 maximum bounds. This is useful for values that increase slowly and fluctuate a
10091 bit while doing so. When these values come close to the threshold, they may
10092 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10094 If, for example, the threshold is configures as
10099 then a I<Warning> notification is created when the value exceeds I<101> and the
10100 corresponding I<Okay> notification is only created once the value falls below
10101 I<99>, thus avoiding the "flapping".
10105 =head1 FILTER CONFIGURATION
10107 Starting with collectd 4.6 there is a powerful filtering infrastructure
10108 implemented in the daemon. The concept has mostly been copied from
10109 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10110 terminology, so that users that are familiar with iptables feel right at home.
10114 The following are the terms used in the remainder of the filter configuration
10115 documentation. For an ASCII-art schema of the mechanism, see
10116 L<"General structure"> below.
10122 A I<match> is a criteria to select specific values. Examples are, of course, the
10123 name of the value or it's current value.
10125 Matches are implemented in plugins which you have to load prior to using the
10126 match. The name of such plugins starts with the "match_" prefix.
10130 A I<target> is some action that is to be performed with data. Such actions
10131 could, for example, be to change part of the value's identifier or to ignore
10132 the value completely.
10134 Some of these targets are built into the daemon, see L<"Built-in targets">
10135 below. Other targets are implemented in plugins which you have to load prior to
10136 using the target. The name of such plugins starts with the "target_" prefix.
10140 The combination of any number of matches and at least one target is called a
10141 I<rule>. The target actions will be performed for all values for which B<all>
10142 matches apply. If the rule does not have any matches associated with it, the
10143 target action will be performed for all values.
10147 A I<chain> is a list of rules and possibly default targets. The rules are tried
10148 in order and if one matches, the associated target will be called. If a value
10149 is handled by a rule, it depends on the target whether or not any subsequent
10150 rules are considered or if traversal of the chain is aborted, see
10151 L<"Flow control"> below. After all rules have been checked, the default targets
10156 =head2 General structure
10158 The following shows the resulting structure:
10165 +---------+ +---------+ +---------+ +---------+
10166 ! Rule !->! Match !->! Match !->! Target !
10167 +---------+ +---------+ +---------+ +---------+
10170 +---------+ +---------+ +---------+
10171 ! Rule !->! Target !->! Target !
10172 +---------+ +---------+ +---------+
10179 +---------+ +---------+ +---------+
10180 ! Rule !->! Match !->! Target !
10181 +---------+ +---------+ +---------+
10189 =head2 Flow control
10191 There are four ways to control which way a value takes through the filter
10198 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10199 process the value with another chain. When the called chain finishes, usually
10200 the next target or rule after the jump is executed.
10204 The stop condition, signaled for example by the built-in target B<stop>, causes
10205 all processing of the value to be stopped immediately.
10209 Causes processing in the current chain to be aborted, but processing of the
10210 value generally will continue. This means that if the chain was called via
10211 B<Jump>, the next target or rule after the jump will be executed. If the chain
10212 was not called by another chain, control will be returned to the daemon and it
10213 may pass the value to another chain.
10217 Most targets will signal the B<continue> condition, meaning that processing
10218 should continue normally. There is no special built-in target for this
10225 The configuration reflects this structure directly:
10227 PostCacheChain "PostCache"
10228 <Chain "PostCache">
10229 <Rule "ignore_mysql_show">
10232 Type "^mysql_command$"
10233 TypeInstance "^show_"
10243 The above configuration example will ignore all values where the plugin field
10244 is "mysql", the type is "mysql_command" and the type instance begins with
10245 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10246 default target of the chain. Since this chain is run after the value has been
10247 added to the cache, the MySQL C<show_*> command statistics will be available
10248 via the C<unixsock> plugin.
10250 =head2 List of configuration options
10254 =item B<PreCacheChain> I<ChainName>
10256 =item B<PostCacheChain> I<ChainName>
10258 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10259 argument is the name of a I<chain> that should be executed before and/or after
10260 the values have been added to the cache.
10262 To understand the implications, it's important you know what is going on inside
10263 I<collectd>. The following diagram shows how values are passed from the
10264 read-plugins to the write-plugins:
10270 + - - - - V - - - - +
10271 : +---------------+ :
10274 : +-------+-------+ :
10277 : +-------+-------+ : +---------------+
10278 : ! Cache !--->! Value Cache !
10279 : ! insert ! : +---+---+-------+
10280 : +-------+-------+ : ! !
10281 : ! ,------------' !
10283 : +-------+---+---+ : +-------+-------+
10284 : ! Post-Cache +--->! Write-Plugins !
10285 : ! Chain ! : +---------------+
10286 : +---------------+ :
10288 : dispatch values :
10289 + - - - - - - - - - +
10291 After the values are passed from the "read" plugins to the dispatch functions,
10292 the pre-cache chain is run first. The values are added to the internal cache
10293 afterwards. The post-cache chain is run after the values have been added to the
10294 cache. So why is it such a huge deal if chains are run before or after the
10295 values have been added to this cache?
10297 Targets that change the identifier of a value list should be executed before
10298 the values are added to the cache, so that the name in the cache matches the
10299 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10300 this cache to receive a list of all available values. If you change the
10301 identifier after the value list has been added to the cache, this may easily
10302 lead to confusion, but it's not forbidden of course.
10304 The cache is also used to convert counter values to rates. These rates are, for
10305 example, used by the C<value> match (see below). If you use the rate stored in
10306 the cache B<before> the new value is added, you will use the old, B<previous>
10307 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10308 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10311 Last but not last, the B<stop> target makes a difference: If the pre-cache
10312 chain returns the stop condition, the value will not be added to the cache and
10313 the post-cache chain will not be run.
10315 =item B<Chain> I<Name>
10317 Adds a new chain with a certain name. This name can be used to refer to a
10318 specific chain, for example to jump to it.
10320 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10322 =item B<Rule> [I<Name>]
10324 Adds a new rule to the current chain. The name of the rule is optional and
10325 currently has no meaning for the daemon.
10327 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10328 must be at least one B<Target> block.
10330 =item B<Match> I<Name>
10332 Adds a match to a B<Rule> block. The name specifies what kind of match should
10333 be performed. Available matches depend on the plugins that have been loaded.
10335 The arguments inside the B<Match> block are passed to the plugin implementing
10336 the match, so which arguments are valid here depends on the plugin being used.
10337 If you do not need any to pass any arguments to a match, you can use the
10342 Which is equivalent to:
10347 =item B<Target> I<Name>
10349 Add a target to a rule or a default target to a chain. The name specifies what
10350 kind of target is to be added. Which targets are available depends on the
10351 plugins being loaded.
10353 The arguments inside the B<Target> block are passed to the plugin implementing
10354 the target, so which arguments are valid here depends on the plugin being used.
10355 If you do not need any to pass any arguments to a target, you can use the
10360 This is the same as writing:
10367 =head2 Built-in targets
10369 The following targets are built into the core daemon and therefore need no
10370 plugins to be loaded:
10376 Signals the "return" condition, see the L<"Flow control"> section above. This
10377 causes the current chain to stop processing the value and returns control to
10378 the calling chain. The calling chain will continue processing targets and rules
10379 just after the B<jump> target (see below). This is very similar to the
10380 B<RETURN> target of iptables, see L<iptables(8)>.
10382 This target does not have any options.
10390 Signals the "stop" condition, see the L<"Flow control"> section above. This
10391 causes processing of the value to be aborted immediately. This is similar to
10392 the B<DROP> target of iptables, see L<iptables(8)>.
10394 This target does not have any options.
10402 Sends the value to "write" plugins.
10408 =item B<Plugin> I<Name>
10410 Name of the write plugin to which the data should be sent. This option may be
10411 given multiple times to send the data to more than one write plugin. If the
10412 plugin supports multiple instances, the plugin's instance(s) must also be
10417 If no plugin is explicitly specified, the values will be sent to all available
10420 Single-instance plugin example:
10426 Multi-instance plugin example:
10428 <Plugin "write_graphite">
10438 Plugin "write_graphite/foo"
10443 Starts processing the rules of another chain, see L<"Flow control"> above. If
10444 the end of that chain is reached, or a stop condition is encountered,
10445 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10446 next target or the next rule. This is similar to the B<-j> command line option
10447 of iptables, see L<iptables(8)>.
10453 =item B<Chain> I<Name>
10455 Jumps to the chain I<Name>. This argument is required and may appear only once.
10467 =head2 Available matches
10473 Matches a value using regular expressions.
10479 =item B<Host> I<Regex>
10481 =item B<Plugin> I<Regex>
10483 =item B<PluginInstance> I<Regex>
10485 =item B<Type> I<Regex>
10487 =item B<TypeInstance> I<Regex>
10489 =item B<MetaData> I<String> I<Regex>
10491 Match values where the given regular expressions match the various fields of
10492 the identifier of a value. If multiple regular expressions are given, B<all>
10493 regexen must match for a value to match.
10495 =item B<Invert> B<false>|B<true>
10497 When set to B<true>, the result of the match is inverted, i.e. all value lists
10498 where all regular expressions apply are not matched, all other value lists are
10499 matched. Defaults to B<false>.
10506 Host "customer[0-9]+"
10512 Matches values that have a time which differs from the time on the server.
10514 This match is mainly intended for servers that receive values over the
10515 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10516 is very sensitive to the timestamp used when updating the RRD files. In
10517 particular, the time must be ever increasing. If a misbehaving client sends one
10518 packet with a timestamp far in the future, all further packets with a correct
10519 time will be ignored because of that one packet. What's worse, such corrupted
10520 RRD files are hard to fix.
10522 This match lets one match all values B<outside> a specified time range
10523 (relative to the server's time), so you can use the B<stop> target (see below)
10524 to ignore the value, for example.
10530 =item B<Future> I<Seconds>
10532 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10533 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10536 =item B<Past> I<Seconds>
10538 Matches all values that are I<behind> of the server's time by I<Seconds> or
10539 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10551 This example matches all values that are five minutes or more ahead of the
10552 server or one hour (or more) lagging behind.
10556 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10557 values. If a data-set consists of more than one data-source, all data-sources
10558 must match the specified ranges for a positive match.
10564 =item B<Min> I<Value>
10566 Sets the smallest value which still results in a match. If unset, behaves like
10569 =item B<Max> I<Value>
10571 Sets the largest value which still results in a match. If unset, behaves like
10574 =item B<Invert> B<true>|B<false>
10576 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10577 no-match is returned and vice versa. Please note that the B<Invert> setting
10578 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10579 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10581 =item B<DataSource> I<DSName> [I<DSName> ...]
10583 Select one or more of the data sources. If no data source is configured, all
10584 data sources will be checked. If the type handled by the match does not have a
10585 data source of the specified name(s), this will always result in no match
10586 (independent of the B<Invert> setting).
10588 =item B<Satisfy> B<Any>|B<All>
10590 Specifies how checking with several data sources is performed. If set to
10591 B<Any>, the match succeeds if one of the data sources is in the configured
10592 range. If set to B<All> the match only succeeds if all data sources are within
10593 the configured range. Default is B<All>.
10595 Usually B<All> is used for positive matches, B<Any> is used for negative
10596 matches. This means that with B<All> you usually check that all values are in a
10597 "good" range, while with B<Any> you check if any value is within a "bad" range
10598 (or outside the "good" range).
10602 Either B<Min> or B<Max>, but not both, may be unset.
10606 # Match all values smaller than or equal to 100. Matches only if all data
10607 # sources are below 100.
10613 # Match if the value of any data source is outside the range of 0 - 100.
10621 =item B<empty_counter>
10623 Matches all values with one or more data sources of type B<COUNTER> and where
10624 all counter values are zero. These counters usually I<never> increased since
10625 they started existing (and are therefore uninteresting), or got reset recently
10626 or overflowed and you had really, I<really> bad luck.
10628 Please keep in mind that ignoring such counters can result in confusing
10629 behavior: Counters which hardly ever increase will be zero for long periods of
10630 time. If the counter is reset for some reason (machine or service restarted,
10631 usually), the graph will be empty (NAN) for a long time. People may not
10636 Calculates a hash value of the host name and matches values according to that
10637 hash value. This makes it possible to divide all hosts into groups and match
10638 only values that are in a specific group. The intended use is in load
10639 balancing, where you want to handle only part of all data and leave the rest
10642 The hashing function used tries to distribute the hosts evenly. First, it
10643 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10646 for (i = 0; host[i] != 0; i++)
10647 hash_value = (hash_value * 251) + host[i];
10649 The constant 251 is a prime number which is supposed to make this hash value
10650 more random. The code then checks the group for this host according to the
10651 I<Total> and I<Match> arguments:
10653 if ((hash_value % Total) == Match)
10658 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10659 groups), then the least significant bit of the hash value will be the XOR of
10660 all least significant bits in the host name. One consequence is that when you
10661 have two hosts, "server0.example.com" and "server1.example.com", where the host
10662 name differs in one digit only and the digits differ by one, those hosts will
10663 never end up in the same group.
10669 =item B<Match> I<Match> I<Total>
10671 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10672 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10673 be smaller than I<Total>. I<Total> must be at least one, although only values
10674 greater than one really do make any sense.
10676 You can repeat this option to match multiple groups, for example:
10681 The above config will divide the data into seven groups and match groups three
10682 and five. One use would be to keep every value on two hosts so that if one
10683 fails the missing data can later be reconstructed from the second host.
10689 # Operate on the pre-cache chain, so that ignored values are not even in the
10694 # Divide all received hosts in seven groups and accept all hosts in
10698 # If matched: Return and continue.
10701 # If not matched: Return and stop.
10707 =head2 Available targets
10711 =item B<notification>
10713 Creates and dispatches a notification.
10719 =item B<Message> I<String>
10721 This required option sets the message of the notification. The following
10722 placeholders will be replaced by an appropriate value:
10730 =item B<%{plugin_instance}>
10734 =item B<%{type_instance}>
10736 These placeholders are replaced by the identifier field of the same name.
10738 =item B<%{ds:>I<name>B<}>
10740 These placeholders are replaced by a (hopefully) human readable representation
10741 of the current rate of this data source. If you changed the instance name
10742 (using the B<set> or B<replace> targets, see below), it may not be possible to
10743 convert counter values to rates.
10747 Please note that these placeholders are B<case sensitive>!
10749 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10751 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10758 <Target "notification">
10759 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10765 Replaces parts of the identifier using regular expressions.
10771 =item B<Host> I<Regex> I<Replacement>
10773 =item B<Plugin> I<Regex> I<Replacement>
10775 =item B<PluginInstance> I<Regex> I<Replacement>
10777 =item B<TypeInstance> I<Regex> I<Replacement>
10779 =item B<MetaData> I<String> I<Regex> I<Replacement>
10781 =item B<DeleteMetaData> I<String> I<Regex>
10783 Match the appropriate field with the given regular expression I<Regex>. If the
10784 regular expression matches, that part that matches is replaced with
10785 I<Replacement>. If multiple places of the input buffer match a given regular
10786 expression, only the first occurrence will be replaced.
10788 You can specify each option multiple times to use multiple regular expressions
10796 # Replace "example.net" with "example.com"
10797 Host "\\<example.net\\>" "example.com"
10799 # Strip "www." from hostnames
10800 Host "\\<www\\." ""
10805 Sets part of the identifier of a value to a given string.
10811 =item B<Host> I<String>
10813 =item B<Plugin> I<String>
10815 =item B<PluginInstance> I<String>
10817 =item B<TypeInstance> I<String>
10819 =item B<MetaData> I<String> I<String>
10821 Set the appropriate field to the given string. The strings for plugin instance,
10822 type instance, and meta data may be empty, the strings for host and plugin may
10823 not be empty. It's currently not possible to set the type of a value this way.
10825 The following placeholders will be replaced by an appropriate value:
10833 =item B<%{plugin_instance}>
10837 =item B<%{type_instance}>
10839 These placeholders are replaced by the identifier field of the same name.
10841 =item B<%{meta:>I<name>B<}>
10843 These placeholders are replaced by the meta data value with the given name.
10847 Please note that these placeholders are B<case sensitive>!
10849 =item B<DeleteMetaData> I<String>
10851 Delete the named meta data field.
10858 PluginInstance "coretemp"
10859 TypeInstance "core3"
10864 =head2 Backwards compatibility
10866 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10867 B<Chain> block, it will behave as it used to. This is equivalent to the
10868 following configuration:
10870 <Chain "PostCache">
10874 If you specify a B<PostCacheChain>, the B<write> target will not be added
10875 anywhere and you will have to make sure that it is called where appropriate. We
10876 suggest to add the above snippet as default target to your "PostCache" chain.
10880 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10895 B<Ignorelists> are a generic framework to either ignore some metrics or report
10896 specific metircs only. Plugins usually provide one or more options to specify
10897 the items (mounts points, devices, ...) and the boolean option
10902 =item B<Select> I<String>
10904 Selects the item I<String>. This option often has a plugin specific name, e.g.
10905 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10906 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10907 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10909 By default, this option is doing a case-sensitive full-string match. The
10910 following config will match C<foo>, but not C<Foo>:
10914 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10915 I<regular expression>. For example, so match all item starting with C<foo>, use
10916 could use the following syntax:
10920 The regular expression is I<not> anchored, i.e. the following config will match
10921 C<foobar>, C<barfoo> and C<AfooZ>:
10925 The B<Select> option may be repeated to select multiple items.
10927 =item B<IgnoreSelected> B<true>|B<false>
10929 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10930 collected. If set to B<false>, matching metrics are I<collected> and all other
10931 metrics are ignored.
10938 L<collectd-exec(5)>,
10939 L<collectd-perl(5)>,
10940 L<collectd-unixsock(5)>,
10953 Florian Forster E<lt>octo@collectd.orgE<gt>