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<#>) is ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
54 Lines may be wrapped by using C<\> as the last character before the newline.
55 This allows long lines to be split into multiple lines. Quoted strings may be
56 wrapped as well. However, those are treated special in that whitespace at the
57 beginning of the following lines will be ignored, which allows for nicely
58 indenting the wrapped lines.
60 The configuration is read and processed in order, i.e. from top to bottom. So
61 the plugins are loaded in the order listed in this config file. It is a good
62 idea to load any logging plugins first in order to catch messages from plugins
63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
64 B<LoadPlugin> option I<must> occur I<before> the appropriate
65 C<E<lt>B<Plugin> ...E<gt>> block.
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
77 =item B<LoadPlugin> I<Plugin>
79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
81 I<collectd> will be mostly useless.
83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
84 effect. This is useful when you want to split up the configuration into smaller
85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
86 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
93 statement looks like this:
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 own support for specifying an
131 interval, that setting will take precedence.
133 =item B<FlushInterval> I<Seconds>
135 Specifies the 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 "write_queue" I<plugin instance> reports the number of elements currently
163 queued and the number of elements dropped off the queue by the
164 B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> mechanism.
166 The "cache" I<plugin instance> reports the number of elements in the value list
167 cache (the cache you can interact with using L<collectd-unixsock(5)>).
169 =item B<Include> I<Path> [I<pattern>]
171 If I<Path> points to a file, includes that file. If I<Path> points to a
172 directory, recursively includes all files within that directory and its
173 subdirectories. If the C<wordexp> function is available on your system,
174 shell-like wildcards are expanded before files are included. This means you can
175 use statements like the following:
177 Include "/etc/collectd.d/*.conf"
179 Starting with version 5.3, this may also be a block in which further options
180 affecting the behavior of B<Include> may be specified. The following option is
183 <Include "/etc/collectd.d">
189 =item B<Filter> I<pattern>
191 If the C<fnmatch> function is available on your system, a shell-like wildcard
192 I<pattern> may be specified to filter which files to include. This may be used
193 in combination with recursively including a directory to easily be able to
194 arbitrarily mix configuration files and other documents (e.g. README files).
195 The given example is similar to the first example above but includes all files
196 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
198 Include "/etc/collectd.d" "*.conf"
202 If more than one files are included by a single B<Include> option, the files
203 will be included in lexicographical order (as defined by the C<strcmp>
204 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
205 order in which the files are loaded.
207 To prevent loops and shooting yourself in the foot in interesting ways the
208 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
209 most uses. Since symlinks are followed it is still possible to crash the daemon
210 by looping symlinks. In our opinion significant stupidity should result in an
211 appropriate amount of pain.
213 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
214 file, but you cannot include files from within blocks.
216 =item B<PIDFile> I<File>
218 Sets where to write the PID file to. This file is overwritten when it exists
219 and deleted when the program is stopped. Some init-scripts might override this
220 setting using the B<-P> command-line option.
222 =item B<PluginDir> I<Directory>
224 Path to the plugins (shared objects) of collectd.
226 =item B<TypesDB> I<File> [I<File> ...]
228 Set one or more files that contain the data-set descriptions. See
229 L<types.db(5)> for a description of the format of this file.
231 =item B<Interval> I<Seconds>
233 Configures the interval in which to query the read plugins. Obviously smaller
234 values lead to a higher system load produced by collectd, while higher values
235 lead to more coarse statistics.
237 B<Warning:> You should set this once and then never touch it again. If you do,
238 I<you will have to delete all your RRD files> or know some serious RRDtool
239 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
241 =item B<MaxReadInterval> I<Seconds>
243 Read plugin doubles interval between queries after each failed attempt
246 This options limits the maximum value of the interval. The default value is
249 =item B<Timeout> I<Iterations>
251 Consider a value list "missing" when no update has been read or received for
252 I<Iterations> iterations. By default, I<collectd> considers a value list
253 missing when no update has been received for twice the update interval. Since
254 this setting uses iterations, the maximum allowed time without update depends
255 on the I<Interval> information contained in each value list. This is used in
256 the I<Threshold> configuration to dispatch notifications about missing values,
257 see L<collectd-threshold(5)> for details.
259 =item B<ReadThreads> I<Num>
261 Number of threads to start for reading plugins. The default value is B<5>, but
262 you may want to increase this if you have more than five plugins that take a
263 long time to read. Mostly those are plugins that do network-IO. Setting this to
264 a value higher than the number of registered read callbacks is not recommended.
266 =item B<WriteThreads> I<Num>
268 Number of threads to start for dispatching value lists to write plugins. The
269 default value is B<5>, but you may want to increase this if you have more than
270 five plugins that may take relatively long to write to.
272 =item B<WriteQueueLimitHigh> I<HighNum>
274 =item B<WriteQueueLimitLow> I<LowNum>
276 Metrics are read by the I<read threads> and then put into a queue to be handled
277 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
278 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
279 running into memory issues in such a case, you can limit the size of this
282 By default, there is no limit and memory may grow indefinitely. This is most
283 likely not an issue for clients, i.e. instances that only handle the local
284 metrics. For servers it is recommended to set this to a non-zero value, though.
286 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
287 Each of them takes a numerical argument which is the number of metrics in the
288 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
289 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
290 I<will> be enqueued. If the number of metrics currently in the queue is between
291 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
292 proportional to the number of metrics in the queue (i.e. it increases linearly
293 until it reaches 100%.)
295 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
296 unset, the latter will default to half of B<WriteQueueLimitHigh>.
298 If you do not want to randomly drop values when the queue size is between
299 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
302 Enabling the B<CollectInternalStats> option is of great help to figure out the
303 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
305 =item B<Hostname> I<Name>
307 Sets the hostname that identifies a host. If you omit this setting, the
308 hostname will be determined using the L<gethostname(2)> system call.
310 =item B<FQDNLookup> B<true|false>
312 If B<Hostname> is determined automatically this setting controls whether or not
313 the daemon should try to figure out the "fully qualified domain name", FQDN.
314 This is done using a lookup of the name returned by C<gethostname>. This option
315 is enabled by default.
317 =item B<PreCacheChain> I<ChainName>
319 =item B<PostCacheChain> I<ChainName>
321 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
322 see L<FILTER CONFIGURATION> below on information on chains and how these
323 setting change the daemon's behavior.
327 =head1 PLUGIN OPTIONS
329 Some plugins may register own options. These options must be enclosed in a
330 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
331 require external configuration, too. The C<apache plugin>, for example,
332 required C<mod_status> to be configured in the webserver you're going to
333 collect data from. These plugins are listed below as well, even if they don't
334 require any configuration within collectd's configuration file.
336 A list of all plugins and a short summary for each plugin can be found in the
337 F<README> file shipped with the sourcecode and hopefully binary packets as
340 =head2 Plugin C<aggregation>
342 The I<Aggregation plugin> makes it possible to aggregate several values into
343 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
344 This can be put to a wide variety of uses, e.g. average and total CPU
345 statistics for your entire fleet.
347 The grouping is powerful but, as with many powerful tools, may be a bit
348 difficult to wrap your head around. The grouping will therefore be
349 demonstrated using an example: The average and sum of the CPU usage across
350 all CPUs of each host is to be calculated.
352 To select all the affected values for our example, set C<Plugin cpu> and
353 C<Type cpu>. The other values are left unspecified, meaning "all values". The
354 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
355 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
361 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
362 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
363 example, the intention is to have a new value for each host / type instance
364 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
365 It can be specified multiple times to group by more than one field.
368 GroupBy "TypeInstance"
370 We do neither specify nor group by I<plugin instance> (the CPU number), so all
371 metrics that differ in the CPU number only will be aggregated. Each
372 aggregation needs I<at least one> such field, otherwise no aggregation would
375 The full example configuration looks like this:
377 <Plugin "aggregation">
383 GroupBy "TypeInstance"
386 CalculateAverage true
390 There are a couple of limitations you should be aware of:
396 The I<Type> cannot be left unspecified, because it is not reasonable to add
397 apples to oranges. Also, the internal lookup structure won't work if you try
402 There must be at least one unspecified, ungrouped field. Otherwise nothing
407 As you can see in the example above, each aggregation has its own
408 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
409 blocks may match the same values, i.e. one value list can update multiple
410 aggregations. The following options are valid inside B<Aggregation> blocks:
414 =item B<Host> I<Host>
416 =item B<Plugin> I<Plugin>
418 =item B<PluginInstance> I<PluginInstance>
420 =item B<Type> I<Type>
422 =item B<TypeInstance> I<TypeInstance>
424 Selects the value lists to be added to this aggregation. B<Type> must be a
425 valid data set name, see L<types.db(5)> for details.
427 If the string starts with and ends with a slash (C</>), the string is
428 interpreted as a I<regular expression>. The regex flavor used are POSIX
429 extended regular expressions as described in L<regex(7)>. Example usage:
431 Host "/^db[0-9]\\.example\\.com$/"
433 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
435 Group valued by the specified field. The B<GroupBy> option may be repeated to
436 group by multiple fields.
438 =item B<SetHost> I<Host>
440 =item B<SetPlugin> I<Plugin>
442 =item B<SetPluginInstance> I<PluginInstance>
444 =item B<SetTypeInstance> I<TypeInstance>
446 Sets the appropriate part of the identifier to the provided string.
448 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
449 will be replaced with the aggregation function, e.g. "average". Not including
450 the placeholder will result in duplication warnings and/or messed up values if
451 more than one aggregation function are enabled.
453 The following example calculates the average usage of all "even" CPUs:
455 <Plugin "aggregation">
458 PluginInstance "/[0,2,4,6,8]$/"
462 SetPluginInstance "even-%{aggregation}"
465 GroupBy "TypeInstance"
467 CalculateAverage true
471 This will create the files:
477 foo.example.com/cpu-even-average/cpu-idle
481 foo.example.com/cpu-even-average/cpu-system
485 foo.example.com/cpu-even-average/cpu-user
493 =item B<CalculateNum> B<true>|B<false>
495 =item B<CalculateSum> B<true>|B<false>
497 =item B<CalculateAverage> B<true>|B<false>
499 =item B<CalculateMinimum> B<true>|B<false>
501 =item B<CalculateMaximum> B<true>|B<false>
503 =item B<CalculateStddev> B<true>|B<false>
505 Boolean options for enabling calculation of the number of value lists, their
506 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
507 are disabled by default.
511 =head2 Plugin C<amqp>
513 The I<AMQP plugin> can be used to communicate with other instances of
514 I<collectd> or third party applications using an AMQP message broker. Values
515 are sent to or received from the broker, which handles routing, queueing and
516 possibly filtering out messages.
521 # Send values to an AMQP broker
522 <Publish "some_name">
528 Exchange "amq.fanout"
529 # ExchangeType "fanout"
530 # RoutingKey "collectd"
532 # ConnectionRetryDelay 0
535 # GraphitePrefix "collectd."
536 # GraphiteEscapeChar "_"
537 # GraphiteSeparateInstances false
538 # GraphiteAlwaysAppendDS false
541 # Receive values from an AMQP broker
542 <Subscribe "some_name">
548 Exchange "amq.fanout"
549 # ExchangeType "fanout"
552 # QueueAutoDelete true
553 # RoutingKey "collectd.#"
554 # ConnectionRetryDelay 0
558 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
559 blocks, which configure sending and receiving of values respectively. The two
560 blocks are very similar, so unless otherwise noted, an option can be used in
561 either block. The name given in the blocks starting tag is only used for
562 reporting messages, but may be used to support I<flushing> of certain
563 I<Publish> blocks in the future.
567 =item B<Host> I<Host>
569 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
570 the underlying communications library, I<rabbitmq-c>, which is "localhost".
572 =item B<Port> I<Port>
574 Service name or port number on which the AMQP broker accepts connections. This
575 argument must be a string, even if the numeric form is used. Defaults to
578 =item B<VHost> I<VHost>
580 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
582 =item B<User> I<User>
584 =item B<Password> I<Password>
586 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
589 =item B<Exchange> I<Exchange>
591 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
592 By default, "amq.fanout" will be used.
594 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
595 the given exchange and the I<queue> is created, using the I<routing key> if
596 configured. See the B<Queue> and B<RoutingKey> options below.
598 =item B<ExchangeType> I<Type>
600 If given, the plugin will try to create the configured I<exchange> with this
601 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
602 be bound to this exchange.
604 =item B<Queue> I<Queue> (Subscribe only)
606 Configures the I<queue> name to subscribe to. If no queue name was configured
607 explicitly, a unique queue name will be created by the broker.
609 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
611 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
612 or transient (will disappear if the AMQP broker is restarted). Defaults to
615 This option should be used in conjunction with the I<Persistent> option on the
618 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
620 Defines if the I<queue> subscribed to will be deleted once the last consumer
621 unsubscribes. Defaults to "true".
623 =item B<RoutingKey> I<Key>
625 In I<Publish> blocks, this configures the routing key to set on all outgoing
626 messages. If not given, the routing key will be computed from the I<identifier>
627 of the value. The host, plugin, type and the two instances are concatenated
628 together using dots as the separator and all containing dots replaced with
629 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
630 possible to receive only specific values using a "topic" exchange.
632 In I<Subscribe> blocks, configures the I<routing key> used when creating a
633 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
634 used to filter messages when using a "topic" exchange. If you're only
635 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
638 =item B<Persistent> B<true>|B<false> (Publish only)
640 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
641 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
642 default), the I<transient> delivery mode will be used, i.e. messages may be
643 lost due to high load, overflowing queues or similar issues.
645 =item B<ConnectionRetryDelay> I<Delay>
647 When the connection to the AMQP broker is lost, defines the time in seconds to
648 wait before attempting to reconnect. Defaults to 0, which implies collectd will
649 attempt to reconnect at each read interval (in Subscribe mode) or each time
650 values are ready for submission (in Publish mode).
652 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
654 Selects the format in which messages are sent to the broker. If set to
655 B<Command> (the default), values are sent as C<PUTVAL> commands which are
656 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
657 case, the C<Content-Type> header field will be set to C<text/collectd>.
659 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
660 an easy and straight forward exchange format. The C<Content-Type> header field
661 will be set to C<application/json>.
663 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
664 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
667 A subscribing client I<should> use the C<Content-Type> header field to
668 determine how to decode the values. Currently, the I<AMQP plugin> itself can
669 only decode the B<Command> format.
671 =item B<StoreRates> B<true>|B<false> (Publish only)
673 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
674 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
675 default), no conversion is performed. Otherwise the conversion is performed
676 using the internal value cache.
678 Please note that currently this option is only used if the B<Format> option has
681 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
683 A prefix can be added in the metric name when outputting in the I<Graphite> format.
684 It's added before the I<Host> name.
685 Metric name will be "<prefix><host><postfix><plugin><type><name>"
687 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
689 A postfix can be added in the metric name when outputting in the I<Graphite> format.
690 It's added after the I<Host> name.
691 Metric name will be "<prefix><host><postfix><plugin><type><name>"
693 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
695 Specify a character to replace dots (.) in the host part of the metric name.
696 In I<Graphite> metric name, dots are used as separators between different
697 metric parts (host, plugin, type).
698 Default is "_" (I<Underscore>).
700 =item B<GraphiteSeparateInstances> B<true>|B<false>
702 If set to B<true>, the plugin instance and type instance will be in their own
703 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
704 default), the plugin and plugin instance (and likewise the type and type
705 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
707 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
709 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
710 identifier. If set to B<false> (the default), this is only done when there is
715 =head2 Plugin C<apache>
717 To configure the C<apache>-plugin you first need to configure the Apache
718 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
719 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
720 the following snipped to base your Apache config upon:
723 <IfModule mod_status.c>
724 <Location /mod_status>
725 SetHandler server-status
729 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
730 also supported. It introduces a new field, called C<BusyServers>, to count the
731 number of currently connected clients. This field is also supported.
733 The configuration of the I<Apache> plugin consists of one or more
734 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
735 as the instance name. For example:
739 URL "http://www1.example.com/mod_status?auto"
742 URL "http://www2.example.com/mod_status?auto"
746 The instance name will be used as the I<plugin instance>. To emulate the old
747 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
748 plugin to work correctly, each instance name must be unique. This is not
749 enforced by the plugin and it is your responsibility to ensure it.
751 The following options are accepted within each I<Instance> block:
755 =item B<URL> I<http://host/mod_status?auto>
757 Sets the URL of the C<mod_status> output. This needs to be the output generated
758 by C<ExtendedStatus on> and it needs to be the machine readable output
759 generated by appending the C<?auto> argument. This option is I<mandatory>.
761 =item B<User> I<Username>
763 Optional user name needed for authentication.
765 =item B<Password> I<Password>
767 Optional password needed for authentication.
769 =item B<VerifyPeer> B<true|false>
771 Enable or disable peer SSL certificate verification. See
772 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
774 =item B<VerifyHost> B<true|false>
776 Enable or disable peer host name verification. If enabled, the plugin checks
777 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
778 certificate matches the host name provided by the B<URL> option. If this
779 identity check fails, the connection is aborted. Obviously, only works when
780 connecting to a SSL enabled server. Enabled by default.
782 =item B<CACert> I<File>
784 File that holds one or more SSL certificates. If you want to use HTTPS you will
785 possibly need this option. What CA certificates come bundled with C<libcurl>
786 and are checked by default depends on the distribution you use.
788 =item B<SSLCiphers> I<list of ciphers>
790 Specifies which ciphers to use in the connection. The list of ciphers
791 must specify valid ciphers. See
792 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
794 =item B<Timeout> I<Milliseconds>
796 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
797 milliseconds. By default, the configured B<Interval> is used to set the
802 =head2 Plugin C<apcups>
806 =item B<Host> I<Hostname>
808 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
809 that IPv6 support has been disabled unless someone can confirm or decline that
810 B<apcupsd> can handle it.
812 =item B<Port> I<Port>
814 TCP-Port to connect to. Defaults to B<3551>.
816 =item B<ReportSeconds> B<true>|B<false>
818 If set to B<true>, the time reported in the C<timeleft> metric will be
819 converted to seconds. This is the recommended setting. If set to B<false>, the
820 default for backwards compatibility, the time will be reported in minutes.
822 =item B<PersistentConnection> B<true>|B<false>
824 By default, the plugin will try to keep the connection to UPS open between
825 reads. Since this appears to be somewhat brittle (I<apcupsd> appears to close
826 the connection due to inactivity quite quickly), the plugin will try to detect
827 this problem and switch to an open-read-close mode in such cases.
829 You can instruct the plugin to close the connection after each read by setting
830 this option to B<false>.
834 =head2 Plugin C<aquaero>
836 This plugin collects the value of the available sensors in an
837 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
838 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
839 connection for monitoring and configuration. The board can handle multiple
840 temperature sensors, fans, water pumps and water level sensors and adjust the
841 output settings such as fan voltage or power used by the water pump based on
842 the available inputs using a configurable controller included in the board.
843 This plugin collects all the available inputs as well as some of the output
844 values chosen by this controller. The plugin is based on the I<libaquaero5>
845 library provided by I<aquatools-ng>.
849 =item B<Device> I<DevicePath>
851 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
852 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
853 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
857 =head2 Plugin C<ascent>
859 This plugin collects information about an Ascent server, a free server for the
860 "World of Warcraft" game. This plugin gathers the information by fetching the
861 XML status page using C<libcurl> and parses it using C<libxml2>.
863 The configuration options are the same as for the C<apache> plugin above:
867 =item B<URL> I<http://localhost/ascent/status/>
869 Sets the URL of the XML status output.
871 =item B<User> I<Username>
873 Optional user name needed for authentication.
875 =item B<Password> I<Password>
877 Optional password needed for authentication.
879 =item B<VerifyPeer> B<true|false>
881 Enable or disable peer SSL certificate verification. See
882 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
884 =item B<VerifyHost> B<true|false>
886 Enable or disable peer host name verification. If enabled, the plugin checks
887 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
888 certificate matches the host name provided by the B<URL> option. If this
889 identity check fails, the connection is aborted. Obviously, only works when
890 connecting to a SSL enabled server. Enabled by default.
892 =item B<CACert> I<File>
894 File that holds one or more SSL certificates. If you want to use HTTPS you will
895 possibly need this option. What CA certificates come bundled with C<libcurl>
896 and are checked by default depends on the distribution you use.
898 =item B<Timeout> I<Milliseconds>
900 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
901 milliseconds. By default, the configured B<Interval> is used to set the
906 =head2 Plugin C<barometer>
908 This plugin reads absolute air pressure using digital barometer sensor on a I2C
909 bus. Supported sensors are:
913 =item I<MPL115A2> from Freescale,
914 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
917 =item I<MPL3115> from Freescale
918 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
921 =item I<BMP085> from Bosch Sensortec
925 The sensor type - one of the above - is detected automatically by the plugin
926 and indicated in the plugin_instance (you will see subdirectory
927 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
928 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
929 (only one sensor can be used by the plugin).
931 The plugin provides absolute barometric pressure, air pressure reduced to sea
932 level (several possible approximations) and as an auxiliary value also internal
933 sensor temperature. It uses (expects/provides) typical metric units - pressure
934 in [hPa], temperature in [C], altitude in [m].
936 It was developed and tested under Linux only. The only platform dependency is
937 the standard Linux i2c-dev interface (the particular bus driver has to
938 support the SM Bus command subset).
940 The reduction or normalization to mean sea level pressure requires (depending
941 on selected method/approximation) also altitude and reference to temperature
942 sensor(s). When multiple temperature sensors are configured the minumum of
943 their values is always used (expecting that the warmer ones are affected by
944 e.g. direct sun light at that moment).
952 TemperatureOffset 0.0
955 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
960 =item B<Device> I<device>
962 The only mandatory configuration parameter.
964 Device name of the I2C bus to which the sensor is connected. Note that
965 typically you need to have loaded the i2c-dev module.
966 Using i2c-tools you can check/list i2c buses available on your system by:
970 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
974 This way you should be able to verify that the pressure sensor (either type) is
975 connected and detected on address 0x60.
977 =item B<Oversampling> I<value>
979 Optional parameter controlling the oversampling/accuracy. Default value
980 is 1 providing fastest and least accurate reading.
982 For I<MPL115> this is the size of the averaging window. To filter out sensor
983 noise a simple averaging using floating window of this configurable size is
984 used. The plugin will use average of the last C<value> measurements (value of 1
985 means no averaging). Minimal size is 1, maximal 1024.
987 For I<MPL3115> this is the oversampling value. The actual oversampling is
988 performed by the sensor and the higher value the higher accuracy and longer
989 conversion time (although nothing to worry about in the collectd context).
990 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
991 adjusted by the plugin to the closest supported one.
993 For I<BMP085> this is the oversampling value. The actual oversampling is
994 performed by the sensor and the higher value the higher accuracy and longer
995 conversion time (although nothing to worry about in the collectd context).
996 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
997 the closest supported one.
999 =item B<PressureOffset> I<offset>
1001 Optional parameter for MPL3115 only.
1003 You can further calibrate the sensor by supplying pressure and/or temperature
1004 offsets. This is added to the measured/caclulated value (i.e. if the measured
1005 value is too high then use negative offset).
1006 In hPa, default is 0.0.
1008 =item B<TemperatureOffset> I<offset>
1010 Optional parameter for MPL3115 only.
1012 You can further calibrate the sensor by supplying pressure and/or temperature
1013 offsets. This is added to the measured/caclulated value (i.e. if the measured
1014 value is too high then use negative offset).
1015 In C, default is 0.0.
1017 =item B<Normalization> I<method>
1019 Optional parameter, default value is 0.
1021 Normalization method - what approximation/model is used to compute the mean sea
1022 level pressure from the air absolute pressure.
1024 Supported values of the C<method> (integer between from 0 to 2) are:
1028 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1029 do not need to configure C<Altitude> or C<TemperatureSensor>.
1031 =item B<1> - international formula for conversion ,
1033 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1034 For this method you have to configure C<Altitude> but do not need
1035 C<TemperatureSensor> (uses fixed global temperature average instead).
1037 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1038 Meteorological Service).
1039 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1040 For this method you have to configure both C<Altitude> and
1041 C<TemperatureSensor>.
1046 =item B<Altitude> I<altitude>
1048 The altitude (in meters) of the location where you meassure the pressure.
1050 =item B<TemperatureSensor> I<reference>
1052 Temperature sensor(s) which should be used as a reference when normalizing the
1053 pressure using C<Normalization> method 2.
1054 When specified more sensors a minumum is found and used each time. The
1055 temperature reading directly from this pressure sensor/plugin is typically not
1056 suitable as the pressure sensor will be probably inside while we want outside
1057 temperature. The collectd reference name is something like
1058 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1059 (<type_instance> is usually omitted when there is just single value type). Or
1060 you can figure it out from the path of the output data files.
1064 =head2 Plugin C<battery>
1066 The I<battery plugin> reports the remaining capacity, power and voltage of
1071 =item B<ValuesPercentage> B<false>|B<true>
1073 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1074 capacity remaining". Otherwise the capacity is stored as reported by the
1075 battery, most likely in "Wh". This option does not work with all input methods,
1076 in particular when only C</proc/pmu> is available on an old Linux system.
1077 Defaults to B<false>.
1079 =item B<ReportDegraded> B<false>|B<true>
1081 Typical laptop batteries degrade over time, meaning the capacity decreases with
1082 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1083 "last full capacity" and used to determine that a battery is "fully charged".
1085 When this option is set to B<false>, the default, the I<battery plugin> will
1086 only report the remaining capacity. If the B<ValuesPercentage> option is
1087 enabled, the relative remaining capacity is calculated as the ratio of the
1088 "remaining capacity" and the "last full capacity". This is what most tools,
1089 such as the status bar of desktop environments, also do.
1091 When set to B<true>, the battery plugin will report three values: B<charged>
1092 (remaining capacity), B<discharged> (difference between "last full capacity"
1093 and "remaining capacity") and B<degraded> (difference between "design capacity"
1094 and "last full capacity").
1098 =head2 Plugin C<bind>
1100 Starting with BIND 9.5.0, the most widely used DNS server software provides
1101 extensive statistics about queries, responses and lots of other information.
1102 The bind plugin retrieves this information that's encoded in XML and provided
1103 via HTTP and submits the values to collectd.
1105 To use this plugin, you first need to tell BIND to make this information
1106 available. This is done with the C<statistics-channels> configuration option:
1108 statistics-channels {
1109 inet localhost port 8053;
1112 The configuration follows the grouping that can be seen when looking at the
1113 data with an XSLT compatible viewer, such as a modern web browser. It's
1114 probably a good idea to make yourself familiar with the provided values, so you
1115 can understand what the collected statistics actually mean.
1120 URL "http://localhost:8053/"
1135 Zone "127.in-addr.arpa/IN"
1139 The bind plugin accepts the following configuration options:
1145 URL from which to retrieve the XML data. If not specified,
1146 C<http://localhost:8053/> will be used.
1148 =item B<ParseTime> B<true>|B<false>
1150 When set to B<true>, the time provided by BIND will be parsed and used to
1151 dispatch the values. When set to B<false>, the local time source is queried.
1153 This setting is set to B<true> by default for backwards compatibility; setting
1154 this to B<false> is I<recommended> to avoid problems with timezones and
1157 =item B<OpCodes> B<true>|B<false>
1159 When enabled, statistics about the I<"OpCodes">, for example the number of
1160 C<QUERY> packets, are collected.
1164 =item B<QTypes> B<true>|B<false>
1166 When enabled, the number of I<incoming> queries by query types (for example
1167 C<A>, C<MX>, C<AAAA>) is collected.
1171 =item B<ServerStats> B<true>|B<false>
1173 Collect global server statistics, such as requests received over IPv4 and IPv6,
1174 successful queries, and failed updates.
1178 =item B<ZoneMaintStats> B<true>|B<false>
1180 Collect zone maintenance statistics, mostly information about notifications
1181 (zone updates) and zone transfers.
1185 =item B<ResolverStats> B<true>|B<false>
1187 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1188 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1189 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1190 default. Use the B<ResolverStats> option within a B<View "_default"> block
1191 instead for the same functionality.
1195 =item B<MemoryStats>
1197 Collect global memory statistics.
1201 =item B<Timeout> I<Milliseconds>
1203 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1204 milliseconds. By default, the configured B<Interval> is used to set the
1207 =item B<View> I<Name>
1209 Collect statistics about a specific I<"view">. BIND can behave different,
1210 mostly depending on the source IP-address of the request. These different
1211 configurations are called "views". If you don't use this feature, you most
1212 likely are only interested in the C<_default> view.
1214 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1215 information you want to collect about a view. If no B<View> block is
1216 configured, no detailed view statistics will be collected.
1220 =item B<QTypes> B<true>|B<false>
1222 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1223 C<MX>) is collected.
1227 =item B<ResolverStats> B<true>|B<false>
1229 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1230 (e.E<nbsp>g. queries over IPv4, lame servers).
1234 =item B<CacheRRSets> B<true>|B<false>
1236 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1237 type is collected. Negative entries (queries which resulted in an error, for
1238 example names that do not exist) are reported with a leading exclamation mark,
1243 =item B<Zone> I<Name>
1245 When given, collect detailed information about the given zone in the view. The
1246 information collected if very similar to the global B<ServerStats> information
1249 You can repeat this option to collect detailed information about multiple
1252 By default no detailed zone information is collected.
1258 =head2 Plugin C<ceph>
1260 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1261 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1263 A separate B<Daemon> block must be configured for each ceph daemon to be
1264 monitored. The following example will read daemon statistics from four
1265 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1268 LongRunAvgLatency false
1269 ConvertSpecialMetricTypes true
1271 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1274 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1277 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1280 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1284 The ceph plugin accepts the following configuration options:
1288 =item B<LongRunAvgLatency> B<true>|B<false>
1290 If enabled, latency values(sum,count pairs) are calculated as the long run
1291 average - average since the ceph daemon was started = (sum / count).
1292 When disabled, latency values are calculated as the average since the last
1293 collection = (sum_now - sum_last) / (count_now - count_last).
1297 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1299 If enabled, special metrics (metrics that differ in type from similar counters)
1300 are converted to the type of those similar counters. This currently only
1301 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1302 ceph schema reports this metric type as a sum,count pair while similar counters
1303 are treated as derive types. When converted, the sum is used as the counter
1304 value and is treated as a derive type.
1305 When disabled, all metrics are treated as the types received from the ceph schema.
1311 Each B<Daemon> block must have a string argument for the plugin instance name.
1312 A B<SocketPath> is also required for each B<Daemon> block:
1316 =item B<Daemon> I<DaemonName>
1318 Name to be used as the instance name for this daemon.
1320 =item B<SocketPath> I<SocketPath>
1322 Specifies the path to the UNIX admin socket of the ceph daemon.
1326 =head2 Plugin C<cgroups>
1328 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1329 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1330 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1334 =item B<CGroup> I<Directory>
1336 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1337 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1340 =item B<IgnoreSelected> B<true>|B<false>
1342 Invert the selection: If set to true, all cgroups I<except> the ones that
1343 match any one of the criteria are collected. By default only selected
1344 cgroups are collected if a selection is made. If no selection is configured
1345 at all, B<all> cgroups are selected.
1349 =head2 Plugin C<conntrack>
1351 This plugin collects IP conntrack statistics.
1357 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1358 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1362 =head2 Plugin C<cpu>
1364 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1365 as Jiffies, using the C<cpu> type. Two aggregations are available:
1371 Sum, per-state, over all CPUs installed in the system; and
1375 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1379 The two aggregations can be combined, leading to I<collectd> only emitting a
1380 single "active" metric for the entire system. As soon as one of these
1381 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1382 rather than Jiffies. In addition, you can request individual, per-state,
1383 per-CPU metrics to be reported as percentage.
1385 The following configuration options are available:
1389 =item B<ReportByState> B<true>|B<false>
1391 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1393 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1396 =item B<ReportByCpu> B<true>|B<false>
1398 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1399 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1400 global sum of CPU states is emitted.
1402 =item B<ValuesPercentage> B<false>|B<true>
1404 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1405 are set to B<true>. In this case, by default, metrics will be reported as
1406 Jiffies. By setting this option to B<true>, you can request percentage values
1407 in the un-aggregated (per-CPU, per-state) mode as well.
1411 =head2 Plugin C<cpufreq>
1413 This plugin doesn't have any options. It reads
1414 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1415 installed) to get the current CPU frequency. If this file does not exist make
1416 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1417 installed and an "cpu governor" (that's a kernel module) is loaded.
1419 =head2 Plugin C<csv>
1423 =item B<DataDir> I<Directory>
1425 Set the directory to store CSV-files under. Per default CSV-files are generated
1426 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1427 The special strings B<stdout> and B<stderr> can be used to write to the standard
1428 output and standard error channels, respectively. This, of course, only makes
1429 much sense when collectd is running in foreground- or non-daemon-mode.
1431 =item B<StoreRates> B<true|false>
1433 If set to B<true>, convert counter values to rates. If set to B<false> (the
1434 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1439 =head2 Plugin C<curl>
1441 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1442 and the match infrastructure (the same code used by the tail plugin) to use
1443 regular expressions with the received data.
1445 The following example will read the current value of AMD stock from Google's
1446 finance page and dispatch the value to collectd.
1449 <Page "stock_quotes">
1450 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1456 CACert "/path/to/ca.crt"
1457 Header "X-Custom-Header: foobar"
1460 MeasureResponseTime false
1461 MeasureResponseCode false
1464 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1465 DSType "GaugeAverage"
1466 # Note: `stock_value' is not a standard type.
1473 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1474 a web page and one or more "matches" to be performed on the returned data. The
1475 string argument to the B<Page> block is used as plugin instance.
1477 The following options are valid within B<Page> blocks:
1483 URL of the web site to retrieve. Since a regular expression will be used to
1484 extract information from this data, non-binary data is a big plus here ;)
1486 =item B<User> I<Name>
1488 Username to use if authorization is required to read the page.
1490 =item B<Password> I<Password>
1492 Password to use if authorization is required to read the page.
1494 =item B<Digest> B<true>|B<false>
1496 Enable HTTP digest authentication.
1498 =item B<VerifyPeer> B<true>|B<false>
1500 Enable or disable peer SSL certificate verification. See
1501 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1503 =item B<VerifyHost> B<true>|B<false>
1505 Enable or disable peer host name verification. If enabled, the plugin checks if
1506 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1507 matches the host name provided by the B<URL> option. If this identity check
1508 fails, the connection is aborted. Obviously, only works when connecting to a
1509 SSL enabled server. Enabled by default.
1511 =item B<CACert> I<file>
1513 File that holds one or more SSL certificates. If you want to use HTTPS you will
1514 possibly need this option. What CA certificates come bundled with C<libcurl>
1515 and are checked by default depends on the distribution you use.
1517 =item B<Header> I<Header>
1519 A HTTP header to add to the request. Multiple headers are added if this option
1520 is specified more than once.
1522 =item B<Post> I<Body>
1524 Specifies that the HTTP operation should be a POST instead of a GET. The
1525 complete data to be posted is given as the argument. This option will usually
1526 need to be accompanied by a B<Header> option to set an appropriate
1527 C<Content-Type> for the post body (e.g. to
1528 C<application/x-www-form-urlencoded>).
1530 =item B<MeasureResponseTime> B<true>|B<false>
1532 Measure response time for the request. If this setting is enabled, B<Match>
1533 blocks (see below) are optional. Disabled by default.
1535 Beware that requests will get aborted if they take too long to complete. Adjust
1536 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1539 =item B<MeasureResponseCode> B<true>|B<false>
1541 Measure response code for the request. If this setting is enabled, B<Match>
1542 blocks (see below) are optional. Disabled by default.
1544 =item B<E<lt>MatchE<gt>>
1546 One or more B<Match> blocks that define how to match information in the data
1547 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1548 used by the C<tail> plugin, so please see the documentation of the C<tail>
1549 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1550 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1553 =item B<Timeout> I<Milliseconds>
1555 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1556 milliseconds. By default, the configured B<Interval> is used to set the
1557 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1558 indefinitely. This legacy behaviour can be achieved by setting the value of
1561 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1562 network connection will stall one read thread. Adjust the B<ReadThreads> global
1563 setting accordingly to prevent this from blocking other plugins.
1567 =head2 Plugin C<curl_json>
1569 The B<curl_json plugin> collects values from JSON data to be parsed by
1570 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1571 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1572 unix socket. The former can be used, for example, to collect values
1573 from CouchDB documents (which are stored JSON notation), and the
1574 latter to collect values from a uWSGI stats socket.
1576 The following example will collect several values from the built-in
1577 C<_stats> runtime statistics module of I<CouchDB>
1578 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1581 <URL "http://localhost:5984/_stats">
1583 <Key "httpd/requests/count">
1584 Type "http_requests"
1587 <Key "httpd_request_methods/*/count">
1588 Type "http_request_methods"
1591 <Key "httpd_status_codes/*/count">
1592 Type "http_response_codes"
1597 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1600 <Sock "/var/run/uwsgi.stats.sock">
1602 <Key "workers/*/requests">
1603 Type "http_requests"
1606 <Key "workers/*/apps/*/requests">
1607 Type "http_requests"
1612 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1613 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1614 blocks defining a unix socket to read JSON from directly. Each of
1615 these blocks may have one or more B<Key> blocks.
1617 The B<Key> string argument must be in a path format. Each component is
1618 used to match the key from a JSON map or the index of an JSON
1619 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1620 values for all map keys or array indices will be collectd.
1622 The following options are valid within B<URL> blocks:
1626 =item B<Instance> I<Instance>
1628 Sets the plugin instance to I<Instance>.
1630 =item B<Interval> I<Interval>
1632 Sets the interval (in seconds) in which the values will be collected from this
1633 URL. By default the global B<Interval> setting will be used.
1635 =item B<User> I<Name>
1637 =item B<Password> I<Password>
1639 =item B<Digest> B<true>|B<false>
1641 =item B<VerifyPeer> B<true>|B<false>
1643 =item B<VerifyHost> B<true>|B<false>
1645 =item B<CACert> I<file>
1647 =item B<Header> I<Header>
1649 =item B<Post> I<Body>
1651 =item B<Timeout> I<Milliseconds>
1653 These options behave exactly equivalent to the appropriate options of the
1654 I<cURL> plugin. Please see there for a detailed description.
1658 The following options are valid within B<Key> blocks:
1662 =item B<Type> I<Type>
1664 Sets the type used to dispatch the values to the daemon. Detailed information
1665 about types and their configuration can be found in L<types.db(5)>. This
1666 option is mandatory.
1668 =item B<Instance> I<Instance>
1670 Type-instance to use. Defaults to the current map key or current string array element value.
1674 =head2 Plugin C<curl_xml>
1676 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1677 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1680 <URL "http://localhost/stats.xml">
1682 Instance "some_instance"
1687 CACert "/path/to/ca.crt"
1688 Header "X-Custom-Header: foobar"
1691 <XPath "table[@id=\"magic_level\"]/tr">
1693 #InstancePrefix "prefix-"
1694 InstanceFrom "td[1]"
1695 ValuesFrom "td[2]/span[@class=\"level\"]"
1700 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1701 URL to be fetched using libcurl. Within each B<URL> block there are
1702 options which specify the connection parameters, for example authentication
1703 information, and one or more B<XPath> blocks.
1705 Each B<XPath> block specifies how to get one type of information. The
1706 string argument must be a valid XPath expression which returns a list
1707 of "base elements". One value is dispatched for each "base element". The
1708 I<type instance> and values are looked up using further I<XPath> expressions
1709 that should be relative to the base element.
1711 Within the B<URL> block the following options are accepted:
1715 =item B<Host> I<Name>
1717 Use I<Name> as the host name when submitting values. Defaults to the global
1720 =item B<Instance> I<Instance>
1722 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1723 empty string (no plugin instance).
1725 =item B<Namespace> I<Prefix> I<URL>
1727 If an XPath expression references namespaces, they must be specified
1728 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1729 I<URL> is the "namespace name", an URI reference uniquely identifying the
1730 namespace. The option can be repeated to register multiple namespaces.
1734 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1735 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1737 =item B<User> I<User>
1739 =item B<Password> I<Password>
1741 =item B<Digest> B<true>|B<false>
1743 =item B<VerifyPeer> B<true>|B<false>
1745 =item B<VerifyHost> B<true>|B<false>
1747 =item B<CACert> I<CA Cert File>
1749 =item B<Header> I<Header>
1751 =item B<Post> I<Body>
1753 =item B<Timeout> I<Milliseconds>
1755 These options behave exactly equivalent to the appropriate options of the
1756 I<cURL plugin>. Please see there for a detailed description.
1758 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1760 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1761 B<XPath> block specifies how to get one type of information. The string
1762 argument must be a valid XPath expression which returns a list of "base
1763 elements". One value is dispatched for each "base element".
1765 Within the B<XPath> block the following options are accepted:
1769 =item B<Type> I<Type>
1771 Specifies the I<Type> used for submitting patches. This determines the number
1772 of values that are required / expected and whether the strings are parsed as
1773 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1774 This option is required.
1776 =item B<InstancePrefix> I<InstancePrefix>
1778 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1779 concatenated together without any separator.
1780 This option is optional.
1782 =item B<InstanceFrom> I<InstanceFrom>
1784 Specifies a XPath expression to use for determining the I<type instance>. The
1785 XPath expression must return exactly one element. The element's value is then
1786 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1788 This value is required. As a special exception, if the "base XPath expression"
1789 (the argument to the B<XPath> block) returns exactly one argument, then this
1790 option may be omitted.
1792 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1794 Specifies one or more XPath expression to use for reading the values. The
1795 number of XPath expressions must match the number of data sources in the
1796 I<type> specified with B<Type> (see above). Each XPath expression must return
1797 exactly one element. The element's value is then parsed as a number and used as
1798 value for the appropriate value in the value list dispatched to the daemon.
1804 =head2 Plugin C<dbi>
1806 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1807 connect to various databases, execute I<SQL> statements and read back the
1808 results. I<dbi> is an acronym for "database interface" in case you were
1809 wondering about the name. You can configure how each column is to be
1810 interpreted and the plugin will generate one or more data sets from each row
1811 returned according to these rules.
1813 Because the plugin is very generic, the configuration is a little more complex
1814 than those of other plugins. It usually looks something like this:
1817 <Query "out_of_stock">
1818 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1819 # Use with MySQL 5.0.0 or later
1823 InstancePrefix "out_of_stock"
1824 InstancesFrom "category"
1828 <Database "product_information">
1831 DriverOption "host" "localhost"
1832 DriverOption "username" "collectd"
1833 DriverOption "password" "aZo6daiw"
1834 DriverOption "dbname" "prod_info"
1835 SelectDB "prod_info"
1836 Query "out_of_stock"
1840 The configuration above defines one query with one result and one database. The
1841 query is then linked to the database with the B<Query> option I<within> the
1842 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1843 and you can also use the B<Include> statement to split up the configuration
1844 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1845 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1848 The following is a complete list of options:
1850 =head3 B<Query> blocks
1852 Query blocks define I<SQL> statements and how the returned data should be
1853 interpreted. They are identified by the name that is given in the opening line
1854 of the block. Thus the name needs to be unique. Other than that, the name is
1855 not used in collectd.
1857 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1858 define which column holds which value or instance information. You can use
1859 multiple B<Result> blocks to create multiple values from one returned row. This
1860 is especially useful, when queries take a long time and sending almost the same
1861 query again and again is not desirable.
1865 <Query "environment">
1866 Statement "select station, temperature, humidity from environment"
1869 # InstancePrefix "foo"
1870 InstancesFrom "station"
1871 ValuesFrom "temperature"
1875 InstancesFrom "station"
1876 ValuesFrom "humidity"
1880 The following options are accepted:
1884 =item B<Statement> I<SQL>
1886 Sets the statement that should be executed on the server. This is B<not>
1887 interpreted by collectd, but simply passed to the database server. Therefore,
1888 the SQL dialect that's used depends on the server collectd is connected to.
1890 The query has to return at least two columns, one for the instance and one
1891 value. You cannot omit the instance, even if the statement is guaranteed to
1892 always return exactly one line. In that case, you can usually specify something
1895 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1897 (That works with MySQL but may not be valid SQL according to the spec. If you
1898 use a more strict database server, you may have to select from a dummy table or
1901 Please note that some databases, for example B<Oracle>, will fail if you
1902 include a semicolon at the end of the statement.
1904 =item B<MinVersion> I<Version>
1906 =item B<MaxVersion> I<Value>
1908 Only use this query for the specified database version. You can use these
1909 options to provide multiple queries with the same name but with a slightly
1910 different syntax. The plugin will use only those queries, where the specified
1911 minimum and maximum versions fit the version of the database in use.
1913 The database version is determined by C<dbi_conn_get_engine_version>, see the
1914 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1915 for details. Basically, each part of the version is assumed to be in the range
1916 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1917 "40102", version "5.0.42" becomes "50042".
1919 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1920 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1921 happen. Don't to it! A valid example would be something along these lines:
1932 In the above example, there are three ranges that don't overlap. The last one
1933 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1934 before "4.0.0" are not specified.
1936 =item B<Type> I<Type>
1938 The B<type> that's used for each line returned. See L<types.db(5)> for more
1939 details on how types are defined. In short: A type is a predefined layout of
1940 data and the number of values and type of values has to match the type
1943 If you specify "temperature" here, you need exactly one gauge column. If you
1944 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1947 There must be exactly one B<Type> option inside each B<Result> block.
1949 =item B<InstancePrefix> I<prefix>
1951 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1952 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1953 all strings returned in the appropriate columns are concatenated together,
1954 separated by dashes I<("-")>.
1956 =item B<InstancesFrom> I<column0> [I<column1> ...]
1958 Specifies the columns whose values will be used to create the "type-instance"
1959 for each row. If you specify more than one column, the value of all columns
1960 will be joined together with dashes I<("-")> as separation characters.
1962 The plugin itself does not check whether or not all built instances are
1963 different. It's your responsibility to assure that each is unique. This is
1964 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1965 sure that only one row is returned in this case.
1967 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1970 =item B<ValuesFrom> I<column0> [I<column1> ...]
1972 Names the columns whose content is used as the actual data for the data sets
1973 that are dispatched to the daemon. How many such columns you need is determined
1974 by the B<Type> setting above. If you specify too many or not enough columns,
1975 the plugin will complain about that and no data will be submitted to the
1978 The actual data type in the columns is not that important. The plugin will
1979 automatically cast the values to the right type if it know how to do that. So
1980 it should be able to handle integer an floating point types, as well as strings
1981 (if they include a number at the beginning).
1983 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1985 =item B<MetadataFrom> [I<column0> I<column1> ...]
1987 Names the columns whose content is used as metadata for the data sets
1988 that are dispatched to the daemon.
1990 The actual data type in the columns is not that important. The plugin will
1991 automatically cast the values to the right type if it know how to do that. So
1992 it should be able to handle integer an floating point types, as well as strings
1993 (if they include a number at the beginning).
1997 =head3 B<Database> blocks
1999 Database blocks define a connection to a database and which queries should be
2000 sent to that database. Since the used "dbi" library can handle a wide variety
2001 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2002 documentationE<nbsp>- we stick as close to the terminology used there.
2004 Each database needs a "name" as string argument in the starting tag of the
2005 block. This name will be used as "PluginInstance" in the values submitted to
2006 the daemon. Other than that, that name is not used.
2010 =item B<Interval> I<Interval>
2012 Sets the interval (in seconds) in which the values will be collected from this
2013 database. By default the global B<Interval> setting will be used.
2015 =item B<Driver> I<Driver>
2017 Specifies the driver to use to connect to the database. In many cases those
2018 drivers are named after the database they can connect to, but this is not a
2019 technical necessity. These drivers are sometimes referred to as "DBD",
2020 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2021 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2022 project at L<http://libdbi-drivers.sourceforge.net/>.
2024 You need to give the driver name as expected by the "dbi" library here. You
2025 should be able to find that in the documentation for each driver. If you
2026 mistype the driver name, the plugin will dump a list of all known driver names
2029 =item B<DriverOption> I<Key> I<Value>
2031 Sets driver-specific options. What option a driver supports can be found in the
2032 documentation for each driver, somewhere at
2033 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2034 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2036 DBDs can register two types of options: String options and numeric options. The
2037 plugin will use the C<dbi_conn_set_option> function when the configuration
2038 provides a string and the C<dbi_conn_require_option_numeric> function when the
2039 configuration provides a number. So these two lines will actually result in
2040 different calls being used:
2042 DriverOption "Port" 1234 # numeric
2043 DriverOption "Port" "1234" # string
2045 Unfortunately, drivers are not too keen to report errors when an unknown option
2046 is passed to them, so invalid settings here may go unnoticed. This is not the
2047 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2048 the driver. If a driver complains about an option, the plugin will dump a
2049 complete list of all options understood by that driver to the log. There is no
2050 way to programatically find out if an option expects a string or a numeric
2051 argument, so you will have to refer to the appropriate DBD's documentation to
2052 find this out. Sorry.
2054 =item B<SelectDB> I<Database>
2056 In some cases, the database name you connect with is not the database name you
2057 want to use for querying data. If this option is set, the plugin will "select"
2058 (switch to) that database after the connection is established.
2060 =item B<Query> I<QueryName>
2062 Associates the query named I<QueryName> with this database connection. The
2063 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2064 blocks you want to refer to must be placed above the database block you want to
2067 =item B<Host> I<Hostname>
2069 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2070 values. Defaults to the global hostname setting.
2078 =item B<Device> I<Device>
2080 Select partitions based on the devicename.
2082 =item B<MountPoint> I<Directory>
2084 Select partitions based on the mountpoint.
2086 =item B<FSType> I<FSType>
2088 Select partitions based on the filesystem type.
2090 =item B<IgnoreSelected> B<true>|B<false>
2092 Invert the selection: If set to true, all partitions B<except> the ones that
2093 match any one of the criteria are collected. By default only selected
2094 partitions are collected if a selection is made. If no selection is configured
2095 at all, B<all> partitions are selected.
2097 =item B<ReportByDevice> B<true>|B<false>
2099 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2100 (the default), it will report a disk as "root", but with it I<true>, it will be
2101 "sda1" (or whichever).
2103 =item B<ReportInodes> B<true>|B<false>
2105 Enables or disables reporting of free, reserved and used inodes. Defaults to
2106 inode collection being disabled.
2108 Enable this option if inodes are a scarce resource for you, usually because
2109 many small files are stored on the disk. This is a usual scenario for mail
2110 transfer agents and web caches.
2112 =item B<ValuesAbsolute> B<true>|B<false>
2114 Enables or disables reporting of free and used disk space in 1K-blocks.
2115 Defaults to B<true>.
2117 =item B<ValuesPercentage> B<false>|B<true>
2119 Enables or disables reporting of free and used disk space in percentage.
2120 Defaults to B<false>.
2122 This is useful for deploying I<collectd> on the cloud, where machines with
2123 different disk size may exist. Then it is more practical to configure
2124 thresholds based on relative disk size.
2128 =head2 Plugin C<disk>
2130 The C<disk> plugin collects information about the usage of physical disks and
2131 logical disks (partitions). Values collected are the number of octets written
2132 to and read from a disk or partition, the number of read/write operations
2133 issued to the disk and a rather complex "time" it took for these commands to be
2136 Using the following two options you can ignore some disks or configure the
2137 collection only of specific disks.
2141 =item B<Disk> I<Name>
2143 Select the disk I<Name>. Whether it is collected or ignored depends on the
2144 B<IgnoreSelected> setting, see below. As with other plugins that use the
2145 daemon's ignorelist functionality, a string that starts and ends with a slash
2146 is interpreted as a regular expression. Examples:
2151 =item B<IgnoreSelected> B<true>|B<false>
2153 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2154 statements, are ignored or if all other disks are ignored. The behavior
2155 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2156 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2157 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2158 is set to B<true>, all disks are collected B<except> the ones matched.
2160 =item B<UseBSDName> B<true>|B<false>
2162 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2163 default major/minor numbers. Requires collectd to be built with Apple's
2166 =item B<UdevNameAttr> I<Attribute>
2168 Attempt to override disk instance name with the value of a specified udev
2169 attribute when built with B<libudev>. If the attribute is not defined for the
2170 given device, the default name is used. Example:
2172 UdevNameAttr "DM_NAME"
2176 =head2 Plugin C<dns>
2180 =item B<Interface> I<Interface>
2182 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2183 option sets the interface that should be used. If this option is not set, or
2184 set to "any", the plugin will try to get packets from B<all> interfaces. This
2185 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2187 =item B<IgnoreSource> I<IP-address>
2189 Ignore packets that originate from this address.
2191 =item B<SelectNumericQueryTypes> B<true>|B<false>
2193 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2197 =head2 Plugin C<email>
2201 =item B<SocketFile> I<Path>
2203 Sets the socket-file which is to be created.
2205 =item B<SocketGroup> I<Group>
2207 If running as root change the group of the UNIX-socket after it has been
2208 created. Defaults to B<collectd>.
2210 =item B<SocketPerms> I<Permissions>
2212 Change the file permissions of the UNIX-socket after it has been created. The
2213 permissions must be given as a numeric, octal value as you would pass to
2214 L<chmod(1)>. Defaults to B<0770>.
2216 =item B<MaxConns> I<Number>
2218 Sets the maximum number of connections that can be handled in parallel. Since
2219 this many threads will be started immediately setting this to a very high
2220 value will waste valuable resources. Defaults to B<5> and will be forced to be
2221 at most B<16384> to prevent typos and dumb mistakes.
2225 =head2 Plugin C<ethstat>
2227 The I<ethstat plugin> collects information about network interface cards (NICs)
2228 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2234 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2235 Map "multicast" "if_multicast"
2242 =item B<Interface> I<Name>
2244 Collect statistical information about interface I<Name>.
2246 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2248 By default, the plugin will submit values as type C<derive> and I<type
2249 instance> set to I<Name>, the name of the metric as reported by the driver. If
2250 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2251 I<TypeInstance> will be used.
2253 =item B<MappedOnly> B<true>|B<false>
2255 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2256 collected, all other metrics will be ignored. Defaults to B<false>.
2260 =head2 Plugin C<exec>
2262 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2263 contains valuable information on when the executable is executed and the
2264 output that is expected from it.
2268 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2270 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2272 Execute the executable I<Executable> as user I<User>. If the user name is
2273 followed by a colon and a group name, the effective group is set to that group.
2274 The real group and saved-set group will be set to the default group of that
2275 user. If no group is given the effective group ID will be the same as the real
2278 Please note that in order to change the user and/or group the daemon needs
2279 superuser privileges. If the daemon is run as an unprivileged user you must
2280 specify the same user/group here. If the daemon is run with superuser
2281 privileges, you must supply a non-root user here.
2283 The executable may be followed by optional arguments that are passed to the
2284 program. Please note that due to the configuration parsing numbers and boolean
2285 values may be changed. If you want to be absolutely sure that something is
2286 passed as-is please enclose it in quotes.
2288 The B<Exec> and B<NotificationExec> statements change the semantics of the
2289 programs executed, i.E<nbsp>e. the data passed to them and the response
2290 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2294 =head2 Plugin C<fhcount>
2296 The C<fhcount> plugin provides statistics about used, unused and total number of
2297 file handles on Linux.
2299 The I<fhcount plugin> provides the following configuration options:
2303 =item B<ValuesAbsolute> B<true>|B<false>
2305 Enables or disables reporting of file handles usage in absolute numbers,
2306 e.g. file handles used. Defaults to B<true>.
2308 =item B<ValuesPercentage> B<false>|B<true>
2310 Enables or disables reporting of file handles usage in percentages, e.g.
2311 percent of file handles used. Defaults to B<false>.
2315 =head2 Plugin C<filecount>
2317 The C<filecount> plugin counts the number of files in a certain directory (and
2318 its subdirectories) and their combined size. The configuration is very straight
2321 <Plugin "filecount">
2322 <Directory "/var/qmail/queue/mess">
2323 Instance "qmail-message"
2325 <Directory "/var/qmail/queue/todo">
2326 Instance "qmail-todo"
2328 <Directory "/var/lib/php5">
2329 Instance "php5-sessions"
2334 The example above counts the number of files in QMail's queue directories and
2335 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2336 QMail has not yet looked at, the "message" queue holds the messages that were
2337 classified into "local" and "remote".
2339 As you can see, the configuration consists of one or more C<Directory> blocks,
2340 each of which specifies a directory in which to count the files. Within those
2341 blocks, the following options are recognized:
2345 =item B<Instance> I<Instance>
2347 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2348 it's your responsibility, the plugin doesn't check for that. If not given, the
2349 instance is set to the directory name with all slashes replaced by underscores
2350 and all leading underscores removed.
2352 =item B<Name> I<Pattern>
2354 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2355 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2356 against the pattern, not the entire path. In case this makes it easier for you:
2357 This option has been named after the B<-name> parameter to L<find(1)>.
2359 =item B<MTime> I<Age>
2361 Count only files of a specific age: If I<Age> is greater than zero, only files
2362 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2363 a negative number, this is inversed. For example, if B<-60> is specified, only
2364 files that have been modified in the last minute will be counted.
2366 The number can also be followed by a "multiplier" to easily specify a larger
2367 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2368 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2369 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2370 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2371 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2374 =item B<Size> I<Size>
2376 Count only files of a specific size. When I<Size> is a positive number, only
2377 files that are at least this big are counted. If I<Size> is a negative number,
2378 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2379 I<Size> are counted.
2381 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2382 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2383 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2384 note that there are 1000 bytes in a kilobyte, not 1024.
2386 =item B<Recursive> I<true>|I<false>
2388 Controls whether or not to recurse into subdirectories. Enabled by default.
2390 =item B<IncludeHidden> I<true>|I<false>
2392 Controls whether or not to include "hidden" files and directories in the count.
2393 "Hidden" files and directories are those, whose name begins with a dot.
2394 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2398 =head2 Plugin C<GenericJMX>
2400 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2401 L<collectd-java(5)>.
2403 =head2 Plugin C<gmond>
2405 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2406 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2407 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2412 MCReceiveFrom "239.2.11.71" "8649"
2413 <Metric "swap_total">
2415 TypeInstance "total"
2418 <Metric "swap_free">
2425 The following metrics are built-in:
2431 load_one, load_five, load_fifteen
2435 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2439 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2451 Available configuration options:
2455 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2457 Sets sets the multicast group and UDP port to which to subscribe.
2459 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2461 =item E<lt>B<Metric> I<Name>E<gt>
2463 These blocks add a new metric conversion to the internal table. I<Name>, the
2464 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2468 =item B<Type> I<Type>
2470 Type to map this metric to. Required.
2472 =item B<TypeInstance> I<Instance>
2474 Type-instance to use. Optional.
2476 =item B<DataSource> I<Name>
2478 Data source to map this metric to. If the configured type has exactly one data
2479 source, this is optional. Otherwise the option is required.
2485 =head2 Plugin C<gps>
2487 The C<gps plugin> connects to gpsd on the host machine.
2488 The host, port, timeout and pause are configurable.
2490 This is useful if you run an NTP server using a GPS for source and you want to
2493 Mind your GPS must send $--GSA for having the data reported!
2495 The following elements are collected:
2501 Number of satellites used for fix (type instance "used") and in view (type
2502 instance "visible"). 0 means no GPS satellites are visible.
2504 =item B<dilution_of_precision>
2506 Vertical and horizontal dilution.
2507 It should be between 0 and 3.
2508 Look at the documentaiton of your GPS to know more.
2516 # Connect to localhost on gpsd regular port:
2521 # PauseRead of 5 sec. between readings:
2523 # PauseConnect of 1 sec. between connection tentatives:
2527 Available configuration options:
2531 =item B<Host> I<Host>
2533 The host on which gpsd runs. Defaults to B<localhost>.
2535 =item B<Port> I<Port>
2537 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2539 =item B<Timeout> I<Seconds>
2541 Timeout in seconds (default 0.015 sec).
2543 =item B<PauseRead> I<Seconds>
2545 Pause to apply between readings in seconds (default 1 sec).
2547 =item B<PauseConnect> I<Seconds>
2549 Pause to apply between tentative of connection in seconds (default 1 sec).
2553 =head2 Plugin C<hddtemp>
2555 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2556 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2557 default values, see below. C<hddtemp> has to be running to work correctly. If
2558 C<hddtemp> is not running timeouts may appear which may interfere with other
2561 The B<hddtemp> homepage can be found at
2562 L<http://www.guzu.net/linux/hddtemp.php>.
2566 =item B<Host> I<Hostname>
2568 Hostname to connect to. Defaults to B<127.0.0.1>.
2570 =item B<Port> I<Port>
2572 TCP-Port to connect to. Defaults to B<7634>.
2576 =head2 Plugin C<interface>
2580 =item B<Interface> I<Interface>
2582 Select this interface. By default these interfaces will then be collected. For
2583 a more detailed description see B<IgnoreSelected> below.
2585 =item B<IgnoreSelected> I<true>|I<false>
2587 If no configuration if given, the B<traffic>-plugin will collect data from
2588 all interfaces. This may not be practical, especially for loopback- and
2589 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2590 interfaces you're interested in. Sometimes, however, it's easier/preferred
2591 to collect all interfaces I<except> a few ones. This option enables you to
2592 do that: By setting B<IgnoreSelected> to I<true> the effect of
2593 B<Interface> is inverted: All selected interfaces are ignored and all
2594 other interfaces are collected.
2598 =head2 Plugin C<ipmi>
2602 =item B<Sensor> I<Sensor>
2604 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2606 =item B<IgnoreSelected> I<true>|I<false>
2608 If no configuration if given, the B<ipmi> plugin will collect data from all
2609 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2610 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2611 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2612 all other sensors are collected.
2614 =item B<NotifySensorAdd> I<true>|I<false>
2616 If a sensor appears after initialization time of a minute a notification
2619 =item B<NotifySensorRemove> I<true>|I<false>
2621 If a sensor disappears a notification is sent.
2623 =item B<NotifySensorNotPresent> I<true>|I<false>
2625 If you have for example dual power supply and one of them is (un)plugged then
2626 a notification is sent.
2630 =head2 Plugin C<iptables>
2634 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2636 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2637 will collect the counters of all rules which have a comment-match. The comment
2638 is then used as type-instance.
2640 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2641 the I<n>th rule will be collected. Again, the comment (or the number) will be
2642 used as the type-instance.
2644 If I<Name> is supplied, it will be used as the type-instance instead of the
2645 comment or the number.
2649 =head2 Plugin C<irq>
2655 Select this irq. By default these irqs will then be collected. For a more
2656 detailed description see B<IgnoreSelected> below.
2658 =item B<IgnoreSelected> I<true>|I<false>
2660 If no configuration if given, the B<irq>-plugin will collect data from all
2661 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2662 can use the B<Irq>-option to pick the interrupt you're interested in.
2663 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2664 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2665 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2666 and all other interrupts are collected.
2670 =head2 Plugin C<java>
2672 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2673 This section only discusses the syntax and semantic of the configuration
2674 options. For more in-depth information on the I<Java> plugin, please read
2675 L<collectd-java(5)>.
2680 JVMArg "-verbose:jni"
2681 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2682 LoadPlugin "org.collectd.java.Foobar"
2683 <Plugin "org.collectd.java.Foobar">
2684 # To be parsed by the plugin
2688 Available configuration options:
2692 =item B<JVMArg> I<Argument>
2694 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2695 exactly the way the arguments to the I<java> binary on the command line work.
2696 Execute C<javaE<nbsp>--help> for details.
2698 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2699 any other options! When another option is found, the JVM will be started and
2700 later options will have to be ignored!
2702 =item B<LoadPlugin> I<JavaClass>
2704 Instantiates a new I<JavaClass> object. The constructor of this object very
2705 likely then registers one or more callback methods with the server.
2707 See L<collectd-java(5)> for details.
2709 When the first such option is found, the virtual machine (JVM) is created. This
2710 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2711 B<LoadPlugin> options!
2713 =item B<Plugin> I<Name>
2715 The entire block is passed to the Java plugin as an
2716 I<org.collectd.api.OConfigItem> object.
2718 For this to work, the plugin has to register a configuration callback first,
2719 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2720 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2721 depends on the (Java) plugin registering the callback and is completely
2722 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2726 =head2 Plugin C<load>
2728 The I<Load plugin> collects the system load. These numbers give a rough overview
2729 over the utilization of a machine. The system load is defined as the number of
2730 runnable tasks in the run-queue and is provided by many operating systems as a
2731 one, five or fifteen minute average.
2733 The following configuration options are available:
2737 =item B<ReportRelative> B<false>|B<true>
2739 When enabled, system load divided by number of available CPU cores is reported
2740 for intervals 1 min, 5 min and 15 min. Defaults to false.
2745 =head2 Plugin C<logfile>
2749 =item B<LogLevel> B<debug|info|notice|warning|err>
2751 Sets the log-level. If, for example, set to B<notice>, then all events with
2752 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2754 Please note that B<debug> is only available if collectd has been compiled with
2757 =item B<File> I<File>
2759 Sets the file to write log messages to. The special strings B<stdout> and
2760 B<stderr> can be used to write to the standard output and standard error
2761 channels, respectively. This, of course, only makes much sense when I<collectd>
2762 is running in foreground- or non-daemon-mode.
2764 =item B<Timestamp> B<true>|B<false>
2766 Prefix all lines printed by the current time. Defaults to B<true>.
2768 =item B<PrintSeverity> B<true>|B<false>
2770 When enabled, all lines are prefixed by the severity of the log message, for
2771 example "warning". Defaults to B<false>.
2775 B<Note>: There is no need to notify the daemon after moving or removing the
2776 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2777 for each line it writes.
2779 =head2 Plugin C<log_logstash>
2781 The I<log logstash plugin> behaves like the logfile plugin but formats
2782 messages as JSON events for logstash to parse and input.
2786 =item B<LogLevel> B<debug|info|notice|warning|err>
2788 Sets the log-level. If, for example, set to B<notice>, then all events with
2789 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2791 Please note that B<debug> is only available if collectd has been compiled with
2794 =item B<File> I<File>
2796 Sets the file to write log messages to. The special strings B<stdout> and
2797 B<stderr> can be used to write to the standard output and standard error
2798 channels, respectively. This, of course, only makes much sense when I<collectd>
2799 is running in foreground- or non-daemon-mode.
2803 B<Note>: There is no need to notify the daemon after moving or removing the
2804 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2805 for each line it writes.
2807 =head2 Plugin C<lpar>
2809 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2810 virtualization technique for IBM POWER processors. It takes into account CPU
2811 time stolen from or donated to a partition, in addition to the usual user,
2812 system, I/O statistics.
2814 The following configuration options are available:
2818 =item B<CpuPoolStats> B<false>|B<true>
2820 When enabled, statistics about the processor pool are read, too. The partition
2821 needs to have pool authority in order to be able to acquire this information.
2824 =item B<ReportBySerial> B<false>|B<true>
2826 If enabled, the serial of the physical machine the partition is currently
2827 running on is reported as I<hostname> and the logical hostname of the machine
2828 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2829 used (just like other plugins) and the I<plugin instance> will be empty.
2834 =head2 Plugin C<mbmon>
2836 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2838 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2839 B<Host> and B<Port> options can be used to change these values, see below.
2840 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2841 timeouts may appear which may interfere with other statistics..
2843 C<mbmon> must be run with the -r option ("print TAG and Value format");
2844 Debian's F</etc/init.d/mbmon> script already does this, other people
2845 will need to ensure that this is the case.
2849 =item B<Host> I<Hostname>
2851 Hostname to connect to. Defaults to B<127.0.0.1>.
2853 =item B<Port> I<Port>
2855 TCP-Port to connect to. Defaults to B<411>.
2861 The C<md plugin> collects information from Linux Software-RAID devices (md).
2863 All reported values are of the type C<md_disks>. Reported type instances are
2864 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2865 I<missing> (physically absent) disks.
2869 =item B<Device> I<Device>
2871 Select md devices based on device name. The I<device name> is the basename of
2872 the device, i.e. the name of the block device without the leading C</dev/>.
2873 See B<IgnoreSelected> for more details.
2875 =item B<IgnoreSelected> B<true>|B<false>
2877 Invert device selection: If set to B<true>, all md devices B<except> those
2878 listed using B<Device> are collected. If B<false> (the default), only those
2879 listed are collected. If no configuration is given, the B<md> plugin will
2880 collect data from all md devices.
2884 =head2 Plugin C<memcachec>
2886 The C<memcachec plugin> connects to a memcached server, queries one or more
2887 given I<pages> and parses the returned data according to user specification.
2888 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2891 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2892 library. Please note that there is another library with a very similar name,
2893 libmemcache (notice the missing `d'), which is not applicable.
2895 Synopsis of the configuration:
2897 <Plugin "memcachec">
2898 <Page "plugin_instance">
2902 Regex "(\\d+) bytes sent"
2905 Instance "type_instance"
2910 The configuration options are:
2914 =item E<lt>B<Page> I<Name>E<gt>
2916 Each B<Page> block defines one I<page> to be queried from the memcached server.
2917 The block requires one string argument which is used as I<plugin instance>.
2919 =item B<Server> I<Address>
2921 Sets the server address to connect to when querying the page. Must be inside a
2926 When connected to the memcached server, asks for the page I<Key>.
2928 =item E<lt>B<Match>E<gt>
2930 Match blocks define which strings to look for and how matches substrings are
2931 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2935 =head2 Plugin C<memcached>
2937 The B<memcached plugin> connects to a memcached server and queries statistics
2938 about cache utilization, memory and bandwidth used.
2939 L<http://www.danga.com/memcached/>
2941 <Plugin "memcached">
2943 Host "memcache.example.com"
2948 The plugin configuration consists of one or more B<Instance> blocks which
2949 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2950 following options are allowed:
2954 =item B<Host> I<Hostname>
2956 Hostname to connect to. Defaults to B<127.0.0.1>.
2958 =item B<Port> I<Port>
2960 TCP-Port to connect to. Defaults to B<11211>.
2962 =item B<Socket> I<Path>
2964 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2965 setting is given, the B<Host> and B<Port> settings are ignored.
2969 =head2 Plugin C<mic>
2971 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2972 Intel's Many Integrated Core (MIC) systems.
2981 ShowTemperatures true
2984 IgnoreSelectedTemperature true
2989 IgnoreSelectedPower true
2992 The following options are valid inside the B<PluginE<nbsp>mic> block:
2996 =item B<ShowCPU> B<true>|B<false>
2998 If enabled (the default) a sum of the CPU usage across all cores is reported.
3000 =item B<ShowCPUCores> B<true>|B<false>
3002 If enabled (the default) per-core CPU usage is reported.
3004 =item B<ShowMemory> B<true>|B<false>
3006 If enabled (the default) the physical memory usage of the MIC system is
3009 =item B<ShowTemperatures> B<true>|B<false>
3011 If enabled (the default) various temperatures of the MIC system are reported.
3013 =item B<Temperature> I<Name>
3015 This option controls which temperatures are being reported. Whether matching
3016 temperatures are being ignored or I<only> matching temperatures are reported
3017 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3018 temperatures are reported.
3020 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3022 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3023 (the default) only temperatures matching a B<Temperature> option are reported
3024 or, if no B<Temperature> option is specified, all temperatures are reported. If
3025 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3028 Known temperature names are:
3062 =item B<ShowPower> B<true>|B<false>
3064 If enabled (the default) various temperatures of the MIC system are reported.
3066 =item B<Power> I<Name>
3068 This option controls which power readings are being reported. Whether matching
3069 power readings are being ignored or I<only> matching power readings are reported
3070 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3071 power readings are reported.
3073 =item B<IgnoreSelectedPower> B<false>|B<true>
3075 Controls the behavior of the B<Power> setting above. If set to B<false>
3076 (the default) only power readings matching a B<Power> option are reported
3077 or, if no B<Power> option is specified, all power readings are reported. If
3078 set to B<true>, matching power readings are I<ignored> and all other power readings
3081 Known power names are:
3087 Total power utilization averaged over Time Window 0 (uWatts).
3091 Total power utilization averaged over Time Window 0 (uWatts).
3095 Instantaneous power (uWatts).
3099 Max instantaneous power (uWatts).
3103 PCI-E connector power (uWatts).
3107 2x3 connector power (uWatts).
3111 2x4 connector power (uWatts).
3119 Uncore rail (uVolts).
3123 Memory subsystem rail (uVolts).
3129 =head2 Plugin C<memory>
3131 The I<memory plugin> provides the following configuration options:
3135 =item B<ValuesAbsolute> B<true>|B<false>
3137 Enables or disables reporting of physical memory usage in absolute numbers,
3138 i.e. bytes. Defaults to B<true>.
3140 =item B<ValuesPercentage> B<false>|B<true>
3142 Enables or disables reporting of physical memory usage in percentages, e.g.
3143 percent of physical memory used. Defaults to B<false>.
3145 This is useful for deploying I<collectd> in a heterogeneous environment in
3146 which the sizes of physical memory vary.
3150 =head2 Plugin C<modbus>
3152 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3153 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3154 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3155 values (two registers interpreted as IEEE floats in big endian notation).
3159 <Data "voltage-input-1">
3162 RegisterCmd ReadHolding
3167 <Data "voltage-input-2">
3170 RegisterCmd ReadHolding
3175 <Data "supply-temperature-1">
3178 RegisterCmd ReadHolding
3183 <Host "modbus.example.com">
3184 Address "192.168.0.42"
3189 Instance "power-supply"
3190 Collect "voltage-input-1"
3191 Collect "voltage-input-2"
3196 Device "/dev/ttyUSB0"
3201 Instance "temperature"
3202 Collect "supply-temperature-1"
3208 =item E<lt>B<Data> I<Name>E<gt> blocks
3210 Data blocks define a mapping between register numbers and the "types" used by
3213 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3217 =item B<RegisterBase> I<Number>
3219 Configures the base register to read from the device. If the option
3220 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3221 register will be read (the register number is increased by one).
3223 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3225 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3226 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3227 combined into one value. Defaults to B<Uint16>.
3229 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3231 Specifies register type to be collected from device. Works only with libmodbus
3232 2.9.2 or higher. Defaults to B<ReadHolding>.
3234 =item B<Type> I<Type>
3236 Specifies the "type" (data set) to use when dispatching the value to
3237 I<collectd>. Currently, only data sets with exactly one data source are
3240 =item B<Instance> I<Instance>
3242 Sets the type instance to use when dispatching the value to I<collectd>. If
3243 unset, an empty string (no type instance) is used.
3247 =item E<lt>B<Host> I<Name>E<gt> blocks
3249 Host blocks are used to specify to which hosts to connect and what data to read
3250 from their "slaves". The string argument I<Name> is used as hostname when
3251 dispatching the values to I<collectd>.
3253 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3257 =item B<Address> I<Hostname>
3259 For Modbus/TCP, specifies the node name (the actual network address) used to
3260 connect to the host. This may be an IP address or a hostname. Please note that
3261 the used I<libmodbus> library only supports IPv4 at the moment.
3263 =item B<Port> I<Service>
3265 for Modbus/TCP, specifies the port used to connect to the host. The port can
3266 either be given as a number or as a service name. Please note that the
3267 I<Service> argument must be a string, even if ports are given in their numerical
3268 form. Defaults to "502".
3270 =item B<Device> I<Devicenode>
3272 For Modbus/RTU, specifies the path to the serial device being used.
3274 =item B<Baudrate> I<Baudrate>
3276 For Modbus/RTU, specifies the baud rate of the serial device.
3277 Note, connections currently support only 8/N/1.
3279 =item B<Interval> I<Interval>
3281 Sets the interval (in seconds) in which the values will be collected from this
3282 host. By default the global B<Interval> setting will be used.
3284 =item E<lt>B<Slave> I<ID>E<gt>
3286 Over each connection, multiple Modbus devices may be reached. The slave ID
3287 is used to specify which device should be addressed. For each device you want
3288 to query, one B<Slave> block must be given.
3290 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3294 =item B<Instance> I<Instance>
3296 Specify the plugin instance to use when dispatching the values to I<collectd>.
3297 By default "slave_I<ID>" is used.
3299 =item B<Collect> I<DataName>
3301 Specifies which data to retrieve from the device. I<DataName> must be the same
3302 string as the I<Name> argument passed to a B<Data> block. You can specify this
3303 option multiple times to collect more than one value from a slave. At least one
3304 B<Collect> option is mandatory.
3312 =head2 Plugin C<mqtt>
3314 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
3315 values from MQTT (B<Subscribe> blocks).
3321 Host "mqtt.example.com"
3325 Host "mqtt.example.com"
3330 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
3331 configuring the sending and receiving direction respectively. The plugin will
3332 register a write callback named C<mqtt/I<name>> where I<name> is the string
3333 argument given to the B<Publish> block. Both types of blocks share many but not
3334 all of the following options. If an option is valid in only one of the blocks,
3335 it will be mentioned explicitly.
3341 =item B<Host> I<Hostname>
3343 Hostname of the MQTT broker to connect to.
3345 =item B<Port> I<Service>
3347 Port number or service name of the MQTT broker to connect to.
3349 =item B<User> I<UserName>
3351 Username used when authenticating to the MQTT broker.
3353 =item B<Password> I<Password>
3355 Password used when authenticating to the MQTT broker.
3357 =item B<ClientId> I<ClientId>
3359 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
3361 =item B<QoS> [B<0>-B<2>]
3363 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
3381 In B<Publish> blocks, this option determines the QoS flag set on outgoing
3382 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
3383 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
3384 on a message is larger than the maximum accepted QoS of a subscriber, the
3385 message's QoS will be downgraded.
3387 =item B<Prefix> I<Prefix> (Publish only)
3389 This plugin will use one topic per I<value list> which will looks like a path.
3390 I<Prefix> is used as the first path element and defaults to B<collectd>.
3392 An example topic name would be:
3394 collectd/cpu-0/cpu-user
3396 =item B<Retain> B<false>|B<true> (Publish only)
3398 Controls whether the MQTT broker will retain (keep a copy of) the last message
3399 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
3401 =item B<StoreRates> B<true>|B<false> (Publish only)
3403 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
3404 before sending. Defaults to B<true>.
3406 =item B<CleanSession> B<true>|B<false> (Subscribe only)
3408 Controls whether the MQTT "cleans" the session up after the subscriber
3409 disconnects or if it maintains the subscriber's subscriptions and all messages
3410 that arrive while the subscriber is disconnected. Defaults to B<true>.
3412 =item B<Topic> I<TopicName> (Subscribe only)
3414 Configures the topic(s) to subscribe to. You can use the single level C<+> and
3415 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
3416 the B<collectd> branch.
3420 =head2 Plugin C<mysql>
3422 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3423 one or more databases when started and keeps the connection up as long as
3424 possible. When the connection is interrupted for whatever reason it will try
3425 to re-connect. The plugin will complain loudly in case anything goes wrong.
3427 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3428 and collects information about MySQL network traffic, executed statements,
3429 requests, the query cache and threads by evaluating the
3430 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3431 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3432 Status Variables> for an explanation of these values.
3434 Optionally, master and slave statistics may be collected in a MySQL
3435 replication setup. In that case, information about the synchronization state
3436 of the nodes are collected by evaluating the C<Position> return value of the
3437 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3438 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3439 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3440 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3441 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3458 Socket "/var/run/mysql/mysqld.sock"
3460 SlaveNotifications true
3464 A B<Database> block defines one connection to a MySQL database. It accepts a
3465 single argument which specifies the name of the database. None of the other
3466 options are required. MySQL will use default values as documented in the
3467 section "mysql_real_connect()" in the B<MySQL reference manual>.
3471 =item B<Alias> I<Alias>
3473 Alias to use as sender instead of hostname when reporting. This may be useful
3474 when having cryptic hostnames.
3476 =item B<Host> I<Hostname>
3478 Hostname of the database server. Defaults to B<localhost>.
3480 =item B<User> I<Username>
3482 Username to use when connecting to the database. The user does not have to be
3483 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3484 unless you want to collectd replication statistics (see B<MasterStats> and
3485 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3486 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3488 =item B<Password> I<Password>
3490 Password needed to log into the database.
3492 =item B<Database> I<Database>
3494 Select this database. Defaults to I<no database> which is a perfectly reasonable
3495 option for what this plugin does.
3497 =item B<Port> I<Port>
3499 TCP-port to connect to. The port must be specified in its numeric form, but it
3500 must be passed as a string nonetheless. For example:
3504 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3505 See the documentation for the C<mysql_real_connect> function for details.
3507 =item B<Socket> I<Socket>
3509 Specifies the path to the UNIX domain socket of the MySQL server. This option
3510 only has any effect, if B<Host> is set to B<localhost> (the default).
3511 Otherwise, use the B<Port> option above. See the documentation for the
3512 C<mysql_real_connect> function for details.
3514 =item B<InnodbStats> I<true|false>
3516 If enabled, metrics about the InnoDB storage engine are collected.
3517 Disabled by default.
3519 =item B<MasterStats> I<true|false>
3521 =item B<SlaveStats> I<true|false>
3523 Enable the collection of master / slave statistics in a replication setup. In
3524 order to be able to get access to these statistics, the user needs special
3525 privileges. See the B<User> documentation above. Defaults to B<false>.
3527 =item B<SlaveNotifications> I<true|false>
3529 If enabled, the plugin sends a notification if the replication slave I/O and /
3530 or SQL threads are not running. Defaults to B<false>.
3532 =item B<ConnectTimeout> I<Seconds>
3534 Sets the connect timeout for the MySQL client.
3538 =head2 Plugin C<netapp>
3540 The netapp plugin can collect various performance and capacity information
3541 from a NetApp filer using the NetApp API.
3543 Please note that NetApp has a wide line of products and a lot of different
3544 software versions for each of these products. This plugin was developed for a
3545 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3546 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3547 model and software version but it is very hard to test this.
3548 If you have used this plugin with other models and/or software version, feel
3549 free to send us a mail to tell us about the results, even if it's just a short
3552 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3553 basic authentication.
3555 B<Do not use a regular user for this!> Create a special collectd user with just
3556 the minimum of capabilities needed. The user only needs the "login-http-admin"
3557 capability as well as a few more depending on which data will be collected.
3558 Required capabilities are documented below.
3563 <Host "netapp1.example.com">
3587 IgnoreSelectedIO false
3589 IgnoreSelectedOps false
3590 GetLatency "volume0"
3591 IgnoreSelectedLatency false
3598 IgnoreSelectedCapacity false
3601 IgnoreSelectedSnapshot false
3629 The netapp plugin accepts the following configuration options:
3633 =item B<Host> I<Name>
3635 A host block defines one NetApp filer. It will appear in collectd with the name
3636 you specify here which does not have to be its real name nor its hostname (see
3637 the B<Address> option below).
3639 =item B<VFiler> I<Name>
3641 A B<VFiler> block may only be used inside a host block. It accepts all the
3642 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3643 will execute all NetApp API commands in the context of the specified
3644 VFiler(R). It will appear in collectd with the name you specify here which
3645 does not have to be its real name. The VFiler name may be specified using the
3646 B<VFilerName> option. If this is not specified, it will default to the name
3649 The VFiler block inherits all connection related settings from the surrounding
3650 B<Host> block (which appear before the B<VFiler> block) but they may be
3651 overwritten inside the B<VFiler> block.
3653 This feature is useful, for example, when using a VFiler as SnapVault target
3654 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3655 available in the host filer (vfiler0) but only in the respective VFiler
3658 =item B<Protocol> B<httpd>|B<http>
3660 The protocol collectd will use to query this host.
3668 Valid options: http, https
3670 =item B<Address> I<Address>
3672 The hostname or IP address of the host.
3678 Default: The "host" block's name.
3680 =item B<Port> I<Port>
3682 The TCP port to connect to on the host.
3688 Default: 80 for protocol "http", 443 for protocol "https"
3690 =item B<User> I<User>
3692 =item B<Password> I<Password>
3694 The username and password to use to login to the NetApp.
3700 =item B<VFilerName> I<Name>
3702 The name of the VFiler in which context to execute API commands. If not
3703 specified, the name provided to the B<VFiler> block will be used instead.
3709 Default: name of the B<VFiler> block
3711 B<Note:> This option may only be used inside B<VFiler> blocks.
3713 =item B<Interval> I<Interval>
3719 The following options decide what kind of data will be collected. You can
3720 either use them as a block and fine tune various parameters inside this block,
3721 use them as a single statement to just accept all default values, or omit it to
3722 not collect any data.
3724 The following options are valid inside all blocks:
3728 =item B<Interval> I<Seconds>
3730 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3731 host specific setting.
3735 =head3 The System block
3737 This will collect various performance data about the whole system.
3739 B<Note:> To get this data the collectd user needs the
3740 "api-perf-object-get-instances" capability.
3744 =item B<Interval> I<Seconds>
3746 Collect disk statistics every I<Seconds> seconds.
3748 =item B<GetCPULoad> B<true>|B<false>
3750 If you set this option to true the current CPU usage will be read. This will be
3751 the average usage between all CPUs in your NetApp without any information about
3754 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3755 returns in the "CPU" field.
3763 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3765 =item B<GetInterfaces> B<true>|B<false>
3767 If you set this option to true the current traffic of the network interfaces
3768 will be read. This will be the total traffic over all interfaces of your NetApp
3769 without any information about individual interfaces.
3771 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3772 in the "Net kB/s" field.
3782 Result: One value list of type "if_octects".
3784 =item B<GetDiskIO> B<true>|B<false>
3786 If you set this option to true the current IO throughput will be read. This
3787 will be the total IO of your NetApp without any information about individual
3788 disks, volumes or aggregates.
3790 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3791 in the "DiskE<nbsp>kB/s" field.
3799 Result: One value list of type "disk_octets".
3801 =item B<GetDiskOps> B<true>|B<false>
3803 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3804 iSCSI, etc. operations will be read. This will be the total number of
3805 operations on your NetApp without any information about individual volumes or
3808 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3809 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3817 Result: A variable number of value lists of type "disk_ops_complex". Each type
3818 of operation will result in one value list with the name of the operation as
3823 =head3 The WAFL block
3825 This will collect various performance data about the WAFL file system. At the
3826 moment this just means cache performance.
3828 B<Note:> To get this data the collectd user needs the
3829 "api-perf-object-get-instances" capability.
3831 B<Note:> The interface to get these values is classified as "Diagnostics" by
3832 NetApp. This means that it is not guaranteed to be stable even between minor
3837 =item B<Interval> I<Seconds>
3839 Collect disk statistics every I<Seconds> seconds.
3841 =item B<GetNameCache> B<true>|B<false>
3849 Result: One value list of type "cache_ratio" and type instance
3852 =item B<GetDirCache> B<true>|B<false>
3860 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3862 =item B<GetInodeCache> B<true>|B<false>
3870 Result: One value list of type "cache_ratio" and type instance
3873 =item B<GetBufferCache> B<true>|B<false>
3875 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3876 in the "Cache hit" field.
3884 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3888 =head3 The Disks block
3890 This will collect performance data about the individual disks in the NetApp.
3892 B<Note:> To get this data the collectd user needs the
3893 "api-perf-object-get-instances" capability.
3897 =item B<Interval> I<Seconds>
3899 Collect disk statistics every I<Seconds> seconds.
3901 =item B<GetBusy> B<true>|B<false>
3903 If you set this option to true the busy time of all disks will be calculated
3904 and the value of the busiest disk in the system will be written.
3906 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3907 in the "Disk util" field. Probably.
3915 Result: One value list of type "percent" and type instance "disk_busy".
3919 =head3 The VolumePerf block
3921 This will collect various performance data about the individual volumes.
3923 You can select which data to collect about which volume using the following
3924 options. They follow the standard ignorelist semantic.
3926 B<Note:> To get this data the collectd user needs the
3927 I<api-perf-object-get-instances> capability.
3931 =item B<Interval> I<Seconds>
3933 Collect volume performance data every I<Seconds> seconds.
3935 =item B<GetIO> I<Volume>
3937 =item B<GetOps> I<Volume>
3939 =item B<GetLatency> I<Volume>
3941 Select the given volume for IO, operations or latency statistics collection.
3942 The argument is the name of the volume without the C</vol/> prefix.
3944 Since the standard ignorelist functionality is used here, you can use a string
3945 starting and ending with a slash to specify regular expression matching: To
3946 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3949 GetIO "/^vol[027]$/"
3951 If no regular expression is specified, an exact match is required. Both,
3952 regular and exact matching are case sensitive.
3954 If no volume was specified at all for either of the three options, that data
3955 will be collected for all available volumes.
3957 =item B<IgnoreSelectedIO> B<true>|B<false>
3959 =item B<IgnoreSelectedOps> B<true>|B<false>
3961 =item B<IgnoreSelectedLatency> B<true>|B<false>
3963 When set to B<true>, the volumes selected for IO, operations or latency
3964 statistics collection will be ignored and the data will be collected for all
3967 When set to B<false>, data will only be collected for the specified volumes and
3968 all other volumes will be ignored.
3970 If no volumes have been specified with the above B<Get*> options, all volumes
3971 will be collected regardless of the B<IgnoreSelected*> option.
3973 Defaults to B<false>
3977 =head3 The VolumeUsage block
3979 This will collect capacity data about the individual volumes.
3981 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3986 =item B<Interval> I<Seconds>
3988 Collect volume usage statistics every I<Seconds> seconds.
3990 =item B<GetCapacity> I<VolumeName>
3992 The current capacity of the volume will be collected. This will result in two
3993 to four value lists, depending on the configuration of the volume. All data
3994 sources are of type "df_complex" with the name of the volume as
3997 There will be type_instances "used" and "free" for the number of used and
3998 available bytes on the volume. If the volume has some space reserved for
3999 snapshots, a type_instance "snap_reserved" will be available. If the volume
4000 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4001 number of bytes saved by the SIS feature.
4003 B<Note:> The current NetApp API has a bug that results in this value being
4004 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4005 number which works most of the time. If you see strange values here, bug
4006 NetApp support to fix this.
4008 Repeat this option to specify multiple volumes.
4010 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4012 Specify whether to collect only the volumes selected by the B<GetCapacity>
4013 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4014 B<false>. However, if no B<GetCapacity> option is specified at all, all
4015 capacities will be selected anyway.
4017 =item B<GetSnapshot> I<VolumeName>
4019 Select volumes from which to collect snapshot information.
4021 Usually, the space used for snapshots is included in the space reported as
4022 "used". If snapshot information is collected as well, the space used for
4023 snapshots is subtracted from the used space.
4025 To make things even more interesting, it is possible to reserve space to be
4026 used for snapshots. If the space required for snapshots is less than that
4027 reserved space, there is "reserved free" and "reserved used" space in addition
4028 to "free" and "used". If the space required for snapshots exceeds the reserved
4029 space, that part allocated in the normal space is subtracted from the "used"
4032 Repeat this option to specify multiple volumes.
4034 =item B<IgnoreSelectedSnapshot>
4036 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4037 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4038 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4039 capacities will be selected anyway.
4043 =head3 The Quota block
4045 This will collect (tree) quota statistics (used disk space and number of used
4046 files). This mechanism is useful to get usage information for single qtrees.
4047 In case the quotas are not used for any other purpose, an entry similar to the
4048 following in C</etc/quotas> would be sufficient:
4050 /vol/volA/some_qtree tree - - - - -
4052 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4056 =item B<Interval> I<Seconds>
4058 Collect SnapVault(R) statistics every I<Seconds> seconds.
4062 =head3 The SnapVault block
4064 This will collect statistics about the time and traffic of SnapVault(R)
4069 =item B<Interval> I<Seconds>
4071 Collect SnapVault(R) statistics every I<Seconds> seconds.
4075 =head2 Plugin C<netlink>
4077 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4078 statistics of various interface and routing aspects.
4082 =item B<Interface> I<Interface>
4084 =item B<VerboseInterface> I<Interface>
4086 Instruct the plugin to collect interface statistics. This is basically the same
4087 as the statistics provided by the C<interface> plugin (see above) but
4088 potentially much more detailed.
4090 When configuring with B<Interface> only the basic statistics will be collected,
4091 namely octets, packets, and errors. These statistics are collected by
4092 the C<interface> plugin, too, so using both at the same time is no benefit.
4094 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4095 so that no data needs to be collected twice if you use the C<interface> plugin.
4096 This includes dropped packets, received multicast packets, collisions and a
4097 whole zoo of differentiated RX and TX errors. You can try the following command
4098 to get an idea of what awaits you:
4102 If I<Interface> is B<All>, all interfaces will be selected.
4104 =item B<QDisc> I<Interface> [I<QDisc>]
4106 =item B<Class> I<Interface> [I<Class>]
4108 =item B<Filter> I<Interface> [I<Filter>]
4110 Collect the octets and packets that pass a certain qdisc, class or filter.
4112 QDiscs and classes are identified by their type and handle (or classid).
4113 Filters don't necessarily have a handle, therefore the parent's handle is used.
4114 The notation used in collectd differs from that used in tc(1) in that it
4115 doesn't skip the major or minor number if it's zero and doesn't print special
4116 ids by their name. So, for example, a qdisc may be identified by
4117 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4118 thus not displayed by tc(1).
4120 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4121 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4122 associated with that interface will be collected.
4124 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4125 used. This may lead to problems when more than one filter is attached to a
4126 qdisc or class. This isn't nice, but we don't know how this could be done any
4127 better. If you have a idea, please don't hesitate to tell us.
4129 As with the B<Interface> option you can specify B<All> as the interface,
4130 meaning all interfaces.
4132 Here are some examples to help you understand the above text more easily:
4135 VerboseInterface "All"
4136 QDisc "eth0" "pfifo_fast-1:0"
4138 Class "ppp0" "htb-1:10"
4139 Filter "ppp0" "u32-1:0"
4142 =item B<IgnoreSelected>
4144 The behavior is the same as with all other similar plugins: If nothing is
4145 selected at all, everything is collected. If some things are selected using the
4146 options described above, only these statistics are collected. If you set
4147 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4148 specified statistics will not be collected.
4152 =head2 Plugin C<network>
4154 The Network plugin sends data to a remote instance of collectd, receives data
4155 from a remote instance, or both at the same time. Data which has been received
4156 from the network is usually not transmitted again, but this can be activated, see
4157 the B<Forward> option below.
4159 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4160 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4162 Both, B<Server> and B<Listen> can be used as single option or as block. When
4163 used as block, given options are valid for this socket only. The following
4164 example will export the metrics twice: Once to an "internal" server (without
4165 encryption and signing) and one to an external server (with cryptographic
4169 # Export to an internal server
4170 # (demonstrates usage without additional options)
4171 Server "collectd.internal.tld"
4173 # Export to an external server
4174 # (demonstrates usage with signature options)
4175 <Server "collectd.external.tld">
4176 SecurityLevel "sign"
4177 Username "myhostname"
4184 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4186 The B<Server> statement/block sets the server to send datagrams to. The
4187 statement may occur multiple times to send each datagram to multiple
4190 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4191 optional second argument specifies a port number or a service name. If not
4192 given, the default, B<25826>, is used.
4194 The following options are recognized within B<Server> blocks:
4198 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4200 Set the security you require for network communication. When the security level
4201 has been set to B<Encrypt>, data sent over the network will be encrypted using
4202 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4203 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4204 authentication code. When set to B<None>, data is sent without any security.
4206 This feature is only available if the I<network> plugin was linked with
4209 =item B<Username> I<Username>
4211 Sets the username to transmit. This is used by the server to lookup the
4212 password. See B<AuthFile> below. All security levels except B<None> require
4215 This feature is only available if the I<network> plugin was linked with
4218 =item B<Password> I<Password>
4220 Sets a password (shared secret) for this socket. All security levels except
4221 B<None> require this setting.
4223 This feature is only available if the I<network> plugin was linked with
4226 =item B<Interface> I<Interface name>
4228 Set the outgoing interface for IP packets. This applies at least
4229 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4230 undefined or a non-existent interface name is specified, the default
4231 behavior is to let the kernel choose the appropriate interface. Be warned
4232 that the manual selection of an interface for unicast traffic is only
4233 necessary in rare cases.
4235 =item B<ResolveInterval> I<Seconds>
4237 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4238 useful to force a regular DNS lookup to support a high availability setup. If
4239 not specified, re-resolves are never attempted.
4243 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4245 The B<Listen> statement sets the interfaces to bind to. When multiple
4246 statements are found the daemon will bind to multiple interfaces.
4248 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4249 the argument is a multicast address the daemon will join that multicast group.
4250 The optional second argument specifies a port number or a service name. If not
4251 given, the default, B<25826>, is used.
4253 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4257 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4259 Set the security you require for network communication. When the security level
4260 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4261 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4262 signed and encrypted data is accepted. When set to B<None>, all data will be
4263 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4264 decrypted if possible.
4266 This feature is only available if the I<network> plugin was linked with
4269 =item B<AuthFile> I<Filename>
4271 Sets a file in which usernames are mapped to passwords. These passwords are
4272 used to verify signatures and to decrypt encrypted network packets. If
4273 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4274 verified and encrypted packets are decrypted. Otherwise, signed data is
4275 accepted without checking the signature and encrypted data cannot be decrypted.
4276 For the other security levels this option is mandatory.
4278 The file format is very simple: Each line consists of a username followed by a
4279 colon and any number of spaces followed by the password. To demonstrate, an
4280 example file could look like this:
4285 Each time a packet is received, the modification time of the file is checked
4286 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4287 the file is being read, it is locked using L<fcntl(2)>.
4289 =item B<Interface> I<Interface name>
4291 Set the incoming interface for IP packets explicitly. This applies at least
4292 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4293 undefined or a non-existent interface name is specified, the default
4294 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4295 traffic gets only accepted, if it arrives on the given interface.
4299 =item B<TimeToLive> I<1-255>
4301 Set the time-to-live of sent packets. This applies to all, unicast and
4302 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4303 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4306 =item B<MaxPacketSize> I<1024-65535>
4308 Set the maximum size for datagrams received over the network. Packets larger
4309 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4310 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4313 On the server side, this limit should be set to the largest value used on
4314 I<any> client. Likewise, the value on the client must not be larger than the
4315 value on the server, or data will be lost.
4317 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4318 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4319 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4322 =item B<Forward> I<true|false>
4324 If set to I<true>, write packets that were received via the network plugin to
4325 the sending sockets. This should only be activated when the B<Listen>- and
4326 B<Server>-statements differ. Otherwise packets may be send multiple times to
4327 the same multicast group. While this results in more network traffic than
4328 necessary it's not a huge problem since the plugin has a duplicate detection,
4329 so the values will not loop.
4331 =item B<ReportStats> B<true>|B<false>
4333 The network plugin cannot only receive and send statistics, it can also create
4334 statistics about itself. Collected data included the number of received and
4335 sent octets and packets, the length of the receive queue and the number of
4336 values handled. When set to B<true>, the I<Network plugin> will make these
4337 statistics available. Defaults to B<false>.
4341 =head2 Plugin C<nginx>
4343 This plugin collects the number of connections and requests handled by the
4344 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4345 queries the page provided by the C<ngx_http_stub_status_module> module, which
4346 isn't compiled by default. Please refer to
4347 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4348 how to compile and configure nginx and this module.
4350 The following options are accepted by the C<nginx plugin>:
4354 =item B<URL> I<http://host/nginx_status>
4356 Sets the URL of the C<ngx_http_stub_status_module> output.
4358 =item B<User> I<Username>
4360 Optional user name needed for authentication.
4362 =item B<Password> I<Password>
4364 Optional password needed for authentication.
4366 =item B<VerifyPeer> B<true|false>
4368 Enable or disable peer SSL certificate verification. See
4369 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4371 =item B<VerifyHost> B<true|false>
4373 Enable or disable peer host name verification. If enabled, the plugin checks
4374 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4375 certificate matches the host name provided by the B<URL> option. If this
4376 identity check fails, the connection is aborted. Obviously, only works when
4377 connecting to a SSL enabled server. Enabled by default.
4379 =item B<CACert> I<File>
4381 File that holds one or more SSL certificates. If you want to use HTTPS you will
4382 possibly need this option. What CA certificates come bundled with C<libcurl>
4383 and are checked by default depends on the distribution you use.
4385 =item B<Timeout> I<Milliseconds>
4387 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4388 milliseconds. By default, the configured B<Interval> is used to set the
4393 =head2 Plugin C<notify_desktop>
4395 This plugin sends a desktop notification to a notification daemon, as defined
4396 in the Desktop Notification Specification. To actually display the
4397 notifications, B<notification-daemon> is required and B<collectd> has to be
4398 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4399 environment variables have to be set correctly) and the D-Bus message bus.
4401 The Desktop Notification Specification can be found at
4402 L<http://www.galago-project.org/specs/notification/>.
4406 =item B<OkayTimeout> I<timeout>
4408 =item B<WarningTimeout> I<timeout>
4410 =item B<FailureTimeout> I<timeout>
4412 Set the I<timeout>, in milliseconds, after which to expire the notification
4413 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4414 been specified, the displayed notification will not be closed at all - the
4415 user has to do so herself. These options default to 5000. If a negative number
4416 has been specified, the default is used as well.
4420 =head2 Plugin C<notify_email>
4422 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4423 configured email address.
4425 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4427 Available configuration options:
4431 =item B<From> I<Address>
4433 Email address from which the emails should appear to come from.
4435 Default: C<root@localhost>
4437 =item B<Recipient> I<Address>
4439 Configures the email address(es) to which the notifications should be mailed.
4440 May be repeated to send notifications to multiple addresses.
4442 At least one B<Recipient> must be present for the plugin to work correctly.
4444 =item B<SMTPServer> I<Hostname>
4446 Hostname of the SMTP server to connect to.
4448 Default: C<localhost>
4450 =item B<SMTPPort> I<Port>
4452 TCP port to connect to.
4456 =item B<SMTPUser> I<Username>
4458 Username for ASMTP authentication. Optional.
4460 =item B<SMTPPassword> I<Password>
4462 Password for ASMTP authentication. Optional.
4464 =item B<Subject> I<Subject>
4466 Subject-template to use when sending emails. There must be exactly two
4467 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4468 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4471 Default: C<Collectd notify: %s@%s>
4475 =head2 Plugin C<ntpd>
4479 =item B<Host> I<Hostname>
4481 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4483 =item B<Port> I<Port>
4485 UDP-Port to connect to. Defaults to B<123>.
4487 =item B<ReverseLookups> B<true>|B<false>
4489 Sets whether or not to perform reverse lookups on peers. Since the name or
4490 IP-address may be used in a filename it is recommended to disable reverse
4491 lookups. The default is to do reverse lookups to preserve backwards
4492 compatibility, though.
4494 =item B<IncludeUnitID> B<true>|B<false>
4496 When a peer is a refclock, include the unit ID in the I<type instance>.
4497 Defaults to B<false> for backward compatibility.
4499 If two refclock peers use the same driver and this is B<false>, the plugin will
4500 try to write simultaneous measurements from both to the same type instance.
4501 This will result in error messages in the log and only one set of measurements
4506 =head2 Plugin C<nut>
4510 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4512 Add a UPS to collect data from. The format is identical to the one accepted by
4517 =head2 Plugin C<olsrd>
4519 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4520 the Optimized Link State Routing daemon and reads information about the current
4521 state of the meshed network.
4523 The following configuration options are understood:
4527 =item B<Host> I<Host>
4529 Connect to I<Host>. Defaults to B<"localhost">.
4531 =item B<Port> I<Port>
4533 Specifies the port to connect to. This must be a string, even if you give the
4534 port as a number rather than a service name. Defaults to B<"2006">.
4536 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4538 Specifies what information to collect about links, i.E<nbsp>e. direct
4539 connections of the daemon queried. If set to B<No>, no information is
4540 collected. If set to B<Summary>, the number of links and the average of all
4541 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4542 If set to B<Detail> LQ and NLQ are collected per link.
4544 Defaults to B<Detail>.
4546 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4548 Specifies what information to collect about routes of the daemon queried. If
4549 set to B<No>, no information is collected. If set to B<Summary>, the number of
4550 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4551 metric and ETX are collected per route.
4553 Defaults to B<Summary>.
4555 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4557 Specifies what information to collect about the global topology. If set to
4558 B<No>, no information is collected. If set to B<Summary>, the number of links
4559 in the entire topology and the average I<link quality> (LQ) is calculated.
4560 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4562 Defaults to B<Summary>.
4566 =head2 Plugin C<onewire>
4568 B<EXPERIMENTAL!> See notes below.
4570 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4571 L<http://owfs.org/> to read sensors connected via the onewire bus.
4573 It can be used in two possible modes - standard or advanced.
4575 In the standard mode only temperature sensors (sensors with the family code
4576 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4577 other sensors you would like to have included, please send a sort request to
4578 the mailing list. You can select sensors to be read or to be ignored depending
4579 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4580 walked and all sensors are read.
4582 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4583 experimental, below.
4585 In the advanced mode you can configure any sensor to be read (only numerical
4586 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4587 In this mode you have to list all the sensors. Neither default bus walk nor
4588 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4589 the path automatically and should produce compatible structure with the "standard"
4590 mode (basically the path is expected as for example
4591 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4592 "F10FCA000800" and the rest after the slash is considered the type - here
4594 There are two advantages to this mode - you can access virtually any sensor
4595 (not just temperature), select whether to use cached or directly read values
4596 and it is slighlty faster. The downside is more complex configuration.
4598 The two modes are distinguished automatically by the format of the address.
4599 It is not possible to mix the two modes. Once a full path is detected in any
4600 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4601 (and as standard addresses will fail parsing they will be ignored).
4605 =item B<Device> I<Device>
4607 Sets the device to read the values from. This can either be a "real" hardware
4608 device, such as a serial port or an USB port, or the address of the
4609 L<owserver(1)> socket, usually B<localhost:4304>.
4611 Though the documentation claims to automatically recognize the given address
4612 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4613 with that version, the following configuration worked for us:
4616 Device "-s localhost:4304"
4619 This directive is B<required> and does not have a default value.
4621 =item B<Sensor> I<Sensor>
4623 In the standard mode selects sensors to collect or to ignore
4624 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4625 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4626 and B<not> include the leading C<10.> family byte and point.
4627 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4628 sensors (see above) are read.
4630 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4631 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4632 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4634 As there can be multiple devices on the bus you can list multiple sensor (use
4635 multiple B<Sensor> elements).
4637 =item B<IgnoreSelected> I<true>|I<false>
4639 If no configuration is given, the B<onewire> plugin will collect data from all
4640 sensors found. This may not be practical, especially if sensors are added and
4641 removed regularly. Sometimes, however, it's easier/preferred to collect only
4642 specific sensors or all sensors I<except> a few specified ones. This option
4643 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4644 B<Sensor> is inverted: All selected interfaces are ignored and all other
4645 interfaces are collected.
4647 Used only in the standard mode - see above.
4649 =item B<Interval> I<Seconds>
4651 Sets the interval in which all sensors should be read. If not specified, the
4652 global B<Interval> setting is used.
4656 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4657 work with big setups. It works with one sensor being attached to one
4658 controller, but as soon as you throw in a couple more senors and maybe a hub
4659 or two, reading all values will take more than ten seconds (the default
4660 interval). We will probably add some separate thread for reading the sensors
4661 and some cache or something like that, but it's not done yet. We will try to
4662 maintain backwards compatibility in the future, but we can't promise. So in
4663 short: If it works for you: Great! But keep in mind that the config I<might>
4664 change, though this is unlikely. Oh, and if you want to help improving this
4665 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4667 =head2 Plugin C<openldap>
4669 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4670 server correctly. The backend database C<monitor> needs to be loaded and
4671 working. See slapd-monitor(5) for the details.
4673 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4674 blocks. Each block requires one string argument as the instance name. For
4679 URL "ldap://localhost/"
4682 URL "ldaps://localhost/"
4686 The instance name will be used as the I<plugin instance>. To emulate the old
4687 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4688 plugin to work correctly, each instance name must be unique. This is not
4689 enforced by the plugin and it is your responsibility to ensure it is.
4691 The following options are accepted within each B<Instance> block:
4695 =item B<URL> I<ldap://host/binddn>
4697 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4700 =item B<BindDN> I<BindDN>
4702 Name in the form of an LDAP distinguished name intended to be used for
4703 authentication. Defaults to empty string to establish an anonymous authorization.
4705 =item B<Password> I<Password>
4707 Password for simple bind authentication. If this option is not set,
4708 unauthenticated bind operation is used.
4710 =item B<StartTLS> B<true|false>
4712 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4713 Disabled by default.
4715 =item B<VerifyHost> B<true|false>
4717 Enables or disables peer host name verification. If enabled, the plugin checks
4718 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4719 certificate matches the host name provided by the B<URL> option. If this
4720 identity check fails, the connection is aborted. Enabled by default.
4722 =item B<CACert> I<File>
4724 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4725 may possibly need this option. What CA certificates are checked by default
4726 depends on the distribution you use and can be changed with the usual ldap
4727 client configuration mechanisms. See ldap.conf(5) for the details.
4729 =item B<Timeout> I<Seconds>
4731 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4732 an infinite timeout.
4734 =item B<Version> I<Version>
4736 An integer which sets the LDAP protocol version number to use when connecting
4737 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4741 =head2 Plugin C<openvpn>
4743 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4744 traffic statistics about connected clients.
4746 To set up OpenVPN to write to the status file periodically, use the
4747 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4748 you need to set the required format, too. This is done by setting
4749 B<--status-version> to B<2>.
4751 So, in a nutshell you need:
4753 openvpn $OTHER_OPTIONS \
4754 --status "/var/run/openvpn-status" 10 \
4761 =item B<StatusFile> I<File>
4763 Specifies the location of the status file.
4765 =item B<ImprovedNamingSchema> B<true>|B<false>
4767 When enabled, the filename of the status file will be used as plugin instance
4768 and the client's "common name" will be used as type instance. This is required
4769 when reading multiple status files. Enabling this option is recommended, but to
4770 maintain backwards compatibility this option is disabled by default.
4772 =item B<CollectCompression> B<true>|B<false>
4774 Sets whether or not statistics about the compression used by OpenVPN should be
4775 collected. This information is only available in I<single> mode. Enabled by
4778 =item B<CollectIndividualUsers> B<true>|B<false>
4780 Sets whether or not traffic information is collected for each connected client
4781 individually. If set to false, currently no traffic data is collected at all
4782 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4784 =item B<CollectUserCount> B<true>|B<false>
4786 When enabled, the number of currently connected clients or users is collected.
4787 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4788 can be configured independently from that option. Defaults to B<false>.
4792 =head2 Plugin C<oracle>
4794 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4795 Oracle® Database and lets you execute SQL statements there. It is very similar
4796 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4797 plugin's documentation above for details.
4800 <Query "out_of_stock">
4801 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4804 # InstancePrefix "foo"
4805 InstancesFrom "category"
4809 <Database "product_information">
4813 Query "out_of_stock"
4817 =head3 B<Query> blocks
4819 The Query blocks are handled identically to the Query blocks of the "dbi"
4820 plugin. Please see its documentation above for details on how to specify
4823 =head3 B<Database> blocks
4825 Database blocks define a connection to a database and which queries should be
4826 sent to that database. Each database needs a "name" as string argument in the
4827 starting tag of the block. This name will be used as "PluginInstance" in the
4828 values submitted to the daemon. Other than that, that name is not used.
4832 =item B<ConnectID> I<ID>
4834 Defines the "database alias" or "service name" to connect to. Usually, these
4835 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4837 =item B<Host> I<Host>
4839 Hostname to use when dispatching values for this database. Defaults to using
4840 the global hostname of the I<collectd> instance.
4842 =item B<Username> I<Username>
4844 Username used for authentication.
4846 =item B<Password> I<Password>
4848 Password used for authentication.
4850 =item B<Query> I<QueryName>
4852 Associates the query named I<QueryName> with this database connection. The
4853 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4854 blocks you want to refer to must be placed above the database block you want to
4859 =head2 Plugin C<perl>
4861 This plugin embeds a Perl-interpreter into collectd and provides an interface
4862 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4864 =head2 Plugin C<pinba>
4866 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4867 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4868 PHP-based webpage has been delivered, the extension will send a UDP packet
4869 containing timing information, peak memory usage and so on. The plugin will
4870 wait for such packets, parse them and account the provided information, which
4871 is then dispatched to the daemon once per interval.
4878 # Overall statistics for the website.
4880 Server "www.example.com"
4882 # Statistics for www-a only
4884 Host "www-a.example.com"
4885 Server "www.example.com"
4887 # Statistics for www-b only
4889 Host "www-b.example.com"
4890 Server "www.example.com"
4894 The plugin provides the following configuration options:
4898 =item B<Address> I<Node>
4900 Configures the address used to open a listening socket. By default, plugin will
4901 bind to the I<any> address C<::0>.
4903 =item B<Port> I<Service>
4905 Configures the port (service) to bind to. By default the default Pinba port
4906 "30002" will be used. The option accepts service names in addition to port
4907 numbers and thus requires a I<string> argument.
4909 =item E<lt>B<View> I<Name>E<gt> block
4911 The packets sent by the Pinba extension include the hostname of the server, the
4912 server name (the name of the virtual host) and the script that was executed.
4913 Using B<View> blocks it is possible to separate the data into multiple groups
4914 to get more meaningful statistics. Each packet is added to all matching groups,
4915 so that a packet may be accounted for more than once.
4919 =item B<Host> I<Host>
4921 Matches the hostname of the system the webserver / script is running on. This
4922 will contain the result of the L<gethostname(2)> system call. If not
4923 configured, all hostnames will be accepted.
4925 =item B<Server> I<Server>
4927 Matches the name of the I<virtual host>, i.e. the contents of the
4928 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4929 server names will be accepted.
4931 =item B<Script> I<Script>
4933 Matches the name of the I<script name>, i.e. the contents of the
4934 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4935 script names will be accepted.
4941 =head2 Plugin C<ping>
4943 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4944 configured hosts periodically and measures the network latency. Whenever the
4945 C<read> function of the plugin is called, it submits the average latency, the
4946 standard deviation and the drop rate for each host.
4948 Available configuration options:
4952 =item B<Host> I<IP-address>
4954 Host to ping periodically. This option may be repeated several times to ping
4957 =item B<Interval> I<Seconds>
4959 Sets the interval in which to send ICMP echo packets to the configured hosts.
4960 This is B<not> the interval in which statistics are queries from the plugin but
4961 the interval in which the hosts are "pinged". Therefore, the setting here
4962 should be smaller than or equal to the global B<Interval> setting. Fractional
4963 times, such as "1.24" are allowed.
4967 =item B<Timeout> I<Seconds>
4969 Time to wait for a response from the host to which an ICMP packet had been
4970 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4971 to be down or the packet to be dropped. This setting must be smaller than the
4972 B<Interval> setting above for the plugin to work correctly. Fractional
4973 arguments are accepted.
4977 =item B<TTL> I<0-255>
4979 Sets the Time-To-Live of generated ICMP packets.
4981 =item B<SourceAddress> I<host>
4983 Sets the source address to use. I<host> may either be a numerical network
4984 address or a network hostname.
4986 =item B<Device> I<name>
4988 Sets the outgoing network device to be used. I<name> has to specify an
4989 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4992 =item B<MaxMissed> I<Packets>
4994 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4995 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4997 Default: B<-1> (disabled)
5001 =head2 Plugin C<postgresql>
5003 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
5004 keeps a persistent connection to all configured databases and tries to
5005 reconnect if the connection has been interrupted. A database is configured by
5006 specifying a B<Database> block as described below. The default statistics are
5007 collected from PostgreSQL's B<statistics collector> which thus has to be
5008 enabled for this plugin to work correctly. This should usually be the case by
5009 default. See the section "The Statistics Collector" of the B<PostgreSQL
5010 Documentation> for details.
5012 By specifying custom database queries using a B<Query> block as described
5013 below, you may collect any data that is available from some PostgreSQL
5014 database. This way, you are able to access statistics of external daemons
5015 which are available in a PostgreSQL database or use future or special
5016 statistics provided by PostgreSQL without the need to upgrade your collectd
5019 Starting with version 5.2, the C<postgresql> plugin supports writing data to
5020 PostgreSQL databases as well. This has been implemented in a generic way. You
5021 need to specify an SQL statement which will then be executed by collectd in
5022 order to write the data (see below for details). The benefit of that approach
5023 is that there is no fixed database layout. Rather, the layout may be optimized
5024 for the current setup.
5026 The B<PostgreSQL Documentation> manual can be found at
5027 L<http://www.postgresql.org/docs/manuals/>.
5031 Statement "SELECT magic FROM wizard WHERE host = $1;"
5035 InstancePrefix "magic"
5040 <Query rt36_tickets>
5041 Statement "SELECT COUNT(type) AS count, type \
5043 WHEN resolved = 'epoch' THEN 'open' \
5044 ELSE 'resolved' END AS type \
5045 FROM tickets) type \
5049 InstancePrefix "rt36_tickets"
5050 InstancesFrom "type"
5056 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
5066 KRBSrvName "kerberos_service_name"
5072 Service "service_name"
5073 Query backend # predefined
5084 The B<Query> block defines one database query which may later be used by a
5085 database definition. It accepts a single mandatory argument which specifies
5086 the name of the query. The names of all queries have to be unique (see the
5087 B<MinVersion> and B<MaxVersion> options below for an exception to this
5088 rule). The following configuration options are available to define the query:
5090 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
5091 blocks define how to handle the values returned from the query. They define
5092 which column holds which value and how to dispatch that value to the daemon.
5093 Multiple B<Result> blocks may be used to extract multiple values from a single
5098 =item B<Statement> I<sql query statement>
5100 Specify the I<sql query statement> which the plugin should execute. The string
5101 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
5102 first, second, etc. parameter. The value of the parameters is specified by the
5103 B<Param> configuration option - see below for details. To include a literal
5104 B<$> character followed by a number, surround it with single quotes (B<'>).
5106 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
5107 allowed. Note, however, that only a single command may be used. Semicolons are
5108 allowed as long as a single non-empty command has been specified only.
5110 The returned lines will be handled separately one after another.
5112 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
5114 Specify the parameters which should be passed to the SQL query. The parameters
5115 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
5116 they appear in the configuration file. The value of the parameter is
5117 determined depending on the value of the B<Param> option as follows:
5123 The configured hostname of the database connection. If a UNIX domain socket is
5124 used, the parameter expands to "localhost".
5128 The name of the database of the current connection.
5132 The name of the database plugin instance. See the B<Instance> option of the
5133 database specification below for details.
5137 The username used to connect to the database.
5141 The interval with which this database is queried (as specified by the database
5142 specific or global B<Interval> options).
5146 Please note that parameters are only supported by PostgreSQL's protocol
5147 version 3 and above which was introduced in version 7.4 of PostgreSQL.
5149 =item B<Type> I<type>
5151 The I<type> name to be used when dispatching the values. The type describes
5152 how to handle the data and where to store it. See L<types.db(5)> for more
5153 details on types and their configuration. The number and type of values (as
5154 selected by the B<ValuesFrom> option) has to match the type of the given name.
5156 This option is required inside a B<Result> block.
5158 =item B<InstancePrefix> I<prefix>
5160 =item B<InstancesFrom> I<column0> [I<column1> ...]
5162 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
5163 B<InstancePrefix> defines a static prefix that will be prepended to all type
5164 instances. B<InstancesFrom> defines the column names whose values will be used
5165 to create the type instance. Multiple values will be joined together using the
5166 hyphen (C<->) as separation character.
5168 The plugin itself does not check whether or not all built instances are
5169 different. It is your responsibility to assure that each is unique.
5171 Both options are optional. If none is specified, the type instance will be
5174 =item B<ValuesFrom> I<column0> [I<column1> ...]
5176 Names the columns whose content is used as the actual data for the data sets
5177 that are dispatched to the daemon. How many such columns you need is
5178 determined by the B<Type> setting as explained above. If you specify too many
5179 or not enough columns, the plugin will complain about that and no data will be
5180 submitted to the daemon.
5182 The actual data type, as seen by PostgreSQL, is not that important as long as
5183 it represents numbers. The plugin will automatically cast the values to the
5184 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
5185 L<strtod(3)> functions, so anything supported by those functions is supported
5186 by the plugin as well.
5188 This option is required inside a B<Result> block and may be specified multiple
5189 times. If multiple B<ValuesFrom> options are specified, the columns are read
5192 =item B<MinVersion> I<version>
5194 =item B<MaxVersion> I<version>
5196 Specify the minimum or maximum version of PostgreSQL that this query should be
5197 used with. Some statistics might only be available with certain versions of
5198 PostgreSQL. This allows you to specify multiple queries with the same name but
5199 which apply to different versions, thus allowing you to use the same
5200 configuration in a heterogeneous environment.
5202 The I<version> has to be specified as the concatenation of the major, minor
5203 and patch-level versions, each represented as two-decimal-digit numbers. For
5204 example, version 8.2.3 will become 80203.
5208 The following predefined queries are available (the definitions can be found
5209 in the F<postgresql_default.conf> file which, by default, is available at
5210 C<I<prefix>/share/collectd/>):
5216 This query collects the number of backends, i.E<nbsp>e. the number of
5219 =item B<transactions>
5221 This query collects the numbers of committed and rolled-back transactions of
5226 This query collects the numbers of various table modifications (i.E<nbsp>e.
5227 insertions, updates, deletions) of the user tables.
5229 =item B<query_plans>
5231 This query collects the numbers of various table scans and returned tuples of
5234 =item B<table_states>
5236 This query collects the numbers of live and dead rows in the user tables.
5240 This query collects disk block access counts for user tables.
5244 This query collects the on-disk size of the database in bytes.
5248 In addition, the following detailed queries are available by default. Please
5249 note that each of those queries collects information B<by table>, thus,
5250 potentially producing B<a lot> of data. For details see the description of the
5251 non-by_table queries above.
5255 =item B<queries_by_table>
5257 =item B<query_plans_by_table>
5259 =item B<table_states_by_table>
5261 =item B<disk_io_by_table>
5265 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5266 mandatory argument specifying the name of the writer. This will then be used
5267 in the B<Database> specification in order to activate the writer instance. The
5268 names of all writers have to be unique. The following options may be
5273 =item B<Statement> I<sql statement>
5275 This mandatory option specifies the SQL statement that will be executed for
5276 each submitted value. A single SQL statement is allowed only. Anything after
5277 the first semicolon will be ignored.
5279 Nine parameters will be passed to the statement and should be specified as
5280 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5281 values are made available through those parameters:
5287 The timestamp of the queried value as a floating point number.
5291 The hostname of the queried value.
5295 The plugin name of the queried value.
5299 The plugin instance of the queried value. This value may be B<NULL> if there
5300 is no plugin instance.
5304 The type of the queried value (cf. L<types.db(5)>).
5308 The type instance of the queried value. This value may be B<NULL> if there is
5313 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5314 sources of the submitted value-list).
5318 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5319 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5320 B<StoreRates> is enabled (which is the default, see below), all types will be
5325 An array of the submitted values. The dimensions of the value name and value
5330 In general, it is advisable to create and call a custom function in the
5331 PostgreSQL database for this purpose. Any procedural language supported by
5332 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5335 =item B<StoreRates> B<false>|B<true>
5337 If set to B<true> (the default), convert counter values to rates. If set to
5338 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5343 The B<Database> block defines one PostgreSQL database for which to collect
5344 statistics. It accepts a single mandatory argument which specifies the
5345 database name. None of the other options are required. PostgreSQL will use
5346 default values as documented in the section "CONNECTING TO A DATABASE" in the
5347 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5348 the user collectd is run as and special environment variables. See the manpage
5353 =item B<Interval> I<seconds>
5355 Specify the interval with which the database should be queried. The default is
5356 to use the global B<Interval> setting.
5358 =item B<CommitInterval> I<seconds>
5360 This option may be used for database connections which have "writers" assigned
5361 (see above). If specified, it causes a writer to put several updates into a
5362 single transaction. This transaction will last for the specified amount of
5363 time. By default, each update will be executed in a separate transaction. Each
5364 transaction generates a fair amount of overhead which can, thus, be reduced by
5365 activating this option. The draw-back is, that data covering the specified
5366 amount of time will be lost, for example, if a single statement within the
5367 transaction fails or if the database server crashes.
5369 =item B<Instance> I<name>
5371 Specify the plugin instance name that should be used instead of the database
5372 name (which is the default, if this option has not been specified). This
5373 allows to query multiple databases of the same name on the same host (e.g.
5374 when running multiple database server versions in parallel).
5376 =item B<Host> I<hostname>
5378 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5379 value begins with a slash, it is interpreted as the directory name in which to
5380 look for the UNIX domain socket.
5382 This option is also used to determine the hostname that is associated with a
5383 collected data set. If it has been omitted or either begins with with a slash
5384 or equals B<localhost> it will be replaced with the global hostname definition
5385 of collectd. Any other value will be passed literally to collectd when
5386 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5388 =item B<Port> I<port>
5390 Specify the TCP port or the local UNIX domain socket file extension of the
5393 =item B<User> I<username>
5395 Specify the username to be used when connecting to the server.
5397 =item B<Password> I<password>
5399 Specify the password to be used when connecting to the server.
5401 =item B<ExpireDelay> I<delay>
5403 Skip expired values in query output.
5405 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5407 Specify whether to use an SSL connection when contacting the server. The
5408 following modes are supported:
5414 Do not use SSL at all.
5418 First, try to connect without using SSL. If that fails, try using SSL.
5420 =item I<prefer> (default)
5422 First, try to connect using SSL. If that fails, try without using SSL.
5430 =item B<Instance> I<name>
5432 Specify the plugin instance name that should be used instead of the database
5433 name (which is the default, if this option has not been specified). This
5434 allows to query multiple databases of the same name on the same host (e.g.
5435 when running multiple database server versions in parallel).
5437 =item B<KRBSrvName> I<kerberos_service_name>
5439 Specify the Kerberos service name to use when authenticating with Kerberos 5
5440 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5441 B<PostgreSQL Documentation> for details.
5443 =item B<Service> I<service_name>
5445 Specify the PostgreSQL service name to use for additional parameters. That
5446 service has to be defined in F<pg_service.conf> and holds additional
5447 connection parameters. See the section "The Connection Service File" in the
5448 B<PostgreSQL Documentation> for details.
5450 =item B<Query> I<query>
5452 Specifies a I<query> which should be executed in the context of the database
5453 connection. This may be any of the predefined or user-defined queries. If no
5454 such option is given, it defaults to "backends", "transactions", "queries",
5455 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5456 has been specified). Else, the specified queries are used only.
5458 =item B<Writer> I<writer>
5460 Assigns the specified I<writer> backend to the database connection. This
5461 causes all collected data to be send to the database using the settings
5462 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5463 below for details on how to selectively send data to certain plugins).
5465 Each writer will register a flush callback which may be used when having long
5466 transactions enabled (see the B<CommitInterval> option above). When issuing
5467 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5468 transaction will be committed right away. Two different kinds of flush
5469 callbacks are available with the C<postgresql> plugin:
5475 Flush all writer backends.
5477 =item B<postgresql->I<database>
5479 Flush all writers of the specified I<database> only.
5485 =head2 Plugin C<powerdns>
5487 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5488 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5489 values, many of which are probably meaningless to most users, but may be useful
5490 for some. So you may chose which values to collect, but if you don't, some
5491 reasonable defaults will be collected.
5494 <Server "server_name">
5496 Collect "udp-answers" "udp-queries"
5497 Socket "/var/run/pdns.controlsocket"
5499 <Recursor "recursor_name">
5501 Collect "cache-hits" "cache-misses"
5502 Socket "/var/run/pdns_recursor.controlsocket"
5504 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5509 =item B<Server> and B<Recursor> block
5511 The B<Server> block defines one authoritative server to query, the B<Recursor>
5512 does the same for an recursing server. The possible options in both blocks are
5513 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5518 =item B<Collect> I<Field>
5520 Using the B<Collect> statement you can select which values to collect. Here,
5521 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5522 C<dlg-only-drops>, C<answers10-100>.
5524 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5525 When querying the server a C<SHOW *> command is issued in any case, because
5526 that's the only way of getting multiple values out of the server at once.
5527 collectd then picks out the values you have selected. When querying the
5528 recursor, a command is generated to query exactly these values. So if you
5529 specify invalid fields when querying the recursor, a syntax error may be
5530 returned by the daemon and collectd may not collect any values at all.
5532 If no B<Collect> statement is given, the following B<Server> values will be
5539 =item packetcache-hit
5541 =item packetcache-miss
5543 =item packetcache-size
5545 =item query-cache-hit
5547 =item query-cache-miss
5549 =item recursing-answers
5551 =item recursing-questions
5563 The following B<Recursor> values will be collected by default:
5567 =item noerror-answers
5569 =item nxdomain-answers
5571 =item servfail-answers
5589 Please note that up to that point collectd doesn't know what values are
5590 available on the server and values that are added do not need a change of the
5591 mechanism so far. However, the values must be mapped to collectd's naming
5592 scheme, which is done using a lookup table that lists all known values. If
5593 values are added in the future and collectd does not know about them, you will
5594 get an error much like this:
5596 powerdns plugin: submit: Not found in lookup table: foobar = 42
5598 In this case please file a bug report with the collectd team.
5600 =item B<Socket> I<Path>
5602 Configures the path to the UNIX domain socket to be used when connecting to the
5603 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5604 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5605 will be used for the recursor.
5609 =item B<LocalSocket> I<Path>
5611 Querying the recursor is done using UDP. When using UDP over UNIX domain
5612 sockets, the client socket needs a name in the file system, too. You can set
5613 this local name to I<Path> using the B<LocalSocket> option. The default is
5614 C<I<prefix>/var/run/collectd-powerdns>.
5618 =head2 Plugin C<processes>
5622 =item B<Process> I<Name>
5624 Select more detailed statistics of processes matching this name. The statistics
5625 collected for these selected processes are size of the resident segment size
5626 (RSS), user- and system-time used, number of processes and number of threads,
5627 io data (where available) and minor and major pagefaults.
5629 =item B<ProcessMatch> I<name> I<regex>
5631 Similar to the B<Process> option this allows to select more detailed
5632 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5633 details). The statistics of all matching processes are summed up and
5634 dispatched to the daemon using the specified I<name> as an identifier. This
5635 allows to "group" several processes together. I<name> must not contain
5638 =item B<CollectContextSwitch> I<Boolean>
5640 Collect context switch of the process.
5644 =head2 Plugin C<protocols>
5646 Collects a lot of information about various network protocols, such as I<IP>,
5647 I<TCP>, I<UDP>, etc.
5649 Available configuration options:
5653 =item B<Value> I<Selector>
5655 Selects whether or not to select a specific value. The string being matched is
5656 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5657 plugin instance and I<ValueName> will be used as type instance. An example of
5658 the string being used would be C<Tcp:RetransSegs>.
5660 You can use regular expressions to match a large number of values with just one
5661 configuration option. To select all "extended" I<TCP> values, you could use the
5662 following statement:
5666 Whether only matched values are selected or all matched values are ignored
5667 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5668 If no value is configured at all, all values will be selected.
5670 =item B<IgnoreSelected> B<true>|B<false>
5672 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5673 matching values will be ignored.
5677 =head2 Plugin C<python>
5679 This plugin embeds a Python-interpreter into collectd and provides an interface
5680 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5682 =head2 Plugin C<routeros>
5684 The C<routeros> plugin connects to a device running I<RouterOS>, the
5685 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5686 I<librouteros> to connect and reads information about the interfaces and
5687 wireless connections of the device. The configuration supports querying
5692 Host "router0.example.com"
5695 CollectInterface true
5700 Host "router1.example.com"
5703 CollectInterface true
5704 CollectRegistrationTable true
5710 As you can see above, the configuration of the I<routeros> plugin consists of
5711 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5712 options are understood:
5716 =item B<Host> I<Host>
5718 Hostname or IP-address of the router to connect to.
5720 =item B<Port> I<Port>
5722 Port name or port number used when connecting. If left unspecified, the default
5723 will be chosen by I<librouteros>, currently "8728". This option expects a
5724 string argument, even when a numeric port number is given.
5726 =item B<User> I<User>
5728 Use the user name I<User> to authenticate. Defaults to "admin".
5730 =item B<Password> I<Password>
5732 Set the password used to authenticate.
5734 =item B<CollectInterface> B<true>|B<false>
5736 When set to B<true>, interface statistics will be collected for all interfaces
5737 present on the device. Defaults to B<false>.
5739 =item B<CollectRegistrationTable> B<true>|B<false>
5741 When set to B<true>, information about wireless LAN connections will be
5742 collected. Defaults to B<false>.
5744 =item B<CollectCPULoad> B<true>|B<false>
5746 When set to B<true>, information about the CPU usage will be collected. The
5747 number is a dimensionless value where zero indicates no CPU usage at all.
5748 Defaults to B<false>.
5750 =item B<CollectMemory> B<true>|B<false>
5752 When enabled, the amount of used and free memory will be collected. How used
5753 memory is calculated is unknown, for example whether or not caches are counted
5755 Defaults to B<false>.
5757 =item B<CollectDF> B<true>|B<false>
5759 When enabled, the amount of used and free disk space will be collected.
5760 Defaults to B<false>.
5762 =item B<CollectDisk> B<true>|B<false>
5764 When enabled, the number of sectors written and bad blocks will be collected.
5765 Defaults to B<false>.
5769 =head2 Plugin C<redis>
5771 The I<Redis plugin> connects to one or more Redis servers and gathers
5772 information about each server's state. For each server there is a I<Node> block
5773 which configures the connection parameters for this node.
5780 <Query "LLEN myqueue">
5787 The information shown in the synopsis above is the I<default configuration>
5788 which is used by the plugin if no configuration is present.
5792 =item B<Node> I<Nodename>
5794 The B<Node> block identifies a new Redis node, that is a new Redis instance
5795 running in an specified host and port. The name for node is a canonical
5796 identifier which is used as I<plugin instance>. It is limited to
5797 64E<nbsp>characters in length.
5799 =item B<Host> I<Hostname>
5801 The B<Host> option is the hostname or IP-address where the Redis instance is
5804 =item B<Port> I<Port>
5806 The B<Port> option is the TCP port on which the Redis instance accepts
5807 connections. Either a service name of a port number may be given. Please note
5808 that numerical port numbers must be given as a string, too.
5810 =item B<Password> I<Password>
5812 Use I<Password> to authenticate when connecting to I<Redis>.
5814 =item B<Timeout> I<Milliseconds>
5816 The B<Timeout> option set the socket timeout for node response. Since the Redis
5817 read function is blocking, you should keep this value as low as possible. Keep
5818 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5819 than B<Interval> defined globally.
5821 =item B<Query> I<Querystring>
5823 The B<Query> block identifies a query to execute against the redis server.
5824 There may be an arbitrary number of queries to execute.
5826 =item B<Type> I<Collectd type>
5828 Within a query definition, a valid collectd type to use as when submitting
5829 the result of the query. When not supplied, will default to B<gauge>.
5831 =item B<Instance> I<Type instance>
5833 Within a query definition, an optional type instance to use when submitting
5834 the result of the query. When not supplied will default to the escaped
5835 command, up to 64 chars.
5839 =head2 Plugin C<rrdcached>
5841 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5842 to store values to RRD files in an efficient manner. The combination of the
5843 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5844 way the C<rrdtool> plugin works (see below). The added abstraction layer
5845 provides a number of benefits, though: Because the cache is not within
5846 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5847 restarted. This results in much shorter (if any) gaps in graphs, especially
5848 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5849 daemon so that it can flush values to disk automatically when needed. This
5850 allows to integrate automated flushing of values into graphing solutions much
5853 There are disadvantages, though: The daemon may reside on a different host, so
5854 it may not be possible for C<collectd> to create the appropriate RRD files
5855 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5856 different base directory, so relative paths may do weird stuff if you're not
5859 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5860 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5861 setting should be set to an absolute path, so that a changed base directory
5862 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5866 =item B<DaemonAddress> I<Address>
5868 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5869 library. See L<rrdcached(1)> for details. Example:
5871 <Plugin "rrdcached">
5872 DaemonAddress "unix:/var/run/rrdcached.sock"
5875 =item B<DataDir> I<Directory>
5877 Set the base directory in which the RRD files reside. If this is a relative
5878 path, it is relative to the working base directory of the C<rrdcached> daemon!
5879 Use of an absolute path is recommended.
5881 =item B<CreateFiles> B<true>|B<false>
5883 Enables or disables the creation of RRD files. If the daemon is not running
5884 locally, or B<DataDir> is set to a relative path, this will not work as
5885 expected. Default is B<true>.
5887 =item B<CreateFilesAsync> B<false>|B<true>
5889 When enabled, new RRD files are enabled asynchronously, using a separate thread
5890 that runs in the background. This prevents writes to block, which is a problem
5891 especially when many hundreds of files need to be created at once. However,
5892 since the purpose of creating the files asynchronously is I<not> to block until
5893 the file is available, values before the file is available will be discarded.
5894 When disabled (the default) files are created synchronously, blocking for a
5895 short while, while the file is being written.
5897 =item B<StepSize> I<Seconds>
5899 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5900 this setting is unset and the stepsize is set to the interval in which the data
5901 is collected. Do not use this option unless you absolutely have to for some
5902 reason. Setting this option may cause problems with the C<snmp plugin>, the
5903 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5905 =item B<HeartBeat> I<Seconds>
5907 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5908 in which case the heartbeat is set to twice the B<StepSize> which should equal
5909 the interval in which data is collected. Do not set this option unless you have
5910 a very good reason to do so.
5912 =item B<RRARows> I<NumRows>
5914 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5915 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5916 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5917 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5918 week, one month, and one year.
5920 So for each timespan, it calculates how many PDPs need to be consolidated into
5921 one CDP by calculating:
5922 number of PDPs = timespan / (stepsize * rrarows)
5924 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5927 =item B<RRATimespan> I<Seconds>
5929 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5930 more then one RRA. If this option is never used, the built-in default of (3600,
5931 86400, 604800, 2678400, 31622400) is used.
5933 For more information on how RRA-sizes are calculated see B<RRARows> above.
5935 =item B<XFF> I<Factor>
5937 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5938 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5941 =item B<CollectStatistics> B<false>|B<true>
5943 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5944 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5946 Statistics are read via I<rrdcached>s socket using the STATS command.
5947 See L<rrdcached(1)> for details.
5951 =head2 Plugin C<rrdtool>
5953 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5954 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5955 using these settings. If you don't want to dive into the depths of RRDtool, you
5956 can safely ignore these settings.
5960 =item B<DataDir> I<Directory>
5962 Set the directory to store RRD files under. By default RRD files are generated
5963 beneath the daemon's working directory, i.e. the B<BaseDir>.
5965 =item B<CreateFilesAsync> B<false>|B<true>
5967 When enabled, new RRD files are enabled asynchronously, using a separate thread
5968 that runs in the background. This prevents writes to block, which is a problem
5969 especially when many hundreds of files need to be created at once. However,
5970 since the purpose of creating the files asynchronously is I<not> to block until
5971 the file is available, values before the file is available will be discarded.
5972 When disabled (the default) files are created synchronously, blocking for a
5973 short while, while the file is being written.
5975 =item B<StepSize> I<Seconds>
5977 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5978 this setting is unset and the stepsize is set to the interval in which the data
5979 is collected. Do not use this option unless you absolutely have to for some
5980 reason. Setting this option may cause problems with the C<snmp plugin>, the
5981 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5983 =item B<HeartBeat> I<Seconds>
5985 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5986 in which case the heartbeat is set to twice the B<StepSize> which should equal
5987 the interval in which data is collected. Do not set this option unless you have
5988 a very good reason to do so.
5990 =item B<RRARows> I<NumRows>
5992 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5993 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5994 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5995 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5996 week, one month, and one year.
5998 So for each timespan, it calculates how many PDPs need to be consolidated into
5999 one CDP by calculating:
6000 number of PDPs = timespan / (stepsize * rrarows)
6002 Bottom line is, set this no smaller than the width of you graphs in pixels. The
6005 =item B<RRATimespan> I<Seconds>
6007 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
6008 more then one RRA. If this option is never used, the built-in default of (3600,
6009 86400, 604800, 2678400, 31622400) is used.
6011 For more information on how RRA-sizes are calculated see B<RRARows> above.
6013 =item B<XFF> I<Factor>
6015 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
6016 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
6019 =item B<CacheFlush> I<Seconds>
6021 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
6022 it writes all values for a certain RRD-file if the oldest value is older than
6023 (or equal to) the number of seconds specified. If some RRD-file is not updated
6024 anymore for some reason (the computer was shut down, the network is broken,
6025 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
6026 entire cache is searched for entries older than B<CacheTimeout> seconds and
6027 written to disk every I<Seconds> seconds. Since this is kind of expensive and
6028 does nothing under normal circumstances, this value should not be too small.
6029 900 seconds might be a good value, though setting this to 7200 seconds doesn't
6030 normally do much harm either.
6032 =item B<CacheTimeout> I<Seconds>
6034 If this option is set to a value greater than zero, the C<rrdtool plugin> will
6035 save values in a cache, as described above. Writing multiple values at once
6036 reduces IO-operations and thus lessens the load produced by updating the files.
6037 The trade off is that the graphs kind of "drag behind" and that more memory is
6040 =item B<WritesPerSecond> I<Updates>
6042 When collecting many statistics with collectd and the C<rrdtool> plugin, you
6043 will run serious performance problems. The B<CacheFlush> setting and the
6044 internal update queue assert that collectd continues to work just fine even
6045 under heavy load, but the system may become very unresponsive and slow. This is
6046 a problem especially if you create graphs from the RRD files on the same
6047 machine, for example using the C<graph.cgi> script included in the
6048 C<contrib/collection3/> directory.
6050 This setting is designed for very large setups. Setting this option to a value
6051 between 25 and 80 updates per second, depending on your hardware, will leave
6052 the server responsive enough to draw graphs even while all the cached values
6053 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
6054 by the B<FLUSH> command, are B<not> effected by this limit. They are still
6055 written as fast as possible, so that web frontends have up to date data when
6058 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
6059 updates per second, writing all values to disk will take approximately
6060 56E<nbsp>minutes. Together with the flushing ability that's integrated into
6061 "collection3" you'll end up with a responsive and fast system, up to date
6062 graphs and basically a "backup" of your values every hour.
6064 =item B<RandomTimeout> I<Seconds>
6066 When set, the actual timeout for each value is chosen randomly between
6067 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
6068 intention is to avoid high load situations that appear when many values timeout
6069 at the same time. This is especially a problem shortly after the daemon starts,
6070 because all values were added to the internal cache at roughly the same time.
6074 =head2 Plugin C<sensors>
6076 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
6077 that all the needed modules have to be loaded and lm_sensors has to be
6078 configured (most likely by editing F</etc/sensors.conf>. Read
6079 L<sensors.conf(5)> for details.
6081 The B<lm_sensors> homepage can be found at
6082 L<http://secure.netroedge.com/~lm78/>.
6086 =item B<SensorConfigFile> I<File>
6088 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
6089 the library's default will be used.
6091 =item B<Sensor> I<chip-bus-address/type-feature>
6093 Selects the name of the sensor which you want to collect or ignore, depending
6094 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
6095 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
6096 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
6098 =item B<IgnoreSelected> I<true>|I<false>
6100 If no configuration if given, the B<sensors>-plugin will collect data from all
6101 sensors. This may not be practical, especially for uninteresting sensors.
6102 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
6103 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
6104 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
6105 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
6106 and all other sensors are collected.
6110 =head2 Plugin C<sigrok>
6112 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
6113 supported by the L<sigrok|http://sigrok.org/> project.
6119 <Device "AC Voltage">
6124 <Device "Sound Level">
6125 Driver "cem-dt-885x"
6132 =item B<LogLevel> B<0-5>
6134 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
6135 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
6136 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
6137 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
6138 their level, are always submitted to I<collectd> at its INFO log level.
6140 =item E<lt>B<Device> I<Name>E<gt>
6142 A sigrok-supported device, uniquely identified by this section's options. The
6143 I<Name> is passed to I<collectd> as the I<plugin instance>.
6145 =item B<Driver> I<DriverName>
6147 The sigrok driver to use for this device.
6149 =item B<Conn> I<ConnectionSpec>
6151 If the device cannot be auto-discovered, or more than one might be discovered
6152 by the driver, I<ConnectionSpec> specifies the connection string to the device.
6153 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
6154 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
6155 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
6156 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
6158 =item B<SerialComm> I<SerialSpec>
6160 For serial devices with non-standard port settings, this option can be used
6161 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
6162 This should not be necessary; drivers know how to communicate with devices they
6165 =item B<MinimumInterval> I<Seconds>
6167 Specifies the minimum time between measurement dispatches to I<collectd>, in
6168 seconds. Since some I<sigrok> supported devices can acquire measurements many
6169 times per second, it may be necessary to throttle these. For example, the
6170 I<RRD plugin> cannot process writes more than once per second.
6172 The default B<MinimumInterval> is B<0>, meaning measurements received from the
6173 device are always dispatched to I<collectd>. When throttled, unused
6174 measurements are discarded.
6178 =head2 Plugin C<smart>
6180 The C<smart> plugin collects SMART information from physical
6181 disks. Values collectd include temperature, power cycle count, poweron
6182 time and bad sectors. Also, all SMART attributes are collected along
6183 with the normalized current value, the worst value, the threshold and
6184 a human readable value.
6186 Using the following two options you can ignore some disks or configure the
6187 collection only of specific disks.
6191 =item B<Disk> I<Name>
6193 Select the disk I<Name>. Whether it is collected or ignored depends on the
6194 B<IgnoreSelected> setting, see below. As with other plugins that use the
6195 daemon's ignorelist functionality, a string that starts and ends with a slash
6196 is interpreted as a regular expression. Examples:
6201 =item B<IgnoreSelected> B<true>|B<false>
6203 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
6204 statements, are ignored or if all other disks are ignored. The behavior
6205 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
6206 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
6207 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
6208 is set to B<true>, all disks are collected B<except> the ones matched.
6212 =head2 Plugin C<snmp>
6214 Since the configuration of the C<snmp plugin> is a little more complicated than
6215 other plugins, its documentation has been moved to an own manpage,
6216 L<collectd-snmp(5)>. Please see there for details.
6218 =head2 Plugin C<statsd>
6220 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
6221 protocol and dispatches rates or other aggregates of these numbers
6224 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
6225 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
6226 C<objects> respectively.
6228 The following configuration options are valid:
6232 =item B<Host> I<Host>
6234 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
6235 "any" address, i.e. accept packets sent to any of the hosts addresses.
6237 =item B<Port> I<Port>
6239 UDP port to listen to. This can be either a service name or a port number.
6240 Defaults to C<8125>.
6242 =item B<DeleteCounters> B<false>|B<true>
6244 =item B<DeleteTimers> B<false>|B<true>
6246 =item B<DeleteGauges> B<false>|B<true>
6248 =item B<DeleteSets> B<false>|B<true>
6250 These options control what happens if metrics are not updated in an interval.
6251 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6252 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6253 are unchanged. If set to B<True>, the such metrics are not dispatched and
6254 removed from the internal cache.
6256 =item B<TimerPercentile> I<Percent>
6258 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6259 that I<Percent> of all reported timers are smaller than or equal to the
6260 computed latency. This is useful for cutting off the long tail latency, as it's
6261 often done in I<Service Level Agreements> (SLAs).
6263 Different percentiles can be calculated by setting this option several times.
6264 If none are specified, no percentiles are calculated / dispatched.
6266 =item B<TimerLower> B<false>|B<true>
6268 =item B<TimerUpper> B<false>|B<true>
6270 =item B<TimerSum> B<false>|B<true>
6272 =item B<TimerCount> B<false>|B<true>
6274 Calculate and dispatch various values out of I<Timer> metrics received during
6275 an interval. If set to B<False>, the default, these values aren't calculated /
6280 =head2 Plugin C<swap>
6282 The I<Swap plugin> collects information about used and available swap space. On
6283 I<Linux> and I<Solaris>, the following options are available:
6287 =item B<ReportByDevice> B<false>|B<true>
6289 Configures how to report physical swap devices. If set to B<false> (the
6290 default), the summary over all swap devices is reported only, i.e. the globally
6291 used and available space over all devices. If B<true> is configured, the used
6292 and available space of each device will be reported separately.
6294 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6295 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6297 =item B<ReportBytes> B<false>|B<true>
6299 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6300 I<swap I/O> is reported in pages. This option is available under Linux only.
6302 =item B<ValuesAbsolute> B<true>|B<false>
6304 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6305 available and used. Defaults to B<true>.
6307 =item B<ValuesPercentage> B<false>|B<true>
6309 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6310 available and free. Defaults to B<false>.
6312 This is useful for deploying I<collectd> in a heterogeneous environment, where
6313 swap sizes differ and you want to specify generic thresholds or similar.
6317 =head2 Plugin C<syslog>
6321 =item B<LogLevel> B<debug|info|notice|warning|err>
6323 Sets the log-level. If, for example, set to B<notice>, then all events with
6324 severity B<notice>, B<warning>, or B<err> will be submitted to the
6327 Please note that B<debug> is only available if collectd has been compiled with
6330 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6332 Controls which notifications should be sent to syslog. The default behaviour is
6333 not to send any. Less severe notifications always imply logging more severe
6334 notifications: Setting this to B<OKAY> means all notifications will be sent to
6335 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6336 notifications but will dismiss B<OKAY> notifications. Setting this option to
6337 B<FAILURE> will only send failures to syslog.
6341 =head2 Plugin C<table>
6343 The C<table plugin> provides generic means to parse tabular data and dispatch
6344 user specified values. Values are selected based on column numbers. For
6345 example, this plugin may be used to get values from the Linux L<proc(5)>
6346 filesystem or CSV (comma separated values) files.
6349 <Table "/proc/slabinfo">
6354 InstancePrefix "active_objs"
6360 InstancePrefix "objperslab"
6367 The configuration consists of one or more B<Table> blocks, each of which
6368 configures one file to parse. Within each B<Table> block, there are one or
6369 more B<Result> blocks, which configure which data to select and how to
6372 The following options are available inside a B<Table> block:
6376 =item B<Instance> I<instance>
6378 If specified, I<instance> is used as the plugin instance. So, in the above
6379 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6380 filename of the table is used instead, with all special characters replaced
6381 with an underscore (C<_>).
6383 =item B<Separator> I<string>
6385 Any character of I<string> is interpreted as a delimiter between the different
6386 columns of the table. A sequence of two or more contiguous delimiters in the
6387 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6388 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6389 of a table - see its documentation for more details. This option is mandatory.
6391 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6392 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6393 required because of collectd's config parsing.
6397 The following options are available inside a B<Result> block:
6401 =item B<Type> I<type>
6403 Sets the type used to dispatch the values to the daemon. Detailed information
6404 about types and their configuration can be found in L<types.db(5)>. This
6405 option is mandatory.
6407 =item B<InstancePrefix> I<prefix>
6409 If specified, prepend I<prefix> to the type instance. If omitted, only the
6410 B<InstancesFrom> option is considered for the type instance.
6412 =item B<InstancesFrom> I<column0> [I<column1> ...]
6414 If specified, the content of the given columns (identified by the column
6415 number starting at zero) will be used to create the type instance for each
6416 row. Multiple values (and the instance prefix) will be joined together with
6417 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6418 option is considered for the type instance.
6420 The plugin itself does not check whether or not all built instances are
6421 different. It’s your responsibility to assure that each is unique. This is
6422 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6423 sure that the table only contains one row.
6425 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6428 =item B<ValuesFrom> I<column0> [I<column1> ...]
6430 Specifies the columns (identified by the column numbers starting at zero)
6431 whose content is used as the actual data for the data sets that are dispatched
6432 to the daemon. How many such columns you need is determined by the B<Type>
6433 setting above. If you specify too many or not enough columns, the plugin will
6434 complain about that and no data will be submitted to the daemon. The plugin
6435 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6436 respectively, so anything supported by those functions is supported by the
6437 plugin as well. This option is mandatory.
6441 =head2 Plugin C<tail>
6443 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6444 each line and dispatches found values. What is matched can be configured by the
6445 user using (extended) regular expressions, as described in L<regex(7)>.
6448 <File "/var/log/exim4/mainlog">
6452 Regex "S=([1-9][0-9]*)"
6458 Regex "\\<R=local_user\\>"
6459 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6462 Instance "local_user"
6467 The config consists of one or more B<File> blocks, each of which configures one
6468 logfile to parse. Within each B<File> block, there are one or more B<Match>
6469 blocks, which configure a regular expression to search for.
6471 The B<Instance> option in the B<File> block may be used to set the plugin
6472 instance. So in the above example the plugin name C<tail-foo> would be used.
6473 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6474 next B<Instance> option. This way you can extract several plugin instances from
6475 one logfile, handy when parsing syslog and the like.
6477 The B<Interval> option allows you to define the length of time between reads. If
6478 this is not set, the default Interval will be used.
6480 Each B<Match> block has the following options to describe how the match should
6485 =item B<Regex> I<regex>
6487 Sets the regular expression to use for matching against a line. The first
6488 subexpression has to match something that can be turned into a number by
6489 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6490 below. Because B<extended> regular expressions are used, you do not need to use
6491 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6492 collectd's config parsing you need to escape backslashes, though. So if you
6493 want to match literal parentheses you need to do the following:
6495 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6497 =item B<ExcludeRegex> I<regex>
6499 Sets an optional regular expression to use for excluding lines from the match.
6500 An example which excludes all connections from localhost from the match:
6502 ExcludeRegex "127\\.0\\.0\\.1"
6504 =item B<DSType> I<Type>
6506 Sets how the values are cumulated. I<Type> is one of:
6510 =item B<GaugeAverage>
6512 Calculate the average.
6516 Use the smallest number only.
6520 Use the greatest number only.
6524 Use the last number found.
6530 =item B<AbsoluteSet>
6532 The matched number is a counter. Simply I<sets> the internal counter to this
6533 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6541 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6542 matched number may be negative, which will effectively subtract from the
6551 Increase the internal counter by one. These B<DSType> are the only ones that do
6552 not use the matched subexpression, but simply count the number of matched
6553 lines. Thus, you may use a regular expression without submatch in this case.
6557 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6558 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6559 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6560 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6561 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6564 =item B<Type> I<Type>
6566 Sets the type used to dispatch this value. Detailed information about types and
6567 their configuration can be found in L<types.db(5)>.
6569 =item B<Instance> I<TypeInstance>
6571 This optional setting sets the type instance to use.
6575 =head2 Plugin C<tail_csv>
6577 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6578 written by I<Snort>.
6583 <Metric "snort-dropped">
6588 <File "/var/log/snort/snort.stats">
6589 Instance "snort-eth0"
6591 Collect "snort-dropped"
6595 The configuration consists of one or more B<Metric> blocks that define an index
6596 into the line of the CSV file and how this value is mapped to I<collectd's>
6597 internal representation. These are followed by one or more B<Instance> blocks
6598 which configure which file to read, in which interval and which metrics to
6603 =item E<lt>B<Metric> I<Name>E<gt>
6605 The B<Metric> block configures a new metric to be extracted from the statistics
6606 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6607 only used inside the B<Instance> blocks to refer to this block, so you can use
6608 one B<Metric> block for multiple CSV files.
6612 =item B<Type> I<Type>
6614 Configures which I<Type> to use when dispatching this metric. Types are defined
6615 in the L<types.db(5)> file, see the appropriate manual page for more
6616 information on specifying types. Only types with a single I<data source> are
6617 supported by the I<tail_csv plugin>. The information whether the value is an
6618 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6619 I<Type's> definition.
6621 =item B<Instance> I<TypeInstance>
6623 If set, I<TypeInstance> is used to populate the type instance field of the
6624 created value lists. Otherwise, no type instance is used.
6626 =item B<ValueFrom> I<Index>
6628 Configure to read the value from the field with the zero-based index I<Index>.
6629 If the value is parsed as signed integer, unsigned integer or double depends on
6630 the B<Type> setting, see above.
6634 =item E<lt>B<File> I<Path>E<gt>
6636 Each B<File> block represents one CSV file to read. There must be at least one
6637 I<File> block but there can be multiple if you have multiple CSV files.
6641 =item B<Instance> I<PluginInstance>
6643 Sets the I<plugin instance> used when dispatching the values.
6645 =item B<Collect> I<Metric>
6647 Specifies which I<Metric> to collect. This option must be specified at least
6648 once, and you can use this option multiple times to specify more than one
6649 metric to be extracted from this statistic file.
6651 =item B<Interval> I<Seconds>
6653 Configures the interval in which to read values from this instance / file.
6654 Defaults to the plugin's default interval.
6656 =item B<TimeFrom> I<Index>
6658 Rather than using the local time when dispatching a value, read the timestamp
6659 from the field with the zero-based index I<Index>. The value is interpreted as
6660 seconds since epoch. The value is parsed as a double and may be factional.
6666 =head2 Plugin C<teamspeak2>
6668 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6669 polls interesting global and virtual server data. The plugin can query only one
6670 physical server but unlimited virtual servers. You can use the following
6671 options to configure it:
6675 =item B<Host> I<hostname/ip>
6677 The hostname or ip which identifies the physical server.
6680 =item B<Port> I<port>
6682 The query port of the physical server. This needs to be a string.
6685 =item B<Server> I<port>
6687 This option has to be added once for every virtual server the plugin should
6688 query. If you want to query the virtual server on port 8767 this is what the
6689 option would look like:
6693 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6694 use quotes around it! If no such statement is given only global information
6699 =head2 Plugin C<ted>
6701 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6702 measure power consumption. These devices are usually connected to a serial
6703 (RS232) or USB port. The plugin opens a configured device and tries to read the
6704 current energy readings. For more information on TED, visit
6705 L<http://www.theenergydetective.com/>.
6707 Available configuration options:
6711 =item B<Device> I<Path>
6713 Path to the device on which TED is connected. collectd will need read and write
6714 permissions on that file.
6716 Default: B</dev/ttyUSB0>
6718 =item B<Retries> I<Num>
6720 Apparently reading from TED is not that reliable. You can therefore configure a
6721 number of retries here. You only configure the I<retries> here, to if you
6722 specify zero, one reading will be performed (but no retries if that fails); if
6723 you specify three, a maximum of four readings are performed. Negative values
6730 =head2 Plugin C<tcpconns>
6732 The C<tcpconns plugin> counts the number of currently established TCP
6733 connections based on the local port and/or the remote port. Since there may be
6734 a lot of connections the default if to count all connections with a local port,
6735 for which a listening socket is opened. You can use the following options to
6736 fine-tune the ports you are interested in:
6740 =item B<ListeningPorts> I<true>|I<false>
6742 If this option is set to I<true>, statistics for all local ports for which a
6743 listening socket exists are collected. The default depends on B<LocalPort> and
6744 B<RemotePort> (see below): If no port at all is specifically selected, the
6745 default is to collect listening ports. If specific ports (no matter if local or
6746 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6747 the selected ports will be collected unless this option is set to I<true>
6750 =item B<LocalPort> I<Port>
6752 Count the connections to a specific local port. This can be used to see how
6753 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6754 You have to specify the port in numeric form, so for the mailserver example
6755 you'd need to set B<25>.
6757 =item B<RemotePort> I<Port>
6759 Count the connections to a specific remote port. This is useful to see how
6760 much a remote service is used. This is most useful if you want to know how many
6761 connections a local service has opened to remote services, e.E<nbsp>g. how many
6762 connections a mail server or news server has to other mail or news servers, or
6763 how many connections a web proxy holds to web servers. You have to give the
6764 port in numeric form.
6766 =item B<AllPortsSummary> I<true>|I<false>
6768 If this option is set to I<true> a summary of statistics from all connections
6769 are collectd. This option defaults to I<false>.
6773 =head2 Plugin C<thermal>
6777 =item B<ForceUseProcfs> I<true>|I<false>
6779 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6780 C<sysfs> interface. If that is not available, the plugin falls back to the
6781 C<procfs> interface. By setting this option to I<true>, you can force the
6782 plugin to use the latter. This option defaults to I<false>.
6784 =item B<Device> I<Device>
6786 Selects the name of the thermal device that you want to collect or ignore,
6787 depending on the value of the B<IgnoreSelected> option. This option may be
6788 used multiple times to specify a list of devices.
6790 =item B<IgnoreSelected> I<true>|I<false>
6792 Invert the selection: If set to true, all devices B<except> the ones that
6793 match the device names specified by the B<Device> option are collected. By
6794 default only selected devices are collected if a selection is made. If no
6795 selection is configured at all, B<all> devices are selected.
6799 =head2 Plugin C<threshold>
6801 The I<Threshold plugin> checks values collected or received by I<collectd>
6802 against a configurable I<threshold> and issues I<notifications> if values are
6805 Documentation for this plugin is available in the L<collectd-threshold(5)>
6808 =head2 Plugin C<tokyotyrant>
6810 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6811 couple metrics: number of records, and database size on disk.
6815 =item B<Host> I<Hostname/IP>
6817 The hostname or ip which identifies the server.
6818 Default: B<127.0.0.1>
6820 =item B<Port> I<Service/Port>
6822 The query port of the server. This needs to be a string, even if the port is
6823 given in its numeric form.
6828 =head2 Plugin C<turbostat>
6830 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
6831 Intel processors by using the new Model Specific Registers.
6835 =item B<CoreCstates> I<Bitmask(Integer)>
6837 Bitmask of the list of core C states supported by the processor.
6838 This option should only be used if the automated detection fails.
6839 Default value extracted from the cpu model and family.
6841 Currently supported C-states (by this plugin): 3, 6, 7
6843 Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
6845 =item B<PackageCstates> I<Bitmask(Integer)>
6847 Bitmask of the list of pacages C states supported by the processor.
6848 This option should only be used if the automated detection fails.
6849 Default value extracted from the cpu model and family.
6851 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
6853 Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7
6855 =item B<SystemManagementInterrupt> I<true>|I<false>
6857 Boolean enabling the collection of the I/O System-Management Interrupt
6858 counter'. This option should only be used if the automated detection
6859 fails or if you want to disable this feature.
6861 =item B<DigitalTemperatureSensor> I<true>|I<false>
6863 Boolean enabling the collection of the temperature of each core.
6864 This option should only be used if the automated detectionfails or
6865 if you want to disable this feature.
6867 =item B<DigitalTemperatureSensor> I<true>|I<false>
6869 Boolean enabling the collection of the temperature of each package.
6870 This option should only be used if the automated detectionfails or
6871 if you want to disable this feature.
6873 =item B<TCCActivationTemp> I<Temperature>
6875 Thermal Control Circuit Activation Temperature of the installed
6876 CPU. This temperature is used when collecting the temperature of
6877 cores or packages. This option should only be used if the automated
6878 detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
6880 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
6882 Bitmask of the list of elements to be thermally monitored. This option
6883 should only be used if the automated detection fails or if you want to
6884 disable some collections. The different bits of this bitmask accepted
6889 =item 0 ('1'): Package
6893 =item 2 ('4'): Cores
6895 =item 3 ('8'): Embedded graphic device
6901 =head2 Plugin C<unixsock>
6905 =item B<SocketFile> I<Path>
6907 Sets the socket-file which is to be created.
6909 =item B<SocketGroup> I<Group>
6911 If running as root change the group of the UNIX-socket after it has been
6912 created. Defaults to B<collectd>.
6914 =item B<SocketPerms> I<Permissions>
6916 Change the file permissions of the UNIX-socket after it has been created. The
6917 permissions must be given as a numeric, octal value as you would pass to
6918 L<chmod(1)>. Defaults to B<0770>.
6920 =item B<DeleteSocket> B<false>|B<true>
6922 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6923 with the given name already exists. If I<collectd> crashes a socket file may be
6924 left over, preventing the daemon from opening a new socket when restarted.
6925 Since this is potentially dangerous, this defaults to B<false>.
6929 =head2 Plugin C<uuid>
6931 This plugin, if loaded, causes the Hostname to be taken from the machine's
6932 UUID. The UUID is a universally unique designation for the machine, usually
6933 taken from the machine's BIOS. This is most useful if the machine is running in
6934 a virtual environment such as Xen, in which case the UUID is preserved across
6935 shutdowns and migration.
6937 The following methods are used to find the machine's UUID, in order:
6943 Check I</etc/uuid> (or I<UUIDFile>).
6947 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6952 Check for UUID from C<dmidecode> / SMBIOS.
6956 Check for UUID from Xen hypervisor.
6960 If no UUID can be found then the hostname is not modified.
6964 =item B<UUIDFile> I<Path>
6966 Take the UUID from the given file (default I</etc/uuid>).
6970 =head2 Plugin C<varnish>
6972 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6973 It collects a subset of the values displayed by L<varnishstat(1)>, and
6974 organizes them in categories which can be enabled or disabled. Currently only
6975 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6976 meaning of each metric can be found in L<varnish-counters(7)>.
6981 <Instance "example">
6985 CollectConnections true
6986 CollectDirectorDNS false
6990 CollectObjects false
6992 CollectSession false
7002 CollectWorkers false
7006 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
7007 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
7008 will collectd statistics from the default "varnishd" instance (this should work
7009 fine in most cases).
7011 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
7015 =item B<CollectBackend> B<true>|B<false>
7017 Back-end connection statistics, such as successful, reused,
7018 and closed connections. True by default.
7020 =item B<CollectBan> B<true>|B<false>
7022 Statistics about ban operations, such as number of bans added, retired, and
7023 number of objects tested against ban operations. Only available with Varnish
7024 3.x and above. False by default.
7026 =item B<CollectCache> B<true>|B<false>
7028 Cache hits and misses. True by default.
7030 =item B<CollectConnections> B<true>|B<false>
7032 Number of client connections received, accepted and dropped. True by default.
7034 =item B<CollectDirectorDNS> B<true>|B<false>
7036 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
7039 =item B<CollectESI> B<true>|B<false>
7041 Edge Side Includes (ESI) parse statistics. False by default.
7043 =item B<CollectFetch> B<true>|B<false>
7045 Statistics about fetches (HTTP requests sent to the backend). False by default.
7047 =item B<CollectHCB> B<true>|B<false>
7049 Inserts and look-ups in the crit bit tree based hash. Look-ups are
7050 divided into locked and unlocked look-ups. False by default.
7052 =item B<CollectObjects> B<true>|B<false>
7054 Statistics on cached objects: number of objects expired, nuked (prematurely
7055 expired), saved, moved, etc. False by default.
7057 =item B<CollectPurge> B<true>|B<false>
7059 Statistics about purge operations, such as number of purges added, retired, and
7060 number of objects tested against purge operations. Only available with Varnish
7061 2.x. False by default.
7063 =item B<CollectSession> B<true>|B<false>
7065 Client session statistics. Number of past and current sessions, session herd and
7066 linger counters, etc. False by default. Note that if using Varnish 4.x, some
7067 metrics found in the Connections and Threads sections with previous versions of
7068 Varnish have been moved here.
7070 =item B<CollectSHM> B<true>|B<false>
7072 Statistics about the shared memory log, a memory region to store
7073 log messages which is flushed to disk when full. True by default.
7075 =item B<CollectSMA> B<true>|B<false>
7077 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
7078 component is Solaris specific. Only available with Varnish 2.x. False by
7081 =item B<CollectSMS> B<true>|B<false>
7083 synth (synthetic content) storage statistics. This storage
7084 component is used internally only. False by default.
7086 =item B<CollectSM> B<true>|B<false>
7088 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
7091 =item B<CollectStruct> B<true>|B<false>
7093 Current varnish internal state statistics. Number of current sessions, objects
7094 in cache store, open connections to backends (with Varnish 2.x), etc. False by
7097 =item B<CollectTotals> B<true>|B<false>
7099 Collects overview counters, such as the number of sessions created,
7100 the number of requests and bytes transferred. False by default.
7102 =item B<CollectUptime> B<true>|B<false>
7104 Varnish uptime. Only available with Varnish 3.x and above. False by default.
7106 =item B<CollectVCL> B<true>|B<false>
7108 Number of total (available + discarded) VCL (config files). False by default.
7110 =item B<CollectVSM> B<true>|B<false>
7112 Collect statistics about Varnish's shared memory usage (used by the logging and
7113 statistics subsystems). Only available with Varnish 4.x. False by default.
7115 =item B<CollectWorkers> B<true>|B<false>
7117 Collect statistics about worker threads. False by default.
7121 =head2 Plugin C<virt>
7123 This plugin allows CPU, disk and network load to be collected for virtualized
7124 guests on the machine. This means that these metrics can be collected for guest
7125 systems without installing any software on them - I<collectd> only runs on the
7126 host system. The statistics are collected through libvirt
7127 (L<http://libvirt.org/>).
7129 Only I<Connection> is required.
7133 =item B<Connection> I<uri>
7135 Connect to the hypervisor given by I<uri>. For example if using Xen use:
7137 Connection "xen:///"
7139 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
7141 =item B<RefreshInterval> I<seconds>
7143 Refresh the list of domains and devices every I<seconds>. The default is 60
7144 seconds. Setting this to be the same or smaller than the I<Interval> will cause
7145 the list of domains and devices to be refreshed on every iteration.
7147 Refreshing the devices in particular is quite a costly operation, so if your
7148 virtualization setup is static you might consider increasing this. If this
7149 option is set to 0, refreshing is disabled completely.
7151 =item B<Domain> I<name>
7153 =item B<BlockDevice> I<name:dev>
7155 =item B<InterfaceDevice> I<name:dev>
7157 =item B<IgnoreSelected> B<true>|B<false>
7159 Select which domains and devices are collected.
7161 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
7162 disk/network devices are collected.
7164 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
7165 domains and disk/network devices are ignored, while the rest are collected.
7167 The domain name and device names may use a regular expression, if the name is
7168 surrounded by I</.../> and collectd was compiled with support for regexps.
7170 The default is to collect statistics for all domains and all their devices.
7174 BlockDevice "/:hdb/"
7175 IgnoreSelected "true"
7177 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
7180 =item B<HostnameFormat> B<name|uuid|hostname|...>
7182 When the virt plugin logs data, it sets the hostname of the collected data
7183 according to this setting. The default is to use the guest name as provided by
7184 the hypervisor, which is equal to setting B<name>.
7186 B<uuid> means use the guest's UUID. This is useful if you want to track the
7187 same guest across migrations.
7189 B<hostname> means to use the global B<Hostname> setting, which is probably not
7190 useful on its own because all guests will appear to have the same name.
7192 You can also specify combinations of these fields. For example B<name uuid>
7193 means to concatenate the guest name and UUID (with a literal colon character
7194 between, thus I<"foo:1234-1234-1234-1234">).
7196 At the moment of writing (collectd-5.5), hostname string is limited to 62
7197 characters. In case when combination of fields exceeds 62 characters,
7198 hostname will be truncated without a warning.
7200 =item B<InterfaceFormat> B<name>|B<address>
7202 When the virt plugin logs interface data, it sets the name of the collected
7203 data according to this setting. The default is to use the path as provided by
7204 the hypervisor (the "dev" property of the target node), which is equal to
7207 B<address> means use the interface's mac address. This is useful since the
7208 interface path might change between reboots of a guest or across migrations.
7210 =item B<PluginInstanceFormat> B<name|uuid|none>
7212 When the virt plugin logs data, it sets the plugin_instance of the collected
7213 data according to this setting. The default is to not set the plugin_instance.
7215 B<name> means use the guest's name as provided by the hypervisor.
7216 B<uuid> means use the guest's UUID.
7218 You can also specify combinations of the B<name> and B<uuid> fields.
7219 For example B<name uuid> means to concatenate the guest name and UUID
7220 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
7224 =head2 Plugin C<vmem>
7226 The C<vmem> plugin collects information about the usage of virtual memory.
7227 Since the statistics provided by the Linux kernel are very detailed, they are
7228 collected very detailed. However, to get all the details, you have to switch
7229 them on manually. Most people just want an overview over, such as the number of
7230 pages read from swap space.
7234 =item B<Verbose> B<true>|B<false>
7236 Enables verbose collection of information. This will start collecting page
7237 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
7238 Part of these statistics are collected on a "per zone" basis.
7242 =head2 Plugin C<vserver>
7244 This plugin doesn't have any options. B<VServer> support is only available for
7245 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
7246 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
7247 need to apply the patches and compile your own kernel, which will then provide
7248 the F</proc/virtual> filesystem that is required by this plugin.
7250 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
7252 B<Note>: The traffic collected by this plugin accounts for the amount of
7253 traffic passing a socket which might be a lot less than the actual on-wire
7254 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
7255 collect on-wire traffic you could, for example, use the logging facilities of
7256 iptables to feed data for the guest IPs into the iptables plugin.
7258 =head2 Plugin C<write_graphite>
7260 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
7261 storage and graphing project. The plugin connects to I<Carbon>, the data layer
7262 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
7263 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
7264 of at most 1428 bytes to minimize the number of network packets.
7268 <Plugin write_graphite>
7278 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7279 blocks. Inside the B<Node> blocks, the following options are recognized:
7283 =item B<Host> I<Address>
7285 Hostname or address to connect to. Defaults to C<localhost>.
7287 =item B<Port> I<Service>
7289 Service name or port number to connect to. Defaults to C<2003>.
7291 =item B<Protocol> I<String>
7293 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
7295 =item B<LogSendErrors> B<false>|B<true>
7297 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
7298 If set to B<false>, it will not log the errors. This is especially useful when
7299 using Protocol UDP since many times we want to use the "fire-and-forget"
7300 approach and logging errors fills syslog with unneeded messages.
7302 =item B<Prefix> I<String>
7304 When set, I<String> is added in front of the host name. Dots and whitespace are
7305 I<not> escaped in this string (see B<EscapeCharacter> below).
7307 =item B<Postfix> I<String>
7309 When set, I<String> is appended to the host name. Dots and whitespace are
7310 I<not> escaped in this string (see B<EscapeCharacter> below).
7312 =item B<EscapeCharacter> I<Char>
7314 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
7315 in the identifier. The B<EscapeCharacter> option determines which character
7316 dots, whitespace and control characters are replaced with. Defaults to
7319 =item B<StoreRates> B<false>|B<true>
7321 If set to B<true> (the default), convert counter values to rates. If set to
7322 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7325 =item B<SeparateInstances> B<false>|B<true>
7327 If set to B<true>, the plugin instance and type instance will be in their own
7328 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7329 default), the plugin and plugin instance (and likewise the type and type
7330 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7332 =item B<AlwaysAppendDS> B<false>|B<true>
7334 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7335 identifier. If set to B<false> (the default), this is only done when there is
7340 =head2 Plugin C<write_tsdb>
7342 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7343 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7344 state daemon that ingests metrics and stores them in HBase. The plugin uses
7345 I<TCP> over the "line based" protocol with a default port 4242. The data will
7346 be sent in blocks of at most 1428 bytes to minimize the number of network
7353 Host "tsd-1.my.domain"
7355 HostTags "status=production"
7359 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7360 blocks. Inside the B<Node> blocks, the following options are recognized:
7364 =item B<Host> I<Address>
7366 Hostname or address to connect to. Defaults to C<localhost>.
7368 =item B<Port> I<Service>
7370 Service name or port number to connect to. Defaults to C<4242>.
7373 =item B<HostTags> I<String>
7375 When set, I<HostTags> is added to the end of the metric. It is intended to be
7376 used for name=value pairs that the TSD will tag the metric with. Dots and
7377 whitespace are I<not> escaped in this string.
7379 =item B<StoreRates> B<false>|B<true>
7381 If set to B<true>, convert counter values to rates. If set to B<false>
7382 (the default) counter values are stored as is, as an increasing
7385 =item B<AlwaysAppendDS> B<false>|B<true>
7387 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7388 identifier. If set to B<false> (the default), this is only done when there is
7393 =head2 Plugin C<write_mongodb>
7395 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7400 <Plugin "write_mongodb">
7409 The plugin can send values to multiple instances of I<MongoDB> by specifying
7410 one B<Node> block for each instance. Within the B<Node> blocks, the following
7411 options are available:
7415 =item B<Host> I<Address>
7417 Hostname or address to connect to. Defaults to C<localhost>.
7419 =item B<Port> I<Service>
7421 Service name or port number to connect to. Defaults to C<27017>.
7423 =item B<Timeout> I<Milliseconds>
7425 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7426 Setting this option to zero means no timeout, which is the default.
7428 =item B<StoreRates> B<false>|B<true>
7430 If set to B<true> (the default), convert counter values to rates. If set to
7431 B<false> counter values are stored as is, i.e. as an increasing integer
7434 =item B<Database> I<Database>
7436 =item B<User> I<User>
7438 =item B<Password> I<Password>
7440 Sets the information used when authenticating to a I<MongoDB> database. The
7441 fields are optional (in which case no authentication is attempted), but if you
7442 want to use authentication all three fields must be set.
7446 =head2 Plugin C<write_http>
7448 This output plugin submits values to an HTTP server using POST requests and
7449 encoding metrics with JSON or using the C<PUTVAL> command described in
7450 L<collectd-unixsock(5)>.
7454 <Plugin "write_http">
7456 URL "http://example.com/post-collectd"
7463 The plugin can send values to multiple HTTP servers by specifying one
7464 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7465 block, the following options are available:
7471 URL to which the values are submitted to. Mandatory.
7473 =item B<User> I<Username>
7475 Optional user name needed for authentication.
7477 =item B<Password> I<Password>
7479 Optional password needed for authentication.
7481 =item B<VerifyPeer> B<true>|B<false>
7483 Enable or disable peer SSL certificate verification. See
7484 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7486 =item B<VerifyHost> B<true|false>
7488 Enable or disable peer host name verification. If enabled, the plugin checks if
7489 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7490 matches the host name provided by the B<URL> option. If this identity check
7491 fails, the connection is aborted. Obviously, only works when connecting to a
7492 SSL enabled server. Enabled by default.
7494 =item B<CACert> I<File>
7496 File that holds one or more SSL certificates. If you want to use HTTPS you will
7497 possibly need this option. What CA certificates come bundled with C<libcurl>
7498 and are checked by default depends on the distribution you use.
7500 =item B<CAPath> I<Directory>
7502 Directory holding one or more CA certificate files. You can use this if for
7503 some reason all the needed CA certificates aren't in the same file and can't be
7504 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7507 =item B<ClientKey> I<File>
7509 File that holds the private key in PEM format to be used for certificate-based
7512 =item B<ClientCert> I<File>
7514 File that holds the SSL certificate to be used for certificate-based
7517 =item B<ClientKeyPass> I<Password>
7519 Password required to load the private key in B<ClientKey>.
7521 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7523 Define which SSL protocol version must be used. By default C<libcurl> will
7524 attempt to figure out the remote SSL protocol version. See
7525 L<curl_easy_setopt(3)> for more details.
7527 =item B<Format> B<Command>|B<JSON>
7529 Format of the output to generate. If set to B<Command>, will create output that
7530 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7531 create output in the I<JavaScript Object Notation> (JSON).
7533 Defaults to B<Command>.
7535 =item B<StoreRates> B<true|false>
7537 If set to B<true>, convert counter values to rates. If set to B<false> (the
7538 default) counter values are stored as is, i.e. as an increasing integer number.
7540 =item B<BufferSize> I<Bytes>
7542 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7543 requests will be generated, but more metrics will be batched / metrics are
7544 cached for longer before being sent, introducing additional delay until they
7545 are available on the server side. I<Bytes> must be at least 1024 and cannot
7546 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7547 Defaults to C<4096>.
7549 =item B<LowSpeedLimit> I<Bytes per Second>
7551 Sets the minimal transfer rate in I<Bytes per Second> below which the
7552 connection with the HTTP server will be considered too slow and aborted. All
7553 the data submitted over this connection will probably be lost. Defaults to 0,
7554 which means no minimum transfer rate is enforced.
7556 =item B<Timeout> I<Timeout>
7558 Sets the maximum time in milliseconds given for HTTP POST operations to
7559 complete. When this limit is reached, the POST operation will be aborted, and
7560 all the data in the current send buffer will probably be lost. Defaults to 0,
7561 which means the connection never times out.
7563 =item B<LogHttpError> B<false>|B<true>
7565 Enables printing of HTTP error code to log. Turned off by default.
7567 The C<write_http> plugin regularly submits the collected values to the HTTP
7568 server. How frequently this happens depends on how much data you are collecting
7569 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
7570 slightly below this interval, which you can estimate by monitoring the network
7571 traffic between collectd and the HTTP server.
7575 =head2 Plugin C<write_kafka>
7577 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7581 <Plugin "write_kafka">
7582 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7588 The following options are understood by the I<write_kafka plugin>:
7592 =item E<lt>B<Topic> I<Name>E<gt>
7594 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7595 is given a unique I<Name> and specifies one kafka producer.
7596 Inside the B<Topic> block, the following per-topic options are
7601 =item B<Property> I<String> I<String>
7603 Configure the named property for the current topic. Properties are
7604 forwarded to the kafka producer library B<librdkafka>.
7606 =item B<Key> I<String>
7608 Use the specified string as a partioning key for the topic. Kafka breaks
7609 topic into partitions and guarantees that for a given topology, the same
7610 consumer will be used for a specific key. The special (case insensitive)
7611 string B<Random> can be used to specify that an arbitrary partition should
7614 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7616 Selects the format in which messages are sent to the broker. If set to
7617 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7618 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7620 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7621 an easy and straight forward exchange format.
7623 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7624 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7626 =item B<StoreRates> B<true>|B<false>
7628 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7629 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7630 default), no conversion is performed. Otherwise the conversion is performed
7631 using the internal value cache.
7633 Please note that currently this option is only used if the B<Format> option has
7634 been set to B<JSON>.
7636 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7638 A prefix can be added in the metric name when outputting in the I<Graphite>
7639 format. It's added before the I<Host> name.
7641 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>>
7643 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7645 A postfix can be added in the metric name when outputting in the I<Graphite>
7646 format. It's added after the I<Host> name.
7648 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>>
7650 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7652 Specify a character to replace dots (.) in the host part of the metric name.
7653 In I<Graphite> metric name, dots are used as separators between different
7654 metric parts (host, plugin, type).
7655 Default is C<_> (I<Underscore>).
7657 =item B<GraphiteSeparateInstances> B<false>|B<true>
7659 If set to B<true>, the plugin instance and type instance will be in their own
7660 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7661 default), the plugin and plugin instance (and likewise the type and type
7662 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7664 =item B<StoreRates> B<true>|B<false>
7666 If set to B<true> (the default), convert counter values to rates. If set to
7667 B<false> counter values are stored as is, i.e. as an increasing integer number.
7669 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7670 converted values will have "rate" appended to the data source type, e.g.
7671 C<ds_type:derive:rate>.
7675 =item B<Property> I<String> I<String>
7677 Configure the kafka producer through properties, you almost always will
7678 want to set B<metadata.broker.list> to your Kafka broker list.
7682 =head2 Plugin C<write_redis>
7684 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7688 <Plugin "write_redis">
7700 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7701 the timestamp as the score. Retrieving a date range can then be done using the
7702 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
7703 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
7704 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
7705 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
7706 with the B<Database> parameter (default is C<0>). See
7707 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7710 The information shown in the synopsis above is the I<default configuration>
7711 which is used by the plugin if no configuration is present.
7713 The plugin can send values to multiple instances of I<Redis> by specifying
7714 one B<Node> block for each instance. Within the B<Node> blocks, the following
7715 options are available:
7719 =item B<Node> I<Nodename>
7721 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7722 instance running on a specified host and port. The node name is a
7723 canonical identifier which is used as I<plugin instance>. It is limited to
7724 51E<nbsp>characters in length.
7726 =item B<Host> I<Hostname>
7728 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7731 =item B<Port> I<Port>
7733 The B<Port> option is the TCP port on which the Redis instance accepts
7734 connections. Either a service name of a port number may be given. Please note
7735 that numerical port numbers must be given as a string, too.
7737 =item B<Timeout> I<Milliseconds>
7739 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7741 =item B<Prefix> I<Prefix>
7743 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
7744 containing all metrics. Defaults to C<collectd/>, so metrics will have names
7745 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
7746 is recommended but not required to include a trailing slash in I<Prefix>.
7748 =item B<Database> I<Index>
7750 This index selects the redis database to use for writing operations. Defaults
7753 =item B<MaxSetSize> I<Items>
7755 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
7756 hold. Negative values for I<Items> sets no limit, which is the default behavior.
7758 =item B<StoreRates> B<true>|B<false>
7760 If set to B<true> (the default), convert counter values to rates. If set to
7761 B<false> counter values are stored as is, i.e. as an increasing integer number.
7765 =head2 Plugin C<write_riemann>
7767 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7768 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7769 I<Riemann> using UDP packets.
7773 <Plugin "write_riemann">
7779 AlwaysAppendDS false
7783 Attribute "foo" "bar"
7786 The following options are understood by the I<write_riemann plugin>:
7790 =item E<lt>B<Node> I<Name>E<gt>
7792 The plugin's configuration consists of one or more B<Node> blocks. Each block
7793 is given a unique I<Name> and specifies one connection to an instance of
7794 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7799 =item B<Host> I<Address>
7801 Hostname or address to connect to. Defaults to C<localhost>.
7803 =item B<Port> I<Service>
7805 Service name or port number to connect to. Defaults to C<5555>.
7807 =item B<Protocol> B<UDP>|B<TCP>
7809 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7812 =item B<Batch> B<true>|B<false>
7814 If set to B<true> and B<Protocol> is set to B<TCP>,
7815 events will be batched in memory and flushed at
7816 regular intervals or when B<BatchMaxSize> is exceeded.
7818 Notifications are not batched and sent as soon as possible.
7820 When enabled, it can occur that events get processed by the Riemann server
7821 close to or after their expiration time. Tune the B<TTLFactor> and
7822 B<BatchMaxSize> settings according to the amount of values collected, if this
7827 =item B<BatchMaxSize> I<size>
7829 Maximum payload size for a riemann packet. Defaults to 8192
7831 =item B<StoreRates> B<true>|B<false>
7833 If set to B<true> (the default), convert counter values to rates. If set to
7834 B<false> counter values are stored as is, i.e. as an increasing integer number.
7836 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7837 converted values will have "rate" appended to the data source type, e.g.
7838 C<ds_type:derive:rate>.
7840 =item B<AlwaysAppendDS> B<false>|B<true>
7842 If set to B<true>, append the name of the I<Data Source> (DS) to the
7843 "service", i.e. the field that, together with the "host" field, uniquely
7844 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7845 only done when there is more than one DS.
7847 =item B<TTLFactor> I<Factor>
7849 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7850 event is considered active. I<collectd> populates this field based on the
7851 metrics interval setting. This setting controls the factor with which the
7852 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7853 know exactly what you're doing, you should only increase this setting from its
7856 =item B<Notifications> B<false>|B<true>
7858 If set to B<true>, create riemann events for notifications. This is B<true>
7859 by default. When processing thresholds from write_riemann, it might prove
7860 useful to avoid getting notification events.
7862 =item B<CheckThresholds> B<false>|B<true>
7864 If set to B<true>, attach state to events based on thresholds defined
7865 in the B<Threshold> plugin. Defaults to B<false>.
7867 =item B<EventServicePrefix> I<String>
7869 Add the given string as a prefix to the event service name.
7870 If B<EventServicePrefix> not set or set to an empty string (""),
7871 no prefix will be used.
7875 =item B<Tag> I<String>
7877 Add the given string as an additional tag to the metric being sent to
7880 =item B<Attribute> I<String> I<String>
7882 Consider the two given strings to be the key and value of an additional
7883 attribute for each metric being sent out to I<Riemann>.
7887 =head2 Plugin C<write_sensu>
7889 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
7890 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
7891 a local I<Sensu> client using a TCP socket.
7893 At the moment, the I<write_sensu plugin> does not send over a collectd_host
7894 parameter so it is not possible to use one collectd instance as a gateway for
7895 others. Each collectd host must pair with one I<Sensu> client.
7899 <Plugin "write_sensu">
7904 AlwaysAppendDS false
7905 MetricHandler "influx"
7906 MetricHandler "default"
7907 NotificationHandler "flapjack"
7908 NotificationHandler "howling_monkey"
7912 Attribute "foo" "bar"
7915 The following options are understood by the I<write_sensu plugin>:
7919 =item E<lt>B<Node> I<Name>E<gt>
7921 The plugin's configuration consists of one or more B<Node> blocks. Each block
7922 is given a unique I<Name> and specifies one connection to an instance of
7923 I<Sensu>. Inside the B<Node> block, the following per-connection options are
7928 =item B<Host> I<Address>
7930 Hostname or address to connect to. Defaults to C<localhost>.
7932 =item B<Port> I<Service>
7934 Service name or port number to connect to. Defaults to C<3030>.
7936 =item B<StoreRates> B<true>|B<false>
7938 If set to B<true> (the default), convert counter values to rates. If set to
7939 B<false> counter values are stored as is, i.e. as an increasing integer number.
7941 This will be reflected in the C<collectd_data_source_type> tag: If
7942 B<StoreRates> is enabled, converted values will have "rate" appended to the
7943 data source type, e.g. C<collectd_data_source_type:derive:rate>.
7945 =item B<AlwaysAppendDS> B<false>|B<true>
7947 If set the B<true>, append the name of the I<Data Source> (DS) to the
7948 "service", i.e. the field that, together with the "host" field, uniquely
7949 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
7950 only done when there is more than one DS.
7952 =item B<Notifications> B<false>|B<true>
7954 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
7955 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7957 =item B<Metrics> B<false>|B<true>
7959 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
7960 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7963 =item B<Separator> I<String>
7965 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
7967 =item B<MetricHandler> I<String>
7969 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
7970 several of them, one per line. Defaults to no handler.
7972 =item B<NotificationHandler> I<String>
7974 Add a handler that will be set when notifications are sent to I<Sensu>. You can
7975 add several of them, one per line. Defaults to no handler.
7977 =item B<EventServicePrefix> I<String>
7979 Add the given string as a prefix to the event service name.
7980 If B<EventServicePrefix> not set or set to an empty string (""),
7981 no prefix will be used.
7985 =item B<Tag> I<String>
7987 Add the given string as an additional tag to the metric being sent to
7990 =item B<Attribute> I<String> I<String>
7992 Consider the two given strings to be the key and value of an additional
7993 attribute for each metric being sent out to I<Sensu>.
7997 =head2 Plugin C<zookeeper>
7999 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
8000 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
8005 <Plugin "zookeeper">
8012 =item B<Host> I<Address>
8014 Hostname or address to connect to. Defaults to C<localhost>.
8016 =item B<Port> I<Service>
8018 Service name or port number to connect to. Defaults to C<2181>.
8022 =head1 THRESHOLD CONFIGURATION
8024 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
8025 we mean that the values are not only stored or sent somewhere, but that they
8026 are judged and, if a problem is recognized, acted upon. The only action
8027 collectd takes itself is to generate and dispatch a "notification". Plugins can
8028 register to receive notifications and perform appropriate further actions.
8030 Since systems and what you expect them to do differ a lot, you can configure
8031 B<thresholds> for your values freely. This gives you a lot of flexibility but
8032 also a lot of responsibility.
8034 Every time a value is out of range a notification is dispatched. This means
8035 that the idle percentage of your CPU needs to be less then the configured
8036 threshold only once for a notification to be generated. There's no such thing
8037 as a moving average or similar - at least not now.
8039 Also, all values that match a threshold are considered to be relevant or
8040 "interesting". As a consequence collectd will issue a notification if they are
8041 not received for B<Timeout> iterations. The B<Timeout> configuration option is
8042 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
8043 "2" (the default) and some hosts sends it's CPU statistics to the server every
8044 60 seconds, a notification will be dispatched after about 120 seconds. It may
8045 take a little longer because the timeout is checked only once each B<Interval>
8048 When a value comes within range again or is received after it was missing, an
8049 "OKAY-notification" is dispatched.
8051 Here is a configuration example to get you started. Read below for more
8064 <Plugin "interface">
8081 WarningMin 100000000
8087 There are basically two types of configuration statements: The C<Host>,
8088 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
8089 configured. The C<Plugin> and C<Type> blocks may be specified further using the
8090 C<Instance> option. You can combine the block by nesting the blocks, though
8091 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
8092 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
8093 C<Type> may not contain other blocks. If multiple blocks apply to the same
8094 value the most specific block is used.
8096 The other statements specify the threshold to configure. They B<must> be
8097 included in a C<Type> block. Currently the following statements are recognized:
8101 =item B<FailureMax> I<Value>
8103 =item B<WarningMax> I<Value>
8105 Sets the upper bound of acceptable values. If unset defaults to positive
8106 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
8107 will be created. If the value is greater than B<WarningMax> but less than (or
8108 equal to) B<FailureMax> a B<WARNING> notification will be created.
8110 =item B<FailureMin> I<Value>
8112 =item B<WarningMin> I<Value>
8114 Sets the lower bound of acceptable values. If unset defaults to negative
8115 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
8116 be created. If the value is less than B<WarningMin> but greater than (or equal
8117 to) B<FailureMin> a B<WARNING> notification will be created.
8119 =item B<DataSource> I<DSName>
8121 Some data sets have more than one "data source". Interesting examples are the
8122 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
8123 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
8124 system load data set, C<load>, even has three data sources: C<shortterm>,
8125 C<midterm>, and C<longterm>.
8127 Normally, all data sources are checked against a configured threshold. If this
8128 is undesirable, or if you want to specify different limits for each data
8129 source, you can use the B<DataSource> option to have a threshold apply only to
8132 =item B<Invert> B<true>|B<false>
8134 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
8135 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
8136 B<WarningMax>) are not okay. Defaults to B<false>.
8138 =item B<Persist> B<true>|B<false>
8140 Sets how often notifications are generated. If set to B<true> one notification
8141 will be generated for each value that is out of the acceptable range. If set to
8142 B<false> (the default) then a notification is only generated if a value is out
8143 of range but the previous value was okay.
8145 This applies to missing values, too: If set to B<true> a notification about a
8146 missing value is generated once every B<Interval> seconds. If set to B<false>
8147 only one such notification is generated until the value appears again.
8149 =item B<Percentage> B<true>|B<false>
8151 If set to B<true>, the minimum and maximum values given are interpreted as
8152 percentage value, relative to the other data sources. This is helpful for
8153 example for the "df" type, where you may want to issue a warning when less than
8154 5E<nbsp>% of the total space is available. Defaults to B<false>.
8156 =item B<Hits> I<Number>
8158 Delay creating the notification until the threshold has been passed I<Number>
8159 times. When a notification has been generated, or when a subsequent value is
8160 inside the threshold, the counter is reset. If, for example, a value is
8161 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
8162 will be dispatched at most once every 30E<nbsp>seconds.
8164 This is useful when short bursts are not a problem. If, for example, 100% CPU
8165 usage for up to a minute is normal (and data is collected every
8166 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
8168 =item B<Hysteresis> I<Number>
8170 When set to non-zero, a hysteresis value is applied when checking minimum and
8171 maximum bounds. This is useful for values that increase slowly and fluctuate a
8172 bit while doing so. When these values come close to the threshold, they may
8173 "flap", i.e. switch between failure / warning case and okay case repeatedly.
8175 If, for example, the threshold is configures as
8180 then a I<Warning> notification is created when the value exceeds I<101> and the
8181 corresponding I<Okay> notification is only created once the value falls below
8182 I<99>, thus avoiding the "flapping".
8186 =head1 FILTER CONFIGURATION
8188 Starting with collectd 4.6 there is a powerful filtering infrastructure
8189 implemented in the daemon. The concept has mostly been copied from
8190 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
8191 terminology, so that users that are familiar with iptables feel right at home.
8195 The following are the terms used in the remainder of the filter configuration
8196 documentation. For an ASCII-art schema of the mechanism, see
8197 L<"General structure"> below.
8203 A I<match> is a criteria to select specific values. Examples are, of course, the
8204 name of the value or it's current value.
8206 Matches are implemented in plugins which you have to load prior to using the
8207 match. The name of such plugins starts with the "match_" prefix.
8211 A I<target> is some action that is to be performed with data. Such actions
8212 could, for example, be to change part of the value's identifier or to ignore
8213 the value completely.
8215 Some of these targets are built into the daemon, see L<"Built-in targets">
8216 below. Other targets are implemented in plugins which you have to load prior to
8217 using the target. The name of such plugins starts with the "target_" prefix.
8221 The combination of any number of matches and at least one target is called a
8222 I<rule>. The target actions will be performed for all values for which B<all>
8223 matches apply. If the rule does not have any matches associated with it, the
8224 target action will be performed for all values.
8228 A I<chain> is a list of rules and possibly default targets. The rules are tried
8229 in order and if one matches, the associated target will be called. If a value
8230 is handled by a rule, it depends on the target whether or not any subsequent
8231 rules are considered or if traversal of the chain is aborted, see
8232 L<"Flow control"> below. After all rules have been checked, the default targets
8237 =head2 General structure
8239 The following shows the resulting structure:
8246 +---------+ +---------+ +---------+ +---------+
8247 ! Rule !->! Match !->! Match !->! Target !
8248 +---------+ +---------+ +---------+ +---------+
8251 +---------+ +---------+ +---------+
8252 ! Rule !->! Target !->! Target !
8253 +---------+ +---------+ +---------+
8260 +---------+ +---------+ +---------+
8261 ! Rule !->! Match !->! Target !
8262 +---------+ +---------+ +---------+
8272 There are four ways to control which way a value takes through the filter
8279 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
8280 process the value with another chain. When the called chain finishes, usually
8281 the next target or rule after the jump is executed.
8285 The stop condition, signaled for example by the built-in target B<stop>, causes
8286 all processing of the value to be stopped immediately.
8290 Causes processing in the current chain to be aborted, but processing of the
8291 value generally will continue. This means that if the chain was called via
8292 B<Jump>, the next target or rule after the jump will be executed. If the chain
8293 was not called by another chain, control will be returned to the daemon and it
8294 may pass the value to another chain.
8298 Most targets will signal the B<continue> condition, meaning that processing
8299 should continue normally. There is no special built-in target for this
8306 The configuration reflects this structure directly:
8308 PostCacheChain "PostCache"
8310 <Rule "ignore_mysql_show">
8313 Type "^mysql_command$"
8314 TypeInstance "^show_"
8324 The above configuration example will ignore all values where the plugin field
8325 is "mysql", the type is "mysql_command" and the type instance begins with
8326 "show_". All other values will be sent to the C<rrdtool> write plugin via the
8327 default target of the chain. Since this chain is run after the value has been
8328 added to the cache, the MySQL C<show_*> command statistics will be available
8329 via the C<unixsock> plugin.
8331 =head2 List of configuration options
8335 =item B<PreCacheChain> I<ChainName>
8337 =item B<PostCacheChain> I<ChainName>
8339 Configure the name of the "pre-cache chain" and the "post-cache chain". The
8340 argument is the name of a I<chain> that should be executed before and/or after
8341 the values have been added to the cache.
8343 To understand the implications, it's important you know what is going on inside
8344 I<collectd>. The following diagram shows how values are passed from the
8345 read-plugins to the write-plugins:
8351 + - - - - V - - - - +
8352 : +---------------+ :
8355 : +-------+-------+ :
8358 : +-------+-------+ : +---------------+
8359 : ! Cache !--->! Value Cache !
8360 : ! insert ! : +---+---+-------+
8361 : +-------+-------+ : ! !
8362 : ! ,------------' !
8364 : +-------+---+---+ : +-------+-------+
8365 : ! Post-Cache +--->! Write-Plugins !
8366 : ! Chain ! : +---------------+
8367 : +---------------+ :
8370 + - - - - - - - - - +
8372 After the values are passed from the "read" plugins to the dispatch functions,
8373 the pre-cache chain is run first. The values are added to the internal cache
8374 afterwards. The post-cache chain is run after the values have been added to the
8375 cache. So why is it such a huge deal if chains are run before or after the
8376 values have been added to this cache?
8378 Targets that change the identifier of a value list should be executed before
8379 the values are added to the cache, so that the name in the cache matches the
8380 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8381 this cache to receive a list of all available values. If you change the
8382 identifier after the value list has been added to the cache, this may easily
8383 lead to confusion, but it's not forbidden of course.
8385 The cache is also used to convert counter values to rates. These rates are, for
8386 example, used by the C<value> match (see below). If you use the rate stored in
8387 the cache B<before> the new value is added, you will use the old, B<previous>
8388 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8389 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8392 Last but not last, the B<stop> target makes a difference: If the pre-cache
8393 chain returns the stop condition, the value will not be added to the cache and
8394 the post-cache chain will not be run.
8396 =item B<Chain> I<Name>
8398 Adds a new chain with a certain name. This name can be used to refer to a
8399 specific chain, for example to jump to it.
8401 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8403 =item B<Rule> [I<Name>]
8405 Adds a new rule to the current chain. The name of the rule is optional and
8406 currently has no meaning for the daemon.
8408 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8409 must be at least one B<Target> block.
8411 =item B<Match> I<Name>
8413 Adds a match to a B<Rule> block. The name specifies what kind of match should
8414 be performed. Available matches depend on the plugins that have been loaded.
8416 The arguments inside the B<Match> block are passed to the plugin implementing
8417 the match, so which arguments are valid here depends on the plugin being used.
8418 If you do not need any to pass any arguments to a match, you can use the
8423 Which is equivalent to:
8428 =item B<Target> I<Name>
8430 Add a target to a rule or a default target to a chain. The name specifies what
8431 kind of target is to be added. Which targets are available depends on the
8432 plugins being loaded.
8434 The arguments inside the B<Target> block are passed to the plugin implementing
8435 the target, so which arguments are valid here depends on the plugin being used.
8436 If you do not need any to pass any arguments to a target, you can use the
8441 This is the same as writing:
8448 =head2 Built-in targets
8450 The following targets are built into the core daemon and therefore need no
8451 plugins to be loaded:
8457 Signals the "return" condition, see the L<"Flow control"> section above. This
8458 causes the current chain to stop processing the value and returns control to
8459 the calling chain. The calling chain will continue processing targets and rules
8460 just after the B<jump> target (see below). This is very similar to the
8461 B<RETURN> target of iptables, see L<iptables(8)>.
8463 This target does not have any options.
8471 Signals the "stop" condition, see the L<"Flow control"> section above. This
8472 causes processing of the value to be aborted immediately. This is similar to
8473 the B<DROP> target of iptables, see L<iptables(8)>.
8475 This target does not have any options.
8483 Sends the value to "write" plugins.
8489 =item B<Plugin> I<Name>
8491 Name of the write plugin to which the data should be sent. This option may be
8492 given multiple times to send the data to more than one write plugin. If the
8493 plugin supports multiple instances, the plugin's instance(s) must also be
8498 If no plugin is explicitly specified, the values will be sent to all available
8501 Single-instance plugin example:
8507 Multi-instance plugin example:
8509 <Plugin "write_graphite">
8519 Plugin "write_graphite/foo"
8524 Starts processing the rules of another chain, see L<"Flow control"> above. If
8525 the end of that chain is reached, or a stop condition is encountered,
8526 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
8527 next target or the next rule. This is similar to the B<-j> command line option
8528 of iptables, see L<iptables(8)>.
8534 =item B<Chain> I<Name>
8536 Jumps to the chain I<Name>. This argument is required and may appear only once.
8548 =head2 Available matches
8554 Matches a value using regular expressions.
8560 =item B<Host> I<Regex>
8562 =item B<Plugin> I<Regex>
8564 =item B<PluginInstance> I<Regex>
8566 =item B<Type> I<Regex>
8568 =item B<TypeInstance> I<Regex>
8570 Match values where the given regular expressions match the various fields of
8571 the identifier of a value. If multiple regular expressions are given, B<all>
8572 regexen must match for a value to match.
8574 =item B<Invert> B<false>|B<true>
8576 When set to B<true>, the result of the match is inverted, i.e. all value lists
8577 where all regular expressions apply are not matched, all other value lists are
8578 matched. Defaults to B<false>.
8585 Host "customer[0-9]+"
8591 Matches values that have a time which differs from the time on the server.
8593 This match is mainly intended for servers that receive values over the
8594 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8595 is very sensitive to the timestamp used when updating the RRD files. In
8596 particular, the time must be ever increasing. If a misbehaving client sends one
8597 packet with a timestamp far in the future, all further packets with a correct
8598 time will be ignored because of that one packet. What's worse, such corrupted
8599 RRD files are hard to fix.
8601 This match lets one match all values B<outside> a specified time range
8602 (relative to the server's time), so you can use the B<stop> target (see below)
8603 to ignore the value, for example.
8609 =item B<Future> I<Seconds>
8611 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8612 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8615 =item B<Past> I<Seconds>
8617 Matches all values that are I<behind> of the server's time by I<Seconds> or
8618 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8630 This example matches all values that are five minutes or more ahead of the
8631 server or one hour (or more) lagging behind.
8635 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8636 values. If a data-set consists of more than one data-source, all data-sources
8637 must match the specified ranges for a positive match.
8643 =item B<Min> I<Value>
8645 Sets the smallest value which still results in a match. If unset, behaves like
8648 =item B<Max> I<Value>
8650 Sets the largest value which still results in a match. If unset, behaves like
8653 =item B<Invert> B<true>|B<false>
8655 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8656 no-match is returned and vice versa. Please note that the B<Invert> setting
8657 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8658 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8660 =item B<DataSource> I<DSName> [I<DSName> ...]
8662 Select one or more of the data sources. If no data source is configured, all
8663 data sources will be checked. If the type handled by the match does not have a
8664 data source of the specified name(s), this will always result in no match
8665 (independent of the B<Invert> setting).
8667 =item B<Satisfy> B<Any>|B<All>
8669 Specifies how checking with several data sources is performed. If set to
8670 B<Any>, the match succeeds if one of the data sources is in the configured
8671 range. If set to B<All> the match only succeeds if all data sources are within
8672 the configured range. Default is B<All>.
8674 Usually B<All> is used for positive matches, B<Any> is used for negative
8675 matches. This means that with B<All> you usually check that all values are in a
8676 "good" range, while with B<Any> you check if any value is within a "bad" range
8677 (or outside the "good" range).
8681 Either B<Min> or B<Max>, but not both, may be unset.
8685 # Match all values smaller than or equal to 100. Matches only if all data
8686 # sources are below 100.
8692 # Match if the value of any data source is outside the range of 0 - 100.
8700 =item B<empty_counter>
8702 Matches all values with one or more data sources of type B<COUNTER> and where
8703 all counter values are zero. These counters usually I<never> increased since
8704 they started existing (and are therefore uninteresting), or got reset recently
8705 or overflowed and you had really, I<really> bad luck.
8707 Please keep in mind that ignoring such counters can result in confusing
8708 behavior: Counters which hardly ever increase will be zero for long periods of
8709 time. If the counter is reset for some reason (machine or service restarted,
8710 usually), the graph will be empty (NAN) for a long time. People may not
8715 Calculates a hash value of the host name and matches values according to that
8716 hash value. This makes it possible to divide all hosts into groups and match
8717 only values that are in a specific group. The intended use is in load
8718 balancing, where you want to handle only part of all data and leave the rest
8721 The hashing function used tries to distribute the hosts evenly. First, it
8722 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8725 for (i = 0; host[i] != 0; i++)
8726 hash_value = (hash_value * 251) + host[i];
8728 The constant 251 is a prime number which is supposed to make this hash value
8729 more random. The code then checks the group for this host according to the
8730 I<Total> and I<Match> arguments:
8732 if ((hash_value % Total) == Match)
8737 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8738 groups), then the least significant bit of the hash value will be the XOR of
8739 all least significant bits in the host name. One consequence is that when you
8740 have two hosts, "server0.example.com" and "server1.example.com", where the host
8741 name differs in one digit only and the digits differ by one, those hosts will
8742 never end up in the same group.
8748 =item B<Match> I<Match> I<Total>
8750 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8751 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8752 be smaller than I<Total>. I<Total> must be at least one, although only values
8753 greater than one really do make any sense.
8755 You can repeat this option to match multiple groups, for example:
8760 The above config will divide the data into seven groups and match groups three
8761 and five. One use would be to keep every value on two hosts so that if one
8762 fails the missing data can later be reconstructed from the second host.
8768 # Operate on the pre-cache chain, so that ignored values are not even in the
8773 # Divide all received hosts in seven groups and accept all hosts in
8777 # If matched: Return and continue.
8780 # If not matched: Return and stop.
8786 =head2 Available targets
8790 =item B<notification>
8792 Creates and dispatches a notification.
8798 =item B<Message> I<String>
8800 This required option sets the message of the notification. The following
8801 placeholders will be replaced by an appropriate value:
8809 =item B<%{plugin_instance}>
8813 =item B<%{type_instance}>
8815 These placeholders are replaced by the identifier field of the same name.
8817 =item B<%{ds:>I<name>B<}>
8819 These placeholders are replaced by a (hopefully) human readable representation
8820 of the current rate of this data source. If you changed the instance name
8821 (using the B<set> or B<replace> targets, see below), it may not be possible to
8822 convert counter values to rates.
8826 Please note that these placeholders are B<case sensitive>!
8828 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8830 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8837 <Target "notification">
8838 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8844 Replaces parts of the identifier using regular expressions.
8850 =item B<Host> I<Regex> I<Replacement>
8852 =item B<Plugin> I<Regex> I<Replacement>
8854 =item B<PluginInstance> I<Regex> I<Replacement>
8856 =item B<TypeInstance> I<Regex> I<Replacement>
8858 Match the appropriate field with the given regular expression I<Regex>. If the
8859 regular expression matches, that part that matches is replaced with
8860 I<Replacement>. If multiple places of the input buffer match a given regular
8861 expression, only the first occurrence will be replaced.
8863 You can specify each option multiple times to use multiple regular expressions
8871 # Replace "example.net" with "example.com"
8872 Host "\\<example.net\\>" "example.com"
8874 # Strip "www." from hostnames
8880 Sets part of the identifier of a value to a given string.
8886 =item B<Host> I<String>
8888 =item B<Plugin> I<String>
8890 =item B<PluginInstance> I<String>
8892 =item B<TypeInstance> I<String>
8894 Set the appropriate field to the given string. The strings for plugin instance
8895 and type instance may be empty, the strings for host and plugin may not be
8896 empty. It's currently not possible to set the type of a value this way.
8903 PluginInstance "coretemp"
8904 TypeInstance "core3"
8909 =head2 Backwards compatibility
8911 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8912 B<Chain> block, it will behave as it used to. This is equivalent to the
8913 following configuration:
8919 If you specify a B<PostCacheChain>, the B<write> target will not be added
8920 anywhere and you will have to make sure that it is called where appropriate. We
8921 suggest to add the above snippet as default target to your "PostCache" chain.
8925 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8941 L<collectd-exec(5)>,
8942 L<collectd-perl(5)>,
8943 L<collectd-unixsock(5)>,
8956 Florian Forster E<lt>octo@collectd.orgE<gt>