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 =item B<IgnoreSelected> B<true>|B<false>
1377 Invert the selection: If set to true, all cgroups I<except> the ones that
1378 match any one of the criteria are collected. By default only selected
1379 cgroups are collected if a selection is made. If no selection is configured
1380 at all, B<all> cgroups are selected.
1384 =head2 Plugin C<chrony>
1386 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1387 skew and per-peer stratum.
1389 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1392 Available configuration options for the C<chrony> plugin:
1396 =item B<Host> I<Hostname>
1398 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1400 =item B<Port> I<Port>
1402 UDP-Port to connect to. Defaults to B<323>.
1404 =item B<Timeout> I<Timeout>
1406 Connection timeout in seconds. Defaults to B<2>.
1410 =head2 Plugin C<conntrack>
1412 This plugin collects IP conntrack statistics.
1418 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1419 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1423 =head2 Plugin C<cpu>
1425 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1426 as Jiffies, using the C<cpu> type. Two aggregations are available:
1432 Sum, per-state, over all CPUs installed in the system; and
1436 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1440 The two aggregations can be combined, leading to I<collectd> only emitting a
1441 single "active" metric for the entire system. As soon as one of these
1442 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1443 rather than Jiffies. In addition, you can request individual, per-state,
1444 per-CPU metrics to be reported as percentage.
1446 The following configuration options are available:
1450 =item B<ReportByState> B<true>|B<false>
1452 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1454 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1457 =item B<ReportByCpu> B<true>|B<false>
1459 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1460 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1461 global sum of CPU states is emitted.
1463 =item B<ValuesPercentage> B<false>|B<true>
1465 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1466 are set to B<true>. In this case, by default, metrics will be reported as
1467 Jiffies. By setting this option to B<true>, you can request percentage values
1468 in the un-aggregated (per-CPU, per-state) mode as well.
1470 =item B<ReportNumCpu> B<false>|B<true>
1472 When set to B<true>, reports the number of available CPUs.
1473 Defaults to B<false>.
1477 =head2 Plugin C<cpufreq>
1479 This plugin doesn't have any options. It reads
1480 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1481 installed) to get the current CPU frequency. If this file does not exist make
1482 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1483 installed and an "cpu governor" (that's a kernel module) is loaded.
1485 =head2 Plugin C<cpusleep>
1487 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1488 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1489 BOOTTIME clock increments while device is suspended and MONOTONIC
1490 clock does not, the derivative of the difference between these clocks
1491 gives the relative amount of time the device has spent in suspend
1492 state. The recorded value is in milliseconds of sleep per seconds of
1495 =head2 Plugin C<csv>
1499 =item B<DataDir> I<Directory>
1501 Set the directory to store CSV-files under. Per default CSV-files are generated
1502 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1503 The special strings B<stdout> and B<stderr> can be used to write to the standard
1504 output and standard error channels, respectively. This, of course, only makes
1505 much sense when collectd is running in foreground- or non-daemon-mode.
1507 =item B<StoreRates> B<true|false>
1509 If set to B<true>, convert counter values to rates. If set to B<false> (the
1510 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1515 =head2 cURL Statistics
1517 All cURL-based plugins support collection of generic, request-based
1518 statistics. These are disabled by default and can be enabled selectively for
1519 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1520 the documentation of those plugins for specific information. This section
1521 describes the available metrics that can be configured for each plugin. All
1522 options are disabled by default.
1524 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1528 =item B<TotalTime> B<true|false>
1530 Total time of the transfer, including name resolving, TCP connect, etc.
1532 =item B<NamelookupTime> B<true|false>
1534 Time it took from the start until name resolving was completed.
1536 =item B<ConnectTime> B<true|false>
1538 Time it took from the start until the connect to the remote host (or proxy)
1541 =item B<AppconnectTime> B<true|false>
1543 Time it took from the start until the SSL/SSH connect/handshake to the remote
1546 =item B<PretransferTime> B<true|false>
1548 Time it took from the start until just before the transfer begins.
1550 =item B<StarttransferTime> B<true|false>
1552 Time it took from the start until the first byte was received.
1554 =item B<RedirectTime> B<true|false>
1556 Time it took for all redirection steps include name lookup, connect,
1557 pre-transfer and transfer before final transaction was started.
1559 =item B<RedirectCount> B<true|false>
1561 The total number of redirections that were actually followed.
1563 =item B<SizeUpload> B<true|false>
1565 The total amount of bytes that were uploaded.
1567 =item B<SizeDownload> B<true|false>
1569 The total amount of bytes that were downloaded.
1571 =item B<SpeedDownload> B<true|false>
1573 The average download speed that curl measured for the complete download.
1575 =item B<SpeedUpload> B<true|false>
1577 The average upload speed that curl measured for the complete upload.
1579 =item B<HeaderSize> B<true|false>
1581 The total size of all the headers received.
1583 =item B<RequestSize> B<true|false>
1585 The total size of the issued requests.
1587 =item B<ContentLengthDownload> B<true|false>
1589 The content-length of the download.
1591 =item B<ContentLengthUpload> B<true|false>
1593 The specified size of the upload.
1595 =item B<NumConnects> B<true|false>
1597 The number of new connections that were created to achieve the transfer.
1601 =head2 Plugin C<curl>
1603 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1604 and the match infrastructure (the same code used by the tail plugin) to use
1605 regular expressions with the received data.
1607 The following example will read the current value of AMD stock from Google's
1608 finance page and dispatch the value to collectd.
1611 <Page "stock_quotes">
1612 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1618 CACert "/path/to/ca.crt"
1619 Header "X-Custom-Header: foobar"
1622 MeasureResponseTime false
1623 MeasureResponseCode false
1626 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1627 DSType "GaugeAverage"
1628 # Note: `stock_value' is not a standard type.
1635 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1636 a web page and one or more "matches" to be performed on the returned data. The
1637 string argument to the B<Page> block is used as plugin instance.
1639 The following options are valid within B<Page> blocks:
1645 URL of the web site to retrieve. Since a regular expression will be used to
1646 extract information from this data, non-binary data is a big plus here ;)
1648 =item B<User> I<Name>
1650 Username to use if authorization is required to read the page.
1652 =item B<Password> I<Password>
1654 Password to use if authorization is required to read the page.
1656 =item B<Digest> B<true>|B<false>
1658 Enable HTTP digest authentication.
1660 =item B<VerifyPeer> B<true>|B<false>
1662 Enable or disable peer SSL certificate verification. See
1663 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1665 =item B<VerifyHost> B<true>|B<false>
1667 Enable or disable peer host name verification. If enabled, the plugin checks if
1668 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1669 matches the host name provided by the B<URL> option. If this identity check
1670 fails, the connection is aborted. Obviously, only works when connecting to a
1671 SSL enabled server. Enabled by default.
1673 =item B<CACert> I<file>
1675 File that holds one or more SSL certificates. If you want to use HTTPS you will
1676 possibly need this option. What CA certificates come bundled with C<libcurl>
1677 and are checked by default depends on the distribution you use.
1679 =item B<Header> I<Header>
1681 A HTTP header to add to the request. Multiple headers are added if this option
1682 is specified more than once.
1684 =item B<Post> I<Body>
1686 Specifies that the HTTP operation should be a POST instead of a GET. The
1687 complete data to be posted is given as the argument. This option will usually
1688 need to be accompanied by a B<Header> option to set an appropriate
1689 C<Content-Type> for the post body (e.g. to
1690 C<application/x-www-form-urlencoded>).
1692 =item B<MeasureResponseTime> B<true>|B<false>
1694 Measure response time for the request. If this setting is enabled, B<Match>
1695 blocks (see below) are optional. Disabled by default.
1697 Beware that requests will get aborted if they take too long to complete. Adjust
1698 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1701 This option is similar to enabling the B<TotalTime> statistic but it's
1702 measured by collectd instead of cURL.
1704 =item B<MeasureResponseCode> B<true>|B<false>
1706 Measure response code for the request. If this setting is enabled, B<Match>
1707 blocks (see below) are optional. Disabled by default.
1709 =item B<E<lt>StatisticsE<gt>>
1711 One B<Statistics> block can be used to specify cURL statistics to be collected
1712 for each request to the remote web site. See the section "cURL Statistics"
1713 above for details. If this setting is enabled, B<Match> blocks (see below) are
1716 =item B<E<lt>MatchE<gt>>
1718 One or more B<Match> blocks that define how to match information in the data
1719 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1720 used by the C<tail> plugin, so please see the documentation of the C<tail>
1721 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1722 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1725 =item B<Timeout> I<Milliseconds>
1727 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1728 milliseconds. By default, the configured B<Interval> is used to set the
1729 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1730 indefinitely. This legacy behaviour can be achieved by setting the value of
1733 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1734 network connection will stall one read thread. Adjust the B<ReadThreads> global
1735 setting accordingly to prevent this from blocking other plugins.
1739 =head2 Plugin C<curl_json>
1741 The B<curl_json plugin> collects values from JSON data to be parsed by
1742 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1743 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1744 unix socket. The former can be used, for example, to collect values
1745 from CouchDB documents (which are stored JSON notation), and the
1746 latter to collect values from a uWSGI stats socket.
1748 The following example will collect several values from the built-in
1749 C<_stats> runtime statistics module of I<CouchDB>
1750 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1753 <URL "http://localhost:5984/_stats">
1755 <Key "httpd/requests/count">
1756 Type "http_requests"
1759 <Key "httpd_request_methods/*/count">
1760 Type "http_request_methods"
1763 <Key "httpd_status_codes/*/count">
1764 Type "http_response_codes"
1769 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1772 <Sock "/var/run/uwsgi.stats.sock">
1774 <Key "workers/*/requests">
1775 Type "http_requests"
1778 <Key "workers/*/apps/*/requests">
1779 Type "http_requests"
1784 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1785 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1786 blocks defining a unix socket to read JSON from directly. Each of
1787 these blocks may have one or more B<Key> blocks.
1789 The B<Key> string argument must be in a path format. Each component is
1790 used to match the key from a JSON map or the index of an JSON
1791 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1792 values for all map keys or array indices will be collectd.
1794 The following options are valid within B<URL> blocks:
1798 =item B<Host> I<Name>
1800 Use I<Name> as the host name when submitting values. Defaults to the global
1803 =item B<Instance> I<Instance>
1805 Sets the plugin instance to I<Instance>.
1807 =item B<Interval> I<Interval>
1809 Sets the interval (in seconds) in which the values will be collected from this
1810 URL. By default the global B<Interval> setting will be used.
1812 =item B<User> I<Name>
1814 =item B<Password> I<Password>
1816 =item B<Digest> B<true>|B<false>
1818 =item B<VerifyPeer> B<true>|B<false>
1820 =item B<VerifyHost> B<true>|B<false>
1822 =item B<CACert> I<file>
1824 =item B<Header> I<Header>
1826 =item B<Post> I<Body>
1828 =item B<Timeout> I<Milliseconds>
1830 These options behave exactly equivalent to the appropriate options of the
1831 I<cURL> plugin. Please see there for a detailed description.
1833 =item B<E<lt>StatisticsE<gt>>
1835 One B<Statistics> block can be used to specify cURL statistics to be collected
1836 for each request to the remote URL. See the section "cURL Statistics" above
1841 The following options are valid within B<Key> blocks:
1845 =item B<Type> I<Type>
1847 Sets the type used to dispatch the values to the daemon. Detailed information
1848 about types and their configuration can be found in L<types.db(5)>. This
1849 option is mandatory.
1851 =item B<Instance> I<Instance>
1853 Type-instance to use. Defaults to the current map key or current string array element value.
1857 =head2 Plugin C<curl_xml>
1859 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1860 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1863 <URL "http://localhost/stats.xml">
1865 Instance "some_instance"
1870 CACert "/path/to/ca.crt"
1871 Header "X-Custom-Header: foobar"
1874 <XPath "table[@id=\"magic_level\"]/tr">
1876 #InstancePrefix "prefix-"
1877 InstanceFrom "td[1]"
1878 ValuesFrom "td[2]/span[@class=\"level\"]"
1883 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1884 URL to be fetched using libcurl. Within each B<URL> block there are
1885 options which specify the connection parameters, for example authentication
1886 information, and one or more B<XPath> blocks.
1888 Each B<XPath> block specifies how to get one type of information. The
1889 string argument must be a valid XPath expression which returns a list
1890 of "base elements". One value is dispatched for each "base element". The
1891 I<type instance> and values are looked up using further I<XPath> expressions
1892 that should be relative to the base element.
1894 Within the B<URL> block the following options are accepted:
1898 =item B<Host> I<Name>
1900 Use I<Name> as the host name when submitting values. Defaults to the global
1903 =item B<Instance> I<Instance>
1905 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1906 empty string (no plugin instance).
1908 =item B<Namespace> I<Prefix> I<URL>
1910 If an XPath expression references namespaces, they must be specified
1911 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1912 I<URL> is the "namespace name", an URI reference uniquely identifying the
1913 namespace. The option can be repeated to register multiple namespaces.
1917 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1918 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1920 =item B<User> I<User>
1922 =item B<Password> I<Password>
1924 =item B<Digest> B<true>|B<false>
1926 =item B<VerifyPeer> B<true>|B<false>
1928 =item B<VerifyHost> B<true>|B<false>
1930 =item B<CACert> I<CA Cert File>
1932 =item B<Header> I<Header>
1934 =item B<Post> I<Body>
1936 =item B<Timeout> I<Milliseconds>
1938 These options behave exactly equivalent to the appropriate options of the
1939 I<cURL plugin>. Please see there for a detailed description.
1941 =item B<E<lt>StatisticsE<gt>>
1943 One B<Statistics> block can be used to specify cURL statistics to be collected
1944 for each request to the remote URL. See the section "cURL Statistics" above
1947 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1949 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1950 B<XPath> block specifies how to get one type of information. The string
1951 argument must be a valid XPath expression which returns a list of "base
1952 elements". One value is dispatched for each "base element".
1954 Within the B<XPath> block the following options are accepted:
1958 =item B<Type> I<Type>
1960 Specifies the I<Type> used for submitting patches. This determines the number
1961 of values that are required / expected and whether the strings are parsed as
1962 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1963 This option is required.
1965 =item B<InstancePrefix> I<InstancePrefix>
1967 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1968 concatenated together without any separator.
1969 This option is optional.
1971 =item B<InstanceFrom> I<InstanceFrom>
1973 Specifies a XPath expression to use for determining the I<type instance>. The
1974 XPath expression must return exactly one element. The element's value is then
1975 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1977 This value is required. As a special exception, if the "base XPath expression"
1978 (the argument to the B<XPath> block) returns exactly one argument, then this
1979 option may be omitted.
1981 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1983 Specifies one or more XPath expression to use for reading the values. The
1984 number of XPath expressions must match the number of data sources in the
1985 I<type> specified with B<Type> (see above). Each XPath expression must return
1986 exactly one element. The element's value is then parsed as a number and used as
1987 value for the appropriate value in the value list dispatched to the daemon.
1993 =head2 Plugin C<dbi>
1995 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1996 connect to various databases, execute I<SQL> statements and read back the
1997 results. I<dbi> is an acronym for "database interface" in case you were
1998 wondering about the name. You can configure how each column is to be
1999 interpreted and the plugin will generate one or more data sets from each row
2000 returned according to these rules.
2002 Because the plugin is very generic, the configuration is a little more complex
2003 than those of other plugins. It usually looks something like this:
2006 <Query "out_of_stock">
2007 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2008 # Use with MySQL 5.0.0 or later
2012 InstancePrefix "out_of_stock"
2013 InstancesFrom "category"
2017 <Database "product_information">
2020 DriverOption "host" "localhost"
2021 DriverOption "username" "collectd"
2022 DriverOption "password" "aZo6daiw"
2023 DriverOption "dbname" "prod_info"
2024 SelectDB "prod_info"
2025 Query "out_of_stock"
2029 The configuration above defines one query with one result and one database. The
2030 query is then linked to the database with the B<Query> option I<within> the
2031 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2032 and you can also use the B<Include> statement to split up the configuration
2033 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2034 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2037 The following is a complete list of options:
2039 =head3 B<Query> blocks
2041 Query blocks define I<SQL> statements and how the returned data should be
2042 interpreted. They are identified by the name that is given in the opening line
2043 of the block. Thus the name needs to be unique. Other than that, the name is
2044 not used in collectd.
2046 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2047 define which column holds which value or instance information. You can use
2048 multiple B<Result> blocks to create multiple values from one returned row. This
2049 is especially useful, when queries take a long time and sending almost the same
2050 query again and again is not desirable.
2054 <Query "environment">
2055 Statement "select station, temperature, humidity from environment"
2058 # InstancePrefix "foo"
2059 InstancesFrom "station"
2060 ValuesFrom "temperature"
2064 InstancesFrom "station"
2065 ValuesFrom "humidity"
2069 The following options are accepted:
2073 =item B<Statement> I<SQL>
2075 Sets the statement that should be executed on the server. This is B<not>
2076 interpreted by collectd, but simply passed to the database server. Therefore,
2077 the SQL dialect that's used depends on the server collectd is connected to.
2079 The query has to return at least two columns, one for the instance and one
2080 value. You cannot omit the instance, even if the statement is guaranteed to
2081 always return exactly one line. In that case, you can usually specify something
2084 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2086 (That works with MySQL but may not be valid SQL according to the spec. If you
2087 use a more strict database server, you may have to select from a dummy table or
2090 Please note that some databases, for example B<Oracle>, will fail if you
2091 include a semicolon at the end of the statement.
2093 =item B<MinVersion> I<Version>
2095 =item B<MaxVersion> I<Value>
2097 Only use this query for the specified database version. You can use these
2098 options to provide multiple queries with the same name but with a slightly
2099 different syntax. The plugin will use only those queries, where the specified
2100 minimum and maximum versions fit the version of the database in use.
2102 The database version is determined by C<dbi_conn_get_engine_version>, see the
2103 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2104 for details. Basically, each part of the version is assumed to be in the range
2105 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2106 "40102", version "5.0.42" becomes "50042".
2108 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2109 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2110 happen. Don't to it! A valid example would be something along these lines:
2121 In the above example, there are three ranges that don't overlap. The last one
2122 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2123 before "4.0.0" are not specified.
2125 =item B<Type> I<Type>
2127 The B<type> that's used for each line returned. See L<types.db(5)> for more
2128 details on how types are defined. In short: A type is a predefined layout of
2129 data and the number of values and type of values has to match the type
2132 If you specify "temperature" here, you need exactly one gauge column. If you
2133 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2136 There must be exactly one B<Type> option inside each B<Result> block.
2138 =item B<InstancePrefix> I<prefix>
2140 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2141 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2142 all strings returned in the appropriate columns are concatenated together,
2143 separated by dashes I<("-")>.
2145 =item B<InstancesFrom> I<column0> [I<column1> ...]
2147 Specifies the columns whose values will be used to create the "type-instance"
2148 for each row. If you specify more than one column, the value of all columns
2149 will be joined together with dashes I<("-")> as separation characters.
2151 The plugin itself does not check whether or not all built instances are
2152 different. It's your responsibility to assure that each is unique. This is
2153 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2154 sure that only one row is returned in this case.
2156 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2159 =item B<ValuesFrom> I<column0> [I<column1> ...]
2161 Names the columns whose content is used as the actual data for the data sets
2162 that are dispatched to the daemon. How many such columns you need is determined
2163 by the B<Type> setting above. If you specify too many or not enough columns,
2164 the plugin will complain about that and no data will be submitted to the
2167 The actual data type in the columns is not that important. The plugin will
2168 automatically cast the values to the right type if it know how to do that. So
2169 it should be able to handle integer an floating point types, as well as strings
2170 (if they include a number at the beginning).
2172 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2174 =item B<MetadataFrom> [I<column0> I<column1> ...]
2176 Names the columns whose content is used as metadata for the data sets
2177 that are dispatched to the daemon.
2179 The actual data type in the columns is not that important. The plugin will
2180 automatically cast the values to the right type if it know how to do that. So
2181 it should be able to handle integer an floating point types, as well as strings
2182 (if they include a number at the beginning).
2186 =head3 B<Database> blocks
2188 Database blocks define a connection to a database and which queries should be
2189 sent to that database. Since the used "dbi" library can handle a wide variety
2190 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2191 documentationE<nbsp>- we stick as close to the terminology used there.
2193 Each database needs a "name" as string argument in the starting tag of the
2194 block. This name will be used as "PluginInstance" in the values submitted to
2195 the daemon. Other than that, that name is not used.
2199 =item B<Interval> I<Interval>
2201 Sets the interval (in seconds) in which the values will be collected from this
2202 database. By default the global B<Interval> setting will be used.
2204 =item B<Driver> I<Driver>
2206 Specifies the driver to use to connect to the database. In many cases those
2207 drivers are named after the database they can connect to, but this is not a
2208 technical necessity. These drivers are sometimes referred to as "DBD",
2209 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2210 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2211 project at L<http://libdbi-drivers.sourceforge.net/>.
2213 You need to give the driver name as expected by the "dbi" library here. You
2214 should be able to find that in the documentation for each driver. If you
2215 mistype the driver name, the plugin will dump a list of all known driver names
2218 =item B<DriverOption> I<Key> I<Value>
2220 Sets driver-specific options. What option a driver supports can be found in the
2221 documentation for each driver, somewhere at
2222 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2223 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2225 DBDs can register two types of options: String options and numeric options. The
2226 plugin will use the C<dbi_conn_set_option> function when the configuration
2227 provides a string and the C<dbi_conn_require_option_numeric> function when the
2228 configuration provides a number. So these two lines will actually result in
2229 different calls being used:
2231 DriverOption "Port" 1234 # numeric
2232 DriverOption "Port" "1234" # string
2234 Unfortunately, drivers are not too keen to report errors when an unknown option
2235 is passed to them, so invalid settings here may go unnoticed. This is not the
2236 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2237 the driver. If a driver complains about an option, the plugin will dump a
2238 complete list of all options understood by that driver to the log. There is no
2239 way to programmatically find out if an option expects a string or a numeric
2240 argument, so you will have to refer to the appropriate DBD's documentation to
2241 find this out. Sorry.
2243 =item B<SelectDB> I<Database>
2245 In some cases, the database name you connect with is not the database name you
2246 want to use for querying data. If this option is set, the plugin will "select"
2247 (switch to) that database after the connection is established.
2249 =item B<Query> I<QueryName>
2251 Associates the query named I<QueryName> with this database connection. The
2252 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2253 blocks you want to refer to must be placed above the database block you want to
2256 =item B<Host> I<Hostname>
2258 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2259 values. Defaults to the global hostname setting.
2267 =item B<Device> I<Device>
2269 Select partitions based on the devicename.
2271 =item B<MountPoint> I<Directory>
2273 Select partitions based on the mountpoint.
2275 =item B<FSType> I<FSType>
2277 Select partitions based on the filesystem type.
2279 =item B<IgnoreSelected> B<true>|B<false>
2281 Invert the selection: If set to true, all partitions B<except> the ones that
2282 match any one of the criteria are collected. By default only selected
2283 partitions are collected if a selection is made. If no selection is configured
2284 at all, B<all> partitions are selected.
2286 =item B<ReportByDevice> B<true>|B<false>
2288 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2289 (the default), it will report a disk as "root", but with it I<true>, it will be
2290 "sda1" (or whichever).
2292 =item B<ReportInodes> B<true>|B<false>
2294 Enables or disables reporting of free, reserved and used inodes. Defaults to
2295 inode collection being disabled.
2297 Enable this option if inodes are a scarce resource for you, usually because
2298 many small files are stored on the disk. This is a usual scenario for mail
2299 transfer agents and web caches.
2301 =item B<ValuesAbsolute> B<true>|B<false>
2303 Enables or disables reporting of free and used disk space in 1K-blocks.
2304 Defaults to B<true>.
2306 =item B<ValuesPercentage> B<false>|B<true>
2308 Enables or disables reporting of free and used disk space in percentage.
2309 Defaults to B<false>.
2311 This is useful for deploying I<collectd> on the cloud, where machines with
2312 different disk size may exist. Then it is more practical to configure
2313 thresholds based on relative disk size.
2317 =head2 Plugin C<disk>
2319 The C<disk> plugin collects information about the usage of physical disks and
2320 logical disks (partitions). Values collected are the number of octets written
2321 to and read from a disk or partition, the number of read/write operations
2322 issued to the disk and a rather complex "time" it took for these commands to be
2325 Using the following two options you can ignore some disks or configure the
2326 collection only of specific disks.
2330 =item B<Disk> I<Name>
2332 Select the disk I<Name>. Whether it is collected or ignored depends on the
2333 B<IgnoreSelected> setting, see below. As with other plugins that use the
2334 daemon's ignorelist functionality, a string that starts and ends with a slash
2335 is interpreted as a regular expression. Examples:
2340 =item B<IgnoreSelected> B<true>|B<false>
2342 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2343 statements, are ignored or if all other disks are ignored. The behavior
2344 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2345 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2346 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2347 is set to B<true>, all disks are collected B<except> the ones matched.
2349 =item B<UseBSDName> B<true>|B<false>
2351 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2352 default major/minor numbers. Requires collectd to be built with Apple's
2355 =item B<UdevNameAttr> I<Attribute>
2357 Attempt to override disk instance name with the value of a specified udev
2358 attribute when built with B<libudev>. If the attribute is not defined for the
2359 given device, the default name is used. Example:
2361 UdevNameAttr "DM_NAME"
2365 =head2 Plugin C<dns>
2369 =item B<Interface> I<Interface>
2371 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2372 option sets the interface that should be used. If this option is not set, or
2373 set to "any", the plugin will try to get packets from B<all> interfaces. This
2374 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2376 =item B<IgnoreSource> I<IP-address>
2378 Ignore packets that originate from this address.
2380 =item B<SelectNumericQueryTypes> B<true>|B<false>
2382 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2386 =head2 Plugin C<dpdkstat>
2388 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2389 extended NIC stats API in DPDK.
2397 ProcessType "secondary"
2401 EnabledPortMask 0xffff
2402 PortName "interface1"
2403 PortName "interface2"
2408 =head3 The EAL block
2412 =item B<Coremask> I<Mask>
2414 A string containing an hexadecimal bit mask of the cores to run on. Note that
2415 core numbering can change between platforms and should be determined beforehand.
2417 =item B<Memorychannels> I<Channels>
2419 A string containing a number of memory channels per processor socket.
2421 =item B<ProcessType> I<type>
2423 A string containing the type of DPDK process instance.
2425 =item B<FilePrefix> I<File>
2427 The prefix text used for hugepage filenames. The filename will be set to
2428 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2430 =item B<SocketMemory> I<MB>
2432 A string containing amount of Memory to allocate from hugepages on specific
2433 sockets in MB. This is an optional value.
2439 =item B<EnabledPortMask> I<Mask>
2441 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2442 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2443 that all ports will be enabled. This is an optional argument - default
2444 is all ports enabled.
2446 =item B<PortName> I<Name>
2448 A string containing an optional name for the enabled DPDK ports. Each PortName
2449 option should contain only one port name; specify as many PortName options as
2450 desired. Default naming convention will be used if PortName is blank. If there
2451 are less PortName options than there are enabled ports, the default naming
2452 convention will be used for the additional ports.
2456 =head2 Plugin C<email>
2460 =item B<SocketFile> I<Path>
2462 Sets the socket-file which is to be created.
2464 =item B<SocketGroup> I<Group>
2466 If running as root change the group of the UNIX-socket after it has been
2467 created. Defaults to B<collectd>.
2469 =item B<SocketPerms> I<Permissions>
2471 Change the file permissions of the UNIX-socket after it has been created. The
2472 permissions must be given as a numeric, octal value as you would pass to
2473 L<chmod(1)>. Defaults to B<0770>.
2475 =item B<MaxConns> I<Number>
2477 Sets the maximum number of connections that can be handled in parallel. Since
2478 this many threads will be started immediately setting this to a very high
2479 value will waste valuable resources. Defaults to B<5> and will be forced to be
2480 at most B<16384> to prevent typos and dumb mistakes.
2484 =head2 Plugin C<ethstat>
2486 The I<ethstat plugin> collects information about network interface cards (NICs)
2487 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2493 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2494 Map "multicast" "if_multicast"
2501 =item B<Interface> I<Name>
2503 Collect statistical information about interface I<Name>.
2505 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2507 By default, the plugin will submit values as type C<derive> and I<type
2508 instance> set to I<Name>, the name of the metric as reported by the driver. If
2509 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2510 I<TypeInstance> will be used.
2512 =item B<MappedOnly> B<true>|B<false>
2514 When set to B<true>, only metrics that can be mapped to a I<type> will be
2515 collected, all other metrics will be ignored. Defaults to B<false>.
2519 =head2 Plugin C<exec>
2521 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2522 contains valuable information on when the executable is executed and the
2523 output that is expected from it.
2527 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2529 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2531 Execute the executable I<Executable> as user I<User>. If the user name is
2532 followed by a colon and a group name, the effective group is set to that group.
2533 The real group and saved-set group will be set to the default group of that
2534 user. If no group is given the effective group ID will be the same as the real
2537 Please note that in order to change the user and/or group the daemon needs
2538 superuser privileges. If the daemon is run as an unprivileged user you must
2539 specify the same user/group here. If the daemon is run with superuser
2540 privileges, you must supply a non-root user here.
2542 The executable may be followed by optional arguments that are passed to the
2543 program. Please note that due to the configuration parsing numbers and boolean
2544 values may be changed. If you want to be absolutely sure that something is
2545 passed as-is please enclose it in quotes.
2547 The B<Exec> and B<NotificationExec> statements change the semantics of the
2548 programs executed, i.E<nbsp>e. the data passed to them and the response
2549 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2553 =head2 Plugin C<fhcount>
2555 The C<fhcount> plugin provides statistics about used, unused and total number of
2556 file handles on Linux.
2558 The I<fhcount plugin> provides the following configuration options:
2562 =item B<ValuesAbsolute> B<true>|B<false>
2564 Enables or disables reporting of file handles usage in absolute numbers,
2565 e.g. file handles used. Defaults to B<true>.
2567 =item B<ValuesPercentage> B<false>|B<true>
2569 Enables or disables reporting of file handles usage in percentages, e.g.
2570 percent of file handles used. Defaults to B<false>.
2574 =head2 Plugin C<filecount>
2576 The C<filecount> plugin counts the number of files in a certain directory (and
2577 its subdirectories) and their combined size. The configuration is very straight
2580 <Plugin "filecount">
2581 <Directory "/var/qmail/queue/mess">
2582 Instance "qmail-message"
2584 <Directory "/var/qmail/queue/todo">
2585 Instance "qmail-todo"
2587 <Directory "/var/lib/php5">
2588 Instance "php5-sessions"
2593 The example above counts the number of files in QMail's queue directories and
2594 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2595 QMail has not yet looked at, the "message" queue holds the messages that were
2596 classified into "local" and "remote".
2598 As you can see, the configuration consists of one or more C<Directory> blocks,
2599 each of which specifies a directory in which to count the files. Within those
2600 blocks, the following options are recognized:
2604 =item B<Instance> I<Instance>
2606 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2607 it's your responsibility, the plugin doesn't check for that. If not given, the
2608 instance is set to the directory name with all slashes replaced by underscores
2609 and all leading underscores removed.
2611 =item B<Name> I<Pattern>
2613 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2614 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2615 against the pattern, not the entire path. In case this makes it easier for you:
2616 This option has been named after the B<-name> parameter to L<find(1)>.
2618 =item B<MTime> I<Age>
2620 Count only files of a specific age: If I<Age> is greater than zero, only files
2621 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2622 a negative number, this is inversed. For example, if B<-60> is specified, only
2623 files that have been modified in the last minute will be counted.
2625 The number can also be followed by a "multiplier" to easily specify a larger
2626 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2627 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2628 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2629 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2630 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2633 =item B<Size> I<Size>
2635 Count only files of a specific size. When I<Size> is a positive number, only
2636 files that are at least this big are counted. If I<Size> is a negative number,
2637 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2638 I<Size> are counted.
2640 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2641 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2642 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2643 note that there are 1000 bytes in a kilobyte, not 1024.
2645 =item B<Recursive> I<true>|I<false>
2647 Controls whether or not to recurse into subdirectories. Enabled by default.
2649 =item B<IncludeHidden> I<true>|I<false>
2651 Controls whether or not to include "hidden" files and directories in the count.
2652 "Hidden" files and directories are those, whose name begins with a dot.
2653 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2657 =head2 Plugin C<GenericJMX>
2659 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2660 L<collectd-java(5)>.
2662 =head2 Plugin C<gmond>
2664 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2665 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2666 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2671 MCReceiveFrom "239.2.11.71" "8649"
2672 <Metric "swap_total">
2674 TypeInstance "total"
2677 <Metric "swap_free">
2684 The following metrics are built-in:
2690 load_one, load_five, load_fifteen
2694 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2698 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2710 Available configuration options:
2714 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2716 Sets sets the multicast group and UDP port to which to subscribe.
2718 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2720 =item E<lt>B<Metric> I<Name>E<gt>
2722 These blocks add a new metric conversion to the internal table. I<Name>, the
2723 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2727 =item B<Type> I<Type>
2729 Type to map this metric to. Required.
2731 =item B<TypeInstance> I<Instance>
2733 Type-instance to use. Optional.
2735 =item B<DataSource> I<Name>
2737 Data source to map this metric to. If the configured type has exactly one data
2738 source, this is optional. Otherwise the option is required.
2744 =head2 Plugin C<gps>
2746 The C<gps plugin> connects to gpsd on the host machine.
2747 The host, port, timeout and pause are configurable.
2749 This is useful if you run an NTP server using a GPS for source and you want to
2752 Mind your GPS must send $--GSA for having the data reported!
2754 The following elements are collected:
2760 Number of satellites used for fix (type instance "used") and in view (type
2761 instance "visible"). 0 means no GPS satellites are visible.
2763 =item B<dilution_of_precision>
2765 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2766 It should be between 0 and 3.
2767 Look at the documentation of your GPS to know more.
2775 # Connect to localhost on gpsd regular port:
2780 # PauseConnect of 5 sec. between connection attempts.
2784 Available configuration options:
2788 =item B<Host> I<Host>
2790 The host on which gpsd daemon runs. Defaults to B<localhost>.
2792 =item B<Port> I<Port>
2794 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2796 =item B<Timeout> I<Seconds>
2798 Timeout in seconds (default 0.015 sec).
2800 The GPS data stream is fetch by the plugin form the daemon.
2801 It waits for data to be available, if none arrives it times out
2802 and loop for another reading.
2803 Mind to put a low value gpsd expects value in the micro-seconds area
2804 (recommended is 500 us) since the waiting function is blocking.
2805 Value must be between 500 us and 5 sec., if outside that range the
2806 default value is applied.
2808 This only applies from gpsd release-2.95.
2810 =item B<PauseConnect> I<Seconds>
2812 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
2816 =head2 Plugin C<grpc>
2818 The I<grpc> plugin provides an RPC interface to submit values to or query
2819 values from collectd based on the open source gRPC framework. It exposes an
2820 end-point for dispatching values to the daemon.
2822 The B<gRPC> homepage can be found at L<https://grpc.io/>.
2826 =item B<Server> I<Host> I<Port>
2828 The B<Server> statement sets the address of a server to which to send metrics
2829 via the C<DispatchValues> function.
2831 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2833 Optionally, B<Server> may be specified as a configuration block which supports
2834 the following options:
2838 =item B<EnableSSL> B<false>|B<true>
2840 Whether to require SSL for outgoing connections. Default: false.
2842 =item B<SSLCACertificateFile> I<Filename>
2844 =item B<SSLCertificateFile> I<Filename>
2846 =item B<SSLCertificateKeyFile> I<Filename>
2848 Filenames specifying SSL certificate and key material to be used with SSL
2853 =item B<Listen> I<Host> I<Port>
2855 The B<Listen> statement sets the network address to bind to. When multiple
2856 statements are specified, the daemon will bind to all of them. If none are
2857 specified, it defaults to B<0.0.0.0:50051>.
2859 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2861 Optionally, B<Listen> may be specified as a configuration block which
2862 supports the following options:
2866 =item B<EnableSSL> I<true>|I<false>
2868 Whether to enable SSL for incoming connections. Default: false.
2870 =item B<SSLCACertificateFile> I<Filename>
2872 =item B<SSLCertificateFile> I<Filename>
2874 =item B<SSLCertificateKeyFile> I<Filename>
2876 Filenames specifying SSL certificate and key material to be used with SSL
2883 =head2 Plugin C<hddtemp>
2885 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2886 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2887 default values, see below. C<hddtemp> has to be running to work correctly. If
2888 C<hddtemp> is not running timeouts may appear which may interfere with other
2891 The B<hddtemp> homepage can be found at
2892 L<http://www.guzu.net/linux/hddtemp.php>.
2896 =item B<Host> I<Hostname>
2898 Hostname to connect to. Defaults to B<127.0.0.1>.
2900 =item B<Port> I<Port>
2902 TCP-Port to connect to. Defaults to B<7634>.
2906 =head2 Plugin C<hugepages>
2908 To collect B<hugepages> information, collectd reads directories
2909 "/sys/devices/system/node/*/hugepages" and
2910 "/sys/kernel/mm/hugepages".
2911 Reading of these directories can be disabled by the following
2912 options (default is enabled).
2916 =item B<ReportPerNodeHP> B<true>|B<false>
2918 If enabled, information will be collected from the hugepage
2919 counters in "/sys/devices/system/node/*/hugepages".
2920 This is used to check the per-node hugepage statistics on
2923 =item B<ReportRootHP> B<true>|B<false>
2925 If enabled, information will be collected from the hugepage
2926 counters in "/sys/kernel/mm/hugepages".
2927 This can be used on both NUMA and non-NUMA systems to check
2928 the overall hugepage statistics.
2930 =item B<ValuesPages> B<true>|B<false>
2932 Whether to report hugepages metrics in number of pages.
2933 Defaults to B<true>.
2935 =item B<ValuesBytes> B<false>|B<true>
2937 Whether to report hugepages metrics in bytes.
2938 Defaults to B<false>.
2940 =item B<ValuesPercentage> B<false>|B<true>
2942 Whether to report hugepages metrics as percentage.
2943 Defaults to B<false>.
2947 =head2 Plugin C<intel_rdt>
2949 The I<intel_rdt> plugin collects information provided by monitoring features of
2950 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
2951 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
2952 information about utilization of shared resources. CMT monitors last level cache
2953 occupancy (LLC). MBM supports two types of events reporting local and remote
2954 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
2955 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
2956 reports the bandwidth of accessing the remote socket. Also this technology
2957 allows to monitor instructions per clock (IPC).
2958 Monitor events are hardware dependant. Monitoring capabilities are detected on
2959 plugin initialization and only supported events are monitored.
2963 <Plugin "intel_rdt">
2964 Cores "0-2" "3,4,6" "8-10,15"
2971 =item B<Interval> I<seconds>
2973 The interval within which to retrieve statistics on monitored events in seconds.
2974 For milliseconds divide the time by 1000 for example if the desired interval
2975 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
2976 recommended to set interval higher than 1 sec.
2978 =item B<Cores> I<cores groups>
2980 All events are reported on a per core basis. Monitoring of the events can be
2981 configured for group of cores (aggregated statistics). This field defines groups
2982 of cores on which to monitor supported events. The field is represented as list
2983 of strings with core group values. Each string represents a list of cores in a
2984 group. Allowed formats are:
2989 If an empty string is provided as value for this field default cores
2990 configuration is applied - a separate group is created for each core.
2994 B<Note:> By default global interval is used to retrieve statistics on monitored
2995 events. To configure a plugin specific interval use B<Interval> option of the
2996 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
2997 example if the desired interval is 50ms, set interval to 0.05.
2998 Due to limited capacity of counters it is not recommended to set interval higher
3001 =head2 Plugin C<interface>
3005 =item B<Interface> I<Interface>
3007 Select this interface. By default these interfaces will then be collected. For
3008 a more detailed description see B<IgnoreSelected> below.
3010 =item B<IgnoreSelected> I<true>|I<false>
3012 If no configuration if given, the B<interface>-plugin will collect data from
3013 all interfaces. This may not be practical, especially for loopback- and
3014 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3015 interfaces you're interested in. Sometimes, however, it's easier/preferred
3016 to collect all interfaces I<except> a few ones. This option enables you to
3017 do that: By setting B<IgnoreSelected> to I<true> the effect of
3018 B<Interface> is inverted: All selected interfaces are ignored and all
3019 other interfaces are collected.
3021 It is possible to use regular expressions to match interface names, if the
3022 name is surrounded by I</.../> and collectd was compiled with support for
3023 regexps. This is useful if there's a need to collect (or ignore) data
3024 for a group of interfaces that are similarly named, without the need to
3025 explicitly list all of them (especially useful if the list is dynamic).
3030 Interface "/^tun[0-9]+/"
3031 IgnoreSelected "true"
3033 This will ignore the loopback interface, all interfaces with names starting
3034 with I<veth> and all interfaces with names starting with I<tun> followed by
3037 =item B<ReportInactive> I<true>|I<false>
3039 When set to I<false>, only interfaces with non-zero traffic will be
3040 reported. Note that the check is done by looking into whether a
3041 package was sent at any time from boot and the corresponding counter
3042 is non-zero. So, if the interface has been sending data in the past
3043 since boot, but not during the reported time-interval, it will still
3046 The default value is I<true> and results in collection of the data
3047 from all interfaces that are selected by B<Interface> and
3048 B<IgnoreSelected> options.
3050 =item B<UniqueName> I<true>|I<false>
3052 Interface name is not unique on Solaris (KSTAT), interface name is unique
3053 only within a module/instance. Following tuple is considered unique:
3054 (ks_module, ks_instance, ks_name)
3055 If this option is set to true, interface name contains above three fields
3056 separated by an underscore. For more info on KSTAT, visit
3057 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3059 This option is only available on Solaris.
3063 =head2 Plugin C<ipmi>
3067 =item B<Sensor> I<Sensor>
3069 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3071 =item B<IgnoreSelected> I<true>|I<false>
3073 If no configuration if given, the B<ipmi> plugin will collect data from all
3074 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3075 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3076 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3077 all other sensors are collected.
3079 =item B<NotifySensorAdd> I<true>|I<false>
3081 If a sensor appears after initialization time of a minute a notification
3084 =item B<NotifySensorRemove> I<true>|I<false>
3086 If a sensor disappears a notification is sent.
3088 =item B<NotifySensorNotPresent> I<true>|I<false>
3090 If you have for example dual power supply and one of them is (un)plugged then
3091 a notification is sent.
3095 =head2 Plugin C<iptables>
3099 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3101 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3103 Select the iptables/ip6tables filter rules to count packets and bytes from.
3105 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3106 of all rules which have a comment-match. The comment is then used as
3109 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3110 the I<n>th rule will be collected. Again, the comment (or the number) will be
3111 used as the type-instance.
3113 If I<Name> is supplied, it will be used as the type-instance instead of the
3114 comment or the number.
3118 =head2 Plugin C<irq>
3124 Select this irq. By default these irqs will then be collected. For a more
3125 detailed description see B<IgnoreSelected> below.
3127 =item B<IgnoreSelected> I<true>|I<false>
3129 If no configuration if given, the B<irq>-plugin will collect data from all
3130 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3131 can use the B<Irq>-option to pick the interrupt you're interested in.
3132 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3133 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3134 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3135 and all other interrupts are collected.
3139 =head2 Plugin C<java>
3141 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3142 This section only discusses the syntax and semantic of the configuration
3143 options. For more in-depth information on the I<Java> plugin, please read
3144 L<collectd-java(5)>.
3149 JVMArg "-verbose:jni"
3150 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3151 LoadPlugin "org.collectd.java.Foobar"
3152 <Plugin "org.collectd.java.Foobar">
3153 # To be parsed by the plugin
3157 Available configuration options:
3161 =item B<JVMArg> I<Argument>
3163 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3164 exactly the way the arguments to the I<java> binary on the command line work.
3165 Execute C<javaE<nbsp>--help> for details.
3167 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3168 any other options! When another option is found, the JVM will be started and
3169 later options will have to be ignored!
3171 =item B<LoadPlugin> I<JavaClass>
3173 Instantiates a new I<JavaClass> object. The constructor of this object very
3174 likely then registers one or more callback methods with the server.
3176 See L<collectd-java(5)> for details.
3178 When the first such option is found, the virtual machine (JVM) is created. This
3179 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3180 B<LoadPlugin> options!
3182 =item B<Plugin> I<Name>
3184 The entire block is passed to the Java plugin as an
3185 I<org.collectd.api.OConfigItem> object.
3187 For this to work, the plugin has to register a configuration callback first,
3188 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3189 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3190 depends on the (Java) plugin registering the callback and is completely
3191 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3195 =head2 Plugin C<load>
3197 The I<Load plugin> collects the system load. These numbers give a rough overview
3198 over the utilization of a machine. The system load is defined as the number of
3199 runnable tasks in the run-queue and is provided by many operating systems as a
3200 one, five or fifteen minute average.
3202 The following configuration options are available:
3206 =item B<ReportRelative> B<false>|B<true>
3208 When enabled, system load divided by number of available CPU cores is reported
3209 for intervals 1 min, 5 min and 15 min. Defaults to false.
3214 =head2 Plugin C<logfile>
3218 =item B<LogLevel> B<debug|info|notice|warning|err>
3220 Sets the log-level. If, for example, set to B<notice>, then all events with
3221 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3223 Please note that B<debug> is only available if collectd has been compiled with
3226 =item B<File> I<File>
3228 Sets the file to write log messages to. The special strings B<stdout> and
3229 B<stderr> can be used to write to the standard output and standard error
3230 channels, respectively. This, of course, only makes much sense when I<collectd>
3231 is running in foreground- or non-daemon-mode.
3233 =item B<Timestamp> B<true>|B<false>
3235 Prefix all lines printed by the current time. Defaults to B<true>.
3237 =item B<PrintSeverity> B<true>|B<false>
3239 When enabled, all lines are prefixed by the severity of the log message, for
3240 example "warning". Defaults to B<false>.
3244 B<Note>: There is no need to notify the daemon after moving or removing the
3245 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3246 for each line it writes.
3248 =head2 Plugin C<log_logstash>
3250 The I<log logstash plugin> behaves like the logfile plugin but formats
3251 messages as JSON events for logstash to parse and input.
3255 =item B<LogLevel> B<debug|info|notice|warning|err>
3257 Sets the log-level. If, for example, set to B<notice>, then all events with
3258 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3260 Please note that B<debug> is only available if collectd has been compiled with
3263 =item B<File> I<File>
3265 Sets the file to write log messages to. The special strings B<stdout> and
3266 B<stderr> can be used to write to the standard output and standard error
3267 channels, respectively. This, of course, only makes much sense when I<collectd>
3268 is running in foreground- or non-daemon-mode.
3272 B<Note>: There is no need to notify the daemon after moving or removing the
3273 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3274 for each line it writes.
3276 =head2 Plugin C<lpar>
3278 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3279 virtualization technique for IBM POWER processors. It takes into account CPU
3280 time stolen from or donated to a partition, in addition to the usual user,
3281 system, I/O statistics.
3283 The following configuration options are available:
3287 =item B<CpuPoolStats> B<false>|B<true>
3289 When enabled, statistics about the processor pool are read, too. The partition
3290 needs to have pool authority in order to be able to acquire this information.
3293 =item B<ReportBySerial> B<false>|B<true>
3295 If enabled, the serial of the physical machine the partition is currently
3296 running on is reported as I<hostname> and the logical hostname of the machine
3297 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3298 used (just like other plugins) and the I<plugin instance> will be empty.
3303 =head2 Plugin C<lua>
3305 This plugin embeds a Lua interpreter into collectd and provides an interface
3306 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3309 =head2 Plugin C<mbmon>
3311 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3313 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3314 B<Host> and B<Port> options can be used to change these values, see below.
3315 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3316 timeouts may appear which may interfere with other statistics..
3318 C<mbmon> must be run with the -r option ("print TAG and Value format");
3319 Debian's F</etc/init.d/mbmon> script already does this, other people
3320 will need to ensure that this is the case.
3324 =item B<Host> I<Hostname>
3326 Hostname to connect to. Defaults to B<127.0.0.1>.
3328 =item B<Port> I<Port>
3330 TCP-Port to connect to. Defaults to B<411>.
3334 =head2 Plugin C<mcelog>
3336 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3338 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3339 mcelog server is running. When the server is running, the plugin will tail the
3340 specified logfile to retrieve machine check exception information and send a
3341 notification with the details from the logfile. The plugin will use the mcelog
3342 client protocol to retrieve memory related machine check exceptions.
3346 =item B<McelogClientSocket> I<Path>
3347 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3348 Defaults to B<"/var/run/mcelog-client">.
3350 =item B<McelogLogfile> I<Path>
3352 The mcelog file to parse. Defaults to B<"/var/log/mcelog">.
3358 The C<md plugin> collects information from Linux Software-RAID devices (md).
3360 All reported values are of the type C<md_disks>. Reported type instances are
3361 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3362 I<missing> (physically absent) disks.
3366 =item B<Device> I<Device>
3368 Select md devices based on device name. The I<device name> is the basename of
3369 the device, i.e. the name of the block device without the leading C</dev/>.
3370 See B<IgnoreSelected> for more details.
3372 =item B<IgnoreSelected> B<true>|B<false>
3374 Invert device selection: If set to B<true>, all md devices B<except> those
3375 listed using B<Device> are collected. If B<false> (the default), only those
3376 listed are collected. If no configuration is given, the B<md> plugin will
3377 collect data from all md devices.
3381 =head2 Plugin C<memcachec>
3383 The C<memcachec plugin> connects to a memcached server, queries one or more
3384 given I<pages> and parses the returned data according to user specification.
3385 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3388 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3389 library. Please note that there is another library with a very similar name,
3390 libmemcache (notice the missing `d'), which is not applicable.
3392 Synopsis of the configuration:
3394 <Plugin "memcachec">
3395 <Page "plugin_instance">
3399 Regex "(\\d+) bytes sent"
3402 Instance "type_instance"
3407 The configuration options are:
3411 =item E<lt>B<Page> I<Name>E<gt>
3413 Each B<Page> block defines one I<page> to be queried from the memcached server.
3414 The block requires one string argument which is used as I<plugin instance>.
3416 =item B<Server> I<Address>
3418 Sets the server address to connect to when querying the page. Must be inside a
3423 When connected to the memcached server, asks for the page I<Key>.
3425 =item E<lt>B<Match>E<gt>
3427 Match blocks define which strings to look for and how matches substrings are
3428 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3432 =head2 Plugin C<memcached>
3434 The B<memcached plugin> connects to a memcached server and queries statistics
3435 about cache utilization, memory and bandwidth used.
3436 L<http://memcached.org/>
3438 <Plugin "memcached">
3440 #Host "memcache.example.com"
3446 The plugin configuration consists of one or more B<Instance> blocks which
3447 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3448 following options are allowed:
3452 =item B<Host> I<Hostname>
3454 Sets the B<host> field of dispatched values. Defaults to the global hostname
3456 For backwards compatibility, values are also dispatched with the global
3457 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3460 =item B<Address> I<Address>
3462 Hostname or IP to connect to. For backwards compatibility, defaults to the
3463 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3465 =item B<Port> I<Port>
3467 TCP port to connect to. Defaults to B<11211>.
3469 =item B<Socket> I<Path>
3471 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3472 setting is given, the B<Address> and B<Port> settings are ignored.
3476 =head2 Plugin C<mic>
3478 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3479 Intel's Many Integrated Core (MIC) systems.
3488 ShowTemperatures true
3491 IgnoreSelectedTemperature true
3496 IgnoreSelectedPower true
3499 The following options are valid inside the B<PluginE<nbsp>mic> block:
3503 =item B<ShowCPU> B<true>|B<false>
3505 If enabled (the default) a sum of the CPU usage across all cores is reported.
3507 =item B<ShowCPUCores> B<true>|B<false>
3509 If enabled (the default) per-core CPU usage is reported.
3511 =item B<ShowMemory> B<true>|B<false>
3513 If enabled (the default) the physical memory usage of the MIC system is
3516 =item B<ShowTemperatures> B<true>|B<false>
3518 If enabled (the default) various temperatures of the MIC system are reported.
3520 =item B<Temperature> I<Name>
3522 This option controls which temperatures are being reported. Whether matching
3523 temperatures are being ignored or I<only> matching temperatures are reported
3524 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3525 temperatures are reported.
3527 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3529 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3530 (the default) only temperatures matching a B<Temperature> option are reported
3531 or, if no B<Temperature> option is specified, all temperatures are reported. If
3532 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3535 Known temperature names are:
3569 =item B<ShowPower> B<true>|B<false>
3571 If enabled (the default) various temperatures of the MIC system are reported.
3573 =item B<Power> I<Name>
3575 This option controls which power readings are being reported. Whether matching
3576 power readings are being ignored or I<only> matching power readings are reported
3577 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3578 power readings are reported.
3580 =item B<IgnoreSelectedPower> B<false>|B<true>
3582 Controls the behavior of the B<Power> setting above. If set to B<false>
3583 (the default) only power readings matching a B<Power> option are reported
3584 or, if no B<Power> option is specified, all power readings are reported. If
3585 set to B<true>, matching power readings are I<ignored> and all other power readings
3588 Known power names are:
3594 Total power utilization averaged over Time Window 0 (uWatts).
3598 Total power utilization averaged over Time Window 0 (uWatts).
3602 Instantaneous power (uWatts).
3606 Max instantaneous power (uWatts).
3610 PCI-E connector power (uWatts).
3614 2x3 connector power (uWatts).
3618 2x4 connector power (uWatts).
3626 Uncore rail (uVolts).
3630 Memory subsystem rail (uVolts).
3636 =head2 Plugin C<memory>
3638 The I<memory plugin> provides the following configuration options:
3642 =item B<ValuesAbsolute> B<true>|B<false>
3644 Enables or disables reporting of physical memory usage in absolute numbers,
3645 i.e. bytes. Defaults to B<true>.
3647 =item B<ValuesPercentage> B<false>|B<true>
3649 Enables or disables reporting of physical memory usage in percentages, e.g.
3650 percent of physical memory used. Defaults to B<false>.
3652 This is useful for deploying I<collectd> in a heterogeneous environment in
3653 which the sizes of physical memory vary.
3657 =head2 Plugin C<modbus>
3659 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3660 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3661 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3662 values (two registers interpreted as IEEE floats in big endian notation).
3666 <Data "voltage-input-1">
3669 RegisterCmd ReadHolding
3674 <Data "voltage-input-2">
3677 RegisterCmd ReadHolding
3682 <Data "supply-temperature-1">
3685 RegisterCmd ReadHolding
3690 <Host "modbus.example.com">
3691 Address "192.168.0.42"
3696 Instance "power-supply"
3697 Collect "voltage-input-1"
3698 Collect "voltage-input-2"
3703 Device "/dev/ttyUSB0"
3708 Instance "temperature"
3709 Collect "supply-temperature-1"
3715 =item E<lt>B<Data> I<Name>E<gt> blocks
3717 Data blocks define a mapping between register numbers and the "types" used by
3720 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3724 =item B<RegisterBase> I<Number>
3726 Configures the base register to read from the device. If the option
3727 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3728 register will be read (the register number is increased by one).
3730 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3732 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3733 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3734 combined into one value. Defaults to B<Uint16>.
3736 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3738 Specifies register type to be collected from device. Works only with libmodbus
3739 2.9.2 or higher. Defaults to B<ReadHolding>.
3741 =item B<Type> I<Type>
3743 Specifies the "type" (data set) to use when dispatching the value to
3744 I<collectd>. Currently, only data sets with exactly one data source are
3747 =item B<Instance> I<Instance>
3749 Sets the type instance to use when dispatching the value to I<collectd>. If
3750 unset, an empty string (no type instance) is used.
3754 =item E<lt>B<Host> I<Name>E<gt> blocks
3756 Host blocks are used to specify to which hosts to connect and what data to read
3757 from their "slaves". The string argument I<Name> is used as hostname when
3758 dispatching the values to I<collectd>.
3760 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3764 =item B<Address> I<Hostname>
3766 For Modbus/TCP, specifies the node name (the actual network address) used to
3767 connect to the host. This may be an IP address or a hostname. Please note that
3768 the used I<libmodbus> library only supports IPv4 at the moment.
3770 =item B<Port> I<Service>
3772 for Modbus/TCP, specifies the port used to connect to the host. The port can
3773 either be given as a number or as a service name. Please note that the
3774 I<Service> argument must be a string, even if ports are given in their numerical
3775 form. Defaults to "502".
3777 =item B<Device> I<Devicenode>
3779 For Modbus/RTU, specifies the path to the serial device being used.
3781 =item B<Baudrate> I<Baudrate>
3783 For Modbus/RTU, specifies the baud rate of the serial device.
3784 Note, connections currently support only 8/N/1.
3786 =item B<Interval> I<Interval>
3788 Sets the interval (in seconds) in which the values will be collected from this
3789 host. By default the global B<Interval> setting will be used.
3791 =item E<lt>B<Slave> I<ID>E<gt>
3793 Over each connection, multiple Modbus devices may be reached. The slave ID
3794 is used to specify which device should be addressed. For each device you want
3795 to query, one B<Slave> block must be given.
3797 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3801 =item B<Instance> I<Instance>
3803 Specify the plugin instance to use when dispatching the values to I<collectd>.
3804 By default "slave_I<ID>" is used.
3806 =item B<Collect> I<DataName>
3808 Specifies which data to retrieve from the device. I<DataName> must be the same
3809 string as the I<Name> argument passed to a B<Data> block. You can specify this
3810 option multiple times to collect more than one value from a slave. At least one
3811 B<Collect> option is mandatory.
3819 =head2 Plugin C<mqtt>
3821 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
3822 values from MQTT (B<Subscribe> blocks).
3828 Host "mqtt.example.com"
3832 Host "mqtt.example.com"
3837 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
3838 configuring the sending and receiving direction respectively. The plugin will
3839 register a write callback named C<mqtt/I<name>> where I<name> is the string
3840 argument given to the B<Publish> block. Both types of blocks share many but not
3841 all of the following options. If an option is valid in only one of the blocks,
3842 it will be mentioned explicitly.
3848 =item B<Host> I<Hostname>
3850 Hostname of the MQTT broker to connect to.
3852 =item B<Port> I<Service>
3854 Port number or service name of the MQTT broker to connect to.
3856 =item B<User> I<UserName>
3858 Username used when authenticating to the MQTT broker.
3860 =item B<Password> I<Password>
3862 Password used when authenticating to the MQTT broker.
3864 =item B<ClientId> I<ClientId>
3866 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
3868 =item B<QoS> [B<0>-B<2>]
3870 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
3888 In B<Publish> blocks, this option determines the QoS flag set on outgoing
3889 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
3890 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
3891 on a message is larger than the maximum accepted QoS of a subscriber, the
3892 message's QoS will be downgraded.
3894 =item B<Prefix> I<Prefix> (Publish only)
3896 This plugin will use one topic per I<value list> which will looks like a path.
3897 I<Prefix> is used as the first path element and defaults to B<collectd>.
3899 An example topic name would be:
3901 collectd/cpu-0/cpu-user
3903 =item B<Retain> B<false>|B<true> (Publish only)
3905 Controls whether the MQTT broker will retain (keep a copy of) the last message
3906 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
3908 =item B<StoreRates> B<true>|B<false> (Publish only)
3910 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
3911 before sending. Defaults to B<true>.
3913 =item B<CleanSession> B<true>|B<false> (Subscribe only)
3915 Controls whether the MQTT "cleans" the session up after the subscriber
3916 disconnects or if it maintains the subscriber's subscriptions and all messages
3917 that arrive while the subscriber is disconnected. Defaults to B<true>.
3919 =item B<Topic> I<TopicName> (Subscribe only)
3921 Configures the topic(s) to subscribe to. You can use the single level C<+> and
3922 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
3923 the B<collectd> branch.
3925 =item B<CACert> I<file>
3927 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
3928 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
3929 port of the MQTT broker.
3930 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3932 =item B<CertificateFile> I<file>
3934 Path to the PEM-encoded certificate file to use as client certificate when
3935 connecting to the MQTT broker.
3936 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3938 =item B<CertificateKeyFile> I<file>
3940 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
3941 A valid TLS configuration requires B<CACert>, B<CertificateFile> and B<CertificateKeyFile>.
3943 =item B<TLSProtocol> I<protocol>
3945 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
3946 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
3947 version is used which depends on the version of OpenSSL the Mosquitto library
3950 =item B<CipherSuite> I<ciphersuite>
3952 A string describing the ciphers available for use. See L<ciphers(1)> and the
3953 C<openssl ciphers> utility for more information. If unset, the default ciphers
3959 =head2 Plugin C<mysql>
3961 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3962 one or more databases when started and keeps the connection up as long as
3963 possible. When the connection is interrupted for whatever reason it will try
3964 to re-connect. The plugin will complain loudly in case anything goes wrong.
3966 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3967 and collects information about MySQL network traffic, executed statements,
3968 requests, the query cache and threads by evaluating the
3969 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3970 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3971 Status Variables> for an explanation of these values.
3973 Optionally, master and slave statistics may be collected in a MySQL
3974 replication setup. In that case, information about the synchronization state
3975 of the nodes are collected by evaluating the C<Position> return value of the
3976 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3977 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3978 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3979 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3980 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3992 SSLKey "/path/to/key.pem"
3993 SSLCert "/path/to/cert.pem"
3994 SSLCA "/path/to/ca.pem"
3995 SSLCAPath "/path/to/cas/"
3996 SSLCipher "DHE-RSA-AES256-SHA"
4002 Socket "/var/run/mysql/mysqld.sock"
4004 SlaveNotifications true
4010 Socket "/var/run/mysql/mysqld.sock"
4015 A B<Database> block defines one connection to a MySQL database. It accepts a
4016 single argument which specifies the name of the database. None of the other
4017 options are required. MySQL will use default values as documented in the
4018 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4019 B<MySQL reference manual>.
4023 =item B<Alias> I<Alias>
4025 Alias to use as sender instead of hostname when reporting. This may be useful
4026 when having cryptic hostnames.
4028 =item B<Host> I<Hostname>
4030 Hostname of the database server. Defaults to B<localhost>.
4032 =item B<User> I<Username>
4034 Username to use when connecting to the database. The user does not have to be
4035 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4036 unless you want to collectd replication statistics (see B<MasterStats> and
4037 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4038 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4040 =item B<Password> I<Password>
4042 Password needed to log into the database.
4044 =item B<Database> I<Database>
4046 Select this database. Defaults to I<no database> which is a perfectly reasonable
4047 option for what this plugin does.
4049 =item B<Port> I<Port>
4051 TCP-port to connect to. The port must be specified in its numeric form, but it
4052 must be passed as a string nonetheless. For example:
4056 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4057 See the documentation for the C<mysql_real_connect> function for details.
4059 =item B<Socket> I<Socket>
4061 Specifies the path to the UNIX domain socket of the MySQL server. This option
4062 only has any effect, if B<Host> is set to B<localhost> (the default).
4063 Otherwise, use the B<Port> option above. See the documentation for the
4064 C<mysql_real_connect> function for details.
4066 =item B<InnodbStats> I<true|false>
4068 If enabled, metrics about the InnoDB storage engine are collected.
4069 Disabled by default.
4071 =item B<MasterStats> I<true|false>
4073 =item B<SlaveStats> I<true|false>
4075 Enable the collection of master / slave statistics in a replication setup. In
4076 order to be able to get access to these statistics, the user needs special
4077 privileges. See the B<User> documentation above. Defaults to B<false>.
4079 =item B<SlaveNotifications> I<true|false>
4081 If enabled, the plugin sends a notification if the replication slave I/O and /
4082 or SQL threads are not running. Defaults to B<false>.
4084 =item B<WsrepStats> I<true|false>
4086 Enable the collection of wsrep plugin statistics, used in Master-Master
4087 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4088 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4090 =item B<ConnectTimeout> I<Seconds>
4092 Sets the connect timeout for the MySQL client.
4094 =item B<SSLKey> I<Path>
4096 If provided, the X509 key in PEM format.
4098 =item B<SSLCert> I<Path>
4100 If provided, the X509 cert in PEM format.
4102 =item B<SSLCA> I<Path>
4104 If provided, the CA file in PEM format (check OpenSSL docs).
4106 =item B<SSLCAPath> I<Path>
4108 If provided, the CA directory (check OpenSSL docs).
4110 =item B<SSLCipher> I<String>
4112 If provided, the SSL cipher to use.
4116 =head2 Plugin C<netapp>
4118 The netapp plugin can collect various performance and capacity information
4119 from a NetApp filer using the NetApp API.
4121 Please note that NetApp has a wide line of products and a lot of different
4122 software versions for each of these products. This plugin was developed for a
4123 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4124 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4125 model and software version but it is very hard to test this.
4126 If you have used this plugin with other models and/or software version, feel
4127 free to send us a mail to tell us about the results, even if it's just a short
4130 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4131 basic authentication.
4133 B<Do not use a regular user for this!> Create a special collectd user with just
4134 the minimum of capabilities needed. The user only needs the "login-http-admin"
4135 capability as well as a few more depending on which data will be collected.
4136 Required capabilities are documented below.
4141 <Host "netapp1.example.com">
4165 IgnoreSelectedIO false
4167 IgnoreSelectedOps false
4168 GetLatency "volume0"
4169 IgnoreSelectedLatency false
4176 IgnoreSelectedCapacity false
4179 IgnoreSelectedSnapshot false
4207 The netapp plugin accepts the following configuration options:
4211 =item B<Host> I<Name>
4213 A host block defines one NetApp filer. It will appear in collectd with the name
4214 you specify here which does not have to be its real name nor its hostname (see
4215 the B<Address> option below).
4217 =item B<VFiler> I<Name>
4219 A B<VFiler> block may only be used inside a host block. It accepts all the
4220 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4221 will execute all NetApp API commands in the context of the specified
4222 VFiler(R). It will appear in collectd with the name you specify here which
4223 does not have to be its real name. The VFiler name may be specified using the
4224 B<VFilerName> option. If this is not specified, it will default to the name
4227 The VFiler block inherits all connection related settings from the surrounding
4228 B<Host> block (which appear before the B<VFiler> block) but they may be
4229 overwritten inside the B<VFiler> block.
4231 This feature is useful, for example, when using a VFiler as SnapVault target
4232 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4233 available in the host filer (vfiler0) but only in the respective VFiler
4236 =item B<Protocol> B<httpd>|B<http>
4238 The protocol collectd will use to query this host.
4246 Valid options: http, https
4248 =item B<Address> I<Address>
4250 The hostname or IP address of the host.
4256 Default: The "host" block's name.
4258 =item B<Port> I<Port>
4260 The TCP port to connect to on the host.
4266 Default: 80 for protocol "http", 443 for protocol "https"
4268 =item B<User> I<User>
4270 =item B<Password> I<Password>
4272 The username and password to use to login to the NetApp.
4278 =item B<VFilerName> I<Name>
4280 The name of the VFiler in which context to execute API commands. If not
4281 specified, the name provided to the B<VFiler> block will be used instead.
4287 Default: name of the B<VFiler> block
4289 B<Note:> This option may only be used inside B<VFiler> blocks.
4291 =item B<Interval> I<Interval>
4297 The following options decide what kind of data will be collected. You can
4298 either use them as a block and fine tune various parameters inside this block,
4299 use them as a single statement to just accept all default values, or omit it to
4300 not collect any data.
4302 The following options are valid inside all blocks:
4306 =item B<Interval> I<Seconds>
4308 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4309 host specific setting.
4313 =head3 The System block
4315 This will collect various performance data about the whole system.
4317 B<Note:> To get this data the collectd user needs the
4318 "api-perf-object-get-instances" capability.
4322 =item B<Interval> I<Seconds>
4324 Collect disk statistics every I<Seconds> seconds.
4326 =item B<GetCPULoad> B<true>|B<false>
4328 If you set this option to true the current CPU usage will be read. This will be
4329 the average usage between all CPUs in your NetApp without any information about
4332 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4333 returns in the "CPU" field.
4341 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4343 =item B<GetInterfaces> B<true>|B<false>
4345 If you set this option to true the current traffic of the network interfaces
4346 will be read. This will be the total traffic over all interfaces of your NetApp
4347 without any information about individual interfaces.
4349 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4350 in the "Net kB/s" field.
4360 Result: One value list of type "if_octects".
4362 =item B<GetDiskIO> B<true>|B<false>
4364 If you set this option to true the current IO throughput will be read. This
4365 will be the total IO of your NetApp without any information about individual
4366 disks, volumes or aggregates.
4368 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4369 in the "DiskE<nbsp>kB/s" field.
4377 Result: One value list of type "disk_octets".
4379 =item B<GetDiskOps> B<true>|B<false>
4381 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4382 iSCSI, etc. operations will be read. This will be the total number of
4383 operations on your NetApp without any information about individual volumes or
4386 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4387 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4395 Result: A variable number of value lists of type "disk_ops_complex". Each type
4396 of operation will result in one value list with the name of the operation as
4401 =head3 The WAFL block
4403 This will collect various performance data about the WAFL file system. At the
4404 moment this just means cache performance.
4406 B<Note:> To get this data the collectd user needs the
4407 "api-perf-object-get-instances" capability.
4409 B<Note:> The interface to get these values is classified as "Diagnostics" by
4410 NetApp. This means that it is not guaranteed to be stable even between minor
4415 =item B<Interval> I<Seconds>
4417 Collect disk statistics every I<Seconds> seconds.
4419 =item B<GetNameCache> B<true>|B<false>
4427 Result: One value list of type "cache_ratio" and type instance
4430 =item B<GetDirCache> B<true>|B<false>
4438 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4440 =item B<GetInodeCache> B<true>|B<false>
4448 Result: One value list of type "cache_ratio" and type instance
4451 =item B<GetBufferCache> B<true>|B<false>
4453 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4454 in the "Cache hit" field.
4462 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4466 =head3 The Disks block
4468 This will collect performance data about the individual disks in the NetApp.
4470 B<Note:> To get this data the collectd user needs the
4471 "api-perf-object-get-instances" capability.
4475 =item B<Interval> I<Seconds>
4477 Collect disk statistics every I<Seconds> seconds.
4479 =item B<GetBusy> B<true>|B<false>
4481 If you set this option to true the busy time of all disks will be calculated
4482 and the value of the busiest disk in the system will be written.
4484 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4485 in the "Disk util" field. Probably.
4493 Result: One value list of type "percent" and type instance "disk_busy".
4497 =head3 The VolumePerf block
4499 This will collect various performance data about the individual volumes.
4501 You can select which data to collect about which volume using the following
4502 options. They follow the standard ignorelist semantic.
4504 B<Note:> To get this data the collectd user needs the
4505 I<api-perf-object-get-instances> capability.
4509 =item B<Interval> I<Seconds>
4511 Collect volume performance data every I<Seconds> seconds.
4513 =item B<GetIO> I<Volume>
4515 =item B<GetOps> I<Volume>
4517 =item B<GetLatency> I<Volume>
4519 Select the given volume for IO, operations or latency statistics collection.
4520 The argument is the name of the volume without the C</vol/> prefix.
4522 Since the standard ignorelist functionality is used here, you can use a string
4523 starting and ending with a slash to specify regular expression matching: To
4524 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4527 GetIO "/^vol[027]$/"
4529 If no regular expression is specified, an exact match is required. Both,
4530 regular and exact matching are case sensitive.
4532 If no volume was specified at all for either of the three options, that data
4533 will be collected for all available volumes.
4535 =item B<IgnoreSelectedIO> B<true>|B<false>
4537 =item B<IgnoreSelectedOps> B<true>|B<false>
4539 =item B<IgnoreSelectedLatency> B<true>|B<false>
4541 When set to B<true>, the volumes selected for IO, operations or latency
4542 statistics collection will be ignored and the data will be collected for all
4545 When set to B<false>, data will only be collected for the specified volumes and
4546 all other volumes will be ignored.
4548 If no volumes have been specified with the above B<Get*> options, all volumes
4549 will be collected regardless of the B<IgnoreSelected*> option.
4551 Defaults to B<false>
4555 =head3 The VolumeUsage block
4557 This will collect capacity data about the individual volumes.
4559 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4564 =item B<Interval> I<Seconds>
4566 Collect volume usage statistics every I<Seconds> seconds.
4568 =item B<GetCapacity> I<VolumeName>
4570 The current capacity of the volume will be collected. This will result in two
4571 to four value lists, depending on the configuration of the volume. All data
4572 sources are of type "df_complex" with the name of the volume as
4575 There will be type_instances "used" and "free" for the number of used and
4576 available bytes on the volume. If the volume has some space reserved for
4577 snapshots, a type_instance "snap_reserved" will be available. If the volume
4578 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4579 number of bytes saved by the SIS feature.
4581 B<Note:> The current NetApp API has a bug that results in this value being
4582 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4583 number which works most of the time. If you see strange values here, bug
4584 NetApp support to fix this.
4586 Repeat this option to specify multiple volumes.
4588 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4590 Specify whether to collect only the volumes selected by the B<GetCapacity>
4591 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4592 B<false>. However, if no B<GetCapacity> option is specified at all, all
4593 capacities will be selected anyway.
4595 =item B<GetSnapshot> I<VolumeName>
4597 Select volumes from which to collect snapshot information.
4599 Usually, the space used for snapshots is included in the space reported as
4600 "used". If snapshot information is collected as well, the space used for
4601 snapshots is subtracted from the used space.
4603 To make things even more interesting, it is possible to reserve space to be
4604 used for snapshots. If the space required for snapshots is less than that
4605 reserved space, there is "reserved free" and "reserved used" space in addition
4606 to "free" and "used". If the space required for snapshots exceeds the reserved
4607 space, that part allocated in the normal space is subtracted from the "used"
4610 Repeat this option to specify multiple volumes.
4612 =item B<IgnoreSelectedSnapshot>
4614 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4615 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4616 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4617 capacities will be selected anyway.
4621 =head3 The Quota block
4623 This will collect (tree) quota statistics (used disk space and number of used
4624 files). This mechanism is useful to get usage information for single qtrees.
4625 In case the quotas are not used for any other purpose, an entry similar to the
4626 following in C</etc/quotas> would be sufficient:
4628 /vol/volA/some_qtree tree - - - - -
4630 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4634 =item B<Interval> I<Seconds>
4636 Collect SnapVault(R) statistics every I<Seconds> seconds.
4640 =head3 The SnapVault block
4642 This will collect statistics about the time and traffic of SnapVault(R)
4647 =item B<Interval> I<Seconds>
4649 Collect SnapVault(R) statistics every I<Seconds> seconds.
4653 =head2 Plugin C<netlink>
4655 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4656 statistics of various interface and routing aspects.
4660 =item B<Interface> I<Interface>
4662 =item B<VerboseInterface> I<Interface>
4664 Instruct the plugin to collect interface statistics. This is basically the same
4665 as the statistics provided by the C<interface> plugin (see above) but
4666 potentially much more detailed.
4668 When configuring with B<Interface> only the basic statistics will be collected,
4669 namely octets, packets, and errors. These statistics are collected by
4670 the C<interface> plugin, too, so using both at the same time is no benefit.
4672 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4673 so that no data needs to be collected twice if you use the C<interface> plugin.
4674 This includes dropped packets, received multicast packets, collisions and a
4675 whole zoo of differentiated RX and TX errors. You can try the following command
4676 to get an idea of what awaits you:
4680 If I<Interface> is B<All>, all interfaces will be selected.
4682 =item B<QDisc> I<Interface> [I<QDisc>]
4684 =item B<Class> I<Interface> [I<Class>]
4686 =item B<Filter> I<Interface> [I<Filter>]
4688 Collect the octets and packets that pass a certain qdisc, class or filter.
4690 QDiscs and classes are identified by their type and handle (or classid).
4691 Filters don't necessarily have a handle, therefore the parent's handle is used.
4692 The notation used in collectd differs from that used in tc(1) in that it
4693 doesn't skip the major or minor number if it's zero and doesn't print special
4694 ids by their name. So, for example, a qdisc may be identified by
4695 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4696 thus not displayed by tc(1).
4698 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4699 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4700 associated with that interface will be collected.
4702 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4703 used. This may lead to problems when more than one filter is attached to a
4704 qdisc or class. This isn't nice, but we don't know how this could be done any
4705 better. If you have a idea, please don't hesitate to tell us.
4707 As with the B<Interface> option you can specify B<All> as the interface,
4708 meaning all interfaces.
4710 Here are some examples to help you understand the above text more easily:
4713 VerboseInterface "All"
4714 QDisc "eth0" "pfifo_fast-1:0"
4716 Class "ppp0" "htb-1:10"
4717 Filter "ppp0" "u32-1:0"
4720 =item B<IgnoreSelected>
4722 The behavior is the same as with all other similar plugins: If nothing is
4723 selected at all, everything is collected. If some things are selected using the
4724 options described above, only these statistics are collected. If you set
4725 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4726 specified statistics will not be collected.
4730 =head2 Plugin C<network>
4732 The Network plugin sends data to a remote instance of collectd, receives data
4733 from a remote instance, or both at the same time. Data which has been received
4734 from the network is usually not transmitted again, but this can be activated, see
4735 the B<Forward> option below.
4737 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4738 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4740 Both, B<Server> and B<Listen> can be used as single option or as block. When
4741 used as block, given options are valid for this socket only. The following
4742 example will export the metrics twice: Once to an "internal" server (without
4743 encryption and signing) and one to an external server (with cryptographic
4747 # Export to an internal server
4748 # (demonstrates usage without additional options)
4749 Server "collectd.internal.tld"
4751 # Export to an external server
4752 # (demonstrates usage with signature options)
4753 <Server "collectd.external.tld">
4754 SecurityLevel "sign"
4755 Username "myhostname"
4762 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4764 The B<Server> statement/block sets the server to send datagrams to. The
4765 statement may occur multiple times to send each datagram to multiple
4768 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4769 optional second argument specifies a port number or a service name. If not
4770 given, the default, B<25826>, is used.
4772 The following options are recognized within B<Server> blocks:
4776 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4778 Set the security you require for network communication. When the security level
4779 has been set to B<Encrypt>, data sent over the network will be encrypted using
4780 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4781 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4782 authentication code. When set to B<None>, data is sent without any security.
4784 This feature is only available if the I<network> plugin was linked with
4787 =item B<Username> I<Username>
4789 Sets the username to transmit. This is used by the server to lookup the
4790 password. See B<AuthFile> below. All security levels except B<None> require
4793 This feature is only available if the I<network> plugin was linked with
4796 =item B<Password> I<Password>
4798 Sets a password (shared secret) for this socket. All security levels except
4799 B<None> require this setting.
4801 This feature is only available if the I<network> plugin was linked with
4804 =item B<Interface> I<Interface name>
4806 Set the outgoing interface for IP packets. This applies at least
4807 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4808 undefined or a non-existent interface name is specified, the default
4809 behavior is to let the kernel choose the appropriate interface. Be warned
4810 that the manual selection of an interface for unicast traffic is only
4811 necessary in rare cases.
4813 =item B<ResolveInterval> I<Seconds>
4815 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4816 useful to force a regular DNS lookup to support a high availability setup. If
4817 not specified, re-resolves are never attempted.
4821 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4823 The B<Listen> statement sets the interfaces to bind to. When multiple
4824 statements are found the daemon will bind to multiple interfaces.
4826 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4827 the argument is a multicast address the daemon will join that multicast group.
4828 The optional second argument specifies a port number or a service name. If not
4829 given, the default, B<25826>, is used.
4831 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4835 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4837 Set the security you require for network communication. When the security level
4838 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4839 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4840 signed and encrypted data is accepted. When set to B<None>, all data will be
4841 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4842 decrypted if possible.
4844 This feature is only available if the I<network> plugin was linked with
4847 =item B<AuthFile> I<Filename>
4849 Sets a file in which usernames are mapped to passwords. These passwords are
4850 used to verify signatures and to decrypt encrypted network packets. If
4851 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4852 verified and encrypted packets are decrypted. Otherwise, signed data is
4853 accepted without checking the signature and encrypted data cannot be decrypted.
4854 For the other security levels this option is mandatory.
4856 The file format is very simple: Each line consists of a username followed by a
4857 colon and any number of spaces followed by the password. To demonstrate, an
4858 example file could look like this:
4863 Each time a packet is received, the modification time of the file is checked
4864 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4865 the file is being read, it is locked using L<fcntl(2)>.
4867 =item B<Interface> I<Interface name>
4869 Set the incoming interface for IP packets explicitly. This applies at least
4870 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4871 undefined or a non-existent interface name is specified, the default
4872 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4873 traffic gets only accepted, if it arrives on the given interface.
4877 =item B<TimeToLive> I<1-255>
4879 Set the time-to-live of sent packets. This applies to all, unicast and
4880 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4881 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4884 =item B<MaxPacketSize> I<1024-65535>
4886 Set the maximum size for datagrams received over the network. Packets larger
4887 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4888 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4891 On the server side, this limit should be set to the largest value used on
4892 I<any> client. Likewise, the value on the client must not be larger than the
4893 value on the server, or data will be lost.
4895 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4896 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4897 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4900 =item B<Forward> I<true|false>
4902 If set to I<true>, write packets that were received via the network plugin to
4903 the sending sockets. This should only be activated when the B<Listen>- and
4904 B<Server>-statements differ. Otherwise packets may be send multiple times to
4905 the same multicast group. While this results in more network traffic than
4906 necessary it's not a huge problem since the plugin has a duplicate detection,
4907 so the values will not loop.
4909 =item B<ReportStats> B<true>|B<false>
4911 The network plugin cannot only receive and send statistics, it can also create
4912 statistics about itself. Collectd data included the number of received and
4913 sent octets and packets, the length of the receive queue and the number of
4914 values handled. When set to B<true>, the I<Network plugin> will make these
4915 statistics available. Defaults to B<false>.
4919 =head2 Plugin C<nginx>
4921 This plugin collects the number of connections and requests handled by the
4922 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4923 queries the page provided by the C<ngx_http_stub_status_module> module, which
4924 isn't compiled by default. Please refer to
4925 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4926 how to compile and configure nginx and this module.
4928 The following options are accepted by the C<nginx plugin>:
4932 =item B<URL> I<http://host/nginx_status>
4934 Sets the URL of the C<ngx_http_stub_status_module> output.
4936 =item B<User> I<Username>
4938 Optional user name needed for authentication.
4940 =item B<Password> I<Password>
4942 Optional password needed for authentication.
4944 =item B<VerifyPeer> B<true|false>
4946 Enable or disable peer SSL certificate verification. See
4947 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4949 =item B<VerifyHost> B<true|false>
4951 Enable or disable peer host name verification. If enabled, the plugin checks
4952 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4953 certificate matches the host name provided by the B<URL> option. If this
4954 identity check fails, the connection is aborted. Obviously, only works when
4955 connecting to a SSL enabled server. Enabled by default.
4957 =item B<CACert> I<File>
4959 File that holds one or more SSL certificates. If you want to use HTTPS you will
4960 possibly need this option. What CA certificates come bundled with C<libcurl>
4961 and are checked by default depends on the distribution you use.
4963 =item B<Timeout> I<Milliseconds>
4965 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4966 milliseconds. By default, the configured B<Interval> is used to set the
4971 =head2 Plugin C<notify_desktop>
4973 This plugin sends a desktop notification to a notification daemon, as defined
4974 in the Desktop Notification Specification. To actually display the
4975 notifications, B<notification-daemon> is required and B<collectd> has to be
4976 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4977 environment variables have to be set correctly) and the D-Bus message bus.
4979 The Desktop Notification Specification can be found at
4980 L<http://www.galago-project.org/specs/notification/>.
4984 =item B<OkayTimeout> I<timeout>
4986 =item B<WarningTimeout> I<timeout>
4988 =item B<FailureTimeout> I<timeout>
4990 Set the I<timeout>, in milliseconds, after which to expire the notification
4991 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4992 been specified, the displayed notification will not be closed at all - the
4993 user has to do so herself. These options default to 5000. If a negative number
4994 has been specified, the default is used as well.
4998 =head2 Plugin C<notify_email>
5000 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5001 configured email address.
5003 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5005 Available configuration options:
5009 =item B<From> I<Address>
5011 Email address from which the emails should appear to come from.
5013 Default: C<root@localhost>
5015 =item B<Recipient> I<Address>
5017 Configures the email address(es) to which the notifications should be mailed.
5018 May be repeated to send notifications to multiple addresses.
5020 At least one B<Recipient> must be present for the plugin to work correctly.
5022 =item B<SMTPServer> I<Hostname>
5024 Hostname of the SMTP server to connect to.
5026 Default: C<localhost>
5028 =item B<SMTPPort> I<Port>
5030 TCP port to connect to.
5034 =item B<SMTPUser> I<Username>
5036 Username for ASMTP authentication. Optional.
5038 =item B<SMTPPassword> I<Password>
5040 Password for ASMTP authentication. Optional.
5042 =item B<Subject> I<Subject>
5044 Subject-template to use when sending emails. There must be exactly two
5045 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5046 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5049 Default: C<Collectd notify: %s@%s>
5053 =head2 Plugin C<notify_nagios>
5055 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5056 a I<passive service check result>.
5058 Available configuration options:
5062 =item B<CommandFile> I<Path>
5064 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5068 =head2 Plugin C<ntpd>
5070 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5073 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5074 the wire - using B<mode 7> specific requests. This mode is deprecated with
5075 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5076 correctly with them, the ntp daemon must be explicitly configured to
5077 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5078 manual page for details.
5080 Available configuration options for the C<ntpd> plugin:
5084 =item B<Host> I<Hostname>
5086 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5088 =item B<Port> I<Port>
5090 UDP-Port to connect to. Defaults to B<123>.
5092 =item B<ReverseLookups> B<true>|B<false>
5094 Sets whether or not to perform reverse lookups on peers. Since the name or
5095 IP-address may be used in a filename it is recommended to disable reverse
5096 lookups. The default is to do reverse lookups to preserve backwards
5097 compatibility, though.
5099 =item B<IncludeUnitID> B<true>|B<false>
5101 When a peer is a refclock, include the unit ID in the I<type instance>.
5102 Defaults to B<false> for backward compatibility.
5104 If two refclock peers use the same driver and this is B<false>, the plugin will
5105 try to write simultaneous measurements from both to the same type instance.
5106 This will result in error messages in the log and only one set of measurements
5111 =head2 Plugin C<nut>
5115 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5117 Add a UPS to collect data from. The format is identical to the one accepted by
5120 =item B<ForceSSL> B<true>|B<false>
5122 Stops connections from falling back to unsecured if an SSL connection
5123 cannot be established. Defaults to false if undeclared.
5125 =item B<VerifyPeer> I<true>|I<false>
5127 If set to true, requires a CAPath be provided. Will use the CAPath to find
5128 certificates to use as Trusted Certificates to validate a upsd server certificate.
5129 If validation of the upsd server certificate fails, the connection will not be
5130 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5131 will override and set ForceSSL to true.
5133 =item B<CAPath> I/path/to/certs/folder
5135 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5136 The folder pointed at must contain certificate(s) named according to their hash.
5137 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5138 occur because two different certs have the same hash value, Y can be incremented
5139 in order to avoid conflict. To create a symbolic link to a certificate the following
5140 command can be used from within the directory where the cert resides:
5142 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5144 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5145 generate links like the one described above for ALL certs in a given folder.
5147 C<c_rehash /path/to/certs/folder>
5151 =head2 Plugin C<olsrd>
5153 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5154 the Optimized Link State Routing daemon and reads information about the current
5155 state of the meshed network.
5157 The following configuration options are understood:
5161 =item B<Host> I<Host>
5163 Connect to I<Host>. Defaults to B<"localhost">.
5165 =item B<Port> I<Port>
5167 Specifies the port to connect to. This must be a string, even if you give the
5168 port as a number rather than a service name. Defaults to B<"2006">.
5170 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5172 Specifies what information to collect about links, i.E<nbsp>e. direct
5173 connections of the daemon queried. If set to B<No>, no information is
5174 collected. If set to B<Summary>, the number of links and the average of all
5175 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5176 If set to B<Detail> LQ and NLQ are collected per link.
5178 Defaults to B<Detail>.
5180 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5182 Specifies what information to collect about routes of the daemon queried. If
5183 set to B<No>, no information is collected. If set to B<Summary>, the number of
5184 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5185 metric and ETX are collected per route.
5187 Defaults to B<Summary>.
5189 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5191 Specifies what information to collect about the global topology. If set to
5192 B<No>, no information is collected. If set to B<Summary>, the number of links
5193 in the entire topology and the average I<link quality> (LQ) is calculated.
5194 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5196 Defaults to B<Summary>.
5200 =head2 Plugin C<onewire>
5202 B<EXPERIMENTAL!> See notes below.
5204 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5205 L<http://owfs.org/> to read sensors connected via the onewire bus.
5207 It can be used in two possible modes - standard or advanced.
5209 In the standard mode only temperature sensors (sensors with the family code
5210 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5211 other sensors you would like to have included, please send a sort request to
5212 the mailing list. You can select sensors to be read or to be ignored depending
5213 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5214 walked and all sensors are read.
5216 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5217 experimental, below.
5219 In the advanced mode you can configure any sensor to be read (only numerical
5220 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5221 In this mode you have to list all the sensors. Neither default bus walk nor
5222 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5223 the path automatically and should produce compatible structure with the "standard"
5224 mode (basically the path is expected as for example
5225 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5226 "F10FCA000800" and the rest after the slash is considered the type - here
5228 There are two advantages to this mode - you can access virtually any sensor
5229 (not just temperature), select whether to use cached or directly read values
5230 and it is slighlty faster. The downside is more complex configuration.
5232 The two modes are distinguished automatically by the format of the address.
5233 It is not possible to mix the two modes. Once a full path is detected in any
5234 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5235 (and as standard addresses will fail parsing they will be ignored).
5239 =item B<Device> I<Device>
5241 Sets the device to read the values from. This can either be a "real" hardware
5242 device, such as a serial port or an USB port, or the address of the
5243 L<owserver(1)> socket, usually B<localhost:4304>.
5245 Though the documentation claims to automatically recognize the given address
5246 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5247 with that version, the following configuration worked for us:
5250 Device "-s localhost:4304"
5253 This directive is B<required> and does not have a default value.
5255 =item B<Sensor> I<Sensor>
5257 In the standard mode selects sensors to collect or to ignore
5258 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5259 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5260 and B<not> include the leading C<10.> family byte and point.
5261 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5262 sensors (see above) are read.
5264 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5265 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5266 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5268 As there can be multiple devices on the bus you can list multiple sensor (use
5269 multiple B<Sensor> elements).
5271 =item B<IgnoreSelected> I<true>|I<false>
5273 If no configuration is given, the B<onewire> plugin will collect data from all
5274 sensors found. This may not be practical, especially if sensors are added and
5275 removed regularly. Sometimes, however, it's easier/preferred to collect only
5276 specific sensors or all sensors I<except> a few specified ones. This option
5277 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5278 B<Sensor> is inverted: All selected interfaces are ignored and all other
5279 interfaces are collected.
5281 Used only in the standard mode - see above.
5283 =item B<Interval> I<Seconds>
5285 Sets the interval in which all sensors should be read. If not specified, the
5286 global B<Interval> setting is used.
5290 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5291 work with big setups. It works with one sensor being attached to one
5292 controller, but as soon as you throw in a couple more senors and maybe a hub
5293 or two, reading all values will take more than ten seconds (the default
5294 interval). We will probably add some separate thread for reading the sensors
5295 and some cache or something like that, but it's not done yet. We will try to
5296 maintain backwards compatibility in the future, but we can't promise. So in
5297 short: If it works for you: Great! But keep in mind that the config I<might>
5298 change, though this is unlikely. Oh, and if you want to help improving this
5299 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5301 =head2 Plugin C<openldap>
5303 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5304 server correctly. The backend database C<monitor> needs to be loaded and
5305 working. See slapd-monitor(5) for the details.
5307 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5308 blocks. Each block requires one string argument as the instance name. For
5313 URL "ldap://localhost/"
5316 URL "ldaps://localhost/"
5320 The instance name will be used as the I<plugin instance>. To emulate the old
5321 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5322 plugin to work correctly, each instance name must be unique. This is not
5323 enforced by the plugin and it is your responsibility to ensure it is.
5325 The following options are accepted within each B<Instance> block:
5329 =item B<URL> I<ldap://host/binddn>
5331 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5334 =item B<BindDN> I<BindDN>
5336 Name in the form of an LDAP distinguished name intended to be used for
5337 authentication. Defaults to empty string to establish an anonymous authorization.
5339 =item B<Password> I<Password>
5341 Password for simple bind authentication. If this option is not set,
5342 unauthenticated bind operation is used.
5344 =item B<StartTLS> B<true|false>
5346 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5347 Disabled by default.
5349 =item B<VerifyHost> B<true|false>
5351 Enables or disables peer host name verification. If enabled, the plugin checks
5352 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5353 certificate matches the host name provided by the B<URL> option. If this
5354 identity check fails, the connection is aborted. Enabled by default.
5356 =item B<CACert> I<File>
5358 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5359 may possibly need this option. What CA certificates are checked by default
5360 depends on the distribution you use and can be changed with the usual ldap
5361 client configuration mechanisms. See ldap.conf(5) for the details.
5363 =item B<Timeout> I<Seconds>
5365 Sets the timeout value for ldap operations, in seconds. By default, the
5366 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5369 =item B<Version> I<Version>
5371 An integer which sets the LDAP protocol version number to use when connecting
5372 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5376 =head2 Plugin C<openvpn>
5378 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5379 traffic statistics about connected clients.
5381 To set up OpenVPN to write to the status file periodically, use the
5382 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
5383 you need to set the required format, too. This is done by setting
5384 B<--status-version> to B<2>.
5386 So, in a nutshell you need:
5388 openvpn $OTHER_OPTIONS \
5389 --status "/var/run/openvpn-status" 10 \
5396 =item B<StatusFile> I<File>
5398 Specifies the location of the status file.
5400 =item B<ImprovedNamingSchema> B<true>|B<false>
5402 When enabled, the filename of the status file will be used as plugin instance
5403 and the client's "common name" will be used as type instance. This is required
5404 when reading multiple status files. Enabling this option is recommended, but to
5405 maintain backwards compatibility this option is disabled by default.
5407 =item B<CollectCompression> B<true>|B<false>
5409 Sets whether or not statistics about the compression used by OpenVPN should be
5410 collected. This information is only available in I<single> mode. Enabled by
5413 =item B<CollectIndividualUsers> B<true>|B<false>
5415 Sets whether or not traffic information is collected for each connected client
5416 individually. If set to false, currently no traffic data is collected at all
5417 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5419 =item B<CollectUserCount> B<true>|B<false>
5421 When enabled, the number of currently connected clients or users is collected.
5422 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5423 can be configured independently from that option. Defaults to B<false>.
5427 =head2 Plugin C<oracle>
5429 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5430 Oracle® Database and lets you execute SQL statements there. It is very similar
5431 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5432 plugin's documentation above for details.
5435 <Query "out_of_stock">
5436 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5439 # InstancePrefix "foo"
5440 InstancesFrom "category"
5444 <Database "product_information">
5448 Query "out_of_stock"
5452 =head3 B<Query> blocks
5454 The Query blocks are handled identically to the Query blocks of the "dbi"
5455 plugin. Please see its documentation above for details on how to specify
5458 =head3 B<Database> blocks
5460 Database blocks define a connection to a database and which queries should be
5461 sent to that database. Each database needs a "name" as string argument in the
5462 starting tag of the block. This name will be used as "PluginInstance" in the
5463 values submitted to the daemon. Other than that, that name is not used.
5467 =item B<ConnectID> I<ID>
5469 Defines the "database alias" or "service name" to connect to. Usually, these
5470 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5472 =item B<Host> I<Host>
5474 Hostname to use when dispatching values for this database. Defaults to using
5475 the global hostname of the I<collectd> instance.
5477 =item B<Username> I<Username>
5479 Username used for authentication.
5481 =item B<Password> I<Password>
5483 Password used for authentication.
5485 =item B<Query> I<QueryName>
5487 Associates the query named I<QueryName> with this database connection. The
5488 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5489 blocks you want to refer to must be placed above the database block you want to
5494 =head2 Plugin C<ovs_events>
5496 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5497 connected interfaces, dispatches the values to collectd and sends the
5498 notification whenever the link state change occurs. This plugin uses OVS
5499 database to get a link state change notification.
5503 <Plugin "ovs_events">
5506 Socket "/var/run/openvswitch/db.sock"
5507 Interfaces "br0" "veth0"
5508 SendNotification false
5511 The plugin provides the following configuration options:
5515 =item B<Address> I<node>
5517 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5518 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5519 option. See L<ovsdb-server(1)> for more details. The option may be either
5520 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5521 format. Defaults to B<'localhost'>.
5523 =item B<Port> I<service>
5525 TCP-port to connect to. Either a service name or a port number may be given.
5526 Defaults to B<6640>.
5528 =item B<Socket> I<path>
5530 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5531 plugin. To enable the interface, the OVS DB daemon should be running with
5532 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5533 option is set, B<Address> and B<Port> options are ignored.
5535 =item B<Interfaces> [I<ifname> ...]
5537 List of interface names to be monitored by this plugin. If this option is not
5538 specified or is empty then all OVS connected interfaces on all bridges are
5541 Default: empty (all interfaces on all bridges are monitored)
5543 =item B<SendNotification> I<true|false>
5545 If set to true, OVS link notifications (interface status and OVS DB connection
5546 terminate) are sent to collectd. Default value is false.
5550 B<Note:> By default, the global interval setting is used within which to
5551 retrieve the OVS link status. To configure a plugin-specific interval, please
5552 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
5553 simple divide the time by 1000 for example if the desired interval is 50ms, set
5556 =head2 Plugin C<perl>
5558 This plugin embeds a Perl-interpreter into collectd and provides an interface
5559 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5561 =head2 Plugin C<pinba>
5563 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5564 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5565 PHP-based webpage has been delivered, the extension will send a UDP packet
5566 containing timing information, peak memory usage and so on. The plugin will
5567 wait for such packets, parse them and account the provided information, which
5568 is then dispatched to the daemon once per interval.
5575 # Overall statistics for the website.
5577 Server "www.example.com"
5579 # Statistics for www-a only
5581 Host "www-a.example.com"
5582 Server "www.example.com"
5584 # Statistics for www-b only
5586 Host "www-b.example.com"
5587 Server "www.example.com"
5591 The plugin provides the following configuration options:
5595 =item B<Address> I<Node>
5597 Configures the address used to open a listening socket. By default, plugin will
5598 bind to the I<any> address C<::0>.
5600 =item B<Port> I<Service>
5602 Configures the port (service) to bind to. By default the default Pinba port
5603 "30002" will be used. The option accepts service names in addition to port
5604 numbers and thus requires a I<string> argument.
5606 =item E<lt>B<View> I<Name>E<gt> block
5608 The packets sent by the Pinba extension include the hostname of the server, the
5609 server name (the name of the virtual host) and the script that was executed.
5610 Using B<View> blocks it is possible to separate the data into multiple groups
5611 to get more meaningful statistics. Each packet is added to all matching groups,
5612 so that a packet may be accounted for more than once.
5616 =item B<Host> I<Host>
5618 Matches the hostname of the system the webserver / script is running on. This
5619 will contain the result of the L<gethostname(2)> system call. If not
5620 configured, all hostnames will be accepted.
5622 =item B<Server> I<Server>
5624 Matches the name of the I<virtual host>, i.e. the contents of the
5625 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
5626 server names will be accepted.
5628 =item B<Script> I<Script>
5630 Matches the name of the I<script name>, i.e. the contents of the
5631 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
5632 script names will be accepted.
5638 =head2 Plugin C<ping>
5640 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
5641 configured hosts periodically and measures the network latency. Whenever the
5642 C<read> function of the plugin is called, it submits the average latency, the
5643 standard deviation and the drop rate for each host.
5645 Available configuration options:
5649 =item B<Host> I<IP-address>
5651 Host to ping periodically. This option may be repeated several times to ping
5654 =item B<Interval> I<Seconds>
5656 Sets the interval in which to send ICMP echo packets to the configured hosts.
5657 This is B<not> the interval in which statistics are queries from the plugin but
5658 the interval in which the hosts are "pinged". Therefore, the setting here
5659 should be smaller than or equal to the global B<Interval> setting. Fractional
5660 times, such as "1.24" are allowed.
5664 =item B<Timeout> I<Seconds>
5666 Time to wait for a response from the host to which an ICMP packet had been
5667 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
5668 to be down or the packet to be dropped. This setting must be smaller than the
5669 B<Interval> setting above for the plugin to work correctly. Fractional
5670 arguments are accepted.
5674 =item B<TTL> I<0-255>
5676 Sets the Time-To-Live of generated ICMP packets.
5678 =item B<Size> I<size>
5680 Sets the size of the data payload in ICMP packet to specified I<size> (it
5681 will be filled with regular ASCII pattern). If not set, default 56 byte
5682 long string is used so that the packet size of an ICMPv4 packet is exactly
5683 64 bytes, similar to the behaviour of normal ping(1) command.
5685 =item B<SourceAddress> I<host>
5687 Sets the source address to use. I<host> may either be a numerical network
5688 address or a network hostname.
5690 =item B<Device> I<name>
5692 Sets the outgoing network device to be used. I<name> has to specify an
5693 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
5696 =item B<MaxMissed> I<Packets>
5698 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
5699 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
5701 Default: B<-1> (disabled)
5705 =head2 Plugin C<postgresql>
5707 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
5708 keeps a persistent connection to all configured databases and tries to
5709 reconnect if the connection has been interrupted. A database is configured by
5710 specifying a B<Database> block as described below. The default statistics are
5711 collected from PostgreSQL's B<statistics collector> which thus has to be
5712 enabled for this plugin to work correctly. This should usually be the case by
5713 default. See the section "The Statistics Collector" of the B<PostgreSQL
5714 Documentation> for details.
5716 By specifying custom database queries using a B<Query> block as described
5717 below, you may collect any data that is available from some PostgreSQL
5718 database. This way, you are able to access statistics of external daemons
5719 which are available in a PostgreSQL database or use future or special
5720 statistics provided by PostgreSQL without the need to upgrade your collectd
5723 Starting with version 5.2, the C<postgresql> plugin supports writing data to
5724 PostgreSQL databases as well. This has been implemented in a generic way. You
5725 need to specify an SQL statement which will then be executed by collectd in
5726 order to write the data (see below for details). The benefit of that approach
5727 is that there is no fixed database layout. Rather, the layout may be optimized
5728 for the current setup.
5730 The B<PostgreSQL Documentation> manual can be found at
5731 L<http://www.postgresql.org/docs/manuals/>.
5735 Statement "SELECT magic FROM wizard WHERE host = $1;"
5739 InstancePrefix "magic"
5744 <Query rt36_tickets>
5745 Statement "SELECT COUNT(type) AS count, type \
5747 WHEN resolved = 'epoch' THEN 'open' \
5748 ELSE 'resolved' END AS type \
5749 FROM tickets) type \
5753 InstancePrefix "rt36_tickets"
5754 InstancesFrom "type"
5760 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
5770 KRBSrvName "kerberos_service_name"
5776 Service "service_name"
5777 Query backend # predefined
5788 The B<Query> block defines one database query which may later be used by a
5789 database definition. It accepts a single mandatory argument which specifies
5790 the name of the query. The names of all queries have to be unique (see the
5791 B<MinVersion> and B<MaxVersion> options below for an exception to this
5794 In each B<Query> block, there is one or more B<Result> blocks. Multiple
5795 B<Result> blocks may be used to extract multiple values from a single query.
5797 The following configuration options are available to define the query:
5801 =item B<Statement> I<sql query statement>
5803 Specify the I<sql query statement> which the plugin should execute. The string
5804 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
5805 first, second, etc. parameter. The value of the parameters is specified by the
5806 B<Param> configuration option - see below for details. To include a literal
5807 B<$> character followed by a number, surround it with single quotes (B<'>).
5809 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
5810 allowed. Note, however, that only a single command may be used. Semicolons are
5811 allowed as long as a single non-empty command has been specified only.
5813 The returned lines will be handled separately one after another.
5815 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
5817 Specify the parameters which should be passed to the SQL query. The parameters
5818 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
5819 they appear in the configuration file. The value of the parameter is
5820 determined depending on the value of the B<Param> option as follows:
5826 The configured hostname of the database connection. If a UNIX domain socket is
5827 used, the parameter expands to "localhost".
5831 The name of the database of the current connection.
5835 The name of the database plugin instance. See the B<Instance> option of the
5836 database specification below for details.
5840 The username used to connect to the database.
5844 The interval with which this database is queried (as specified by the database
5845 specific or global B<Interval> options).
5849 Please note that parameters are only supported by PostgreSQL's protocol
5850 version 3 and above which was introduced in version 7.4 of PostgreSQL.
5852 =item B<PluginInstanceFrom> I<column>
5854 Specify how to create the "PluginInstance" for reporting this query results.
5855 Only one column is supported. You may concatenate fields and string values in
5856 the query statement to get the required results.
5858 =item B<MinVersion> I<version>
5860 =item B<MaxVersion> I<version>
5862 Specify the minimum or maximum version of PostgreSQL that this query should be
5863 used with. Some statistics might only be available with certain versions of
5864 PostgreSQL. This allows you to specify multiple queries with the same name but
5865 which apply to different versions, thus allowing you to use the same
5866 configuration in a heterogeneous environment.
5868 The I<version> has to be specified as the concatenation of the major, minor
5869 and patch-level versions, each represented as two-decimal-digit numbers. For
5870 example, version 8.2.3 will become 80203.
5874 The B<Result> block defines how to handle the values returned from the query.
5875 It defines which column holds which value and how to dispatch that value to
5880 =item B<Type> I<type>
5882 The I<type> name to be used when dispatching the values. The type describes
5883 how to handle the data and where to store it. See L<types.db(5)> for more
5884 details on types and their configuration. The number and type of values (as
5885 selected by the B<ValuesFrom> option) has to match the type of the given name.
5887 This option is mandatory.
5889 =item B<InstancePrefix> I<prefix>
5891 =item B<InstancesFrom> I<column0> [I<column1> ...]
5893 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
5894 B<InstancePrefix> defines a static prefix that will be prepended to all type
5895 instances. B<InstancesFrom> defines the column names whose values will be used
5896 to create the type instance. Multiple values will be joined together using the
5897 hyphen (C<->) as separation character.
5899 The plugin itself does not check whether or not all built instances are
5900 different. It is your responsibility to assure that each is unique.
5902 Both options are optional. If none is specified, the type instance will be
5905 =item B<ValuesFrom> I<column0> [I<column1> ...]
5907 Names the columns whose content is used as the actual data for the data sets
5908 that are dispatched to the daemon. How many such columns you need is
5909 determined by the B<Type> setting as explained above. If you specify too many
5910 or not enough columns, the plugin will complain about that and no data will be
5911 submitted to the daemon.
5913 The actual data type, as seen by PostgreSQL, is not that important as long as
5914 it represents numbers. The plugin will automatically cast the values to the
5915 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
5916 L<strtod(3)> functions, so anything supported by those functions is supported
5917 by the plugin as well.
5919 This option is required inside a B<Result> block and may be specified multiple
5920 times. If multiple B<ValuesFrom> options are specified, the columns are read
5925 The following predefined queries are available (the definitions can be found
5926 in the F<postgresql_default.conf> file which, by default, is available at
5927 C<I<prefix>/share/collectd/>):
5933 This query collects the number of backends, i.E<nbsp>e. the number of
5936 =item B<transactions>
5938 This query collects the numbers of committed and rolled-back transactions of
5943 This query collects the numbers of various table modifications (i.E<nbsp>e.
5944 insertions, updates, deletions) of the user tables.
5946 =item B<query_plans>
5948 This query collects the numbers of various table scans and returned tuples of
5951 =item B<table_states>
5953 This query collects the numbers of live and dead rows in the user tables.
5957 This query collects disk block access counts for user tables.
5961 This query collects the on-disk size of the database in bytes.
5965 In addition, the following detailed queries are available by default. Please
5966 note that each of those queries collects information B<by table>, thus,
5967 potentially producing B<a lot> of data. For details see the description of the
5968 non-by_table queries above.
5972 =item B<queries_by_table>
5974 =item B<query_plans_by_table>
5976 =item B<table_states_by_table>
5978 =item B<disk_io_by_table>
5982 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5983 mandatory argument specifying the name of the writer. This will then be used
5984 in the B<Database> specification in order to activate the writer instance. The
5985 names of all writers have to be unique. The following options may be
5990 =item B<Statement> I<sql statement>
5992 This mandatory option specifies the SQL statement that will be executed for
5993 each submitted value. A single SQL statement is allowed only. Anything after
5994 the first semicolon will be ignored.
5996 Nine parameters will be passed to the statement and should be specified as
5997 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5998 values are made available through those parameters:
6004 The timestamp of the queried value as an RFC 3339-formatted local time.
6008 The hostname of the queried value.
6012 The plugin name of the queried value.
6016 The plugin instance of the queried value. This value may be B<NULL> if there
6017 is no plugin instance.
6021 The type of the queried value (cf. L<types.db(5)>).
6025 The type instance of the queried value. This value may be B<NULL> if there is
6030 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6031 sources of the submitted value-list).
6035 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6036 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6037 B<StoreRates> is enabled (which is the default, see below), all types will be
6042 An array of the submitted values. The dimensions of the value name and value
6047 In general, it is advisable to create and call a custom function in the
6048 PostgreSQL database for this purpose. Any procedural language supported by
6049 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6052 =item B<StoreRates> B<false>|B<true>
6054 If set to B<true> (the default), convert counter values to rates. If set to
6055 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6060 The B<Database> block defines one PostgreSQL database for which to collect
6061 statistics. It accepts a single mandatory argument which specifies the
6062 database name. None of the other options are required. PostgreSQL will use
6063 default values as documented in the section "CONNECTING TO A DATABASE" in the
6064 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6065 the user collectd is run as and special environment variables. See the manpage
6070 =item B<Interval> I<seconds>
6072 Specify the interval with which the database should be queried. The default is
6073 to use the global B<Interval> setting.
6075 =item B<CommitInterval> I<seconds>
6077 This option may be used for database connections which have "writers" assigned
6078 (see above). If specified, it causes a writer to put several updates into a
6079 single transaction. This transaction will last for the specified amount of
6080 time. By default, each update will be executed in a separate transaction. Each
6081 transaction generates a fair amount of overhead which can, thus, be reduced by
6082 activating this option. The draw-back is, that data covering the specified
6083 amount of time will be lost, for example, if a single statement within the
6084 transaction fails or if the database server crashes.
6086 =item B<Instance> I<name>
6088 Specify the plugin instance name that should be used instead of the database
6089 name (which is the default, if this option has not been specified). This
6090 allows one to query multiple databases of the same name on the same host (e.g.
6091 when running multiple database server versions in parallel).
6092 The plugin instance name can also be set from the query result using
6093 the B<PluginInstanceFrom> option in B<Query> block.
6095 =item B<Host> I<hostname>
6097 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6098 value begins with a slash, it is interpreted as the directory name in which to
6099 look for the UNIX domain socket.
6101 This option is also used to determine the hostname that is associated with a
6102 collected data set. If it has been omitted or either begins with with a slash
6103 or equals B<localhost> it will be replaced with the global hostname definition
6104 of collectd. Any other value will be passed literally to collectd when
6105 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6107 =item B<Port> I<port>
6109 Specify the TCP port or the local UNIX domain socket file extension of the
6112 =item B<User> I<username>
6114 Specify the username to be used when connecting to the server.
6116 =item B<Password> I<password>
6118 Specify the password to be used when connecting to the server.
6120 =item B<ExpireDelay> I<delay>
6122 Skip expired values in query output.
6124 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6126 Specify whether to use an SSL connection when contacting the server. The
6127 following modes are supported:
6133 Do not use SSL at all.
6137 First, try to connect without using SSL. If that fails, try using SSL.
6139 =item I<prefer> (default)
6141 First, try to connect using SSL. If that fails, try without using SSL.
6149 =item B<Instance> I<name>
6151 Specify the plugin instance name that should be used instead of the database
6152 name (which is the default, if this option has not been specified). This
6153 allows one to query multiple databases of the same name on the same host (e.g.
6154 when running multiple database server versions in parallel).
6156 =item B<KRBSrvName> I<kerberos_service_name>
6158 Specify the Kerberos service name to use when authenticating with Kerberos 5
6159 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6160 B<PostgreSQL Documentation> for details.
6162 =item B<Service> I<service_name>
6164 Specify the PostgreSQL service name to use for additional parameters. That
6165 service has to be defined in F<pg_service.conf> and holds additional
6166 connection parameters. See the section "The Connection Service File" in the
6167 B<PostgreSQL Documentation> for details.
6169 =item B<Query> I<query>
6171 Specifies a I<query> which should be executed in the context of the database
6172 connection. This may be any of the predefined or user-defined queries. If no
6173 such option is given, it defaults to "backends", "transactions", "queries",
6174 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6175 has been specified). Else, the specified queries are used only.
6177 =item B<Writer> I<writer>
6179 Assigns the specified I<writer> backend to the database connection. This
6180 causes all collected data to be send to the database using the settings
6181 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6182 below for details on how to selectively send data to certain plugins).
6184 Each writer will register a flush callback which may be used when having long
6185 transactions enabled (see the B<CommitInterval> option above). When issuing
6186 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6187 transaction will be committed right away. Two different kinds of flush
6188 callbacks are available with the C<postgresql> plugin:
6194 Flush all writer backends.
6196 =item B<postgresql->I<database>
6198 Flush all writers of the specified I<database> only.
6204 =head2 Plugin C<powerdns>
6206 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6207 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6208 values, many of which are probably meaningless to most users, but may be useful
6209 for some. So you may chose which values to collect, but if you don't, some
6210 reasonable defaults will be collected.
6213 <Server "server_name">
6215 Collect "udp-answers" "udp-queries"
6216 Socket "/var/run/pdns.controlsocket"
6218 <Recursor "recursor_name">
6220 Collect "cache-hits" "cache-misses"
6221 Socket "/var/run/pdns_recursor.controlsocket"
6223 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6228 =item B<Server> and B<Recursor> block
6230 The B<Server> block defines one authoritative server to query, the B<Recursor>
6231 does the same for an recursing server. The possible options in both blocks are
6232 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6237 =item B<Collect> I<Field>
6239 Using the B<Collect> statement you can select which values to collect. Here,
6240 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6241 C<dlg-only-drops>, C<answers10-100>.
6243 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6244 When querying the server a C<SHOW *> command is issued in any case, because
6245 that's the only way of getting multiple values out of the server at once.
6246 collectd then picks out the values you have selected. When querying the
6247 recursor, a command is generated to query exactly these values. So if you
6248 specify invalid fields when querying the recursor, a syntax error may be
6249 returned by the daemon and collectd may not collect any values at all.
6251 If no B<Collect> statement is given, the following B<Server> values will be
6258 =item packetcache-hit
6260 =item packetcache-miss
6262 =item packetcache-size
6264 =item query-cache-hit
6266 =item query-cache-miss
6268 =item recursing-answers
6270 =item recursing-questions
6282 The following B<Recursor> values will be collected by default:
6286 =item noerror-answers
6288 =item nxdomain-answers
6290 =item servfail-answers
6308 Please note that up to that point collectd doesn't know what values are
6309 available on the server and values that are added do not need a change of the
6310 mechanism so far. However, the values must be mapped to collectd's naming
6311 scheme, which is done using a lookup table that lists all known values. If
6312 values are added in the future and collectd does not know about them, you will
6313 get an error much like this:
6315 powerdns plugin: submit: Not found in lookup table: foobar = 42
6317 In this case please file a bug report with the collectd team.
6319 =item B<Socket> I<Path>
6321 Configures the path to the UNIX domain socket to be used when connecting to the
6322 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6323 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6324 will be used for the recursor.
6328 =item B<LocalSocket> I<Path>
6330 Querying the recursor is done using UDP. When using UDP over UNIX domain
6331 sockets, the client socket needs a name in the file system, too. You can set
6332 this local name to I<Path> using the B<LocalSocket> option. The default is
6333 C<I<prefix>/var/run/collectd-powerdns>.
6337 =head2 Plugin C<processes>
6341 =item B<Process> I<Name>
6343 Select more detailed statistics of processes matching this name. The statistics
6344 collected for these selected processes are size of the resident segment size
6345 (RSS), user- and system-time used, number of processes and number of threads,
6346 io data (where available) and minor and major pagefaults.
6348 Some platforms have a limit on the length of process names. I<Name> must stay
6351 =item B<ProcessMatch> I<name> I<regex>
6353 Similar to the B<Process> option this allows one to select more detailed
6354 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6355 details). The statistics of all matching processes are summed up and
6356 dispatched to the daemon using the specified I<name> as an identifier. This
6357 allows one to "group" several processes together. I<name> must not contain
6360 =item B<CollectContextSwitch> I<Boolean>
6362 Collect context switch of the process.
6366 =head2 Plugin C<protocols>
6368 Collects a lot of information about various network protocols, such as I<IP>,
6369 I<TCP>, I<UDP>, etc.
6371 Available configuration options:
6375 =item B<Value> I<Selector>
6377 Selects whether or not to select a specific value. The string being matched is
6378 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6379 plugin instance and I<ValueName> will be used as type instance. An example of
6380 the string being used would be C<Tcp:RetransSegs>.
6382 You can use regular expressions to match a large number of values with just one
6383 configuration option. To select all "extended" I<TCP> values, you could use the
6384 following statement:
6388 Whether only matched values are selected or all matched values are ignored
6389 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6390 If no value is configured at all, all values will be selected.
6392 =item B<IgnoreSelected> B<true>|B<false>
6394 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6395 matching values will be ignored.
6399 =head2 Plugin C<python>
6401 This plugin embeds a Python-interpreter into collectd and provides an interface
6402 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6404 =head2 Plugin C<routeros>
6406 The C<routeros> plugin connects to a device running I<RouterOS>, the
6407 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6408 I<librouteros> to connect and reads information about the interfaces and
6409 wireless connections of the device. The configuration supports querying
6414 Host "router0.example.com"
6417 CollectInterface true
6422 Host "router1.example.com"
6425 CollectInterface true
6426 CollectRegistrationTable true
6432 As you can see above, the configuration of the I<routeros> plugin consists of
6433 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6434 options are understood:
6438 =item B<Host> I<Host>
6440 Hostname or IP-address of the router to connect to.
6442 =item B<Port> I<Port>
6444 Port name or port number used when connecting. If left unspecified, the default
6445 will be chosen by I<librouteros>, currently "8728". This option expects a
6446 string argument, even when a numeric port number is given.
6448 =item B<User> I<User>
6450 Use the user name I<User> to authenticate. Defaults to "admin".
6452 =item B<Password> I<Password>
6454 Set the password used to authenticate.
6456 =item B<CollectInterface> B<true>|B<false>
6458 When set to B<true>, interface statistics will be collected for all interfaces
6459 present on the device. Defaults to B<false>.
6461 =item B<CollectRegistrationTable> B<true>|B<false>
6463 When set to B<true>, information about wireless LAN connections will be
6464 collected. Defaults to B<false>.
6466 =item B<CollectCPULoad> B<true>|B<false>
6468 When set to B<true>, information about the CPU usage will be collected. The
6469 number is a dimensionless value where zero indicates no CPU usage at all.
6470 Defaults to B<false>.
6472 =item B<CollectMemory> B<true>|B<false>
6474 When enabled, the amount of used and free memory will be collected. How used
6475 memory is calculated is unknown, for example whether or not caches are counted
6477 Defaults to B<false>.
6479 =item B<CollectDF> B<true>|B<false>
6481 When enabled, the amount of used and free disk space will be collected.
6482 Defaults to B<false>.
6484 =item B<CollectDisk> B<true>|B<false>
6486 When enabled, the number of sectors written and bad blocks will be collected.
6487 Defaults to B<false>.
6491 =head2 Plugin C<redis>
6493 The I<Redis plugin> connects to one or more Redis servers and gathers
6494 information about each server's state. For each server there is a I<Node> block
6495 which configures the connection parameters for this node.
6502 <Query "LLEN myqueue">
6509 The information shown in the synopsis above is the I<default configuration>
6510 which is used by the plugin if no configuration is present.
6514 =item B<Node> I<Nodename>
6516 The B<Node> block identifies a new Redis node, that is a new Redis instance
6517 running in an specified host and port. The name for node is a canonical
6518 identifier which is used as I<plugin instance>. It is limited to
6519 64E<nbsp>characters in length.
6521 =item B<Host> I<Hostname>
6523 The B<Host> option is the hostname or IP-address where the Redis instance is
6526 =item B<Port> I<Port>
6528 The B<Port> option is the TCP port on which the Redis instance accepts
6529 connections. Either a service name of a port number may be given. Please note
6530 that numerical port numbers must be given as a string, too.
6532 =item B<Password> I<Password>
6534 Use I<Password> to authenticate when connecting to I<Redis>.
6536 =item B<Timeout> I<Milliseconds>
6538 The B<Timeout> option set the socket timeout for node response. Since the Redis
6539 read function is blocking, you should keep this value as low as possible. Keep
6540 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6541 than B<Interval> defined globally.
6543 =item B<Query> I<Querystring>
6545 The B<Query> block identifies a query to execute against the redis server.
6546 There may be an arbitrary number of queries to execute.
6548 =item B<Type> I<Collectd type>
6550 Within a query definition, a valid collectd type to use as when submitting
6551 the result of the query. When not supplied, will default to B<gauge>.
6553 =item B<Instance> I<Type instance>
6555 Within a query definition, an optional type instance to use when submitting
6556 the result of the query. When not supplied will default to the escaped
6557 command, up to 64 chars.
6561 =head2 Plugin C<rrdcached>
6563 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6564 to store values to RRD files in an efficient manner. The combination of the
6565 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6566 way the C<rrdtool> plugin works (see below). The added abstraction layer
6567 provides a number of benefits, though: Because the cache is not within
6568 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6569 restarted. This results in much shorter (if any) gaps in graphs, especially
6570 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6571 daemon so that it can flush values to disk automatically when needed. This
6572 allows one to integrate automated flushing of values into graphing solutions
6575 There are disadvantages, though: The daemon may reside on a different host, so
6576 it may not be possible for C<collectd> to create the appropriate RRD files
6577 anymore. And even if C<rrdcached> runs on the same host, it may run in a
6578 different base directory, so relative paths may do weird stuff if you're not
6581 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
6582 on the same host, communicating via a UNIX domain socket. The B<DataDir>
6583 setting should be set to an absolute path, so that a changed base directory
6584 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
6588 =item B<DaemonAddress> I<Address>
6590 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
6591 library. See L<rrdcached(1)> for details. Example:
6593 <Plugin "rrdcached">
6594 DaemonAddress "unix:/var/run/rrdcached.sock"
6597 =item B<DataDir> I<Directory>
6599 Set the base directory in which the RRD files reside. If this is a relative
6600 path, it is relative to the working base directory of the C<rrdcached> daemon!
6601 Use of an absolute path is recommended.
6603 =item B<CreateFiles> B<true>|B<false>
6605 Enables or disables the creation of RRD files. If the daemon is not running
6606 locally, or B<DataDir> is set to a relative path, this will not work as
6607 expected. Default is B<true>.
6609 =item B<CreateFilesAsync> B<false>|B<true>
6611 When enabled, new RRD files are enabled asynchronously, using a separate thread
6612 that runs in the background. This prevents writes to block, which is a problem
6613 especially when many hundreds of files need to be created at once. However,
6614 since the purpose of creating the files asynchronously is I<not> to block until
6615 the file is available, values before the file is available will be discarded.
6616 When disabled (the default) files are created synchronously, blocking for a
6617 short while, while the file is being written.
6619 =item B<StepSize> I<Seconds>
6621 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6622 this setting is unset and the stepsize is set to the interval in which the data
6623 is collected. Do not use this option unless you absolutely have to for some
6624 reason. Setting this option may cause problems with the C<snmp plugin>, the
6625 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6627 =item B<HeartBeat> I<Seconds>
6629 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6630 in which case the heartbeat is set to twice the B<StepSize> which should equal
6631 the interval in which data is collected. Do not set this option unless you have
6632 a very good reason to do so.
6634 =item B<RRARows> I<NumRows>
6636 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6637 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6638 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6639 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6640 week, one month, and one year.
6642 So for each timespan, it calculates how many PDPs need to be consolidated into
6643 one CDP by calculating:
6644 number of PDPs = timespan / (stepsize * rrarows)
6646 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6649 =item B<RRATimespan> I<Seconds>
6651 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6652 more then one RRA. If this option is never used, the built-in default of (3600,
6653 86400, 604800, 2678400, 31622400) is used.
6655 For more information on how RRA-sizes are calculated see B<RRARows> above.
6657 =item B<XFF> I<Factor>
6659 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6660 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6663 =item B<CollectStatistics> B<false>|B<true>
6665 When set to B<true>, various statistics about the I<rrdcached> daemon will be
6666 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
6668 Statistics are read via I<rrdcached>s socket using the STATS command.
6669 See L<rrdcached(1)> for details.
6673 =head2 Plugin C<rrdtool>
6675 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
6676 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
6677 using these settings. If you don't want to dive into the depths of RRDtool, you
6678 can safely ignore these settings.
6682 =item B<DataDir> I<Directory>
6684 Set the directory to store RRD files under. By default RRD files are generated
6685 beneath the daemon's working directory, i.e. the B<BaseDir>.
6687 =item B<CreateFilesAsync> B<false>|B<true>
6689 When enabled, new RRD files are enabled asynchronously, using a separate thread
6690 that runs in the background. This prevents writes to block, which is a problem
6691 especially when many hundreds of files need to be created at once. However,
6692 since the purpose of creating the files asynchronously is I<not> to block until
6693 the file is available, values before the file is available will be discarded.
6694 When disabled (the default) files are created synchronously, blocking for a
6695 short while, while the file is being written.
6697 =item B<StepSize> I<Seconds>
6699 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6700 this setting is unset and the stepsize is set to the interval in which the data
6701 is collected. Do not use this option unless you absolutely have to for some
6702 reason. Setting this option may cause problems with the C<snmp plugin>, the
6703 C<exec plugin> or when the daemon is set up to receive data from other hosts.
6705 =item B<HeartBeat> I<Seconds>
6707 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
6708 in which case the heartbeat is set to twice the B<StepSize> which should equal
6709 the interval in which data is collected. Do not set this option unless you have
6710 a very good reason to do so.
6712 =item B<RRARows> I<NumRows>
6714 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
6715 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
6716 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
6717 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
6718 week, one month, and one year.
6720 So for each timespan, it calculates how many PDPs need to be consolidated into
6721 one CDP by calculating:
6722 number of PDPs = timespan / (stepsize * rrarows)
6724 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6727 =item B<RRATimespan> I<Seconds>
6729 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6730 more then one RRA. If this option is never used, the built-in default of (3600,
6731 86400, 604800, 2678400, 31622400) is used.
6733 For more information on how RRA-sizes are calculated see B<RRARows> above.
6735 =item B<XFF> I<Factor>
6737 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6738 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6741 =item B<CacheFlush> I<Seconds>
6743 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
6744 it writes all values for a certain RRD-file if the oldest value is older than
6745 (or equal to) the number of seconds specified. If some RRD-file is not updated
6746 anymore for some reason (the computer was shut down, the network is broken,
6747 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
6748 entire cache is searched for entries older than B<CacheTimeout> seconds and
6749 written to disk every I<Seconds> seconds. Since this is kind of expensive and
6750 does nothing under normal circumstances, this value should not be too small.
6751 900 seconds might be a good value, though setting this to 7200 seconds doesn't
6752 normally do much harm either.
6754 =item B<CacheTimeout> I<Seconds>
6756 If this option is set to a value greater than zero, the C<rrdtool plugin> will
6757 save values in a cache, as described above. Writing multiple values at once
6758 reduces IO-operations and thus lessens the load produced by updating the files.
6759 The trade off is that the graphs kind of "drag behind" and that more memory is
6762 =item B<WritesPerSecond> I<Updates>
6764 When collecting many statistics with collectd and the C<rrdtool> plugin, you
6765 will run serious performance problems. The B<CacheFlush> setting and the
6766 internal update queue assert that collectd continues to work just fine even
6767 under heavy load, but the system may become very unresponsive and slow. This is
6768 a problem especially if you create graphs from the RRD files on the same
6769 machine, for example using the C<graph.cgi> script included in the
6770 C<contrib/collection3/> directory.
6772 This setting is designed for very large setups. Setting this option to a value
6773 between 25 and 80 updates per second, depending on your hardware, will leave
6774 the server responsive enough to draw graphs even while all the cached values
6775 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
6776 by the B<FLUSH> command, are B<not> effected by this limit. They are still
6777 written as fast as possible, so that web frontends have up to date data when
6780 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
6781 updates per second, writing all values to disk will take approximately
6782 56E<nbsp>minutes. Together with the flushing ability that's integrated into
6783 "collection3" you'll end up with a responsive and fast system, up to date
6784 graphs and basically a "backup" of your values every hour.
6786 =item B<RandomTimeout> I<Seconds>
6788 When set, the actual timeout for each value is chosen randomly between
6789 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
6790 intention is to avoid high load situations that appear when many values timeout
6791 at the same time. This is especially a problem shortly after the daemon starts,
6792 because all values were added to the internal cache at roughly the same time.
6796 =head2 Plugin C<sensors>
6798 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
6799 that all the needed modules have to be loaded and lm_sensors has to be
6800 configured (most likely by editing F</etc/sensors.conf>. Read
6801 L<sensors.conf(5)> for details.
6803 The B<lm_sensors> homepage can be found at
6804 L<http://secure.netroedge.com/~lm78/>.
6808 =item B<SensorConfigFile> I<File>
6810 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
6811 the library's default will be used.
6813 =item B<Sensor> I<chip-bus-address/type-feature>
6815 Selects the name of the sensor which you want to collect or ignore, depending
6816 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
6817 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
6818 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
6820 =item B<IgnoreSelected> I<true>|I<false>
6822 If no configuration if given, the B<sensors>-plugin will collect data from all
6823 sensors. This may not be practical, especially for uninteresting sensors.
6824 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
6825 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
6826 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
6827 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
6828 and all other sensors are collected.
6830 =item B<UseLabels> I<true>|I<false>
6832 Configures how sensor readings are reported. When set to I<true>, sensor
6833 readings are reported using their descriptive label (e.g. "VCore"). When set to
6834 I<false> (the default) the sensor name is used ("in0").
6838 =head2 Plugin C<sigrok>
6840 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
6841 supported by the L<sigrok|http://sigrok.org/> project.
6847 <Device "AC Voltage">
6852 <Device "Sound Level">
6853 Driver "cem-dt-885x"
6860 =item B<LogLevel> B<0-5>
6862 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
6863 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
6864 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
6865 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
6866 their level, are always submitted to I<collectd> at its INFO log level.
6868 =item E<lt>B<Device> I<Name>E<gt>
6870 A sigrok-supported device, uniquely identified by this section's options. The
6871 I<Name> is passed to I<collectd> as the I<plugin instance>.
6873 =item B<Driver> I<DriverName>
6875 The sigrok driver to use for this device.
6877 =item B<Conn> I<ConnectionSpec>
6879 If the device cannot be auto-discovered, or more than one might be discovered
6880 by the driver, I<ConnectionSpec> specifies the connection string to the device.
6881 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
6882 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
6883 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
6884 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
6886 =item B<SerialComm> I<SerialSpec>
6888 For serial devices with non-standard port settings, this option can be used
6889 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
6890 This should not be necessary; drivers know how to communicate with devices they
6893 =item B<MinimumInterval> I<Seconds>
6895 Specifies the minimum time between measurement dispatches to I<collectd>, in
6896 seconds. Since some I<sigrok> supported devices can acquire measurements many
6897 times per second, it may be necessary to throttle these. For example, the
6898 I<RRD plugin> cannot process writes more than once per second.
6900 The default B<MinimumInterval> is B<0>, meaning measurements received from the
6901 device are always dispatched to I<collectd>. When throttled, unused
6902 measurements are discarded.
6906 =head2 Plugin C<smart>
6908 The C<smart> plugin collects SMART information from physical
6909 disks. Values collectd include temperature, power cycle count, poweron
6910 time and bad sectors. Also, all SMART attributes are collected along
6911 with the normalized current value, the worst value, the threshold and
6912 a human readable value.
6914 Using the following two options you can ignore some disks or configure the
6915 collection only of specific disks.
6919 =item B<Disk> I<Name>
6921 Select the disk I<Name>. Whether it is collected or ignored depends on the
6922 B<IgnoreSelected> setting, see below. As with other plugins that use the
6923 daemon's ignorelist functionality, a string that starts and ends with a slash
6924 is interpreted as a regular expression. Examples:
6929 =item B<IgnoreSelected> B<true>|B<false>
6931 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
6932 statements, are ignored or if all other disks are ignored. The behavior
6933 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
6934 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
6935 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
6936 is set to B<true>, all disks are collected B<except> the ones matched.
6938 =item B<IgnoreSleepMode> B<true>|B<false>
6940 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
6941 This option disables the sleep mode check and allows the plugin to collect data
6942 from these disks anyway. This is useful in cases where libatasmart mistakenly
6943 reports disks as asleep because it has not been updated to incorporate support
6944 for newer idle states in the ATA spec.
6946 =item B<UseSerial> B<true>|B<false>
6948 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
6949 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
6950 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
6951 storing data. This ensures that the data for a given disk will be kept together
6952 even if the kernel name changes.
6956 =head2 Plugin C<snmp>
6958 Since the configuration of the C<snmp plugin> is a little more complicated than
6959 other plugins, its documentation has been moved to an own manpage,
6960 L<collectd-snmp(5)>. Please see there for details.
6962 =head2 Plugin C<statsd>
6964 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
6965 protocol and dispatches rates or other aggregates of these numbers
6968 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
6969 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
6970 C<objects> respectively.
6972 The following configuration options are valid:
6976 =item B<Host> I<Host>
6978 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
6979 "any" address, i.e. accept packets sent to any of the hosts addresses.
6981 =item B<Port> I<Port>
6983 UDP port to listen to. This can be either a service name or a port number.
6984 Defaults to C<8125>.
6986 =item B<DeleteCounters> B<false>|B<true>
6988 =item B<DeleteTimers> B<false>|B<true>
6990 =item B<DeleteGauges> B<false>|B<true>
6992 =item B<DeleteSets> B<false>|B<true>
6994 These options control what happens if metrics are not updated in an interval.
6995 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6996 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6997 are unchanged. If set to B<True>, the such metrics are not dispatched and
6998 removed from the internal cache.
7000 =item B<CounterSum> B<false>|B<true>
7002 When enabled, creates a C<count> metric which reports the change since the last
7003 read. This option primarily exists for compatibility with the I<statsd>
7004 implementation by Etsy.
7006 =item B<TimerPercentile> I<Percent>
7008 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7009 that I<Percent> of all reported timers are smaller than or equal to the
7010 computed latency. This is useful for cutting off the long tail latency, as it's
7011 often done in I<Service Level Agreements> (SLAs).
7013 Different percentiles can be calculated by setting this option several times.
7014 If none are specified, no percentiles are calculated / dispatched.
7016 =item B<TimerLower> B<false>|B<true>
7018 =item B<TimerUpper> B<false>|B<true>
7020 =item B<TimerSum> B<false>|B<true>
7022 =item B<TimerCount> B<false>|B<true>
7024 Calculate and dispatch various values out of I<Timer> metrics received during
7025 an interval. If set to B<False>, the default, these values aren't calculated /
7030 =head2 Plugin C<swap>
7032 The I<Swap plugin> collects information about used and available swap space. On
7033 I<Linux> and I<Solaris>, the following options are available:
7037 =item B<ReportByDevice> B<false>|B<true>
7039 Configures how to report physical swap devices. If set to B<false> (the
7040 default), the summary over all swap devices is reported only, i.e. the globally
7041 used and available space over all devices. If B<true> is configured, the used
7042 and available space of each device will be reported separately.
7044 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7045 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7047 =item B<ReportBytes> B<false>|B<true>
7049 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7050 I<swap I/O> is reported in pages. This option is available under Linux only.
7052 =item B<ValuesAbsolute> B<true>|B<false>
7054 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7055 available and used. Defaults to B<true>.
7057 =item B<ValuesPercentage> B<false>|B<true>
7059 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7060 available and free. Defaults to B<false>.
7062 This is useful for deploying I<collectd> in a heterogeneous environment, where
7063 swap sizes differ and you want to specify generic thresholds or similar.
7067 =head2 Plugin C<syslog>
7071 =item B<LogLevel> B<debug|info|notice|warning|err>
7073 Sets the log-level. If, for example, set to B<notice>, then all events with
7074 severity B<notice>, B<warning>, or B<err> will be submitted to the
7077 Please note that B<debug> is only available if collectd has been compiled with
7080 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7082 Controls which notifications should be sent to syslog. The default behaviour is
7083 not to send any. Less severe notifications always imply logging more severe
7084 notifications: Setting this to B<OKAY> means all notifications will be sent to
7085 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7086 notifications but will dismiss B<OKAY> notifications. Setting this option to
7087 B<FAILURE> will only send failures to syslog.
7091 =head2 Plugin C<table>
7093 The C<table plugin> provides generic means to parse tabular data and dispatch
7094 user specified values. Values are selected based on column numbers. For
7095 example, this plugin may be used to get values from the Linux L<proc(5)>
7096 filesystem or CSV (comma separated values) files.
7099 <Table "/proc/slabinfo">
7104 InstancePrefix "active_objs"
7110 InstancePrefix "objperslab"
7117 The configuration consists of one or more B<Table> blocks, each of which
7118 configures one file to parse. Within each B<Table> block, there are one or
7119 more B<Result> blocks, which configure which data to select and how to
7122 The following options are available inside a B<Table> block:
7126 =item B<Instance> I<instance>
7128 If specified, I<instance> is used as the plugin instance. So, in the above
7129 example, the plugin name C<table-slabinfo> would be used. If omitted, the
7130 filename of the table is used instead, with all special characters replaced
7131 with an underscore (C<_>).
7133 =item B<Separator> I<string>
7135 Any character of I<string> is interpreted as a delimiter between the different
7136 columns of the table. A sequence of two or more contiguous delimiters in the
7137 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7138 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7139 of a table - see its documentation for more details. This option is mandatory.
7141 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7142 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7143 required because of collectd's config parsing.
7147 The following options are available inside a B<Result> block:
7151 =item B<Type> I<type>
7153 Sets the type used to dispatch the values to the daemon. Detailed information
7154 about types and their configuration can be found in L<types.db(5)>. This
7155 option is mandatory.
7157 =item B<InstancePrefix> I<prefix>
7159 If specified, prepend I<prefix> to the type instance. If omitted, only the
7160 B<InstancesFrom> option is considered for the type instance.
7162 =item B<InstancesFrom> I<column0> [I<column1> ...]
7164 If specified, the content of the given columns (identified by the column
7165 number starting at zero) will be used to create the type instance for each
7166 row. Multiple values (and the instance prefix) will be joined together with
7167 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7168 option is considered for the type instance.
7170 The plugin itself does not check whether or not all built instances are
7171 different. It’s your responsibility to assure that each is unique. This is
7172 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7173 sure that the table only contains one row.
7175 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7178 =item B<ValuesFrom> I<column0> [I<column1> ...]
7180 Specifies the columns (identified by the column numbers starting at zero)
7181 whose content is used as the actual data for the data sets that are dispatched
7182 to the daemon. How many such columns you need is determined by the B<Type>
7183 setting above. If you specify too many or not enough columns, the plugin will
7184 complain about that and no data will be submitted to the daemon. The plugin
7185 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7186 respectively, so anything supported by those functions is supported by the
7187 plugin as well. This option is mandatory.
7191 =head2 Plugin C<tail>
7193 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7194 each line and dispatches found values. What is matched can be configured by the
7195 user using (extended) regular expressions, as described in L<regex(7)>.
7198 <File "/var/log/exim4/mainlog">
7202 Regex "S=([1-9][0-9]*)"
7208 Regex "\\<R=local_user\\>"
7209 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7212 Instance "local_user"
7215 Regex "l=([0-9]*\\.[0-9]*)"
7216 <DSType "Distribution">
7226 The config consists of one or more B<File> blocks, each of which configures one
7227 logfile to parse. Within each B<File> block, there are one or more B<Match>
7228 blocks, which configure a regular expression to search for.
7230 The B<Instance> option in the B<File> block may be used to set the plugin
7231 instance. So in the above example the plugin name C<tail-foo> would be used.
7232 This plugin instance is for all B<Match> blocks that B<follow> it, until the
7233 next B<Instance> option. This way you can extract several plugin instances from
7234 one logfile, handy when parsing syslog and the like.
7236 The B<Interval> option allows you to define the length of time between reads. If
7237 this is not set, the default Interval will be used.
7239 Each B<Match> block has the following options to describe how the match should
7244 =item B<Regex> I<regex>
7246 Sets the regular expression to use for matching against a line. The first
7247 subexpression has to match something that can be turned into a number by
7248 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7249 below. Because B<extended> regular expressions are used, you do not need to use
7250 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7251 collectd's config parsing you need to escape backslashes, though. So if you
7252 want to match literal parentheses you need to do the following:
7254 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7256 =item B<ExcludeRegex> I<regex>
7258 Sets an optional regular expression to use for excluding lines from the match.
7259 An example which excludes all connections from localhost from the match:
7261 ExcludeRegex "127\\.0\\.0\\.1"
7263 =item B<DSType> I<Type>
7265 Sets how the values are cumulated. I<Type> is one of:
7269 =item B<GaugeAverage>
7271 Calculate the average.
7275 Use the smallest number only.
7279 Use the greatest number only.
7283 Use the last number found.
7285 =item B<GaugePersist>
7287 Use the last number found. The number is not reset at the end of an interval.
7288 It is continously reported until another number is matched. This is intended
7289 for cases in which only state changes are reported, for example a thermometer
7290 that only reports the temperature when it changes.
7296 =item B<AbsoluteSet>
7298 The matched number is a counter. Simply I<sets> the internal counter to this
7299 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
7307 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
7308 matched number may be negative, which will effectively subtract from the
7317 Increase the internal counter by one. These B<DSType> are the only ones that do
7318 not use the matched subexpression, but simply count the number of matched
7319 lines. Thus, you may use a regular expression without submatch in this case.
7321 =item B<Distribution>
7323 Type to do calculations based on the distribution of values, primarily
7324 calculating percentiles. This is primarily geared towards latency, but can be
7325 used for other metrics as well. The range of values tracked with this setting
7326 must be in the range (0–2^34) and can be fractional. Please note that neither
7327 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
7330 This option must be used together with the B<Percentile> and/or B<Bucket>
7335 <DSType "Distribution">
7342 =item B<Percentile> I<Percent>
7344 Calculate and dispatch the configured percentile, i.e. compute the value, so
7345 that I<Percent> of all matched values are smaller than or equal to the computed
7348 Metrics are reported with the I<type> B<Type> (the value of the above option)
7349 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
7351 This option may be repeated to calculate more than one percentile.
7353 =item B<Bucket> I<lower_bound> I<upper_bound>
7355 Export the number of values (a C<DERIVE>) falling within the given range. Both,
7356 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
7357 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
7358 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
7359 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
7362 To export the entire (0–inf) range without overlap, use the upper bound of the
7363 previous range as the lower bound of the following range. In other words, use
7364 the following schema:
7374 Metrics are reported with the I<type> C<bucket> and the I<type instance>
7375 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
7377 This option may be repeated to calculate more than one rate.
7383 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
7384 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
7385 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
7386 B<Derive*> types interpret the submatch as a signed integer using
7387 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
7388 and it may be omitted in this case.
7390 =item B<Type> I<Type>
7392 Sets the type used to dispatch this value. Detailed information about types and
7393 their configuration can be found in L<types.db(5)>.
7395 =item B<Instance> I<TypeInstance>
7397 This optional setting sets the type instance to use.
7401 =head2 Plugin C<tail_csv>
7403 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
7404 written by I<Snort>.
7409 <Metric "snort-dropped">
7414 <File "/var/log/snort/snort.stats">
7415 Instance "snort-eth0"
7417 Collect "snort-dropped"
7421 The configuration consists of one or more B<Metric> blocks that define an index
7422 into the line of the CSV file and how this value is mapped to I<collectd's>
7423 internal representation. These are followed by one or more B<Instance> blocks
7424 which configure which file to read, in which interval and which metrics to
7429 =item E<lt>B<Metric> I<Name>E<gt>
7431 The B<Metric> block configures a new metric to be extracted from the statistics
7432 file and how it is mapped on I<collectd's> data model. The string I<Name> is
7433 only used inside the B<Instance> blocks to refer to this block, so you can use
7434 one B<Metric> block for multiple CSV files.
7438 =item B<Type> I<Type>
7440 Configures which I<Type> to use when dispatching this metric. Types are defined
7441 in the L<types.db(5)> file, see the appropriate manual page for more
7442 information on specifying types. Only types with a single I<data source> are
7443 supported by the I<tail_csv plugin>. The information whether the value is an
7444 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
7445 I<Type's> definition.
7447 =item B<Instance> I<TypeInstance>
7449 If set, I<TypeInstance> is used to populate the type instance field of the
7450 created value lists. Otherwise, no type instance is used.
7452 =item B<ValueFrom> I<Index>
7454 Configure to read the value from the field with the zero-based index I<Index>.
7455 If the value is parsed as signed integer, unsigned integer or double depends on
7456 the B<Type> setting, see above.
7460 =item E<lt>B<File> I<Path>E<gt>
7462 Each B<File> block represents one CSV file to read. There must be at least one
7463 I<File> block but there can be multiple if you have multiple CSV files.
7467 =item B<Instance> I<PluginInstance>
7469 Sets the I<plugin instance> used when dispatching the values.
7471 =item B<Collect> I<Metric>
7473 Specifies which I<Metric> to collect. This option must be specified at least
7474 once, and you can use this option multiple times to specify more than one
7475 metric to be extracted from this statistic file.
7477 =item B<Interval> I<Seconds>
7479 Configures the interval in which to read values from this instance / file.
7480 Defaults to the plugin's default interval.
7482 =item B<TimeFrom> I<Index>
7484 Rather than using the local time when dispatching a value, read the timestamp
7485 from the field with the zero-based index I<Index>. The value is interpreted as
7486 seconds since epoch. The value is parsed as a double and may be factional.
7492 =head2 Plugin C<teamspeak2>
7494 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
7495 polls interesting global and virtual server data. The plugin can query only one
7496 physical server but unlimited virtual servers. You can use the following
7497 options to configure it:
7501 =item B<Host> I<hostname/ip>
7503 The hostname or ip which identifies the physical server.
7506 =item B<Port> I<port>
7508 The query port of the physical server. This needs to be a string.
7511 =item B<Server> I<port>
7513 This option has to be added once for every virtual server the plugin should
7514 query. If you want to query the virtual server on port 8767 this is what the
7515 option would look like:
7519 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
7520 use quotes around it! If no such statement is given only global information
7525 =head2 Plugin C<ted>
7527 The I<TED> plugin connects to a device of "The Energy Detective", a device to
7528 measure power consumption. These devices are usually connected to a serial
7529 (RS232) or USB port. The plugin opens a configured device and tries to read the
7530 current energy readings. For more information on TED, visit
7531 L<http://www.theenergydetective.com/>.
7533 Available configuration options:
7537 =item B<Device> I<Path>
7539 Path to the device on which TED is connected. collectd will need read and write
7540 permissions on that file.
7542 Default: B</dev/ttyUSB0>
7544 =item B<Retries> I<Num>
7546 Apparently reading from TED is not that reliable. You can therefore configure a
7547 number of retries here. You only configure the I<retries> here, to if you
7548 specify zero, one reading will be performed (but no retries if that fails); if
7549 you specify three, a maximum of four readings are performed. Negative values
7556 =head2 Plugin C<tcpconns>
7558 The C<tcpconns plugin> counts the number of currently established TCP
7559 connections based on the local port and/or the remote port. Since there may be
7560 a lot of connections the default if to count all connections with a local port,
7561 for which a listening socket is opened. You can use the following options to
7562 fine-tune the ports you are interested in:
7566 =item B<ListeningPorts> I<true>|I<false>
7568 If this option is set to I<true>, statistics for all local ports for which a
7569 listening socket exists are collected. The default depends on B<LocalPort> and
7570 B<RemotePort> (see below): If no port at all is specifically selected, the
7571 default is to collect listening ports. If specific ports (no matter if local or
7572 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
7573 the selected ports will be collected unless this option is set to I<true>
7576 =item B<LocalPort> I<Port>
7578 Count the connections to a specific local port. This can be used to see how
7579 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
7580 You have to specify the port in numeric form, so for the mailserver example
7581 you'd need to set B<25>.
7583 =item B<RemotePort> I<Port>
7585 Count the connections to a specific remote port. This is useful to see how
7586 much a remote service is used. This is most useful if you want to know how many
7587 connections a local service has opened to remote services, e.E<nbsp>g. how many
7588 connections a mail server or news server has to other mail or news servers, or
7589 how many connections a web proxy holds to web servers. You have to give the
7590 port in numeric form.
7592 =item B<AllPortsSummary> I<true>|I<false>
7594 If this option is set to I<true> a summary of statistics from all connections
7595 are collected. This option defaults to I<false>.
7599 =head2 Plugin C<thermal>
7603 =item B<ForceUseProcfs> I<true>|I<false>
7605 By default, the I<Thermal plugin> tries to read the statistics from the Linux
7606 C<sysfs> interface. If that is not available, the plugin falls back to the
7607 C<procfs> interface. By setting this option to I<true>, you can force the
7608 plugin to use the latter. This option defaults to I<false>.
7610 =item B<Device> I<Device>
7612 Selects the name of the thermal device that you want to collect or ignore,
7613 depending on the value of the B<IgnoreSelected> option. This option may be
7614 used multiple times to specify a list of devices.
7616 =item B<IgnoreSelected> I<true>|I<false>
7618 Invert the selection: If set to true, all devices B<except> the ones that
7619 match the device names specified by the B<Device> option are collected. By
7620 default only selected devices are collected if a selection is made. If no
7621 selection is configured at all, B<all> devices are selected.
7625 =head2 Plugin C<threshold>
7627 The I<Threshold plugin> checks values collected or received by I<collectd>
7628 against a configurable I<threshold> and issues I<notifications> if values are
7631 Documentation for this plugin is available in the L<collectd-threshold(5)>
7634 =head2 Plugin C<tokyotyrant>
7636 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
7637 couple metrics: number of records, and database size on disk.
7641 =item B<Host> I<Hostname/IP>
7643 The hostname or IP which identifies the server.
7644 Default: B<127.0.0.1>
7646 =item B<Port> I<Service/Port>
7648 The query port of the server. This needs to be a string, even if the port is
7649 given in its numeric form.
7654 =head2 Plugin C<turbostat>
7656 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
7657 Intel processors by using I<Model Specific Registers>.
7661 =item B<CoreCstates> I<Bitmask(Integer)>
7663 Bit mask of the list of core C-states supported by the processor.
7664 This option should only be used if the automated detection fails.
7665 Default value extracted from the CPU model and family.
7667 Currently supported C-states (by this plugin): 3, 6, 7
7671 All states (3, 6 and 7):
7672 (1<<3) + (1<<6) + (1<<7) = 392
7674 =item B<PackageCstates> I<Bitmask(Integer)>
7676 Bit mask of the list of packages C-states supported by the processor. This
7677 option should only be used if the automated detection fails. Default value
7678 extracted from the CPU model and family.
7680 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
7684 States 2, 3, 6 and 7:
7685 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
7687 =item B<SystemManagementInterrupt> I<true>|I<false>
7689 Boolean enabling the collection of the I/O System-Management Interrupt counter.
7690 This option should only be used if the automated detection fails or if you want
7691 to disable this feature.
7693 =item B<DigitalTemperatureSensor> I<true>|I<false>
7695 Boolean enabling the collection of the temperature of each core. This option
7696 should only be used if the automated detection fails or if you want to disable
7699 =item B<TCCActivationTemp> I<Temperature>
7701 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
7702 temperature is used when collecting the temperature of cores or packages. This
7703 option should only be used if the automated detection fails. Default value
7704 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
7706 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
7708 Bit mask of the list of elements to be thermally monitored. This option should
7709 only be used if the automated detection fails or if you want to disable some
7710 collections. The different bits of this bit mask accepted by this plugin are:
7714 =item 0 ('1'): Package
7718 =item 2 ('4'): Cores
7720 =item 3 ('8'): Embedded graphic device
7724 =item B<LogicalCoreNames> I<true>|I<false>
7726 Boolean enabling the use of logical core numbering for per core statistics.
7727 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
7728 sequential number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
7729 where I<n> is the n-th core of the socket, causing name conflicts when there is
7730 more than one socket.
7734 =head2 Plugin C<unixsock>
7738 =item B<SocketFile> I<Path>
7740 Sets the socket-file which is to be created.
7742 =item B<SocketGroup> I<Group>
7744 If running as root change the group of the UNIX-socket after it has been
7745 created. Defaults to B<collectd>.
7747 =item B<SocketPerms> I<Permissions>
7749 Change the file permissions of the UNIX-socket after it has been created. The
7750 permissions must be given as a numeric, octal value as you would pass to
7751 L<chmod(1)>. Defaults to B<0770>.
7753 =item B<DeleteSocket> B<false>|B<true>
7755 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
7756 with the given name already exists. If I<collectd> crashes a socket file may be
7757 left over, preventing the daemon from opening a new socket when restarted.
7758 Since this is potentially dangerous, this defaults to B<false>.
7762 =head2 Plugin C<uuid>
7764 This plugin, if loaded, causes the Hostname to be taken from the machine's
7765 UUID. The UUID is a universally unique designation for the machine, usually
7766 taken from the machine's BIOS. This is most useful if the machine is running in
7767 a virtual environment such as Xen, in which case the UUID is preserved across
7768 shutdowns and migration.
7770 The following methods are used to find the machine's UUID, in order:
7776 Check I</etc/uuid> (or I<UUIDFile>).
7780 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
7785 Check for UUID from C<dmidecode> / SMBIOS.
7789 Check for UUID from Xen hypervisor.
7793 If no UUID can be found then the hostname is not modified.
7797 =item B<UUIDFile> I<Path>
7799 Take the UUID from the given file (default I</etc/uuid>).
7803 =head2 Plugin C<varnish>
7805 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
7806 It collects a subset of the values displayed by L<varnishstat(1)>, and
7807 organizes them in categories which can be enabled or disabled. Currently only
7808 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
7809 meaning of each metric can be found in L<varnish-counters(7)>.
7814 <Instance "example">
7818 CollectConnections true
7819 CollectDirectorDNS false
7823 CollectObjects false
7825 CollectSession false
7835 CollectWorkers false
7839 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
7840 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
7841 will collectd statistics from the default "varnishd" instance (this should work
7842 fine in most cases).
7844 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
7848 =item B<CollectBackend> B<true>|B<false>
7850 Back-end connection statistics, such as successful, reused,
7851 and closed connections. True by default.
7853 =item B<CollectBan> B<true>|B<false>
7855 Statistics about ban operations, such as number of bans added, retired, and
7856 number of objects tested against ban operations. Only available with Varnish
7857 3.x and above. False by default.
7859 =item B<CollectCache> B<true>|B<false>
7861 Cache hits and misses. True by default.
7863 =item B<CollectConnections> B<true>|B<false>
7865 Number of client connections received, accepted and dropped. True by default.
7867 =item B<CollectDirectorDNS> B<true>|B<false>
7869 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
7872 =item B<CollectESI> B<true>|B<false>
7874 Edge Side Includes (ESI) parse statistics. False by default.
7876 =item B<CollectFetch> B<true>|B<false>
7878 Statistics about fetches (HTTP requests sent to the backend). False by default.
7880 =item B<CollectHCB> B<true>|B<false>
7882 Inserts and look-ups in the crit bit tree based hash. Look-ups are
7883 divided into locked and unlocked look-ups. False by default.
7885 =item B<CollectObjects> B<true>|B<false>
7887 Statistics on cached objects: number of objects expired, nuked (prematurely
7888 expired), saved, moved, etc. False by default.
7890 =item B<CollectPurge> B<true>|B<false>
7892 Statistics about purge operations, such as number of purges added, retired, and
7893 number of objects tested against purge operations. Only available with Varnish
7894 2.x. False by default.
7896 =item B<CollectSession> B<true>|B<false>
7898 Client session statistics. Number of past and current sessions, session herd and
7899 linger counters, etc. False by default. Note that if using Varnish 4.x, some
7900 metrics found in the Connections and Threads sections with previous versions of
7901 Varnish have been moved here.
7903 =item B<CollectSHM> B<true>|B<false>
7905 Statistics about the shared memory log, a memory region to store
7906 log messages which is flushed to disk when full. True by default.
7908 =item B<CollectSMA> B<true>|B<false>
7910 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
7911 component is Solaris specific. Only available with Varnish 2.x. False by
7914 =item B<CollectSMS> B<true>|B<false>
7916 synth (synthetic content) storage statistics. This storage
7917 component is used internally only. False by default.
7919 =item B<CollectSM> B<true>|B<false>
7921 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
7924 =item B<CollectStruct> B<true>|B<false>
7926 Current varnish internal state statistics. Number of current sessions, objects
7927 in cache store, open connections to backends (with Varnish 2.x), etc. False by
7930 =item B<CollectTotals> B<true>|B<false>
7932 Collects overview counters, such as the number of sessions created,
7933 the number of requests and bytes transferred. False by default.
7935 =item B<CollectUptime> B<true>|B<false>
7937 Varnish uptime. Only available with Varnish 3.x and above. False by default.
7939 =item B<CollectVCL> B<true>|B<false>
7941 Number of total (available + discarded) VCL (config files). False by default.
7943 =item B<CollectVSM> B<true>|B<false>
7945 Collect statistics about Varnish's shared memory usage (used by the logging and
7946 statistics subsystems). Only available with Varnish 4.x. False by default.
7948 =item B<CollectWorkers> B<true>|B<false>
7950 Collect statistics about worker threads. False by default.
7954 =head2 Plugin C<virt>
7956 This plugin allows CPU, disk and network load to be collected for virtualized
7957 guests on the machine. This means that these metrics can be collected for guest
7958 systems without installing any software on them - I<collectd> only runs on the
7959 host system. The statistics are collected through libvirt
7960 (L<http://libvirt.org/>).
7962 Only I<Connection> is required.
7966 =item B<Connection> I<uri>
7968 Connect to the hypervisor given by I<uri>. For example if using Xen use:
7970 Connection "xen:///"
7972 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
7974 =item B<RefreshInterval> I<seconds>
7976 Refresh the list of domains and devices every I<seconds>. The default is 60
7977 seconds. Setting this to be the same or smaller than the I<Interval> will cause
7978 the list of domains and devices to be refreshed on every iteration.
7980 Refreshing the devices in particular is quite a costly operation, so if your
7981 virtualization setup is static you might consider increasing this. If this
7982 option is set to 0, refreshing is disabled completely.
7984 =item B<Domain> I<name>
7986 =item B<BlockDevice> I<name:dev>
7988 =item B<InterfaceDevice> I<name:dev>
7990 =item B<IgnoreSelected> B<true>|B<false>
7992 Select which domains and devices are collected.
7994 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
7995 disk/network devices are collected.
7997 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
7998 domains and disk/network devices are ignored, while the rest are collected.
8000 The domain name and device names may use a regular expression, if the name is
8001 surrounded by I</.../> and collectd was compiled with support for regexps.
8003 The default is to collect statistics for all domains and all their devices.
8007 BlockDevice "/:hdb/"
8008 IgnoreSelected "true"
8010 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8013 =item B<BlockDeviceFormat> B<target>|B<source>
8015 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8016 seen by the guest will be used for reporting metrics.
8017 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8020 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8021 using the path of the source, e.g. an image file.
8022 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8027 If the domain XML have the following device defined:
8029 <disk type='block' device='disk'>
8030 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8031 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8032 <target dev='sda' bus='scsi'/>
8034 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8037 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8039 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8040 to C<var_lib_libvirt_images_image1.qcow2>.
8042 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8044 The B<BlockDeviceFormatBasename> controls whether the full path or the
8045 L<basename(1)> of the source is being used as the I<type instance> when
8046 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8050 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8051 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8052 be set to C<var_lib_libvirt_images_image1.qcow2>.
8053 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8054 set to C<image1.qcow2>.
8056 =item B<HostnameFormat> B<name|uuid|hostname|...>
8058 When the virt plugin logs data, it sets the hostname of the collected data
8059 according to this setting. The default is to use the guest name as provided by
8060 the hypervisor, which is equal to setting B<name>.
8062 B<uuid> means use the guest's UUID. This is useful if you want to track the
8063 same guest across migrations.
8065 B<hostname> means to use the global B<Hostname> setting, which is probably not
8066 useful on its own because all guests will appear to have the same name.
8068 You can also specify combinations of these fields. For example B<name uuid>
8069 means to concatenate the guest name and UUID (with a literal colon character
8070 between, thus I<"foo:1234-1234-1234-1234">).
8072 At the moment of writing (collectd-5.5), hostname string is limited to 62
8073 characters. In case when combination of fields exceeds 62 characters,
8074 hostname will be truncated without a warning.
8076 =item B<InterfaceFormat> B<name>|B<address>
8078 When the virt plugin logs interface data, it sets the name of the collected
8079 data according to this setting. The default is to use the path as provided by
8080 the hypervisor (the "dev" property of the target node), which is equal to
8083 B<address> means use the interface's mac address. This is useful since the
8084 interface path might change between reboots of a guest or across migrations.
8086 =item B<PluginInstanceFormat> B<name|uuid|none>
8088 When the virt plugin logs data, it sets the plugin_instance of the collected
8089 data according to this setting. The default is to not set the plugin_instance.
8091 B<name> means use the guest's name as provided by the hypervisor.
8092 B<uuid> means use the guest's UUID.
8094 You can also specify combinations of the B<name> and B<uuid> fields.
8095 For example B<name uuid> means to concatenate the guest name and UUID
8096 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8098 =item B<Instances> B<integer>
8100 How many read instances you want to use for this plugin. The default is one,
8101 and the sensible setting is a multiple of the B<ReadThreads> value.
8102 If you are not sure, just use the default setting.
8106 =head2 Plugin C<vmem>
8108 The C<vmem> plugin collects information about the usage of virtual memory.
8109 Since the statistics provided by the Linux kernel are very detailed, they are
8110 collected very detailed. However, to get all the details, you have to switch
8111 them on manually. Most people just want an overview over, such as the number of
8112 pages read from swap space.
8116 =item B<Verbose> B<true>|B<false>
8118 Enables verbose collection of information. This will start collecting page
8119 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8120 Part of these statistics are collected on a "per zone" basis.
8124 =head2 Plugin C<vserver>
8126 This plugin doesn't have any options. B<VServer> support is only available for
8127 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8128 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8129 need to apply the patches and compile your own kernel, which will then provide
8130 the F</proc/virtual> filesystem that is required by this plugin.
8132 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8134 B<Note>: The traffic collected by this plugin accounts for the amount of
8135 traffic passing a socket which might be a lot less than the actual on-wire
8136 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8137 collect on-wire traffic you could, for example, use the logging facilities of
8138 iptables to feed data for the guest IPs into the iptables plugin.
8140 =head2 Plugin C<write_graphite>
8142 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8143 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8144 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8145 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8146 of at most 1428 bytes to minimize the number of network packets.
8150 <Plugin write_graphite>
8160 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8161 blocks. Inside the B<Node> blocks, the following options are recognized:
8165 =item B<Host> I<Address>
8167 Hostname or address to connect to. Defaults to C<localhost>.
8169 =item B<Port> I<Service>
8171 Service name or port number to connect to. Defaults to C<2003>.
8173 =item B<Protocol> I<String>
8175 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
8177 =item B<ReconnectInterval> I<Seconds>
8179 When set to non-zero, forces the connection to the Graphite backend to be
8180 closed and re-opend periodically. This behavior is desirable in environments
8181 where the connection to the Graphite backend is done through load balancers,
8182 for example. When set to zero, the default, the connetion is kept open for as
8185 =item B<LogSendErrors> B<false>|B<true>
8187 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
8188 If set to B<false>, it will not log the errors. This is especially useful when
8189 using Protocol UDP since many times we want to use the "fire-and-forget"
8190 approach and logging errors fills syslog with unneeded messages.
8192 =item B<Prefix> I<String>
8194 When set, I<String> is added in front of the host name. Dots and whitespace are
8195 I<not> escaped in this string (see B<EscapeCharacter> below).
8197 =item B<Postfix> I<String>
8199 When set, I<String> is appended to the host name. Dots and whitespace are
8200 I<not> escaped in this string (see B<EscapeCharacter> below).
8202 =item B<EscapeCharacter> I<Char>
8204 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
8205 in the identifier. The B<EscapeCharacter> option determines which character
8206 dots, whitespace and control characters are replaced with. Defaults to
8209 =item B<StoreRates> B<false>|B<true>
8211 If set to B<true> (the default), convert counter values to rates. If set to
8212 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
8215 =item B<SeparateInstances> B<false>|B<true>
8217 If set to B<true>, the plugin instance and type instance will be in their own
8218 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8219 default), the plugin and plugin instance (and likewise the type and type
8220 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8222 =item B<AlwaysAppendDS> B<false>|B<true>
8224 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
8225 identifier. If set to B<false> (the default), this is only done when there is
8228 =item B<PreserveSeparator> B<false>|B<true>
8230 If set to B<false> (the default) the C<.> (dot) character is replaced with
8231 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
8232 is preserved, i.e. passed through.
8234 =item B<DropDuplicateFields> B<false>|B<true>
8236 If set to B<true>, detect and remove duplicate components in Graphite metric
8237 names. For example, the metric name C<host.load.load.shortterm> will
8238 be shortened to C<host.load.shortterm>.
8242 =head2 Plugin C<write_log>
8244 The C<write_log> plugin writes metrics as INFO log messages.
8246 This plugin supports two output formats: I<Graphite> and I<JSON>.
8256 =item B<Format> I<Format>
8258 The output format to use. Can be one of C<Graphite> or C<JSON>.
8262 =head2 Plugin C<write_tsdb>
8264 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
8265 time series database. The plugin connects to a I<TSD>, a masterless, no shared
8266 state daemon that ingests metrics and stores them in HBase. The plugin uses
8267 I<TCP> over the "line based" protocol with a default port 4242. The data will
8268 be sent in blocks of at most 1428 bytes to minimize the number of network
8277 Host "tsd-1.my.domain"
8279 HostTags "status=production"
8283 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8284 blocks and global directives.
8286 Global directives are:
8290 =item B<ResolveInterval> I<seconds>
8292 =item B<ResolveJitter> I<seconds>
8294 When I<collectd> connects to a TSDB node, it will request the hostname from
8295 DNS. This can become a problem if the TSDB node is unavailable or badly
8296 configured because collectd will request DNS in order to reconnect for every
8297 metric, which can flood your DNS. So you can cache the last value for
8298 I<ResolveInterval> seconds.
8299 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8301 You can also define a jitter, a random interval to wait in addition to
8302 I<ResolveInterval>. This prevents all your collectd servers to resolve the
8303 hostname at the same time when the connection fails.
8304 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8306 B<Note:> If the DNS resolution has already been successful when the socket
8307 closes, the plugin will try to reconnect immediately with the cached
8308 information. DNS is queried only when the socket is closed for a longer than
8309 I<ResolveInterval> + I<ResolveJitter> seconds.
8313 Inside the B<Node> blocks, the following options are recognized:
8317 =item B<Host> I<Address>
8319 Hostname or address to connect to. Defaults to C<localhost>.
8321 =item B<Port> I<Service>
8323 Service name or port number to connect to. Defaults to C<4242>.
8326 =item B<HostTags> I<String>
8328 When set, I<HostTags> is added to the end of the metric. It is intended to be
8329 used for name=value pairs that the TSD will tag the metric with. Dots and
8330 whitespace are I<not> escaped in this string.
8332 =item B<StoreRates> B<false>|B<true>
8334 If set to B<true>, convert counter values to rates. If set to B<false>
8335 (the default) counter values are stored as is, as an increasing
8338 =item B<AlwaysAppendDS> B<false>|B<true>
8340 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
8341 identifier. If set to B<false> (the default), this is only done when there is
8346 =head2 Plugin C<write_mongodb>
8348 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
8353 <Plugin "write_mongodb">
8362 The plugin can send values to multiple instances of I<MongoDB> by specifying
8363 one B<Node> block for each instance. Within the B<Node> blocks, the following
8364 options are available:
8368 =item B<Host> I<Address>
8370 Hostname or address to connect to. Defaults to C<localhost>.
8372 =item B<Port> I<Service>
8374 Service name or port number to connect to. Defaults to C<27017>.
8376 =item B<Timeout> I<Milliseconds>
8378 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
8379 Setting this option to zero means no timeout, which is the default.
8381 =item B<StoreRates> B<false>|B<true>
8383 If set to B<true> (the default), convert counter values to rates. If set to
8384 B<false> counter values are stored as is, i.e. as an increasing integer
8387 =item B<Database> I<Database>
8389 =item B<User> I<User>
8391 =item B<Password> I<Password>
8393 Sets the information used when authenticating to a I<MongoDB> database. The
8394 fields are optional (in which case no authentication is attempted), but if you
8395 want to use authentication all three fields must be set.
8399 =head2 Plugin C<write_prometheus>
8401 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
8402 using I<Prometheus>.
8408 =item B<Port> I<Port>
8410 Port the embedded webserver should listen on. Defaults to B<9103>.
8412 =item B<StalenessDelta> I<Seconds>
8414 Time in seconds after which I<Prometheus> considers a metric "stale" if it
8415 hasn't seen any update for it. This value must match the setting in Prometheus.
8416 It defaults to B<300> seconds (5 minutes), same as Prometheus.
8420 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
8421 which time a metric without updates is considered "stale". This setting
8422 effectively puts an upper limit on the interval in which metrics are reported.
8424 When the I<write_prometheus plugin> encounters a metric with an interval
8425 exceeding this limit, it will inform you, the user, and provide the metric to
8426 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
8427 metric "fresh" each time it is scraped, with the time of the scrape being
8428 considered the time of the update. The result is that there appear more
8429 datapoints in I<Prometheus> than were actually created, but at least the metric
8430 doesn't disappear periodically.
8434 =head2 Plugin C<write_http>
8436 This output plugin submits values to an HTTP server using POST requests and
8437 encoding metrics with JSON or using the C<PUTVAL> command described in
8438 L<collectd-unixsock(5)>.
8442 <Plugin "write_http">
8444 URL "http://example.com/post-collectd"
8451 The plugin can send values to multiple HTTP servers by specifying one
8452 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
8453 block, the following options are available:
8459 URL to which the values are submitted to. Mandatory.
8461 =item B<User> I<Username>
8463 Optional user name needed for authentication.
8465 =item B<Password> I<Password>
8467 Optional password needed for authentication.
8469 =item B<VerifyPeer> B<true>|B<false>
8471 Enable or disable peer SSL certificate verification. See
8472 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
8474 =item B<VerifyHost> B<true|false>
8476 Enable or disable peer host name verification. If enabled, the plugin checks if
8477 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
8478 matches the host name provided by the B<URL> option. If this identity check
8479 fails, the connection is aborted. Obviously, only works when connecting to a
8480 SSL enabled server. Enabled by default.
8482 =item B<CACert> I<File>
8484 File that holds one or more SSL certificates. If you want to use HTTPS you will
8485 possibly need this option. What CA certificates come bundled with C<libcurl>
8486 and are checked by default depends on the distribution you use.
8488 =item B<CAPath> I<Directory>
8490 Directory holding one or more CA certificate files. You can use this if for
8491 some reason all the needed CA certificates aren't in the same file and can't be
8492 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
8495 =item B<ClientKey> I<File>
8497 File that holds the private key in PEM format to be used for certificate-based
8500 =item B<ClientCert> I<File>
8502 File that holds the SSL certificate to be used for certificate-based
8505 =item B<ClientKeyPass> I<Password>
8507 Password required to load the private key in B<ClientKey>.
8509 =item B<Header> I<Header>
8511 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
8513 Header "X-Custom-Header: custom_value"
8515 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
8517 Define which SSL protocol version must be used. By default C<libcurl> will
8518 attempt to figure out the remote SSL protocol version. See
8519 L<curl_easy_setopt(3)> for more details.
8521 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
8523 Format of the output to generate. If set to B<Command>, will create output that
8524 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
8525 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
8526 , will create output in the KairosDB format.
8528 Defaults to B<Command>.
8530 =item B<Metrics> B<true>|B<false>
8532 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
8534 =item B<Notifications> B<false>|B<true>
8536 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
8538 =item B<StoreRates> B<true|false>
8540 If set to B<true>, convert counter values to rates. If set to B<false> (the
8541 default) counter values are stored as is, i.e. as an increasing integer number.
8543 =item B<BufferSize> I<Bytes>
8545 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
8546 requests will be generated, but more metrics will be batched / metrics are
8547 cached for longer before being sent, introducing additional delay until they
8548 are available on the server side. I<Bytes> must be at least 1024 and cannot
8549 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
8550 Defaults to C<4096>.
8552 =item B<LowSpeedLimit> I<Bytes per Second>
8554 Sets the minimal transfer rate in I<Bytes per Second> below which the
8555 connection with the HTTP server will be considered too slow and aborted. All
8556 the data submitted over this connection will probably be lost. Defaults to 0,
8557 which means no minimum transfer rate is enforced.
8559 =item B<Timeout> I<Timeout>
8561 Sets the maximum time in milliseconds given for HTTP POST operations to
8562 complete. When this limit is reached, the POST operation will be aborted, and
8563 all the data in the current send buffer will probably be lost. Defaults to 0,
8564 which means the connection never times out.
8566 =item B<LogHttpError> B<false>|B<true>
8568 Enables printing of HTTP error code to log. Turned off by default.
8570 The C<write_http> plugin regularly submits the collected values to the HTTP
8571 server. How frequently this happens depends on how much data you are collecting
8572 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
8573 slightly below this interval, which you can estimate by monitoring the network
8574 traffic between collectd and the HTTP server.
8578 =head2 Plugin C<write_kafka>
8580 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
8584 <Plugin "write_kafka">
8585 Property "metadata.broker.list" "broker1:9092,broker2:9092"
8591 The following options are understood by the I<write_kafka plugin>:
8595 =item E<lt>B<Topic> I<Name>E<gt>
8597 The plugin's configuration consists of one or more B<Topic> blocks. Each block
8598 is given a unique I<Name> and specifies one kafka producer.
8599 Inside the B<Topic> block, the following per-topic options are
8604 =item B<Property> I<String> I<String>
8606 Configure the named property for the current topic. Properties are
8607 forwarded to the kafka producer library B<librdkafka>.
8609 =item B<Key> I<String>
8611 Use the specified string as a partitioning key for the topic. Kafka breaks
8612 topic into partitions and guarantees that for a given topology, the same
8613 consumer will be used for a specific key. The special (case insensitive)
8614 string B<Random> can be used to specify that an arbitrary partition should
8617 =item B<Format> B<Command>|B<JSON>|B<Graphite>
8619 Selects the format in which messages are sent to the broker. If set to
8620 B<Command> (the default), values are sent as C<PUTVAL> commands which are
8621 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
8623 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
8624 an easy and straight forward exchange format.
8626 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
8627 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
8629 =item B<StoreRates> B<true>|B<false>
8631 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
8632 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
8633 default), no conversion is performed. Otherwise the conversion is performed
8634 using the internal value cache.
8636 Please note that currently this option is only used if the B<Format> option has
8637 been set to B<JSON>.
8639 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
8641 A prefix can be added in the metric name when outputting in the I<Graphite>
8642 format. It's added before the I<Host> name.
8644 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>>
8646 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
8648 A postfix can be added in the metric name when outputting in the I<Graphite>
8649 format. It's added after the I<Host> name.
8651 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>>
8653 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
8655 Specify a character to replace dots (.) in the host part of the metric name.
8656 In I<Graphite> metric name, dots are used as separators between different
8657 metric parts (host, plugin, type).
8658 Default is C<_> (I<Underscore>).
8660 =item B<GraphiteSeparateInstances> B<false>|B<true>
8662 If set to B<true>, the plugin instance and type instance will be in their own
8663 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8664 default), the plugin and plugin instance (and likewise the type and type
8665 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8667 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
8669 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
8670 identifier. If set to B<false> (the default), this is only done when there is
8673 =item B<GraphitePreserveSeparator> B<false>|B<true>
8675 If set to B<false> (the default) the C<.> (dot) character is replaced with
8676 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
8677 is preserved, i.e. passed through.
8679 =item B<StoreRates> B<true>|B<false>
8681 If set to B<true> (the default), convert counter values to rates. If set to
8682 B<false> counter values are stored as is, i.e. as an increasing integer number.
8684 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
8685 converted values will have "rate" appended to the data source type, e.g.
8686 C<ds_type:derive:rate>.
8690 =item B<Property> I<String> I<String>
8692 Configure the kafka producer through properties, you almost always will
8693 want to set B<metadata.broker.list> to your Kafka broker list.
8697 =head2 Plugin C<write_redis>
8699 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
8703 <Plugin "write_redis">
8715 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
8716 the timestamp as the score. Retrieving a date range can then be done using the
8717 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
8718 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
8719 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
8720 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
8721 with the B<Database> parameter (default is C<0>). See
8722 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
8725 The information shown in the synopsis above is the I<default configuration>
8726 which is used by the plugin if no configuration is present.
8728 The plugin can send values to multiple instances of I<Redis> by specifying
8729 one B<Node> block for each instance. Within the B<Node> blocks, the following
8730 options are available:
8734 =item B<Node> I<Nodename>
8736 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
8737 instance running on a specified host and port. The node name is a
8738 canonical identifier which is used as I<plugin instance>. It is limited to
8739 51E<nbsp>characters in length.
8741 =item B<Host> I<Hostname>
8743 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
8746 =item B<Port> I<Port>
8748 The B<Port> option is the TCP port on which the Redis instance accepts
8749 connections. Either a service name of a port number may be given. Please note
8750 that numerical port numbers must be given as a string, too.
8752 =item B<Timeout> I<Milliseconds>
8754 The B<Timeout> option sets the socket connection timeout, in milliseconds.
8756 =item B<Prefix> I<Prefix>
8758 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
8759 containing all metrics. Defaults to C<collectd/>, so metrics will have names
8760 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
8761 is recommended but not required to include a trailing slash in I<Prefix>.
8763 =item B<Database> I<Index>
8765 This index selects the redis database to use for writing operations. Defaults
8768 =item B<MaxSetSize> I<Items>
8770 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
8771 hold. Negative values for I<Items> sets no limit, which is the default behavior.
8773 =item B<StoreRates> B<true>|B<false>
8775 If set to B<true> (the default), convert counter values to rates. If set to
8776 B<false> counter values are stored as is, i.e. as an increasing integer number.
8780 =head2 Plugin C<write_riemann>
8782 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
8783 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
8784 I<Riemann> using UDP packets.
8788 <Plugin "write_riemann">
8794 AlwaysAppendDS false
8798 Attribute "foo" "bar"
8801 The following options are understood by the I<write_riemann plugin>:
8805 =item E<lt>B<Node> I<Name>E<gt>
8807 The plugin's configuration consists of one or more B<Node> blocks. Each block
8808 is given a unique I<Name> and specifies one connection to an instance of
8809 I<Riemann>. Indise the B<Node> block, the following per-connection options are
8814 =item B<Host> I<Address>
8816 Hostname or address to connect to. Defaults to C<localhost>.
8818 =item B<Port> I<Service>
8820 Service name or port number to connect to. Defaults to C<5555>.
8822 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
8824 Specify the protocol to use when communicating with I<Riemann>. Defaults to
8827 =item B<TLSCertFile> I<Path>
8829 When using the B<TLS> protocol, path to a PEM certificate to present
8832 =item B<TLSCAFile> I<Path>
8834 When using the B<TLS> protocol, path to a PEM CA certificate to
8835 use to validate the remote hosts's identity.
8837 =item B<TLSKeyFile> I<Path>
8839 When using the B<TLS> protocol, path to a PEM private key associated
8840 with the certificate defined by B<TLSCertFile>.
8842 =item B<Batch> B<true>|B<false>
8844 If set to B<true> and B<Protocol> is set to B<TCP>,
8845 events will be batched in memory and flushed at
8846 regular intervals or when B<BatchMaxSize> is exceeded.
8848 Notifications are not batched and sent as soon as possible.
8850 When enabled, it can occur that events get processed by the Riemann server
8851 close to or after their expiration time. Tune the B<TTLFactor> and
8852 B<BatchMaxSize> settings according to the amount of values collected, if this
8857 =item B<BatchMaxSize> I<size>
8859 Maximum payload size for a riemann packet. Defaults to 8192
8861 =item B<BatchFlushTimeout> I<seconds>
8863 Maximum amount of seconds to wait in between to batch flushes.
8864 No timeout by default.
8866 =item B<StoreRates> B<true>|B<false>
8868 If set to B<true> (the default), convert counter values to rates. If set to
8869 B<false> counter values are stored as is, i.e. as an increasing integer number.
8871 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
8872 converted values will have "rate" appended to the data source type, e.g.
8873 C<ds_type:derive:rate>.
8875 =item B<AlwaysAppendDS> B<false>|B<true>
8877 If set to B<true>, append the name of the I<Data Source> (DS) to the
8878 "service", i.e. the field that, together with the "host" field, uniquely
8879 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
8880 only done when there is more than one DS.
8882 =item B<TTLFactor> I<Factor>
8884 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
8885 event is considered active. I<collectd> populates this field based on the
8886 metrics interval setting. This setting controls the factor with which the
8887 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
8888 know exactly what you're doing, you should only increase this setting from its
8891 =item B<Notifications> B<false>|B<true>
8893 If set to B<true>, create riemann events for notifications. This is B<true>
8894 by default. When processing thresholds from write_riemann, it might prove
8895 useful to avoid getting notification events.
8897 =item B<CheckThresholds> B<false>|B<true>
8899 If set to B<true>, attach state to events based on thresholds defined
8900 in the B<Threshold> plugin. Defaults to B<false>.
8902 =item B<EventServicePrefix> I<String>
8904 Add the given string as a prefix to the event service name.
8905 If B<EventServicePrefix> not set or set to an empty string (""),
8906 no prefix will be used.
8910 =item B<Tag> I<String>
8912 Add the given string as an additional tag to the metric being sent to
8915 =item B<Attribute> I<String> I<String>
8917 Consider the two given strings to be the key and value of an additional
8918 attribute for each metric being sent out to I<Riemann>.
8922 =head2 Plugin C<write_sensu>
8924 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
8925 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
8926 a local I<Sensu> client using a TCP socket.
8928 At the moment, the I<write_sensu plugin> does not send over a collectd_host
8929 parameter so it is not possible to use one collectd instance as a gateway for
8930 others. Each collectd host must pair with one I<Sensu> client.
8934 <Plugin "write_sensu">
8939 AlwaysAppendDS false
8940 MetricHandler "influx"
8941 MetricHandler "default"
8942 NotificationHandler "flapjack"
8943 NotificationHandler "howling_monkey"
8947 Attribute "foo" "bar"
8950 The following options are understood by the I<write_sensu plugin>:
8954 =item E<lt>B<Node> I<Name>E<gt>
8956 The plugin's configuration consists of one or more B<Node> blocks. Each block
8957 is given a unique I<Name> and specifies one connection to an instance of
8958 I<Sensu>. Inside the B<Node> block, the following per-connection options are
8963 =item B<Host> I<Address>
8965 Hostname or address to connect to. Defaults to C<localhost>.
8967 =item B<Port> I<Service>
8969 Service name or port number to connect to. Defaults to C<3030>.
8971 =item B<StoreRates> B<true>|B<false>
8973 If set to B<true> (the default), convert counter values to rates. If set to
8974 B<false> counter values are stored as is, i.e. as an increasing integer number.
8976 This will be reflected in the C<collectd_data_source_type> tag: If
8977 B<StoreRates> is enabled, converted values will have "rate" appended to the
8978 data source type, e.g. C<collectd_data_source_type:derive:rate>.
8980 =item B<AlwaysAppendDS> B<false>|B<true>
8982 If set the B<true>, append the name of the I<Data Source> (DS) to the
8983 "service", i.e. the field that, together with the "host" field, uniquely
8984 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
8985 only done when there is more than one DS.
8987 =item B<Notifications> B<false>|B<true>
8989 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
8990 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8992 =item B<Metrics> B<false>|B<true>
8994 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
8995 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
8998 =item B<Separator> I<String>
9000 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9002 =item B<MetricHandler> I<String>
9004 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9005 several of them, one per line. Defaults to no handler.
9007 =item B<NotificationHandler> I<String>
9009 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9010 add several of them, one per line. Defaults to no handler.
9012 =item B<EventServicePrefix> I<String>
9014 Add the given string as a prefix to the event service name.
9015 If B<EventServicePrefix> not set or set to an empty string (""),
9016 no prefix will be used.
9020 =item B<Tag> I<String>
9022 Add the given string as an additional tag to the metric being sent to
9025 =item B<Attribute> I<String> I<String>
9027 Consider the two given strings to be the key and value of an additional
9028 attribute for each metric being sent out to I<Sensu>.
9032 =head2 Plugin C<xencpu>
9034 This plugin collects metrics of hardware CPU load for machine running Xen
9035 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9036 Result is reported using the C<percent> type, for each CPU (core).
9038 This plugin doesn't have any options (yet).
9040 =head2 Plugin C<zookeeper>
9042 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9043 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9048 <Plugin "zookeeper">
9055 =item B<Host> I<Address>
9057 Hostname or address to connect to. Defaults to C<localhost>.
9059 =item B<Port> I<Service>
9061 Service name or port number to connect to. Defaults to C<2181>.
9065 =head1 THRESHOLD CONFIGURATION
9067 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9068 we mean that the values are not only stored or sent somewhere, but that they
9069 are judged and, if a problem is recognized, acted upon. The only action
9070 collectd takes itself is to generate and dispatch a "notification". Plugins can
9071 register to receive notifications and perform appropriate further actions.
9073 Since systems and what you expect them to do differ a lot, you can configure
9074 B<thresholds> for your values freely. This gives you a lot of flexibility but
9075 also a lot of responsibility.
9077 Every time a value is out of range a notification is dispatched. This means
9078 that the idle percentage of your CPU needs to be less then the configured
9079 threshold only once for a notification to be generated. There's no such thing
9080 as a moving average or similar - at least not now.
9082 Also, all values that match a threshold are considered to be relevant or
9083 "interesting". As a consequence collectd will issue a notification if they are
9084 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9085 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9086 "2" (the default) and some hosts sends it's CPU statistics to the server every
9087 60 seconds, a notification will be dispatched after about 120 seconds. It may
9088 take a little longer because the timeout is checked only once each B<Interval>
9091 When a value comes within range again or is received after it was missing, an
9092 "OKAY-notification" is dispatched.
9094 Here is a configuration example to get you started. Read below for more
9107 <Plugin "interface">
9124 WarningMin 100000000
9130 There are basically two types of configuration statements: The C<Host>,
9131 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
9132 configured. The C<Plugin> and C<Type> blocks may be specified further using the
9133 C<Instance> option. You can combine the block by nesting the blocks, though
9134 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
9135 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
9136 C<Type> may not contain other blocks. If multiple blocks apply to the same
9137 value the most specific block is used.
9139 The other statements specify the threshold to configure. They B<must> be
9140 included in a C<Type> block. Currently the following statements are recognized:
9144 =item B<FailureMax> I<Value>
9146 =item B<WarningMax> I<Value>
9148 Sets the upper bound of acceptable values. If unset defaults to positive
9149 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
9150 will be created. If the value is greater than B<WarningMax> but less than (or
9151 equal to) B<FailureMax> a B<WARNING> notification will be created.
9153 =item B<FailureMin> I<Value>
9155 =item B<WarningMin> I<Value>
9157 Sets the lower bound of acceptable values. If unset defaults to negative
9158 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
9159 be created. If the value is less than B<WarningMin> but greater than (or equal
9160 to) B<FailureMin> a B<WARNING> notification will be created.
9162 =item B<DataSource> I<DSName>
9164 Some data sets have more than one "data source". Interesting examples are the
9165 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
9166 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
9167 system load data set, C<load>, even has three data sources: C<shortterm>,
9168 C<midterm>, and C<longterm>.
9170 Normally, all data sources are checked against a configured threshold. If this
9171 is undesirable, or if you want to specify different limits for each data
9172 source, you can use the B<DataSource> option to have a threshold apply only to
9175 =item B<Invert> B<true>|B<false>
9177 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
9178 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
9179 B<WarningMax>) are not okay. Defaults to B<false>.
9181 =item B<Persist> B<true>|B<false>
9183 Sets how often notifications are generated. If set to B<true> one notification
9184 will be generated for each value that is out of the acceptable range. If set to
9185 B<false> (the default) then a notification is only generated if a value is out
9186 of range but the previous value was okay.
9188 This applies to missing values, too: If set to B<true> a notification about a
9189 missing value is generated once every B<Interval> seconds. If set to B<false>
9190 only one such notification is generated until the value appears again.
9192 =item B<Percentage> B<true>|B<false>
9194 If set to B<true>, the minimum and maximum values given are interpreted as
9195 percentage value, relative to the other data sources. This is helpful for
9196 example for the "df" type, where you may want to issue a warning when less than
9197 5E<nbsp>% of the total space is available. Defaults to B<false>.
9199 =item B<Hits> I<Number>
9201 Delay creating the notification until the threshold has been passed I<Number>
9202 times. When a notification has been generated, or when a subsequent value is
9203 inside the threshold, the counter is reset. If, for example, a value is
9204 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
9205 will be dispatched at most once every 30E<nbsp>seconds.
9207 This is useful when short bursts are not a problem. If, for example, 100% CPU
9208 usage for up to a minute is normal (and data is collected every
9209 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
9211 =item B<Hysteresis> I<Number>
9213 When set to non-zero, a hysteresis value is applied when checking minimum and
9214 maximum bounds. This is useful for values that increase slowly and fluctuate a
9215 bit while doing so. When these values come close to the threshold, they may
9216 "flap", i.e. switch between failure / warning case and okay case repeatedly.
9218 If, for example, the threshold is configures as
9223 then a I<Warning> notification is created when the value exceeds I<101> and the
9224 corresponding I<Okay> notification is only created once the value falls below
9225 I<99>, thus avoiding the "flapping".
9229 =head1 FILTER CONFIGURATION
9231 Starting with collectd 4.6 there is a powerful filtering infrastructure
9232 implemented in the daemon. The concept has mostly been copied from
9233 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
9234 terminology, so that users that are familiar with iptables feel right at home.
9238 The following are the terms used in the remainder of the filter configuration
9239 documentation. For an ASCII-art schema of the mechanism, see
9240 L<"General structure"> below.
9246 A I<match> is a criteria to select specific values. Examples are, of course, the
9247 name of the value or it's current value.
9249 Matches are implemented in plugins which you have to load prior to using the
9250 match. The name of such plugins starts with the "match_" prefix.
9254 A I<target> is some action that is to be performed with data. Such actions
9255 could, for example, be to change part of the value's identifier or to ignore
9256 the value completely.
9258 Some of these targets are built into the daemon, see L<"Built-in targets">
9259 below. Other targets are implemented in plugins which you have to load prior to
9260 using the target. The name of such plugins starts with the "target_" prefix.
9264 The combination of any number of matches and at least one target is called a
9265 I<rule>. The target actions will be performed for all values for which B<all>
9266 matches apply. If the rule does not have any matches associated with it, the
9267 target action will be performed for all values.
9271 A I<chain> is a list of rules and possibly default targets. The rules are tried
9272 in order and if one matches, the associated target will be called. If a value
9273 is handled by a rule, it depends on the target whether or not any subsequent
9274 rules are considered or if traversal of the chain is aborted, see
9275 L<"Flow control"> below. After all rules have been checked, the default targets
9280 =head2 General structure
9282 The following shows the resulting structure:
9289 +---------+ +---------+ +---------+ +---------+
9290 ! Rule !->! Match !->! Match !->! Target !
9291 +---------+ +---------+ +---------+ +---------+
9294 +---------+ +---------+ +---------+
9295 ! Rule !->! Target !->! Target !
9296 +---------+ +---------+ +---------+
9303 +---------+ +---------+ +---------+
9304 ! Rule !->! Match !->! Target !
9305 +---------+ +---------+ +---------+
9315 There are four ways to control which way a value takes through the filter
9322 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
9323 process the value with another chain. When the called chain finishes, usually
9324 the next target or rule after the jump is executed.
9328 The stop condition, signaled for example by the built-in target B<stop>, causes
9329 all processing of the value to be stopped immediately.
9333 Causes processing in the current chain to be aborted, but processing of the
9334 value generally will continue. This means that if the chain was called via
9335 B<Jump>, the next target or rule after the jump will be executed. If the chain
9336 was not called by another chain, control will be returned to the daemon and it
9337 may pass the value to another chain.
9341 Most targets will signal the B<continue> condition, meaning that processing
9342 should continue normally. There is no special built-in target for this
9349 The configuration reflects this structure directly:
9351 PostCacheChain "PostCache"
9353 <Rule "ignore_mysql_show">
9356 Type "^mysql_command$"
9357 TypeInstance "^show_"
9367 The above configuration example will ignore all values where the plugin field
9368 is "mysql", the type is "mysql_command" and the type instance begins with
9369 "show_". All other values will be sent to the C<rrdtool> write plugin via the
9370 default target of the chain. Since this chain is run after the value has been
9371 added to the cache, the MySQL C<show_*> command statistics will be available
9372 via the C<unixsock> plugin.
9374 =head2 List of configuration options
9378 =item B<PreCacheChain> I<ChainName>
9380 =item B<PostCacheChain> I<ChainName>
9382 Configure the name of the "pre-cache chain" and the "post-cache chain". The
9383 argument is the name of a I<chain> that should be executed before and/or after
9384 the values have been added to the cache.
9386 To understand the implications, it's important you know what is going on inside
9387 I<collectd>. The following diagram shows how values are passed from the
9388 read-plugins to the write-plugins:
9394 + - - - - V - - - - +
9395 : +---------------+ :
9398 : +-------+-------+ :
9401 : +-------+-------+ : +---------------+
9402 : ! Cache !--->! Value Cache !
9403 : ! insert ! : +---+---+-------+
9404 : +-------+-------+ : ! !
9405 : ! ,------------' !
9407 : +-------+---+---+ : +-------+-------+
9408 : ! Post-Cache +--->! Write-Plugins !
9409 : ! Chain ! : +---------------+
9410 : +---------------+ :
9413 + - - - - - - - - - +
9415 After the values are passed from the "read" plugins to the dispatch functions,
9416 the pre-cache chain is run first. The values are added to the internal cache
9417 afterwards. The post-cache chain is run after the values have been added to the
9418 cache. So why is it such a huge deal if chains are run before or after the
9419 values have been added to this cache?
9421 Targets that change the identifier of a value list should be executed before
9422 the values are added to the cache, so that the name in the cache matches the
9423 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
9424 this cache to receive a list of all available values. If you change the
9425 identifier after the value list has been added to the cache, this may easily
9426 lead to confusion, but it's not forbidden of course.
9428 The cache is also used to convert counter values to rates. These rates are, for
9429 example, used by the C<value> match (see below). If you use the rate stored in
9430 the cache B<before> the new value is added, you will use the old, B<previous>
9431 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
9432 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
9435 Last but not last, the B<stop> target makes a difference: If the pre-cache
9436 chain returns the stop condition, the value will not be added to the cache and
9437 the post-cache chain will not be run.
9439 =item B<Chain> I<Name>
9441 Adds a new chain with a certain name. This name can be used to refer to a
9442 specific chain, for example to jump to it.
9444 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
9446 =item B<Rule> [I<Name>]
9448 Adds a new rule to the current chain. The name of the rule is optional and
9449 currently has no meaning for the daemon.
9451 Within the B<Rule> block, there may be any number of B<Match> blocks and there
9452 must be at least one B<Target> block.
9454 =item B<Match> I<Name>
9456 Adds a match to a B<Rule> block. The name specifies what kind of match should
9457 be performed. Available matches depend on the plugins that have been loaded.
9459 The arguments inside the B<Match> block are passed to the plugin implementing
9460 the match, so which arguments are valid here depends on the plugin being used.
9461 If you do not need any to pass any arguments to a match, you can use the
9466 Which is equivalent to:
9471 =item B<Target> I<Name>
9473 Add a target to a rule or a default target to a chain. The name specifies what
9474 kind of target is to be added. Which targets are available depends on the
9475 plugins being loaded.
9477 The arguments inside the B<Target> block are passed to the plugin implementing
9478 the target, so which arguments are valid here depends on the plugin being used.
9479 If you do not need any to pass any arguments to a target, you can use the
9484 This is the same as writing:
9491 =head2 Built-in targets
9493 The following targets are built into the core daemon and therefore need no
9494 plugins to be loaded:
9500 Signals the "return" condition, see the L<"Flow control"> section above. This
9501 causes the current chain to stop processing the value and returns control to
9502 the calling chain. The calling chain will continue processing targets and rules
9503 just after the B<jump> target (see below). This is very similar to the
9504 B<RETURN> target of iptables, see L<iptables(8)>.
9506 This target does not have any options.
9514 Signals the "stop" condition, see the L<"Flow control"> section above. This
9515 causes processing of the value to be aborted immediately. This is similar to
9516 the B<DROP> target of iptables, see L<iptables(8)>.
9518 This target does not have any options.
9526 Sends the value to "write" plugins.
9532 =item B<Plugin> I<Name>
9534 Name of the write plugin to which the data should be sent. This option may be
9535 given multiple times to send the data to more than one write plugin. If the
9536 plugin supports multiple instances, the plugin's instance(s) must also be
9541 If no plugin is explicitly specified, the values will be sent to all available
9544 Single-instance plugin example:
9550 Multi-instance plugin example:
9552 <Plugin "write_graphite">
9562 Plugin "write_graphite/foo"
9567 Starts processing the rules of another chain, see L<"Flow control"> above. If
9568 the end of that chain is reached, or a stop condition is encountered,
9569 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
9570 next target or the next rule. This is similar to the B<-j> command line option
9571 of iptables, see L<iptables(8)>.
9577 =item B<Chain> I<Name>
9579 Jumps to the chain I<Name>. This argument is required and may appear only once.
9591 =head2 Available matches
9597 Matches a value using regular expressions.
9603 =item B<Host> I<Regex>
9605 =item B<Plugin> I<Regex>
9607 =item B<PluginInstance> I<Regex>
9609 =item B<Type> I<Regex>
9611 =item B<TypeInstance> I<Regex>
9613 =item B<MetaData> I<String> I<Regex>
9615 Match values where the given regular expressions match the various fields of
9616 the identifier of a value. If multiple regular expressions are given, B<all>
9617 regexen must match for a value to match.
9619 =item B<Invert> B<false>|B<true>
9621 When set to B<true>, the result of the match is inverted, i.e. all value lists
9622 where all regular expressions apply are not matched, all other value lists are
9623 matched. Defaults to B<false>.
9630 Host "customer[0-9]+"
9636 Matches values that have a time which differs from the time on the server.
9638 This match is mainly intended for servers that receive values over the
9639 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
9640 is very sensitive to the timestamp used when updating the RRD files. In
9641 particular, the time must be ever increasing. If a misbehaving client sends one
9642 packet with a timestamp far in the future, all further packets with a correct
9643 time will be ignored because of that one packet. What's worse, such corrupted
9644 RRD files are hard to fix.
9646 This match lets one match all values B<outside> a specified time range
9647 (relative to the server's time), so you can use the B<stop> target (see below)
9648 to ignore the value, for example.
9654 =item B<Future> I<Seconds>
9656 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
9657 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
9660 =item B<Past> I<Seconds>
9662 Matches all values that are I<behind> of the server's time by I<Seconds> or
9663 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
9675 This example matches all values that are five minutes or more ahead of the
9676 server or one hour (or more) lagging behind.
9680 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
9681 values. If a data-set consists of more than one data-source, all data-sources
9682 must match the specified ranges for a positive match.
9688 =item B<Min> I<Value>
9690 Sets the smallest value which still results in a match. If unset, behaves like
9693 =item B<Max> I<Value>
9695 Sets the largest value which still results in a match. If unset, behaves like
9698 =item B<Invert> B<true>|B<false>
9700 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
9701 no-match is returned and vice versa. Please note that the B<Invert> setting
9702 only effects how B<Min> and B<Max> are applied to a specific value. Especially
9703 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
9705 =item B<DataSource> I<DSName> [I<DSName> ...]
9707 Select one or more of the data sources. If no data source is configured, all
9708 data sources will be checked. If the type handled by the match does not have a
9709 data source of the specified name(s), this will always result in no match
9710 (independent of the B<Invert> setting).
9712 =item B<Satisfy> B<Any>|B<All>
9714 Specifies how checking with several data sources is performed. If set to
9715 B<Any>, the match succeeds if one of the data sources is in the configured
9716 range. If set to B<All> the match only succeeds if all data sources are within
9717 the configured range. Default is B<All>.
9719 Usually B<All> is used for positive matches, B<Any> is used for negative
9720 matches. This means that with B<All> you usually check that all values are in a
9721 "good" range, while with B<Any> you check if any value is within a "bad" range
9722 (or outside the "good" range).
9726 Either B<Min> or B<Max>, but not both, may be unset.
9730 # Match all values smaller than or equal to 100. Matches only if all data
9731 # sources are below 100.
9737 # Match if the value of any data source is outside the range of 0 - 100.
9745 =item B<empty_counter>
9747 Matches all values with one or more data sources of type B<COUNTER> and where
9748 all counter values are zero. These counters usually I<never> increased since
9749 they started existing (and are therefore uninteresting), or got reset recently
9750 or overflowed and you had really, I<really> bad luck.
9752 Please keep in mind that ignoring such counters can result in confusing
9753 behavior: Counters which hardly ever increase will be zero for long periods of
9754 time. If the counter is reset for some reason (machine or service restarted,
9755 usually), the graph will be empty (NAN) for a long time. People may not
9760 Calculates a hash value of the host name and matches values according to that
9761 hash value. This makes it possible to divide all hosts into groups and match
9762 only values that are in a specific group. The intended use is in load
9763 balancing, where you want to handle only part of all data and leave the rest
9766 The hashing function used tries to distribute the hosts evenly. First, it
9767 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
9770 for (i = 0; host[i] != 0; i++)
9771 hash_value = (hash_value * 251) + host[i];
9773 The constant 251 is a prime number which is supposed to make this hash value
9774 more random. The code then checks the group for this host according to the
9775 I<Total> and I<Match> arguments:
9777 if ((hash_value % Total) == Match)
9782 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
9783 groups), then the least significant bit of the hash value will be the XOR of
9784 all least significant bits in the host name. One consequence is that when you
9785 have two hosts, "server0.example.com" and "server1.example.com", where the host
9786 name differs in one digit only and the digits differ by one, those hosts will
9787 never end up in the same group.
9793 =item B<Match> I<Match> I<Total>
9795 Divide the data into I<Total> groups and match all hosts in group I<Match> as
9796 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
9797 be smaller than I<Total>. I<Total> must be at least one, although only values
9798 greater than one really do make any sense.
9800 You can repeat this option to match multiple groups, for example:
9805 The above config will divide the data into seven groups and match groups three
9806 and five. One use would be to keep every value on two hosts so that if one
9807 fails the missing data can later be reconstructed from the second host.
9813 # Operate on the pre-cache chain, so that ignored values are not even in the
9818 # Divide all received hosts in seven groups and accept all hosts in
9822 # If matched: Return and continue.
9825 # If not matched: Return and stop.
9831 =head2 Available targets
9835 =item B<notification>
9837 Creates and dispatches a notification.
9843 =item B<Message> I<String>
9845 This required option sets the message of the notification. The following
9846 placeholders will be replaced by an appropriate value:
9854 =item B<%{plugin_instance}>
9858 =item B<%{type_instance}>
9860 These placeholders are replaced by the identifier field of the same name.
9862 =item B<%{ds:>I<name>B<}>
9864 These placeholders are replaced by a (hopefully) human readable representation
9865 of the current rate of this data source. If you changed the instance name
9866 (using the B<set> or B<replace> targets, see below), it may not be possible to
9867 convert counter values to rates.
9871 Please note that these placeholders are B<case sensitive>!
9873 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
9875 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
9882 <Target "notification">
9883 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
9889 Replaces parts of the identifier using regular expressions.
9895 =item B<Host> I<Regex> I<Replacement>
9897 =item B<Plugin> I<Regex> I<Replacement>
9899 =item B<PluginInstance> I<Regex> I<Replacement>
9901 =item B<TypeInstance> I<Regex> I<Replacement>
9903 =item B<MetaData> I<String> I<Regex> I<Replacement>
9905 =item B<DeleteMetaData> I<String> I<Regex>
9907 Match the appropriate field with the given regular expression I<Regex>. If the
9908 regular expression matches, that part that matches is replaced with
9909 I<Replacement>. If multiple places of the input buffer match a given regular
9910 expression, only the first occurrence will be replaced.
9912 You can specify each option multiple times to use multiple regular expressions
9920 # Replace "example.net" with "example.com"
9921 Host "\\<example.net\\>" "example.com"
9923 # Strip "www." from hostnames
9929 Sets part of the identifier of a value to a given string.
9935 =item B<Host> I<String>
9937 =item B<Plugin> I<String>
9939 =item B<PluginInstance> I<String>
9941 =item B<TypeInstance> I<String>
9943 =item B<MetaData> I<String> I<String>
9945 Set the appropriate field to the given string. The strings for plugin instance,
9946 type instance, and meta data may be empty, the strings for host and plugin may
9947 not be empty. It's currently not possible to set the type of a value this way.
9949 The following placeholders will be replaced by an appropriate value:
9957 =item B<%{plugin_instance}>
9961 =item B<%{type_instance}>
9963 These placeholders are replaced by the identifier field of the same name.
9965 =item B<%{meta:>I<name>B<}>
9967 These placeholders are replaced by the meta data value with the given name.
9971 Please note that these placeholders are B<case sensitive>!
9973 =item B<DeleteMetaData> I<String>
9975 Delete the named meta data field.
9982 PluginInstance "coretemp"
9983 TypeInstance "core3"
9988 =head2 Backwards compatibility
9990 If you use collectd with an old configuration, i.E<nbsp>e. one without a
9991 B<Chain> block, it will behave as it used to. This is equivalent to the
9992 following configuration:
9998 If you specify a B<PostCacheChain>, the B<write> target will not be added
9999 anywhere and you will have to make sure that it is called where appropriate. We
10000 suggest to add the above snippet as default target to your "PostCache" chain.
10004 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10020 L<collectd-exec(5)>,
10021 L<collectd-perl(5)>,
10022 L<collectd-unixsock(5)>,
10035 Florian Forster E<lt>octo@collectd.orgE<gt>