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.
135 =item B<AutoLoadPlugin> B<false>|B<true>
137 When set to B<false> (the default), each plugin needs to be loaded explicitly,
138 using the B<LoadPlugin> statement documented above. If a
139 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
140 handling callback for this plugin has been registered, a warning is logged and
141 the block is ignored.
143 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
144 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
145 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
146 plugins that don't provide any configuration, e.g. the I<Load plugin>.
148 =item B<CollectInternalStats> B<false>|B<true>
150 When set to B<true>, various statistics about the I<collectd> daemon will be
151 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
153 The following metrics are reported:
157 =item C<collectd-write_queue/queue_length>
159 The number of metrics currently in the write queue. You can limit the queue
160 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
162 =item C<collectd-write_queue/derive-dropped>
164 The number of metrics dropped due to a queue length limitation.
165 If this value is non-zero, your system can't handle all incoming metrics and
166 protects itself against overload by dropping metrics.
168 =item C<collectd-cache/cache_size>
170 The number of elements in the metric cache (the cache you can interact with
171 using L<collectd-unixsock(5)>).
175 =item B<Include> I<Path> [I<pattern>]
177 If I<Path> points to a file, includes that file. If I<Path> points to a
178 directory, recursively includes all files within that directory and its
179 subdirectories. If the C<wordexp> function is available on your system,
180 shell-like wildcards are expanded before files are included. This means you can
181 use statements like the following:
183 Include "/etc/collectd.d/*.conf"
185 Starting with version 5.3, this may also be a block in which further options
186 affecting the behavior of B<Include> may be specified. The following option is
189 <Include "/etc/collectd.d">
195 =item B<Filter> I<pattern>
197 If the C<fnmatch> function is available on your system, a shell-like wildcard
198 I<pattern> may be specified to filter which files to include. This may be used
199 in combination with recursively including a directory to easily be able to
200 arbitrarily mix configuration files and other documents (e.g. README files).
201 The given example is similar to the first example above but includes all files
202 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
206 If more than one files are included by a single B<Include> option, the files
207 will be included in lexicographical order (as defined by the C<strcmp>
208 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
209 order in which the files are loaded.
211 To prevent loops and shooting yourself in the foot in interesting ways the
212 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
213 most uses. Since symlinks are followed it is still possible to crash the daemon
214 by looping symlinks. In our opinion significant stupidity should result in an
215 appropriate amount of pain.
217 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
218 file, but you cannot include files from within blocks.
220 =item B<PIDFile> I<File>
222 Sets where to write the PID file to. This file is overwritten when it exists
223 and deleted when the program is stopped. Some init-scripts might override this
224 setting using the B<-P> command-line option.
226 =item B<PluginDir> I<Directory>
228 Path to the plugins (shared objects) of collectd.
230 =item B<TypesDB> I<File> [I<File> ...]
232 Set one or more files that contain the data-set descriptions. See
233 L<types.db(5)> for a description of the format of this file.
235 =item B<Interval> I<Seconds>
237 Configures the interval in which to query the read plugins. Obviously smaller
238 values lead to a higher system load produced by collectd, while higher values
239 lead to more coarse statistics.
241 B<Warning:> You should set this once and then never touch it again. If you do,
242 I<you will have to delete all your RRD files> or know some serious RRDtool
243 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
245 =item B<MaxReadInterval> I<Seconds>
247 Read plugin doubles interval between queries after each failed attempt
250 This options limits the maximum value of the interval. The default value is
253 =item B<Timeout> I<Iterations>
255 Consider a value list "missing" when no update has been read or received for
256 I<Iterations> iterations. By default, I<collectd> considers a value list
257 missing when no update has been received for twice the update interval. Since
258 this setting uses iterations, the maximum allowed time without update depends
259 on the I<Interval> information contained in each value list. This is used in
260 the I<Threshold> configuration to dispatch notifications about missing values,
261 see L<collectd-threshold(5)> for details.
263 =item B<ReadThreads> I<Num>
265 Number of threads to start for reading plugins. The default value is B<5>, but
266 you may want to increase this if you have more than five plugins that take a
267 long time to read. Mostly those are plugins that do network-IO. Setting this to
268 a value higher than the number of registered read callbacks is not recommended.
270 =item B<WriteThreads> I<Num>
272 Number of threads to start for dispatching value lists to write plugins. The
273 default value is B<5>, but you may want to increase this if you have more than
274 five plugins that may take relatively long to write to.
276 =item B<WriteQueueLimitHigh> I<HighNum>
278 =item B<WriteQueueLimitLow> I<LowNum>
280 Metrics are read by the I<read threads> and then put into a queue to be handled
281 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
282 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
283 running into memory issues in such a case, you can limit the size of this
286 By default, there is no limit and memory may grow indefinitely. This is most
287 likely not an issue for clients, i.e. instances that only handle the local
288 metrics. For servers it is recommended to set this to a non-zero value, though.
290 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
291 Each of them takes a numerical argument which is the number of metrics in the
292 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
293 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
294 I<will> be enqueued. If the number of metrics currently in the queue is between
295 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
296 proportional to the number of metrics in the queue (i.e. it increases linearly
297 until it reaches 100%.)
299 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
300 unset, the latter will default to half of B<WriteQueueLimitHigh>.
302 If you do not want to randomly drop values when the queue size is between
303 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
306 Enabling the B<CollectInternalStats> option is of great help to figure out the
307 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
309 =item B<Hostname> I<Name>
311 Sets the hostname that identifies a host. If you omit this setting, the
312 hostname will be determined using the L<gethostname(2)> system call.
314 =item B<FQDNLookup> B<true|false>
316 If B<Hostname> is determined automatically this setting controls whether or not
317 the daemon should try to figure out the "fully qualified domain name", FQDN.
318 This is done using a lookup of the name returned by C<gethostname>. This option
319 is enabled by default.
321 =item B<PreCacheChain> I<ChainName>
323 =item B<PostCacheChain> I<ChainName>
325 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
326 see L<FILTER CONFIGURATION> below on information on chains and how these
327 setting change the daemon's behavior.
331 =head1 PLUGIN OPTIONS
333 Some plugins may register own options. These options must be enclosed in a
334 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
335 require external configuration, too. The C<apache plugin>, for example,
336 required C<mod_status> to be configured in the webserver you're going to
337 collect data from. These plugins are listed below as well, even if they don't
338 require any configuration within collectd's configuration file.
340 A list of all plugins and a short summary for each plugin can be found in the
341 F<README> file shipped with the sourcecode and hopefully binary packets as
344 =head2 Plugin C<aggregation>
346 The I<Aggregation plugin> makes it possible to aggregate several values into
347 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
348 This can be put to a wide variety of uses, e.g. average and total CPU
349 statistics for your entire fleet.
351 The grouping is powerful but, as with many powerful tools, may be a bit
352 difficult to wrap your head around. The grouping will therefore be
353 demonstrated using an example: The average and sum of the CPU usage across
354 all CPUs of each host is to be calculated.
356 To select all the affected values for our example, set C<Plugin cpu> and
357 C<Type cpu>. The other values are left unspecified, meaning "all values". The
358 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
359 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
365 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
366 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
367 example, the intention is to have a new value for each host / type instance
368 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
369 It can be specified multiple times to group by more than one field.
372 GroupBy "TypeInstance"
374 We do neither specify nor group by I<plugin instance> (the CPU number), so all
375 metrics that differ in the CPU number only will be aggregated. Each
376 aggregation needs I<at least one> such field, otherwise no aggregation would
379 The full example configuration looks like this:
381 <Plugin "aggregation">
387 GroupBy "TypeInstance"
390 CalculateAverage true
394 There are a couple of limitations you should be aware of:
400 The I<Type> cannot be left unspecified, because it is not reasonable to add
401 apples to oranges. Also, the internal lookup structure won't work if you try
406 There must be at least one unspecified, ungrouped field. Otherwise nothing
411 As you can see in the example above, each aggregation has its own
412 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
413 blocks may match the same values, i.e. one value list can update multiple
414 aggregations. The following options are valid inside B<Aggregation> blocks:
418 =item B<Host> I<Host>
420 =item B<Plugin> I<Plugin>
422 =item B<PluginInstance> I<PluginInstance>
424 =item B<Type> I<Type>
426 =item B<TypeInstance> I<TypeInstance>
428 Selects the value lists to be added to this aggregation. B<Type> must be a
429 valid data set name, see L<types.db(5)> for details.
431 If the string starts with and ends with a slash (C</>), the string is
432 interpreted as a I<regular expression>. The regex flavor used are POSIX
433 extended regular expressions as described in L<regex(7)>. Example usage:
435 Host "/^db[0-9]\\.example\\.com$/"
437 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
439 Group valued by the specified field. The B<GroupBy> option may be repeated to
440 group by multiple fields.
442 =item B<SetHost> I<Host>
444 =item B<SetPlugin> I<Plugin>
446 =item B<SetPluginInstance> I<PluginInstance>
448 =item B<SetTypeInstance> I<TypeInstance>
450 Sets the appropriate part of the identifier to the provided string.
452 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
453 will be replaced with the aggregation function, e.g. "average". Not including
454 the placeholder will result in duplication warnings and/or messed up values if
455 more than one aggregation function are enabled.
457 The following example calculates the average usage of all "even" CPUs:
459 <Plugin "aggregation">
462 PluginInstance "/[0,2,4,6,8]$/"
466 SetPluginInstance "even-%{aggregation}"
469 GroupBy "TypeInstance"
471 CalculateAverage true
475 This will create the files:
481 foo.example.com/cpu-even-average/cpu-idle
485 foo.example.com/cpu-even-average/cpu-system
489 foo.example.com/cpu-even-average/cpu-user
497 =item B<CalculateNum> B<true>|B<false>
499 =item B<CalculateSum> B<true>|B<false>
501 =item B<CalculateAverage> B<true>|B<false>
503 =item B<CalculateMinimum> B<true>|B<false>
505 =item B<CalculateMaximum> B<true>|B<false>
507 =item B<CalculateStddev> B<true>|B<false>
509 Boolean options for enabling calculation of the number of value lists, their
510 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
511 are disabled by default.
515 =head2 Plugin C<amqp>
517 The I<AMQP plugin> can be used to communicate with other instances of
518 I<collectd> or third party applications using an AMQP message broker. Values
519 are sent to or received from the broker, which handles routing, queueing and
520 possibly filtering or messages.
523 # Send values to an AMQP broker
524 <Publish "some_name">
530 Exchange "amq.fanout"
531 # ExchangeType "fanout"
532 # RoutingKey "collectd"
534 # ConnectionRetryDelay 0
537 # GraphitePrefix "collectd."
538 # GraphiteEscapeChar "_"
539 # GraphiteSeparateInstances false
540 # GraphiteAlwaysAppendDS false
543 # Receive values from an AMQP broker
544 <Subscribe "some_name">
550 Exchange "amq.fanout"
551 # ExchangeType "fanout"
554 # QueueAutoDelete true
555 # RoutingKey "collectd.#"
556 # ConnectionRetryDelay 0
560 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
561 blocks, which configure sending and receiving of values respectively. The two
562 blocks are very similar, so unless otherwise noted, an option can be used in
563 either block. The name given in the blocks starting tag is only used for
564 reporting messages, but may be used to support I<flushing> of certain
565 I<Publish> blocks in the future.
569 =item B<Host> I<Host>
571 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
572 the underlying communications library, I<rabbitmq-c>, which is "localhost".
574 =item B<Port> I<Port>
576 Service name or port number on which the AMQP broker accepts connections. This
577 argument must be a string, even if the numeric form is used. Defaults to
580 =item B<VHost> I<VHost>
582 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
584 =item B<User> I<User>
586 =item B<Password> I<Password>
588 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
591 =item B<Exchange> I<Exchange>
593 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
594 By default, "amq.fanout" will be used.
596 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
597 the given exchange and the I<queue> is created, using the I<routing key> if
598 configured. See the B<Queue> and B<RoutingKey> options below.
600 =item B<ExchangeType> I<Type>
602 If given, the plugin will try to create the configured I<exchange> with this
603 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
604 be bound to this exchange.
606 =item B<Queue> I<Queue> (Subscribe only)
608 Configures the I<queue> name to subscribe to. If no queue name was configured
609 explicitly, a unique queue name will be created by the broker.
611 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
613 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
614 or transient (will disappear if the AMQP broker is restarted). Defaults to
617 This option should be used in conjunction with the I<Persistent> option on the
620 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
622 Defines if the I<queue> subscribed to will be deleted once the last consumer
623 unsubscribes. Defaults to "true".
625 =item B<RoutingKey> I<Key>
627 In I<Publish> blocks, this configures the routing key to set on all outgoing
628 messages. If not given, the routing key will be computed from the I<identifier>
629 of the value. The host, plugin, type and the two instances are concatenated
630 together using dots as the separator and all containing dots replaced with
631 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
632 possible to receive only specific values using a "topic" exchange.
634 In I<Subscribe> blocks, configures the I<routing key> used when creating a
635 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
636 used to filter messages when using a "topic" exchange. If you're only
637 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
640 =item B<Persistent> B<true>|B<false> (Publish only)
642 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
643 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
644 default), the I<transient> delivery mode will be used, i.e. messages may be
645 lost due to high load, overflowing queues or similar issues.
647 =item B<ConnectionRetryDelay> I<Delay>
649 When the connection to the AMQP broker is lost, defines the time in seconds to
650 wait before attempting to reconnect. Defaults to 0, which implies collectd will
651 attempt to reconnect at each read interval (in Subscribe mode) or each time
652 values are ready for submission (in Publish mode).
654 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
656 Selects the format in which messages are sent to the broker. If set to
657 B<Command> (the default), values are sent as C<PUTVAL> commands which are
658 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
659 case, the C<Content-Type> header field will be set to C<text/collectd>.
661 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
662 an easy and straight forward exchange format. The C<Content-Type> header field
663 will be set to C<application/json>.
665 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
666 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
669 A subscribing client I<should> use the C<Content-Type> header field to
670 determine how to decode the values. Currently, the I<AMQP plugin> itself can
671 only decode the B<Command> format.
673 =item B<StoreRates> B<true>|B<false> (Publish only)
675 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
676 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
677 default), no conversion is performed. Otherwise the conversion is performed
678 using the internal value cache.
680 Please note that currently this option is only used if the B<Format> option has
683 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
685 A prefix can be added in the metric name when outputting in the I<Graphite> format.
686 It's added before the I<Host> name.
687 Metric name will be "<prefix><host><postfix><plugin><type><name>"
689 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
691 A postfix can be added in the metric name when outputting in the I<Graphite> format.
692 It's added after the I<Host> name.
693 Metric name will be "<prefix><host><postfix><plugin><type><name>"
695 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
697 Specify a character to replace dots (.) in the host part of the metric name.
698 In I<Graphite> metric name, dots are used as separators between different
699 metric parts (host, plugin, type).
700 Default is "_" (I<Underscore>).
702 =item B<GraphiteSeparateInstances> B<true>|B<false>
704 If set to B<true>, the plugin instance and type instance will be in their own
705 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
706 default), the plugin and plugin instance (and likewise the type and type
707 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
709 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
711 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
712 identifier. If set to B<false> (the default), this is only done when there is
717 =head2 Plugin C<apache>
719 To configure the C<apache>-plugin you first need to configure the Apache
720 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
721 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
722 the following snipped to base your Apache config upon:
725 <IfModule mod_status.c>
726 <Location /mod_status>
727 SetHandler server-status
731 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
732 also supported. It introduces a new field, called C<BusyServers>, to count the
733 number of currently connected clients. This field is also supported.
735 The configuration of the I<Apache> plugin consists of one or more
736 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
737 as the instance name. For example:
741 URL "http://www1.example.com/mod_status?auto"
744 URL "http://www2.example.com/mod_status?auto"
748 The instance name will be used as the I<plugin instance>. To emulate the old
749 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
750 plugin to work correctly, each instance name must be unique. This is not
751 enforced by the plugin and it is your responsibility to ensure it.
753 The following options are accepted within each I<Instance> block:
757 =item B<URL> I<http://host/mod_status?auto>
759 Sets the URL of the C<mod_status> output. This needs to be the output generated
760 by C<ExtendedStatus on> and it needs to be the machine readable output
761 generated by appending the C<?auto> argument. This option is I<mandatory>.
763 =item B<User> I<Username>
765 Optional user name needed for authentication.
767 =item B<Password> I<Password>
769 Optional password needed for authentication.
771 =item B<VerifyPeer> B<true|false>
773 Enable or disable peer SSL certificate verification. See
774 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
776 =item B<VerifyHost> B<true|false>
778 Enable or disable peer host name verification. If enabled, the plugin checks
779 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
780 certificate matches the host name provided by the B<URL> option. If this
781 identity check fails, the connection is aborted. Obviously, only works when
782 connecting to a SSL enabled server. Enabled by default.
784 =item B<CACert> I<File>
786 File that holds one or more SSL certificates. If you want to use HTTPS you will
787 possibly need this option. What CA certificates come bundled with C<libcurl>
788 and are checked by default depends on the distribution you use.
790 =item B<SSLCiphers> I<list of ciphers>
792 Specifies which ciphers to use in the connection. The list of ciphers
793 must specify valid ciphers. See
794 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
796 =item B<Timeout> I<Milliseconds>
798 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
799 milliseconds. By default, the configured B<Interval> is used to set the
804 =head2 Plugin C<apcups>
808 =item B<Host> I<Hostname>
810 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
811 that IPv6 support has been disabled unless someone can confirm or decline that
812 B<apcupsd> can handle it.
814 =item B<Port> I<Port>
816 TCP-Port to connect to. Defaults to B<3551>.
818 =item B<ReportSeconds> B<true|false>
820 If set to B<true>, the time reported in the C<timeleft> metric will be
821 converted to seconds. This is the recommended setting. If set to B<false>, the
822 default for backwards compatibility, the time will be reported in minutes.
826 =head2 Plugin C<aquaero>
828 This plugin collects the value of the available sensors in an
829 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
830 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
831 connection for monitoring and configuration. The board can handle multiple
832 temperature sensors, fans, water pumps and water level sensors and adjust the
833 output settings such as fan voltage or power used by the water pump based on
834 the available inputs using a configurable controller included in the board.
835 This plugin collects all the available inputs as well as some of the output
836 values chosen by this controller. The plugin is based on the I<libaquaero5>
837 library provided by I<aquatools-ng>.
841 =item B<Device> I<DevicePath>
843 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
844 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
845 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
849 =head2 Plugin C<ascent>
851 This plugin collects information about an Ascent server, a free server for the
852 "World of Warcraft" game. This plugin gathers the information by fetching the
853 XML status page using C<libcurl> and parses it using C<libxml2>.
855 The configuration options are the same as for the C<apache> plugin above:
859 =item B<URL> I<http://localhost/ascent/status/>
861 Sets the URL of the XML status output.
863 =item B<User> I<Username>
865 Optional user name needed for authentication.
867 =item B<Password> I<Password>
869 Optional password needed for authentication.
871 =item B<VerifyPeer> B<true|false>
873 Enable or disable peer SSL certificate verification. See
874 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
876 =item B<VerifyHost> B<true|false>
878 Enable or disable peer host name verification. If enabled, the plugin checks
879 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
880 certificate matches the host name provided by the B<URL> option. If this
881 identity check fails, the connection is aborted. Obviously, only works when
882 connecting to a SSL enabled server. Enabled by default.
884 =item B<CACert> I<File>
886 File that holds one or more SSL certificates. If you want to use HTTPS you will
887 possibly need this option. What CA certificates come bundled with C<libcurl>
888 and are checked by default depends on the distribution you use.
890 =item B<Timeout> I<Milliseconds>
892 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
893 milliseconds. By default, the configured B<Interval> is used to set the
898 =head2 Plugin C<barometer>
900 This plugin reads absolute air pressure using digital barometer sensor on a I2C
901 bus. Supported sensors are:
905 =item I<MPL115A2> from Freescale,
906 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
909 =item I<MPL3115> from Freescale
910 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
913 =item I<BMP085> from Bosch Sensortec
917 The sensor type - one of the above - is detected automatically by the plugin
918 and indicated in the plugin_instance (you will see subdirectory
919 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
920 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
921 (only one sensor can be used by the plugin).
923 The plugin provides absolute barometric pressure, air pressure reduced to sea
924 level (several possible approximations) and as an auxiliary value also internal
925 sensor temperature. It uses (expects/provides) typical metric units - pressure
926 in [hPa], temperature in [C], altitude in [m].
928 It was developed and tested under Linux only. The only platform dependency is
929 the standard Linux i2c-dev interface (the particular bus driver has to
930 support the SM Bus command subset).
932 The reduction or normalization to mean sea level pressure requires (depending
933 on selected method/approximation) also altitude and reference to temperature
934 sensor(s). When multiple temperature sensors are configured the minumum of
935 their values is always used (expecting that the warmer ones are affected by
936 e.g. direct sun light at that moment).
944 TemperatureOffset 0.0
947 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
952 =item B<Device> I<device>
954 The only mandatory configuration parameter.
956 Device name of the I2C bus to which the sensor is connected. Note that
957 typically you need to have loaded the i2c-dev module.
958 Using i2c-tools you can check/list i2c buses available on your system by:
962 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
966 This way you should be able to verify that the pressure sensor (either type) is
967 connected and detected on address 0x60.
969 =item B<Oversampling> I<value>
971 Optional parameter controlling the oversampling/accuracy. Default value
972 is 1 providing fastest and least accurate reading.
974 For I<MPL115> this is the size of the averaging window. To filter out sensor
975 noise a simple averaging using floating window of this configurable size is
976 used. The plugin will use average of the last C<value> measurements (value of 1
977 means no averaging). Minimal size is 1, maximal 1024.
979 For I<MPL3115> this is the oversampling value. The actual oversampling is
980 performed by the sensor and the higher value the higher accuracy and longer
981 conversion time (although nothing to worry about in the collectd context).
982 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
983 adjusted by the plugin to the closest supported one.
985 For I<BMP085> this is the oversampling value. The actual oversampling is
986 performed by the sensor and the higher value the higher accuracy and longer
987 conversion time (although nothing to worry about in the collectd context).
988 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
989 the closest supported one.
991 =item B<PressureOffset> I<offset>
993 Optional parameter for MPL3115 only.
995 You can further calibrate the sensor by supplying pressure and/or temperature
996 offsets. This is added to the measured/caclulated value (i.e. if the measured
997 value is too high then use negative offset).
998 In hPa, default is 0.0.
1000 =item B<TemperatureOffset> I<offset>
1002 Optional parameter for MPL3115 only.
1004 You can further calibrate the sensor by supplying pressure and/or temperature
1005 offsets. This is added to the measured/caclulated value (i.e. if the measured
1006 value is too high then use negative offset).
1007 In C, default is 0.0.
1009 =item B<Normalization> I<method>
1011 Optional parameter, default value is 0.
1013 Normalization method - what approximation/model is used to compute the mean sea
1014 level pressure from the air absolute pressure.
1016 Supported values of the C<method> (integer between from 0 to 2) are:
1020 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1021 do not need to configure C<Altitude> or C<TemperatureSensor>.
1023 =item B<1> - international formula for conversion ,
1025 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1026 For this method you have to configure C<Altitude> but do not need
1027 C<TemperatureSensor> (uses fixed global temperature average instead).
1029 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1030 Meteorological Service).
1031 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1032 For this method you have to configure both C<Altitude> and
1033 C<TemperatureSensor>.
1038 =item B<Altitude> I<altitude>
1040 The altitude (in meters) of the location where you meassure the pressure.
1042 =item B<TemperatureSensor> I<reference>
1044 Temperature sensor(s) which should be used as a reference when normalizing the
1045 pressure using C<Normalization> method 2.
1046 When specified more sensors a minumum is found and used each time. The
1047 temperature reading directly from this pressure sensor/plugin is typically not
1048 suitable as the pressure sensor will be probably inside while we want outside
1049 temperature. The collectd reference name is something like
1050 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1051 (<type_instance> is usually omitted when there is just single value type). Or
1052 you can figure it out from the path of the output data files.
1056 =head2 Plugin C<battery>
1058 The I<battery plugin> reports the remaining capacity, power and voltage of
1063 =item B<ValuesPercentage> B<false>|B<true>
1065 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1066 capacity remaining". Otherwise the capacity is stored as reported by the
1067 battery, most likely in "Wh". This option does not work with all input methods,
1068 in particular when only C</proc/pmu> is available on an old Linux system.
1069 Defaults to B<false>.
1071 =item B<ReportDegraded> B<false>|B<true>
1073 Typical laptop batteries degrade over time, meaning the capacity decreases with
1074 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1075 "last full capacity" and used to determine that a battery is "fully charged".
1077 When this option is set to B<false>, the default, the I<battery plugin> will
1078 only report the remaining capacity. If the B<ValuesPercentage> option is
1079 enabled, the relative remaining capacity is calculated as the ratio of the
1080 "remaining capacity" and the "last full capacity". This is what most tools,
1081 such as the status bar of desktop environments, also do.
1083 When set to B<true>, the battery plugin will report three values: B<charged>
1084 (remaining capacity), B<discharged> (difference between "last full capacity"
1085 and "remaining capacity") and B<degraded> (difference between "design capacity"
1086 and "last full capacity").
1090 =head2 Plugin C<bind>
1092 Starting with BIND 9.5.0, the most widely used DNS server software provides
1093 extensive statistics about queries, responses and lots of other information.
1094 The bind plugin retrieves this information that's encoded in XML and provided
1095 via HTTP and submits the values to collectd.
1097 To use this plugin, you first need to tell BIND to make this information
1098 available. This is done with the C<statistics-channels> configuration option:
1100 statistics-channels {
1101 inet localhost port 8053;
1104 The configuration follows the grouping that can be seen when looking at the
1105 data with an XSLT compatible viewer, such as a modern web browser. It's
1106 probably a good idea to make yourself familiar with the provided values, so you
1107 can understand what the collected statistics actually mean.
1112 URL "http://localhost:8053/"
1127 Zone "127.in-addr.arpa/IN"
1131 The bind plugin accepts the following configuration options:
1137 URL from which to retrieve the XML data. If not specified,
1138 C<http://localhost:8053/> will be used.
1140 =item B<ParseTime> B<true>|B<false>
1142 When set to B<true>, the time provided by BIND will be parsed and used to
1143 dispatch the values. When set to B<false>, the local time source is queried.
1145 This setting is set to B<true> by default for backwards compatibility; setting
1146 this to B<false> is I<recommended> to avoid problems with timezones and
1149 =item B<OpCodes> B<true>|B<false>
1151 When enabled, statistics about the I<"OpCodes">, for example the number of
1152 C<QUERY> packets, are collected.
1156 =item B<QTypes> B<true>|B<false>
1158 When enabled, the number of I<incoming> queries by query types (for example
1159 C<A>, C<MX>, C<AAAA>) is collected.
1163 =item B<ServerStats> B<true>|B<false>
1165 Collect global server statistics, such as requests received over IPv4 and IPv6,
1166 successful queries, and failed updates.
1170 =item B<ZoneMaintStats> B<true>|B<false>
1172 Collect zone maintenance statistics, mostly information about notifications
1173 (zone updates) and zone transfers.
1177 =item B<ResolverStats> B<true>|B<false>
1179 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1180 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1181 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1182 default. Use the B<ResolverStats> option within a B<View "_default"> block
1183 instead for the same functionality.
1187 =item B<MemoryStats>
1189 Collect global memory statistics.
1193 =item B<Timeout> I<Milliseconds>
1195 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1196 milliseconds. By default, the configured B<Interval> is used to set the
1199 =item B<View> I<Name>
1201 Collect statistics about a specific I<"view">. BIND can behave different,
1202 mostly depending on the source IP-address of the request. These different
1203 configurations are called "views". If you don't use this feature, you most
1204 likely are only interested in the C<_default> view.
1206 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1207 information you want to collect about a view. If no B<View> block is
1208 configured, no detailed view statistics will be collected.
1212 =item B<QTypes> B<true>|B<false>
1214 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1215 C<MX>) is collected.
1219 =item B<ResolverStats> B<true>|B<false>
1221 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1222 (e.E<nbsp>g. queries over IPv4, lame servers).
1226 =item B<CacheRRSets> B<true>|B<false>
1228 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1229 type is collected. Negative entries (queries which resulted in an error, for
1230 example names that do not exist) are reported with a leading exclamation mark,
1235 =item B<Zone> I<Name>
1237 When given, collect detailed information about the given zone in the view. The
1238 information collected if very similar to the global B<ServerStats> information
1241 You can repeat this option to collect detailed information about multiple
1244 By default no detailed zone information is collected.
1250 =head2 Plugin C<ceph>
1252 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1253 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1255 A separate B<Daemon> block must be configured for each ceph daemon to be
1256 monitored. The following example will read daemon statistics from four
1257 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1260 LongRunAvgLatency false
1261 ConvertSpecialMetricTypes true
1263 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1266 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1269 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1272 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1276 The ceph plugin accepts the following configuration options:
1280 =item B<LongRunAvgLatency> B<true>|B<false>
1282 If enabled, latency values(sum,count pairs) are calculated as the long run
1283 average - average since the ceph daemon was started = (sum / count).
1284 When disabled, latency values are calculated as the average since the last
1285 collection = (sum_now - sum_last) / (count_now - count_last).
1289 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1291 If enabled, special metrics (metrics that differ in type from similar counters)
1292 are converted to the type of those similar counters. This currently only
1293 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1294 ceph schema reports this metric type as a sum,count pair while similar counters
1295 are treated as derive types. When converted, the sum is used as the counter
1296 value and is treated as a derive type.
1297 When disabled, all metrics are treated as the types received from the ceph schema.
1303 Each B<Daemon> block must have a string argument for the plugin instance name.
1304 A B<SocketPath> is also required for each B<Daemon> block:
1308 =item B<Daemon> I<DaemonName>
1310 Name to be used as the instance name for this daemon.
1312 =item B<SocketPath> I<SocketPath>
1314 Specifies the path to the UNIX admin socket of the ceph daemon.
1318 =head2 Plugin C<cgroups>
1320 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1321 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1322 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1326 =item B<CGroup> I<Directory>
1328 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1329 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1332 =item B<IgnoreSelected> B<true>|B<false>
1334 Invert the selection: If set to true, all cgroups I<except> the ones that
1335 match any one of the criteria are collected. By default only selected
1336 cgroups are collected if a selection is made. If no selection is configured
1337 at all, B<all> cgroups are selected.
1341 =head2 Plugin C<conntrack>
1343 This plugin collects IP conntrack statistics.
1349 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1350 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1354 =head2 Plugin C<cpu>
1356 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1357 as Jiffies, using the C<cpu> type. Two aggregations are available:
1363 Sum, per-state, over all CPUs installed in the system; and
1367 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1371 The two aggregations can be combined, leading to I<collectd> only emitting a
1372 single "active" metric for the entire system. As soon as one of these
1373 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1374 rather than Jiffies. In addition, you can request individual, per-state,
1375 per-CPU metrics to be reported as percentage.
1377 The following configuration options are available:
1381 =item B<ReportByState> B<true>|B<false>
1383 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1385 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1388 =item B<ReportByCpu> B<true>|B<false>
1390 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1391 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1392 global sum of CPU states is emitted.
1394 =item B<ValuesPercentage> B<false>|B<true>
1396 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1397 are set to B<true>. In this case, by default, metrics will be reported as
1398 Jiffies. By setting this option to B<true>, you can request percentage values
1399 in the un-aggregated (per-CPU, per-state) mode as well.
1403 =head2 Plugin C<cpufreq>
1405 This plugin doesn't have any options. It reads
1406 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1407 installed) to get the current CPU frequency. If this file does not exist make
1408 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1409 installed and an "cpu governor" (that's a kernel module) is loaded.
1411 =head2 Plugin C<csv>
1415 =item B<DataDir> I<Directory>
1417 Set the directory to store CSV-files under. Per default CSV-files are generated
1418 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1419 The special strings B<stdout> and B<stderr> can be used to write to the standard
1420 output and standard error channels, respectively. This, of course, only makes
1421 much sense when collectd is running in foreground- or non-daemon-mode.
1423 =item B<StoreRates> B<true|false>
1425 If set to B<true>, convert counter values to rates. If set to B<false> (the
1426 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1431 =head2 Plugin C<curl>
1433 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1434 and the match infrastructure (the same code used by the tail plugin) to use
1435 regular expressions with the received data.
1437 The following example will read the current value of AMD stock from Google's
1438 finance page and dispatch the value to collectd.
1441 <Page "stock_quotes">
1442 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1448 CACert "/path/to/ca.crt"
1449 Header "X-Custom-Header: foobar"
1452 MeasureResponseTime false
1453 MeasureResponseCode false
1456 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1457 DSType "GaugeAverage"
1458 # Note: `stock_value' is not a standard type.
1465 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1466 a web page and one or more "matches" to be performed on the returned data. The
1467 string argument to the B<Page> block is used as plugin instance.
1469 The following options are valid within B<Page> blocks:
1475 URL of the web site to retrieve. Since a regular expression will be used to
1476 extract information from this data, non-binary data is a big plus here ;)
1478 =item B<User> I<Name>
1480 Username to use if authorization is required to read the page.
1482 =item B<Password> I<Password>
1484 Password to use if authorization is required to read the page.
1486 =item B<Digest> B<true>|B<false>
1488 Enable HTTP digest authentication.
1490 =item B<VerifyPeer> B<true>|B<false>
1492 Enable or disable peer SSL certificate verification. See
1493 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1495 =item B<VerifyHost> B<true>|B<false>
1497 Enable or disable peer host name verification. If enabled, the plugin checks if
1498 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1499 matches the host name provided by the B<URL> option. If this identity check
1500 fails, the connection is aborted. Obviously, only works when connecting to a
1501 SSL enabled server. Enabled by default.
1503 =item B<CACert> I<file>
1505 File that holds one or more SSL certificates. If you want to use HTTPS you will
1506 possibly need this option. What CA certificates come bundled with C<libcurl>
1507 and are checked by default depends on the distribution you use.
1509 =item B<Header> I<Header>
1511 A HTTP header to add to the request. Multiple headers are added if this option
1512 is specified more than once.
1514 =item B<Post> I<Body>
1516 Specifies that the HTTP operation should be a POST instead of a GET. The
1517 complete data to be posted is given as the argument. This option will usually
1518 need to be accompanied by a B<Header> option to set an appropriate
1519 C<Content-Type> for the post body (e.g. to
1520 C<application/x-www-form-urlencoded>).
1522 =item B<MeasureResponseTime> B<true>|B<false>
1524 Measure response time for the request. If this setting is enabled, B<Match>
1525 blocks (see below) are optional. Disabled by default.
1527 Beware that requests will get aborted if they take too long to complete. Adjust
1528 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1531 =item B<MeasureResponseCode> B<true>|B<false>
1533 Measure response code for the request. If this setting is enabled, B<Match>
1534 blocks (see below) are optional. Disabled by default.
1536 =item B<E<lt>MatchE<gt>>
1538 One or more B<Match> blocks that define how to match information in the data
1539 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1540 used by the C<tail> plugin, so please see the documentation of the C<tail>
1541 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1542 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1545 =item B<Timeout> I<Milliseconds>
1547 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1548 milliseconds. By default, the configured B<Interval> is used to set the
1549 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1550 indefinitely. This legacy behaviour can be achieved by setting the value of
1553 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1554 network connection will stall one read thread. Adjust the B<ReadThreads> global
1555 setting accordingly to prevent this from blocking other plugins.
1559 =head2 Plugin C<curl_json>
1561 The B<curl_json plugin> collects values from JSON data to be parsed by
1562 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1563 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1564 unix socket. The former can be used, for example, to collect values
1565 from CouchDB documents (which are stored JSON notation), and the
1566 latter to collect values from a uWSGI stats socket.
1568 The following example will collect several values from the built-in
1569 C<_stats> runtime statistics module of I<CouchDB>
1570 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1573 <URL "http://localhost:5984/_stats">
1575 <Key "httpd/requests/count">
1576 Type "http_requests"
1579 <Key "httpd_request_methods/*/count">
1580 Type "http_request_methods"
1583 <Key "httpd_status_codes/*/count">
1584 Type "http_response_codes"
1589 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1592 <Sock "/var/run/uwsgi.stats.sock">
1594 <Key "workers/*/requests">
1595 Type "http_requests"
1598 <Key "workers/*/apps/*/requests">
1599 Type "http_requests"
1604 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1605 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1606 blocks defining a unix socket to read JSON from directly. Each of
1607 these blocks may have one or more B<Key> blocks.
1609 The B<Key> string argument must be in a path format. Each component is
1610 used to match the key from a JSON map or the index of an JSON
1611 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1612 values for all map keys or array indices will be collectd.
1614 The following options are valid within B<URL> blocks:
1618 =item B<Instance> I<Instance>
1620 Sets the plugin instance to I<Instance>.
1622 =item B<Interval> I<Interval>
1624 Sets the interval (in seconds) in which the values will be collected from this
1625 URL. By default the global B<Interval> setting will be used.
1627 =item B<User> I<Name>
1629 =item B<Password> I<Password>
1631 =item B<Digest> B<true>|B<false>
1633 =item B<VerifyPeer> B<true>|B<false>
1635 =item B<VerifyHost> B<true>|B<false>
1637 =item B<CACert> I<file>
1639 =item B<Header> I<Header>
1641 =item B<Post> I<Body>
1643 =item B<Timeout> I<Milliseconds>
1645 These options behave exactly equivalent to the appropriate options of the
1646 I<cURL> plugin. Please see there for a detailed description.
1650 The following options are valid within B<Key> blocks:
1654 =item B<Type> I<Type>
1656 Sets the type used to dispatch the values to the daemon. Detailed information
1657 about types and their configuration can be found in L<types.db(5)>. This
1658 option is mandatory.
1660 =item B<Instance> I<Instance>
1662 Type-instance to use. Defaults to the current map key or current string array element value.
1666 =head2 Plugin C<curl_xml>
1668 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1669 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1672 <URL "http://localhost/stats.xml">
1674 Instance "some_instance"
1679 CACert "/path/to/ca.crt"
1680 Header "X-Custom-Header: foobar"
1683 <XPath "table[@id=\"magic_level\"]/tr">
1685 #InstancePrefix "prefix-"
1686 InstanceFrom "td[1]"
1687 ValuesFrom "td[2]/span[@class=\"level\"]"
1692 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1693 URL to be fetched using libcurl. Within each B<URL> block there are
1694 options which specify the connection parameters, for example authentication
1695 information, and one or more B<XPath> blocks.
1697 Each B<XPath> block specifies how to get one type of information. The
1698 string argument must be a valid XPath expression which returns a list
1699 of "base elements". One value is dispatched for each "base element". The
1700 I<type instance> and values are looked up using further I<XPath> expressions
1701 that should be relative to the base element.
1703 Within the B<URL> block the following options are accepted:
1707 =item B<Host> I<Name>
1709 Use I<Name> as the host name when submitting values. Defaults to the global
1712 =item B<Instance> I<Instance>
1714 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1715 empty string (no plugin instance).
1717 =item B<Namespace> I<Prefix> I<URL>
1719 If an XPath expression references namespaces, they must be specified
1720 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1721 I<URL> is the "namespace name", an URI reference uniquely identifying the
1722 namespace. The option can be repeated to register multiple namespaces.
1726 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1727 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1729 =item B<User> I<User>
1731 =item B<Password> I<Password>
1733 =item B<Digest> B<true>|B<false>
1735 =item B<VerifyPeer> B<true>|B<false>
1737 =item B<VerifyHost> B<true>|B<false>
1739 =item B<CACert> I<CA Cert File>
1741 =item B<Header> I<Header>
1743 =item B<Post> I<Body>
1745 =item B<Timeout> I<Milliseconds>
1747 These options behave exactly equivalent to the appropriate options of the
1748 I<cURL plugin>. Please see there for a detailed description.
1750 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1752 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1753 B<XPath> block specifies how to get one type of information. The string
1754 argument must be a valid XPath expression which returns a list of "base
1755 elements". One value is dispatched for each "base element".
1757 Within the B<XPath> block the following options are accepted:
1761 =item B<Type> I<Type>
1763 Specifies the I<Type> used for submitting patches. This determines the number
1764 of values that are required / expected and whether the strings are parsed as
1765 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1766 This option is required.
1768 =item B<InstancePrefix> I<InstancePrefix>
1770 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1771 concatenated together without any separator.
1772 This option is optional.
1774 =item B<InstanceFrom> I<InstanceFrom>
1776 Specifies a XPath expression to use for determining the I<type instance>. The
1777 XPath expression must return exactly one element. The element's value is then
1778 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1780 This value is required. As a special exception, if the "base XPath expression"
1781 (the argument to the B<XPath> block) returns exactly one argument, then this
1782 option may be omitted.
1784 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1786 Specifies one or more XPath expression to use for reading the values. The
1787 number of XPath expressions must match the number of data sources in the
1788 I<type> specified with B<Type> (see above). Each XPath expression must return
1789 exactly one element. The element's value is then parsed as a number and used as
1790 value for the appropriate value in the value list dispatched to the daemon.
1796 =head2 Plugin C<dbi>
1798 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1799 connect to various databases, execute I<SQL> statements and read back the
1800 results. I<dbi> is an acronym for "database interface" in case you were
1801 wondering about the name. You can configure how each column is to be
1802 interpreted and the plugin will generate one or more data sets from each row
1803 returned according to these rules.
1805 Because the plugin is very generic, the configuration is a little more complex
1806 than those of other plugins. It usually looks something like this:
1809 <Query "out_of_stock">
1810 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1811 # Use with MySQL 5.0.0 or later
1815 InstancePrefix "out_of_stock"
1816 InstancesFrom "category"
1820 <Database "product_information">
1822 DriverOption "host" "localhost"
1823 DriverOption "username" "collectd"
1824 DriverOption "password" "aZo6daiw"
1825 DriverOption "dbname" "prod_info"
1826 SelectDB "prod_info"
1827 Query "out_of_stock"
1831 The configuration above defines one query with one result and one database. The
1832 query is then linked to the database with the B<Query> option I<within> the
1833 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1834 and you can also use the B<Include> statement to split up the configuration
1835 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1836 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1839 The following is a complete list of options:
1841 =head3 B<Query> blocks
1843 Query blocks define I<SQL> statements and how the returned data should be
1844 interpreted. They are identified by the name that is given in the opening line
1845 of the block. Thus the name needs to be unique. Other than that, the name is
1846 not used in collectd.
1848 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1849 define which column holds which value or instance information. You can use
1850 multiple B<Result> blocks to create multiple values from one returned row. This
1851 is especially useful, when queries take a long time and sending almost the same
1852 query again and again is not desirable.
1856 <Query "environment">
1857 Statement "select station, temperature, humidity from environment"
1860 # InstancePrefix "foo"
1861 InstancesFrom "station"
1862 ValuesFrom "temperature"
1866 InstancesFrom "station"
1867 ValuesFrom "humidity"
1871 The following options are accepted:
1875 =item B<Statement> I<SQL>
1877 Sets the statement that should be executed on the server. This is B<not>
1878 interpreted by collectd, but simply passed to the database server. Therefore,
1879 the SQL dialect that's used depends on the server collectd is connected to.
1881 The query has to return at least two columns, one for the instance and one
1882 value. You cannot omit the instance, even if the statement is guaranteed to
1883 always return exactly one line. In that case, you can usually specify something
1886 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1888 (That works with MySQL but may not be valid SQL according to the spec. If you
1889 use a more strict database server, you may have to select from a dummy table or
1892 Please note that some databases, for example B<Oracle>, will fail if you
1893 include a semicolon at the end of the statement.
1895 =item B<MinVersion> I<Version>
1897 =item B<MaxVersion> I<Value>
1899 Only use this query for the specified database version. You can use these
1900 options to provide multiple queries with the same name but with a slightly
1901 different syntax. The plugin will use only those queries, where the specified
1902 minimum and maximum versions fit the version of the database in use.
1904 The database version is determined by C<dbi_conn_get_engine_version>, see the
1905 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1906 for details. Basically, each part of the version is assumed to be in the range
1907 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1908 "40102", version "5.0.42" becomes "50042".
1910 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1911 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1912 happen. Don't to it! A valid example would be something along these lines:
1923 In the above example, there are three ranges that don't overlap. The last one
1924 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1925 before "4.0.0" are not specified.
1927 =item B<Type> I<Type>
1929 The B<type> that's used for each line returned. See L<types.db(5)> for more
1930 details on how types are defined. In short: A type is a predefined layout of
1931 data and the number of values and type of values has to match the type
1934 If you specify "temperature" here, you need exactly one gauge column. If you
1935 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1938 There must be exactly one B<Type> option inside each B<Result> block.
1940 =item B<InstancePrefix> I<prefix>
1942 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1943 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1944 all strings returned in the appropriate columns are concatenated together,
1945 separated by dashes I<("-")>.
1947 =item B<InstancesFrom> I<column0> [I<column1> ...]
1949 Specifies the columns whose values will be used to create the "type-instance"
1950 for each row. If you specify more than one column, the value of all columns
1951 will be joined together with dashes I<("-")> as separation characters.
1953 The plugin itself does not check whether or not all built instances are
1954 different. It's your responsibility to assure that each is unique. This is
1955 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1956 sure that only one row is returned in this case.
1958 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1961 =item B<ValuesFrom> I<column0> [I<column1> ...]
1963 Names the columns whose content is used as the actual data for the data sets
1964 that are dispatched to the daemon. How many such columns you need is determined
1965 by the B<Type> setting above. If you specify too many or not enough columns,
1966 the plugin will complain about that and no data will be submitted to the
1969 The actual data type in the columns is not that important. The plugin will
1970 automatically cast the values to the right type if it know how to do that. So
1971 it should be able to handle integer an floating point types, as well as strings
1972 (if they include a number at the beginning).
1974 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1976 =item B<MetadataFrom> [I<column0> I<column1> ...]
1978 Names the columns whose content is used as metadata for the data sets
1979 that are dispatched to the daemon.
1981 The actual data type in the columns is not that important. The plugin will
1982 automatically cast the values to the right type if it know how to do that. So
1983 it should be able to handle integer an floating point types, as well as strings
1984 (if they include a number at the beginning).
1988 =head3 B<Database> blocks
1990 Database blocks define a connection to a database and which queries should be
1991 sent to that database. Since the used "dbi" library can handle a wide variety
1992 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1993 documentationE<nbsp>- we stick as close to the terminology used there.
1995 Each database needs a "name" as string argument in the starting tag of the
1996 block. This name will be used as "PluginInstance" in the values submitted to
1997 the daemon. Other than that, that name is not used.
2001 =item B<Driver> I<Driver>
2003 Specifies the driver to use to connect to the database. In many cases those
2004 drivers are named after the database they can connect to, but this is not a
2005 technical necessity. These drivers are sometimes referred to as "DBD",
2006 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2007 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2008 project at L<http://libdbi-drivers.sourceforge.net/>.
2010 You need to give the driver name as expected by the "dbi" library here. You
2011 should be able to find that in the documentation for each driver. If you
2012 mistype the driver name, the plugin will dump a list of all known driver names
2015 =item B<DriverOption> I<Key> I<Value>
2017 Sets driver-specific options. What option a driver supports can be found in the
2018 documentation for each driver, somewhere at
2019 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2020 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2022 DBDs can register two types of options: String options and numeric options. The
2023 plugin will use the C<dbi_conn_set_option> function when the configuration
2024 provides a string and the C<dbi_conn_require_option_numeric> function when the
2025 configuration provides a number. So these two lines will actually result in
2026 different calls being used:
2028 DriverOption "Port" 1234 # numeric
2029 DriverOption "Port" "1234" # string
2031 Unfortunately, drivers are not too keen to report errors when an unknown option
2032 is passed to them, so invalid settings here may go unnoticed. This is not the
2033 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2034 the driver. If a driver complains about an option, the plugin will dump a
2035 complete list of all options understood by that driver to the log. There is no
2036 way to programatically find out if an option expects a string or a numeric
2037 argument, so you will have to refer to the appropriate DBD's documentation to
2038 find this out. Sorry.
2040 =item B<SelectDB> I<Database>
2042 In some cases, the database name you connect with is not the database name you
2043 want to use for querying data. If this option is set, the plugin will "select"
2044 (switch to) that database after the connection is established.
2046 =item B<Query> I<QueryName>
2048 Associates the query named I<QueryName> with this database connection. The
2049 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2050 blocks you want to refer to must be placed above the database block you want to
2053 =item B<Host> I<Hostname>
2055 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2056 values. Defaults to the global hostname setting.
2064 =item B<Device> I<Device>
2066 Select partitions based on the devicename.
2068 =item B<MountPoint> I<Directory>
2070 Select partitions based on the mountpoint.
2072 =item B<FSType> I<FSType>
2074 Select partitions based on the filesystem type.
2076 =item B<IgnoreSelected> B<true>|B<false>
2078 Invert the selection: If set to true, all partitions B<except> the ones that
2079 match any one of the criteria are collected. By default only selected
2080 partitions are collected if a selection is made. If no selection is configured
2081 at all, B<all> partitions are selected.
2083 =item B<ReportByDevice> B<true>|B<false>
2085 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2086 (the default), it will report a disk as "root", but with it I<true>, it will be
2087 "sda1" (or whichever).
2089 =item B<ReportInodes> B<true>|B<false>
2091 Enables or disables reporting of free, reserved and used inodes. Defaults to
2092 inode collection being disabled.
2094 Enable this option if inodes are a scarce resource for you, usually because
2095 many small files are stored on the disk. This is a usual scenario for mail
2096 transfer agents and web caches.
2098 =item B<ValuesAbsolute> B<true>|B<false>
2100 Enables or disables reporting of free and used disk space in 1K-blocks.
2101 Defaults to B<true>.
2103 =item B<ValuesPercentage> B<false>|B<true>
2105 Enables or disables reporting of free and used disk space in percentage.
2106 Defaults to B<false>.
2108 This is useful for deploying I<collectd> on the cloud, where machines with
2109 different disk size may exist. Then it is more practical to configure
2110 thresholds based on relative disk size.
2114 =head2 Plugin C<disk>
2116 The C<disk> plugin collects information about the usage of physical disks and
2117 logical disks (partitions). Values collected are the number of octets written
2118 to and read from a disk or partition, the number of read/write operations
2119 issued to the disk and a rather complex "time" it took for these commands to be
2122 Using the following two options you can ignore some disks or configure the
2123 collection only of specific disks.
2127 =item B<Disk> I<Name>
2129 Select the disk I<Name>. Whether it is collected or ignored depends on the
2130 B<IgnoreSelected> setting, see below. As with other plugins that use the
2131 daemon's ignorelist functionality, a string that starts and ends with a slash
2132 is interpreted as a regular expression. Examples:
2137 =item B<IgnoreSelected> B<true>|B<false>
2139 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2140 statements, are ignored or if all other disks are ignored. The behavior
2141 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2142 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2143 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2144 is set to B<true>, all disks are collected B<except> the ones matched.
2146 =item B<UseBSDName> B<true>|B<false>
2148 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2149 default major/minor numbers. Requires collectd to be built with Apple's
2152 =item B<UdevNameAttr> I<Attribute>
2154 Attempt to override disk instance name with the value of a specified udev
2155 attribute when built with B<libudev>. If the attribute is not defined for the
2156 given device, the default name is used. Example:
2158 UdevNameAttr "DM_NAME"
2162 =head2 Plugin C<dns>
2166 =item B<Interface> I<Interface>
2168 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2169 option sets the interface that should be used. If this option is not set, or
2170 set to "any", the plugin will try to get packets from B<all> interfaces. This
2171 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2173 =item B<IgnoreSource> I<IP-address>
2175 Ignore packets that originate from this address.
2177 =item B<SelectNumericQueryTypes> B<true>|B<false>
2179 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2183 =head2 Plugin C<email>
2187 =item B<SocketFile> I<Path>
2189 Sets the socket-file which is to be created.
2191 =item B<SocketGroup> I<Group>
2193 If running as root change the group of the UNIX-socket after it has been
2194 created. Defaults to B<collectd>.
2196 =item B<SocketPerms> I<Permissions>
2198 Change the file permissions of the UNIX-socket after it has been created. The
2199 permissions must be given as a numeric, octal value as you would pass to
2200 L<chmod(1)>. Defaults to B<0770>.
2202 =item B<MaxConns> I<Number>
2204 Sets the maximum number of connections that can be handled in parallel. Since
2205 this many threads will be started immediately setting this to a very high
2206 value will waste valuable resources. Defaults to B<5> and will be forced to be
2207 at most B<16384> to prevent typos and dumb mistakes.
2211 =head2 Plugin C<ethstat>
2213 The I<ethstat plugin> collects information about network interface cards (NICs)
2214 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2220 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2221 Map "multicast" "if_multicast"
2228 =item B<Interface> I<Name>
2230 Collect statistical information about interface I<Name>.
2232 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2234 By default, the plugin will submit values as type C<derive> and I<type
2235 instance> set to I<Name>, the name of the metric as reported by the driver. If
2236 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2237 I<TypeInstance> will be used.
2239 =item B<MappedOnly> B<true>|B<false>
2241 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2242 collected, all other metrics will be ignored. Defaults to B<false>.
2246 =head2 Plugin C<exec>
2248 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2249 contains valuable information on when the executable is executed and the
2250 output that is expected from it.
2254 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2256 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2258 Execute the executable I<Executable> as user I<User>. If the user name is
2259 followed by a colon and a group name, the effective group is set to that group.
2260 The real group and saved-set group will be set to the default group of that
2261 user. If no group is given the effective group ID will be the same as the real
2264 Please note that in order to change the user and/or group the daemon needs
2265 superuser privileges. If the daemon is run as an unprivileged user you must
2266 specify the same user/group here. If the daemon is run with superuser
2267 privileges, you must supply a non-root user here.
2269 The executable may be followed by optional arguments that are passed to the
2270 program. Please note that due to the configuration parsing numbers and boolean
2271 values may be changed. If you want to be absolutely sure that something is
2272 passed as-is please enclose it in quotes.
2274 The B<Exec> and B<NotificationExec> statements change the semantics of the
2275 programs executed, i.E<nbsp>e. the data passed to them and the response
2276 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2280 =head2 Plugin C<fhcount>
2282 The C<fhcount> plugin provides statistics about used, unused and total number of
2283 file handles on Linux.
2285 The I<fhcount plugin> provides the following configuration options:
2289 =item B<ValuesAbsolute> B<true>|B<false>
2291 Enables or disables reporting of file handles usage in absolute numbers,
2292 e.g. file handles used. Defaults to B<true>.
2294 =item B<ValuesPercentage> B<false>|B<true>
2296 Enables or disables reporting of file handles usage in percentages, e.g.
2297 percent of file handles used. Defaults to B<false>.
2301 =head2 Plugin C<filecount>
2303 The C<filecount> plugin counts the number of files in a certain directory (and
2304 its subdirectories) and their combined size. The configuration is very straight
2307 <Plugin "filecount">
2308 <Directory "/var/qmail/queue/mess">
2309 Instance "qmail-message"
2311 <Directory "/var/qmail/queue/todo">
2312 Instance "qmail-todo"
2314 <Directory "/var/lib/php5">
2315 Instance "php5-sessions"
2320 The example above counts the number of files in QMail's queue directories and
2321 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2322 QMail has not yet looked at, the "message" queue holds the messages that were
2323 classified into "local" and "remote".
2325 As you can see, the configuration consists of one or more C<Directory> blocks,
2326 each of which specifies a directory in which to count the files. Within those
2327 blocks, the following options are recognized:
2331 =item B<Instance> I<Instance>
2333 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2334 it's your responsibility, the plugin doesn't check for that. If not given, the
2335 instance is set to the directory name with all slashes replaced by underscores
2336 and all leading underscores removed.
2338 =item B<Name> I<Pattern>
2340 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2341 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2342 against the pattern, not the entire path. In case this makes it easier for you:
2343 This option has been named after the B<-name> parameter to L<find(1)>.
2345 =item B<MTime> I<Age>
2347 Count only files of a specific age: If I<Age> is greater than zero, only files
2348 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2349 a negative number, this is inversed. For example, if B<-60> is specified, only
2350 files that have been modified in the last minute will be counted.
2352 The number can also be followed by a "multiplier" to easily specify a larger
2353 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2354 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2355 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2356 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2357 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2360 =item B<Size> I<Size>
2362 Count only files of a specific size. When I<Size> is a positive number, only
2363 files that are at least this big are counted. If I<Size> is a negative number,
2364 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2365 I<Size> are counted.
2367 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2368 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2369 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2370 note that there are 1000 bytes in a kilobyte, not 1024.
2372 =item B<Recursive> I<true>|I<false>
2374 Controls whether or not to recurse into subdirectories. Enabled by default.
2376 =item B<IncludeHidden> I<true>|I<false>
2378 Controls whether or not to include "hidden" files and directories in the count.
2379 "Hidden" files and directories are those, whose name begins with a dot.
2380 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2384 =head2 Plugin C<GenericJMX>
2386 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2387 L<collectd-java(5)>.
2389 =head2 Plugin C<gmond>
2391 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2392 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2393 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2398 MCReceiveFrom "239.2.11.71" "8649"
2399 <Metric "swap_total">
2401 TypeInstance "total"
2404 <Metric "swap_free">
2411 The following metrics are built-in:
2417 load_one, load_five, load_fifteen
2421 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2425 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2437 Available configuration options:
2441 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2443 Sets sets the multicast group and UDP port to which to subscribe.
2445 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2447 =item E<lt>B<Metric> I<Name>E<gt>
2449 These blocks add a new metric conversion to the internal table. I<Name>, the
2450 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2454 =item B<Type> I<Type>
2456 Type to map this metric to. Required.
2458 =item B<TypeInstance> I<Instance>
2460 Type-instance to use. Optional.
2462 =item B<DataSource> I<Name>
2464 Data source to map this metric to. If the configured type has exactly one data
2465 source, this is optional. Otherwise the option is required.
2471 =head2 Plugin C<hddtemp>
2473 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2474 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2475 default values, see below. C<hddtemp> has to be running to work correctly. If
2476 C<hddtemp> is not running timeouts may appear which may interfere with other
2479 The B<hddtemp> homepage can be found at
2480 L<http://www.guzu.net/linux/hddtemp.php>.
2484 =item B<Host> I<Hostname>
2486 Hostname to connect to. Defaults to B<127.0.0.1>.
2488 =item B<Port> I<Port>
2490 TCP-Port to connect to. Defaults to B<7634>.
2494 =head2 Plugin C<interface>
2498 =item B<Interface> I<Interface>
2500 Select this interface. By default these interfaces will then be collected. For
2501 a more detailed description see B<IgnoreSelected> below.
2503 =item B<IgnoreSelected> I<true>|I<false>
2505 If no configuration if given, the B<interface>-plugin will collect data from
2506 all interfaces. This may not be practical, especially for loopback- and
2507 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2508 interfaces you're interested in. Sometimes, however, it's easier/preferred
2509 to collect all interfaces I<except> a few ones. This option enables you to
2510 do that: By setting B<IgnoreSelected> to I<true> the effect of
2511 B<Interface> is inverted: All selected interfaces are ignored and all
2512 other interfaces are collected.
2514 It is possible to use regular expressions to match interface names, if the
2515 name is surrounded by I</.../> and collectd was compiled with support for
2516 regexps. This is useful if there's a need to collect (or ignore) data
2517 for a group of interfaces that are similarly named, without the need to
2518 explicitly list all of them (especially useful if the list is dynamic).
2523 Interface "/^tun[0-9]+/"
2524 IgnoreSelected "true"
2526 This will ignore the loopback interface, all interfaces with names starting
2527 with I<veth> and all interfaces with names starting with I<tun> followed by
2533 =head2 Plugin C<ipmi>
2537 =item B<Sensor> I<Sensor>
2539 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2541 =item B<IgnoreSelected> I<true>|I<false>
2543 If no configuration if given, the B<ipmi> plugin will collect data from all
2544 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2545 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2546 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2547 all other sensors are collected.
2549 =item B<NotifySensorAdd> I<true>|I<false>
2551 If a sensor appears after initialization time of a minute a notification
2554 =item B<NotifySensorRemove> I<true>|I<false>
2556 If a sensor disappears a notification is sent.
2558 =item B<NotifySensorNotPresent> I<true>|I<false>
2560 If you have for example dual power supply and one of them is (un)plugged then
2561 a notification is sent.
2565 =head2 Plugin C<iptables>
2569 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2571 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2573 Select the iptables/ip6tables filter rules to count packets and bytes from.
2575 If only I<Table> and I<Chain> are given, this plugin will collect the counters
2576 of all rules which have a comment-match. The comment is then used as
2579 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2580 the I<n>th rule will be collected. Again, the comment (or the number) will be
2581 used as the type-instance.
2583 If I<Name> is supplied, it will be used as the type-instance instead of the
2584 comment or the number.
2588 =head2 Plugin C<irq>
2594 Select this irq. By default these irqs will then be collected. For a more
2595 detailed description see B<IgnoreSelected> below.
2597 =item B<IgnoreSelected> I<true>|I<false>
2599 If no configuration if given, the B<irq>-plugin will collect data from all
2600 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2601 can use the B<Irq>-option to pick the interrupt you're interested in.
2602 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2603 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2604 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2605 and all other interrupts are collected.
2609 =head2 Plugin C<java>
2611 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2612 This section only discusses the syntax and semantic of the configuration
2613 options. For more in-depth information on the I<Java> plugin, please read
2614 L<collectd-java(5)>.
2619 JVMArg "-verbose:jni"
2620 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2621 LoadPlugin "org.collectd.java.Foobar"
2622 <Plugin "org.collectd.java.Foobar">
2623 # To be parsed by the plugin
2627 Available configuration options:
2631 =item B<JVMArg> I<Argument>
2633 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2634 exactly the way the arguments to the I<java> binary on the command line work.
2635 Execute C<javaE<nbsp>--help> for details.
2637 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2638 any other options! When another option is found, the JVM will be started and
2639 later options will have to be ignored!
2641 =item B<LoadPlugin> I<JavaClass>
2643 Instantiates a new I<JavaClass> object. The constructor of this object very
2644 likely then registers one or more callback methods with the server.
2646 See L<collectd-java(5)> for details.
2648 When the first such option is found, the virtual machine (JVM) is created. This
2649 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2650 B<LoadPlugin> options!
2652 =item B<Plugin> I<Name>
2654 The entire block is passed to the Java plugin as an
2655 I<org.collectd.api.OConfigItem> object.
2657 For this to work, the plugin has to register a configuration callback first,
2658 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2659 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2660 depends on the (Java) plugin registering the callback and is completely
2661 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2665 =head2 Plugin C<load>
2667 The I<Load plugin> collects the system load. These numbers give a rough overview
2668 over the utilization of a machine. The system load is defined as the number of
2669 runnable tasks in the run-queue and is provided by many operating systems as a
2670 one, five or fifteen minute average.
2672 The following configuration options are available:
2676 =item B<ReportRelative> B<false>|B<true>
2678 When enabled, system load divided by number of available CPU cores is reported
2679 for intervals 1 min, 5 min and 15 min. Defaults to false.
2684 =head2 Plugin C<logfile>
2688 =item B<LogLevel> B<debug|info|notice|warning|err>
2690 Sets the log-level. If, for example, set to B<notice>, then all events with
2691 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2693 Please note that B<debug> is only available if collectd has been compiled with
2696 =item B<File> I<File>
2698 Sets the file to write log messages to. The special strings B<stdout> and
2699 B<stderr> can be used to write to the standard output and standard error
2700 channels, respectively. This, of course, only makes much sense when I<collectd>
2701 is running in foreground- or non-daemon-mode.
2703 =item B<Timestamp> B<true>|B<false>
2705 Prefix all lines printed by the current time. Defaults to B<true>.
2707 =item B<PrintSeverity> B<true>|B<false>
2709 When enabled, all lines are prefixed by the severity of the log message, for
2710 example "warning". Defaults to B<false>.
2714 B<Note>: There is no need to notify the daemon after moving or removing the
2715 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2716 for each line it writes.
2718 =head2 Plugin C<log_logstash>
2720 The I<log logstash plugin> behaves like the logfile plugin but formats
2721 messages as JSON events for logstash to parse and input.
2725 =item B<LogLevel> B<debug|info|notice|warning|err>
2727 Sets the log-level. If, for example, set to B<notice>, then all events with
2728 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2730 Please note that B<debug> is only available if collectd has been compiled with
2733 =item B<File> I<File>
2735 Sets the file to write log messages to. The special strings B<stdout> and
2736 B<stderr> can be used to write to the standard output and standard error
2737 channels, respectively. This, of course, only makes much sense when I<collectd>
2738 is running in foreground- or non-daemon-mode.
2742 B<Note>: There is no need to notify the daemon after moving or removing the
2743 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2744 for each line it writes.
2746 =head2 Plugin C<lpar>
2748 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2749 virtualization technique for IBM POWER processors. It takes into account CPU
2750 time stolen from or donated to a partition, in addition to the usual user,
2751 system, I/O statistics.
2753 The following configuration options are available:
2757 =item B<CpuPoolStats> B<false>|B<true>
2759 When enabled, statistics about the processor pool are read, too. The partition
2760 needs to have pool authority in order to be able to acquire this information.
2763 =item B<ReportBySerial> B<false>|B<true>
2765 If enabled, the serial of the physical machine the partition is currently
2766 running on is reported as I<hostname> and the logical hostname of the machine
2767 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2768 used (just like other plugins) and the I<plugin instance> will be empty.
2773 =head2 Plugin C<mbmon>
2775 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2777 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2778 B<Host> and B<Port> options can be used to change these values, see below.
2779 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2780 timeouts may appear which may interfere with other statistics..
2782 C<mbmon> must be run with the -r option ("print TAG and Value format");
2783 Debian's F</etc/init.d/mbmon> script already does this, other people
2784 will need to ensure that this is the case.
2788 =item B<Host> I<Hostname>
2790 Hostname to connect to. Defaults to B<127.0.0.1>.
2792 =item B<Port> I<Port>
2794 TCP-Port to connect to. Defaults to B<411>.
2800 The C<md plugin> collects information from Linux Software-RAID devices (md).
2802 All reported values are of the type C<md_disks>. Reported type instances are
2803 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2804 I<missing> (physically absent) disks.
2808 =item B<Device> I<Device>
2810 Select md devices based on device name. The I<device name> is the basename of
2811 the device, i.e. the name of the block device without the leading C</dev/>.
2812 See B<IgnoreSelected> for more details.
2814 =item B<IgnoreSelected> B<true>|B<false>
2816 Invert device selection: If set to B<true>, all md devices B<except> those
2817 listed using B<Device> are collected. If B<false> (the default), only those
2818 listed are collected. If no configuration is given, the B<md> plugin will
2819 collect data from all md devices.
2823 =head2 Plugin C<memcachec>
2825 The C<memcachec plugin> connects to a memcached server, queries one or more
2826 given I<pages> and parses the returned data according to user specification.
2827 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2830 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2831 library. Please note that there is another library with a very similar name,
2832 libmemcache (notice the missing `d'), which is not applicable.
2834 Synopsis of the configuration:
2836 <Plugin "memcachec">
2837 <Page "plugin_instance">
2841 Regex "(\\d+) bytes sent"
2844 Instance "type_instance"
2849 The configuration options are:
2853 =item E<lt>B<Page> I<Name>E<gt>
2855 Each B<Page> block defines one I<page> to be queried from the memcached server.
2856 The block requires one string argument which is used as I<plugin instance>.
2858 =item B<Server> I<Address>
2860 Sets the server address to connect to when querying the page. Must be inside a
2865 When connected to the memcached server, asks for the page I<Key>.
2867 =item E<lt>B<Match>E<gt>
2869 Match blocks define which strings to look for and how matches substrings are
2870 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2874 =head2 Plugin C<memcached>
2876 The B<memcached plugin> connects to a memcached server and queries statistics
2877 about cache utilization, memory and bandwidth used.
2878 L<http://www.danga.com/memcached/>
2880 <Plugin "memcached">
2882 Host "memcache.example.com"
2887 The plugin configuration consists of one or more B<Instance> blocks which
2888 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2889 following options are allowed:
2893 =item B<Host> I<Hostname>
2895 Hostname to connect to. Defaults to B<127.0.0.1>.
2897 =item B<Port> I<Port>
2899 TCP-Port to connect to. Defaults to B<11211>.
2901 =item B<Socket> I<Path>
2903 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2904 setting is given, the B<Host> and B<Port> settings are ignored.
2908 =head2 Plugin C<mic>
2910 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2911 Intel's Many Integrated Core (MIC) systems.
2920 ShowTemperatures true
2923 IgnoreSelectedTemperature true
2928 IgnoreSelectedPower true
2931 The following options are valid inside the B<PluginE<nbsp>mic> block:
2935 =item B<ShowCPU> B<true>|B<false>
2937 If enabled (the default) a sum of the CPU usage across all cores is reported.
2939 =item B<ShowCPUCores> B<true>|B<false>
2941 If enabled (the default) per-core CPU usage is reported.
2943 =item B<ShowMemory> B<true>|B<false>
2945 If enabled (the default) the physical memory usage of the MIC system is
2948 =item B<ShowTemperatures> B<true>|B<false>
2950 If enabled (the default) various temperatures of the MIC system are reported.
2952 =item B<Temperature> I<Name>
2954 This option controls which temperatures are being reported. Whether matching
2955 temperatures are being ignored or I<only> matching temperatures are reported
2956 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2957 temperatures are reported.
2959 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2961 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2962 (the default) only temperatures matching a B<Temperature> option are reported
2963 or, if no B<Temperature> option is specified, all temperatures are reported. If
2964 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2967 Known temperature names are:
3001 =item B<ShowPower> B<true>|B<false>
3003 If enabled (the default) various temperatures of the MIC system are reported.
3005 =item B<Power> I<Name>
3007 This option controls which power readings are being reported. Whether matching
3008 power readings are being ignored or I<only> matching power readings are reported
3009 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3010 power readings are reported.
3012 =item B<IgnoreSelectedPower> B<false>|B<true>
3014 Controls the behavior of the B<Power> setting above. If set to B<false>
3015 (the default) only power readings matching a B<Power> option are reported
3016 or, if no B<Power> option is specified, all power readings are reported. If
3017 set to B<true>, matching power readings are I<ignored> and all other power readings
3020 Known power names are:
3026 Total power utilization averaged over Time Window 0 (uWatts).
3030 Total power utilization averaged over Time Window 0 (uWatts).
3034 Instantaneous power (uWatts).
3038 Max instantaneous power (uWatts).
3042 PCI-E connector power (uWatts).
3046 2x3 connector power (uWatts).
3050 2x4 connector power (uWatts).
3058 Uncore rail (uVolts).
3062 Memory subsystem rail (uVolts).
3068 =head2 Plugin C<memory>
3070 The I<memory plugin> provides the following configuration options:
3074 =item B<ValuesAbsolute> B<true>|B<false>
3076 Enables or disables reporting of physical memory usage in absolute numbers,
3077 i.e. bytes. Defaults to B<true>.
3079 =item B<ValuesPercentage> B<false>|B<true>
3081 Enables or disables reporting of physical memory usage in percentages, e.g.
3082 percent of physical memory used. Defaults to B<false>.
3084 This is useful for deploying I<collectd> in a heterogeneous environment in
3085 which the sizes of physical memory vary.
3089 =head2 Plugin C<modbus>
3091 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3092 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3093 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3094 values (two registers interpreted as IEEE floats in big endian notation).
3098 <Data "voltage-input-1">
3101 RegisterCmd ReadHolding
3106 <Data "voltage-input-2">
3109 RegisterCmd ReadHolding
3114 <Data "supply-temperature-1">
3117 RegisterCmd ReadHolding
3122 <Host "modbus.example.com">
3123 Address "192.168.0.42"
3128 Instance "power-supply"
3129 Collect "voltage-input-1"
3130 Collect "voltage-input-2"
3135 Device "/dev/ttyUSB0"
3140 Instance "temperature"
3141 Collect "supply-temperature-1"
3147 =item E<lt>B<Data> I<Name>E<gt> blocks
3149 Data blocks define a mapping between register numbers and the "types" used by
3152 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3156 =item B<RegisterBase> I<Number>
3158 Configures the base register to read from the device. If the option
3159 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3160 register will be read (the register number is increased by one).
3162 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3164 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3165 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3166 combined into one value. Defaults to B<Uint16>.
3168 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3170 Specifies register type to be collected from device. Works only with libmodbus
3171 2.9.2 or higher. Defaults to B<ReadHolding>.
3173 =item B<Type> I<Type>
3175 Specifies the "type" (data set) to use when dispatching the value to
3176 I<collectd>. Currently, only data sets with exactly one data source are
3179 =item B<Instance> I<Instance>
3181 Sets the type instance to use when dispatching the value to I<collectd>. If
3182 unset, an empty string (no type instance) is used.
3186 =item E<lt>B<Host> I<Name>E<gt> blocks
3188 Host blocks are used to specify to which hosts to connect and what data to read
3189 from their "slaves". The string argument I<Name> is used as hostname when
3190 dispatching the values to I<collectd>.
3192 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3196 =item B<Address> I<Hostname>
3198 For Modbus/TCP, specifies the node name (the actual network address) used to
3199 connect to the host. This may be an IP address or a hostname. Please note that
3200 the used I<libmodbus> library only supports IPv4 at the moment.
3202 =item B<Port> I<Service>
3204 for Modbus/TCP, specifies the port used to connect to the host. The port can
3205 either be given as a number or as a service name. Please note that the
3206 I<Service> argument must be a string, even if ports are given in their numerical
3207 form. Defaults to "502".
3209 =item B<Device> I<Devicenode>
3211 For Modbus/RTU, specifies the path to the serial device being used.
3213 =item B<Baudrate> I<Baudrate>
3215 For Modbus/RTU, specifies the baud rate of the serial device.
3216 Note, connections currently support only 8/N/1.
3218 =item B<Interval> I<Interval>
3220 Sets the interval (in seconds) in which the values will be collected from this
3221 host. By default the global B<Interval> setting will be used.
3223 =item E<lt>B<Slave> I<ID>E<gt>
3225 Over each connection, multiple Modbus devices may be reached. The slave ID
3226 is used to specify which device should be addressed. For each device you want
3227 to query, one B<Slave> block must be given.
3229 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3233 =item B<Instance> I<Instance>
3235 Specify the plugin instance to use when dispatching the values to I<collectd>.
3236 By default "slave_I<ID>" is used.
3238 =item B<Collect> I<DataName>
3240 Specifies which data to retrieve from the device. I<DataName> must be the same
3241 string as the I<Name> argument passed to a B<Data> block. You can specify this
3242 option multiple times to collect more than one value from a slave. At least one
3243 B<Collect> option is mandatory.
3251 =head2 Plugin C<mysql>
3253 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3254 one or more databases when started and keeps the connection up as long as
3255 possible. When the connection is interrupted for whatever reason it will try
3256 to re-connect. The plugin will complain loudly in case anything goes wrong.
3258 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3259 and collects information about MySQL network traffic, executed statements,
3260 requests, the query cache and threads by evaluating the
3261 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3262 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3263 Status Variables> for an explanation of these values.
3265 Optionally, master and slave statistics may be collected in a MySQL
3266 replication setup. In that case, information about the synchronization state
3267 of the nodes are collected by evaluating the C<Position> return value of the
3268 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3269 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3270 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3271 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3272 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3289 Socket "/var/run/mysql/mysqld.sock"
3291 SlaveNotifications true
3295 A B<Database> block defines one connection to a MySQL database. It accepts a
3296 single argument which specifies the name of the database. None of the other
3297 options are required. MySQL will use default values as documented in the
3298 section "mysql_real_connect()" in the B<MySQL reference manual>.
3302 =item B<Alias> I<Alias>
3304 Alias to use as sender instead of hostname when reporting. This may be useful
3305 when having cryptic hostnames.
3307 =item B<Host> I<Hostname>
3309 Hostname of the database server. Defaults to B<localhost>.
3311 =item B<User> I<Username>
3313 Username to use when connecting to the database. The user does not have to be
3314 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3315 unless you want to collectd replication statistics (see B<MasterStats> and
3316 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3317 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3319 =item B<Password> I<Password>
3321 Password needed to log into the database.
3323 =item B<Database> I<Database>
3325 Select this database. Defaults to I<no database> which is a perfectly reasonable
3326 option for what this plugin does.
3328 =item B<Port> I<Port>
3330 TCP-port to connect to. The port must be specified in its numeric form, but it
3331 must be passed as a string nonetheless. For example:
3335 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3336 See the documentation for the C<mysql_real_connect> function for details.
3338 =item B<Socket> I<Socket>
3340 Specifies the path to the UNIX domain socket of the MySQL server. This option
3341 only has any effect, if B<Host> is set to B<localhost> (the default).
3342 Otherwise, use the B<Port> option above. See the documentation for the
3343 C<mysql_real_connect> function for details.
3345 =item B<InnodbStats> I<true|false>
3347 If enabled, metrics about the InnoDB storage engine are collected.
3348 Disabled by default.
3350 =item B<MasterStats> I<true|false>
3352 =item B<SlaveStats> I<true|false>
3354 Enable the collection of master / slave statistics in a replication setup. In
3355 order to be able to get access to these statistics, the user needs special
3356 privileges. See the B<User> documentation above. Defaults to B<false>.
3358 =item B<SlaveNotifications> I<true|false>
3360 If enabled, the plugin sends a notification if the replication slave I/O and /
3361 or SQL threads are not running. Defaults to B<false>.
3363 =item B<ConnectTimeout> I<Seconds>
3365 Sets the connect timeout for the MySQL client.
3369 =head2 Plugin C<netapp>
3371 The netapp plugin can collect various performance and capacity information
3372 from a NetApp filer using the NetApp API.
3374 Please note that NetApp has a wide line of products and a lot of different
3375 software versions for each of these products. This plugin was developed for a
3376 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3377 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3378 model and software version but it is very hard to test this.
3379 If you have used this plugin with other models and/or software version, feel
3380 free to send us a mail to tell us about the results, even if it's just a short
3383 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3384 basic authentication.
3386 B<Do not use a regular user for this!> Create a special collectd user with just
3387 the minimum of capabilities needed. The user only needs the "login-http-admin"
3388 capability as well as a few more depending on which data will be collected.
3389 Required capabilities are documented below.
3394 <Host "netapp1.example.com">
3418 IgnoreSelectedIO false
3420 IgnoreSelectedOps false
3421 GetLatency "volume0"
3422 IgnoreSelectedLatency false
3429 IgnoreSelectedCapacity false
3432 IgnoreSelectedSnapshot false
3460 The netapp plugin accepts the following configuration options:
3464 =item B<Host> I<Name>
3466 A host block defines one NetApp filer. It will appear in collectd with the name
3467 you specify here which does not have to be its real name nor its hostname (see
3468 the B<Address> option below).
3470 =item B<VFiler> I<Name>
3472 A B<VFiler> block may only be used inside a host block. It accepts all the
3473 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3474 will execute all NetApp API commands in the context of the specified
3475 VFiler(R). It will appear in collectd with the name you specify here which
3476 does not have to be its real name. The VFiler name may be specified using the
3477 B<VFilerName> option. If this is not specified, it will default to the name
3480 The VFiler block inherits all connection related settings from the surrounding
3481 B<Host> block (which appear before the B<VFiler> block) but they may be
3482 overwritten inside the B<VFiler> block.
3484 This feature is useful, for example, when using a VFiler as SnapVault target
3485 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3486 available in the host filer (vfiler0) but only in the respective VFiler
3489 =item B<Protocol> B<httpd>|B<http>
3491 The protocol collectd will use to query this host.
3499 Valid options: http, https
3501 =item B<Address> I<Address>
3503 The hostname or IP address of the host.
3509 Default: The "host" block's name.
3511 =item B<Port> I<Port>
3513 The TCP port to connect to on the host.
3519 Default: 80 for protocol "http", 443 for protocol "https"
3521 =item B<User> I<User>
3523 =item B<Password> I<Password>
3525 The username and password to use to login to the NetApp.
3531 =item B<VFilerName> I<Name>
3533 The name of the VFiler in which context to execute API commands. If not
3534 specified, the name provided to the B<VFiler> block will be used instead.
3540 Default: name of the B<VFiler> block
3542 B<Note:> This option may only be used inside B<VFiler> blocks.
3544 =item B<Interval> I<Interval>
3550 The following options decide what kind of data will be collected. You can
3551 either use them as a block and fine tune various parameters inside this block,
3552 use them as a single statement to just accept all default values, or omit it to
3553 not collect any data.
3555 The following options are valid inside all blocks:
3559 =item B<Interval> I<Seconds>
3561 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3562 host specific setting.
3566 =head3 The System block
3568 This will collect various performance data about the whole system.
3570 B<Note:> To get this data the collectd user needs the
3571 "api-perf-object-get-instances" capability.
3575 =item B<Interval> I<Seconds>
3577 Collect disk statistics every I<Seconds> seconds.
3579 =item B<GetCPULoad> B<true>|B<false>
3581 If you set this option to true the current CPU usage will be read. This will be
3582 the average usage between all CPUs in your NetApp without any information about
3585 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3586 returns in the "CPU" field.
3594 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3596 =item B<GetInterfaces> B<true>|B<false>
3598 If you set this option to true the current traffic of the network interfaces
3599 will be read. This will be the total traffic over all interfaces of your NetApp
3600 without any information about individual interfaces.
3602 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3603 in the "Net kB/s" field.
3613 Result: One value list of type "if_octects".
3615 =item B<GetDiskIO> B<true>|B<false>
3617 If you set this option to true the current IO throughput will be read. This
3618 will be the total IO of your NetApp without any information about individual
3619 disks, volumes or aggregates.
3621 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3622 in the "DiskE<nbsp>kB/s" field.
3630 Result: One value list of type "disk_octets".
3632 =item B<GetDiskOps> B<true>|B<false>
3634 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3635 iSCSI, etc. operations will be read. This will be the total number of
3636 operations on your NetApp without any information about individual volumes or
3639 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3640 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3648 Result: A variable number of value lists of type "disk_ops_complex". Each type
3649 of operation will result in one value list with the name of the operation as
3654 =head3 The WAFL block
3656 This will collect various performance data about the WAFL file system. At the
3657 moment this just means cache performance.
3659 B<Note:> To get this data the collectd user needs the
3660 "api-perf-object-get-instances" capability.
3662 B<Note:> The interface to get these values is classified as "Diagnostics" by
3663 NetApp. This means that it is not guaranteed to be stable even between minor
3668 =item B<Interval> I<Seconds>
3670 Collect disk statistics every I<Seconds> seconds.
3672 =item B<GetNameCache> B<true>|B<false>
3680 Result: One value list of type "cache_ratio" and type instance
3683 =item B<GetDirCache> B<true>|B<false>
3691 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3693 =item B<GetInodeCache> B<true>|B<false>
3701 Result: One value list of type "cache_ratio" and type instance
3704 =item B<GetBufferCache> B<true>|B<false>
3706 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3707 in the "Cache hit" field.
3715 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3719 =head3 The Disks block
3721 This will collect performance data about the individual disks in the NetApp.
3723 B<Note:> To get this data the collectd user needs the
3724 "api-perf-object-get-instances" capability.
3728 =item B<Interval> I<Seconds>
3730 Collect disk statistics every I<Seconds> seconds.
3732 =item B<GetBusy> B<true>|B<false>
3734 If you set this option to true the busy time of all disks will be calculated
3735 and the value of the busiest disk in the system will be written.
3737 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3738 in the "Disk util" field. Probably.
3746 Result: One value list of type "percent" and type instance "disk_busy".
3750 =head3 The VolumePerf block
3752 This will collect various performance data about the individual volumes.
3754 You can select which data to collect about which volume using the following
3755 options. They follow the standard ignorelist semantic.
3757 B<Note:> To get this data the collectd user needs the
3758 I<api-perf-object-get-instances> capability.
3762 =item B<Interval> I<Seconds>
3764 Collect volume performance data every I<Seconds> seconds.
3766 =item B<GetIO> I<Volume>
3768 =item B<GetOps> I<Volume>
3770 =item B<GetLatency> I<Volume>
3772 Select the given volume for IO, operations or latency statistics collection.
3773 The argument is the name of the volume without the C</vol/> prefix.
3775 Since the standard ignorelist functionality is used here, you can use a string
3776 starting and ending with a slash to specify regular expression matching: To
3777 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3780 GetIO "/^vol[027]$/"
3782 If no regular expression is specified, an exact match is required. Both,
3783 regular and exact matching are case sensitive.
3785 If no volume was specified at all for either of the three options, that data
3786 will be collected for all available volumes.
3788 =item B<IgnoreSelectedIO> B<true>|B<false>
3790 =item B<IgnoreSelectedOps> B<true>|B<false>
3792 =item B<IgnoreSelectedLatency> B<true>|B<false>
3794 When set to B<true>, the volumes selected for IO, operations or latency
3795 statistics collection will be ignored and the data will be collected for all
3798 When set to B<false>, data will only be collected for the specified volumes and
3799 all other volumes will be ignored.
3801 If no volumes have been specified with the above B<Get*> options, all volumes
3802 will be collected regardless of the B<IgnoreSelected*> option.
3804 Defaults to B<false>
3808 =head3 The VolumeUsage block
3810 This will collect capacity data about the individual volumes.
3812 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3817 =item B<Interval> I<Seconds>
3819 Collect volume usage statistics every I<Seconds> seconds.
3821 =item B<GetCapacity> I<VolumeName>
3823 The current capacity of the volume will be collected. This will result in two
3824 to four value lists, depending on the configuration of the volume. All data
3825 sources are of type "df_complex" with the name of the volume as
3828 There will be type_instances "used" and "free" for the number of used and
3829 available bytes on the volume. If the volume has some space reserved for
3830 snapshots, a type_instance "snap_reserved" will be available. If the volume
3831 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3832 number of bytes saved by the SIS feature.
3834 B<Note:> The current NetApp API has a bug that results in this value being
3835 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3836 number which works most of the time. If you see strange values here, bug
3837 NetApp support to fix this.
3839 Repeat this option to specify multiple volumes.
3841 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3843 Specify whether to collect only the volumes selected by the B<GetCapacity>
3844 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3845 B<false>. However, if no B<GetCapacity> option is specified at all, all
3846 capacities will be selected anyway.
3848 =item B<GetSnapshot> I<VolumeName>
3850 Select volumes from which to collect snapshot information.
3852 Usually, the space used for snapshots is included in the space reported as
3853 "used". If snapshot information is collected as well, the space used for
3854 snapshots is subtracted from the used space.
3856 To make things even more interesting, it is possible to reserve space to be
3857 used for snapshots. If the space required for snapshots is less than that
3858 reserved space, there is "reserved free" and "reserved used" space in addition
3859 to "free" and "used". If the space required for snapshots exceeds the reserved
3860 space, that part allocated in the normal space is subtracted from the "used"
3863 Repeat this option to specify multiple volumes.
3865 =item B<IgnoreSelectedSnapshot>
3867 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3868 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3869 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3870 capacities will be selected anyway.
3874 =head3 The Quota block
3876 This will collect (tree) quota statistics (used disk space and number of used
3877 files). This mechanism is useful to get usage information for single qtrees.
3878 In case the quotas are not used for any other purpose, an entry similar to the
3879 following in C</etc/quotas> would be sufficient:
3881 /vol/volA/some_qtree tree - - - - -
3883 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3887 =item B<Interval> I<Seconds>
3889 Collect SnapVault(R) statistics every I<Seconds> seconds.
3893 =head3 The SnapVault block
3895 This will collect statistics about the time and traffic of SnapVault(R)
3900 =item B<Interval> I<Seconds>
3902 Collect SnapVault(R) statistics every I<Seconds> seconds.
3906 =head2 Plugin C<netlink>
3908 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3909 statistics of various interface and routing aspects.
3913 =item B<Interface> I<Interface>
3915 =item B<VerboseInterface> I<Interface>
3917 Instruct the plugin to collect interface statistics. This is basically the same
3918 as the statistics provided by the C<interface> plugin (see above) but
3919 potentially much more detailed.
3921 When configuring with B<Interface> only the basic statistics will be collected,
3922 namely octets, packets, and errors. These statistics are collected by
3923 the C<interface> plugin, too, so using both at the same time is no benefit.
3925 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3926 so that no data needs to be collected twice if you use the C<interface> plugin.
3927 This includes dropped packets, received multicast packets, collisions and a
3928 whole zoo of differentiated RX and TX errors. You can try the following command
3929 to get an idea of what awaits you:
3933 If I<Interface> is B<All>, all interfaces will be selected.
3935 =item B<QDisc> I<Interface> [I<QDisc>]
3937 =item B<Class> I<Interface> [I<Class>]
3939 =item B<Filter> I<Interface> [I<Filter>]
3941 Collect the octets and packets that pass a certain qdisc, class or filter.
3943 QDiscs and classes are identified by their type and handle (or classid).
3944 Filters don't necessarily have a handle, therefore the parent's handle is used.
3945 The notation used in collectd differs from that used in tc(1) in that it
3946 doesn't skip the major or minor number if it's zero and doesn't print special
3947 ids by their name. So, for example, a qdisc may be identified by
3948 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3949 thus not displayed by tc(1).
3951 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3952 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3953 associated with that interface will be collected.
3955 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3956 used. This may lead to problems when more than one filter is attached to a
3957 qdisc or class. This isn't nice, but we don't know how this could be done any
3958 better. If you have a idea, please don't hesitate to tell us.
3960 As with the B<Interface> option you can specify B<All> as the interface,
3961 meaning all interfaces.
3963 Here are some examples to help you understand the above text more easily:
3966 VerboseInterface "All"
3967 QDisc "eth0" "pfifo_fast-1:0"
3969 Class "ppp0" "htb-1:10"
3970 Filter "ppp0" "u32-1:0"
3973 =item B<IgnoreSelected>
3975 The behavior is the same as with all other similar plugins: If nothing is
3976 selected at all, everything is collected. If some things are selected using the
3977 options described above, only these statistics are collected. If you set
3978 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3979 specified statistics will not be collected.
3983 =head2 Plugin C<network>
3985 The Network plugin sends data to a remote instance of collectd, receives data
3986 from a remote instance, or both at the same time. Data which has been received
3987 from the network is usually not transmitted again, but this can be activated, see
3988 the B<Forward> option below.
3990 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3991 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3993 Both, B<Server> and B<Listen> can be used as single option or as block. When
3994 used as block, given options are valid for this socket only. The following
3995 example will export the metrics twice: Once to an "internal" server (without
3996 encryption and signing) and one to an external server (with cryptographic
4000 # Export to an internal server
4001 # (demonstrates usage without additional options)
4002 Server "collectd.internal.tld"
4004 # Export to an external server
4005 # (demonstrates usage with signature options)
4006 <Server "collectd.external.tld">
4007 SecurityLevel "sign"
4008 Username "myhostname"
4015 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4017 The B<Server> statement/block sets the server to send datagrams to. The
4018 statement may occur multiple times to send each datagram to multiple
4021 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4022 optional second argument specifies a port number or a service name. If not
4023 given, the default, B<25826>, is used.
4025 The following options are recognized within B<Server> blocks:
4029 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4031 Set the security you require for network communication. When the security level
4032 has been set to B<Encrypt>, data sent over the network will be encrypted using
4033 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4034 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4035 authentication code. When set to B<None>, data is sent without any security.
4037 This feature is only available if the I<network> plugin was linked with
4040 =item B<Username> I<Username>
4042 Sets the username to transmit. This is used by the server to lookup the
4043 password. See B<AuthFile> below. All security levels except B<None> require
4046 This feature is only available if the I<network> plugin was linked with
4049 =item B<Password> I<Password>
4051 Sets a password (shared secret) for this socket. All security levels except
4052 B<None> require this setting.
4054 This feature is only available if the I<network> plugin was linked with
4057 =item B<Interface> I<Interface name>
4059 Set the outgoing interface for IP packets. This applies at least
4060 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4061 undefined or a non-existent interface name is specified, the default
4062 behavior is to let the kernel choose the appropriate interface. Be warned
4063 that the manual selection of an interface for unicast traffic is only
4064 necessary in rare cases.
4066 =item B<ResolveInterval> I<Seconds>
4068 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4069 useful to force a regular DNS lookup to support a high availability setup. If
4070 not specified, re-resolves are never attempted.
4074 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4076 The B<Listen> statement sets the interfaces to bind to. When multiple
4077 statements are found the daemon will bind to multiple interfaces.
4079 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4080 the argument is a multicast address the daemon will join that multicast group.
4081 The optional second argument specifies a port number or a service name. If not
4082 given, the default, B<25826>, is used.
4084 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4088 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4090 Set the security you require for network communication. When the security level
4091 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4092 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4093 signed and encrypted data is accepted. When set to B<None>, all data will be
4094 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4095 decrypted if possible.
4097 This feature is only available if the I<network> plugin was linked with
4100 =item B<AuthFile> I<Filename>
4102 Sets a file in which usernames are mapped to passwords. These passwords are
4103 used to verify signatures and to decrypt encrypted network packets. If
4104 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4105 verified and encrypted packets are decrypted. Otherwise, signed data is
4106 accepted without checking the signature and encrypted data cannot be decrypted.
4107 For the other security levels this option is mandatory.
4109 The file format is very simple: Each line consists of a username followed by a
4110 colon and any number of spaces followed by the password. To demonstrate, an
4111 example file could look like this:
4116 Each time a packet is received, the modification time of the file is checked
4117 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4118 the file is being read, it is locked using L<fcntl(2)>.
4120 =item B<Interface> I<Interface name>
4122 Set the incoming interface for IP packets explicitly. This applies at least
4123 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4124 undefined or a non-existent interface name is specified, the default
4125 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4126 traffic gets only accepted, if it arrives on the given interface.
4130 =item B<TimeToLive> I<1-255>
4132 Set the time-to-live of sent packets. This applies to all, unicast and
4133 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4134 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4137 =item B<MaxPacketSize> I<1024-65535>
4139 Set the maximum size for datagrams received over the network. Packets larger
4140 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4141 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4144 On the server side, this limit should be set to the largest value used on
4145 I<any> client. Likewise, the value on the client must not be larger than the
4146 value on the server, or data will be lost.
4148 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4149 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4150 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4153 =item B<Forward> I<true|false>
4155 If set to I<true>, write packets that were received via the network plugin to
4156 the sending sockets. This should only be activated when the B<Listen>- and
4157 B<Server>-statements differ. Otherwise packets may be send multiple times to
4158 the same multicast group. While this results in more network traffic than
4159 necessary it's not a huge problem since the plugin has a duplicate detection,
4160 so the values will not loop.
4162 =item B<ReportStats> B<true>|B<false>
4164 The network plugin cannot only receive and send statistics, it can also create
4165 statistics about itself. Collected data included the number of received and
4166 sent octets and packets, the length of the receive queue and the number of
4167 values handled. When set to B<true>, the I<Network plugin> will make these
4168 statistics available. Defaults to B<false>.
4172 =head2 Plugin C<nginx>
4174 This plugin collects the number of connections and requests handled by the
4175 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4176 queries the page provided by the C<ngx_http_stub_status_module> module, which
4177 isn't compiled by default. Please refer to
4178 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4179 how to compile and configure nginx and this module.
4181 The following options are accepted by the C<nginx plugin>:
4185 =item B<URL> I<http://host/nginx_status>
4187 Sets the URL of the C<ngx_http_stub_status_module> output.
4189 =item B<User> I<Username>
4191 Optional user name needed for authentication.
4193 =item B<Password> I<Password>
4195 Optional password needed for authentication.
4197 =item B<VerifyPeer> B<true|false>
4199 Enable or disable peer SSL certificate verification. See
4200 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4202 =item B<VerifyHost> B<true|false>
4204 Enable or disable peer host name verification. If enabled, the plugin checks
4205 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4206 certificate matches the host name provided by the B<URL> option. If this
4207 identity check fails, the connection is aborted. Obviously, only works when
4208 connecting to a SSL enabled server. Enabled by default.
4210 =item B<CACert> I<File>
4212 File that holds one or more SSL certificates. If you want to use HTTPS you will
4213 possibly need this option. What CA certificates come bundled with C<libcurl>
4214 and are checked by default depends on the distribution you use.
4216 =item B<Timeout> I<Milliseconds>
4218 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4219 milliseconds. By default, the configured B<Interval> is used to set the
4224 =head2 Plugin C<notify_desktop>
4226 This plugin sends a desktop notification to a notification daemon, as defined
4227 in the Desktop Notification Specification. To actually display the
4228 notifications, B<notification-daemon> is required and B<collectd> has to be
4229 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4230 environment variables have to be set correctly) and the D-Bus message bus.
4232 The Desktop Notification Specification can be found at
4233 L<http://www.galago-project.org/specs/notification/>.
4237 =item B<OkayTimeout> I<timeout>
4239 =item B<WarningTimeout> I<timeout>
4241 =item B<FailureTimeout> I<timeout>
4243 Set the I<timeout>, in milliseconds, after which to expire the notification
4244 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4245 been specified, the displayed notification will not be closed at all - the
4246 user has to do so herself. These options default to 5000. If a negative number
4247 has been specified, the default is used as well.
4251 =head2 Plugin C<notify_email>
4253 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4254 configured email address.
4256 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4258 Available configuration options:
4262 =item B<From> I<Address>
4264 Email address from which the emails should appear to come from.
4266 Default: C<root@localhost>
4268 =item B<Recipient> I<Address>
4270 Configures the email address(es) to which the notifications should be mailed.
4271 May be repeated to send notifications to multiple addresses.
4273 At least one B<Recipient> must be present for the plugin to work correctly.
4275 =item B<SMTPServer> I<Hostname>
4277 Hostname of the SMTP server to connect to.
4279 Default: C<localhost>
4281 =item B<SMTPPort> I<Port>
4283 TCP port to connect to.
4287 =item B<SMTPUser> I<Username>
4289 Username for ASMTP authentication. Optional.
4291 =item B<SMTPPassword> I<Password>
4293 Password for ASMTP authentication. Optional.
4295 =item B<Subject> I<Subject>
4297 Subject-template to use when sending emails. There must be exactly two
4298 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4299 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4302 Default: C<Collectd notify: %s@%s>
4306 =head2 Plugin C<ntpd>
4308 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
4311 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
4312 the wire - using B<mode 7> specific requests. This mode is deprecated with
4313 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
4314 correctly with them, the ntp daemon must be explicitly configured to
4315 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
4316 manual page for details.
4318 Available configuration options for the C<ntpd> plugin:
4322 =item B<Host> I<Hostname>
4324 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4326 =item B<Port> I<Port>
4328 UDP-Port to connect to. Defaults to B<123>.
4330 =item B<ReverseLookups> B<true>|B<false>
4332 Sets whether or not to perform reverse lookups on peers. Since the name or
4333 IP-address may be used in a filename it is recommended to disable reverse
4334 lookups. The default is to do reverse lookups to preserve backwards
4335 compatibility, though.
4337 =item B<IncludeUnitID> B<true>|B<false>
4339 When a peer is a refclock, include the unit ID in the I<type instance>.
4340 Defaults to B<false> for backward compatibility.
4342 If two refclock peers use the same driver and this is B<false>, the plugin will
4343 try to write simultaneous measurements from both to the same type instance.
4344 This will result in error messages in the log and only one set of measurements
4349 =head2 Plugin C<nut>
4353 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4355 Add a UPS to collect data from. The format is identical to the one accepted by
4360 =head2 Plugin C<olsrd>
4362 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4363 the Optimized Link State Routing daemon and reads information about the current
4364 state of the meshed network.
4366 The following configuration options are understood:
4370 =item B<Host> I<Host>
4372 Connect to I<Host>. Defaults to B<"localhost">.
4374 =item B<Port> I<Port>
4376 Specifies the port to connect to. This must be a string, even if you give the
4377 port as a number rather than a service name. Defaults to B<"2006">.
4379 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4381 Specifies what information to collect about links, i.E<nbsp>e. direct
4382 connections of the daemon queried. If set to B<No>, no information is
4383 collected. If set to B<Summary>, the number of links and the average of all
4384 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4385 If set to B<Detail> LQ and NLQ are collected per link.
4387 Defaults to B<Detail>.
4389 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4391 Specifies what information to collect about routes of the daemon queried. If
4392 set to B<No>, no information is collected. If set to B<Summary>, the number of
4393 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4394 metric and ETX are collected per route.
4396 Defaults to B<Summary>.
4398 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4400 Specifies what information to collect about the global topology. If set to
4401 B<No>, no information is collected. If set to B<Summary>, the number of links
4402 in the entire topology and the average I<link quality> (LQ) is calculated.
4403 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4405 Defaults to B<Summary>.
4409 =head2 Plugin C<onewire>
4411 B<EXPERIMENTAL!> See notes below.
4413 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4414 L<http://owfs.org/> to read sensors connected via the onewire bus.
4416 It can be used in two possible modes - standard or advanced.
4418 In the standard mode only temperature sensors (sensors with the family code
4419 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4420 other sensors you would like to have included, please send a sort request to
4421 the mailing list. You can select sensors to be read or to be ignored depending
4422 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4423 walked and all sensors are read.
4425 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4426 experimental, below.
4428 In the advanced mode you can configure any sensor to be read (only numerical
4429 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4430 In this mode you have to list all the sensors. Neither default bus walk nor
4431 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4432 the path automatically and should produce compatible structure with the "standard"
4433 mode (basically the path is expected as for example
4434 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4435 "F10FCA000800" and the rest after the slash is considered the type - here
4437 There are two advantages to this mode - you can access virtually any sensor
4438 (not just temperature), select whether to use cached or directly read values
4439 and it is slighlty faster. The downside is more complex configuration.
4441 The two modes are distinguished automatically by the format of the address.
4442 It is not possible to mix the two modes. Once a full path is detected in any
4443 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4444 (and as standard addresses will fail parsing they will be ignored).
4448 =item B<Device> I<Device>
4450 Sets the device to read the values from. This can either be a "real" hardware
4451 device, such as a serial port or an USB port, or the address of the
4452 L<owserver(1)> socket, usually B<localhost:4304>.
4454 Though the documentation claims to automatically recognize the given address
4455 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4456 with that version, the following configuration worked for us:
4459 Device "-s localhost:4304"
4462 This directive is B<required> and does not have a default value.
4464 =item B<Sensor> I<Sensor>
4466 In the standard mode selects sensors to collect or to ignore
4467 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4468 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4469 and B<not> include the leading C<10.> family byte and point.
4470 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4471 sensors (see above) are read.
4473 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4474 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4475 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4477 As there can be multiple devices on the bus you can list multiple sensor (use
4478 multiple B<Sensor> elements).
4480 =item B<IgnoreSelected> I<true>|I<false>
4482 If no configuration is given, the B<onewire> plugin will collect data from all
4483 sensors found. This may not be practical, especially if sensors are added and
4484 removed regularly. Sometimes, however, it's easier/preferred to collect only
4485 specific sensors or all sensors I<except> a few specified ones. This option
4486 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4487 B<Sensor> is inverted: All selected interfaces are ignored and all other
4488 interfaces are collected.
4490 Used only in the standard mode - see above.
4492 =item B<Interval> I<Seconds>
4494 Sets the interval in which all sensors should be read. If not specified, the
4495 global B<Interval> setting is used.
4499 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4500 work with big setups. It works with one sensor being attached to one
4501 controller, but as soon as you throw in a couple more senors and maybe a hub
4502 or two, reading all values will take more than ten seconds (the default
4503 interval). We will probably add some separate thread for reading the sensors
4504 and some cache or something like that, but it's not done yet. We will try to
4505 maintain backwards compatibility in the future, but we can't promise. So in
4506 short: If it works for you: Great! But keep in mind that the config I<might>
4507 change, though this is unlikely. Oh, and if you want to help improving this
4508 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4510 =head2 Plugin C<openldap>
4512 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4513 server correctly. The backend database C<monitor> needs to be loaded and
4514 working. See slapd-monitor(5) for the details.
4516 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4517 blocks. Each block requires one string argument as the instance name. For
4522 URL "ldap://localhost/"
4525 URL "ldaps://localhost/"
4529 The instance name will be used as the I<plugin instance>. To emulate the old
4530 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4531 plugin to work correctly, each instance name must be unique. This is not
4532 enforced by the plugin and it is your responsibility to ensure it is.
4534 The following options are accepted within each B<Instance> block:
4538 =item B<URL> I<ldap://host/binddn>
4540 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4543 =item B<StartTLS> B<true|false>
4545 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4546 Disabled by default.
4548 =item B<VerifyHost> B<true|false>
4550 Enables or disables peer host name verification. If enabled, the plugin checks
4551 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4552 certificate matches the host name provided by the B<URL> option. If this
4553 identity check fails, the connection is aborted. Enabled by default.
4555 =item B<CACert> I<File>
4557 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4558 may possibly need this option. What CA certificates are checked by default
4559 depends on the distribution you use and can be changed with the usual ldap
4560 client configuration mechanisms. See ldap.conf(5) for the details.
4562 =item B<Timeout> I<Seconds>
4564 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4565 an infinite timeout.
4567 =item B<Version> I<Version>
4569 An integer which sets the LDAP protocol version number to use when connecting
4570 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4574 =head2 Plugin C<openvpn>
4576 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4577 traffic statistics about connected clients.
4579 To set up OpenVPN to write to the status file periodically, use the
4580 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4581 you need to set the required format, too. This is done by setting
4582 B<--status-version> to B<2>.
4584 So, in a nutshell you need:
4586 openvpn $OTHER_OPTIONS \
4587 --status "/var/run/openvpn-status" 10 \
4594 =item B<StatusFile> I<File>
4596 Specifies the location of the status file.
4598 =item B<ImprovedNamingSchema> B<true>|B<false>
4600 When enabled, the filename of the status file will be used as plugin instance
4601 and the client's "common name" will be used as type instance. This is required
4602 when reading multiple status files. Enabling this option is recommended, but to
4603 maintain backwards compatibility this option is disabled by default.
4605 =item B<CollectCompression> B<true>|B<false>
4607 Sets whether or not statistics about the compression used by OpenVPN should be
4608 collected. This information is only available in I<single> mode. Enabled by
4611 =item B<CollectIndividualUsers> B<true>|B<false>
4613 Sets whether or not traffic information is collected for each connected client
4614 individually. If set to false, currently no traffic data is collected at all
4615 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4617 =item B<CollectUserCount> B<true>|B<false>
4619 When enabled, the number of currently connected clients or users is collected.
4620 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4621 can be configured independently from that option. Defaults to B<false>.
4625 =head2 Plugin C<oracle>
4627 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4628 Oracle® Database and lets you execute SQL statements there. It is very similar
4629 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4630 plugin's documentation above for details.
4633 <Query "out_of_stock">
4634 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4637 # InstancePrefix "foo"
4638 InstancesFrom "category"
4642 <Database "product_information">
4646 Query "out_of_stock"
4650 =head3 B<Query> blocks
4652 The Query blocks are handled identically to the Query blocks of the "dbi"
4653 plugin. Please see its documentation above for details on how to specify
4656 =head3 B<Database> blocks
4658 Database blocks define a connection to a database and which queries should be
4659 sent to that database. Each database needs a "name" as string argument in the
4660 starting tag of the block. This name will be used as "PluginInstance" in the
4661 values submitted to the daemon. Other than that, that name is not used.
4665 =item B<ConnectID> I<ID>
4667 Defines the "database alias" or "service name" to connect to. Usually, these
4668 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4670 =item B<Host> I<Host>
4672 Hostname to use when dispatching values for this database. Defaults to using
4673 the global hostname of the I<collectd> instance.
4675 =item B<Username> I<Username>
4677 Username used for authentication.
4679 =item B<Password> I<Password>
4681 Password used for authentication.
4683 =item B<Query> I<QueryName>
4685 Associates the query named I<QueryName> with this database connection. The
4686 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4687 blocks you want to refer to must be placed above the database block you want to
4692 =head2 Plugin C<perl>
4694 This plugin embeds a Perl-interpreter into collectd and provides an interface
4695 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4697 =head2 Plugin C<pinba>
4699 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4700 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4701 PHP-based webpage has been delivered, the extension will send a UDP packet
4702 containing timing information, peak memory usage and so on. The plugin will
4703 wait for such packets, parse them and account the provided information, which
4704 is then dispatched to the daemon once per interval.
4711 # Overall statistics for the website.
4713 Server "www.example.com"
4715 # Statistics for www-a only
4717 Host "www-a.example.com"
4718 Server "www.example.com"
4720 # Statistics for www-b only
4722 Host "www-b.example.com"
4723 Server "www.example.com"
4727 The plugin provides the following configuration options:
4731 =item B<Address> I<Node>
4733 Configures the address used to open a listening socket. By default, plugin will
4734 bind to the I<any> address C<::0>.
4736 =item B<Port> I<Service>
4738 Configures the port (service) to bind to. By default the default Pinba port
4739 "30002" will be used. The option accepts service names in addition to port
4740 numbers and thus requires a I<string> argument.
4742 =item E<lt>B<View> I<Name>E<gt> block
4744 The packets sent by the Pinba extension include the hostname of the server, the
4745 server name (the name of the virtual host) and the script that was executed.
4746 Using B<View> blocks it is possible to separate the data into multiple groups
4747 to get more meaningful statistics. Each packet is added to all matching groups,
4748 so that a packet may be accounted for more than once.
4752 =item B<Host> I<Host>
4754 Matches the hostname of the system the webserver / script is running on. This
4755 will contain the result of the L<gethostname(2)> system call. If not
4756 configured, all hostnames will be accepted.
4758 =item B<Server> I<Server>
4760 Matches the name of the I<virtual host>, i.e. the contents of the
4761 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4762 server names will be accepted.
4764 =item B<Script> I<Script>
4766 Matches the name of the I<script name>, i.e. the contents of the
4767 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4768 script names will be accepted.
4774 =head2 Plugin C<ping>
4776 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4777 configured hosts periodically and measures the network latency. Whenever the
4778 C<read> function of the plugin is called, it submits the average latency, the
4779 standard deviation and the drop rate for each host.
4781 Available configuration options:
4785 =item B<Host> I<IP-address>
4787 Host to ping periodically. This option may be repeated several times to ping
4790 =item B<Interval> I<Seconds>
4792 Sets the interval in which to send ICMP echo packets to the configured hosts.
4793 This is B<not> the interval in which statistics are queries from the plugin but
4794 the interval in which the hosts are "pinged". Therefore, the setting here
4795 should be smaller than or equal to the global B<Interval> setting. Fractional
4796 times, such as "1.24" are allowed.
4800 =item B<Timeout> I<Seconds>
4802 Time to wait for a response from the host to which an ICMP packet had been
4803 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4804 to be down or the packet to be dropped. This setting must be smaller than the
4805 B<Interval> setting above for the plugin to work correctly. Fractional
4806 arguments are accepted.
4810 =item B<TTL> I<0-255>
4812 Sets the Time-To-Live of generated ICMP packets.
4814 =item B<SourceAddress> I<host>
4816 Sets the source address to use. I<host> may either be a numerical network
4817 address or a network hostname.
4819 =item B<Device> I<name>
4821 Sets the outgoing network device to be used. I<name> has to specify an
4822 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4825 =item B<MaxMissed> I<Packets>
4827 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4828 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4830 Default: B<-1> (disabled)
4834 =head2 Plugin C<postgresql>
4836 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4837 keeps a persistent connection to all configured databases and tries to
4838 reconnect if the connection has been interrupted. A database is configured by
4839 specifying a B<Database> block as described below. The default statistics are
4840 collected from PostgreSQL's B<statistics collector> which thus has to be
4841 enabled for this plugin to work correctly. This should usually be the case by
4842 default. See the section "The Statistics Collector" of the B<PostgreSQL
4843 Documentation> for details.
4845 By specifying custom database queries using a B<Query> block as described
4846 below, you may collect any data that is available from some PostgreSQL
4847 database. This way, you are able to access statistics of external daemons
4848 which are available in a PostgreSQL database or use future or special
4849 statistics provided by PostgreSQL without the need to upgrade your collectd
4852 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4853 PostgreSQL databases as well. This has been implemented in a generic way. You
4854 need to specify an SQL statement which will then be executed by collectd in
4855 order to write the data (see below for details). The benefit of that approach
4856 is that there is no fixed database layout. Rather, the layout may be optimized
4857 for the current setup.
4859 The B<PostgreSQL Documentation> manual can be found at
4860 L<http://www.postgresql.org/docs/manuals/>.
4864 Statement "SELECT magic FROM wizard WHERE host = $1;"
4868 InstancePrefix "magic"
4873 <Query rt36_tickets>
4874 Statement "SELECT COUNT(type) AS count, type \
4876 WHEN resolved = 'epoch' THEN 'open' \
4877 ELSE 'resolved' END AS type \
4878 FROM tickets) type \
4882 InstancePrefix "rt36_tickets"
4883 InstancesFrom "type"
4889 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4899 KRBSrvName "kerberos_service_name"
4905 Service "service_name"
4906 Query backend # predefined
4917 The B<Query> block defines one database query which may later be used by a
4918 database definition. It accepts a single mandatory argument which specifies
4919 the name of the query. The names of all queries have to be unique (see the
4920 B<MinVersion> and B<MaxVersion> options below for an exception to this
4921 rule). The following configuration options are available to define the query:
4923 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4924 blocks define how to handle the values returned from the query. They define
4925 which column holds which value and how to dispatch that value to the daemon.
4926 Multiple B<Result> blocks may be used to extract multiple values from a single
4931 =item B<Statement> I<sql query statement>
4933 Specify the I<sql query statement> which the plugin should execute. The string
4934 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4935 first, second, etc. parameter. The value of the parameters is specified by the
4936 B<Param> configuration option - see below for details. To include a literal
4937 B<$> character followed by a number, surround it with single quotes (B<'>).
4939 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4940 allowed. Note, however, that only a single command may be used. Semicolons are
4941 allowed as long as a single non-empty command has been specified only.
4943 The returned lines will be handled separately one after another.
4945 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4947 Specify the parameters which should be passed to the SQL query. The parameters
4948 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4949 they appear in the configuration file. The value of the parameter is
4950 determined depending on the value of the B<Param> option as follows:
4956 The configured hostname of the database connection. If a UNIX domain socket is
4957 used, the parameter expands to "localhost".
4961 The name of the database of the current connection.
4965 The name of the database plugin instance. See the B<Instance> option of the
4966 database specification below for details.
4970 The username used to connect to the database.
4974 The interval with which this database is queried (as specified by the database
4975 specific or global B<Interval> options).
4979 Please note that parameters are only supported by PostgreSQL's protocol
4980 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4982 =item B<Type> I<type>
4984 The I<type> name to be used when dispatching the values. The type describes
4985 how to handle the data and where to store it. See L<types.db(5)> for more
4986 details on types and their configuration. The number and type of values (as
4987 selected by the B<ValuesFrom> option) has to match the type of the given name.
4989 This option is required inside a B<Result> block.
4991 =item B<InstancePrefix> I<prefix>
4993 =item B<InstancesFrom> I<column0> [I<column1> ...]
4995 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4996 B<InstancePrefix> defines a static prefix that will be prepended to all type
4997 instances. B<InstancesFrom> defines the column names whose values will be used
4998 to create the type instance. Multiple values will be joined together using the
4999 hyphen (C<->) as separation character.
5001 The plugin itself does not check whether or not all built instances are
5002 different. It is your responsibility to assure that each is unique.
5004 Both options are optional. If none is specified, the type instance will be
5007 =item B<ValuesFrom> I<column0> [I<column1> ...]
5009 Names the columns whose content is used as the actual data for the data sets
5010 that are dispatched to the daemon. How many such columns you need is
5011 determined by the B<Type> setting as explained above. If you specify too many
5012 or not enough columns, the plugin will complain about that and no data will be
5013 submitted to the daemon.
5015 The actual data type, as seen by PostgreSQL, is not that important as long as
5016 it represents numbers. The plugin will automatically cast the values to the
5017 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
5018 L<strtod(3)> functions, so anything supported by those functions is supported
5019 by the plugin as well.
5021 This option is required inside a B<Result> block and may be specified multiple
5022 times. If multiple B<ValuesFrom> options are specified, the columns are read
5025 =item B<MinVersion> I<version>
5027 =item B<MaxVersion> I<version>
5029 Specify the minimum or maximum version of PostgreSQL that this query should be
5030 used with. Some statistics might only be available with certain versions of
5031 PostgreSQL. This allows you to specify multiple queries with the same name but
5032 which apply to different versions, thus allowing you to use the same
5033 configuration in a heterogeneous environment.
5035 The I<version> has to be specified as the concatenation of the major, minor
5036 and patch-level versions, each represented as two-decimal-digit numbers. For
5037 example, version 8.2.3 will become 80203.
5041 The following predefined queries are available (the definitions can be found
5042 in the F<postgresql_default.conf> file which, by default, is available at
5043 C<I<prefix>/share/collectd/>):
5049 This query collects the number of backends, i.E<nbsp>e. the number of
5052 =item B<transactions>
5054 This query collects the numbers of committed and rolled-back transactions of
5059 This query collects the numbers of various table modifications (i.E<nbsp>e.
5060 insertions, updates, deletions) of the user tables.
5062 =item B<query_plans>
5064 This query collects the numbers of various table scans and returned tuples of
5067 =item B<table_states>
5069 This query collects the numbers of live and dead rows in the user tables.
5073 This query collects disk block access counts for user tables.
5077 This query collects the on-disk size of the database in bytes.
5081 In addition, the following detailed queries are available by default. Please
5082 note that each of those queries collects information B<by table>, thus,
5083 potentially producing B<a lot> of data. For details see the description of the
5084 non-by_table queries above.
5088 =item B<queries_by_table>
5090 =item B<query_plans_by_table>
5092 =item B<table_states_by_table>
5094 =item B<disk_io_by_table>
5098 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5099 mandatory argument specifying the name of the writer. This will then be used
5100 in the B<Database> specification in order to activate the writer instance. The
5101 names of all writers have to be unique. The following options may be
5106 =item B<Statement> I<sql statement>
5108 This mandatory option specifies the SQL statement that will be executed for
5109 each submitted value. A single SQL statement is allowed only. Anything after
5110 the first semicolon will be ignored.
5112 Nine parameters will be passed to the statement and should be specified as
5113 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5114 values are made available through those parameters:
5120 The timestamp of the queried value as a floating point number.
5124 The hostname of the queried value.
5128 The plugin name of the queried value.
5132 The plugin instance of the queried value. This value may be B<NULL> if there
5133 is no plugin instance.
5137 The type of the queried value (cf. L<types.db(5)>).
5141 The type instance of the queried value. This value may be B<NULL> if there is
5146 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5147 sources of the submitted value-list).
5151 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5152 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5153 B<StoreRates> is enabled (which is the default, see below), all types will be
5158 An array of the submitted values. The dimensions of the value name and value
5163 In general, it is advisable to create and call a custom function in the
5164 PostgreSQL database for this purpose. Any procedural language supported by
5165 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5168 =item B<StoreRates> B<false>|B<true>
5170 If set to B<true> (the default), convert counter values to rates. If set to
5171 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5176 The B<Database> block defines one PostgreSQL database for which to collect
5177 statistics. It accepts a single mandatory argument which specifies the
5178 database name. None of the other options are required. PostgreSQL will use
5179 default values as documented in the section "CONNECTING TO A DATABASE" in the
5180 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5181 the user collectd is run as and special environment variables. See the manpage
5186 =item B<Interval> I<seconds>
5188 Specify the interval with which the database should be queried. The default is
5189 to use the global B<Interval> setting.
5191 =item B<CommitInterval> I<seconds>
5193 This option may be used for database connections which have "writers" assigned
5194 (see above). If specified, it causes a writer to put several updates into a
5195 single transaction. This transaction will last for the specified amount of
5196 time. By default, each update will be executed in a separate transaction. Each
5197 transaction generates a fair amount of overhead which can, thus, be reduced by
5198 activating this option. The draw-back is, that data covering the specified
5199 amount of time will be lost, for example, if a single statement within the
5200 transaction fails or if the database server crashes.
5202 =item B<Instance> I<name>
5204 Specify the plugin instance name that should be used instead of the database
5205 name (which is the default, if this option has not been specified). This
5206 allows to query multiple databases of the same name on the same host (e.g.
5207 when running multiple database server versions in parallel).
5209 =item B<Host> I<hostname>
5211 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5212 value begins with a slash, it is interpreted as the directory name in which to
5213 look for the UNIX domain socket.
5215 This option is also used to determine the hostname that is associated with a
5216 collected data set. If it has been omitted or either begins with with a slash
5217 or equals B<localhost> it will be replaced with the global hostname definition
5218 of collectd. Any other value will be passed literally to collectd when
5219 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5221 =item B<Port> I<port>
5223 Specify the TCP port or the local UNIX domain socket file extension of the
5226 =item B<User> I<username>
5228 Specify the username to be used when connecting to the server.
5230 =item B<Password> I<password>
5232 Specify the password to be used when connecting to the server.
5234 =item B<ExpireDelay> I<delay>
5236 Skip expired values in query output.
5238 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5240 Specify whether to use an SSL connection when contacting the server. The
5241 following modes are supported:
5247 Do not use SSL at all.
5251 First, try to connect without using SSL. If that fails, try using SSL.
5253 =item I<prefer> (default)
5255 First, try to connect using SSL. If that fails, try without using SSL.
5263 =item B<Instance> I<name>
5265 Specify the plugin instance name that should be used instead of the database
5266 name (which is the default, if this option has not been specified). This
5267 allows to query multiple databases of the same name on the same host (e.g.
5268 when running multiple database server versions in parallel).
5270 =item B<KRBSrvName> I<kerberos_service_name>
5272 Specify the Kerberos service name to use when authenticating with Kerberos 5
5273 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5274 B<PostgreSQL Documentation> for details.
5276 =item B<Service> I<service_name>
5278 Specify the PostgreSQL service name to use for additional parameters. That
5279 service has to be defined in F<pg_service.conf> and holds additional
5280 connection parameters. See the section "The Connection Service File" in the
5281 B<PostgreSQL Documentation> for details.
5283 =item B<Query> I<query>
5285 Specifies a I<query> which should be executed in the context of the database
5286 connection. This may be any of the predefined or user-defined queries. If no
5287 such option is given, it defaults to "backends", "transactions", "queries",
5288 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5289 has been specified). Else, the specified queries are used only.
5291 =item B<Writer> I<writer>
5293 Assigns the specified I<writer> backend to the database connection. This
5294 causes all collected data to be send to the database using the settings
5295 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5296 below for details on how to selectively send data to certain plugins).
5298 Each writer will register a flush callback which may be used when having long
5299 transactions enabled (see the B<CommitInterval> option above). When issuing
5300 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5301 transaction will be committed right away. Two different kinds of flush
5302 callbacks are available with the C<postgresql> plugin:
5308 Flush all writer backends.
5310 =item B<postgresql->I<database>
5312 Flush all writers of the specified I<database> only.
5318 =head2 Plugin C<powerdns>
5320 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5321 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5322 values, many of which are probably meaningless to most users, but may be useful
5323 for some. So you may chose which values to collect, but if you don't, some
5324 reasonable defaults will be collected.
5327 <Server "server_name">
5329 Collect "udp-answers" "udp-queries"
5330 Socket "/var/run/pdns.controlsocket"
5332 <Recursor "recursor_name">
5334 Collect "cache-hits" "cache-misses"
5335 Socket "/var/run/pdns_recursor.controlsocket"
5337 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5342 =item B<Server> and B<Recursor> block
5344 The B<Server> block defines one authoritative server to query, the B<Recursor>
5345 does the same for an recursing server. The possible options in both blocks are
5346 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5351 =item B<Collect> I<Field>
5353 Using the B<Collect> statement you can select which values to collect. Here,
5354 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5355 C<dlg-only-drops>, C<answers10-100>.
5357 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5358 When querying the server a C<SHOW *> command is issued in any case, because
5359 that's the only way of getting multiple values out of the server at once.
5360 collectd then picks out the values you have selected. When querying the
5361 recursor, a command is generated to query exactly these values. So if you
5362 specify invalid fields when querying the recursor, a syntax error may be
5363 returned by the daemon and collectd may not collect any values at all.
5365 If no B<Collect> statement is given, the following B<Server> values will be
5372 =item packetcache-hit
5374 =item packetcache-miss
5376 =item packetcache-size
5378 =item query-cache-hit
5380 =item query-cache-miss
5382 =item recursing-answers
5384 =item recursing-questions
5396 The following B<Recursor> values will be collected by default:
5400 =item noerror-answers
5402 =item nxdomain-answers
5404 =item servfail-answers
5422 Please note that up to that point collectd doesn't know what values are
5423 available on the server and values that are added do not need a change of the
5424 mechanism so far. However, the values must be mapped to collectd's naming
5425 scheme, which is done using a lookup table that lists all known values. If
5426 values are added in the future and collectd does not know about them, you will
5427 get an error much like this:
5429 powerdns plugin: submit: Not found in lookup table: foobar = 42
5431 In this case please file a bug report with the collectd team.
5433 =item B<Socket> I<Path>
5435 Configures the path to the UNIX domain socket to be used when connecting to the
5436 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5437 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5438 will be used for the recursor.
5442 =item B<LocalSocket> I<Path>
5444 Querying the recursor is done using UDP. When using UDP over UNIX domain
5445 sockets, the client socket needs a name in the file system, too. You can set
5446 this local name to I<Path> using the B<LocalSocket> option. The default is
5447 C<I<prefix>/var/run/collectd-powerdns>.
5451 =head2 Plugin C<processes>
5455 =item B<Process> I<Name>
5457 Select more detailed statistics of processes matching this name. The statistics
5458 collected for these selected processes are size of the resident segment size
5459 (RSS), user- and system-time used, number of processes and number of threads,
5460 io data (where available) and minor and major pagefaults.
5462 Some platforms have a limit on the length of process names. I<Name> must stay
5465 =item B<ProcessMatch> I<name> I<regex>
5467 Similar to the B<Process> option this allows to select more detailed
5468 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5469 details). The statistics of all matching processes are summed up and
5470 dispatched to the daemon using the specified I<name> as an identifier. This
5471 allows to "group" several processes together. I<name> must not contain
5476 =head2 Plugin C<protocols>
5478 Collects a lot of information about various network protocols, such as I<IP>,
5479 I<TCP>, I<UDP>, etc.
5481 Available configuration options:
5485 =item B<Value> I<Selector>
5487 Selects whether or not to select a specific value. The string being matched is
5488 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5489 plugin instance and I<ValueName> will be used as type instance. An example of
5490 the string being used would be C<Tcp:RetransSegs>.
5492 You can use regular expressions to match a large number of values with just one
5493 configuration option. To select all "extended" I<TCP> values, you could use the
5494 following statement:
5498 Whether only matched values are selected or all matched values are ignored
5499 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5500 If no value is configured at all, all values will be selected.
5502 =item B<IgnoreSelected> B<true>|B<false>
5504 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5505 matching values will be ignored.
5509 =head2 Plugin C<python>
5511 This plugin embeds a Python-interpreter into collectd and provides an interface
5512 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5514 =head2 Plugin C<routeros>
5516 The C<routeros> plugin connects to a device running I<RouterOS>, the
5517 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5518 I<librouteros> to connect and reads information about the interfaces and
5519 wireless connections of the device. The configuration supports querying
5524 Host "router0.example.com"
5527 CollectInterface true
5532 Host "router1.example.com"
5535 CollectInterface true
5536 CollectRegistrationTable true
5542 As you can see above, the configuration of the I<routeros> plugin consists of
5543 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5544 options are understood:
5548 =item B<Host> I<Host>
5550 Hostname or IP-address of the router to connect to.
5552 =item B<Port> I<Port>
5554 Port name or port number used when connecting. If left unspecified, the default
5555 will be chosen by I<librouteros>, currently "8728". This option expects a
5556 string argument, even when a numeric port number is given.
5558 =item B<User> I<User>
5560 Use the user name I<User> to authenticate. Defaults to "admin".
5562 =item B<Password> I<Password>
5564 Set the password used to authenticate.
5566 =item B<CollectInterface> B<true>|B<false>
5568 When set to B<true>, interface statistics will be collected for all interfaces
5569 present on the device. Defaults to B<false>.
5571 =item B<CollectRegistrationTable> B<true>|B<false>
5573 When set to B<true>, information about wireless LAN connections will be
5574 collected. Defaults to B<false>.
5576 =item B<CollectCPULoad> B<true>|B<false>
5578 When set to B<true>, information about the CPU usage will be collected. The
5579 number is a dimensionless value where zero indicates no CPU usage at all.
5580 Defaults to B<false>.
5582 =item B<CollectMemory> B<true>|B<false>
5584 When enabled, the amount of used and free memory will be collected. How used
5585 memory is calculated is unknown, for example whether or not caches are counted
5587 Defaults to B<false>.
5589 =item B<CollectDF> B<true>|B<false>
5591 When enabled, the amount of used and free disk space will be collected.
5592 Defaults to B<false>.
5594 =item B<CollectDisk> B<true>|B<false>
5596 When enabled, the number of sectors written and bad blocks will be collected.
5597 Defaults to B<false>.
5601 =head2 Plugin C<redis>
5603 The I<Redis plugin> connects to one or more Redis servers and gathers
5604 information about each server's state. For each server there is a I<Node> block
5605 which configures the connection parameters for this node.
5612 <Query "LLEN myqueue">
5619 The information shown in the synopsis above is the I<default configuration>
5620 which is used by the plugin if no configuration is present.
5624 =item B<Node> I<Nodename>
5626 The B<Node> block identifies a new Redis node, that is a new Redis instance
5627 running in an specified host and port. The name for node is a canonical
5628 identifier which is used as I<plugin instance>. It is limited to
5629 64E<nbsp>characters in length.
5631 =item B<Host> I<Hostname>
5633 The B<Host> option is the hostname or IP-address where the Redis instance is
5636 =item B<Port> I<Port>
5638 The B<Port> option is the TCP port on which the Redis instance accepts
5639 connections. Either a service name of a port number may be given. Please note
5640 that numerical port numbers must be given as a string, too.
5642 =item B<Password> I<Password>
5644 Use I<Password> to authenticate when connecting to I<Redis>.
5646 =item B<Timeout> I<Milliseconds>
5648 The B<Timeout> option set the socket timeout for node response. Since the Redis
5649 read function is blocking, you should keep this value as low as possible. Keep
5650 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5651 than B<Interval> defined globally.
5653 =item B<Query> I<Querystring>
5655 The B<Query> block identifies a query to execute against the redis server.
5656 There may be an arbitrary number of queries to execute.
5658 =item B<Type> I<Collectd type>
5660 Within a query definition, a valid collectd type to use as when submitting
5661 the result of the query. When not supplied, will default to B<gauge>.
5663 =item B<Instance> I<Type instance>
5665 Within a query definition, an optional type instance to use when submitting
5666 the result of the query. When not supplied will default to the escaped
5667 command, up to 64 chars.
5671 =head2 Plugin C<rrdcached>
5673 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5674 to store values to RRD files in an efficient manner. The combination of the
5675 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5676 way the C<rrdtool> plugin works (see below). The added abstraction layer
5677 provides a number of benefits, though: Because the cache is not within
5678 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5679 restarted. This results in much shorter (if any) gaps in graphs, especially
5680 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5681 daemon so that it can flush values to disk automatically when needed. This
5682 allows to integrate automated flushing of values into graphing solutions much
5685 There are disadvantages, though: The daemon may reside on a different host, so
5686 it may not be possible for C<collectd> to create the appropriate RRD files
5687 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5688 different base directory, so relative paths may do weird stuff if you're not
5691 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5692 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5693 setting should be set to an absolute path, so that a changed base directory
5694 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5698 =item B<DaemonAddress> I<Address>
5700 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5701 library. See L<rrdcached(1)> for details. Example:
5703 <Plugin "rrdcached">
5704 DaemonAddress "unix:/var/run/rrdcached.sock"
5707 =item B<DataDir> I<Directory>
5709 Set the base directory in which the RRD files reside. If this is a relative
5710 path, it is relative to the working base directory of the C<rrdcached> daemon!
5711 Use of an absolute path is recommended.
5713 =item B<CreateFiles> B<true>|B<false>
5715 Enables or disables the creation of RRD files. If the daemon is not running
5716 locally, or B<DataDir> is set to a relative path, this will not work as
5717 expected. Default is B<true>.
5719 =item B<CreateFilesAsync> B<false>|B<true>
5721 When enabled, new RRD files are enabled asynchronously, using a separate thread
5722 that runs in the background. This prevents writes to block, which is a problem
5723 especially when many hundreds of files need to be created at once. However,
5724 since the purpose of creating the files asynchronously is I<not> to block until
5725 the file is available, values before the file is available will be discarded.
5726 When disabled (the default) files are created synchronously, blocking for a
5727 short while, while the file is being written.
5729 =item B<StepSize> I<Seconds>
5731 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5732 this setting is unset and the stepsize is set to the interval in which the data
5733 is collected. Do not use this option unless you absolutely have to for some
5734 reason. Setting this option may cause problems with the C<snmp plugin>, the
5735 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5737 =item B<HeartBeat> I<Seconds>
5739 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5740 in which case the heartbeat is set to twice the B<StepSize> which should equal
5741 the interval in which data is collected. Do not set this option unless you have
5742 a very good reason to do so.
5744 =item B<RRARows> I<NumRows>
5746 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5747 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5748 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5749 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5750 week, one month, and one year.
5752 So for each timespan, it calculates how many PDPs need to be consolidated into
5753 one CDP by calculating:
5754 number of PDPs = timespan / (stepsize * rrarows)
5756 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5759 =item B<RRATimespan> I<Seconds>
5761 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5762 more then one RRA. If this option is never used, the built-in default of (3600,
5763 86400, 604800, 2678400, 31622400) is used.
5765 For more information on how RRA-sizes are calculated see B<RRARows> above.
5767 =item B<XFF> I<Factor>
5769 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5770 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5773 =item B<CollectStatistics> B<false>|B<true>
5775 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5776 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5778 Statistics are read via I<rrdcached>s socket using the STATS command.
5779 See L<rrdcached(1)> for details.
5783 =head2 Plugin C<rrdtool>
5785 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5786 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5787 using these settings. If you don't want to dive into the depths of RRDtool, you
5788 can safely ignore these settings.
5792 =item B<DataDir> I<Directory>
5794 Set the directory to store RRD files under. By default RRD files are generated
5795 beneath the daemon's working directory, i.e. the B<BaseDir>.
5797 =item B<CreateFilesAsync> B<false>|B<true>
5799 When enabled, new RRD files are enabled asynchronously, using a separate thread
5800 that runs in the background. This prevents writes to block, which is a problem
5801 especially when many hundreds of files need to be created at once. However,
5802 since the purpose of creating the files asynchronously is I<not> to block until
5803 the file is available, values before the file is available will be discarded.
5804 When disabled (the default) files are created synchronously, blocking for a
5805 short while, while the file is being written.
5807 =item B<StepSize> I<Seconds>
5809 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5810 this setting is unset and the stepsize is set to the interval in which the data
5811 is collected. Do not use this option unless you absolutely have to for some
5812 reason. Setting this option may cause problems with the C<snmp plugin>, the
5813 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5815 =item B<HeartBeat> I<Seconds>
5817 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5818 in which case the heartbeat is set to twice the B<StepSize> which should equal
5819 the interval in which data is collected. Do not set this option unless you have
5820 a very good reason to do so.
5822 =item B<RRARows> I<NumRows>
5824 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5825 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5826 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5827 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5828 week, one month, and one year.
5830 So for each timespan, it calculates how many PDPs need to be consolidated into
5831 one CDP by calculating:
5832 number of PDPs = timespan / (stepsize * rrarows)
5834 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5837 =item B<RRATimespan> I<Seconds>
5839 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5840 more then one RRA. If this option is never used, the built-in default of (3600,
5841 86400, 604800, 2678400, 31622400) is used.
5843 For more information on how RRA-sizes are calculated see B<RRARows> above.
5845 =item B<XFF> I<Factor>
5847 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5848 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5851 =item B<CacheFlush> I<Seconds>
5853 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5854 it writes all values for a certain RRD-file if the oldest value is older than
5855 (or equal to) the number of seconds specified. If some RRD-file is not updated
5856 anymore for some reason (the computer was shut down, the network is broken,
5857 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5858 entire cache is searched for entries older than B<CacheTimeout> seconds and
5859 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5860 does nothing under normal circumstances, this value should not be too small.
5861 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5862 normally do much harm either.
5864 =item B<CacheTimeout> I<Seconds>
5866 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5867 save values in a cache, as described above. Writing multiple values at once
5868 reduces IO-operations and thus lessens the load produced by updating the files.
5869 The trade off is that the graphs kind of "drag behind" and that more memory is
5872 =item B<WritesPerSecond> I<Updates>
5874 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5875 will run serious performance problems. The B<CacheFlush> setting and the
5876 internal update queue assert that collectd continues to work just fine even
5877 under heavy load, but the system may become very unresponsive and slow. This is
5878 a problem especially if you create graphs from the RRD files on the same
5879 machine, for example using the C<graph.cgi> script included in the
5880 C<contrib/collection3/> directory.
5882 This setting is designed for very large setups. Setting this option to a value
5883 between 25 and 80 updates per second, depending on your hardware, will leave
5884 the server responsive enough to draw graphs even while all the cached values
5885 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5886 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5887 written as fast as possible, so that web frontends have up to date data when
5890 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5891 updates per second, writing all values to disk will take approximately
5892 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5893 "collection3" you'll end up with a responsive and fast system, up to date
5894 graphs and basically a "backup" of your values every hour.
5896 =item B<RandomTimeout> I<Seconds>
5898 When set, the actual timeout for each value is chosen randomly between
5899 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5900 intention is to avoid high load situations that appear when many values timeout
5901 at the same time. This is especially a problem shortly after the daemon starts,
5902 because all values were added to the internal cache at roughly the same time.
5906 =head2 Plugin C<sensors>
5908 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5909 that all the needed modules have to be loaded and lm_sensors has to be
5910 configured (most likely by editing F</etc/sensors.conf>. Read
5911 L<sensors.conf(5)> for details.
5913 The B<lm_sensors> homepage can be found at
5914 L<http://secure.netroedge.com/~lm78/>.
5918 =item B<SensorConfigFile> I<File>
5920 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5921 the library's default will be used.
5923 =item B<Sensor> I<chip-bus-address/type-feature>
5925 Selects the name of the sensor which you want to collect or ignore, depending
5926 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5927 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5928 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5930 =item B<IgnoreSelected> I<true>|I<false>
5932 If no configuration if given, the B<sensors>-plugin will collect data from all
5933 sensors. This may not be practical, especially for uninteresting sensors.
5934 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5935 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5936 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5937 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5938 and all other sensors are collected.
5942 =head2 Plugin C<sigrok>
5944 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5945 supported by the L<sigrok|http://sigrok.org/> project.
5951 <Device "AC Voltage">
5956 <Device "Sound Level">
5957 Driver "cem-dt-885x"
5964 =item B<LogLevel> B<0-5>
5966 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5967 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5968 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5969 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5970 their level, are always submitted to I<collectd> at its INFO log level.
5972 =item E<lt>B<Device> I<Name>E<gt>
5974 A sigrok-supported device, uniquely identified by this section's options. The
5975 I<Name> is passed to I<collectd> as the I<plugin instance>.
5977 =item B<Driver> I<DriverName>
5979 The sigrok driver to use for this device.
5981 =item B<Conn> I<ConnectionSpec>
5983 If the device cannot be auto-discovered, or more than one might be discovered
5984 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5985 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5986 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5987 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5988 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5990 =item B<SerialComm> I<SerialSpec>
5992 For serial devices with non-standard port settings, this option can be used
5993 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5994 This should not be necessary; drivers know how to communicate with devices they
5997 =item B<MinimumInterval> I<Seconds>
5999 Specifies the minimum time between measurement dispatches to I<collectd>, in
6000 seconds. Since some I<sigrok> supported devices can acquire measurements many
6001 times per second, it may be necessary to throttle these. For example, the
6002 I<RRD plugin> cannot process writes more than once per second.
6004 The default B<MinimumInterval> is B<0>, meaning measurements received from the
6005 device are always dispatched to I<collectd>. When throttled, unused
6006 measurements are discarded.
6010 =head2 Plugin C<smart>
6012 The C<smart> plugin collects SMART information from physical
6013 disks. Values collectd include temperature, power cycle count, poweron
6014 time and bad sectors. Also, all SMART attributes are collected along
6015 with the normalized current value, the worst value, the threshold and
6016 a human readable value.
6018 Using the following two options you can ignore some disks or configure the
6019 collection only of specific disks.
6023 =item B<Disk> I<Name>
6025 Select the disk I<Name>. Whether it is collected or ignored depends on the
6026 B<IgnoreSelected> setting, see below. As with other plugins that use the
6027 daemon's ignorelist functionality, a string that starts and ends with a slash
6028 is interpreted as a regular expression. Examples:
6033 =item B<IgnoreSelected> B<true>|B<false>
6035 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
6036 statements, are ignored or if all other disks are ignored. The behavior
6037 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
6038 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
6039 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
6040 is set to B<true>, all disks are collected B<except> the ones matched.
6044 =head2 Plugin C<snmp>
6046 Since the configuration of the C<snmp plugin> is a little more complicated than
6047 other plugins, its documentation has been moved to an own manpage,
6048 L<collectd-snmp(5)>. Please see there for details.
6050 =head2 Plugin C<statsd>
6052 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
6053 protocol and dispatches rates or other aggregates of these numbers
6056 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
6057 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
6058 C<objects> respectively.
6060 The following configuration options are valid:
6064 =item B<Host> I<Host>
6066 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
6067 "any" address, i.e. accept packets sent to any of the hosts addresses.
6069 =item B<Port> I<Port>
6071 UDP port to listen to. This can be either a service name or a port number.
6072 Defaults to C<8125>.
6074 =item B<DeleteCounters> B<false>|B<true>
6076 =item B<DeleteTimers> B<false>|B<true>
6078 =item B<DeleteGauges> B<false>|B<true>
6080 =item B<DeleteSets> B<false>|B<true>
6082 These options control what happens if metrics are not updated in an interval.
6083 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6084 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6085 are unchanged. If set to B<True>, the such metrics are not dispatched and
6086 removed from the internal cache.
6088 =item B<TimerPercentile> I<Percent>
6090 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6091 that I<Percent> of all reported timers are smaller than or equal to the
6092 computed latency. This is useful for cutting off the long tail latency, as it's
6093 often done in I<Service Level Agreements> (SLAs).
6095 Different percentiles can be calculated by setting this option several times.
6096 If none are specified, no percentiles are calculated / dispatched.
6098 =item B<TimerLower> B<false>|B<true>
6100 =item B<TimerUpper> B<false>|B<true>
6102 =item B<TimerSum> B<false>|B<true>
6104 =item B<TimerCount> B<false>|B<true>
6106 Calculate and dispatch various values out of I<Timer> metrics received during
6107 an interval. If set to B<False>, the default, these values aren't calculated /
6112 =head2 Plugin C<swap>
6114 The I<Swap plugin> collects information about used and available swap space. On
6115 I<Linux> and I<Solaris>, the following options are available:
6119 =item B<ReportByDevice> B<false>|B<true>
6121 Configures how to report physical swap devices. If set to B<false> (the
6122 default), the summary over all swap devices is reported only, i.e. the globally
6123 used and available space over all devices. If B<true> is configured, the used
6124 and available space of each device will be reported separately.
6126 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6127 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6129 =item B<ReportBytes> B<false>|B<true>
6131 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6132 I<swap I/O> is reported in pages. This option is available under Linux only.
6134 =item B<ValuesAbsolute> B<true>|B<false>
6136 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6137 available and used. Defaults to B<true>.
6139 =item B<ValuesPercentage> B<false>|B<true>
6141 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6142 available and free. Defaults to B<false>.
6144 This is useful for deploying I<collectd> in a heterogeneous environment, where
6145 swap sizes differ and you want to specify generic thresholds or similar.
6149 =head2 Plugin C<syslog>
6153 =item B<LogLevel> B<debug|info|notice|warning|err>
6155 Sets the log-level. If, for example, set to B<notice>, then all events with
6156 severity B<notice>, B<warning>, or B<err> will be submitted to the
6159 Please note that B<debug> is only available if collectd has been compiled with
6162 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6164 Controls which notifications should be sent to syslog. The default behaviour is
6165 not to send any. Less severe notifications always imply logging more severe
6166 notifications: Setting this to B<OKAY> means all notifications will be sent to
6167 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6168 notifications but will dismiss B<OKAY> notifications. Setting this option to
6169 B<FAILURE> will only send failures to syslog.
6173 =head2 Plugin C<table>
6175 The C<table plugin> provides generic means to parse tabular data and dispatch
6176 user specified values. Values are selected based on column numbers. For
6177 example, this plugin may be used to get values from the Linux L<proc(5)>
6178 filesystem or CSV (comma separated values) files.
6181 <Table "/proc/slabinfo">
6186 InstancePrefix "active_objs"
6192 InstancePrefix "objperslab"
6199 The configuration consists of one or more B<Table> blocks, each of which
6200 configures one file to parse. Within each B<Table> block, there are one or
6201 more B<Result> blocks, which configure which data to select and how to
6204 The following options are available inside a B<Table> block:
6208 =item B<Instance> I<instance>
6210 If specified, I<instance> is used as the plugin instance. So, in the above
6211 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6212 filename of the table is used instead, with all special characters replaced
6213 with an underscore (C<_>).
6215 =item B<Separator> I<string>
6217 Any character of I<string> is interpreted as a delimiter between the different
6218 columns of the table. A sequence of two or more contiguous delimiters in the
6219 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6220 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6221 of a table - see its documentation for more details. This option is mandatory.
6223 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6224 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6225 required because of collectd's config parsing.
6229 The following options are available inside a B<Result> block:
6233 =item B<Type> I<type>
6235 Sets the type used to dispatch the values to the daemon. Detailed information
6236 about types and their configuration can be found in L<types.db(5)>. This
6237 option is mandatory.
6239 =item B<InstancePrefix> I<prefix>
6241 If specified, prepend I<prefix> to the type instance. If omitted, only the
6242 B<InstancesFrom> option is considered for the type instance.
6244 =item B<InstancesFrom> I<column0> [I<column1> ...]
6246 If specified, the content of the given columns (identified by the column
6247 number starting at zero) will be used to create the type instance for each
6248 row. Multiple values (and the instance prefix) will be joined together with
6249 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6250 option is considered for the type instance.
6252 The plugin itself does not check whether or not all built instances are
6253 different. It’s your responsibility to assure that each is unique. This is
6254 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6255 sure that the table only contains one row.
6257 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6260 =item B<ValuesFrom> I<column0> [I<column1> ...]
6262 Specifies the columns (identified by the column numbers starting at zero)
6263 whose content is used as the actual data for the data sets that are dispatched
6264 to the daemon. How many such columns you need is determined by the B<Type>
6265 setting above. If you specify too many or not enough columns, the plugin will
6266 complain about that and no data will be submitted to the daemon. The plugin
6267 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6268 respectively, so anything supported by those functions is supported by the
6269 plugin as well. This option is mandatory.
6273 =head2 Plugin C<tail>
6275 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6276 each line and dispatches found values. What is matched can be configured by the
6277 user using (extended) regular expressions, as described in L<regex(7)>.
6280 <File "/var/log/exim4/mainlog">
6284 Regex "S=([1-9][0-9]*)"
6290 Regex "\\<R=local_user\\>"
6291 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6294 Instance "local_user"
6299 The config consists of one or more B<File> blocks, each of which configures one
6300 logfile to parse. Within each B<File> block, there are one or more B<Match>
6301 blocks, which configure a regular expression to search for.
6303 The B<Instance> option in the B<File> block may be used to set the plugin
6304 instance. So in the above example the plugin name C<tail-foo> would be used.
6305 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6306 next B<Instance> option. This way you can extract several plugin instances from
6307 one logfile, handy when parsing syslog and the like.
6309 The B<Interval> option allows you to define the length of time between reads. If
6310 this is not set, the default Interval will be used.
6312 Each B<Match> block has the following options to describe how the match should
6317 =item B<Regex> I<regex>
6319 Sets the regular expression to use for matching against a line. The first
6320 subexpression has to match something that can be turned into a number by
6321 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6322 below. Because B<extended> regular expressions are used, you do not need to use
6323 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6324 collectd's config parsing you need to escape backslashes, though. So if you
6325 want to match literal parentheses you need to do the following:
6327 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6329 =item B<ExcludeRegex> I<regex>
6331 Sets an optional regular expression to use for excluding lines from the match.
6332 An example which excludes all connections from localhost from the match:
6334 ExcludeRegex "127\\.0\\.0\\.1"
6336 =item B<DSType> I<Type>
6338 Sets how the values are cumulated. I<Type> is one of:
6342 =item B<GaugeAverage>
6344 Calculate the average.
6348 Use the smallest number only.
6352 Use the greatest number only.
6356 Use the last number found.
6362 =item B<AbsoluteSet>
6364 The matched number is a counter. Simply I<sets> the internal counter to this
6365 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6373 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6374 matched number may be negative, which will effectively subtract from the
6383 Increase the internal counter by one. These B<DSType> are the only ones that do
6384 not use the matched subexpression, but simply count the number of matched
6385 lines. Thus, you may use a regular expression without submatch in this case.
6389 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6390 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6391 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6392 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6393 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6396 =item B<Type> I<Type>
6398 Sets the type used to dispatch this value. Detailed information about types and
6399 their configuration can be found in L<types.db(5)>.
6401 =item B<Instance> I<TypeInstance>
6403 This optional setting sets the type instance to use.
6407 =head2 Plugin C<tail_csv>
6409 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6410 written by I<Snort>.
6415 <Metric "snort-dropped">
6420 <File "/var/log/snort/snort.stats">
6421 Instance "snort-eth0"
6423 Collect "snort-dropped"
6427 The configuration consists of one or more B<Metric> blocks that define an index
6428 into the line of the CSV file and how this value is mapped to I<collectd's>
6429 internal representation. These are followed by one or more B<Instance> blocks
6430 which configure which file to read, in which interval and which metrics to
6435 =item E<lt>B<Metric> I<Name>E<gt>
6437 The B<Metric> block configures a new metric to be extracted from the statistics
6438 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6439 only used inside the B<Instance> blocks to refer to this block, so you can use
6440 one B<Metric> block for multiple CSV files.
6444 =item B<Type> I<Type>
6446 Configures which I<Type> to use when dispatching this metric. Types are defined
6447 in the L<types.db(5)> file, see the appropriate manual page for more
6448 information on specifying types. Only types with a single I<data source> are
6449 supported by the I<tail_csv plugin>. The information whether the value is an
6450 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6451 I<Type's> definition.
6453 =item B<Instance> I<TypeInstance>
6455 If set, I<TypeInstance> is used to populate the type instance field of the
6456 created value lists. Otherwise, no type instance is used.
6458 =item B<ValueFrom> I<Index>
6460 Configure to read the value from the field with the zero-based index I<Index>.
6461 If the value is parsed as signed integer, unsigned integer or double depends on
6462 the B<Type> setting, see above.
6466 =item E<lt>B<File> I<Path>E<gt>
6468 Each B<File> block represents one CSV file to read. There must be at least one
6469 I<File> block but there can be multiple if you have multiple CSV files.
6473 =item B<Instance> I<PluginInstance>
6475 Sets the I<plugin instance> used when dispatching the values.
6477 =item B<Collect> I<Metric>
6479 Specifies which I<Metric> to collect. This option must be specified at least
6480 once, and you can use this option multiple times to specify more than one
6481 metric to be extracted from this statistic file.
6483 =item B<Interval> I<Seconds>
6485 Configures the interval in which to read values from this instance / file.
6486 Defaults to the plugin's default interval.
6488 =item B<TimeFrom> I<Index>
6490 Rather than using the local time when dispatching a value, read the timestamp
6491 from the field with the zero-based index I<Index>. The value is interpreted as
6492 seconds since epoch. The value is parsed as a double and may be factional.
6498 =head2 Plugin C<teamspeak2>
6500 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6501 polls interesting global and virtual server data. The plugin can query only one
6502 physical server but unlimited virtual servers. You can use the following
6503 options to configure it:
6507 =item B<Host> I<hostname/ip>
6509 The hostname or ip which identifies the physical server.
6512 =item B<Port> I<port>
6514 The query port of the physical server. This needs to be a string.
6517 =item B<Server> I<port>
6519 This option has to be added once for every virtual server the plugin should
6520 query. If you want to query the virtual server on port 8767 this is what the
6521 option would look like:
6525 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6526 use quotes around it! If no such statement is given only global information
6531 =head2 Plugin C<ted>
6533 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6534 measure power consumption. These devices are usually connected to a serial
6535 (RS232) or USB port. The plugin opens a configured device and tries to read the
6536 current energy readings. For more information on TED, visit
6537 L<http://www.theenergydetective.com/>.
6539 Available configuration options:
6543 =item B<Device> I<Path>
6545 Path to the device on which TED is connected. collectd will need read and write
6546 permissions on that file.
6548 Default: B</dev/ttyUSB0>
6550 =item B<Retries> I<Num>
6552 Apparently reading from TED is not that reliable. You can therefore configure a
6553 number of retries here. You only configure the I<retries> here, to if you
6554 specify zero, one reading will be performed (but no retries if that fails); if
6555 you specify three, a maximum of four readings are performed. Negative values
6562 =head2 Plugin C<tcpconns>
6564 The C<tcpconns plugin> counts the number of currently established TCP
6565 connections based on the local port and/or the remote port. Since there may be
6566 a lot of connections the default if to count all connections with a local port,
6567 for which a listening socket is opened. You can use the following options to
6568 fine-tune the ports you are interested in:
6572 =item B<ListeningPorts> I<true>|I<false>
6574 If this option is set to I<true>, statistics for all local ports for which a
6575 listening socket exists are collected. The default depends on B<LocalPort> and
6576 B<RemotePort> (see below): If no port at all is specifically selected, the
6577 default is to collect listening ports. If specific ports (no matter if local or
6578 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6579 the selected ports will be collected unless this option is set to I<true>
6582 =item B<LocalPort> I<Port>
6584 Count the connections to a specific local port. This can be used to see how
6585 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6586 You have to specify the port in numeric form, so for the mailserver example
6587 you'd need to set B<25>.
6589 =item B<RemotePort> I<Port>
6591 Count the connections to a specific remote port. This is useful to see how
6592 much a remote service is used. This is most useful if you want to know how many
6593 connections a local service has opened to remote services, e.E<nbsp>g. how many
6594 connections a mail server or news server has to other mail or news servers, or
6595 how many connections a web proxy holds to web servers. You have to give the
6596 port in numeric form.
6598 =item B<AllPortsSummary> I<true>|I<false>
6600 If this option is set to I<true> a summary of statistics from all connections
6601 are collectd. This option defaults to I<false>.
6605 =head2 Plugin C<thermal>
6609 =item B<ForceUseProcfs> I<true>|I<false>
6611 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6612 C<sysfs> interface. If that is not available, the plugin falls back to the
6613 C<procfs> interface. By setting this option to I<true>, you can force the
6614 plugin to use the latter. This option defaults to I<false>.
6616 =item B<Device> I<Device>
6618 Selects the name of the thermal device that you want to collect or ignore,
6619 depending on the value of the B<IgnoreSelected> option. This option may be
6620 used multiple times to specify a list of devices.
6622 =item B<IgnoreSelected> I<true>|I<false>
6624 Invert the selection: If set to true, all devices B<except> the ones that
6625 match the device names specified by the B<Device> option are collected. By
6626 default only selected devices are collected if a selection is made. If no
6627 selection is configured at all, B<all> devices are selected.
6631 =head2 Plugin C<threshold>
6633 The I<Threshold plugin> checks values collected or received by I<collectd>
6634 against a configurable I<threshold> and issues I<notifications> if values are
6637 Documentation for this plugin is available in the L<collectd-threshold(5)>
6640 =head2 Plugin C<tokyotyrant>
6642 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6643 couple metrics: number of records, and database size on disk.
6647 =item B<Host> I<Hostname/IP>
6649 The hostname or ip which identifies the server.
6650 Default: B<127.0.0.1>
6652 =item B<Port> I<Service/Port>
6654 The query port of the server. This needs to be a string, even if the port is
6655 given in its numeric form.
6660 =head2 Plugin C<turbostat>
6662 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
6663 Intel processors by using the new Model Specific Registers.
6667 =item B<CoreCstates> I<Bitmask(Integer)>
6669 Bitmask of the list of core C states supported by the processor.
6670 This option should only be used if the automated detection fails.
6671 Default value extracted from the cpu model and family.
6673 Currently supported C-states (by this plugin): 3, 6, 7
6675 Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
6677 =item B<PackageCstates> I<Bitmask(Integer)>
6679 Bitmask of the list of pacages C states supported by the processor.
6680 This option should only be used if the automated detection fails.
6681 Default value extracted from the cpu model and family.
6683 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
6685 Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7
6687 =item B<SystemManagementInterrupt> I<true>|I<false>
6689 Boolean enabling the collection of the I/O System-Management Interrupt
6690 counter'. This option should only be used if the automated detection
6691 fails or if you want to disable this feature.
6693 =item B<DigitalTemperatureSensor> I<true>|I<false>
6695 Boolean enabling the collection of the temperature of each core.
6696 This option should only be used if the automated detectionfails or
6697 if you want to disable this feature.
6699 =item B<DigitalTemperatureSensor> I<true>|I<false>
6701 Boolean enabling the collection of the temperature of each package.
6702 This option should only be used if the automated detectionfails or
6703 if you want to disable this feature.
6705 =item B<TCCActivationTemp> I<Temperature>
6707 Thermal Control Circuit Activation Temperature of the installed
6708 CPU. This temperature is used when collecting the temperature of
6709 cores or packages. This option should only be used if the automated
6710 detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
6712 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
6714 Bitmask of the list of elements to be thermally monitored. This option
6715 should only be used if the automated detection fails or if you want to
6716 disable some collections. The different bits of this bitmask accepted
6721 =item 0 ('1'): Package
6725 =item 2 ('4'): Cores
6727 =item 3 ('8'): Embedded graphic device
6733 =head2 Plugin C<unixsock>
6737 =item B<SocketFile> I<Path>
6739 Sets the socket-file which is to be created.
6741 =item B<SocketGroup> I<Group>
6743 If running as root change the group of the UNIX-socket after it has been
6744 created. Defaults to B<collectd>.
6746 =item B<SocketPerms> I<Permissions>
6748 Change the file permissions of the UNIX-socket after it has been created. The
6749 permissions must be given as a numeric, octal value as you would pass to
6750 L<chmod(1)>. Defaults to B<0770>.
6752 =item B<DeleteSocket> B<false>|B<true>
6754 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6755 with the given name already exists. If I<collectd> crashes a socket file may be
6756 left over, preventing the daemon from opening a new socket when restarted.
6757 Since this is potentially dangerous, this defaults to B<false>.
6761 =head2 Plugin C<uuid>
6763 This plugin, if loaded, causes the Hostname to be taken from the machine's
6764 UUID. The UUID is a universally unique designation for the machine, usually
6765 taken from the machine's BIOS. This is most useful if the machine is running in
6766 a virtual environment such as Xen, in which case the UUID is preserved across
6767 shutdowns and migration.
6769 The following methods are used to find the machine's UUID, in order:
6775 Check I</etc/uuid> (or I<UUIDFile>).
6779 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6784 Check for UUID from C<dmidecode> / SMBIOS.
6788 Check for UUID from Xen hypervisor.
6792 If no UUID can be found then the hostname is not modified.
6796 =item B<UUIDFile> I<Path>
6798 Take the UUID from the given file (default I</etc/uuid>).
6802 =head2 Plugin C<varnish>
6804 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6805 It collects a subset of the values displayed by L<varnishstat(1)>, and
6806 organizes them in categories which can be enabled or disabled. Currently only
6807 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6808 meaning of each metric can be found in L<varnish-counters(7)>.
6813 <Instance "example">
6817 CollectConnections true
6818 CollectDirectorDNS false
6822 CollectObjects false
6824 CollectSession false
6834 CollectWorkers false
6838 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6839 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6840 will collectd statistics from the default "varnishd" instance (this should work
6841 fine in most cases).
6843 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6847 =item B<CollectBackend> B<true>|B<false>
6849 Back-end connection statistics, such as successful, reused,
6850 and closed connections. True by default.
6852 =item B<CollectBan> B<true>|B<false>
6854 Statistics about ban operations, such as number of bans added, retired, and
6855 number of objects tested against ban operations. Only available with Varnish
6856 3.x and above. False by default.
6858 =item B<CollectCache> B<true>|B<false>
6860 Cache hits and misses. True by default.
6862 =item B<CollectConnections> B<true>|B<false>
6864 Number of client connections received, accepted and dropped. True by default.
6866 =item B<CollectDirectorDNS> B<true>|B<false>
6868 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6871 =item B<CollectESI> B<true>|B<false>
6873 Edge Side Includes (ESI) parse statistics. False by default.
6875 =item B<CollectFetch> B<true>|B<false>
6877 Statistics about fetches (HTTP requests sent to the backend). False by default.
6879 =item B<CollectHCB> B<true>|B<false>
6881 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6882 divided into locked and unlocked look-ups. False by default.
6884 =item B<CollectObjects> B<true>|B<false>
6886 Statistics on cached objects: number of objects expired, nuked (prematurely
6887 expired), saved, moved, etc. False by default.
6889 =item B<CollectPurge> B<true>|B<false>
6891 Statistics about purge operations, such as number of purges added, retired, and
6892 number of objects tested against purge operations. Only available with Varnish
6893 2.x. False by default.
6895 =item B<CollectSession> B<true>|B<false>
6897 Client session statistics. Number of past and current sessions, session herd and
6898 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6899 metrics found in the Connections and Threads sections with previous versions of
6900 Varnish have been moved here.
6902 =item B<CollectSHM> B<true>|B<false>
6904 Statistics about the shared memory log, a memory region to store
6905 log messages which is flushed to disk when full. True by default.
6907 =item B<CollectSMA> B<true>|B<false>
6909 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6910 component is Solaris specific. Only available with Varnish 2.x. False by
6913 =item B<CollectSMS> B<true>|B<false>
6915 synth (synthetic content) storage statistics. This storage
6916 component is used internally only. False by default.
6918 =item B<CollectSM> B<true>|B<false>
6920 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6923 =item B<CollectStruct> B<true>|B<false>
6925 Current varnish internal state statistics. Number of current sessions, objects
6926 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6929 =item B<CollectTotals> B<true>|B<false>
6931 Collects overview counters, such as the number of sessions created,
6932 the number of requests and bytes transferred. False by default.
6934 =item B<CollectUptime> B<true>|B<false>
6936 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6938 =item B<CollectVCL> B<true>|B<false>
6940 Number of total (available + discarded) VCL (config files). False by default.
6942 =item B<CollectVSM> B<true>|B<false>
6944 Collect statistics about Varnish's shared memory usage (used by the logging and
6945 statistics subsystems). Only available with Varnish 4.x. False by default.
6947 =item B<CollectWorkers> B<true>|B<false>
6949 Collect statistics about worker threads. False by default.
6953 =head2 Plugin C<virt>
6955 This plugin allows CPU, disk and network load to be collected for virtualized
6956 guests on the machine. This means that these metrics can be collected for guest
6957 systems without installing any software on them - I<collectd> only runs on the
6958 host system. The statistics are collected through libvirt
6959 (L<http://libvirt.org/>).
6961 Only I<Connection> is required.
6965 =item B<Connection> I<uri>
6967 Connect to the hypervisor given by I<uri>. For example if using Xen use:
6969 Connection "xen:///"
6971 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
6973 =item B<RefreshInterval> I<seconds>
6975 Refresh the list of domains and devices every I<seconds>. The default is 60
6976 seconds. Setting this to be the same or smaller than the I<Interval> will cause
6977 the list of domains and devices to be refreshed on every iteration.
6979 Refreshing the devices in particular is quite a costly operation, so if your
6980 virtualization setup is static you might consider increasing this. If this
6981 option is set to 0, refreshing is disabled completely.
6983 =item B<Domain> I<name>
6985 =item B<BlockDevice> I<name:dev>
6987 =item B<InterfaceDevice> I<name:dev>
6989 =item B<IgnoreSelected> B<true>|B<false>
6991 Select which domains and devices are collected.
6993 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
6994 disk/network devices are collected.
6996 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
6997 domains and disk/network devices are ignored, while the rest are collected.
6999 The domain name and device names may use a regular expression, if the name is
7000 surrounded by I</.../> and collectd was compiled with support for regexps.
7002 The default is to collect statistics for all domains and all their devices.
7006 BlockDevice "/:hdb/"
7007 IgnoreSelected "true"
7009 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
7012 =item B<HostnameFormat> B<name|uuid|hostname|...>
7014 When the virt plugin logs data, it sets the hostname of the collected data
7015 according to this setting. The default is to use the guest name as provided by
7016 the hypervisor, which is equal to setting B<name>.
7018 B<uuid> means use the guest's UUID. This is useful if you want to track the
7019 same guest across migrations.
7021 B<hostname> means to use the global B<Hostname> setting, which is probably not
7022 useful on its own because all guests will appear to have the same name.
7024 You can also specify combinations of these fields. For example B<name uuid>
7025 means to concatenate the guest name and UUID (with a literal colon character
7026 between, thus I<"foo:1234-1234-1234-1234">).
7028 At the moment of writing (collectd-5.5), hostname string is limited to 62
7029 characters. In case when combination of fields exceeds 62 characters,
7030 hostname will be truncated without a warning.
7032 =item B<InterfaceFormat> B<name>|B<address>
7034 When the virt plugin logs interface data, it sets the name of the collected
7035 data according to this setting. The default is to use the path as provided by
7036 the hypervisor (the "dev" property of the target node), which is equal to
7039 B<address> means use the interface's mac address. This is useful since the
7040 interface path might change between reboots of a guest or across migrations.
7042 =item B<PluginInstanceFormat> B<name|uuid>
7044 When the virt plugin logs data, it sets the plugin_instance of the collected
7045 data according to this setting. The default is to use the guest name as provided
7046 by the hypervisor, which is equal to setting B<name>.
7048 B<uuid> means use the guest's UUID.
7050 You can also specify combinations of these fields. For example B<name uuid>
7051 means to concatenate the guest name and UUID (with a literal colon character
7052 between, thus I<"foo:1234-1234-1234-1234">).
7056 =head2 Plugin C<vmem>
7058 The C<vmem> plugin collects information about the usage of virtual memory.
7059 Since the statistics provided by the Linux kernel are very detailed, they are
7060 collected very detailed. However, to get all the details, you have to switch
7061 them on manually. Most people just want an overview over, such as the number of
7062 pages read from swap space.
7066 =item B<Verbose> B<true>|B<false>
7068 Enables verbose collection of information. This will start collecting page
7069 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
7070 Part of these statistics are collected on a "per zone" basis.
7074 =head2 Plugin C<vserver>
7076 This plugin doesn't have any options. B<VServer> support is only available for
7077 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
7078 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
7079 need to apply the patches and compile your own kernel, which will then provide
7080 the F</proc/virtual> filesystem that is required by this plugin.
7082 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
7084 B<Note>: The traffic collected by this plugin accounts for the amount of
7085 traffic passing a socket which might be a lot less than the actual on-wire
7086 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
7087 collect on-wire traffic you could, for example, use the logging facilities of
7088 iptables to feed data for the guest IPs into the iptables plugin.
7090 =head2 Plugin C<write_graphite>
7092 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
7093 storage and graphing project. The plugin connects to I<Carbon>, the data layer
7094 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
7095 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
7096 of at most 1428 bytes to minimize the number of network packets.
7100 <Plugin write_graphite>
7110 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7111 blocks. Inside the B<Node> blocks, the following options are recognized:
7115 =item B<Host> I<Address>
7117 Hostname or address to connect to. Defaults to C<localhost>.
7119 =item B<Port> I<Service>
7121 Service name or port number to connect to. Defaults to C<2003>.
7123 =item B<Protocol> I<String>
7125 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
7127 =item B<LogSendErrors> B<false>|B<true>
7129 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
7130 If set to B<false>, it will not log the errors. This is especially useful when
7131 using Protocol UDP since many times we want to use the "fire-and-forget"
7132 approach and logging errors fills syslog with unneeded messages.
7134 =item B<Prefix> I<String>
7136 When set, I<String> is added in front of the host name. Dots and whitespace are
7137 I<not> escaped in this string (see B<EscapeCharacter> below).
7139 =item B<Postfix> I<String>
7141 When set, I<String> is appended to the host name. Dots and whitespace are
7142 I<not> escaped in this string (see B<EscapeCharacter> below).
7144 =item B<EscapeCharacter> I<Char>
7146 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
7147 in the identifier. The B<EscapeCharacter> option determines which character
7148 dots, whitespace and control characters are replaced with. Defaults to
7151 =item B<StoreRates> B<false>|B<true>
7153 If set to B<true> (the default), convert counter values to rates. If set to
7154 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7157 =item B<SeparateInstances> B<false>|B<true>
7159 If set to B<true>, the plugin instance and type instance will be in their own
7160 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7161 default), the plugin and plugin instance (and likewise the type and type
7162 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7164 =item B<AlwaysAppendDS> B<false>|B<true>
7166 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7167 identifier. If set to B<false> (the default), this is only done when there is
7172 =head2 Plugin C<write_tsdb>
7174 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7175 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7176 state daemon that ingests metrics and stores them in HBase. The plugin uses
7177 I<TCP> over the "line based" protocol with a default port 4242. The data will
7178 be sent in blocks of at most 1428 bytes to minimize the number of network
7185 Host "tsd-1.my.domain"
7187 HostTags "status=production"
7191 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7192 blocks. Inside the B<Node> blocks, the following options are recognized:
7196 =item B<Host> I<Address>
7198 Hostname or address to connect to. Defaults to C<localhost>.
7200 =item B<Port> I<Service>
7202 Service name or port number to connect to. Defaults to C<4242>.
7205 =item B<HostTags> I<String>
7207 When set, I<HostTags> is added to the end of the metric. It is intended to be
7208 used for name=value pairs that the TSD will tag the metric with. Dots and
7209 whitespace are I<not> escaped in this string.
7211 =item B<StoreRates> B<false>|B<true>
7213 If set to B<true>, convert counter values to rates. If set to B<false>
7214 (the default) counter values are stored as is, as an increasing
7217 =item B<AlwaysAppendDS> B<false>|B<true>
7219 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7220 identifier. If set to B<false> (the default), this is only done when there is
7225 =head2 Plugin C<write_mongodb>
7227 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7232 <Plugin "write_mongodb">
7241 The plugin can send values to multiple instances of I<MongoDB> by specifying
7242 one B<Node> block for each instance. Within the B<Node> blocks, the following
7243 options are available:
7247 =item B<Host> I<Address>
7249 Hostname or address to connect to. Defaults to C<localhost>.
7251 =item B<Port> I<Service>
7253 Service name or port number to connect to. Defaults to C<27017>.
7255 =item B<Timeout> I<Milliseconds>
7257 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7258 Setting this option to zero means no timeout, which is the default.
7260 =item B<StoreRates> B<false>|B<true>
7262 If set to B<true> (the default), convert counter values to rates. If set to
7263 B<false> counter values are stored as is, i.e. as an increasing integer
7266 =item B<Database> I<Database>
7268 =item B<User> I<User>
7270 =item B<Password> I<Password>
7272 Sets the information used when authenticating to a I<MongoDB> database. The
7273 fields are optional (in which case no authentication is attempted), but if you
7274 want to use authentication all three fields must be set.
7278 =head2 Plugin C<write_http>
7280 This output plugin submits values to an HTTP server using POST requests and
7281 encoding metrics with JSON or using the C<PUTVAL> command described in
7282 L<collectd-unixsock(5)>.
7286 <Plugin "write_http">
7288 URL "http://example.com/post-collectd"
7295 The plugin can send values to multiple HTTP servers by specifying one
7296 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7297 block, the following options are available:
7303 URL to which the values are submitted to. Mandatory.
7305 =item B<User> I<Username>
7307 Optional user name needed for authentication.
7309 =item B<Password> I<Password>
7311 Optional password needed for authentication.
7313 =item B<VerifyPeer> B<true>|B<false>
7315 Enable or disable peer SSL certificate verification. See
7316 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7318 =item B<VerifyHost> B<true|false>
7320 Enable or disable peer host name verification. If enabled, the plugin checks if
7321 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7322 matches the host name provided by the B<URL> option. If this identity check
7323 fails, the connection is aborted. Obviously, only works when connecting to a
7324 SSL enabled server. Enabled by default.
7326 =item B<CACert> I<File>
7328 File that holds one or more SSL certificates. If you want to use HTTPS you will
7329 possibly need this option. What CA certificates come bundled with C<libcurl>
7330 and are checked by default depends on the distribution you use.
7332 =item B<CAPath> I<Directory>
7334 Directory holding one or more CA certificate files. You can use this if for
7335 some reason all the needed CA certificates aren't in the same file and can't be
7336 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7339 =item B<ClientKey> I<File>
7341 File that holds the private key in PEM format to be used for certificate-based
7344 =item B<ClientCert> I<File>
7346 File that holds the SSL certificate to be used for certificate-based
7349 =item B<ClientKeyPass> I<Password>
7351 Password required to load the private key in B<ClientKey>.
7353 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7355 Define which SSL protocol version must be used. By default C<libcurl> will
7356 attempt to figure out the remote SSL protocol version. See
7357 L<curl_easy_setopt(3)> for more details.
7359 =item B<Format> B<Command>|B<JSON>
7361 Format of the output to generate. If set to B<Command>, will create output that
7362 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7363 create output in the I<JavaScript Object Notation> (JSON).
7365 Defaults to B<Command>.
7367 =item B<StoreRates> B<true|false>
7369 If set to B<true>, convert counter values to rates. If set to B<false> (the
7370 default) counter values are stored as is, i.e. as an increasing integer number.
7372 =item B<BufferSize> I<Bytes>
7374 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7375 requests will be generated, but more metrics will be batched / metrics are
7376 cached for longer before being sent, introducing additional delay until they
7377 are available on the server side. I<Bytes> must be at least 1024 and cannot
7378 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7379 Defaults to C<4096>.
7381 =item B<LowSpeedLimit> I<Bytes per Second>
7383 Sets the minimal transfer rate in I<Bytes per Second> below which the
7384 connection with the HTTP server will be considered too slow and aborted. All
7385 the data submitted over this connection will probably be lost. Defaults to 0,
7386 which means no minimum transfer rate is enforced.
7388 =item B<Timeout> I<Timeout>
7390 Sets the maximum time in milliseconds given for HTTP POST operations to
7391 complete. When this limit is reached, the POST operation will be aborted, and
7392 all the data in the current send buffer will probably be lost. Defaults to 0,
7393 which means the connection never times out.
7395 The C<write_http> plugin regularly submits the collected values to the HTTP
7396 server. How frequently this happens depends on how much data you are collecting
7397 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
7398 slightly below this interval, which you can estimate by monitoring the network
7399 traffic between collectd and the HTTP server.
7403 =head2 Plugin C<write_kafka>
7405 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7409 <Plugin "write_kafka">
7410 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7416 The following options are understood by the I<write_kafka plugin>:
7420 =item E<lt>B<Topic> I<Name>E<gt>
7422 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7423 is given a unique I<Name> and specifies one kafka producer.
7424 Inside the B<Topic> block, the following per-topic options are
7429 =item B<Property> I<String> I<String>
7431 Configure the named property for the current topic. Properties are
7432 forwarded to the kafka producer library B<librdkafka>.
7434 =item B<Key> I<String>
7436 Use the specified string as a partioning key for the topic. Kafka breaks
7437 topic into partitions and guarantees that for a given topology, the same
7438 consumer will be used for a specific key. The special (case insensitive)
7439 string B<Random> can be used to specify that an arbitrary partition should
7442 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7444 Selects the format in which messages are sent to the broker. If set to
7445 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7446 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7448 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7449 an easy and straight forward exchange format.
7451 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7452 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7454 =item B<StoreRates> B<true>|B<false>
7456 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7457 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7458 default), no conversion is performed. Otherwise the conversion is performed
7459 using the internal value cache.
7461 Please note that currently this option is only used if the B<Format> option has
7462 been set to B<JSON>.
7464 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7466 A prefix can be added in the metric name when outputting in the I<Graphite>
7467 format. It's added before the I<Host> name.
7469 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>>
7471 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7473 A postfix can be added in the metric name when outputting in the I<Graphite>
7474 format. It's added after the I<Host> name.
7476 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>>
7478 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7480 Specify a character to replace dots (.) in the host part of the metric name.
7481 In I<Graphite> metric name, dots are used as separators between different
7482 metric parts (host, plugin, type).
7483 Default is C<_> (I<Underscore>).
7485 =item B<GraphiteSeparateInstances> B<false>|B<true>
7487 If set to B<true>, the plugin instance and type instance will be in their own
7488 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7489 default), the plugin and plugin instance (and likewise the type and type
7490 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7492 =item B<StoreRates> B<true>|B<false>
7494 If set to B<true> (the default), convert counter values to rates. If set to
7495 B<false> counter values are stored as is, i.e. as an increasing integer number.
7497 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7498 converted values will have "rate" appended to the data source type, e.g.
7499 C<ds_type:derive:rate>.
7503 =item B<Property> I<String> I<String>
7505 Configure the kafka producer through properties, you almost always will
7506 want to set B<metadata.broker.list> to your Kafka broker list.
7510 =head2 Plugin C<write_redis>
7512 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7516 <Plugin "write_redis">
7524 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7525 the timestamp as the score. Retrieving a date range can then be done using the
7526 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
7527 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7528 retrieved using the C<SMEMBERS> I<Redis> command. See
7529 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7532 The information shown in the synopsis above is the I<default configuration>
7533 which is used by the plugin if no configuration is present.
7535 The plugin can send values to multiple instances of I<Redis> by specifying
7536 one B<Node> block for each instance. Within the B<Node> blocks, the following
7537 options are available:
7541 =item B<Node> I<Nodename>
7543 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7544 instance running on a specified host and port. The node name is a
7545 canonical identifier which is used as I<plugin instance>. It is limited to
7546 51E<nbsp>characters in length.
7548 =item B<Host> I<Hostname>
7550 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7553 =item B<Port> I<Port>
7555 The B<Port> option is the TCP port on which the Redis instance accepts
7556 connections. Either a service name of a port number may be given. Please note
7557 that numerical port numbers must be given as a string, too.
7559 =item B<Timeout> I<Milliseconds>
7561 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7565 =head2 Plugin C<write_riemann>
7567 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7568 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7569 I<Riemann> using UDP packets.
7573 <Plugin "write_riemann">
7579 AlwaysAppendDS false
7583 Attribute "foo" "bar"
7586 The following options are understood by the I<write_riemann plugin>:
7590 =item E<lt>B<Node> I<Name>E<gt>
7592 The plugin's configuration consists of one or more B<Node> blocks. Each block
7593 is given a unique I<Name> and specifies one connection to an instance of
7594 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7599 =item B<Host> I<Address>
7601 Hostname or address to connect to. Defaults to C<localhost>.
7603 =item B<Port> I<Service>
7605 Service name or port number to connect to. Defaults to C<5555>.
7607 =item B<Protocol> B<UDP>|B<TCP>
7609 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7612 =item B<Batch> B<true>|B<false>
7614 If set to B<true> and B<Protocol> is set to B<TCP>,
7615 events will be batched in memory and flushed at
7616 regular intervals or when B<BatchMaxSize> is exceeded.
7618 Notifications are not batched and sent as soon as possible.
7620 When enabled, it can occur that events get processed by the Riemann server
7621 close to or after their expiration time. Tune the B<TTLFactor> and
7622 B<BatchMaxSize> settings according to the amount of values collected, if this
7627 =item B<BatchMaxSize> I<size>
7629 Maximum payload size for a riemann packet. Defaults to 8192
7631 =item B<StoreRates> B<true>|B<false>
7633 If set to B<true> (the default), convert counter values to rates. If set to
7634 B<false> counter values are stored as is, i.e. as an increasing integer number.
7636 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7637 converted values will have "rate" appended to the data source type, e.g.
7638 C<ds_type:derive:rate>.
7640 =item B<AlwaysAppendDS> B<false>|B<true>
7642 If set to B<true>, append the name of the I<Data Source> (DS) to the
7643 "service", i.e. the field that, together with the "host" field, uniquely
7644 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7645 only done when there is more than one DS.
7647 =item B<TTLFactor> I<Factor>
7649 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7650 event is considered active. I<collectd> populates this field based on the
7651 metrics interval setting. This setting controls the factor with which the
7652 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7653 know exactly what you're doing, you should only increase this setting from its
7656 =item B<Notifications> B<false>|B<true>
7658 If set to B<true>, create riemann events for notifications. This is B<true>
7659 by default. When processing thresholds from write_riemann, it might prove
7660 useful to avoid getting notification events.
7662 =item B<CheckThresholds> B<false>|B<true>
7664 If set to B<true>, attach state to events based on thresholds defined
7665 in the B<Threshold> plugin. Defaults to B<false>.
7667 =item B<EventServicePrefix> I<String>
7669 Add the given string as a prefix to the event service name.
7670 If B<EventServicePrefix> not set or set to an empty string (""),
7671 no prefix will be used.
7675 =item B<Tag> I<String>
7677 Add the given string as an additional tag to the metric being sent to
7680 =item B<Attribute> I<String> I<String>
7682 Consider the two given strings to be the key and value of an additional
7683 attribute for each metric being sent out to I<Riemann>.
7687 =head2 Plugin C<write_sensu>
7689 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
7690 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
7691 a local I<Sensu> client using a TCP socket.
7693 At the moment, the I<write_sensu plugin> does not send over a collectd_host
7694 parameter so it is not possible to use one collectd instance as a gateway for
7695 others. Each collectd host must pair with one I<Sensu> client.
7699 <Plugin "write_sensu">
7704 AlwaysAppendDS false
7705 MetricHandler "influx"
7706 MetricHandler "default"
7707 NotificationHandler "flapjack"
7708 NotificationHandler "howling_monkey"
7712 Attribute "foo" "bar"
7715 The following options are understood by the I<write_sensu plugin>:
7719 =item E<lt>B<Node> I<Name>E<gt>
7721 The plugin's configuration consists of one or more B<Node> blocks. Each block
7722 is given a unique I<Name> and specifies one connection to an instance of
7723 I<Sensu>. Inside the B<Node> block, the following per-connection options are
7728 =item B<Host> I<Address>
7730 Hostname or address to connect to. Defaults to C<localhost>.
7732 =item B<Port> I<Service>
7734 Service name or port number to connect to. Defaults to C<3030>.
7736 =item B<StoreRates> B<true>|B<false>
7738 If set to B<true> (the default), convert counter values to rates. If set to
7739 B<false> counter values are stored as is, i.e. as an increasing integer number.
7741 This will be reflected in the C<collectd_data_source_type> tag: If
7742 B<StoreRates> is enabled, converted values will have "rate" appended to the
7743 data source type, e.g. C<collectd_data_source_type:derive:rate>.
7745 =item B<AlwaysAppendDS> B<false>|B<true>
7747 If set the B<true>, append the name of the I<Data Source> (DS) to the
7748 "service", i.e. the field that, together with the "host" field, uniquely
7749 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
7750 only done when there is more than one DS.
7752 =item B<Notifications> B<false>|B<true>
7754 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
7755 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7757 =item B<Metrics> B<false>|B<true>
7759 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
7760 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7763 =item B<Separator> I<String>
7765 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
7767 =item B<MetricHandler> I<String>
7769 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
7770 several of them, one per line. Defaults to no handler.
7772 =item B<NotificationHandler> I<String>
7774 Add a handler that will be set when notifications are sent to I<Sensu>. You can
7775 add several of them, one per line. Defaults to no handler.
7777 =item B<EventServicePrefix> I<String>
7779 Add the given string as a prefix to the event service name.
7780 If B<EventServicePrefix> not set or set to an empty string (""),
7781 no prefix will be used.
7785 =item B<Tag> I<String>
7787 Add the given string as an additional tag to the metric being sent to
7790 =item B<Attribute> I<String> I<String>
7792 Consider the two given strings to be the key and value of an additional
7793 attribute for each metric being sent out to I<Sensu>.
7797 =head2 Plugin C<zookeeper>
7799 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7800 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
7805 <Plugin "zookeeper">
7812 =item B<Host> I<Address>
7814 Hostname or address to connect to. Defaults to C<localhost>.
7816 =item B<Port> I<Service>
7818 Service name or port number to connect to. Defaults to C<2181>.
7822 =head1 THRESHOLD CONFIGURATION
7824 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7825 we mean that the values are not only stored or sent somewhere, but that they
7826 are judged and, if a problem is recognized, acted upon. The only action
7827 collectd takes itself is to generate and dispatch a "notification". Plugins can
7828 register to receive notifications and perform appropriate further actions.
7830 Since systems and what you expect them to do differ a lot, you can configure
7831 B<thresholds> for your values freely. This gives you a lot of flexibility but
7832 also a lot of responsibility.
7834 Every time a value is out of range a notification is dispatched. This means
7835 that the idle percentage of your CPU needs to be less then the configured
7836 threshold only once for a notification to be generated. There's no such thing
7837 as a moving average or similar - at least not now.
7839 Also, all values that match a threshold are considered to be relevant or
7840 "interesting". As a consequence collectd will issue a notification if they are
7841 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7842 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7843 "2" (the default) and some hosts sends it's CPU statistics to the server every
7844 60 seconds, a notification will be dispatched after about 120 seconds. It may
7845 take a little longer because the timeout is checked only once each B<Interval>
7848 When a value comes within range again or is received after it was missing, an
7849 "OKAY-notification" is dispatched.
7851 Here is a configuration example to get you started. Read below for more
7864 <Plugin "interface">
7881 WarningMin 100000000
7887 There are basically two types of configuration statements: The C<Host>,
7888 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7889 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7890 C<Instance> option. You can combine the block by nesting the blocks, though
7891 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7892 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7893 C<Type> may not contain other blocks. If multiple blocks apply to the same
7894 value the most specific block is used.
7896 The other statements specify the threshold to configure. They B<must> be
7897 included in a C<Type> block. Currently the following statements are recognized:
7901 =item B<FailureMax> I<Value>
7903 =item B<WarningMax> I<Value>
7905 Sets the upper bound of acceptable values. If unset defaults to positive
7906 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7907 will be created. If the value is greater than B<WarningMax> but less than (or
7908 equal to) B<FailureMax> a B<WARNING> notification will be created.
7910 =item B<FailureMin> I<Value>
7912 =item B<WarningMin> I<Value>
7914 Sets the lower bound of acceptable values. If unset defaults to negative
7915 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7916 be created. If the value is less than B<WarningMin> but greater than (or equal
7917 to) B<FailureMin> a B<WARNING> notification will be created.
7919 =item B<DataSource> I<DSName>
7921 Some data sets have more than one "data source". Interesting examples are the
7922 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7923 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7924 system load data set, C<load>, even has three data sources: C<shortterm>,
7925 C<midterm>, and C<longterm>.
7927 Normally, all data sources are checked against a configured threshold. If this
7928 is undesirable, or if you want to specify different limits for each data
7929 source, you can use the B<DataSource> option to have a threshold apply only to
7932 =item B<Invert> B<true>|B<false>
7934 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7935 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7936 B<WarningMax>) are not okay. Defaults to B<false>.
7938 =item B<Persist> B<true>|B<false>
7940 Sets how often notifications are generated. If set to B<true> one notification
7941 will be generated for each value that is out of the acceptable range. If set to
7942 B<false> (the default) then a notification is only generated if a value is out
7943 of range but the previous value was okay.
7945 This applies to missing values, too: If set to B<true> a notification about a
7946 missing value is generated once every B<Interval> seconds. If set to B<false>
7947 only one such notification is generated until the value appears again.
7949 =item B<Percentage> B<true>|B<false>
7951 If set to B<true>, the minimum and maximum values given are interpreted as
7952 percentage value, relative to the other data sources. This is helpful for
7953 example for the "df" type, where you may want to issue a warning when less than
7954 5E<nbsp>% of the total space is available. Defaults to B<false>.
7956 =item B<Hits> I<Number>
7958 Delay creating the notification until the threshold has been passed I<Number>
7959 times. When a notification has been generated, or when a subsequent value is
7960 inside the threshold, the counter is reset. If, for example, a value is
7961 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7962 will be dispatched at most once every 30E<nbsp>seconds.
7964 This is useful when short bursts are not a problem. If, for example, 100% CPU
7965 usage for up to a minute is normal (and data is collected every
7966 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7968 =item B<Hysteresis> I<Number>
7970 When set to non-zero, a hysteresis value is applied when checking minimum and
7971 maximum bounds. This is useful for values that increase slowly and fluctuate a
7972 bit while doing so. When these values come close to the threshold, they may
7973 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7975 If, for example, the threshold is configures as
7980 then a I<Warning> notification is created when the value exceeds I<101> and the
7981 corresponding I<Okay> notification is only created once the value falls below
7982 I<99>, thus avoiding the "flapping".
7986 =head1 FILTER CONFIGURATION
7988 Starting with collectd 4.6 there is a powerful filtering infrastructure
7989 implemented in the daemon. The concept has mostly been copied from
7990 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7991 terminology, so that users that are familiar with iptables feel right at home.
7995 The following are the terms used in the remainder of the filter configuration
7996 documentation. For an ASCII-art schema of the mechanism, see
7997 L<"General structure"> below.
8003 A I<match> is a criteria to select specific values. Examples are, of course, the
8004 name of the value or it's current value.
8006 Matches are implemented in plugins which you have to load prior to using the
8007 match. The name of such plugins starts with the "match_" prefix.
8011 A I<target> is some action that is to be performed with data. Such actions
8012 could, for example, be to change part of the value's identifier or to ignore
8013 the value completely.
8015 Some of these targets are built into the daemon, see L<"Built-in targets">
8016 below. Other targets are implemented in plugins which you have to load prior to
8017 using the target. The name of such plugins starts with the "target_" prefix.
8021 The combination of any number of matches and at least one target is called a
8022 I<rule>. The target actions will be performed for all values for which B<all>
8023 matches apply. If the rule does not have any matches associated with it, the
8024 target action will be performed for all values.
8028 A I<chain> is a list of rules and possibly default targets. The rules are tried
8029 in order and if one matches, the associated target will be called. If a value
8030 is handled by a rule, it depends on the target whether or not any subsequent
8031 rules are considered or if traversal of the chain is aborted, see
8032 L<"Flow control"> below. After all rules have been checked, the default targets
8037 =head2 General structure
8039 The following shows the resulting structure:
8046 +---------+ +---------+ +---------+ +---------+
8047 ! Rule !->! Match !->! Match !->! Target !
8048 +---------+ +---------+ +---------+ +---------+
8051 +---------+ +---------+ +---------+
8052 ! Rule !->! Target !->! Target !
8053 +---------+ +---------+ +---------+
8060 +---------+ +---------+ +---------+
8061 ! Rule !->! Match !->! Target !
8062 +---------+ +---------+ +---------+
8072 There are four ways to control which way a value takes through the filter
8079 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
8080 process the value with another chain. When the called chain finishes, usually
8081 the next target or rule after the jump is executed.
8085 The stop condition, signaled for example by the built-in target B<stop>, causes
8086 all processing of the value to be stopped immediately.
8090 Causes processing in the current chain to be aborted, but processing of the
8091 value generally will continue. This means that if the chain was called via
8092 B<Jump>, the next target or rule after the jump will be executed. If the chain
8093 was not called by another chain, control will be returned to the daemon and it
8094 may pass the value to another chain.
8098 Most targets will signal the B<continue> condition, meaning that processing
8099 should continue normally. There is no special built-in target for this
8106 The configuration reflects this structure directly:
8108 PostCacheChain "PostCache"
8110 <Rule "ignore_mysql_show">
8113 Type "^mysql_command$"
8114 TypeInstance "^show_"
8124 The above configuration example will ignore all values where the plugin field
8125 is "mysql", the type is "mysql_command" and the type instance begins with
8126 "show_". All other values will be sent to the C<rrdtool> write plugin via the
8127 default target of the chain. Since this chain is run after the value has been
8128 added to the cache, the MySQL C<show_*> command statistics will be available
8129 via the C<unixsock> plugin.
8131 =head2 List of configuration options
8135 =item B<PreCacheChain> I<ChainName>
8137 =item B<PostCacheChain> I<ChainName>
8139 Configure the name of the "pre-cache chain" and the "post-cache chain". The
8140 argument is the name of a I<chain> that should be executed before and/or after
8141 the values have been added to the cache.
8143 To understand the implications, it's important you know what is going on inside
8144 I<collectd>. The following diagram shows how values are passed from the
8145 read-plugins to the write-plugins:
8151 + - - - - V - - - - +
8152 : +---------------+ :
8155 : +-------+-------+ :
8158 : +-------+-------+ : +---------------+
8159 : ! Cache !--->! Value Cache !
8160 : ! insert ! : +---+---+-------+
8161 : +-------+-------+ : ! !
8162 : ! ,------------' !
8164 : +-------+---+---+ : +-------+-------+
8165 : ! Post-Cache +--->! Write-Plugins !
8166 : ! Chain ! : +---------------+
8167 : +---------------+ :
8170 + - - - - - - - - - +
8172 After the values are passed from the "read" plugins to the dispatch functions,
8173 the pre-cache chain is run first. The values are added to the internal cache
8174 afterwards. The post-cache chain is run after the values have been added to the
8175 cache. So why is it such a huge deal if chains are run before or after the
8176 values have been added to this cache?
8178 Targets that change the identifier of a value list should be executed before
8179 the values are added to the cache, so that the name in the cache matches the
8180 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8181 this cache to receive a list of all available values. If you change the
8182 identifier after the value list has been added to the cache, this may easily
8183 lead to confusion, but it's not forbidden of course.
8185 The cache is also used to convert counter values to rates. These rates are, for
8186 example, used by the C<value> match (see below). If you use the rate stored in
8187 the cache B<before> the new value is added, you will use the old, B<previous>
8188 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8189 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8192 Last but not last, the B<stop> target makes a difference: If the pre-cache
8193 chain returns the stop condition, the value will not be added to the cache and
8194 the post-cache chain will not be run.
8196 =item B<Chain> I<Name>
8198 Adds a new chain with a certain name. This name can be used to refer to a
8199 specific chain, for example to jump to it.
8201 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8203 =item B<Rule> [I<Name>]
8205 Adds a new rule to the current chain. The name of the rule is optional and
8206 currently has no meaning for the daemon.
8208 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8209 must be at least one B<Target> block.
8211 =item B<Match> I<Name>
8213 Adds a match to a B<Rule> block. The name specifies what kind of match should
8214 be performed. Available matches depend on the plugins that have been loaded.
8216 The arguments inside the B<Match> block are passed to the plugin implementing
8217 the match, so which arguments are valid here depends on the plugin being used.
8218 If you do not need any to pass any arguments to a match, you can use the
8223 Which is equivalent to:
8228 =item B<Target> I<Name>
8230 Add a target to a rule or a default target to a chain. The name specifies what
8231 kind of target is to be added. Which targets are available depends on the
8232 plugins being loaded.
8234 The arguments inside the B<Target> block are passed to the plugin implementing
8235 the target, so which arguments are valid here depends on the plugin being used.
8236 If you do not need any to pass any arguments to a target, you can use the
8241 This is the same as writing:
8248 =head2 Built-in targets
8250 The following targets are built into the core daemon and therefore need no
8251 plugins to be loaded:
8257 Signals the "return" condition, see the L<"Flow control"> section above. This
8258 causes the current chain to stop processing the value and returns control to
8259 the calling chain. The calling chain will continue processing targets and rules
8260 just after the B<jump> target (see below). This is very similar to the
8261 B<RETURN> target of iptables, see L<iptables(8)>.
8263 This target does not have any options.
8271 Signals the "stop" condition, see the L<"Flow control"> section above. This
8272 causes processing of the value to be aborted immediately. This is similar to
8273 the B<DROP> target of iptables, see L<iptables(8)>.
8275 This target does not have any options.
8283 Sends the value to "write" plugins.
8289 =item B<Plugin> I<Name>
8291 Name of the write plugin to which the data should be sent. This option may be
8292 given multiple times to send the data to more than one write plugin. If the
8293 plugin supports multiple instances, the plugin's instance(s) must also be
8298 If no plugin is explicitly specified, the values will be sent to all available
8301 Single-instance plugin example:
8307 Multi-instance plugin example:
8309 <Plugin "write_graphite">
8319 Plugin "write_graphite/foo"
8324 Starts processing the rules of another chain, see L<"Flow control"> above. If
8325 the end of that chain is reached, or a stop condition is encountered,
8326 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
8327 next target or the next rule. This is similar to the B<-j> command line option
8328 of iptables, see L<iptables(8)>.
8334 =item B<Chain> I<Name>
8336 Jumps to the chain I<Name>. This argument is required and may appear only once.
8348 =head2 Available matches
8354 Matches a value using regular expressions.
8360 =item B<Host> I<Regex>
8362 =item B<Plugin> I<Regex>
8364 =item B<PluginInstance> I<Regex>
8366 =item B<Type> I<Regex>
8368 =item B<TypeInstance> I<Regex>
8370 Match values where the given regular expressions match the various fields of
8371 the identifier of a value. If multiple regular expressions are given, B<all>
8372 regexen must match for a value to match.
8374 =item B<Invert> B<false>|B<true>
8376 When set to B<true>, the result of the match is inverted, i.e. all value lists
8377 where all regular expressions apply are not matched, all other value lists are
8378 matched. Defaults to B<false>.
8385 Host "customer[0-9]+"
8391 Matches values that have a time which differs from the time on the server.
8393 This match is mainly intended for servers that receive values over the
8394 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8395 is very sensitive to the timestamp used when updating the RRD files. In
8396 particular, the time must be ever increasing. If a misbehaving client sends one
8397 packet with a timestamp far in the future, all further packets with a correct
8398 time will be ignored because of that one packet. What's worse, such corrupted
8399 RRD files are hard to fix.
8401 This match lets one match all values B<outside> a specified time range
8402 (relative to the server's time), so you can use the B<stop> target (see below)
8403 to ignore the value, for example.
8409 =item B<Future> I<Seconds>
8411 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8412 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8415 =item B<Past> I<Seconds>
8417 Matches all values that are I<behind> of the server's time by I<Seconds> or
8418 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8430 This example matches all values that are five minutes or more ahead of the
8431 server or one hour (or more) lagging behind.
8435 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8436 values. If a data-set consists of more than one data-source, all data-sources
8437 must match the specified ranges for a positive match.
8443 =item B<Min> I<Value>
8445 Sets the smallest value which still results in a match. If unset, behaves like
8448 =item B<Max> I<Value>
8450 Sets the largest value which still results in a match. If unset, behaves like
8453 =item B<Invert> B<true>|B<false>
8455 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8456 no-match is returned and vice versa. Please note that the B<Invert> setting
8457 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8458 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8460 =item B<DataSource> I<DSName> [I<DSName> ...]
8462 Select one or more of the data sources. If no data source is configured, all
8463 data sources will be checked. If the type handled by the match does not have a
8464 data source of the specified name(s), this will always result in no match
8465 (independent of the B<Invert> setting).
8467 =item B<Satisfy> B<Any>|B<All>
8469 Specifies how checking with several data sources is performed. If set to
8470 B<Any>, the match succeeds if one of the data sources is in the configured
8471 range. If set to B<All> the match only succeeds if all data sources are within
8472 the configured range. Default is B<All>.
8474 Usually B<All> is used for positive matches, B<Any> is used for negative
8475 matches. This means that with B<All> you usually check that all values are in a
8476 "good" range, while with B<Any> you check if any value is within a "bad" range
8477 (or outside the "good" range).
8481 Either B<Min> or B<Max>, but not both, may be unset.
8485 # Match all values smaller than or equal to 100. Matches only if all data
8486 # sources are below 100.
8492 # Match if the value of any data source is outside the range of 0 - 100.
8500 =item B<empty_counter>
8502 Matches all values with one or more data sources of type B<COUNTER> and where
8503 all counter values are zero. These counters usually I<never> increased since
8504 they started existing (and are therefore uninteresting), or got reset recently
8505 or overflowed and you had really, I<really> bad luck.
8507 Please keep in mind that ignoring such counters can result in confusing
8508 behavior: Counters which hardly ever increase will be zero for long periods of
8509 time. If the counter is reset for some reason (machine or service restarted,
8510 usually), the graph will be empty (NAN) for a long time. People may not
8515 Calculates a hash value of the host name and matches values according to that
8516 hash value. This makes it possible to divide all hosts into groups and match
8517 only values that are in a specific group. The intended use is in load
8518 balancing, where you want to handle only part of all data and leave the rest
8521 The hashing function used tries to distribute the hosts evenly. First, it
8522 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8525 for (i = 0; host[i] != 0; i++)
8526 hash_value = (hash_value * 251) + host[i];
8528 The constant 251 is a prime number which is supposed to make this hash value
8529 more random. The code then checks the group for this host according to the
8530 I<Total> and I<Match> arguments:
8532 if ((hash_value % Total) == Match)
8537 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8538 groups), then the least significant bit of the hash value will be the XOR of
8539 all least significant bits in the host name. One consequence is that when you
8540 have two hosts, "server0.example.com" and "server1.example.com", where the host
8541 name differs in one digit only and the digits differ by one, those hosts will
8542 never end up in the same group.
8548 =item B<Match> I<Match> I<Total>
8550 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8551 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8552 be smaller than I<Total>. I<Total> must be at least one, although only values
8553 greater than one really do make any sense.
8555 You can repeat this option to match multiple groups, for example:
8560 The above config will divide the data into seven groups and match groups three
8561 and five. One use would be to keep every value on two hosts so that if one
8562 fails the missing data can later be reconstructed from the second host.
8568 # Operate on the pre-cache chain, so that ignored values are not even in the
8573 # Divide all received hosts in seven groups and accept all hosts in
8577 # If matched: Return and continue.
8580 # If not matched: Return and stop.
8586 =head2 Available targets
8590 =item B<notification>
8592 Creates and dispatches a notification.
8598 =item B<Message> I<String>
8600 This required option sets the message of the notification. The following
8601 placeholders will be replaced by an appropriate value:
8609 =item B<%{plugin_instance}>
8613 =item B<%{type_instance}>
8615 These placeholders are replaced by the identifier field of the same name.
8617 =item B<%{ds:>I<name>B<}>
8619 These placeholders are replaced by a (hopefully) human readable representation
8620 of the current rate of this data source. If you changed the instance name
8621 (using the B<set> or B<replace> targets, see below), it may not be possible to
8622 convert counter values to rates.
8626 Please note that these placeholders are B<case sensitive>!
8628 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8630 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8637 <Target "notification">
8638 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8644 Replaces parts of the identifier using regular expressions.
8650 =item B<Host> I<Regex> I<Replacement>
8652 =item B<Plugin> I<Regex> I<Replacement>
8654 =item B<PluginInstance> I<Regex> I<Replacement>
8656 =item B<TypeInstance> I<Regex> I<Replacement>
8658 Match the appropriate field with the given regular expression I<Regex>. If the
8659 regular expression matches, that part that matches is replaced with
8660 I<Replacement>. If multiple places of the input buffer match a given regular
8661 expression, only the first occurrence will be replaced.
8663 You can specify each option multiple times to use multiple regular expressions
8671 # Replace "example.net" with "example.com"
8672 Host "\\<example.net\\>" "example.com"
8674 # Strip "www." from hostnames
8680 Sets part of the identifier of a value to a given string.
8686 =item B<Host> I<String>
8688 =item B<Plugin> I<String>
8690 =item B<PluginInstance> I<String>
8692 =item B<TypeInstance> I<String>
8694 Set the appropriate field to the given string. The strings for plugin instance
8695 and type instance may be empty, the strings for host and plugin may not be
8696 empty. It's currently not possible to set the type of a value this way.
8703 PluginInstance "coretemp"
8704 TypeInstance "core3"
8709 =head2 Backwards compatibility
8711 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8712 B<Chain> block, it will behave as it used to. This is equivalent to the
8713 following configuration:
8719 If you specify a B<PostCacheChain>, the B<write> target will not be added
8720 anywhere and you will have to make sure that it is called where appropriate. We
8721 suggest to add the above snippet as default target to your "PostCache" chain.
8725 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8741 L<collectd-exec(5)>,
8742 L<collectd-perl(5)>,
8743 L<collectd-unixsock(5)>,
8756 Florian Forster E<lt>octo@collectd.orgE<gt>