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 SharedMemObj "dpdk_collectd_stats_0"
2577 EnabledPortMask 0xffff
2578 PortName "interface1"
2579 PortName "interface2"
2584 =head3 The EAL block
2588 =item B<Coremask> I<Mask>
2590 A string containing an hexadecimal bit mask of the cores to run on. Note that
2591 core numbering can change between platforms and should be determined beforehand.
2593 =item B<Memorychannels> I<Channels>
2595 A string containing a number of memory channels per processor socket.
2597 =item B<FilePrefix> I<File>
2599 The prefix text used for hugepage filenames. The filename will be set to
2600 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2602 =item B<SocketMemory> I<MB>
2604 A string containing amount of Memory to allocate from hugepages on specific
2605 sockets in MB. This is an optional value.
2611 =item B<SharedMemObj> I<Mask>
2613 A string containing the name of the shared memory object that should be used to
2614 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2615 Defaults to dpdk_collectd_stats if no other value is configured.
2617 =item B<EnabledPortMask> I<Mask>
2619 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2620 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2621 that all ports will be enabled. This is an optional argument - default
2622 is all ports enabled.
2624 =item B<PortName> I<Name>
2626 A string containing an optional name for the enabled DPDK ports. Each PortName
2627 option should contain only one port name; specify as many PortName options as
2628 desired. Default naming convention will be used if PortName is blank. If there
2629 are less PortName options than there are enabled ports, the default naming
2630 convention will be used for the additional ports.
2634 =head2 Plugin C<email>
2638 =item B<SocketFile> I<Path>
2640 Sets the socket-file which is to be created.
2642 =item B<SocketGroup> I<Group>
2644 If running as root change the group of the UNIX-socket after it has been
2645 created. Defaults to B<collectd>.
2647 =item B<SocketPerms> I<Permissions>
2649 Change the file permissions of the UNIX-socket after it has been created. The
2650 permissions must be given as a numeric, octal value as you would pass to
2651 L<chmod(1)>. Defaults to B<0770>.
2653 =item B<MaxConns> I<Number>
2655 Sets the maximum number of connections that can be handled in parallel. Since
2656 this many threads will be started immediately setting this to a very high
2657 value will waste valuable resources. Defaults to B<5> and will be forced to be
2658 at most B<16384> to prevent typos and dumb mistakes.
2662 =head2 Plugin C<ethstat>
2664 The I<ethstat plugin> collects information about network interface cards (NICs)
2665 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2671 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2672 Map "multicast" "if_multicast"
2679 =item B<Interface> I<Name>
2681 Collect statistical information about interface I<Name>.
2683 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2685 By default, the plugin will submit values as type C<derive> and I<type
2686 instance> set to I<Name>, the name of the metric as reported by the driver. If
2687 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2688 I<TypeInstance> will be used.
2690 =item B<MappedOnly> B<true>|B<false>
2692 When set to B<true>, only metrics that can be mapped to a I<type> will be
2693 collected, all other metrics will be ignored. Defaults to B<false>.
2697 =head2 Plugin C<exec>
2699 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2700 contains valuable information on when the executable is executed and the
2701 output that is expected from it.
2705 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2707 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2709 Execute the executable I<Executable> as user I<User>. If the user name is
2710 followed by a colon and a group name, the effective group is set to that group.
2711 The real group and saved-set group will be set to the default group of that
2712 user. If no group is given the effective group ID will be the same as the real
2715 Please note that in order to change the user and/or group the daemon needs
2716 superuser privileges. If the daemon is run as an unprivileged user you must
2717 specify the same user/group here. If the daemon is run with superuser
2718 privileges, you must supply a non-root user here.
2720 The executable may be followed by optional arguments that are passed to the
2721 program. Please note that due to the configuration parsing numbers and boolean
2722 values may be changed. If you want to be absolutely sure that something is
2723 passed as-is please enclose it in quotes.
2725 The B<Exec> and B<NotificationExec> statements change the semantics of the
2726 programs executed, i.E<nbsp>e. the data passed to them and the response
2727 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2731 =head2 Plugin C<fhcount>
2733 The C<fhcount> plugin provides statistics about used, unused and total number of
2734 file handles on Linux.
2736 The I<fhcount plugin> provides the following configuration options:
2740 =item B<ValuesAbsolute> B<true>|B<false>
2742 Enables or disables reporting of file handles usage in absolute numbers,
2743 e.g. file handles used. Defaults to B<true>.
2745 =item B<ValuesPercentage> B<false>|B<true>
2747 Enables or disables reporting of file handles usage in percentages, e.g.
2748 percent of file handles used. Defaults to B<false>.
2752 =head2 Plugin C<filecount>
2754 The C<filecount> plugin counts the number of files in a certain directory (and
2755 its subdirectories) and their combined size. The configuration is very straight
2758 <Plugin "filecount">
2759 <Directory "/var/qmail/queue/mess">
2760 Instance "qmail-message"
2762 <Directory "/var/qmail/queue/todo">
2763 Instance "qmail-todo"
2765 <Directory "/var/lib/php5">
2766 Instance "php5-sessions"
2771 The example above counts the number of files in QMail's queue directories and
2772 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2773 QMail has not yet looked at, the "message" queue holds the messages that were
2774 classified into "local" and "remote".
2776 As you can see, the configuration consists of one or more C<Directory> blocks,
2777 each of which specifies a directory in which to count the files. Within those
2778 blocks, the following options are recognized:
2782 =item B<Plugin> I<Plugin>
2784 Use I<Plugin> as the plugin name when submitting values.
2785 Defaults to B<filecount>.
2787 =item B<Instance> I<Instance>
2789 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2790 the directory name with all slashes replaced by underscores and all leading
2791 underscores removed. Empty value is allowed.
2793 =item B<Name> I<Pattern>
2795 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2796 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2797 against the pattern, not the entire path. In case this makes it easier for you:
2798 This option has been named after the B<-name> parameter to L<find(1)>.
2800 =item B<MTime> I<Age>
2802 Count only files of a specific age: If I<Age> is greater than zero, only files
2803 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2804 a negative number, this is inversed. For example, if B<-60> is specified, only
2805 files that have been modified in the last minute will be counted.
2807 The number can also be followed by a "multiplier" to easily specify a larger
2808 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2809 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2810 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2811 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2812 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2815 =item B<Size> I<Size>
2817 Count only files of a specific size. When I<Size> is a positive number, only
2818 files that are at least this big are counted. If I<Size> is a negative number,
2819 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2820 I<Size> are counted.
2822 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2823 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2824 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2825 note that there are 1000 bytes in a kilobyte, not 1024.
2827 =item B<Recursive> I<true>|I<false>
2829 Controls whether or not to recurse into subdirectories. Enabled by default.
2831 =item B<IncludeHidden> I<true>|I<false>
2833 Controls whether or not to include "hidden" files and directories in the count.
2834 "Hidden" files and directories are those, whose name begins with a dot.
2835 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2837 =item B<FilesSizeType> I<Type>
2839 Sets the type used to dispatch files combined size. Empty value ("") disables
2840 reporting. Defaults to B<bytes>.
2842 =item B<FilesCountType> I<Type>
2844 Sets the type used to dispatch number of files. Empty value ("") disables
2845 reporting. Defaults to B<files>.
2847 =item B<TypeInstance> I<Instance>
2849 Sets the I<type instance> used to dispatch values. Defaults to an empty string
2850 (no plugin instance).
2854 =head2 Plugin C<GenericJMX>
2856 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2857 L<collectd-java(5)>.
2859 =head2 Plugin C<gmond>
2861 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2862 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2863 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2868 MCReceiveFrom "239.2.11.71" "8649"
2869 <Metric "swap_total">
2871 TypeInstance "total"
2874 <Metric "swap_free">
2881 The following metrics are built-in:
2887 load_one, load_five, load_fifteen
2891 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2895 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2907 Available configuration options:
2911 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2913 Sets sets the multicast group and UDP port to which to subscribe.
2915 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2917 =item E<lt>B<Metric> I<Name>E<gt>
2919 These blocks add a new metric conversion to the internal table. I<Name>, the
2920 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2924 =item B<Type> I<Type>
2926 Type to map this metric to. Required.
2928 =item B<TypeInstance> I<Instance>
2930 Type-instance to use. Optional.
2932 =item B<DataSource> I<Name>
2934 Data source to map this metric to. If the configured type has exactly one data
2935 source, this is optional. Otherwise the option is required.
2941 =head2 Plugin C<gps>
2943 The C<gps plugin> connects to gpsd on the host machine.
2944 The host, port, timeout and pause are configurable.
2946 This is useful if you run an NTP server using a GPS for source and you want to
2949 Mind your GPS must send $--GSA for having the data reported!
2951 The following elements are collected:
2957 Number of satellites used for fix (type instance "used") and in view (type
2958 instance "visible"). 0 means no GPS satellites are visible.
2960 =item B<dilution_of_precision>
2962 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2963 It should be between 0 and 3.
2964 Look at the documentation of your GPS to know more.
2972 # Connect to localhost on gpsd regular port:
2977 # PauseConnect of 5 sec. between connection attempts.
2981 Available configuration options:
2985 =item B<Host> I<Host>
2987 The host on which gpsd daemon runs. Defaults to B<localhost>.
2989 =item B<Port> I<Port>
2991 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2993 =item B<Timeout> I<Seconds>
2995 Timeout in seconds (default 0.015 sec).
2997 The GPS data stream is fetch by the plugin form the daemon.
2998 It waits for data to be available, if none arrives it times out
2999 and loop for another reading.
3000 Mind to put a low value gpsd expects value in the micro-seconds area
3001 (recommended is 500 us) since the waiting function is blocking.
3002 Value must be between 500 us and 5 sec., if outside that range the
3003 default value is applied.
3005 This only applies from gpsd release-2.95.
3007 =item B<PauseConnect> I<Seconds>
3009 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3013 =head2 Plugin C<grpc>
3015 The I<grpc> plugin provides an RPC interface to submit values to or query
3016 values from collectd based on the open source gRPC framework. It exposes an
3017 end-point for dispatching values to the daemon.
3019 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3023 =item B<Server> I<Host> I<Port>
3025 The B<Server> statement sets the address of a server to which to send metrics
3026 via the C<DispatchValues> function.
3028 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3030 Optionally, B<Server> may be specified as a configuration block which supports
3031 the following options:
3035 =item B<EnableSSL> B<false>|B<true>
3037 Whether to require SSL for outgoing connections. Default: false.
3039 =item B<SSLCACertificateFile> I<Filename>
3041 =item B<SSLCertificateFile> I<Filename>
3043 =item B<SSLCertificateKeyFile> I<Filename>
3045 Filenames specifying SSL certificate and key material to be used with SSL
3050 =item B<Listen> I<Host> I<Port>
3052 The B<Listen> statement sets the network address to bind to. When multiple
3053 statements are specified, the daemon will bind to all of them. If none are
3054 specified, it defaults to B<0.0.0.0:50051>.
3056 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3058 Optionally, B<Listen> may be specified as a configuration block which
3059 supports the following options:
3063 =item B<EnableSSL> I<true>|I<false>
3065 Whether to enable SSL for incoming connections. Default: false.
3067 =item B<SSLCACertificateFile> I<Filename>
3069 =item B<SSLCertificateFile> I<Filename>
3071 =item B<SSLCertificateKeyFile> I<Filename>
3073 Filenames specifying SSL certificate and key material to be used with SSL
3080 =head2 Plugin C<hddtemp>
3082 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3083 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3084 default values, see below. C<hddtemp> has to be running to work correctly. If
3085 C<hddtemp> is not running timeouts may appear which may interfere with other
3088 The B<hddtemp> homepage can be found at
3089 L<http://www.guzu.net/linux/hddtemp.php>.
3093 =item B<Host> I<Hostname>
3095 Hostname to connect to. Defaults to B<127.0.0.1>.
3097 =item B<Port> I<Port>
3099 TCP-Port to connect to. Defaults to B<7634>.
3103 =head2 Plugin C<hugepages>
3105 To collect B<hugepages> information, collectd reads directories
3106 "/sys/devices/system/node/*/hugepages" and
3107 "/sys/kernel/mm/hugepages".
3108 Reading of these directories can be disabled by the following
3109 options (default is enabled).
3113 =item B<ReportPerNodeHP> B<true>|B<false>
3115 If enabled, information will be collected from the hugepage
3116 counters in "/sys/devices/system/node/*/hugepages".
3117 This is used to check the per-node hugepage statistics on
3120 =item B<ReportRootHP> B<true>|B<false>
3122 If enabled, information will be collected from the hugepage
3123 counters in "/sys/kernel/mm/hugepages".
3124 This can be used on both NUMA and non-NUMA systems to check
3125 the overall hugepage statistics.
3127 =item B<ValuesPages> B<true>|B<false>
3129 Whether to report hugepages metrics in number of pages.
3130 Defaults to B<true>.
3132 =item B<ValuesBytes> B<false>|B<true>
3134 Whether to report hugepages metrics in bytes.
3135 Defaults to B<false>.
3137 =item B<ValuesPercentage> B<false>|B<true>
3139 Whether to report hugepages metrics as percentage.
3140 Defaults to B<false>.
3144 =head2 Plugin C<intel_pmu>
3146 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3147 Linux perf interface. All events are reported on a per core basis.
3152 ReportHardwareCacheEvents true
3153 ReportKernelPMUEvents true
3154 ReportSoftwareEvents true
3155 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3156 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3163 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3165 Enable or disable measuring of hardware CPU cache events:
3167 - L1-dcache-load-misses
3169 - L1-dcache-store-misses
3170 - L1-dcache-prefetches
3171 - L1-dcache-prefetch-misses
3173 - L1-icache-load-misses
3174 - L1-icache-prefetches
3175 - L1-icache-prefetch-misses
3181 - LLC-prefetch-misses
3187 - dTLB-prefetch-misses
3191 - branch-load-misses
3193 =item B<ReportKernelPMUEvents> B<false>|B<true>
3195 Enable or disable measuring of the following events:
3204 =item B<ReportSoftwareEvents> B<false>|B<true>
3206 Enable or disable measuring of software events provided by kernel:
3217 =item B<EventList> I<filename>
3219 JSON performance counter event list file name. To be able to monitor all Intel
3220 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3221 event_download.py script to download event list for current CPU.
3223 =item B<HardwareEvents> I<events>
3225 This field is a list of event names or groups of comma separated event names.
3226 This option requires B<EventList> option to be configured.
3230 =head2 Plugin C<intel_rdt>
3232 The I<intel_rdt> plugin collects information provided by monitoring features of
3233 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3234 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3235 information about utilization of shared resources. CMT monitors last level cache
3236 occupancy (LLC). MBM supports two types of events reporting local and remote
3237 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3238 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3239 reports the bandwidth of accessing the remote socket. Also this technology
3240 allows to monitor instructions per clock (IPC).
3241 Monitor events are hardware dependant. Monitoring capabilities are detected on
3242 plugin initialization and only supported events are monitored.
3244 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3245 require an additional capability to be enabled if collectd is run as a service.
3246 Please refer to I<contrib/systemd.collectd.service> file for more details.
3250 <Plugin "intel_rdt">
3251 Cores "0-2" "3,4,6" "8-10,15"
3258 =item B<Interval> I<seconds>
3260 The interval within which to retrieve statistics on monitored events in seconds.
3261 For milliseconds divide the time by 1000 for example if the desired interval
3262 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3263 recommended to set interval higher than 1 sec.
3265 =item B<Cores> I<cores groups>
3267 All events are reported on a per core basis. Monitoring of the events can be
3268 configured for group of cores (aggregated statistics). This field defines groups
3269 of cores on which to monitor supported events. The field is represented as list
3270 of strings with core group values. Each string represents a list of cores in a
3271 group. Allowed formats are:
3276 If an empty string is provided as value for this field default cores
3277 configuration is applied - a separate group is created for each core.
3281 B<Note:> By default global interval is used to retrieve statistics on monitored
3282 events. To configure a plugin specific interval use B<Interval> option of the
3283 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3284 example if the desired interval is 50ms, set interval to 0.05.
3285 Due to limited capacity of counters it is not recommended to set interval higher
3288 =head2 Plugin C<interface>
3292 =item B<Interface> I<Interface>
3294 Select this interface. By default these interfaces will then be collected. For
3295 a more detailed description see B<IgnoreSelected> below.
3297 See F</"IGNORELISTS"> for details.
3299 =item B<IgnoreSelected> I<true>|I<false>
3301 If no configuration is given, the B<interface>-plugin will collect data from
3302 all interfaces. This may not be practical, especially for loopback- and
3303 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3304 interfaces you're interested in. Sometimes, however, it's easier/preferred
3305 to collect all interfaces I<except> a few ones. This option enables you to
3306 do that: By setting B<IgnoreSelected> to I<true> the effect of
3307 B<Interface> is inverted: All selected interfaces are ignored and all
3308 other interfaces are collected.
3310 It is possible to use regular expressions to match interface names, if the
3311 name is surrounded by I</.../> and collectd was compiled with support for
3312 regexps. This is useful if there's a need to collect (or ignore) data
3313 for a group of interfaces that are similarly named, without the need to
3314 explicitly list all of them (especially useful if the list is dynamic).
3319 Interface "/^tun[0-9]+/"
3320 IgnoreSelected "true"
3322 This will ignore the loopback interface, all interfaces with names starting
3323 with I<veth> and all interfaces with names starting with I<tun> followed by
3326 =item B<ReportInactive> I<true>|I<false>
3328 When set to I<false>, only interfaces with non-zero traffic will be
3329 reported. Note that the check is done by looking into whether a
3330 package was sent at any time from boot and the corresponding counter
3331 is non-zero. So, if the interface has been sending data in the past
3332 since boot, but not during the reported time-interval, it will still
3335 The default value is I<true> and results in collection of the data
3336 from all interfaces that are selected by B<Interface> and
3337 B<IgnoreSelected> options.
3339 =item B<UniqueName> I<true>|I<false>
3341 Interface name is not unique on Solaris (KSTAT), interface name is unique
3342 only within a module/instance. Following tuple is considered unique:
3343 (ks_module, ks_instance, ks_name)
3344 If this option is set to true, interface name contains above three fields
3345 separated by an underscore. For more info on KSTAT, visit
3346 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3348 This option is only available on Solaris.
3352 =head2 Plugin C<ipmi>
3354 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3355 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3357 The plugin configuration consists of one or more B<Instance> blocks which
3358 specify one I<ipmi> connection each. Within the B<Instance> blocks, the
3359 following options are allowed:
3363 =item B<Address> I<Address>
3365 Hostname or IP to connect to. If not specified, plugin will try to connect to
3366 local management controller (BMC).
3368 =item B<Username> I<Username>
3370 =item B<Password> I<Password>
3372 The username and the password to use for the connection to remote BMC.
3374 =item B<AuthType> I<MD5>|I<rmcp+>
3376 Forces the authentication type to use for the connection to remote BMC.
3377 By default most secure type is seleted.
3379 =item B<Host> I<Hostname>
3381 Sets the B<host> field of dispatched values. Defaults to the global hostname
3384 =item B<Sensor> I<Sensor>
3386 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3388 See F</"IGNORELISTS"> for details.
3390 =item B<IgnoreSelected> I<true>|I<false>
3392 If no configuration if given, the B<ipmi> plugin will collect data from all
3393 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3394 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3395 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3396 all other sensors are collected.
3398 =item B<NotifySensorAdd> I<true>|I<false>
3400 If a sensor appears after initialization time of a minute a notification
3403 =item B<NotifySensorRemove> I<true>|I<false>
3405 If a sensor disappears a notification is sent.
3407 =item B<NotifySensorNotPresent> I<true>|I<false>
3409 If you have for example dual power supply and one of them is (un)plugged then
3410 a notification is sent.
3412 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3414 If a IPMI connection state changes after initialization time of a minute
3415 a notification is sent. Defaults to B<false>.
3417 =item B<SELEnabled> I<true>|I<false>
3419 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3420 and discrete events. When event is received the notification is sent.
3421 Defaults to B<false>.
3423 =item B<SELClearEvent> I<true>|I<false>
3425 If SEL clear event is enabled, plugin will delete event from SEL list after
3426 it is received and successfully handled. In this case other tools that are
3427 subscribed for SEL events will receive an empty event.
3428 Defaults to B<false>.
3432 =head2 Plugin C<iptables>
3436 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3438 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3440 Select the iptables/ip6tables filter rules to count packets and bytes from.
3442 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3443 of all rules which have a comment-match. The comment is then used as
3446 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3447 the I<n>th rule will be collected. Again, the comment (or the number) will be
3448 used as the type-instance.
3450 If I<Name> is supplied, it will be used as the type-instance instead of the
3451 comment or the number.
3455 =head2 Plugin C<irq>
3461 Select this irq. By default these irqs will then be collected. For a more
3462 detailed description see B<IgnoreSelected> below.
3464 See F</"IGNORELISTS"> for details.
3466 =item B<IgnoreSelected> I<true>|I<false>
3468 If no configuration if given, the B<irq>-plugin will collect data from all
3469 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3470 can use the B<Irq>-option to pick the interrupt you're interested in.
3471 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3472 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3473 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3474 and all other interrupts are collected.
3478 =head2 Plugin C<java>
3480 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3481 This section only discusses the syntax and semantic of the configuration
3482 options. For more in-depth information on the I<Java> plugin, please read
3483 L<collectd-java(5)>.
3488 JVMArg "-verbose:jni"
3489 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3490 LoadPlugin "org.collectd.java.Foobar"
3491 <Plugin "org.collectd.java.Foobar">
3492 # To be parsed by the plugin
3496 Available configuration options:
3500 =item B<JVMArg> I<Argument>
3502 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3503 exactly the way the arguments to the I<java> binary on the command line work.
3504 Execute C<javaE<nbsp>--help> for details.
3506 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3507 any other options! When another option is found, the JVM will be started and
3508 later options will have to be ignored!
3510 =item B<LoadPlugin> I<JavaClass>
3512 Instantiates a new I<JavaClass> object. The constructor of this object very
3513 likely then registers one or more callback methods with the server.
3515 See L<collectd-java(5)> for details.
3517 When the first such option is found, the virtual machine (JVM) is created. This
3518 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3519 B<LoadPlugin> options!
3521 =item B<Plugin> I<Name>
3523 The entire block is passed to the Java plugin as an
3524 I<org.collectd.api.OConfigItem> object.
3526 For this to work, the plugin has to register a configuration callback first,
3527 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3528 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3529 depends on the (Java) plugin registering the callback and is completely
3530 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3534 =head2 Plugin C<load>
3536 The I<Load plugin> collects the system load. These numbers give a rough overview
3537 over the utilization of a machine. The system load is defined as the number of
3538 runnable tasks in the run-queue and is provided by many operating systems as a
3539 one, five or fifteen minute average.
3541 The following configuration options are available:
3545 =item B<ReportRelative> B<false>|B<true>
3547 When enabled, system load divided by number of available CPU cores is reported
3548 for intervals 1 min, 5 min and 15 min. Defaults to false.
3553 =head2 Plugin C<logfile>
3557 =item B<LogLevel> B<debug|info|notice|warning|err>
3559 Sets the log-level. If, for example, set to B<notice>, then all events with
3560 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3562 Please note that B<debug> is only available if collectd has been compiled with
3565 =item B<File> I<File>
3567 Sets the file to write log messages to. The special strings B<stdout> and
3568 B<stderr> can be used to write to the standard output and standard error
3569 channels, respectively. This, of course, only makes much sense when I<collectd>
3570 is running in foreground- or non-daemon-mode.
3572 =item B<Timestamp> B<true>|B<false>
3574 Prefix all lines printed by the current time. Defaults to B<true>.
3576 =item B<PrintSeverity> B<true>|B<false>
3578 When enabled, all lines are prefixed by the severity of the log message, for
3579 example "warning". Defaults to B<false>.
3583 B<Note>: There is no need to notify the daemon after moving or removing the
3584 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3585 for each line it writes.
3587 =head2 Plugin C<log_logstash>
3589 The I<log logstash plugin> behaves like the logfile plugin but formats
3590 messages as JSON events for logstash to parse and input.
3594 =item B<LogLevel> B<debug|info|notice|warning|err>
3596 Sets the log-level. If, for example, set to B<notice>, then all events with
3597 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3599 Please note that B<debug> is only available if collectd has been compiled with
3602 =item B<File> I<File>
3604 Sets the file to write log messages to. The special strings B<stdout> and
3605 B<stderr> can be used to write to the standard output and standard error
3606 channels, respectively. This, of course, only makes much sense when I<collectd>
3607 is running in foreground- or non-daemon-mode.
3611 B<Note>: There is no need to notify the daemon after moving or removing the
3612 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3613 for each line it writes.
3615 =head2 Plugin C<lpar>
3617 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3618 virtualization technique for IBM POWER processors. It takes into account CPU
3619 time stolen from or donated to a partition, in addition to the usual user,
3620 system, I/O statistics.
3622 The following configuration options are available:
3626 =item B<CpuPoolStats> B<false>|B<true>
3628 When enabled, statistics about the processor pool are read, too. The partition
3629 needs to have pool authority in order to be able to acquire this information.
3632 =item B<ReportBySerial> B<false>|B<true>
3634 If enabled, the serial of the physical machine the partition is currently
3635 running on is reported as I<hostname> and the logical hostname of the machine
3636 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3637 used (just like other plugins) and the I<plugin instance> will be empty.
3642 =head2 Plugin C<lua>
3644 This plugin embeds a Lua interpreter into collectd and provides an interface
3645 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3648 =head2 Plugin C<mbmon>
3650 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3652 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3653 B<Host> and B<Port> options can be used to change these values, see below.
3654 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3655 timeouts may appear which may interfere with other statistics..
3657 C<mbmon> must be run with the -r option ("print TAG and Value format");
3658 Debian's F</etc/init.d/mbmon> script already does this, other people
3659 will need to ensure that this is the case.
3663 =item B<Host> I<Hostname>
3665 Hostname to connect to. Defaults to B<127.0.0.1>.
3667 =item B<Port> I<Port>
3669 TCP-Port to connect to. Defaults to B<411>.
3673 =head2 Plugin C<mcelog>
3675 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3677 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3678 mcelog server is running. When the server is running, the plugin will tail the
3679 specified logfile to retrieve machine check exception information and send a
3680 notification with the details from the logfile. The plugin will use the mcelog
3681 client protocol to retrieve memory related machine check exceptions. Note that
3682 for memory exceptions, notifications are only sent when there is a change in
3683 the number of corrected/uncorrected memory errors.
3685 =head3 The Memory block
3687 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3692 =item B<McelogClientSocket> I<Path>
3693 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3694 Defaults to B<"/var/run/mcelog-client">.
3696 =item B<PersistentNotification> B<true>|B<false>
3697 Override default configuration to only send notifications when sent when there
3698 is a change in the number of corrected/uncorrected memory errors. When set to
3699 true notifications will be sent for every read cycle. Default is false. Does
3700 not affect the stats being dispatched.
3706 =item B<McelogLogfile> I<Path>
3708 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3709 cannot be used in conjunction with the memory block options, they are mutually
3716 The C<md plugin> collects information from Linux Software-RAID devices (md).
3718 All reported values are of the type C<md_disks>. Reported type instances are
3719 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3720 I<missing> (physically absent) disks.
3724 =item B<Device> I<Device>
3726 Select md devices based on device name. The I<device name> is the basename of
3727 the device, i.e. the name of the block device without the leading C</dev/>.
3728 See B<IgnoreSelected> for more details.
3730 See F</"IGNORELISTS"> for details.
3732 =item B<IgnoreSelected> B<true>|B<false>
3734 Invert device selection: If set to B<true>, all md devices B<except> those
3735 listed using B<Device> are collected. If B<false> (the default), only those
3736 listed are collected. If no configuration is given, the B<md> plugin will
3737 collect data from all md devices.
3741 =head2 Plugin C<memcachec>
3743 The C<memcachec plugin> connects to a memcached server, queries one or more
3744 given I<pages> and parses the returned data according to user specification.
3745 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3748 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3749 library. Please note that there is another library with a very similar name,
3750 libmemcache (notice the missing `d'), which is not applicable.
3752 Synopsis of the configuration:
3754 <Plugin "memcachec">
3755 <Page "plugin_instance">
3758 Plugin "plugin_name"
3760 Regex "(\\d+) bytes sent"
3763 Instance "type_instance"
3768 The configuration options are:
3772 =item E<lt>B<Page> I<Name>E<gt>
3774 Each B<Page> block defines one I<page> to be queried from the memcached server.
3775 The block requires one string argument which is used as I<plugin instance>.
3777 =item B<Server> I<Address>
3779 Sets the server address to connect to when querying the page. Must be inside a
3784 When connected to the memcached server, asks for the page I<Key>.
3786 =item B<Plugin> I<Plugin>
3788 Use I<Plugin> as the plugin name when submitting values.
3789 Defaults to C<memcachec>.
3791 =item E<lt>B<Match>E<gt>
3793 Match blocks define which strings to look for and how matches substrings are
3794 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3798 =head2 Plugin C<memcached>
3800 The B<memcached plugin> connects to a memcached server and queries statistics
3801 about cache utilization, memory and bandwidth used.
3802 L<http://memcached.org/>
3804 <Plugin "memcached">
3806 #Host "memcache.example.com"
3812 The plugin configuration consists of one or more B<Instance> blocks which
3813 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3814 following options are allowed:
3818 =item B<Host> I<Hostname>
3820 Sets the B<host> field of dispatched values. Defaults to the global hostname
3822 For backwards compatibility, values are also dispatched with the global
3823 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3826 =item B<Address> I<Address>
3828 Hostname or IP to connect to. For backwards compatibility, defaults to the
3829 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3831 =item B<Port> I<Port>
3833 TCP port to connect to. Defaults to B<11211>.
3835 =item B<Socket> I<Path>
3837 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3838 setting is given, the B<Address> and B<Port> settings are ignored.
3842 =head2 Plugin C<mic>
3844 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3845 Intel's Many Integrated Core (MIC) systems.
3854 ShowTemperatures true
3857 IgnoreSelectedTemperature true
3862 IgnoreSelectedPower true
3865 The following options are valid inside the B<PluginE<nbsp>mic> block:
3869 =item B<ShowCPU> B<true>|B<false>
3871 If enabled (the default) a sum of the CPU usage across all cores is reported.
3873 =item B<ShowCPUCores> B<true>|B<false>
3875 If enabled (the default) per-core CPU usage is reported.
3877 =item B<ShowMemory> B<true>|B<false>
3879 If enabled (the default) the physical memory usage of the MIC system is
3882 =item B<ShowTemperatures> B<true>|B<false>
3884 If enabled (the default) various temperatures of the MIC system are reported.
3886 =item B<Temperature> I<Name>
3888 This option controls which temperatures are being reported. Whether matching
3889 temperatures are being ignored or I<only> matching temperatures are reported
3890 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3891 temperatures are reported.
3893 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3895 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3896 (the default) only temperatures matching a B<Temperature> option are reported
3897 or, if no B<Temperature> option is specified, all temperatures are reported. If
3898 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3901 Known temperature names are:
3935 =item B<ShowPower> B<true>|B<false>
3937 If enabled (the default) various temperatures of the MIC system are reported.
3939 =item B<Power> I<Name>
3941 This option controls which power readings are being reported. Whether matching
3942 power readings are being ignored or I<only> matching power readings are reported
3943 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3944 power readings are reported.
3946 =item B<IgnoreSelectedPower> B<false>|B<true>
3948 Controls the behavior of the B<Power> setting above. If set to B<false>
3949 (the default) only power readings matching a B<Power> option are reported
3950 or, if no B<Power> option is specified, all power readings are reported. If
3951 set to B<true>, matching power readings are I<ignored> and all other power readings
3954 Known power names are:
3960 Total power utilization averaged over Time Window 0 (uWatts).
3964 Total power utilization averaged over Time Window 0 (uWatts).
3968 Instantaneous power (uWatts).
3972 Max instantaneous power (uWatts).
3976 PCI-E connector power (uWatts).
3980 2x3 connector power (uWatts).
3984 2x4 connector power (uWatts).
3992 Uncore rail (uVolts).
3996 Memory subsystem rail (uVolts).
4002 =head2 Plugin C<memory>
4004 The I<memory plugin> provides the following configuration options:
4008 =item B<ValuesAbsolute> B<true>|B<false>
4010 Enables or disables reporting of physical memory usage in absolute numbers,
4011 i.e. bytes. Defaults to B<true>.
4013 =item B<ValuesPercentage> B<false>|B<true>
4015 Enables or disables reporting of physical memory usage in percentages, e.g.
4016 percent of physical memory used. Defaults to B<false>.
4018 This is useful for deploying I<collectd> in a heterogeneous environment in
4019 which the sizes of physical memory vary.
4023 =head2 Plugin C<modbus>
4025 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4026 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4027 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
4028 values (two registers interpreted as IEEE floats in big endian notation).
4032 <Data "voltage-input-1">
4035 RegisterCmd ReadHolding
4040 <Data "voltage-input-2">
4043 RegisterCmd ReadHolding
4048 <Data "supply-temperature-1">
4051 RegisterCmd ReadHolding
4056 <Host "modbus.example.com">
4057 Address "192.168.0.42"
4062 Instance "power-supply"
4063 Collect "voltage-input-1"
4064 Collect "voltage-input-2"
4069 Device "/dev/ttyUSB0"
4074 Instance "temperature"
4075 Collect "supply-temperature-1"
4081 =item E<lt>B<Data> I<Name>E<gt> blocks
4083 Data blocks define a mapping between register numbers and the "types" used by
4086 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4090 =item B<RegisterBase> I<Number>
4092 Configures the base register to read from the device. If the option
4093 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4094 register will be read (the register number is increased by one).
4096 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
4098 Specifies what kind of data is returned by the device. If the type is B<Int32>,
4099 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
4100 combined into one value. Defaults to B<Uint16>.
4102 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4104 Specifies register type to be collected from device. Works only with libmodbus
4105 2.9.2 or higher. Defaults to B<ReadHolding>.
4107 =item B<Type> I<Type>
4109 Specifies the "type" (data set) to use when dispatching the value to
4110 I<collectd>. Currently, only data sets with exactly one data source are
4113 =item B<Instance> I<Instance>
4115 Sets the type instance to use when dispatching the value to I<collectd>. If
4116 unset, an empty string (no type instance) is used.
4120 =item E<lt>B<Host> I<Name>E<gt> blocks
4122 Host blocks are used to specify to which hosts to connect and what data to read
4123 from their "slaves". The string argument I<Name> is used as hostname when
4124 dispatching the values to I<collectd>.
4126 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4130 =item B<Address> I<Hostname>
4132 For Modbus/TCP, specifies the node name (the actual network address) used to
4133 connect to the host. This may be an IP address or a hostname. Please note that
4134 the used I<libmodbus> library only supports IPv4 at the moment.
4136 =item B<Port> I<Service>
4138 for Modbus/TCP, specifies the port used to connect to the host. The port can
4139 either be given as a number or as a service name. Please note that the
4140 I<Service> argument must be a string, even if ports are given in their numerical
4141 form. Defaults to "502".
4143 =item B<Device> I<Devicenode>
4145 For Modbus/RTU, specifies the path to the serial device being used.
4147 =item B<Baudrate> I<Baudrate>
4149 For Modbus/RTU, specifies the baud rate of the serial device.
4150 Note, connections currently support only 8/N/1.
4152 =item B<Interval> I<Interval>
4154 Sets the interval (in seconds) in which the values will be collected from this
4155 host. By default the global B<Interval> setting will be used.
4157 =item E<lt>B<Slave> I<ID>E<gt>
4159 Over each connection, multiple Modbus devices may be reached. The slave ID
4160 is used to specify which device should be addressed. For each device you want
4161 to query, one B<Slave> block must be given.
4163 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4167 =item B<Instance> I<Instance>
4169 Specify the plugin instance to use when dispatching the values to I<collectd>.
4170 By default "slave_I<ID>" is used.
4172 =item B<Collect> I<DataName>
4174 Specifies which data to retrieve from the device. I<DataName> must be the same
4175 string as the I<Name> argument passed to a B<Data> block. You can specify this
4176 option multiple times to collect more than one value from a slave. At least one
4177 B<Collect> option is mandatory.
4185 =head2 Plugin C<mqtt>
4187 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4188 values from MQTT (B<Subscribe> blocks).
4194 Host "mqtt.example.com"
4198 Host "mqtt.example.com"
4203 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4204 configuring the sending and receiving direction respectively. The plugin will
4205 register a write callback named C<mqtt/I<name>> where I<name> is the string
4206 argument given to the B<Publish> block. Both types of blocks share many but not
4207 all of the following options. If an option is valid in only one of the blocks,
4208 it will be mentioned explicitly.
4214 =item B<Host> I<Hostname>
4216 Hostname of the MQTT broker to connect to.
4218 =item B<Port> I<Service>
4220 Port number or service name of the MQTT broker to connect to.
4222 =item B<User> I<UserName>
4224 Username used when authenticating to the MQTT broker.
4226 =item B<Password> I<Password>
4228 Password used when authenticating to the MQTT broker.
4230 =item B<ClientId> I<ClientId>
4232 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4234 =item B<QoS> [B<0>-B<2>]
4236 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4254 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4255 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4256 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4257 on a message is larger than the maximum accepted QoS of a subscriber, the
4258 message's QoS will be downgraded.
4260 =item B<Prefix> I<Prefix> (Publish only)
4262 This plugin will use one topic per I<value list> which will looks like a path.
4263 I<Prefix> is used as the first path element and defaults to B<collectd>.
4265 An example topic name would be:
4267 collectd/cpu-0/cpu-user
4269 =item B<Retain> B<false>|B<true> (Publish only)
4271 Controls whether the MQTT broker will retain (keep a copy of) the last message
4272 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4274 =item B<StoreRates> B<true>|B<false> (Publish only)
4276 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4277 before sending. Defaults to B<true>.
4279 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4281 Controls whether the MQTT "cleans" the session up after the subscriber
4282 disconnects or if it maintains the subscriber's subscriptions and all messages
4283 that arrive while the subscriber is disconnected. Defaults to B<true>.
4285 =item B<Topic> I<TopicName> (Subscribe only)
4287 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4288 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4289 the B<collectd> branch.
4291 =item B<CACert> I<file>
4293 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4294 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4295 port of the MQTT broker.
4296 This option enables the use of TLS.
4298 =item B<CertificateFile> I<file>
4300 Path to the PEM-encoded certificate file to use as client certificate when
4301 connecting to the MQTT broker.
4302 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4304 =item B<CertificateKeyFile> I<file>
4306 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4307 Only valid if B<CACert> and B<CertificateFile> are also set.
4309 =item B<TLSProtocol> I<protocol>
4311 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4312 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4313 version is used which depends on the version of OpenSSL the Mosquitto library
4315 Only valid if B<CACert> is set.
4317 =item B<CipherSuite> I<ciphersuite>
4319 A string describing the ciphers available for use. See L<ciphers(1)> and the
4320 C<openssl ciphers> utility for more information. If unset, the default ciphers
4322 Only valid if B<CACert> is set.
4326 =head2 Plugin C<mysql>
4328 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4329 one or more databases when started and keeps the connection up as long as
4330 possible. When the connection is interrupted for whatever reason it will try
4331 to re-connect. The plugin will complain loudly in case anything goes wrong.
4333 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4334 and collects information about MySQL network traffic, executed statements,
4335 requests, the query cache and threads by evaluating the
4336 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4337 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4338 Status Variables> for an explanation of these values.
4340 Optionally, master and slave statistics may be collected in a MySQL
4341 replication setup. In that case, information about the synchronization state
4342 of the nodes are collected by evaluating the C<Position> return value of the
4343 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4344 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4345 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4346 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4347 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4359 SSLKey "/path/to/key.pem"
4360 SSLCert "/path/to/cert.pem"
4361 SSLCA "/path/to/ca.pem"
4362 SSLCAPath "/path/to/cas/"
4363 SSLCipher "DHE-RSA-AES256-SHA"
4369 Socket "/var/run/mysql/mysqld.sock"
4371 SlaveNotifications true
4377 Socket "/var/run/mysql/mysqld.sock"
4382 A B<Database> block defines one connection to a MySQL database. It accepts a
4383 single argument which specifies the name of the database. None of the other
4384 options are required. MySQL will use default values as documented in the
4385 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4386 B<MySQL reference manual>.
4390 =item B<Alias> I<Alias>
4392 Alias to use as sender instead of hostname when reporting. This may be useful
4393 when having cryptic hostnames.
4395 =item B<Host> I<Hostname>
4397 Hostname of the database server. Defaults to B<localhost>.
4399 =item B<User> I<Username>
4401 Username to use when connecting to the database. The user does not have to be
4402 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4403 unless you want to collectd replication statistics (see B<MasterStats> and
4404 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4405 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4407 =item B<Password> I<Password>
4409 Password needed to log into the database.
4411 =item B<Database> I<Database>
4413 Select this database. Defaults to I<no database> which is a perfectly reasonable
4414 option for what this plugin does.
4416 =item B<Port> I<Port>
4418 TCP-port to connect to. The port must be specified in its numeric form, but it
4419 must be passed as a string nonetheless. For example:
4423 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4424 See the documentation for the C<mysql_real_connect> function for details.
4426 =item B<Socket> I<Socket>
4428 Specifies the path to the UNIX domain socket of the MySQL server. This option
4429 only has any effect, if B<Host> is set to B<localhost> (the default).
4430 Otherwise, use the B<Port> option above. See the documentation for the
4431 C<mysql_real_connect> function for details.
4433 =item B<InnodbStats> I<true|false>
4435 If enabled, metrics about the InnoDB storage engine are collected.
4436 Disabled by default.
4438 =item B<MasterStats> I<true|false>
4440 =item B<SlaveStats> I<true|false>
4442 Enable the collection of master / slave statistics in a replication setup. In
4443 order to be able to get access to these statistics, the user needs special
4444 privileges. See the B<User> documentation above. Defaults to B<false>.
4446 =item B<SlaveNotifications> I<true|false>
4448 If enabled, the plugin sends a notification if the replication slave I/O and /
4449 or SQL threads are not running. Defaults to B<false>.
4451 =item B<WsrepStats> I<true|false>
4453 Enable the collection of wsrep plugin statistics, used in Master-Master
4454 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4455 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4457 =item B<ConnectTimeout> I<Seconds>
4459 Sets the connect timeout for the MySQL client.
4461 =item B<SSLKey> I<Path>
4463 If provided, the X509 key in PEM format.
4465 =item B<SSLCert> I<Path>
4467 If provided, the X509 cert in PEM format.
4469 =item B<SSLCA> I<Path>
4471 If provided, the CA file in PEM format (check OpenSSL docs).
4473 =item B<SSLCAPath> I<Path>
4475 If provided, the CA directory (check OpenSSL docs).
4477 =item B<SSLCipher> I<String>
4479 If provided, the SSL cipher to use.
4483 =head2 Plugin C<netapp>
4485 The netapp plugin can collect various performance and capacity information
4486 from a NetApp filer using the NetApp API.
4488 Please note that NetApp has a wide line of products and a lot of different
4489 software versions for each of these products. This plugin was developed for a
4490 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4491 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4492 model and software version but it is very hard to test this.
4493 If you have used this plugin with other models and/or software version, feel
4494 free to send us a mail to tell us about the results, even if it's just a short
4497 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4498 basic authentication.
4500 B<Do not use a regular user for this!> Create a special collectd user with just
4501 the minimum of capabilities needed. The user only needs the "login-http-admin"
4502 capability as well as a few more depending on which data will be collected.
4503 Required capabilities are documented below.
4508 <Host "netapp1.example.com">
4532 IgnoreSelectedIO false
4534 IgnoreSelectedOps false
4535 GetLatency "volume0"
4536 IgnoreSelectedLatency false
4543 IgnoreSelectedCapacity false
4546 IgnoreSelectedSnapshot false
4574 The netapp plugin accepts the following configuration options:
4578 =item B<Host> I<Name>
4580 A host block defines one NetApp filer. It will appear in collectd with the name
4581 you specify here which does not have to be its real name nor its hostname (see
4582 the B<Address> option below).
4584 =item B<VFiler> I<Name>
4586 A B<VFiler> block may only be used inside a host block. It accepts all the
4587 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4588 will execute all NetApp API commands in the context of the specified
4589 VFiler(R). It will appear in collectd with the name you specify here which
4590 does not have to be its real name. The VFiler name may be specified using the
4591 B<VFilerName> option. If this is not specified, it will default to the name
4594 The VFiler block inherits all connection related settings from the surrounding
4595 B<Host> block (which appear before the B<VFiler> block) but they may be
4596 overwritten inside the B<VFiler> block.
4598 This feature is useful, for example, when using a VFiler as SnapVault target
4599 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4600 available in the host filer (vfiler0) but only in the respective VFiler
4603 =item B<Protocol> B<httpd>|B<http>
4605 The protocol collectd will use to query this host.
4613 Valid options: http, https
4615 =item B<Address> I<Address>
4617 The hostname or IP address of the host.
4623 Default: The "host" block's name.
4625 =item B<Port> I<Port>
4627 The TCP port to connect to on the host.
4633 Default: 80 for protocol "http", 443 for protocol "https"
4635 =item B<User> I<User>
4637 =item B<Password> I<Password>
4639 The username and password to use to login to the NetApp.
4645 =item B<VFilerName> I<Name>
4647 The name of the VFiler in which context to execute API commands. If not
4648 specified, the name provided to the B<VFiler> block will be used instead.
4654 Default: name of the B<VFiler> block
4656 B<Note:> This option may only be used inside B<VFiler> blocks.
4658 =item B<Interval> I<Interval>
4664 The following options decide what kind of data will be collected. You can
4665 either use them as a block and fine tune various parameters inside this block,
4666 use them as a single statement to just accept all default values, or omit it to
4667 not collect any data.
4669 The following options are valid inside all blocks:
4673 =item B<Interval> I<Seconds>
4675 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4676 host specific setting.
4680 =head3 The System block
4682 This will collect various performance data about the whole system.
4684 B<Note:> To get this data the collectd user needs the
4685 "api-perf-object-get-instances" capability.
4689 =item B<Interval> I<Seconds>
4691 Collect disk statistics every I<Seconds> seconds.
4693 =item B<GetCPULoad> B<true>|B<false>
4695 If you set this option to true the current CPU usage will be read. This will be
4696 the average usage between all CPUs in your NetApp without any information about
4699 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4700 returns in the "CPU" field.
4708 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4710 =item B<GetInterfaces> B<true>|B<false>
4712 If you set this option to true the current traffic of the network interfaces
4713 will be read. This will be the total traffic over all interfaces of your NetApp
4714 without any information about individual interfaces.
4716 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4717 in the "Net kB/s" field.
4727 Result: One value list of type "if_octects".
4729 =item B<GetDiskIO> B<true>|B<false>
4731 If you set this option to true the current IO throughput will be read. This
4732 will be the total IO of your NetApp without any information about individual
4733 disks, volumes or aggregates.
4735 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4736 in the "DiskE<nbsp>kB/s" field.
4744 Result: One value list of type "disk_octets".
4746 =item B<GetDiskOps> B<true>|B<false>
4748 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4749 iSCSI, etc. operations will be read. This will be the total number of
4750 operations on your NetApp without any information about individual volumes or
4753 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4754 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4762 Result: A variable number of value lists of type "disk_ops_complex". Each type
4763 of operation will result in one value list with the name of the operation as
4768 =head3 The WAFL block
4770 This will collect various performance data about the WAFL file system. At the
4771 moment this just means cache performance.
4773 B<Note:> To get this data the collectd user needs the
4774 "api-perf-object-get-instances" capability.
4776 B<Note:> The interface to get these values is classified as "Diagnostics" by
4777 NetApp. This means that it is not guaranteed to be stable even between minor
4782 =item B<Interval> I<Seconds>
4784 Collect disk statistics every I<Seconds> seconds.
4786 =item B<GetNameCache> B<true>|B<false>
4794 Result: One value list of type "cache_ratio" and type instance
4797 =item B<GetDirCache> B<true>|B<false>
4805 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4807 =item B<GetInodeCache> B<true>|B<false>
4815 Result: One value list of type "cache_ratio" and type instance
4818 =item B<GetBufferCache> B<true>|B<false>
4820 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4821 in the "Cache hit" field.
4829 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4833 =head3 The Disks block
4835 This will collect performance data about the individual disks in the NetApp.
4837 B<Note:> To get this data the collectd user needs the
4838 "api-perf-object-get-instances" capability.
4842 =item B<Interval> I<Seconds>
4844 Collect disk statistics every I<Seconds> seconds.
4846 =item B<GetBusy> B<true>|B<false>
4848 If you set this option to true the busy time of all disks will be calculated
4849 and the value of the busiest disk in the system will be written.
4851 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4852 in the "Disk util" field. Probably.
4860 Result: One value list of type "percent" and type instance "disk_busy".
4864 =head3 The VolumePerf block
4866 This will collect various performance data about the individual volumes.
4868 You can select which data to collect about which volume using the following
4869 options. They follow the standard ignorelist semantic.
4871 B<Note:> To get this data the collectd user needs the
4872 I<api-perf-object-get-instances> capability.
4876 =item B<Interval> I<Seconds>
4878 Collect volume performance data every I<Seconds> seconds.
4880 =item B<GetIO> I<Volume>
4882 =item B<GetOps> I<Volume>
4884 =item B<GetLatency> I<Volume>
4886 Select the given volume for IO, operations or latency statistics collection.
4887 The argument is the name of the volume without the C</vol/> prefix.
4889 Since the standard ignorelist functionality is used here, you can use a string
4890 starting and ending with a slash to specify regular expression matching: To
4891 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4894 GetIO "/^vol[027]$/"
4896 If no regular expression is specified, an exact match is required. Both,
4897 regular and exact matching are case sensitive.
4899 If no volume was specified at all for either of the three options, that data
4900 will be collected for all available volumes.
4902 See F</"IGNORELISTS"> for details.
4904 =item B<IgnoreSelectedIO> B<true>|B<false>
4906 =item B<IgnoreSelectedOps> B<true>|B<false>
4908 =item B<IgnoreSelectedLatency> B<true>|B<false>
4910 When set to B<true>, the volumes selected for IO, operations or latency
4911 statistics collection will be ignored and the data will be collected for all
4914 When set to B<false>, data will only be collected for the specified volumes and
4915 all other volumes will be ignored.
4917 If no volumes have been specified with the above B<Get*> options, all volumes
4918 will be collected regardless of the B<IgnoreSelected*> option.
4920 Defaults to B<false>
4924 =head3 The VolumeUsage block
4926 This will collect capacity data about the individual volumes.
4928 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4933 =item B<Interval> I<Seconds>
4935 Collect volume usage statistics every I<Seconds> seconds.
4937 =item B<GetCapacity> I<VolumeName>
4939 The current capacity of the volume will be collected. This will result in two
4940 to four value lists, depending on the configuration of the volume. All data
4941 sources are of type "df_complex" with the name of the volume as
4944 There will be type_instances "used" and "free" for the number of used and
4945 available bytes on the volume. If the volume has some space reserved for
4946 snapshots, a type_instance "snap_reserved" will be available. If the volume
4947 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4948 number of bytes saved by the SIS feature.
4950 B<Note:> The current NetApp API has a bug that results in this value being
4951 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4952 number which works most of the time. If you see strange values here, bug
4953 NetApp support to fix this.
4955 Repeat this option to specify multiple volumes.
4957 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4959 Specify whether to collect only the volumes selected by the B<GetCapacity>
4960 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4961 B<false>. However, if no B<GetCapacity> option is specified at all, all
4962 capacities will be selected anyway.
4964 =item B<GetSnapshot> I<VolumeName>
4966 Select volumes from which to collect snapshot information.
4968 Usually, the space used for snapshots is included in the space reported as
4969 "used". If snapshot information is collected as well, the space used for
4970 snapshots is subtracted from the used space.
4972 To make things even more interesting, it is possible to reserve space to be
4973 used for snapshots. If the space required for snapshots is less than that
4974 reserved space, there is "reserved free" and "reserved used" space in addition
4975 to "free" and "used". If the space required for snapshots exceeds the reserved
4976 space, that part allocated in the normal space is subtracted from the "used"
4979 Repeat this option to specify multiple volumes.
4981 =item B<IgnoreSelectedSnapshot>
4983 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4984 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4985 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4986 capacities will be selected anyway.
4990 =head3 The Quota block
4992 This will collect (tree) quota statistics (used disk space and number of used
4993 files). This mechanism is useful to get usage information for single qtrees.
4994 In case the quotas are not used for any other purpose, an entry similar to the
4995 following in C</etc/quotas> would be sufficient:
4997 /vol/volA/some_qtree tree - - - - -
4999 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5003 =item B<Interval> I<Seconds>
5005 Collect SnapVault(R) statistics every I<Seconds> seconds.
5009 =head3 The SnapVault block
5011 This will collect statistics about the time and traffic of SnapVault(R)
5016 =item B<Interval> I<Seconds>
5018 Collect SnapVault(R) statistics every I<Seconds> seconds.
5022 =head2 Plugin C<netlink>
5024 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5025 statistics of various interface and routing aspects.
5029 =item B<Interface> I<Interface>
5031 =item B<VerboseInterface> I<Interface>
5033 Instruct the plugin to collect interface statistics. This is basically the same
5034 as the statistics provided by the C<interface> plugin (see above) but
5035 potentially much more detailed.
5037 When configuring with B<Interface> only the basic statistics will be collected,
5038 namely octets, packets, and errors. These statistics are collected by
5039 the C<interface> plugin, too, so using both at the same time is no benefit.
5041 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5042 so that no data needs to be collected twice if you use the C<interface> plugin.
5043 This includes dropped packets, received multicast packets, collisions and a
5044 whole zoo of differentiated RX and TX errors. You can try the following command
5045 to get an idea of what awaits you:
5049 If I<Interface> is B<All>, all interfaces will be selected.
5051 =item B<QDisc> I<Interface> [I<QDisc>]
5053 =item B<Class> I<Interface> [I<Class>]
5055 =item B<Filter> I<Interface> [I<Filter>]
5057 Collect the octets and packets that pass a certain qdisc, class or filter.
5059 QDiscs and classes are identified by their type and handle (or classid).
5060 Filters don't necessarily have a handle, therefore the parent's handle is used.
5061 The notation used in collectd differs from that used in tc(1) in that it
5062 doesn't skip the major or minor number if it's zero and doesn't print special
5063 ids by their name. So, for example, a qdisc may be identified by
5064 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5065 thus not displayed by tc(1).
5067 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5068 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5069 associated with that interface will be collected.
5071 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5072 used. This may lead to problems when more than one filter is attached to a
5073 qdisc or class. This isn't nice, but we don't know how this could be done any
5074 better. If you have a idea, please don't hesitate to tell us.
5076 As with the B<Interface> option you can specify B<All> as the interface,
5077 meaning all interfaces.
5079 Here are some examples to help you understand the above text more easily:
5082 VerboseInterface "All"
5083 QDisc "eth0" "pfifo_fast-1:0"
5085 Class "ppp0" "htb-1:10"
5086 Filter "ppp0" "u32-1:0"
5089 See F</"IGNORELISTS"> for details.
5091 =item B<IgnoreSelected>
5093 The behavior is the same as with all other similar plugins: If nothing is
5094 selected at all, everything is collected. If some things are selected using the
5095 options described above, only these statistics are collected. If you set
5096 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5097 specified statistics will not be collected.
5101 =head2 Plugin C<network>
5103 The Network plugin sends data to a remote instance of collectd, receives data
5104 from a remote instance, or both at the same time. Data which has been received
5105 from the network is usually not transmitted again, but this can be activated, see
5106 the B<Forward> option below.
5108 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5109 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5111 Both, B<Server> and B<Listen> can be used as single option or as block. When
5112 used as block, given options are valid for this socket only. The following
5113 example will export the metrics twice: Once to an "internal" server (without
5114 encryption and signing) and one to an external server (with cryptographic
5118 # Export to an internal server
5119 # (demonstrates usage without additional options)
5120 Server "collectd.internal.tld"
5122 # Export to an external server
5123 # (demonstrates usage with signature options)
5124 <Server "collectd.external.tld">
5125 SecurityLevel "sign"
5126 Username "myhostname"
5133 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5135 The B<Server> statement/block sets the server to send datagrams to. The
5136 statement may occur multiple times to send each datagram to multiple
5139 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5140 optional second argument specifies a port number or a service name. If not
5141 given, the default, B<25826>, is used.
5143 The following options are recognized within B<Server> blocks:
5147 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5149 Set the security you require for network communication. When the security level
5150 has been set to B<Encrypt>, data sent over the network will be encrypted using
5151 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5152 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5153 authentication code. When set to B<None>, data is sent without any security.
5155 This feature is only available if the I<network> plugin was linked with
5158 =item B<Username> I<Username>
5160 Sets the username to transmit. This is used by the server to lookup the
5161 password. See B<AuthFile> below. All security levels except B<None> require
5164 This feature is only available if the I<network> plugin was linked with
5167 =item B<Password> I<Password>
5169 Sets a password (shared secret) for this socket. All security levels except
5170 B<None> require this setting.
5172 This feature is only available if the I<network> plugin was linked with
5175 =item B<Interface> I<Interface name>
5177 Set the outgoing interface for IP packets. This applies at least
5178 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5179 undefined or a non-existent interface name is specified, the default
5180 behavior is to let the kernel choose the appropriate interface. Be warned
5181 that the manual selection of an interface for unicast traffic is only
5182 necessary in rare cases.
5184 =item B<ResolveInterval> I<Seconds>
5186 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5187 useful to force a regular DNS lookup to support a high availability setup. If
5188 not specified, re-resolves are never attempted.
5192 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5194 The B<Listen> statement sets the interfaces to bind to. When multiple
5195 statements are found the daemon will bind to multiple interfaces.
5197 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5198 the argument is a multicast address the daemon will join that multicast group.
5199 The optional second argument specifies a port number or a service name. If not
5200 given, the default, B<25826>, is used.
5202 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5206 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5208 Set the security you require for network communication. When the security level
5209 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5210 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5211 signed and encrypted data is accepted. When set to B<None>, all data will be
5212 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5213 decrypted if possible.
5215 This feature is only available if the I<network> plugin was linked with
5218 =item B<AuthFile> I<Filename>
5220 Sets a file in which usernames are mapped to passwords. These passwords are
5221 used to verify signatures and to decrypt encrypted network packets. If
5222 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5223 verified and encrypted packets are decrypted. Otherwise, signed data is
5224 accepted without checking the signature and encrypted data cannot be decrypted.
5225 For the other security levels this option is mandatory.
5227 The file format is very simple: Each line consists of a username followed by a
5228 colon and any number of spaces followed by the password. To demonstrate, an
5229 example file could look like this:
5234 Each time a packet is received, the modification time of the file is checked
5235 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5236 the file is being read, it is locked using L<fcntl(2)>.
5238 =item B<Interface> I<Interface name>
5240 Set the incoming interface for IP packets explicitly. This applies at least
5241 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5242 undefined or a non-existent interface name is specified, the default
5243 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5244 traffic gets only accepted, if it arrives on the given interface.
5248 =item B<TimeToLive> I<1-255>
5250 Set the time-to-live of sent packets. This applies to all, unicast and
5251 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5252 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5255 =item B<MaxPacketSize> I<1024-65535>
5257 Set the maximum size for datagrams received over the network. Packets larger
5258 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5259 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5262 On the server side, this limit should be set to the largest value used on
5263 I<any> client. Likewise, the value on the client must not be larger than the
5264 value on the server, or data will be lost.
5266 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5267 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5268 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5271 =item B<Forward> I<true|false>
5273 If set to I<true>, write packets that were received via the network plugin to
5274 the sending sockets. This should only be activated when the B<Listen>- and
5275 B<Server>-statements differ. Otherwise packets may be send multiple times to
5276 the same multicast group. While this results in more network traffic than
5277 necessary it's not a huge problem since the plugin has a duplicate detection,
5278 so the values will not loop.
5280 =item B<ReportStats> B<true>|B<false>
5282 The network plugin cannot only receive and send statistics, it can also create
5283 statistics about itself. Collectd data included the number of received and
5284 sent octets and packets, the length of the receive queue and the number of
5285 values handled. When set to B<true>, the I<Network plugin> will make these
5286 statistics available. Defaults to B<false>.
5290 =head2 Plugin C<nfs>
5292 The I<nfs plugin> collects information about the usage of the Network File
5293 System (NFS). It counts the number of procedure calls for each procedure,
5294 grouped by version and whether the system runs as server or client.
5296 It is possibly to omit metrics for a specific NFS version by setting one or
5297 more of the following options to B<false> (all of them default to B<true>).
5301 =item B<ReportV2> B<true>|B<false>
5303 =item B<ReportV3> B<true>|B<false>
5305 =item B<ReportV4> B<true>|B<false>
5309 =head2 Plugin C<nginx>
5311 This plugin collects the number of connections and requests handled by the
5312 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5313 queries the page provided by the C<ngx_http_stub_status_module> module, which
5314 isn't compiled by default. Please refer to
5315 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5316 how to compile and configure nginx and this module.
5318 The following options are accepted by the C<nginx plugin>:
5322 =item B<URL> I<http://host/nginx_status>
5324 Sets the URL of the C<ngx_http_stub_status_module> output.
5326 =item B<User> I<Username>
5328 Optional user name needed for authentication.
5330 =item B<Password> I<Password>
5332 Optional password needed for authentication.
5334 =item B<VerifyPeer> B<true|false>
5336 Enable or disable peer SSL certificate verification. See
5337 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5339 =item B<VerifyHost> B<true|false>
5341 Enable or disable peer host name verification. If enabled, the plugin checks
5342 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5343 certificate matches the host name provided by the B<URL> option. If this
5344 identity check fails, the connection is aborted. Obviously, only works when
5345 connecting to a SSL enabled server. Enabled by default.
5347 =item B<CACert> I<File>
5349 File that holds one or more SSL certificates. If you want to use HTTPS you will
5350 possibly need this option. What CA certificates come bundled with C<libcurl>
5351 and are checked by default depends on the distribution you use.
5353 =item B<Timeout> I<Milliseconds>
5355 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5356 milliseconds. By default, the configured B<Interval> is used to set the
5361 =head2 Plugin C<notify_desktop>
5363 This plugin sends a desktop notification to a notification daemon, as defined
5364 in the Desktop Notification Specification. To actually display the
5365 notifications, B<notification-daemon> is required and B<collectd> has to be
5366 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5367 environment variables have to be set correctly) and the D-Bus message bus.
5369 The Desktop Notification Specification can be found at
5370 L<http://www.galago-project.org/specs/notification/>.
5374 =item B<OkayTimeout> I<timeout>
5376 =item B<WarningTimeout> I<timeout>
5378 =item B<FailureTimeout> I<timeout>
5380 Set the I<timeout>, in milliseconds, after which to expire the notification
5381 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5382 been specified, the displayed notification will not be closed at all - the
5383 user has to do so herself. These options default to 5000. If a negative number
5384 has been specified, the default is used as well.
5388 =head2 Plugin C<notify_email>
5390 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5391 configured email address.
5393 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5395 Available configuration options:
5399 =item B<From> I<Address>
5401 Email address from which the emails should appear to come from.
5403 Default: C<root@localhost>
5405 =item B<Recipient> I<Address>
5407 Configures the email address(es) to which the notifications should be mailed.
5408 May be repeated to send notifications to multiple addresses.
5410 At least one B<Recipient> must be present for the plugin to work correctly.
5412 =item B<SMTPServer> I<Hostname>
5414 Hostname of the SMTP server to connect to.
5416 Default: C<localhost>
5418 =item B<SMTPPort> I<Port>
5420 TCP port to connect to.
5424 =item B<SMTPUser> I<Username>
5426 Username for ASMTP authentication. Optional.
5428 =item B<SMTPPassword> I<Password>
5430 Password for ASMTP authentication. Optional.
5432 =item B<Subject> I<Subject>
5434 Subject-template to use when sending emails. There must be exactly two
5435 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5436 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5439 Default: C<Collectd notify: %s@%s>
5443 =head2 Plugin C<notify_nagios>
5445 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5446 a I<passive service check result>.
5448 Available configuration options:
5452 =item B<CommandFile> I<Path>
5454 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5458 =head2 Plugin C<ntpd>
5460 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5463 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5464 the wire - using B<mode 7> specific requests. This mode is deprecated with
5465 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5466 correctly with them, the ntp daemon must be explicitly configured to
5467 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5468 manual page for details.
5470 Available configuration options for the C<ntpd> plugin:
5474 =item B<Host> I<Hostname>
5476 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5478 =item B<Port> I<Port>
5480 UDP-Port to connect to. Defaults to B<123>.
5482 =item B<ReverseLookups> B<true>|B<false>
5484 Sets whether or not to perform reverse lookups on peers. Since the name or
5485 IP-address may be used in a filename it is recommended to disable reverse
5486 lookups. The default is to do reverse lookups to preserve backwards
5487 compatibility, though.
5489 =item B<IncludeUnitID> B<true>|B<false>
5491 When a peer is a refclock, include the unit ID in the I<type instance>.
5492 Defaults to B<false> for backward compatibility.
5494 If two refclock peers use the same driver and this is B<false>, the plugin will
5495 try to write simultaneous measurements from both to the same type instance.
5496 This will result in error messages in the log and only one set of measurements
5501 =head2 Plugin C<nut>
5505 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5507 Add a UPS to collect data from. The format is identical to the one accepted by
5510 =item B<ForceSSL> B<true>|B<false>
5512 Stops connections from falling back to unsecured if an SSL connection
5513 cannot be established. Defaults to false if undeclared.
5515 =item B<VerifyPeer> I<true>|I<false>
5517 If set to true, requires a CAPath be provided. Will use the CAPath to find
5518 certificates to use as Trusted Certificates to validate a upsd server certificate.
5519 If validation of the upsd server certificate fails, the connection will not be
5520 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5521 will override and set ForceSSL to true.
5523 =item B<CAPath> I/path/to/certs/folder
5525 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5526 The folder pointed at must contain certificate(s) named according to their hash.
5527 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5528 occur because two different certs have the same hash value, Y can be incremented
5529 in order to avoid conflict. To create a symbolic link to a certificate the following
5530 command can be used from within the directory where the cert resides:
5532 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5534 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5535 generate links like the one described above for ALL certs in a given folder.
5537 C<c_rehash /path/to/certs/folder>
5539 =item B<ConnectTimeout> I<Milliseconds>
5541 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5542 By default, the configured B<Interval> is used to set the timeout.
5546 =head2 Plugin C<olsrd>
5548 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5549 the Optimized Link State Routing daemon and reads information about the current
5550 state of the meshed network.
5552 The following configuration options are understood:
5556 =item B<Host> I<Host>
5558 Connect to I<Host>. Defaults to B<"localhost">.
5560 =item B<Port> I<Port>
5562 Specifies the port to connect to. This must be a string, even if you give the
5563 port as a number rather than a service name. Defaults to B<"2006">.
5565 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5567 Specifies what information to collect about links, i.E<nbsp>e. direct
5568 connections of the daemon queried. If set to B<No>, no information is
5569 collected. If set to B<Summary>, the number of links and the average of all
5570 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5571 If set to B<Detail> LQ and NLQ are collected per link.
5573 Defaults to B<Detail>.
5575 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5577 Specifies what information to collect about routes of the daemon queried. If
5578 set to B<No>, no information is collected. If set to B<Summary>, the number of
5579 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5580 metric and ETX are collected per route.
5582 Defaults to B<Summary>.
5584 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5586 Specifies what information to collect about the global topology. If set to
5587 B<No>, no information is collected. If set to B<Summary>, the number of links
5588 in the entire topology and the average I<link quality> (LQ) is calculated.
5589 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5591 Defaults to B<Summary>.
5595 =head2 Plugin C<onewire>
5597 B<EXPERIMENTAL!> See notes below.
5599 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5600 L<http://owfs.org/> to read sensors connected via the onewire bus.
5602 It can be used in two possible modes - standard or advanced.
5604 In the standard mode only temperature sensors (sensors with the family code
5605 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5606 other sensors you would like to have included, please send a sort request to
5607 the mailing list. You can select sensors to be read or to be ignored depending
5608 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5609 walked and all sensors are read.
5611 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5612 experimental, below.
5614 In the advanced mode you can configure any sensor to be read (only numerical
5615 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5616 In this mode you have to list all the sensors. Neither default bus walk nor
5617 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5618 the path automatically and should produce compatible structure with the "standard"
5619 mode (basically the path is expected as for example
5620 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5621 "F10FCA000800" and the rest after the slash is considered the type - here
5623 There are two advantages to this mode - you can access virtually any sensor
5624 (not just temperature), select whether to use cached or directly read values
5625 and it is slighlty faster. The downside is more complex configuration.
5627 The two modes are distinguished automatically by the format of the address.
5628 It is not possible to mix the two modes. Once a full path is detected in any
5629 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5630 (and as standard addresses will fail parsing they will be ignored).
5634 =item B<Device> I<Device>
5636 Sets the device to read the values from. This can either be a "real" hardware
5637 device, such as a serial port or an USB port, or the address of the
5638 L<owserver(1)> socket, usually B<localhost:4304>.
5640 Though the documentation claims to automatically recognize the given address
5641 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5642 with that version, the following configuration worked for us:
5645 Device "-s localhost:4304"
5648 This directive is B<required> and does not have a default value.
5650 =item B<Sensor> I<Sensor>
5652 In the standard mode selects sensors to collect or to ignore
5653 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5654 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5655 and B<not> include the leading C<10.> family byte and point.
5656 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5657 sensors (see above) are read.
5659 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5660 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5661 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5663 As there can be multiple devices on the bus you can list multiple sensor (use
5664 multiple B<Sensor> elements).
5666 See F</"IGNORELISTS"> for details.
5668 =item B<IgnoreSelected> I<true>|I<false>
5670 If no configuration is given, the B<onewire> plugin will collect data from all
5671 sensors found. This may not be practical, especially if sensors are added and
5672 removed regularly. Sometimes, however, it's easier/preferred to collect only
5673 specific sensors or all sensors I<except> a few specified ones. This option
5674 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5675 B<Sensor> is inverted: All selected interfaces are ignored and all other
5676 interfaces are collected.
5678 Used only in the standard mode - see above.
5680 =item B<Interval> I<Seconds>
5682 Sets the interval in which all sensors should be read. If not specified, the
5683 global B<Interval> setting is used.
5687 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5688 work with big setups. It works with one sensor being attached to one
5689 controller, but as soon as you throw in a couple more senors and maybe a hub
5690 or two, reading all values will take more than ten seconds (the default
5691 interval). We will probably add some separate thread for reading the sensors
5692 and some cache or something like that, but it's not done yet. We will try to
5693 maintain backwards compatibility in the future, but we can't promise. So in
5694 short: If it works for you: Great! But keep in mind that the config I<might>
5695 change, though this is unlikely. Oh, and if you want to help improving this
5696 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5698 =head2 Plugin C<openldap>
5700 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5701 server correctly. The backend database C<monitor> needs to be loaded and
5702 working. See slapd-monitor(5) for the details.
5704 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5705 blocks. Each block requires one string argument as the instance name. For
5710 URL "ldap://localhost/"
5713 URL "ldaps://localhost/"
5717 The instance name will be used as the I<plugin instance>. To emulate the old
5718 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5719 plugin to work correctly, each instance name must be unique. This is not
5720 enforced by the plugin and it is your responsibility to ensure it is.
5722 The following options are accepted within each B<Instance> block:
5726 =item B<URL> I<ldap://host/binddn>
5728 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5731 =item B<BindDN> I<BindDN>
5733 Name in the form of an LDAP distinguished name intended to be used for
5734 authentication. Defaults to empty string to establish an anonymous authorization.
5736 =item B<Password> I<Password>
5738 Password for simple bind authentication. If this option is not set,
5739 unauthenticated bind operation is used.
5741 =item B<StartTLS> B<true|false>
5743 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5744 Disabled by default.
5746 =item B<VerifyHost> B<true|false>
5748 Enables or disables peer host name verification. If enabled, the plugin checks
5749 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5750 certificate matches the host name provided by the B<URL> option. If this
5751 identity check fails, the connection is aborted. Enabled by default.
5753 =item B<CACert> I<File>
5755 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5756 may possibly need this option. What CA certificates are checked by default
5757 depends on the distribution you use and can be changed with the usual ldap
5758 client configuration mechanisms. See ldap.conf(5) for the details.
5760 =item B<Timeout> I<Seconds>
5762 Sets the timeout value for ldap operations, in seconds. By default, the
5763 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5766 =item B<Version> I<Version>
5768 An integer which sets the LDAP protocol version number to use when connecting
5769 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5773 =head2 Plugin C<openvpn>
5775 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5776 traffic statistics about connected clients.
5778 To set up OpenVPN to write to the status file periodically, use the
5779 B<--status> option of OpenVPN.
5781 So, in a nutshell you need:
5783 openvpn $OTHER_OPTIONS \
5784 --status "/var/run/openvpn-status" 10
5790 =item B<StatusFile> I<File>
5792 Specifies the location of the status file.
5794 =item B<ImprovedNamingSchema> B<true>|B<false>
5796 When enabled, the filename of the status file will be used as plugin instance
5797 and the client's "common name" will be used as type instance. This is required
5798 when reading multiple status files. Enabling this option is recommended, but to
5799 maintain backwards compatibility this option is disabled by default.
5801 =item B<CollectCompression> B<true>|B<false>
5803 Sets whether or not statistics about the compression used by OpenVPN should be
5804 collected. This information is only available in I<single> mode. Enabled by
5807 =item B<CollectIndividualUsers> B<true>|B<false>
5809 Sets whether or not traffic information is collected for each connected client
5810 individually. If set to false, currently no traffic data is collected at all
5811 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5813 =item B<CollectUserCount> B<true>|B<false>
5815 When enabled, the number of currently connected clients or users is collected.
5816 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5817 can be configured independently from that option. Defaults to B<false>.
5821 =head2 Plugin C<oracle>
5823 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5824 Oracle® Database and lets you execute SQL statements there. It is very similar
5825 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5826 plugin's documentation above for details.
5829 <Query "out_of_stock">
5830 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5833 # InstancePrefix "foo"
5834 InstancesFrom "category"
5838 <Database "product_information">
5843 Query "out_of_stock"
5847 =head3 B<Query> blocks
5849 The Query blocks are handled identically to the Query blocks of the "dbi"
5850 plugin. Please see its documentation above for details on how to specify
5853 =head3 B<Database> blocks
5855 Database blocks define a connection to a database and which queries should be
5856 sent to that database. Each database needs a "name" as string argument in the
5857 starting tag of the block. This name will be used as "PluginInstance" in the
5858 values submitted to the daemon. Other than that, that name is not used.
5862 =item B<Plugin> I<Plugin>
5864 Use I<Plugin> as the plugin name when submitting query results from
5865 this B<Database>. Defaults to C<oracle>.
5867 =item B<ConnectID> I<ID>
5869 Defines the "database alias" or "service name" to connect to. Usually, these
5870 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5872 =item B<Host> I<Host>
5874 Hostname to use when dispatching values for this database. Defaults to using
5875 the global hostname of the I<collectd> instance.
5877 =item B<Username> I<Username>
5879 Username used for authentication.
5881 =item B<Password> I<Password>
5883 Password used for authentication.
5885 =item B<Query> I<QueryName>
5887 Associates the query named I<QueryName> with this database connection. The
5888 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5889 blocks you want to refer to must be placed above the database block you want to
5894 =head2 Plugin C<ovs_events>
5896 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5897 connected interfaces, dispatches the values to collectd and sends the
5898 notification whenever the link state change occurs. This plugin uses OVS
5899 database to get a link state change notification.
5903 <Plugin "ovs_events">
5906 Socket "/var/run/openvswitch/db.sock"
5907 Interfaces "br0" "veth0"
5908 SendNotification true
5909 DispatchValues false
5912 The plugin provides the following configuration options:
5916 =item B<Address> I<node>
5918 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5919 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5920 option. See L<ovsdb-server(1)> for more details. The option may be either
5921 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5922 format. Defaults to C<localhost>.
5924 =item B<Port> I<service>
5926 TCP-port to connect to. Either a service name or a port number may be given.
5927 Defaults to B<6640>.
5929 =item B<Socket> I<path>
5931 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5932 plugin. To enable the interface, the OVS DB daemon should be running with
5933 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5934 option is set, B<Address> and B<Port> options are ignored.
5936 =item B<Interfaces> [I<ifname> ...]
5938 List of interface names to be monitored by this plugin. If this option is not
5939 specified or is empty then all OVS connected interfaces on all bridges are
5942 Default: empty (all interfaces on all bridges are monitored)
5944 =item B<SendNotification> I<true|false>
5946 If set to true, OVS link notifications (interface status and OVS DB connection
5947 terminate) are sent to collectd. Default value is true.
5949 =item B<DispatchValues> I<true|false>
5951 Dispatch the OVS DB interface link status value with configured plugin interval.
5952 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
5953 options are false, no OVS information will be provided by the plugin.
5957 B<Note:> By default, the global interval setting is used within which to
5958 retrieve the OVS link status. To configure a plugin-specific interval, please
5959 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
5960 simple divide the time by 1000 for example if the desired interval is 50ms, set
5963 =head2 Plugin C<ovs_stats>
5965 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
5966 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
5967 statistics from OVSDB
5971 <Plugin "ovs_stats">
5974 Socket "/var/run/openvswitch/db.sock"
5975 Bridges "br0" "br_ext"
5978 The plugin provides the following configuration options:
5982 =item B<Address> I<node>
5984 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5985 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5986 option. See L<ovsdb-server(1)> for more details. The option may be either
5987 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5988 format. Defaults to C<localhost>.
5990 =item B<Port> I<service>
5992 TCP-port to connect to. Either a service name or a port number may be given.
5993 Defaults to B<6640>.
5995 =item B<Socket> I<path>
5997 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5998 plugin. To enable the interface, the OVS DB daemon should be running with
5999 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6000 option is set, B<Address> and B<Port> options are ignored.
6002 =item B<Bridges> [I<brname> ...]
6004 List of OVS bridge names to be monitored by this plugin. If this option is
6005 omitted or is empty then all OVS bridges will be monitored.
6007 Default: empty (monitor all bridges)
6011 =head2 Plugin C<perl>
6013 This plugin embeds a Perl-interpreter into collectd and provides an interface
6014 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6016 =head2 Plugin C<pinba>
6018 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6019 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6020 PHP-based webpage has been delivered, the extension will send a UDP packet
6021 containing timing information, peak memory usage and so on. The plugin will
6022 wait for such packets, parse them and account the provided information, which
6023 is then dispatched to the daemon once per interval.
6030 # Overall statistics for the website.
6032 Server "www.example.com"
6034 # Statistics for www-a only
6036 Host "www-a.example.com"
6037 Server "www.example.com"
6039 # Statistics for www-b only
6041 Host "www-b.example.com"
6042 Server "www.example.com"
6046 The plugin provides the following configuration options:
6050 =item B<Address> I<Node>
6052 Configures the address used to open a listening socket. By default, plugin will
6053 bind to the I<any> address C<::0>.
6055 =item B<Port> I<Service>
6057 Configures the port (service) to bind to. By default the default Pinba port
6058 "30002" will be used. The option accepts service names in addition to port
6059 numbers and thus requires a I<string> argument.
6061 =item E<lt>B<View> I<Name>E<gt> block
6063 The packets sent by the Pinba extension include the hostname of the server, the
6064 server name (the name of the virtual host) and the script that was executed.
6065 Using B<View> blocks it is possible to separate the data into multiple groups
6066 to get more meaningful statistics. Each packet is added to all matching groups,
6067 so that a packet may be accounted for more than once.
6071 =item B<Host> I<Host>
6073 Matches the hostname of the system the webserver / script is running on. This
6074 will contain the result of the L<gethostname(2)> system call. If not
6075 configured, all hostnames will be accepted.
6077 =item B<Server> I<Server>
6079 Matches the name of the I<virtual host>, i.e. the contents of the
6080 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6081 server names will be accepted.
6083 =item B<Script> I<Script>
6085 Matches the name of the I<script name>, i.e. the contents of the
6086 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6087 script names will be accepted.
6093 =head2 Plugin C<ping>
6095 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6096 configured hosts periodically and measures the network latency. Whenever the
6097 C<read> function of the plugin is called, it submits the average latency, the
6098 standard deviation and the drop rate for each host.
6100 Available configuration options:
6104 =item B<Host> I<IP-address>
6106 Host to ping periodically. This option may be repeated several times to ping
6109 =item B<Interval> I<Seconds>
6111 Sets the interval in which to send ICMP echo packets to the configured hosts.
6112 This is B<not> the interval in which metrics are read from the plugin but the
6113 interval in which the hosts are "pinged". Therefore, the setting here should be
6114 smaller than or equal to the global B<Interval> setting. Fractional times, such
6115 as "1.24" are allowed.
6119 =item B<Timeout> I<Seconds>
6121 Time to wait for a response from the host to which an ICMP packet had been
6122 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6123 to be down or the packet to be dropped. This setting must be smaller than the
6124 B<Interval> setting above for the plugin to work correctly. Fractional
6125 arguments are accepted.
6129 =item B<TTL> I<0-255>
6131 Sets the Time-To-Live of generated ICMP packets.
6133 =item B<Size> I<size>
6135 Sets the size of the data payload in ICMP packet to specified I<size> (it
6136 will be filled with regular ASCII pattern). If not set, default 56 byte
6137 long string is used so that the packet size of an ICMPv4 packet is exactly
6138 64 bytes, similar to the behaviour of normal ping(1) command.
6140 =item B<SourceAddress> I<host>
6142 Sets the source address to use. I<host> may either be a numerical network
6143 address or a network hostname.
6145 =item B<Device> I<name>
6147 Sets the outgoing network device to be used. I<name> has to specify an
6148 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6151 =item B<MaxMissed> I<Packets>
6153 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6154 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6156 Default: B<-1> (disabled)
6160 =head2 Plugin C<postgresql>
6162 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6163 keeps a persistent connection to all configured databases and tries to
6164 reconnect if the connection has been interrupted. A database is configured by
6165 specifying a B<Database> block as described below. The default statistics are
6166 collected from PostgreSQL's B<statistics collector> which thus has to be
6167 enabled for this plugin to work correctly. This should usually be the case by
6168 default. See the section "The Statistics Collector" of the B<PostgreSQL
6169 Documentation> for details.
6171 By specifying custom database queries using a B<Query> block as described
6172 below, you may collect any data that is available from some PostgreSQL
6173 database. This way, you are able to access statistics of external daemons
6174 which are available in a PostgreSQL database or use future or special
6175 statistics provided by PostgreSQL without the need to upgrade your collectd
6178 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6179 PostgreSQL databases as well. This has been implemented in a generic way. You
6180 need to specify an SQL statement which will then be executed by collectd in
6181 order to write the data (see below for details). The benefit of that approach
6182 is that there is no fixed database layout. Rather, the layout may be optimized
6183 for the current setup.
6185 The B<PostgreSQL Documentation> manual can be found at
6186 L<http://www.postgresql.org/docs/manuals/>.
6190 Statement "SELECT magic FROM wizard WHERE host = $1;"
6194 InstancePrefix "magic"
6199 <Query rt36_tickets>
6200 Statement "SELECT COUNT(type) AS count, type \
6202 WHEN resolved = 'epoch' THEN 'open' \
6203 ELSE 'resolved' END AS type \
6204 FROM tickets) type \
6208 InstancePrefix "rt36_tickets"
6209 InstancesFrom "type"
6215 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6226 KRBSrvName "kerberos_service_name"
6232 Service "service_name"
6233 Query backend # predefined
6244 The B<Query> block defines one database query which may later be used by a
6245 database definition. It accepts a single mandatory argument which specifies
6246 the name of the query. The names of all queries have to be unique (see the
6247 B<MinVersion> and B<MaxVersion> options below for an exception to this
6250 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6251 B<Result> blocks may be used to extract multiple values from a single query.
6253 The following configuration options are available to define the query:
6257 =item B<Statement> I<sql query statement>
6259 Specify the I<sql query statement> which the plugin should execute. The string
6260 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6261 first, second, etc. parameter. The value of the parameters is specified by the
6262 B<Param> configuration option - see below for details. To include a literal
6263 B<$> character followed by a number, surround it with single quotes (B<'>).
6265 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6266 allowed. Note, however, that only a single command may be used. Semicolons are
6267 allowed as long as a single non-empty command has been specified only.
6269 The returned lines will be handled separately one after another.
6271 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6273 Specify the parameters which should be passed to the SQL query. The parameters
6274 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6275 they appear in the configuration file. The value of the parameter is
6276 determined depending on the value of the B<Param> option as follows:
6282 The configured hostname of the database connection. If a UNIX domain socket is
6283 used, the parameter expands to "localhost".
6287 The name of the database of the current connection.
6291 The name of the database plugin instance. See the B<Instance> option of the
6292 database specification below for details.
6296 The username used to connect to the database.
6300 The interval with which this database is queried (as specified by the database
6301 specific or global B<Interval> options).
6305 Please note that parameters are only supported by PostgreSQL's protocol
6306 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6308 =item B<PluginInstanceFrom> I<column>
6310 Specify how to create the "PluginInstance" for reporting this query results.
6311 Only one column is supported. You may concatenate fields and string values in
6312 the query statement to get the required results.
6314 =item B<MinVersion> I<version>
6316 =item B<MaxVersion> I<version>
6318 Specify the minimum or maximum version of PostgreSQL that this query should be
6319 used with. Some statistics might only be available with certain versions of
6320 PostgreSQL. This allows you to specify multiple queries with the same name but
6321 which apply to different versions, thus allowing you to use the same
6322 configuration in a heterogeneous environment.
6324 The I<version> has to be specified as the concatenation of the major, minor
6325 and patch-level versions, each represented as two-decimal-digit numbers. For
6326 example, version 8.2.3 will become 80203.
6330 The B<Result> block defines how to handle the values returned from the query.
6331 It defines which column holds which value and how to dispatch that value to
6336 =item B<Type> I<type>
6338 The I<type> name to be used when dispatching the values. The type describes
6339 how to handle the data and where to store it. See L<types.db(5)> for more
6340 details on types and their configuration. The number and type of values (as
6341 selected by the B<ValuesFrom> option) has to match the type of the given name.
6343 This option is mandatory.
6345 =item B<InstancePrefix> I<prefix>
6347 =item B<InstancesFrom> I<column0> [I<column1> ...]
6349 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6350 B<InstancePrefix> defines a static prefix that will be prepended to all type
6351 instances. B<InstancesFrom> defines the column names whose values will be used
6352 to create the type instance. Multiple values will be joined together using the
6353 hyphen (C<->) as separation character.
6355 The plugin itself does not check whether or not all built instances are
6356 different. It is your responsibility to assure that each is unique.
6358 Both options are optional. If none is specified, the type instance will be
6361 =item B<ValuesFrom> I<column0> [I<column1> ...]
6363 Names the columns whose content is used as the actual data for the data sets
6364 that are dispatched to the daemon. How many such columns you need is
6365 determined by the B<Type> setting as explained above. If you specify too many
6366 or not enough columns, the plugin will complain about that and no data will be
6367 submitted to the daemon.
6369 The actual data type, as seen by PostgreSQL, is not that important as long as
6370 it represents numbers. The plugin will automatically cast the values to the
6371 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6372 L<strtod(3)> functions, so anything supported by those functions is supported
6373 by the plugin as well.
6375 This option is required inside a B<Result> block and may be specified multiple
6376 times. If multiple B<ValuesFrom> options are specified, the columns are read
6381 The following predefined queries are available (the definitions can be found
6382 in the F<postgresql_default.conf> file which, by default, is available at
6383 C<I<prefix>/share/collectd/>):
6389 This query collects the number of backends, i.E<nbsp>e. the number of
6392 =item B<transactions>
6394 This query collects the numbers of committed and rolled-back transactions of
6399 This query collects the numbers of various table modifications (i.E<nbsp>e.
6400 insertions, updates, deletions) of the user tables.
6402 =item B<query_plans>
6404 This query collects the numbers of various table scans and returned tuples of
6407 =item B<table_states>
6409 This query collects the numbers of live and dead rows in the user tables.
6413 This query collects disk block access counts for user tables.
6417 This query collects the on-disk size of the database in bytes.
6421 In addition, the following detailed queries are available by default. Please
6422 note that each of those queries collects information B<by table>, thus,
6423 potentially producing B<a lot> of data. For details see the description of the
6424 non-by_table queries above.
6428 =item B<queries_by_table>
6430 =item B<query_plans_by_table>
6432 =item B<table_states_by_table>
6434 =item B<disk_io_by_table>
6438 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6439 mandatory argument specifying the name of the writer. This will then be used
6440 in the B<Database> specification in order to activate the writer instance. The
6441 names of all writers have to be unique. The following options may be
6446 =item B<Statement> I<sql statement>
6448 This mandatory option specifies the SQL statement that will be executed for
6449 each submitted value. A single SQL statement is allowed only. Anything after
6450 the first semicolon will be ignored.
6452 Nine parameters will be passed to the statement and should be specified as
6453 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6454 values are made available through those parameters:
6460 The timestamp of the queried value as an RFC 3339-formatted local time.
6464 The hostname of the queried value.
6468 The plugin name of the queried value.
6472 The plugin instance of the queried value. This value may be B<NULL> if there
6473 is no plugin instance.
6477 The type of the queried value (cf. L<types.db(5)>).
6481 The type instance of the queried value. This value may be B<NULL> if there is
6486 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6487 sources of the submitted value-list).
6491 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6492 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6493 B<StoreRates> is enabled (which is the default, see below), all types will be
6498 An array of the submitted values. The dimensions of the value name and value
6503 In general, it is advisable to create and call a custom function in the
6504 PostgreSQL database for this purpose. Any procedural language supported by
6505 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6508 =item B<StoreRates> B<false>|B<true>
6510 If set to B<true> (the default), convert counter values to rates. If set to
6511 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6516 The B<Database> block defines one PostgreSQL database for which to collect
6517 statistics. It accepts a single mandatory argument which specifies the
6518 database name. None of the other options are required. PostgreSQL will use
6519 default values as documented in the section "CONNECTING TO A DATABASE" in the
6520 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6521 the user collectd is run as and special environment variables. See the manpage
6526 =item B<Interval> I<seconds>
6528 Specify the interval with which the database should be queried. The default is
6529 to use the global B<Interval> setting.
6531 =item B<CommitInterval> I<seconds>
6533 This option may be used for database connections which have "writers" assigned
6534 (see above). If specified, it causes a writer to put several updates into a
6535 single transaction. This transaction will last for the specified amount of
6536 time. By default, each update will be executed in a separate transaction. Each
6537 transaction generates a fair amount of overhead which can, thus, be reduced by
6538 activating this option. The draw-back is, that data covering the specified
6539 amount of time will be lost, for example, if a single statement within the
6540 transaction fails or if the database server crashes.
6542 =item B<Plugin> I<Plugin>
6544 Use I<Plugin> as the plugin name when submitting query results from
6545 this B<Database>. Defaults to C<postgresql>.
6547 =item B<Instance> I<name>
6549 Specify the plugin instance name that should be used instead of the database
6550 name (which is the default, if this option has not been specified). This
6551 allows one to query multiple databases of the same name on the same host (e.g.
6552 when running multiple database server versions in parallel).
6553 The plugin instance name can also be set from the query result using
6554 the B<PluginInstanceFrom> option in B<Query> block.
6556 =item B<Host> I<hostname>
6558 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6559 value begins with a slash, it is interpreted as the directory name in which to
6560 look for the UNIX domain socket.
6562 This option is also used to determine the hostname that is associated with a
6563 collected data set. If it has been omitted or either begins with with a slash
6564 or equals B<localhost> it will be replaced with the global hostname definition
6565 of collectd. Any other value will be passed literally to collectd when
6566 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6568 =item B<Port> I<port>
6570 Specify the TCP port or the local UNIX domain socket file extension of the
6573 =item B<User> I<username>
6575 Specify the username to be used when connecting to the server.
6577 =item B<Password> I<password>
6579 Specify the password to be used when connecting to the server.
6581 =item B<ExpireDelay> I<delay>
6583 Skip expired values in query output.
6585 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6587 Specify whether to use an SSL connection when contacting the server. The
6588 following modes are supported:
6594 Do not use SSL at all.
6598 First, try to connect without using SSL. If that fails, try using SSL.
6600 =item I<prefer> (default)
6602 First, try to connect using SSL. If that fails, try without using SSL.
6610 =item B<Instance> I<name>
6612 Specify the plugin instance name that should be used instead of the database
6613 name (which is the default, if this option has not been specified). This
6614 allows one to query multiple databases of the same name on the same host (e.g.
6615 when running multiple database server versions in parallel).
6617 =item B<KRBSrvName> I<kerberos_service_name>
6619 Specify the Kerberos service name to use when authenticating with Kerberos 5
6620 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6621 B<PostgreSQL Documentation> for details.
6623 =item B<Service> I<service_name>
6625 Specify the PostgreSQL service name to use for additional parameters. That
6626 service has to be defined in F<pg_service.conf> and holds additional
6627 connection parameters. See the section "The Connection Service File" in the
6628 B<PostgreSQL Documentation> for details.
6630 =item B<Query> I<query>
6632 Specifies a I<query> which should be executed in the context of the database
6633 connection. This may be any of the predefined or user-defined queries. If no
6634 such option is given, it defaults to "backends", "transactions", "queries",
6635 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6636 has been specified). Else, the specified queries are used only.
6638 =item B<Writer> I<writer>
6640 Assigns the specified I<writer> backend to the database connection. This
6641 causes all collected data to be send to the database using the settings
6642 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6643 below for details on how to selectively send data to certain plugins).
6645 Each writer will register a flush callback which may be used when having long
6646 transactions enabled (see the B<CommitInterval> option above). When issuing
6647 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6648 transaction will be committed right away. Two different kinds of flush
6649 callbacks are available with the C<postgresql> plugin:
6655 Flush all writer backends.
6657 =item B<postgresql->I<database>
6659 Flush all writers of the specified I<database> only.
6665 =head2 Plugin C<powerdns>
6667 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6668 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6669 values, many of which are probably meaningless to most users, but may be useful
6670 for some. So you may chose which values to collect, but if you don't, some
6671 reasonable defaults will be collected.
6674 <Server "server_name">
6676 Collect "udp-answers" "udp-queries"
6677 Socket "/var/run/pdns.controlsocket"
6679 <Recursor "recursor_name">
6681 Collect "cache-hits" "cache-misses"
6682 Socket "/var/run/pdns_recursor.controlsocket"
6684 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6689 =item B<Server> and B<Recursor> block
6691 The B<Server> block defines one authoritative server to query, the B<Recursor>
6692 does the same for an recursing server. The possible options in both blocks are
6693 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6698 =item B<Collect> I<Field>
6700 Using the B<Collect> statement you can select which values to collect. Here,
6701 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6702 C<dlg-only-drops>, C<answers10-100>.
6704 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6705 When querying the server a C<SHOW *> command is issued in any case, because
6706 that's the only way of getting multiple values out of the server at once.
6707 collectd then picks out the values you have selected. When querying the
6708 recursor, a command is generated to query exactly these values. So if you
6709 specify invalid fields when querying the recursor, a syntax error may be
6710 returned by the daemon and collectd may not collect any values at all.
6712 If no B<Collect> statement is given, the following B<Server> values will be
6719 =item packetcache-hit
6721 =item packetcache-miss
6723 =item packetcache-size
6725 =item query-cache-hit
6727 =item query-cache-miss
6729 =item recursing-answers
6731 =item recursing-questions
6743 The following B<Recursor> values will be collected by default:
6747 =item noerror-answers
6749 =item nxdomain-answers
6751 =item servfail-answers
6769 Please note that up to that point collectd doesn't know what values are
6770 available on the server and values that are added do not need a change of the
6771 mechanism so far. However, the values must be mapped to collectd's naming
6772 scheme, which is done using a lookup table that lists all known values. If
6773 values are added in the future and collectd does not know about them, you will
6774 get an error much like this:
6776 powerdns plugin: submit: Not found in lookup table: foobar = 42
6778 In this case please file a bug report with the collectd team.
6780 =item B<Socket> I<Path>
6782 Configures the path to the UNIX domain socket to be used when connecting to the
6783 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6784 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6785 will be used for the recursor.
6789 =item B<LocalSocket> I<Path>
6791 Querying the recursor is done using UDP. When using UDP over UNIX domain
6792 sockets, the client socket needs a name in the file system, too. You can set
6793 this local name to I<Path> using the B<LocalSocket> option. The default is
6794 C<I<prefix>/var/run/collectd-powerdns>.
6798 =head2 Plugin C<processes>
6802 =item B<Process> I<Name>
6804 Select more detailed statistics of processes matching this name. The statistics
6805 collected for these selected processes are:
6806 - size of the resident segment size (RSS)
6807 - user- and system-time used
6808 - number of processes
6810 - number of open files (under Linux)
6811 - number of memory mapped files (under Linux)
6812 - io data (where available)
6813 - context switches (under Linux)
6814 - minor and major pagefaults.
6816 Some platforms have a limit on the length of process names. I<Name> must stay
6819 =item B<ProcessMatch> I<name> I<regex>
6821 Similar to the B<Process> option this allows one to select more detailed
6822 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6823 details). The statistics of all matching processes are summed up and
6824 dispatched to the daemon using the specified I<name> as an identifier. This
6825 allows one to "group" several processes together. I<name> must not contain
6828 =item B<CollectContextSwitch> I<Boolean>
6830 Collect context switch of the process.
6832 =item B<CollectMemoryMaps> I<Boolean>
6834 Collect the number of memory mapped files of the process.
6835 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
6840 =head2 Plugin C<protocols>
6842 Collects a lot of information about various network protocols, such as I<IP>,
6843 I<TCP>, I<UDP>, etc.
6845 Available configuration options:
6849 =item B<Value> I<Selector>
6851 Selects whether or not to select a specific value. The string being matched is
6852 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6853 plugin instance and I<ValueName> will be used as type instance. An example of
6854 the string being used would be C<Tcp:RetransSegs>.
6856 You can use regular expressions to match a large number of values with just one
6857 configuration option. To select all "extended" I<TCP> values, you could use the
6858 following statement:
6862 Whether only matched values are selected or all matched values are ignored
6863 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6864 If no value is configured at all, all values will be selected.
6866 See F</"IGNORELISTS"> for details.
6868 =item B<IgnoreSelected> B<true>|B<false>
6870 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6871 matching values will be ignored.
6875 =head2 Plugin C<python>
6877 This plugin embeds a Python-interpreter into collectd and provides an interface
6878 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6880 =head2 Plugin C<routeros>
6882 The C<routeros> plugin connects to a device running I<RouterOS>, the
6883 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6884 I<librouteros> to connect and reads information about the interfaces and
6885 wireless connections of the device. The configuration supports querying
6890 Host "router0.example.com"
6893 CollectInterface true
6898 Host "router1.example.com"
6901 CollectInterface true
6902 CollectRegistrationTable true
6908 As you can see above, the configuration of the I<routeros> plugin consists of
6909 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6910 options are understood:
6914 =item B<Host> I<Host>
6916 Hostname or IP-address of the router to connect to.
6918 =item B<Port> I<Port>
6920 Port name or port number used when connecting. If left unspecified, the default
6921 will be chosen by I<librouteros>, currently "8728". This option expects a
6922 string argument, even when a numeric port number is given.
6924 =item B<User> I<User>
6926 Use the user name I<User> to authenticate. Defaults to "admin".
6928 =item B<Password> I<Password>
6930 Set the password used to authenticate.
6932 =item B<CollectInterface> B<true>|B<false>
6934 When set to B<true>, interface statistics will be collected for all interfaces
6935 present on the device. Defaults to B<false>.
6937 =item B<CollectRegistrationTable> B<true>|B<false>
6939 When set to B<true>, information about wireless LAN connections will be
6940 collected. Defaults to B<false>.
6942 =item B<CollectCPULoad> B<true>|B<false>
6944 When set to B<true>, information about the CPU usage will be collected. The
6945 number is a dimensionless value where zero indicates no CPU usage at all.
6946 Defaults to B<false>.
6948 =item B<CollectMemory> B<true>|B<false>
6950 When enabled, the amount of used and free memory will be collected. How used
6951 memory is calculated is unknown, for example whether or not caches are counted
6953 Defaults to B<false>.
6955 =item B<CollectDF> B<true>|B<false>
6957 When enabled, the amount of used and free disk space will be collected.
6958 Defaults to B<false>.
6960 =item B<CollectDisk> B<true>|B<false>
6962 When enabled, the number of sectors written and bad blocks will be collected.
6963 Defaults to B<false>.
6967 =head2 Plugin C<redis>
6969 The I<Redis plugin> connects to one or more Redis servers and gathers
6970 information about each server's state. For each server there is a I<Node> block
6971 which configures the connection parameters for this node.
6978 <Query "LLEN myqueue">
6985 The information shown in the synopsis above is the I<default configuration>
6986 which is used by the plugin if no configuration is present.
6990 =item B<Node> I<Nodename>
6992 The B<Node> block identifies a new Redis node, that is a new Redis instance
6993 running in an specified host and port. The name for node is a canonical
6994 identifier which is used as I<plugin instance>. It is limited to
6995 64E<nbsp>characters in length.
6997 =item B<Host> I<Hostname>
6999 The B<Host> option is the hostname or IP-address where the Redis instance is
7002 =item B<Port> I<Port>
7004 The B<Port> option is the TCP port on which the Redis instance accepts
7005 connections. Either a service name of a port number may be given. Please note
7006 that numerical port numbers must be given as a string, too.
7008 =item B<Password> I<Password>
7010 Use I<Password> to authenticate when connecting to I<Redis>.
7012 =item B<Timeout> I<Milliseconds>
7014 The B<Timeout> option set the socket timeout for node response. Since the Redis
7015 read function is blocking, you should keep this value as low as possible. Keep
7016 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
7017 than B<Interval> defined globally.
7019 =item B<Query> I<Querystring>
7021 The B<Query> block identifies a query to execute against the redis server.
7022 There may be an arbitrary number of queries to execute.
7024 =item B<Type> I<Collectd type>
7026 Within a query definition, a valid collectd type to use as when submitting
7027 the result of the query. When not supplied, will default to B<gauge>.
7029 =item B<Instance> I<Type instance>
7031 Within a query definition, an optional type instance to use when submitting
7032 the result of the query. When not supplied will default to the escaped
7033 command, up to 64 chars.
7037 =head2 Plugin C<rrdcached>
7039 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7040 to store values to RRD files in an efficient manner. The combination of the
7041 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7042 way the C<rrdtool> plugin works (see below). The added abstraction layer
7043 provides a number of benefits, though: Because the cache is not within
7044 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7045 restarted. This results in much shorter (if any) gaps in graphs, especially
7046 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7047 daemon so that it can flush values to disk automatically when needed. This
7048 allows one to integrate automated flushing of values into graphing solutions
7051 There are disadvantages, though: The daemon may reside on a different host, so
7052 it may not be possible for C<collectd> to create the appropriate RRD files
7053 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7054 different base directory, so relative paths may do weird stuff if you're not
7057 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7058 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7059 setting should be set to an absolute path, so that a changed base directory
7060 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7064 =item B<DaemonAddress> I<Address>
7066 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7067 library. See L<rrdcached(1)> for details. Example:
7069 <Plugin "rrdcached">
7070 DaemonAddress "unix:/var/run/rrdcached.sock"
7073 =item B<DataDir> I<Directory>
7075 Set the base directory in which the RRD files reside. If this is a relative
7076 path, it is relative to the working base directory of the C<rrdcached> daemon!
7077 Use of an absolute path is recommended.
7079 =item B<CreateFiles> B<true>|B<false>
7081 Enables or disables the creation of RRD files. If the daemon is not running
7082 locally, or B<DataDir> is set to a relative path, this will not work as
7083 expected. Default is B<true>.
7085 =item B<CreateFilesAsync> B<false>|B<true>
7087 When enabled, new RRD files are enabled asynchronously, using a separate thread
7088 that runs in the background. This prevents writes to block, which is a problem
7089 especially when many hundreds of files need to be created at once. However,
7090 since the purpose of creating the files asynchronously is I<not> to block until
7091 the file is available, values before the file is available will be discarded.
7092 When disabled (the default) files are created synchronously, blocking for a
7093 short while, while the file is being written.
7095 =item B<StepSize> I<Seconds>
7097 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7098 this setting is unset and the stepsize is set to the interval in which the data
7099 is collected. Do not use this option unless you absolutely have to for some
7100 reason. Setting this option may cause problems with the C<snmp plugin>, the
7101 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7103 =item B<HeartBeat> I<Seconds>
7105 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7106 in which case the heartbeat is set to twice the B<StepSize> which should equal
7107 the interval in which data is collected. Do not set this option unless you have
7108 a very good reason to do so.
7110 =item B<RRARows> I<NumRows>
7112 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7113 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7114 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7115 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7116 week, one month, and one year.
7118 So for each timespan, it calculates how many PDPs need to be consolidated into
7119 one CDP by calculating:
7120 number of PDPs = timespan / (stepsize * rrarows)
7122 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7125 =item B<RRATimespan> I<Seconds>
7127 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7128 more then one RRA. If this option is never used, the built-in default of (3600,
7129 86400, 604800, 2678400, 31622400) is used.
7131 For more information on how RRA-sizes are calculated see B<RRARows> above.
7133 =item B<XFF> I<Factor>
7135 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7136 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7139 =item B<CollectStatistics> B<false>|B<true>
7141 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7142 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7144 Statistics are read via I<rrdcached>s socket using the STATS command.
7145 See L<rrdcached(1)> for details.
7149 =head2 Plugin C<rrdtool>
7151 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7152 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7153 using these settings. If you don't want to dive into the depths of RRDtool, you
7154 can safely ignore these settings.
7158 =item B<DataDir> I<Directory>
7160 Set the directory to store RRD files under. By default RRD files are generated
7161 beneath the daemon's working directory, i.e. the B<BaseDir>.
7163 =item B<CreateFilesAsync> B<false>|B<true>
7165 When enabled, new RRD files are enabled asynchronously, using a separate thread
7166 that runs in the background. This prevents writes to block, which is a problem
7167 especially when many hundreds of files need to be created at once. However,
7168 since the purpose of creating the files asynchronously is I<not> to block until
7169 the file is available, values before the file is available will be discarded.
7170 When disabled (the default) files are created synchronously, blocking for a
7171 short while, while the file is being written.
7173 =item B<StepSize> I<Seconds>
7175 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7176 this setting is unset and the stepsize is set to the interval in which the data
7177 is collected. Do not use this option unless you absolutely have to for some
7178 reason. Setting this option may cause problems with the C<snmp plugin>, the
7179 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7181 =item B<HeartBeat> I<Seconds>
7183 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7184 in which case the heartbeat is set to twice the B<StepSize> which should equal
7185 the interval in which data is collected. Do not set this option unless you have
7186 a very good reason to do so.
7188 =item B<RRARows> I<NumRows>
7190 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7191 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7192 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7193 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7194 week, one month, and one year.
7196 So for each timespan, it calculates how many PDPs need to be consolidated into
7197 one CDP by calculating:
7198 number of PDPs = timespan / (stepsize * rrarows)
7200 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7203 =item B<RRATimespan> I<Seconds>
7205 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7206 more then one RRA. If this option is never used, the built-in default of (3600,
7207 86400, 604800, 2678400, 31622400) is used.
7209 For more information on how RRA-sizes are calculated see B<RRARows> above.
7211 =item B<XFF> I<Factor>
7213 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7214 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7217 =item B<CacheFlush> I<Seconds>
7219 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7220 it writes all values for a certain RRD-file if the oldest value is older than
7221 (or equal to) the number of seconds specified by B<CacheTimeout>.
7222 That check happens on new values arriwal. If some RRD-file is not updated
7223 anymore for some reason (the computer was shut down, the network is broken,
7224 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7225 every I<Seconds> seconds the entire cache is searched for entries older than
7226 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7227 disk. Since scanning the entire cache is kind of expensive and does nothing
7228 under normal circumstances, this value should not be too small. 900 seconds
7229 might be a good value, though setting this to 7200 seconds doesn't normally
7230 do much harm either.
7232 Defaults to 10x B<CacheTimeout>.
7233 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7234 above default is used.
7236 =item B<CacheTimeout> I<Seconds>
7238 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7239 save values in a cache, as described above. Writing multiple values at once
7240 reduces IO-operations and thus lessens the load produced by updating the files.
7241 The trade off is that the graphs kind of "drag behind" and that more memory is
7244 =item B<WritesPerSecond> I<Updates>
7246 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7247 will run serious performance problems. The B<CacheFlush> setting and the
7248 internal update queue assert that collectd continues to work just fine even
7249 under heavy load, but the system may become very unresponsive and slow. This is
7250 a problem especially if you create graphs from the RRD files on the same
7251 machine, for example using the C<graph.cgi> script included in the
7252 C<contrib/collection3/> directory.
7254 This setting is designed for very large setups. Setting this option to a value
7255 between 25 and 80 updates per second, depending on your hardware, will leave
7256 the server responsive enough to draw graphs even while all the cached values
7257 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7258 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7259 written as fast as possible, so that web frontends have up to date data when
7262 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7263 updates per second, writing all values to disk will take approximately
7264 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7265 "collection3" you'll end up with a responsive and fast system, up to date
7266 graphs and basically a "backup" of your values every hour.
7268 =item B<RandomTimeout> I<Seconds>
7270 When set, the actual timeout for each value is chosen randomly between
7271 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7272 intention is to avoid high load situations that appear when many values timeout
7273 at the same time. This is especially a problem shortly after the daemon starts,
7274 because all values were added to the internal cache at roughly the same time.
7278 =head2 Plugin C<sensors>
7280 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7281 that all the needed modules have to be loaded and lm_sensors has to be
7282 configured (most likely by editing F</etc/sensors.conf>. Read
7283 L<sensors.conf(5)> for details.
7285 The B<lm_sensors> homepage can be found at
7286 L<http://secure.netroedge.com/~lm78/>.
7290 =item B<SensorConfigFile> I<File>
7292 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7293 the library's default will be used.
7295 =item B<Sensor> I<chip-bus-address/type-feature>
7297 Selects the name of the sensor which you want to collect or ignore, depending
7298 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7299 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7300 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7302 See F</"IGNORELISTS"> for details.
7304 =item B<IgnoreSelected> I<true>|I<false>
7306 If no configuration if given, the B<sensors>-plugin will collect data from all
7307 sensors. This may not be practical, especially for uninteresting sensors.
7308 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7309 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7310 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7311 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7312 and all other sensors are collected.
7314 =item B<UseLabels> I<true>|I<false>
7316 Configures how sensor readings are reported. When set to I<true>, sensor
7317 readings are reported using their descriptive label (e.g. "VCore"). When set to
7318 I<false> (the default) the sensor name is used ("in0").
7322 =head2 Plugin C<sigrok>
7324 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7325 supported by the L<sigrok|http://sigrok.org/> project.
7331 <Device "AC Voltage">
7336 <Device "Sound Level">
7337 Driver "cem-dt-885x"
7344 =item B<LogLevel> B<0-5>
7346 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7347 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7348 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7349 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7350 their level, are always submitted to I<collectd> at its INFO log level.
7352 =item E<lt>B<Device> I<Name>E<gt>
7354 A sigrok-supported device, uniquely identified by this section's options. The
7355 I<Name> is passed to I<collectd> as the I<plugin instance>.
7357 =item B<Driver> I<DriverName>
7359 The sigrok driver to use for this device.
7361 =item B<Conn> I<ConnectionSpec>
7363 If the device cannot be auto-discovered, or more than one might be discovered
7364 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7365 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7366 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7367 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7368 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7370 =item B<SerialComm> I<SerialSpec>
7372 For serial devices with non-standard port settings, this option can be used
7373 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7374 This should not be necessary; drivers know how to communicate with devices they
7377 =item B<MinimumInterval> I<Seconds>
7379 Specifies the minimum time between measurement dispatches to I<collectd>, in
7380 seconds. Since some I<sigrok> supported devices can acquire measurements many
7381 times per second, it may be necessary to throttle these. For example, the
7382 I<RRD plugin> cannot process writes more than once per second.
7384 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7385 device are always dispatched to I<collectd>. When throttled, unused
7386 measurements are discarded.
7390 =head2 Plugin C<smart>
7392 The C<smart> plugin collects SMART information from physical
7393 disks. Values collectd include temperature, power cycle count, poweron
7394 time and bad sectors. Also, all SMART attributes are collected along
7395 with the normalized current value, the worst value, the threshold and
7396 a human readable value.
7398 Using the following two options you can ignore some disks or configure the
7399 collection only of specific disks.
7403 =item B<Disk> I<Name>
7405 Select the disk I<Name>. Whether it is collected or ignored depends on the
7406 B<IgnoreSelected> setting, see below. As with other plugins that use the
7407 daemon's ignorelist functionality, a string that starts and ends with a slash
7408 is interpreted as a regular expression. Examples:
7413 See F</"IGNORELISTS"> for details.
7415 =item B<IgnoreSelected> B<true>|B<false>
7417 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7418 statements, are ignored or if all other disks are ignored. The behavior
7419 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7420 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7421 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7422 is set to B<true>, all disks are collected B<except> the ones matched.
7424 =item B<IgnoreSleepMode> B<true>|B<false>
7426 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7427 This option disables the sleep mode check and allows the plugin to collect data
7428 from these disks anyway. This is useful in cases where libatasmart mistakenly
7429 reports disks as asleep because it has not been updated to incorporate support
7430 for newer idle states in the ATA spec.
7432 =item B<UseSerial> B<true>|B<false>
7434 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7435 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7436 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7437 storing data. This ensures that the data for a given disk will be kept together
7438 even if the kernel name changes.
7442 =head2 Plugin C<snmp>
7444 Since the configuration of the C<snmp plugin> is a little more complicated than
7445 other plugins, its documentation has been moved to an own manpage,
7446 L<collectd-snmp(5)>. Please see there for details.
7448 =head2 Plugin C<snmp_agent>
7450 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7451 from SNMP master agent and returns the data collected by read plugins.
7452 The I<snmp_agent> plugin handles requests only for OIDs specified in
7453 configuration file. To handle SNMP queries the plugin gets data from collectd
7454 and translates requested values from collectd's internal format to SNMP format.
7455 This plugin is a generic plugin and cannot work without configuration.
7456 For more details on AgentX subagent see
7457 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7462 <Data "memAvailReal">
7464 #PluginInstance "some"
7467 OIDs "1.3.6.1.4.1.2021.4.6.0"
7470 IndexOID "IF-MIB::ifIndex"
7471 SizeOID "IF-MIB::ifNumber"
7475 OIDs "IF-MIB::ifDescr"
7481 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7486 There are two types of blocks that can be contained in the
7487 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7489 =head3 The B<Data> block
7491 The B<Data> block defines a list OIDs that are to be handled. This block can
7492 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7493 block it reperesents table OIDs.
7494 The following options can be set:
7498 =item B<Instance> I<true|false>
7500 When B<Instance> is set to B<true>, the value for requested OID is copied from
7501 plugin instance field of corresponding collectd value. If B<Data> block defines
7502 scalar data type B<Instance> has no effect and can be omitted.
7504 =item B<Plugin> I<String>
7506 Read plugin name whose collected data will be mapped to specified OIDs.
7508 =item B<PluginInstance> I<String>
7510 Read plugin instance whose collected data will be mapped to specified OIDs.
7511 The field is optional and by default there is no plugin instance check.
7512 Allowed only if B<Data> block defines scalar data type.
7514 =item B<Type> I<String>
7516 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7517 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7519 =item B<TypeInstance> I<String>
7521 Collectd's type-instance that is to be used for specified OID.
7523 =item B<OIDs> I<OID> [I<OID> ...]
7525 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7526 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7527 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7528 configured should correspond to number of values in specified B<Type>.
7529 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7530 "rx" and "tx" values of "if_octets" type.
7532 =item B<Scale> I<Value>
7534 The values taken from collectd are multiplied by I<Value>. The field is optional
7535 and the default is B<1.0>.
7537 =item B<Shift> I<Value>
7539 I<Value> is added to values from collectd after they have been multiplied by
7540 B<Scale> value. The field is optional and the default value is B<0.0>.
7544 =head3 The B<Table> block
7546 The B<Table> block defines a collection of B<Data> blocks that belong to one
7547 snmp table. In addition to multiple B<Data> blocks the following options can be
7552 =item B<IndexOID> I<OID>
7554 OID that is handled by the plugin and is mapped to numerical index value that is
7555 generated by the plugin for each table record.
7557 =item B<SizeOID> I<OID>
7559 OID that is handled by the plugin. Returned value is the number of records in
7560 the table. The field is optional.
7564 =head2 Plugin C<statsd>
7566 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7567 protocol and dispatches rates or other aggregates of these numbers
7570 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7571 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7572 C<objects> respectively.
7574 The following configuration options are valid:
7578 =item B<Host> I<Host>
7580 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7581 "any" address, i.e. accept packets sent to any of the hosts addresses.
7583 =item B<Port> I<Port>
7585 UDP port to listen to. This can be either a service name or a port number.
7586 Defaults to C<8125>.
7588 =item B<DeleteCounters> B<false>|B<true>
7590 =item B<DeleteTimers> B<false>|B<true>
7592 =item B<DeleteGauges> B<false>|B<true>
7594 =item B<DeleteSets> B<false>|B<true>
7596 These options control what happens if metrics are not updated in an interval.
7597 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7598 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7599 are unchanged. If set to B<True>, the such metrics are not dispatched and
7600 removed from the internal cache.
7602 =item B<CounterSum> B<false>|B<true>
7604 When enabled, creates a C<count> metric which reports the change since the last
7605 read. This option primarily exists for compatibility with the I<statsd>
7606 implementation by Etsy.
7608 =item B<TimerPercentile> I<Percent>
7610 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7611 that I<Percent> of all reported timers are smaller than or equal to the
7612 computed latency. This is useful for cutting off the long tail latency, as it's
7613 often done in I<Service Level Agreements> (SLAs).
7615 Different percentiles can be calculated by setting this option several times.
7616 If none are specified, no percentiles are calculated / dispatched.
7618 =item B<TimerLower> B<false>|B<true>
7620 =item B<TimerUpper> B<false>|B<true>
7622 =item B<TimerSum> B<false>|B<true>
7624 =item B<TimerCount> B<false>|B<true>
7626 Calculate and dispatch various values out of I<Timer> metrics received during
7627 an interval. If set to B<False>, the default, these values aren't calculated /
7632 =head2 Plugin C<swap>
7634 The I<Swap plugin> collects information about used and available swap space. On
7635 I<Linux> and I<Solaris>, the following options are available:
7639 =item B<ReportByDevice> B<false>|B<true>
7641 Configures how to report physical swap devices. If set to B<false> (the
7642 default), the summary over all swap devices is reported only, i.e. the globally
7643 used and available space over all devices. If B<true> is configured, the used
7644 and available space of each device will be reported separately.
7646 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7647 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7649 =item B<ReportBytes> B<false>|B<true>
7651 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7652 I<swap I/O> is reported in pages. This option is available under Linux only.
7654 =item B<ValuesAbsolute> B<true>|B<false>
7656 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7657 available and used. Defaults to B<true>.
7659 =item B<ValuesPercentage> B<false>|B<true>
7661 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7662 available and free. Defaults to B<false>.
7664 This is useful for deploying I<collectd> in a heterogeneous environment, where
7665 swap sizes differ and you want to specify generic thresholds or similar.
7667 =item B<ReportIO> B<true>|B<false>
7669 Enables or disables reporting swap IO. Defaults to B<true>.
7671 This is useful for the cases when swap IO is not neccessary, is not available,
7676 =head2 Plugin C<syslog>
7680 =item B<LogLevel> B<debug|info|notice|warning|err>
7682 Sets the log-level. If, for example, set to B<notice>, then all events with
7683 severity B<notice>, B<warning>, or B<err> will be submitted to the
7686 Please note that B<debug> is only available if collectd has been compiled with
7689 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7691 Controls which notifications should be sent to syslog. The default behaviour is
7692 not to send any. Less severe notifications always imply logging more severe
7693 notifications: Setting this to B<OKAY> means all notifications will be sent to
7694 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7695 notifications but will dismiss B<OKAY> notifications. Setting this option to
7696 B<FAILURE> will only send failures to syslog.
7700 =head2 Plugin C<table>
7702 The C<table plugin> provides generic means to parse tabular data and dispatch
7703 user specified values. Values are selected based on column numbers. For
7704 example, this plugin may be used to get values from the Linux L<proc(5)>
7705 filesystem or CSV (comma separated values) files.
7708 <Table "/proc/slabinfo">
7714 InstancePrefix "active_objs"
7720 InstancePrefix "objperslab"
7727 The configuration consists of one or more B<Table> blocks, each of which
7728 configures one file to parse. Within each B<Table> block, there are one or
7729 more B<Result> blocks, which configure which data to select and how to
7732 The following options are available inside a B<Table> block:
7736 =item B<Plugin> I<Plugin>
7738 If specified, I<Plugin> is used as the plugin name when submitting values.
7739 Defaults to B<table>.
7741 =item B<Instance> I<instance>
7743 If specified, I<instance> is used as the plugin instance. If omitted, the
7744 filename of the table is used instead, with all special characters replaced
7745 with an underscore (C<_>).
7747 =item B<Separator> I<string>
7749 Any character of I<string> is interpreted as a delimiter between the different
7750 columns of the table. A sequence of two or more contiguous delimiters in the
7751 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7752 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7753 of a table - see its documentation for more details. This option is mandatory.
7755 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7756 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7757 required because of collectd's config parsing.
7761 The following options are available inside a B<Result> block:
7765 =item B<Type> I<type>
7767 Sets the type used to dispatch the values to the daemon. Detailed information
7768 about types and their configuration can be found in L<types.db(5)>. This
7769 option is mandatory.
7771 =item B<InstancePrefix> I<prefix>
7773 If specified, prepend I<prefix> to the type instance. If omitted, only the
7774 B<InstancesFrom> option is considered for the type instance.
7776 =item B<InstancesFrom> I<column0> [I<column1> ...]
7778 If specified, the content of the given columns (identified by the column
7779 number starting at zero) will be used to create the type instance for each
7780 row. Multiple values (and the instance prefix) will be joined together with
7781 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7782 option is considered for the type instance.
7784 The plugin itself does not check whether or not all built instances are
7785 different. It’s your responsibility to assure that each is unique. This is
7786 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7787 sure that the table only contains one row.
7789 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7792 =item B<ValuesFrom> I<column0> [I<column1> ...]
7794 Specifies the columns (identified by the column numbers starting at zero)
7795 whose content is used as the actual data for the data sets that are dispatched
7796 to the daemon. How many such columns you need is determined by the B<Type>
7797 setting above. If you specify too many or not enough columns, the plugin will
7798 complain about that and no data will be submitted to the daemon. The plugin
7799 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7800 respectively, so anything supported by those functions is supported by the
7801 plugin as well. This option is mandatory.
7805 =head2 Plugin C<tail>
7807 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7808 each line and dispatches found values. What is matched can be configured by the
7809 user using (extended) regular expressions, as described in L<regex(7)>.
7812 <File "/var/log/exim4/mainlog">
7817 Regex "S=([1-9][0-9]*)"
7823 Regex "\\<R=local_user\\>"
7824 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7827 Instance "local_user"
7830 Regex "l=([0-9]*\\.[0-9]*)"
7831 <DSType "Distribution">
7834 #BucketType "bucket"
7842 The config consists of one or more B<File> blocks, each of which configures one
7843 logfile to parse. Within each B<File> block, there are one or more B<Match>
7844 blocks, which configure a regular expression to search for.
7846 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
7847 the plugin name and instance respectively. So in the above example the plugin name
7848 C<mail-exim> would be used.
7850 These options are applied for all B<Match> blocks that B<follow> it, until the
7851 next B<Plugin> or B<Instance> option. This way you can extract several plugin
7852 instances from one logfile, handy when parsing syslog and the like.
7854 The B<Interval> option allows you to define the length of time between reads. If
7855 this is not set, the default Interval will be used.
7857 Each B<Match> block has the following options to describe how the match should
7862 =item B<Regex> I<regex>
7864 Sets the regular expression to use for matching against a line. The first
7865 subexpression has to match something that can be turned into a number by
7866 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7867 below. Because B<extended> regular expressions are used, you do not need to use
7868 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7869 collectd's config parsing you need to escape backslashes, though. So if you
7870 want to match literal parentheses you need to do the following:
7872 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7874 =item B<ExcludeRegex> I<regex>
7876 Sets an optional regular expression to use for excluding lines from the match.
7877 An example which excludes all connections from localhost from the match:
7879 ExcludeRegex "127\\.0\\.0\\.1"
7881 =item B<DSType> I<Type>
7883 Sets how the values are cumulated. I<Type> is one of:
7887 =item B<GaugeAverage>
7889 Calculate the average.
7893 Use the smallest number only.
7897 Use the greatest number only.
7901 Use the last number found.
7903 =item B<GaugePersist>
7905 Use the last number found. The number is not reset at the end of an interval.
7906 It is continously reported until another number is matched. This is intended
7907 for cases in which only state changes are reported, for example a thermometer
7908 that only reports the temperature when it changes.
7914 =item B<AbsoluteSet>
7916 The matched number is a counter. Simply I<sets> the internal counter to this
7917 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
7925 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
7926 matched number may be negative, which will effectively subtract from the
7935 Increase the internal counter by one. These B<DSType> are the only ones that do
7936 not use the matched subexpression, but simply count the number of matched
7937 lines. Thus, you may use a regular expression without submatch in this case.
7939 =item B<Distribution>
7941 Type to do calculations based on the distribution of values, primarily
7942 calculating percentiles. This is primarily geared towards latency, but can be
7943 used for other metrics as well. The range of values tracked with this setting
7944 must be in the range (0–2^34) and can be fractional. Please note that neither
7945 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
7948 This option must be used together with the B<Percentile> and/or B<Bucket>
7953 <DSType "Distribution">
7961 =item B<Percentile> I<Percent>
7963 Calculate and dispatch the configured percentile, i.e. compute the value, so
7964 that I<Percent> of all matched values are smaller than or equal to the computed
7967 Metrics are reported with the I<type> B<Type> (the value of the above option)
7968 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
7970 This option may be repeated to calculate more than one percentile.
7972 =item B<Bucket> I<lower_bound> I<upper_bound>
7974 Export the number of values (a C<DERIVE>) falling within the given range. Both,
7975 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
7976 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
7977 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
7978 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
7981 To export the entire (0–inf) range without overlap, use the upper bound of the
7982 previous range as the lower bound of the following range. In other words, use
7983 the following schema:
7993 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
7994 by default) and the I<type instance>
7995 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
7997 This option may be repeated to calculate more than one rate.
7999 =item B<BucketType> I<Type>
8001 Sets the type used to dispatch B<Bucket> metrics.
8002 Optional, by default C<bucket> will be used.
8008 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8009 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8010 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8011 B<Derive*> types interpret the submatch as a signed integer using
8012 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8013 and it may be omitted in this case.
8015 =item B<Type> I<Type>
8017 Sets the type used to dispatch this value. Detailed information about types and
8018 their configuration can be found in L<types.db(5)>.
8020 =item B<Instance> I<TypeInstance>
8022 This optional setting sets the type instance to use.
8026 =head2 Plugin C<tail_csv>
8028 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8029 written by I<Snort>.
8034 <Metric "snort-dropped">
8039 <File "/var/log/snort/snort.stats">
8043 Collect "snort-dropped"
8047 The configuration consists of one or more B<Metric> blocks that define an index
8048 into the line of the CSV file and how this value is mapped to I<collectd's>
8049 internal representation. These are followed by one or more B<Instance> blocks
8050 which configure which file to read, in which interval and which metrics to
8055 =item E<lt>B<Metric> I<Name>E<gt>
8057 The B<Metric> block configures a new metric to be extracted from the statistics
8058 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8059 only used inside the B<Instance> blocks to refer to this block, so you can use
8060 one B<Metric> block for multiple CSV files.
8064 =item B<Type> I<Type>
8066 Configures which I<Type> to use when dispatching this metric. Types are defined
8067 in the L<types.db(5)> file, see the appropriate manual page for more
8068 information on specifying types. Only types with a single I<data source> are
8069 supported by the I<tail_csv plugin>. The information whether the value is an
8070 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8071 I<Type's> definition.
8073 =item B<Instance> I<TypeInstance>
8075 If set, I<TypeInstance> is used to populate the type instance field of the
8076 created value lists. Otherwise, no type instance is used.
8078 =item B<ValueFrom> I<Index>
8080 Configure to read the value from the field with the zero-based index I<Index>.
8081 If the value is parsed as signed integer, unsigned integer or double depends on
8082 the B<Type> setting, see above.
8086 =item E<lt>B<File> I<Path>E<gt>
8088 Each B<File> block represents one CSV file to read. There must be at least one
8089 I<File> block but there can be multiple if you have multiple CSV files.
8093 =item B<Plugin> I<Plugin>
8095 Use I<Plugin> as the plugin name when submitting values.
8096 Defaults to C<tail_csv>.
8098 =item B<Instance> I<PluginInstance>
8100 Sets the I<plugin instance> used when dispatching the values.
8102 =item B<Collect> I<Metric>
8104 Specifies which I<Metric> to collect. This option must be specified at least
8105 once, and you can use this option multiple times to specify more than one
8106 metric to be extracted from this statistic file.
8108 =item B<Interval> I<Seconds>
8110 Configures the interval in which to read values from this instance / file.
8111 Defaults to the plugin's default interval.
8113 =item B<TimeFrom> I<Index>
8115 Rather than using the local time when dispatching a value, read the timestamp
8116 from the field with the zero-based index I<Index>. The value is interpreted as
8117 seconds since epoch. The value is parsed as a double and may be factional.
8123 =head2 Plugin C<teamspeak2>
8125 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8126 polls interesting global and virtual server data. The plugin can query only one
8127 physical server but unlimited virtual servers. You can use the following
8128 options to configure it:
8132 =item B<Host> I<hostname/ip>
8134 The hostname or ip which identifies the physical server.
8137 =item B<Port> I<port>
8139 The query port of the physical server. This needs to be a string.
8142 =item B<Server> I<port>
8144 This option has to be added once for every virtual server the plugin should
8145 query. If you want to query the virtual server on port 8767 this is what the
8146 option would look like:
8150 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8151 use quotes around it! If no such statement is given only global information
8156 =head2 Plugin C<ted>
8158 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8159 measure power consumption. These devices are usually connected to a serial
8160 (RS232) or USB port. The plugin opens a configured device and tries to read the
8161 current energy readings. For more information on TED, visit
8162 L<http://www.theenergydetective.com/>.
8164 Available configuration options:
8168 =item B<Device> I<Path>
8170 Path to the device on which TED is connected. collectd will need read and write
8171 permissions on that file.
8173 Default: B</dev/ttyUSB0>
8175 =item B<Retries> I<Num>
8177 Apparently reading from TED is not that reliable. You can therefore configure a
8178 number of retries here. You only configure the I<retries> here, to if you
8179 specify zero, one reading will be performed (but no retries if that fails); if
8180 you specify three, a maximum of four readings are performed. Negative values
8187 =head2 Plugin C<tcpconns>
8189 The C<tcpconns plugin> counts the number of currently established TCP
8190 connections based on the local port and/or the remote port. Since there may be
8191 a lot of connections the default if to count all connections with a local port,
8192 for which a listening socket is opened. You can use the following options to
8193 fine-tune the ports you are interested in:
8197 =item B<ListeningPorts> I<true>|I<false>
8199 If this option is set to I<true>, statistics for all local ports for which a
8200 listening socket exists are collected. The default depends on B<LocalPort> and
8201 B<RemotePort> (see below): If no port at all is specifically selected, the
8202 default is to collect listening ports. If specific ports (no matter if local or
8203 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8204 the selected ports will be collected unless this option is set to I<true>
8207 =item B<LocalPort> I<Port>
8209 Count the connections to a specific local port. This can be used to see how
8210 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8211 You have to specify the port in numeric form, so for the mailserver example
8212 you'd need to set B<25>.
8214 =item B<RemotePort> I<Port>
8216 Count the connections to a specific remote port. This is useful to see how
8217 much a remote service is used. This is most useful if you want to know how many
8218 connections a local service has opened to remote services, e.E<nbsp>g. how many
8219 connections a mail server or news server has to other mail or news servers, or
8220 how many connections a web proxy holds to web servers. You have to give the
8221 port in numeric form.
8223 =item B<AllPortsSummary> I<true>|I<false>
8225 If this option is set to I<true> a summary of statistics from all connections
8226 are collected. This option defaults to I<false>.
8230 =head2 Plugin C<thermal>
8234 =item B<ForceUseProcfs> I<true>|I<false>
8236 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8237 C<sysfs> interface. If that is not available, the plugin falls back to the
8238 C<procfs> interface. By setting this option to I<true>, you can force the
8239 plugin to use the latter. This option defaults to I<false>.
8241 =item B<Device> I<Device>
8243 Selects the name of the thermal device that you want to collect or ignore,
8244 depending on the value of the B<IgnoreSelected> option. This option may be
8245 used multiple times to specify a list of devices.
8247 See F</"IGNORELISTS"> for details.
8249 =item B<IgnoreSelected> I<true>|I<false>
8251 Invert the selection: If set to true, all devices B<except> the ones that
8252 match the device names specified by the B<Device> option are collected. By
8253 default only selected devices are collected if a selection is made. If no
8254 selection is configured at all, B<all> devices are selected.
8258 =head2 Plugin C<threshold>
8260 The I<Threshold plugin> checks values collected or received by I<collectd>
8261 against a configurable I<threshold> and issues I<notifications> if values are
8264 Documentation for this plugin is available in the L<collectd-threshold(5)>
8267 =head2 Plugin C<tokyotyrant>
8269 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8270 couple metrics: number of records, and database size on disk.
8274 =item B<Host> I<Hostname/IP>
8276 The hostname or IP which identifies the server.
8277 Default: B<127.0.0.1>
8279 =item B<Port> I<Service/Port>
8281 The query port of the server. This needs to be a string, even if the port is
8282 given in its numeric form.
8287 =head2 Plugin C<turbostat>
8289 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8290 Intel processors by using I<Model Specific Registers>.
8294 =item B<CoreCstates> I<Bitmask(Integer)>
8296 Bit mask of the list of core C-states supported by the processor.
8297 This option should only be used if the automated detection fails.
8298 Default value extracted from the CPU model and family.
8300 Currently supported C-states (by this plugin): 3, 6, 7
8304 All states (3, 6 and 7):
8305 (1<<3) + (1<<6) + (1<<7) = 392
8307 =item B<PackageCstates> I<Bitmask(Integer)>
8309 Bit mask of the list of packages C-states supported by the processor. This
8310 option should only be used if the automated detection fails. Default value
8311 extracted from the CPU model and family.
8313 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8317 States 2, 3, 6 and 7:
8318 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8320 =item B<SystemManagementInterrupt> I<true>|I<false>
8322 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8323 This option should only be used if the automated detection fails or if you want
8324 to disable this feature.
8326 =item B<DigitalTemperatureSensor> I<true>|I<false>
8328 Boolean enabling the collection of the temperature of each core. This option
8329 should only be used if the automated detection fails or if you want to disable
8332 =item B<TCCActivationTemp> I<Temperature>
8334 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8335 temperature is used when collecting the temperature of cores or packages. This
8336 option should only be used if the automated detection fails. Default value
8337 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8339 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8341 Bit mask of the list of elements to be thermally monitored. This option should
8342 only be used if the automated detection fails or if you want to disable some
8343 collections. The different bits of this bit mask accepted by this plugin are:
8347 =item 0 ('1'): Package
8351 =item 2 ('4'): Cores
8353 =item 3 ('8'): Embedded graphic device
8357 =item B<LogicalCoreNames> I<true>|I<false>
8359 Boolean enabling the use of logical core numbering for per core statistics.
8360 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8361 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8362 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8363 more than one, where I<n> is the n-th core of package I<m>.
8367 =head2 Plugin C<unixsock>
8371 =item B<SocketFile> I<Path>
8373 Sets the socket-file which is to be created.
8375 =item B<SocketGroup> I<Group>
8377 If running as root change the group of the UNIX-socket after it has been
8378 created. Defaults to B<collectd>.
8380 =item B<SocketPerms> I<Permissions>
8382 Change the file permissions of the UNIX-socket after it has been created. The
8383 permissions must be given as a numeric, octal value as you would pass to
8384 L<chmod(1)>. Defaults to B<0770>.
8386 =item B<DeleteSocket> B<false>|B<true>
8388 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8389 with the given name already exists. If I<collectd> crashes a socket file may be
8390 left over, preventing the daemon from opening a new socket when restarted.
8391 Since this is potentially dangerous, this defaults to B<false>.
8395 =head2 Plugin C<uuid>
8397 This plugin, if loaded, causes the Hostname to be taken from the machine's
8398 UUID. The UUID is a universally unique designation for the machine, usually
8399 taken from the machine's BIOS. This is most useful if the machine is running in
8400 a virtual environment such as Xen, in which case the UUID is preserved across
8401 shutdowns and migration.
8403 The following methods are used to find the machine's UUID, in order:
8409 Check I</etc/uuid> (or I<UUIDFile>).
8413 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8418 Check for UUID from C<dmidecode> / SMBIOS.
8422 Check for UUID from Xen hypervisor.
8426 If no UUID can be found then the hostname is not modified.
8430 =item B<UUIDFile> I<Path>
8432 Take the UUID from the given file (default I</etc/uuid>).
8436 =head2 Plugin C<varnish>
8438 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8439 It collects a subset of the values displayed by L<varnishstat(1)>, and
8440 organizes them in categories which can be enabled or disabled. Currently only
8441 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8442 meaning of each metric can be found in L<varnish-counters(7)>.
8447 <Instance "example">
8451 CollectConnections true
8452 CollectDirectorDNS false
8456 CollectObjects false
8458 CollectSession false
8468 CollectWorkers false
8470 CollectMempool false
8471 CollectManagement false
8478 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8479 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8480 will collectd statistics from the default "varnishd" instance (this should work
8481 fine in most cases).
8483 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8487 =item B<CollectBackend> B<true>|B<false>
8489 Back-end connection statistics, such as successful, reused,
8490 and closed connections. True by default.
8492 =item B<CollectBan> B<true>|B<false>
8494 Statistics about ban operations, such as number of bans added, retired, and
8495 number of objects tested against ban operations. Only available with Varnish
8496 3.x and above. False by default.
8498 =item B<CollectCache> B<true>|B<false>
8500 Cache hits and misses. True by default.
8502 =item B<CollectConnections> B<true>|B<false>
8504 Number of client connections received, accepted and dropped. True by default.
8506 =item B<CollectDirectorDNS> B<true>|B<false>
8508 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8511 =item B<CollectESI> B<true>|B<false>
8513 Edge Side Includes (ESI) parse statistics. False by default.
8515 =item B<CollectFetch> B<true>|B<false>
8517 Statistics about fetches (HTTP requests sent to the backend). False by default.
8519 =item B<CollectHCB> B<true>|B<false>
8521 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8522 divided into locked and unlocked look-ups. False by default.
8524 =item B<CollectObjects> B<true>|B<false>
8526 Statistics on cached objects: number of objects expired, nuked (prematurely
8527 expired), saved, moved, etc. False by default.
8529 =item B<CollectPurge> B<true>|B<false>
8531 Statistics about purge operations, such as number of purges added, retired, and
8532 number of objects tested against purge operations. Only available with Varnish
8533 2.x. False by default.
8535 =item B<CollectSession> B<true>|B<false>
8537 Client session statistics. Number of past and current sessions, session herd and
8538 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8539 metrics found in the Connections and Threads sections with previous versions of
8540 Varnish have been moved here.
8542 =item B<CollectSHM> B<true>|B<false>
8544 Statistics about the shared memory log, a memory region to store
8545 log messages which is flushed to disk when full. True by default.
8547 =item B<CollectSMA> B<true>|B<false>
8549 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8550 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
8551 only the one used by the Varnish instance. Only available with Varnish 2.x.
8554 =item B<CollectSMS> B<true>|B<false>
8556 synth (synthetic content) storage statistics. This storage
8557 component is used internally only. False by default.
8559 =item B<CollectSM> B<true>|B<false>
8561 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8562 in varnish 4.x. use CollectSMF.
8565 =item B<CollectStruct> B<true>|B<false>
8567 Current varnish internal state statistics. Number of current sessions, objects
8568 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8571 =item B<CollectTotals> B<true>|B<false>
8573 Collects overview counters, such as the number of sessions created,
8574 the number of requests and bytes transferred. False by default.
8576 =item B<CollectUptime> B<true>|B<false>
8578 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8580 =item B<CollectVCL> B<true>|B<false>
8582 Number of total (available + discarded) VCL (config files). False by default.
8584 =item B<CollectVSM> B<true>|B<false>
8586 Collect statistics about Varnish's shared memory usage (used by the logging and
8587 statistics subsystems). Only available with Varnish 4.x. False by default.
8589 =item B<CollectWorkers> B<true>|B<false>
8591 Collect statistics about worker threads. False by default.
8593 =item B<CollectVBE> B<true>|B<false>
8595 Backend counters. Only available with Varnish 4.x. False by default.
8597 =item B<CollectSMF> B<true>|B<false>
8599 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
8600 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
8601 instance. Used to be called SM in Varnish 2.x. False by default.
8603 =item B<CollectManagement> B<true>|B<false>
8605 Management process counters. Only available with Varnish 4.x. False by default.
8607 =item B<CollectLock> B<true>|B<false>
8609 Lock counters. Only available with Varnish 4.x. False by default.
8611 =item B<CollectMempool> B<true>|B<false>
8613 Memory pool counters. Only available with Varnish 4.x. False by default.
8615 =item B<CollectMSE> B<true>|B<false>
8617 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
8618 Varnish, replacing the traditional malloc and file storages. Only available
8619 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
8620 one used by the Varnish instance. False by default.
8624 =head2 Plugin C<virt>
8626 This plugin allows CPU, disk, network load and other metrics to be collected for
8627 virtualized guests on the machine. The statistics are collected through libvirt
8628 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8629 installing any additional software on guests, especially I<collectd>, which runs
8630 only on the host system.
8632 Only I<Connection> is required.
8636 =item B<Connection> I<uri>
8638 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8640 Connection "xen:///"
8642 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8644 =item B<RefreshInterval> I<seconds>
8646 Refresh the list of domains and devices every I<seconds>. The default is 60
8647 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8648 the list of domains and devices to be refreshed on every iteration.
8650 Refreshing the devices in particular is quite a costly operation, so if your
8651 virtualization setup is static you might consider increasing this. If this
8652 option is set to 0, refreshing is disabled completely.
8654 =item B<Domain> I<name>
8656 =item B<BlockDevice> I<name:dev>
8658 =item B<InterfaceDevice> I<name:dev>
8660 =item B<IgnoreSelected> B<true>|B<false>
8662 Select which domains and devices are collected.
8664 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8665 disk/network devices are collected.
8667 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8668 domains and disk/network devices are ignored, while the rest are collected.
8670 The domain name and device names may use a regular expression, if the name is
8671 surrounded by I</.../> and collectd was compiled with support for regexps.
8673 The default is to collect statistics for all domains and all their devices.
8677 BlockDevice "/:hdb/"
8678 IgnoreSelected "true"
8680 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8683 =item B<BlockDeviceFormat> B<target>|B<source>
8685 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8686 seen by the guest will be used for reporting metrics.
8687 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8690 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8691 using the path of the source, e.g. an image file.
8692 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8697 If the domain XML have the following device defined:
8699 <disk type='block' device='disk'>
8700 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8701 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8702 <target dev='sda' bus='scsi'/>
8704 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8707 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8709 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8710 to C<var_lib_libvirt_images_image1.qcow2>.
8712 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8714 The B<BlockDeviceFormatBasename> controls whether the full path or the
8715 L<basename(1)> of the source is being used as the I<type instance> when
8716 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8720 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8721 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8722 be set to C<var_lib_libvirt_images_image1.qcow2>.
8723 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8724 set to C<image1.qcow2>.
8726 =item B<HostnameFormat> B<name|uuid|hostname|...>
8728 When the virt plugin logs data, it sets the hostname of the collected data
8729 according to this setting. The default is to use the guest name as provided by
8730 the hypervisor, which is equal to setting B<name>.
8732 B<uuid> means use the guest's UUID. This is useful if you want to track the
8733 same guest across migrations.
8735 B<hostname> means to use the global B<Hostname> setting, which is probably not
8736 useful on its own because all guests will appear to have the same name.
8738 You can also specify combinations of these fields. For example B<name uuid>
8739 means to concatenate the guest name and UUID (with a literal colon character
8740 between, thus I<"foo:1234-1234-1234-1234">).
8742 At the moment of writing (collectd-5.5), hostname string is limited to 62
8743 characters. In case when combination of fields exceeds 62 characters,
8744 hostname will be truncated without a warning.
8746 =item B<InterfaceFormat> B<name>|B<address>
8748 When the virt plugin logs interface data, it sets the name of the collected
8749 data according to this setting. The default is to use the path as provided by
8750 the hypervisor (the "dev" property of the target node), which is equal to
8753 B<address> means use the interface's mac address. This is useful since the
8754 interface path might change between reboots of a guest or across migrations.
8756 =item B<PluginInstanceFormat> B<name|uuid|none>
8758 When the virt plugin logs data, it sets the plugin_instance of the collected
8759 data according to this setting. The default is to not set the plugin_instance.
8761 B<name> means use the guest's name as provided by the hypervisor.
8762 B<uuid> means use the guest's UUID.
8764 You can also specify combinations of the B<name> and B<uuid> fields.
8765 For example B<name uuid> means to concatenate the guest name and UUID
8766 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8768 =item B<Instances> B<integer>
8770 How many read instances you want to use for this plugin. The default is one,
8771 and the sensible setting is a multiple of the B<ReadThreads> value.
8772 If you are not sure, just use the default setting.
8774 =item B<ExtraStats> B<string>
8776 Report additional extra statistics. The default is no extra statistics, preserving
8777 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8778 allows the plugin to reported more detailed statistics about the behaviour of
8779 Virtual Machines. The argument is a space-separated list of selectors.
8781 Currently supported selectors are:
8785 =item B<cpu_util>: report CPU utilization per domain in percentage.
8787 =item B<disk>: report extra statistics like number of flush operations and total
8788 service time for read, write and flush operations. Requires libvirt API version
8791 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8794 =item B<domain_state>: report domain state and reason in human-readable format as
8795 a notification. If libvirt API version I<0.9.2> or later is available, domain
8796 reason will be included in notification.
8798 =item B<fs_info>: report file system information as a notification. Requires
8799 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8800 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8801 version supports retrieving file system information.
8803 =item B<job_stats_background>: report statistics about progress of a background
8804 job on a domain. Only one type of job statistics can be collected at the same time.
8805 Requires libvirt API version I<1.2.9> or later.
8807 =item B<job_stats_completed>: report statistics about a recently completed job on
8808 a domain. Only one type of job statistics can be collected at the same time.
8809 Requires libvirt API version I<1.2.9> or later.
8811 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8812 Requires libvirt API version I<0.9.11> or later.
8814 =item B<perf>: report performance monitoring events. To collect performance
8815 metrics they must be enabled for domain and supported by the platform. Requires
8816 libvirt API version I<1.3.3> or later.
8817 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8819 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8825 =head2 Plugin C<vmem>
8827 The C<vmem> plugin collects information about the usage of virtual memory.
8828 Since the statistics provided by the Linux kernel are very detailed, they are
8829 collected very detailed. However, to get all the details, you have to switch
8830 them on manually. Most people just want an overview over, such as the number of
8831 pages read from swap space.
8835 =item B<Verbose> B<true>|B<false>
8837 Enables verbose collection of information. This will start collecting page
8838 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8839 Part of these statistics are collected on a "per zone" basis.
8843 =head2 Plugin C<vserver>
8845 This plugin doesn't have any options. B<VServer> support is only available for
8846 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8847 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8848 need to apply the patches and compile your own kernel, which will then provide
8849 the F</proc/virtual> filesystem that is required by this plugin.
8851 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8853 B<Note>: The traffic collected by this plugin accounts for the amount of
8854 traffic passing a socket which might be a lot less than the actual on-wire
8855 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8856 collect on-wire traffic you could, for example, use the logging facilities of
8857 iptables to feed data for the guest IPs into the iptables plugin.
8859 =head2 Plugin C<write_graphite>
8861 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8862 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8863 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8864 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8865 of at most 1428 bytes to minimize the number of network packets.
8869 <Plugin write_graphite>
8879 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8880 blocks. Inside the B<Node> blocks, the following options are recognized:
8884 =item B<Host> I<Address>
8886 Hostname or address to connect to. Defaults to C<localhost>.
8888 =item B<Port> I<Service>
8890 Service name or port number to connect to. Defaults to C<2003>.
8892 =item B<Protocol> I<String>
8894 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
8896 =item B<ReconnectInterval> I<Seconds>
8898 When set to non-zero, forces the connection to the Graphite backend to be
8899 closed and re-opend periodically. This behavior is desirable in environments
8900 where the connection to the Graphite backend is done through load balancers,
8901 for example. When set to zero, the default, the connetion is kept open for as
8904 =item B<LogSendErrors> B<false>|B<true>
8906 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
8907 If set to B<false>, it will not log the errors. This is especially useful when
8908 using Protocol UDP since many times we want to use the "fire-and-forget"
8909 approach and logging errors fills syslog with unneeded messages.
8911 =item B<Prefix> I<String>
8913 When set, I<String> is added in front of the host name. Dots and whitespace are
8914 I<not> escaped in this string (see B<EscapeCharacter> below).
8916 =item B<Postfix> I<String>
8918 When set, I<String> is appended to the host name. Dots and whitespace are
8919 I<not> escaped in this string (see B<EscapeCharacter> below).
8921 =item B<EscapeCharacter> I<Char>
8923 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
8924 in the identifier. The B<EscapeCharacter> option determines which character
8925 dots, whitespace and control characters are replaced with. Defaults to
8928 =item B<StoreRates> B<false>|B<true>
8930 If set to B<true> (the default), convert counter values to rates. If set to
8931 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
8934 =item B<SeparateInstances> B<false>|B<true>
8936 If set to B<true>, the plugin instance and type instance will be in their own
8937 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8938 default), the plugin and plugin instance (and likewise the type and type
8939 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8941 =item B<AlwaysAppendDS> B<false>|B<true>
8943 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
8944 identifier. If set to B<false> (the default), this is only done when there is
8947 =item B<PreserveSeparator> B<false>|B<true>
8949 If set to B<false> (the default) the C<.> (dot) character is replaced with
8950 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
8951 is preserved, i.e. passed through.
8953 =item B<DropDuplicateFields> B<false>|B<true>
8955 If set to B<true>, detect and remove duplicate components in Graphite metric
8956 names. For example, the metric name C<host.load.load.shortterm> will
8957 be shortened to C<host.load.shortterm>.
8961 =head2 Plugin C<write_log>
8963 The C<write_log> plugin writes metrics as INFO log messages.
8965 This plugin supports two output formats: I<Graphite> and I<JSON>.
8975 =item B<Format> I<Format>
8977 The output format to use. Can be one of C<Graphite> or C<JSON>.
8981 =head2 Plugin C<write_tsdb>
8983 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
8984 time series database. The plugin connects to a I<TSD>, a masterless, no shared
8985 state daemon that ingests metrics and stores them in HBase. The plugin uses
8986 I<TCP> over the "line based" protocol with a default port 4242. The data will
8987 be sent in blocks of at most 1428 bytes to minimize the number of network
8996 Host "tsd-1.my.domain"
8998 HostTags "status=production"
9002 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9003 blocks and global directives.
9005 Global directives are:
9009 =item B<ResolveInterval> I<seconds>
9011 =item B<ResolveJitter> I<seconds>
9013 When I<collectd> connects to a TSDB node, it will request the hostname from
9014 DNS. This can become a problem if the TSDB node is unavailable or badly
9015 configured because collectd will request DNS in order to reconnect for every
9016 metric, which can flood your DNS. So you can cache the last value for
9017 I<ResolveInterval> seconds.
9018 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9020 You can also define a jitter, a random interval to wait in addition to
9021 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9022 hostname at the same time when the connection fails.
9023 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9025 B<Note:> If the DNS resolution has already been successful when the socket
9026 closes, the plugin will try to reconnect immediately with the cached
9027 information. DNS is queried only when the socket is closed for a longer than
9028 I<ResolveInterval> + I<ResolveJitter> seconds.
9032 Inside the B<Node> blocks, the following options are recognized:
9036 =item B<Host> I<Address>
9038 Hostname or address to connect to. Defaults to C<localhost>.
9040 =item B<Port> I<Service>
9042 Service name or port number to connect to. Defaults to C<4242>.
9045 =item B<HostTags> I<String>
9047 When set, I<HostTags> is added to the end of the metric. It is intended to be
9048 used for name=value pairs that the TSD will tag the metric with. Dots and
9049 whitespace are I<not> escaped in this string.
9051 =item B<StoreRates> B<false>|B<true>
9053 If set to B<true>, convert counter values to rates. If set to B<false>
9054 (the default) counter values are stored as is, as an increasing
9057 =item B<AlwaysAppendDS> B<false>|B<true>
9059 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9060 identifier. If set to B<false> (the default), this is only done when there is
9065 =head2 Plugin C<write_mongodb>
9067 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9072 <Plugin "write_mongodb">
9081 The plugin can send values to multiple instances of I<MongoDB> by specifying
9082 one B<Node> block for each instance. Within the B<Node> blocks, the following
9083 options are available:
9087 =item B<Host> I<Address>
9089 Hostname or address to connect to. Defaults to C<localhost>.
9091 =item B<Port> I<Service>
9093 Service name or port number to connect to. Defaults to C<27017>.
9095 =item B<Timeout> I<Milliseconds>
9097 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9098 Setting this option to zero means no timeout, which is the default.
9100 =item B<StoreRates> B<false>|B<true>
9102 If set to B<true> (the default), convert counter values to rates. If set to
9103 B<false> counter values are stored as is, i.e. as an increasing integer
9106 =item B<Database> I<Database>
9108 =item B<User> I<User>
9110 =item B<Password> I<Password>
9112 Sets the information used when authenticating to a I<MongoDB> database. The
9113 fields are optional (in which case no authentication is attempted), but if you
9114 want to use authentication all three fields must be set.
9118 =head2 Plugin C<write_prometheus>
9120 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9121 using I<Prometheus>.
9127 =item B<Port> I<Port>
9129 Port the embedded webserver should listen on. Defaults to B<9103>.
9131 =item B<StalenessDelta> I<Seconds>
9133 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9134 hasn't seen any update for it. This value must match the setting in Prometheus.
9135 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9139 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9140 which time a metric without updates is considered "stale". This setting
9141 effectively puts an upper limit on the interval in which metrics are reported.
9143 When the I<write_prometheus plugin> encounters a metric with an interval
9144 exceeding this limit, it will inform you, the user, and provide the metric to
9145 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9146 metric "fresh" each time it is scraped, with the time of the scrape being
9147 considered the time of the update. The result is that there appear more
9148 datapoints in I<Prometheus> than were actually created, but at least the metric
9149 doesn't disappear periodically.
9153 =head2 Plugin C<write_http>
9155 This output plugin submits values to an HTTP server using POST requests and
9156 encoding metrics with JSON or using the C<PUTVAL> command described in
9157 L<collectd-unixsock(5)>.
9161 <Plugin "write_http">
9163 URL "http://example.com/post-collectd"
9170 The plugin can send values to multiple HTTP servers by specifying one
9171 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9172 block, the following options are available:
9178 URL to which the values are submitted to. Mandatory.
9180 =item B<User> I<Username>
9182 Optional user name needed for authentication.
9184 =item B<Password> I<Password>
9186 Optional password needed for authentication.
9188 =item B<VerifyPeer> B<true>|B<false>
9190 Enable or disable peer SSL certificate verification. See
9191 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9193 =item B<VerifyHost> B<true|false>
9195 Enable or disable peer host name verification. If enabled, the plugin checks if
9196 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9197 matches the host name provided by the B<URL> option. If this identity check
9198 fails, the connection is aborted. Obviously, only works when connecting to a
9199 SSL enabled server. Enabled by default.
9201 =item B<CACert> I<File>
9203 File that holds one or more SSL certificates. If you want to use HTTPS you will
9204 possibly need this option. What CA certificates come bundled with C<libcurl>
9205 and are checked by default depends on the distribution you use.
9207 =item B<CAPath> I<Directory>
9209 Directory holding one or more CA certificate files. You can use this if for
9210 some reason all the needed CA certificates aren't in the same file and can't be
9211 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9214 =item B<ClientKey> I<File>
9216 File that holds the private key in PEM format to be used for certificate-based
9219 =item B<ClientCert> I<File>
9221 File that holds the SSL certificate to be used for certificate-based
9224 =item B<ClientKeyPass> I<Password>
9226 Password required to load the private key in B<ClientKey>.
9228 =item B<Header> I<Header>
9230 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9232 Header "X-Custom-Header: custom_value"
9234 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9236 Define which SSL protocol version must be used. By default C<libcurl> will
9237 attempt to figure out the remote SSL protocol version. See
9238 L<curl_easy_setopt(3)> for more details.
9240 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9242 Format of the output to generate. If set to B<Command>, will create output that
9243 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9244 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9245 , will create output in the KairosDB format.
9247 Defaults to B<Command>.
9249 =item B<Attribute> I<String> I<String>
9251 Only available for the KAIROSDB output format.
9253 Consider the two given strings to be the key and value of an additional tag for
9254 each metric being sent out.
9256 You can add multiple B<Attribute>.
9260 Only available for the KAIROSDB output format.
9262 Sets the Cassandra ttl for the data points.
9264 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9266 =item B<Metrics> B<true>|B<false>
9268 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9270 =item B<Notifications> B<false>|B<true>
9272 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9274 =item B<StoreRates> B<true|false>
9276 If set to B<true>, convert counter values to rates. If set to B<false> (the
9277 default) counter values are stored as is, i.e. as an increasing integer number.
9279 =item B<BufferSize> I<Bytes>
9281 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9282 requests will be generated, but more metrics will be batched / metrics are
9283 cached for longer before being sent, introducing additional delay until they
9284 are available on the server side. I<Bytes> must be at least 1024 and cannot
9285 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9286 Defaults to C<4096>.
9288 =item B<LowSpeedLimit> I<Bytes per Second>
9290 Sets the minimal transfer rate in I<Bytes per Second> below which the
9291 connection with the HTTP server will be considered too slow and aborted. All
9292 the data submitted over this connection will probably be lost. Defaults to 0,
9293 which means no minimum transfer rate is enforced.
9295 =item B<Timeout> I<Timeout>
9297 Sets the maximum time in milliseconds given for HTTP POST operations to
9298 complete. When this limit is reached, the POST operation will be aborted, and
9299 all the data in the current send buffer will probably be lost. Defaults to 0,
9300 which means the connection never times out.
9302 =item B<LogHttpError> B<false>|B<true>
9304 Enables printing of HTTP error code to log. Turned off by default.
9306 The C<write_http> plugin regularly submits the collected values to the HTTP
9307 server. How frequently this happens depends on how much data you are collecting
9308 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9309 slightly below this interval, which you can estimate by monitoring the network
9310 traffic between collectd and the HTTP server.
9314 =head2 Plugin C<write_kafka>
9316 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9320 <Plugin "write_kafka">
9321 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9327 The following options are understood by the I<write_kafka plugin>:
9331 =item E<lt>B<Topic> I<Name>E<gt>
9333 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9334 is given a unique I<Name> and specifies one kafka producer.
9335 Inside the B<Topic> block, the following per-topic options are
9340 =item B<Property> I<String> I<String>
9342 Configure the named property for the current topic. Properties are
9343 forwarded to the kafka producer library B<librdkafka>.
9345 =item B<Key> I<String>
9347 Use the specified string as a partitioning key for the topic. Kafka breaks
9348 topic into partitions and guarantees that for a given topology, the same
9349 consumer will be used for a specific key. The special (case insensitive)
9350 string B<Random> can be used to specify that an arbitrary partition should
9353 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9355 Selects the format in which messages are sent to the broker. If set to
9356 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9357 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9359 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9360 an easy and straight forward exchange format.
9362 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9363 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9365 =item B<StoreRates> B<true>|B<false>
9367 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9368 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9369 default), no conversion is performed. Otherwise the conversion is performed
9370 using the internal value cache.
9372 Please note that currently this option is only used if the B<Format> option has
9373 been set to B<JSON>.
9375 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9377 A prefix can be added in the metric name when outputting in the I<Graphite>
9378 format. It's added before the I<Host> name.
9380 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>>
9382 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9384 A postfix can be added in the metric name when outputting in the I<Graphite>
9385 format. It's added after the I<Host> name.
9387 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>>
9389 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9391 Specify a character to replace dots (.) in the host part of the metric name.
9392 In I<Graphite> metric name, dots are used as separators between different
9393 metric parts (host, plugin, type).
9394 Default is C<_> (I<Underscore>).
9396 =item B<GraphiteSeparateInstances> B<false>|B<true>
9398 If set to B<true>, the plugin instance and type instance will be in their own
9399 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9400 default), the plugin and plugin instance (and likewise the type and type
9401 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9403 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9405 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9406 identifier. If set to B<false> (the default), this is only done when there is
9409 =item B<GraphitePreserveSeparator> B<false>|B<true>
9411 If set to B<false> (the default) the C<.> (dot) character is replaced with
9412 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9413 is preserved, i.e. passed through.
9415 =item B<StoreRates> B<true>|B<false>
9417 If set to B<true> (the default), convert counter values to rates. If set to
9418 B<false> counter values are stored as is, i.e. as an increasing integer number.
9420 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9421 converted values will have "rate" appended to the data source type, e.g.
9422 C<ds_type:derive:rate>.
9426 =item B<Property> I<String> I<String>
9428 Configure the kafka producer through properties, you almost always will
9429 want to set B<metadata.broker.list> to your Kafka broker list.
9433 =head2 Plugin C<write_redis>
9435 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9439 <Plugin "write_redis">
9452 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9453 the timestamp as the score. Retrieving a date range can then be done using the
9454 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9455 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9456 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9457 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9458 with the B<Database> parameter (default is C<0>). See
9459 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9462 The information shown in the synopsis above is the I<default configuration>
9463 which is used by the plugin if no configuration is present.
9465 The plugin can send values to multiple instances of I<Redis> by specifying
9466 one B<Node> block for each instance. Within the B<Node> blocks, the following
9467 options are available:
9471 =item B<Node> I<Nodename>
9473 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9474 instance running on a specified host and port. The node name is a
9475 canonical identifier which is used as I<plugin instance>. It is limited to
9476 51E<nbsp>characters in length.
9478 =item B<Host> I<Hostname>
9480 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9483 =item B<Port> I<Port>
9485 The B<Port> option is the TCP port on which the Redis instance accepts
9486 connections. Either a service name of a port number may be given. Please note
9487 that numerical port numbers must be given as a string, too.
9489 =item B<Timeout> I<Milliseconds>
9491 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9493 =item B<Prefix> I<Prefix>
9495 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9496 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9497 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9498 is recommended but not required to include a trailing slash in I<Prefix>.
9500 =item B<Database> I<Index>
9502 This index selects the redis database to use for writing operations. Defaults
9505 =item B<MaxSetSize> I<Items>
9507 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9508 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9510 =item B<MaxSetDuration> I<Seconds>
9512 The B<MaxSetDuration> option limits the duration of items that the
9513 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9514 is the default behavior.
9516 =item B<StoreRates> B<true>|B<false>
9518 If set to B<true> (the default), convert counter values to rates. If set to
9519 B<false> counter values are stored as is, i.e. as an increasing integer number.
9523 =head2 Plugin C<write_riemann>
9525 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9526 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9527 I<Riemann> using UDP packets.
9531 <Plugin "write_riemann">
9537 AlwaysAppendDS false
9541 Attribute "foo" "bar"
9544 The following options are understood by the I<write_riemann plugin>:
9548 =item E<lt>B<Node> I<Name>E<gt>
9550 The plugin's configuration consists of one or more B<Node> blocks. Each block
9551 is given a unique I<Name> and specifies one connection to an instance of
9552 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9557 =item B<Host> I<Address>
9559 Hostname or address to connect to. Defaults to C<localhost>.
9561 =item B<Port> I<Service>
9563 Service name or port number to connect to. Defaults to C<5555>.
9565 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9567 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9570 =item B<TLSCertFile> I<Path>
9572 When using the B<TLS> protocol, path to a PEM certificate to present
9575 =item B<TLSCAFile> I<Path>
9577 When using the B<TLS> protocol, path to a PEM CA certificate to
9578 use to validate the remote hosts's identity.
9580 =item B<TLSKeyFile> I<Path>
9582 When using the B<TLS> protocol, path to a PEM private key associated
9583 with the certificate defined by B<TLSCertFile>.
9585 =item B<Batch> B<true>|B<false>
9587 If set to B<true> and B<Protocol> is set to B<TCP>,
9588 events will be batched in memory and flushed at
9589 regular intervals or when B<BatchMaxSize> is exceeded.
9591 Notifications are not batched and sent as soon as possible.
9593 When enabled, it can occur that events get processed by the Riemann server
9594 close to or after their expiration time. Tune the B<TTLFactor> and
9595 B<BatchMaxSize> settings according to the amount of values collected, if this
9600 =item B<BatchMaxSize> I<size>
9602 Maximum payload size for a riemann packet. Defaults to 8192
9604 =item B<BatchFlushTimeout> I<seconds>
9606 Maximum amount of seconds to wait in between to batch flushes.
9607 No timeout by default.
9609 =item B<StoreRates> B<true>|B<false>
9611 If set to B<true> (the default), convert counter values to rates. If set to
9612 B<false> counter values are stored as is, i.e. as an increasing integer number.
9614 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9615 converted values will have "rate" appended to the data source type, e.g.
9616 C<ds_type:derive:rate>.
9618 =item B<AlwaysAppendDS> B<false>|B<true>
9620 If set to B<true>, append the name of the I<Data Source> (DS) to the
9621 "service", i.e. the field that, together with the "host" field, uniquely
9622 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9623 only done when there is more than one DS.
9625 =item B<TTLFactor> I<Factor>
9627 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9628 event is considered active. I<collectd> populates this field based on the
9629 metrics interval setting. This setting controls the factor with which the
9630 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9631 know exactly what you're doing, you should only increase this setting from its
9634 =item B<Notifications> B<false>|B<true>
9636 If set to B<true>, create riemann events for notifications. This is B<true>
9637 by default. When processing thresholds from write_riemann, it might prove
9638 useful to avoid getting notification events.
9640 =item B<CheckThresholds> B<false>|B<true>
9642 If set to B<true>, attach state to events based on thresholds defined
9643 in the B<Threshold> plugin. Defaults to B<false>.
9645 =item B<EventServicePrefix> I<String>
9647 Add the given string as a prefix to the event service name.
9648 If B<EventServicePrefix> not set or set to an empty string (""),
9649 no prefix will be used.
9653 =item B<Tag> I<String>
9655 Add the given string as an additional tag to the metric being sent to
9658 =item B<Attribute> I<String> I<String>
9660 Consider the two given strings to be the key and value of an additional
9661 attribute for each metric being sent out to I<Riemann>.
9665 =head2 Plugin C<write_sensu>
9667 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9668 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9669 a local I<Sensu> client using a TCP socket.
9671 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9672 parameter so it is not possible to use one collectd instance as a gateway for
9673 others. Each collectd host must pair with one I<Sensu> client.
9677 <Plugin "write_sensu">
9682 AlwaysAppendDS false
9683 MetricHandler "influx"
9684 MetricHandler "default"
9685 NotificationHandler "flapjack"
9686 NotificationHandler "howling_monkey"
9690 Attribute "foo" "bar"
9693 The following options are understood by the I<write_sensu plugin>:
9697 =item E<lt>B<Node> I<Name>E<gt>
9699 The plugin's configuration consists of one or more B<Node> blocks. Each block
9700 is given a unique I<Name> and specifies one connection to an instance of
9701 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9706 =item B<Host> I<Address>
9708 Hostname or address to connect to. Defaults to C<localhost>.
9710 =item B<Port> I<Service>
9712 Service name or port number to connect to. Defaults to C<3030>.
9714 =item B<StoreRates> B<true>|B<false>
9716 If set to B<true> (the default), convert counter values to rates. If set to
9717 B<false> counter values are stored as is, i.e. as an increasing integer number.
9719 This will be reflected in the C<collectd_data_source_type> tag: If
9720 B<StoreRates> is enabled, converted values will have "rate" appended to the
9721 data source type, e.g. C<collectd_data_source_type:derive:rate>.
9723 =item B<AlwaysAppendDS> B<false>|B<true>
9725 If set the B<true>, append the name of the I<Data Source> (DS) to the
9726 "service", i.e. the field that, together with the "host" field, uniquely
9727 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9728 only done when there is more than one DS.
9730 =item B<Notifications> B<false>|B<true>
9732 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9733 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9735 =item B<Metrics> B<false>|B<true>
9737 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9738 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9741 =item B<Separator> I<String>
9743 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9745 =item B<MetricHandler> I<String>
9747 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9748 several of them, one per line. Defaults to no handler.
9750 =item B<NotificationHandler> I<String>
9752 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9753 add several of them, one per line. Defaults to no handler.
9755 =item B<EventServicePrefix> I<String>
9757 Add the given string as a prefix to the event service name.
9758 If B<EventServicePrefix> not set or set to an empty string (""),
9759 no prefix will be used.
9763 =item B<Tag> I<String>
9765 Add the given string as an additional tag to the metric being sent to
9768 =item B<Attribute> I<String> I<String>
9770 Consider the two given strings to be the key and value of an additional
9771 attribute for each metric being sent out to I<Sensu>.
9775 =head2 Plugin C<xencpu>
9777 This plugin collects metrics of hardware CPU load for machine running Xen
9778 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9779 Result is reported using the C<percent> type, for each CPU (core).
9781 This plugin doesn't have any options (yet).
9783 =head2 Plugin C<zookeeper>
9785 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9786 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9791 <Plugin "zookeeper">
9798 =item B<Host> I<Address>
9800 Hostname or address to connect to. Defaults to C<localhost>.
9802 =item B<Port> I<Service>
9804 Service name or port number to connect to. Defaults to C<2181>.
9808 =head1 THRESHOLD CONFIGURATION
9810 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9811 we mean that the values are not only stored or sent somewhere, but that they
9812 are judged and, if a problem is recognized, acted upon. The only action
9813 collectd takes itself is to generate and dispatch a "notification". Plugins can
9814 register to receive notifications and perform appropriate further actions.
9816 Since systems and what you expect them to do differ a lot, you can configure
9817 B<thresholds> for your values freely. This gives you a lot of flexibility but
9818 also a lot of responsibility.
9820 Every time a value is out of range a notification is dispatched. This means
9821 that the idle percentage of your CPU needs to be less then the configured
9822 threshold only once for a notification to be generated. There's no such thing
9823 as a moving average or similar - at least not now.
9825 Also, all values that match a threshold are considered to be relevant or
9826 "interesting". As a consequence collectd will issue a notification if they are
9827 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9828 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9829 "2" (the default) and some hosts sends it's CPU statistics to the server every
9830 60 seconds, a notification will be dispatched after about 120 seconds. It may
9831 take a little longer because the timeout is checked only once each B<Interval>
9834 When a value comes within range again or is received after it was missing, an
9835 "OKAY-notification" is dispatched.
9837 Here is a configuration example to get you started. Read below for more
9850 <Plugin "interface">
9867 WarningMin 100000000
9873 There are basically two types of configuration statements: The C<Host>,
9874 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
9875 configured. The C<Plugin> and C<Type> blocks may be specified further using the
9876 C<Instance> option. You can combine the block by nesting the blocks, though
9877 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
9878 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
9879 C<Type> may not contain other blocks. If multiple blocks apply to the same
9880 value the most specific block is used.
9882 The other statements specify the threshold to configure. They B<must> be
9883 included in a C<Type> block. Currently the following statements are recognized:
9887 =item B<FailureMax> I<Value>
9889 =item B<WarningMax> I<Value>
9891 Sets the upper bound of acceptable values. If unset defaults to positive
9892 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
9893 will be created. If the value is greater than B<WarningMax> but less than (or
9894 equal to) B<FailureMax> a B<WARNING> notification will be created.
9896 =item B<FailureMin> I<Value>
9898 =item B<WarningMin> I<Value>
9900 Sets the lower bound of acceptable values. If unset defaults to negative
9901 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
9902 be created. If the value is less than B<WarningMin> but greater than (or equal
9903 to) B<FailureMin> a B<WARNING> notification will be created.
9905 =item B<DataSource> I<DSName>
9907 Some data sets have more than one "data source". Interesting examples are the
9908 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
9909 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
9910 system load data set, C<load>, even has three data sources: C<shortterm>,
9911 C<midterm>, and C<longterm>.
9913 Normally, all data sources are checked against a configured threshold. If this
9914 is undesirable, or if you want to specify different limits for each data
9915 source, you can use the B<DataSource> option to have a threshold apply only to
9918 =item B<Invert> B<true>|B<false>
9920 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
9921 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
9922 B<WarningMax>) are not okay. Defaults to B<false>.
9924 =item B<Persist> B<true>|B<false>
9926 Sets how often notifications are generated. If set to B<true> one notification
9927 will be generated for each value that is out of the acceptable range. If set to
9928 B<false> (the default) then a notification is only generated if a value is out
9929 of range but the previous value was okay.
9931 This applies to missing values, too: If set to B<true> a notification about a
9932 missing value is generated once every B<Interval> seconds. If set to B<false>
9933 only one such notification is generated until the value appears again.
9935 =item B<Percentage> B<true>|B<false>
9937 If set to B<true>, the minimum and maximum values given are interpreted as
9938 percentage value, relative to the other data sources. This is helpful for
9939 example for the "df" type, where you may want to issue a warning when less than
9940 5E<nbsp>% of the total space is available. Defaults to B<false>.
9942 =item B<Hits> I<Number>
9944 Delay creating the notification until the threshold has been passed I<Number>
9945 times. When a notification has been generated, or when a subsequent value is
9946 inside the threshold, the counter is reset. If, for example, a value is
9947 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
9948 will be dispatched at most once every 30E<nbsp>seconds.
9950 This is useful when short bursts are not a problem. If, for example, 100% CPU
9951 usage for up to a minute is normal (and data is collected every
9952 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
9954 =item B<Hysteresis> I<Number>
9956 When set to non-zero, a hysteresis value is applied when checking minimum and
9957 maximum bounds. This is useful for values that increase slowly and fluctuate a
9958 bit while doing so. When these values come close to the threshold, they may
9959 "flap", i.e. switch between failure / warning case and okay case repeatedly.
9961 If, for example, the threshold is configures as
9966 then a I<Warning> notification is created when the value exceeds I<101> and the
9967 corresponding I<Okay> notification is only created once the value falls below
9968 I<99>, thus avoiding the "flapping".
9972 =head1 FILTER CONFIGURATION
9974 Starting with collectd 4.6 there is a powerful filtering infrastructure
9975 implemented in the daemon. The concept has mostly been copied from
9976 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
9977 terminology, so that users that are familiar with iptables feel right at home.
9981 The following are the terms used in the remainder of the filter configuration
9982 documentation. For an ASCII-art schema of the mechanism, see
9983 L<"General structure"> below.
9989 A I<match> is a criteria to select specific values. Examples are, of course, the
9990 name of the value or it's current value.
9992 Matches are implemented in plugins which you have to load prior to using the
9993 match. The name of such plugins starts with the "match_" prefix.
9997 A I<target> is some action that is to be performed with data. Such actions
9998 could, for example, be to change part of the value's identifier or to ignore
9999 the value completely.
10001 Some of these targets are built into the daemon, see L<"Built-in targets">
10002 below. Other targets are implemented in plugins which you have to load prior to
10003 using the target. The name of such plugins starts with the "target_" prefix.
10007 The combination of any number of matches and at least one target is called a
10008 I<rule>. The target actions will be performed for all values for which B<all>
10009 matches apply. If the rule does not have any matches associated with it, the
10010 target action will be performed for all values.
10014 A I<chain> is a list of rules and possibly default targets. The rules are tried
10015 in order and if one matches, the associated target will be called. If a value
10016 is handled by a rule, it depends on the target whether or not any subsequent
10017 rules are considered or if traversal of the chain is aborted, see
10018 L<"Flow control"> below. After all rules have been checked, the default targets
10023 =head2 General structure
10025 The following shows the resulting structure:
10032 +---------+ +---------+ +---------+ +---------+
10033 ! Rule !->! Match !->! Match !->! Target !
10034 +---------+ +---------+ +---------+ +---------+
10037 +---------+ +---------+ +---------+
10038 ! Rule !->! Target !->! Target !
10039 +---------+ +---------+ +---------+
10046 +---------+ +---------+ +---------+
10047 ! Rule !->! Match !->! Target !
10048 +---------+ +---------+ +---------+
10056 =head2 Flow control
10058 There are four ways to control which way a value takes through the filter
10065 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10066 process the value with another chain. When the called chain finishes, usually
10067 the next target or rule after the jump is executed.
10071 The stop condition, signaled for example by the built-in target B<stop>, causes
10072 all processing of the value to be stopped immediately.
10076 Causes processing in the current chain to be aborted, but processing of the
10077 value generally will continue. This means that if the chain was called via
10078 B<Jump>, the next target or rule after the jump will be executed. If the chain
10079 was not called by another chain, control will be returned to the daemon and it
10080 may pass the value to another chain.
10084 Most targets will signal the B<continue> condition, meaning that processing
10085 should continue normally. There is no special built-in target for this
10092 The configuration reflects this structure directly:
10094 PostCacheChain "PostCache"
10095 <Chain "PostCache">
10096 <Rule "ignore_mysql_show">
10099 Type "^mysql_command$"
10100 TypeInstance "^show_"
10110 The above configuration example will ignore all values where the plugin field
10111 is "mysql", the type is "mysql_command" and the type instance begins with
10112 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10113 default target of the chain. Since this chain is run after the value has been
10114 added to the cache, the MySQL C<show_*> command statistics will be available
10115 via the C<unixsock> plugin.
10117 =head2 List of configuration options
10121 =item B<PreCacheChain> I<ChainName>
10123 =item B<PostCacheChain> I<ChainName>
10125 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10126 argument is the name of a I<chain> that should be executed before and/or after
10127 the values have been added to the cache.
10129 To understand the implications, it's important you know what is going on inside
10130 I<collectd>. The following diagram shows how values are passed from the
10131 read-plugins to the write-plugins:
10137 + - - - - V - - - - +
10138 : +---------------+ :
10141 : +-------+-------+ :
10144 : +-------+-------+ : +---------------+
10145 : ! Cache !--->! Value Cache !
10146 : ! insert ! : +---+---+-------+
10147 : +-------+-------+ : ! !
10148 : ! ,------------' !
10150 : +-------+---+---+ : +-------+-------+
10151 : ! Post-Cache +--->! Write-Plugins !
10152 : ! Chain ! : +---------------+
10153 : +---------------+ :
10155 : dispatch values :
10156 + - - - - - - - - - +
10158 After the values are passed from the "read" plugins to the dispatch functions,
10159 the pre-cache chain is run first. The values are added to the internal cache
10160 afterwards. The post-cache chain is run after the values have been added to the
10161 cache. So why is it such a huge deal if chains are run before or after the
10162 values have been added to this cache?
10164 Targets that change the identifier of a value list should be executed before
10165 the values are added to the cache, so that the name in the cache matches the
10166 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10167 this cache to receive a list of all available values. If you change the
10168 identifier after the value list has been added to the cache, this may easily
10169 lead to confusion, but it's not forbidden of course.
10171 The cache is also used to convert counter values to rates. These rates are, for
10172 example, used by the C<value> match (see below). If you use the rate stored in
10173 the cache B<before> the new value is added, you will use the old, B<previous>
10174 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10175 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10178 Last but not last, the B<stop> target makes a difference: If the pre-cache
10179 chain returns the stop condition, the value will not be added to the cache and
10180 the post-cache chain will not be run.
10182 =item B<Chain> I<Name>
10184 Adds a new chain with a certain name. This name can be used to refer to a
10185 specific chain, for example to jump to it.
10187 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10189 =item B<Rule> [I<Name>]
10191 Adds a new rule to the current chain. The name of the rule is optional and
10192 currently has no meaning for the daemon.
10194 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10195 must be at least one B<Target> block.
10197 =item B<Match> I<Name>
10199 Adds a match to a B<Rule> block. The name specifies what kind of match should
10200 be performed. Available matches depend on the plugins that have been loaded.
10202 The arguments inside the B<Match> block are passed to the plugin implementing
10203 the match, so which arguments are valid here depends on the plugin being used.
10204 If you do not need any to pass any arguments to a match, you can use the
10209 Which is equivalent to:
10214 =item B<Target> I<Name>
10216 Add a target to a rule or a default target to a chain. The name specifies what
10217 kind of target is to be added. Which targets are available depends on the
10218 plugins being loaded.
10220 The arguments inside the B<Target> block are passed to the plugin implementing
10221 the target, so which arguments are valid here depends on the plugin being used.
10222 If you do not need any to pass any arguments to a target, you can use the
10227 This is the same as writing:
10234 =head2 Built-in targets
10236 The following targets are built into the core daemon and therefore need no
10237 plugins to be loaded:
10243 Signals the "return" condition, see the L<"Flow control"> section above. This
10244 causes the current chain to stop processing the value and returns control to
10245 the calling chain. The calling chain will continue processing targets and rules
10246 just after the B<jump> target (see below). This is very similar to the
10247 B<RETURN> target of iptables, see L<iptables(8)>.
10249 This target does not have any options.
10257 Signals the "stop" condition, see the L<"Flow control"> section above. This
10258 causes processing of the value to be aborted immediately. This is similar to
10259 the B<DROP> target of iptables, see L<iptables(8)>.
10261 This target does not have any options.
10269 Sends the value to "write" plugins.
10275 =item B<Plugin> I<Name>
10277 Name of the write plugin to which the data should be sent. This option may be
10278 given multiple times to send the data to more than one write plugin. If the
10279 plugin supports multiple instances, the plugin's instance(s) must also be
10284 If no plugin is explicitly specified, the values will be sent to all available
10287 Single-instance plugin example:
10293 Multi-instance plugin example:
10295 <Plugin "write_graphite">
10305 Plugin "write_graphite/foo"
10310 Starts processing the rules of another chain, see L<"Flow control"> above. If
10311 the end of that chain is reached, or a stop condition is encountered,
10312 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10313 next target or the next rule. This is similar to the B<-j> command line option
10314 of iptables, see L<iptables(8)>.
10320 =item B<Chain> I<Name>
10322 Jumps to the chain I<Name>. This argument is required and may appear only once.
10334 =head2 Available matches
10340 Matches a value using regular expressions.
10346 =item B<Host> I<Regex>
10348 =item B<Plugin> I<Regex>
10350 =item B<PluginInstance> I<Regex>
10352 =item B<Type> I<Regex>
10354 =item B<TypeInstance> I<Regex>
10356 =item B<MetaData> I<String> I<Regex>
10358 Match values where the given regular expressions match the various fields of
10359 the identifier of a value. If multiple regular expressions are given, B<all>
10360 regexen must match for a value to match.
10362 =item B<Invert> B<false>|B<true>
10364 When set to B<true>, the result of the match is inverted, i.e. all value lists
10365 where all regular expressions apply are not matched, all other value lists are
10366 matched. Defaults to B<false>.
10373 Host "customer[0-9]+"
10379 Matches values that have a time which differs from the time on the server.
10381 This match is mainly intended for servers that receive values over the
10382 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10383 is very sensitive to the timestamp used when updating the RRD files. In
10384 particular, the time must be ever increasing. If a misbehaving client sends one
10385 packet with a timestamp far in the future, all further packets with a correct
10386 time will be ignored because of that one packet. What's worse, such corrupted
10387 RRD files are hard to fix.
10389 This match lets one match all values B<outside> a specified time range
10390 (relative to the server's time), so you can use the B<stop> target (see below)
10391 to ignore the value, for example.
10397 =item B<Future> I<Seconds>
10399 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10400 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10403 =item B<Past> I<Seconds>
10405 Matches all values that are I<behind> of the server's time by I<Seconds> or
10406 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10418 This example matches all values that are five minutes or more ahead of the
10419 server or one hour (or more) lagging behind.
10423 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10424 values. If a data-set consists of more than one data-source, all data-sources
10425 must match the specified ranges for a positive match.
10431 =item B<Min> I<Value>
10433 Sets the smallest value which still results in a match. If unset, behaves like
10436 =item B<Max> I<Value>
10438 Sets the largest value which still results in a match. If unset, behaves like
10441 =item B<Invert> B<true>|B<false>
10443 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10444 no-match is returned and vice versa. Please note that the B<Invert> setting
10445 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10446 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10448 =item B<DataSource> I<DSName> [I<DSName> ...]
10450 Select one or more of the data sources. If no data source is configured, all
10451 data sources will be checked. If the type handled by the match does not have a
10452 data source of the specified name(s), this will always result in no match
10453 (independent of the B<Invert> setting).
10455 =item B<Satisfy> B<Any>|B<All>
10457 Specifies how checking with several data sources is performed. If set to
10458 B<Any>, the match succeeds if one of the data sources is in the configured
10459 range. If set to B<All> the match only succeeds if all data sources are within
10460 the configured range. Default is B<All>.
10462 Usually B<All> is used for positive matches, B<Any> is used for negative
10463 matches. This means that with B<All> you usually check that all values are in a
10464 "good" range, while with B<Any> you check if any value is within a "bad" range
10465 (or outside the "good" range).
10469 Either B<Min> or B<Max>, but not both, may be unset.
10473 # Match all values smaller than or equal to 100. Matches only if all data
10474 # sources are below 100.
10480 # Match if the value of any data source is outside the range of 0 - 100.
10488 =item B<empty_counter>
10490 Matches all values with one or more data sources of type B<COUNTER> and where
10491 all counter values are zero. These counters usually I<never> increased since
10492 they started existing (and are therefore uninteresting), or got reset recently
10493 or overflowed and you had really, I<really> bad luck.
10495 Please keep in mind that ignoring such counters can result in confusing
10496 behavior: Counters which hardly ever increase will be zero for long periods of
10497 time. If the counter is reset for some reason (machine or service restarted,
10498 usually), the graph will be empty (NAN) for a long time. People may not
10503 Calculates a hash value of the host name and matches values according to that
10504 hash value. This makes it possible to divide all hosts into groups and match
10505 only values that are in a specific group. The intended use is in load
10506 balancing, where you want to handle only part of all data and leave the rest
10509 The hashing function used tries to distribute the hosts evenly. First, it
10510 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10513 for (i = 0; host[i] != 0; i++)
10514 hash_value = (hash_value * 251) + host[i];
10516 The constant 251 is a prime number which is supposed to make this hash value
10517 more random. The code then checks the group for this host according to the
10518 I<Total> and I<Match> arguments:
10520 if ((hash_value % Total) == Match)
10525 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10526 groups), then the least significant bit of the hash value will be the XOR of
10527 all least significant bits in the host name. One consequence is that when you
10528 have two hosts, "server0.example.com" and "server1.example.com", where the host
10529 name differs in one digit only and the digits differ by one, those hosts will
10530 never end up in the same group.
10536 =item B<Match> I<Match> I<Total>
10538 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10539 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10540 be smaller than I<Total>. I<Total> must be at least one, although only values
10541 greater than one really do make any sense.
10543 You can repeat this option to match multiple groups, for example:
10548 The above config will divide the data into seven groups and match groups three
10549 and five. One use would be to keep every value on two hosts so that if one
10550 fails the missing data can later be reconstructed from the second host.
10556 # Operate on the pre-cache chain, so that ignored values are not even in the
10561 # Divide all received hosts in seven groups and accept all hosts in
10565 # If matched: Return and continue.
10568 # If not matched: Return and stop.
10574 =head2 Available targets
10578 =item B<notification>
10580 Creates and dispatches a notification.
10586 =item B<Message> I<String>
10588 This required option sets the message of the notification. The following
10589 placeholders will be replaced by an appropriate value:
10597 =item B<%{plugin_instance}>
10601 =item B<%{type_instance}>
10603 These placeholders are replaced by the identifier field of the same name.
10605 =item B<%{ds:>I<name>B<}>
10607 These placeholders are replaced by a (hopefully) human readable representation
10608 of the current rate of this data source. If you changed the instance name
10609 (using the B<set> or B<replace> targets, see below), it may not be possible to
10610 convert counter values to rates.
10614 Please note that these placeholders are B<case sensitive>!
10616 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10618 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10625 <Target "notification">
10626 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10632 Replaces parts of the identifier using regular expressions.
10638 =item B<Host> I<Regex> I<Replacement>
10640 =item B<Plugin> I<Regex> I<Replacement>
10642 =item B<PluginInstance> I<Regex> I<Replacement>
10644 =item B<TypeInstance> I<Regex> I<Replacement>
10646 =item B<MetaData> I<String> I<Regex> I<Replacement>
10648 =item B<DeleteMetaData> I<String> I<Regex>
10650 Match the appropriate field with the given regular expression I<Regex>. If the
10651 regular expression matches, that part that matches is replaced with
10652 I<Replacement>. If multiple places of the input buffer match a given regular
10653 expression, only the first occurrence will be replaced.
10655 You can specify each option multiple times to use multiple regular expressions
10663 # Replace "example.net" with "example.com"
10664 Host "\\<example.net\\>" "example.com"
10666 # Strip "www." from hostnames
10667 Host "\\<www\\." ""
10672 Sets part of the identifier of a value to a given string.
10678 =item B<Host> I<String>
10680 =item B<Plugin> I<String>
10682 =item B<PluginInstance> I<String>
10684 =item B<TypeInstance> I<String>
10686 =item B<MetaData> I<String> I<String>
10688 Set the appropriate field to the given string. The strings for plugin instance,
10689 type instance, and meta data may be empty, the strings for host and plugin may
10690 not be empty. It's currently not possible to set the type of a value this way.
10692 The following placeholders will be replaced by an appropriate value:
10700 =item B<%{plugin_instance}>
10704 =item B<%{type_instance}>
10706 These placeholders are replaced by the identifier field of the same name.
10708 =item B<%{meta:>I<name>B<}>
10710 These placeholders are replaced by the meta data value with the given name.
10714 Please note that these placeholders are B<case sensitive>!
10716 =item B<DeleteMetaData> I<String>
10718 Delete the named meta data field.
10725 PluginInstance "coretemp"
10726 TypeInstance "core3"
10731 =head2 Backwards compatibility
10733 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10734 B<Chain> block, it will behave as it used to. This is equivalent to the
10735 following configuration:
10737 <Chain "PostCache">
10741 If you specify a B<PostCacheChain>, the B<write> target will not be added
10742 anywhere and you will have to make sure that it is called where appropriate. We
10743 suggest to add the above snippet as default target to your "PostCache" chain.
10747 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10762 B<Ignorelists> are a generic framework to either ignore some metrics or report
10763 specific metircs only. Plugins usually provide one or more options to specify
10764 the items (mounts points, devices, ...) and the boolean option
10769 =item B<Select> I<String>
10771 Selects the item I<String>. This option often has a plugin specific name, e.g.
10772 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10773 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10774 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10776 By default, this option is doing a case-sensitive full-string match. The
10777 following config will match C<foo>, but not C<Foo>:
10781 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10782 I<regular expression>. For example, so match all item starting with C<foo>, use
10783 could use the following syntax:
10787 The regular expression is I<not> anchored, i.e. the following config will match
10788 C<foobar>, C<barfoo> and C<AfooZ>:
10792 The B<Select> option may be repeated to select multiple items.
10794 =item B<IgnoreSelected> B<true>|B<false>
10796 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10797 collected. If set to B<false>, matching metrics are I<collected> and all other
10798 metrics are ignored.
10805 L<collectd-exec(5)>,
10806 L<collectd-perl(5)>,
10807 L<collectd-unixsock(5)>,
10820 Florian Forster E<lt>octo@collectd.orgE<gt>