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 "write_queue" I<plugin instance> reports the number of elements currently
154 queued and the number of elements dropped off the queue by the
155 B<WriteQueueLimitLow>/B<WriteQueueLimitHigh> mechanism.
157 The "cache" I<plugin instance> reports the number of elements in the value list
158 cache (the cache you can interact with using L<collectd-unixsock(5)>).
160 =item B<Include> I<Path> [I<pattern>]
162 If I<Path> points to a file, includes that file. If I<Path> points to a
163 directory, recursively includes all files within that directory and its
164 subdirectories. If the C<wordexp> function is available on your system,
165 shell-like wildcards are expanded before files are included. This means you can
166 use statements like the following:
168 Include "/etc/collectd.d/*.conf"
170 Starting with version 5.3, this may also be a block in which further options
171 affecting the behavior of B<Include> may be specified. The following option is
174 <Include "/etc/collectd.d">
180 =item B<Filter> I<pattern>
182 If the C<fnmatch> function is available on your system, a shell-like wildcard
183 I<pattern> may be specified to filter which files to include. This may be used
184 in combination with recursively including a directory to easily be able to
185 arbitrarily mix configuration files and other documents (e.g. README files).
186 The given example is similar to the first example above but includes all files
187 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
189 Include "/etc/collectd.d" "*.conf"
193 If more than one files are included by a single B<Include> option, the files
194 will be included in lexicographical order (as defined by the C<strcmp>
195 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
196 order in which the files are loaded.
198 To prevent loops and shooting yourself in the foot in interesting ways the
199 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
200 most uses. Since symlinks are followed it is still possible to crash the daemon
201 by looping symlinks. In our opinion significant stupidity should result in an
202 appropriate amount of pain.
204 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
205 file, but you cannot include files from within blocks.
207 =item B<PIDFile> I<File>
209 Sets where to write the PID file to. This file is overwritten when it exists
210 and deleted when the program is stopped. Some init-scripts might override this
211 setting using the B<-P> command-line option.
213 =item B<PluginDir> I<Directory>
215 Path to the plugins (shared objects) of collectd.
217 =item B<TypesDB> I<File> [I<File> ...]
219 Set one or more files that contain the data-set descriptions. See
220 L<types.db(5)> for a description of the format of this file.
222 =item B<Interval> I<Seconds>
224 Configures the interval in which to query the read plugins. Obviously smaller
225 values lead to a higher system load produced by collectd, while higher values
226 lead to more coarse statistics.
228 B<Warning:> You should set this once and then never touch it again. If you do,
229 I<you will have to delete all your RRD files> or know some serious RRDtool
230 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
232 =item B<MaxReadInterval> I<Seconds>
234 Read plugin doubles interval between queries after each failed attempt
237 This options limits the maximum value of the interval. The default value is
240 =item B<Timeout> I<Iterations>
242 Consider a value list "missing" when no update has been read or received for
243 I<Iterations> iterations. By default, I<collectd> considers a value list
244 missing when no update has been received for twice the update interval. Since
245 this setting uses iterations, the maximum allowed time without update depends
246 on the I<Interval> information contained in each value list. This is used in
247 the I<Threshold> configuration to dispatch notifications about missing values,
248 see L<collectd-threshold(5)> for details.
250 =item B<ReadThreads> I<Num>
252 Number of threads to start for reading plugins. The default value is B<5>, but
253 you may want to increase this if you have more than five plugins that take a
254 long time to read. Mostly those are plugins that do network-IO. Setting this to
255 a value higher than the number of registered read callbacks is not recommended.
257 =item B<WriteThreads> I<Num>
259 Number of threads to start for dispatching value lists to write plugins. The
260 default value is B<5>, but you may want to increase this if you have more than
261 five plugins that may take relatively long to write to.
263 =item B<WriteQueueLimitHigh> I<HighNum>
265 =item B<WriteQueueLimitLow> I<LowNum>
267 Metrics are read by the I<read threads> and then put into a queue to be handled
268 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
269 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
270 running into memory issues in such a case, you can limit the size of this
273 By default, there is no limit and memory may grow indefinitely. This is most
274 likely not an issue for clients, i.e. instances that only handle the local
275 metrics. For servers it is recommended to set this to a non-zero value, though.
277 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
278 Each of them takes a numerical argument which is the number of metrics in the
279 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
280 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
281 I<will> be enqueued. If the number of metrics currently in the queue is between
282 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
283 proportional to the number of metrics in the queue (i.e. it increases linearly
284 until it reaches 100%.)
286 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
287 unset, the latter will default to half of B<WriteQueueLimitHigh>.
289 If you do not want to randomly drop values when the queue size is between
290 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
293 Enabling the B<CollectInternalStats> option is of great help to figure out the
294 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
296 =item B<Hostname> I<Name>
298 Sets the hostname that identifies a host. If you omit this setting, the
299 hostname will be determined using the L<gethostname(2)> system call.
301 =item B<FQDNLookup> B<true|false>
303 If B<Hostname> is determined automatically this setting controls whether or not
304 the daemon should try to figure out the "fully qualified domain name", FQDN.
305 This is done using a lookup of the name returned by C<gethostname>. This option
306 is enabled by default.
308 =item B<PreCacheChain> I<ChainName>
310 =item B<PostCacheChain> I<ChainName>
312 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
313 see L<FILTER CONFIGURATION> below on information on chains and how these
314 setting change the daemon's behavior.
318 =head1 PLUGIN OPTIONS
320 Some plugins may register own options. These options must be enclosed in a
321 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
322 require external configuration, too. The C<apache plugin>, for example,
323 required C<mod_status> to be configured in the webserver you're going to
324 collect data from. These plugins are listed below as well, even if they don't
325 require any configuration within collectd's configuration file.
327 A list of all plugins and a short summary for each plugin can be found in the
328 F<README> file shipped with the sourcecode and hopefully binary packets as
331 =head2 Plugin C<aggregation>
333 The I<Aggregation plugin> makes it possible to aggregate several values into
334 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
335 This can be put to a wide variety of uses, e.g. average and total CPU
336 statistics for your entire fleet.
338 The grouping is powerful but, as with many powerful tools, may be a bit
339 difficult to wrap your head around. The grouping will therefore be
340 demonstrated using an example: The average and sum of the CPU usage across
341 all CPUs of each host is to be calculated.
343 To select all the affected values for our example, set C<Plugin cpu> and
344 C<Type cpu>. The other values are left unspecified, meaning "all values". The
345 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
346 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
352 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
353 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
354 example, the intention is to have a new value for each host / type instance
355 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
356 It can be specified multiple times to group by more than one field.
359 GroupBy "TypeInstance"
361 We do neither specify nor group by I<plugin instance> (the CPU number), so all
362 metrics that differ in the CPU number only will be aggregated. Each
363 aggregation needs I<at least one> such field, otherwise no aggregation would
366 The full example configuration looks like this:
368 <Plugin "aggregation">
374 GroupBy "TypeInstance"
377 CalculateAverage true
381 There are a couple of limitations you should be aware of:
387 The I<Type> cannot be left unspecified, because it is not reasonable to add
388 apples to oranges. Also, the internal lookup structure won't work if you try
393 There must be at least one unspecified, ungrouped field. Otherwise nothing
398 As you can see in the example above, each aggregation has its own
399 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
400 blocks may match the same values, i.e. one value list can update multiple
401 aggregations. The following options are valid inside B<Aggregation> blocks:
405 =item B<Host> I<Host>
407 =item B<Plugin> I<Plugin>
409 =item B<PluginInstance> I<PluginInstance>
411 =item B<Type> I<Type>
413 =item B<TypeInstance> I<TypeInstance>
415 Selects the value lists to be added to this aggregation. B<Type> must be a
416 valid data set name, see L<types.db(5)> for details.
418 If the string starts with and ends with a slash (C</>), the string is
419 interpreted as a I<regular expression>. The regex flavor used are POSIX
420 extended regular expressions as described in L<regex(7)>. Example usage:
422 Host "/^db[0-9]\\.example\\.com$/"
424 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
426 Group valued by the specified field. The B<GroupBy> option may be repeated to
427 group by multiple fields.
429 =item B<SetHost> I<Host>
431 =item B<SetPlugin> I<Plugin>
433 =item B<SetPluginInstance> I<PluginInstance>
435 =item B<SetTypeInstance> I<TypeInstance>
437 Sets the appropriate part of the identifier to the provided string.
439 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
440 will be replaced with the aggregation function, e.g. "average". Not including
441 the placeholder will result in duplication warnings and/or messed up values if
442 more than one aggregation function are enabled.
444 The following example calculates the average usage of all "even" CPUs:
446 <Plugin "aggregation">
449 PluginInstance "/[0,2,4,6,8]$/"
453 SetPluginInstance "even-%{aggregation}"
456 GroupBy "TypeInstance"
458 CalculateAverage true
462 This will create the files:
468 foo.example.com/cpu-even-average/cpu-idle
472 foo.example.com/cpu-even-average/cpu-system
476 foo.example.com/cpu-even-average/cpu-user
484 =item B<CalculateNum> B<true>|B<false>
486 =item B<CalculateSum> B<true>|B<false>
488 =item B<CalculateAverage> B<true>|B<false>
490 =item B<CalculateMinimum> B<true>|B<false>
492 =item B<CalculateMaximum> B<true>|B<false>
494 =item B<CalculateStddev> B<true>|B<false>
496 Boolean options for enabling calculation of the number of value lists, their
497 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
498 are disabled by default.
502 =head2 Plugin C<amqp>
504 The I<AMQMP plugin> can be used to communicate with other instances of
505 I<collectd> or third party applications using an AMQP message broker. Values
506 are sent to or received from the broker, which handles routing, queueing and
507 possibly filtering or messages.
510 # Send values to an AMQP broker
511 <Publish "some_name">
517 Exchange "amq.fanout"
518 # ExchangeType "fanout"
519 # RoutingKey "collectd"
521 # ConnectionRetryDelay 0
524 # GraphitePrefix "collectd."
525 # GraphiteEscapeChar "_"
526 # GraphiteSeparateInstances false
527 # GraphiteAlwaysAppendDS false
530 # Receive values from an AMQP broker
531 <Subscribe "some_name">
537 Exchange "amq.fanout"
538 # ExchangeType "fanout"
541 # QueueAutoDelete true
542 # RoutingKey "collectd.#"
543 # ConnectionRetryDelay 0
547 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
548 blocks, which configure sending and receiving of values respectively. The two
549 blocks are very similar, so unless otherwise noted, an option can be used in
550 either block. The name given in the blocks starting tag is only used for
551 reporting messages, but may be used to support I<flushing> of certain
552 I<Publish> blocks in the future.
556 =item B<Host> I<Host>
558 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
559 the underlying communications library, I<rabbitmq-c>, which is "localhost".
561 =item B<Port> I<Port>
563 Service name or port number on which the AMQP broker accepts connections. This
564 argument must be a string, even if the numeric form is used. Defaults to
567 =item B<VHost> I<VHost>
569 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
571 =item B<User> I<User>
573 =item B<Password> I<Password>
575 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
578 =item B<Exchange> I<Exchange>
580 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
581 By default, "amq.fanout" will be used.
583 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
584 the given exchange and the I<queue> is created, using the I<routing key> if
585 configured. See the B<Queue> and B<RoutingKey> options below.
587 =item B<ExchangeType> I<Type>
589 If given, the plugin will try to create the configured I<exchange> with this
590 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
591 be bound to this exchange.
593 =item B<Queue> I<Queue> (Subscribe only)
595 Configures the I<queue> name to subscribe to. If no queue name was configured
596 explicitly, a unique queue name will be created by the broker.
598 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
600 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
601 or transient (will disappear if the AMQP broker is restarted). Defaults to
604 This option should be used in conjunction with the I<Persistent> option on the
607 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
609 Defines if the I<queue> subscribed to will be deleted once the last consumer
610 unsubscribes. Defaults to "true".
612 =item B<RoutingKey> I<Key>
614 In I<Publish> blocks, this configures the routing key to set on all outgoing
615 messages. If not given, the routing key will be computed from the I<identifier>
616 of the value. The host, plugin, type and the two instances are concatenated
617 together using dots as the separator and all containing dots replaced with
618 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
619 possible to receive only specific values using a "topic" exchange.
621 In I<Subscribe> blocks, configures the I<routing key> used when creating a
622 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
623 used to filter messages when using a "topic" exchange. If you're only
624 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
627 =item B<Persistent> B<true>|B<false> (Publish only)
629 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
630 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
631 default), the I<transient> delivery mode will be used, i.e. messages may be
632 lost due to high load, overflowing queues or similar issues.
634 =item B<ConnectionRetryDelay> I<Delay>
636 When the connection to the AMQP broker is lost, defines the time in seconds to
637 wait before attempting to reconnect. Defaults to 0, which implies collectd will
638 attempt to reconnect at each read interval (in Subscribe mode) or each time
639 values are ready for submission (in Publish mode).
641 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
643 Selects the format in which messages are sent to the broker. If set to
644 B<Command> (the default), values are sent as C<PUTVAL> commands which are
645 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
646 case, the C<Content-Type> header field will be set to C<text/collectd>.
648 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
649 an easy and straight forward exchange format. The C<Content-Type> header field
650 will be set to C<application/json>.
652 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
653 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
656 A subscribing client I<should> use the C<Content-Type> header field to
657 determine how to decode the values. Currently, the I<AMQP plugin> itself can
658 only decode the B<Command> format.
660 =item B<StoreRates> B<true>|B<false> (Publish only)
662 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
663 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
664 default), no conversion is performed. Otherwise the conversion is performed
665 using the internal value cache.
667 Please note that currently this option is only used if the B<Format> option has
670 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
672 A prefix can be added in the metric name when outputting in the I<Graphite> format.
673 It's added before the I<Host> name.
674 Metric name will be "<prefix><host><postfix><plugin><type><name>"
676 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
678 A postfix can be added in the metric name when outputting in the I<Graphite> format.
679 It's added after the I<Host> name.
680 Metric name will be "<prefix><host><postfix><plugin><type><name>"
682 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
684 Specify a character to replace dots (.) in the host part of the metric name.
685 In I<Graphite> metric name, dots are used as separators between different
686 metric parts (host, plugin, type).
687 Default is "_" (I<Underscore>).
689 =item B<GraphiteSeparateInstances> B<true>|B<false>
691 If set to B<true>, the plugin instance and type instance will be in their own
692 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
693 default), the plugin and plugin instance (and likewise the type and type
694 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
696 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
698 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
699 identifier. If set to B<false> (the default), this is only done when there is
704 =head2 Plugin C<apache>
706 To configure the C<apache>-plugin you first need to configure the Apache
707 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
708 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
709 the following snipped to base your Apache config upon:
712 <IfModule mod_status.c>
713 <Location /mod_status>
714 SetHandler server-status
718 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
719 also supported. It introduces a new field, called C<BusyServers>, to count the
720 number of currently connected clients. This field is also supported.
722 The configuration of the I<Apache> plugin consists of one or more
723 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
724 as the instance name. For example:
728 URL "http://www1.example.com/mod_status?auto"
731 URL "http://www2.example.com/mod_status?auto"
735 The instance name will be used as the I<plugin instance>. To emulate the old
736 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
737 plugin to work correctly, each instance name must be unique. This is not
738 enforced by the plugin and it is your responsibility to ensure it.
740 The following options are accepted within each I<Instance> block:
744 =item B<URL> I<http://host/mod_status?auto>
746 Sets the URL of the C<mod_status> output. This needs to be the output generated
747 by C<ExtendedStatus on> and it needs to be the machine readable output
748 generated by appending the C<?auto> argument. This option is I<mandatory>.
750 =item B<User> I<Username>
752 Optional user name needed for authentication.
754 =item B<Password> I<Password>
756 Optional password needed for authentication.
758 =item B<VerifyPeer> B<true|false>
760 Enable or disable peer SSL certificate verification. See
761 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
763 =item B<VerifyHost> B<true|false>
765 Enable or disable peer host name verification. If enabled, the plugin checks
766 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
767 certificate matches the host name provided by the B<URL> option. If this
768 identity check fails, the connection is aborted. Obviously, only works when
769 connecting to a SSL enabled server. Enabled by default.
771 =item B<CACert> I<File>
773 File that holds one or more SSL certificates. If you want to use HTTPS you will
774 possibly need this option. What CA certificates come bundled with C<libcurl>
775 and are checked by default depends on the distribution you use.
777 =item B<SSLCiphers> I<list of ciphers>
779 Specifies which ciphers to use in the connection. The list of ciphers
780 must specify valid ciphers. See
781 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
783 =item B<Timeout> I<Milliseconds>
785 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
786 milliseconds. By default, the configured B<Interval> is used to set the
791 =head2 Plugin C<apcups>
795 =item B<Host> I<Hostname>
797 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
798 that IPv6 support has been disabled unless someone can confirm or decline that
799 B<apcupsd> can handle it.
801 =item B<Port> I<Port>
803 TCP-Port to connect to. Defaults to B<3551>.
805 =item B<ReportSeconds> B<true>|B<false>
807 If set to B<true>, the time reported in the C<timeleft> metric will be
808 converted to seconds. This is the recommended setting. If set to B<false>, the
809 default for backwards compatibility, the time will be reported in minutes.
811 =item B<PersistentConnection> B<true>|B<false>
813 By default, the plugin will try to keep the connection to UPS open between
814 reads. Since this appears to be somewhat brittle (I<apcupsd> appears to close
815 the connection due to inactivity quite quickly), the plugin will try to detect
816 this problem and switch to an open-read-close mode in such cases.
818 You can instruct the plugin to close the connection after each read by setting
819 this option to B<false>.
823 =head2 Plugin C<aquaero>
825 This plugin collects the value of the available sensors in an
826 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
827 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
828 connection for monitoring and configuration. The board can handle multiple
829 temperature sensors, fans, water pumps and water level sensors and adjust the
830 output settings such as fan voltage or power used by the water pump based on
831 the available inputs using a configurable controller included in the board.
832 This plugin collects all the available inputs as well as some of the output
833 values chosen by this controller. The plugin is based on the I<libaquaero5>
834 library provided by I<aquatools-ng>.
838 =item B<Device> I<DevicePath>
840 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
841 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
842 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
846 =head2 Plugin C<ascent>
848 This plugin collects information about an Ascent server, a free server for the
849 "World of Warcraft" game. This plugin gathers the information by fetching the
850 XML status page using C<libcurl> and parses it using C<libxml2>.
852 The configuration options are the same as for the C<apache> plugin above:
856 =item B<URL> I<http://localhost/ascent/status/>
858 Sets the URL of the XML status output.
860 =item B<User> I<Username>
862 Optional user name needed for authentication.
864 =item B<Password> I<Password>
866 Optional password needed for authentication.
868 =item B<VerifyPeer> B<true|false>
870 Enable or disable peer SSL certificate verification. See
871 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
873 =item B<VerifyHost> B<true|false>
875 Enable or disable peer host name verification. If enabled, the plugin checks
876 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
877 certificate matches the host name provided by the B<URL> option. If this
878 identity check fails, the connection is aborted. Obviously, only works when
879 connecting to a SSL enabled server. Enabled by default.
881 =item B<CACert> I<File>
883 File that holds one or more SSL certificates. If you want to use HTTPS you will
884 possibly need this option. What CA certificates come bundled with C<libcurl>
885 and are checked by default depends on the distribution you use.
887 =item B<Timeout> I<Milliseconds>
889 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
890 milliseconds. By default, the configured B<Interval> is used to set the
895 =head2 Plugin C<barometer>
897 This plugin reads absolute air pressure using digital barometer sensor on a I2C
898 bus. Supported sensors are:
902 =item I<MPL115A2> from Freescale,
903 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
906 =item I<MPL3115> from Freescale
907 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
910 =item I<BMP085> from Bosch Sensortec
914 The sensor type - one of the above - is detected automatically by the plugin
915 and indicated in the plugin_instance (you will see subdirectory
916 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
917 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
918 (only one sensor can be used by the plugin).
920 The plugin provides absolute barometric pressure, air pressure reduced to sea
921 level (several possible approximations) and as an auxiliary value also internal
922 sensor temperature. It uses (expects/provides) typical metric units - pressure
923 in [hPa], temperature in [C], altitude in [m].
925 It was developed and tested under Linux only. The only platform dependency is
926 the standard Linux i2c-dev interface (the particular bus driver has to
927 support the SM Bus command subset).
929 The reduction or normalization to mean sea level pressure requires (depending
930 on selected method/approximation) also altitude and reference to temperature
931 sensor(s). When multiple temperature sensors are configured the minumum of
932 their values is always used (expecting that the warmer ones are affected by
933 e.g. direct sun light at that moment).
941 TemperatureOffset 0.0
944 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
949 =item B<Device> I<device>
951 The only mandatory configuration parameter.
953 Device name of the I2C bus to which the sensor is connected. Note that
954 typically you need to have loaded the i2c-dev module.
955 Using i2c-tools you can check/list i2c buses available on your system by:
959 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
963 This way you should be able to verify that the pressure sensor (either type) is
964 connected and detected on address 0x60.
966 =item B<Oversampling> I<value>
968 Optional parameter controlling the oversampling/accuracy. Default value
969 is 1 providing fastest and least accurate reading.
971 For I<MPL115> this is the size of the averaging window. To filter out sensor
972 noise a simple averaging using floating window of this configurable size is
973 used. The plugin will use average of the last C<value> measurements (value of 1
974 means no averaging). Minimal size is 1, maximal 1024.
976 For I<MPL3115> this is the oversampling value. The actual oversampling is
977 performed by the sensor and the higher value the higher accuracy and longer
978 conversion time (although nothing to worry about in the collectd context).
979 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
980 adjusted by the plugin to the closest supported one.
982 For I<BMP085> this is the oversampling value. The actual oversampling is
983 performed by the sensor and the higher value the higher accuracy and longer
984 conversion time (although nothing to worry about in the collectd context).
985 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
986 the closest supported one.
988 =item B<PressureOffset> I<offset>
990 Optional parameter for MPL3115 only.
992 You can further calibrate the sensor by supplying pressure and/or temperature
993 offsets. This is added to the measured/caclulated value (i.e. if the measured
994 value is too high then use negative offset).
995 In hPa, default is 0.0.
997 =item B<TemperatureOffset> I<offset>
999 Optional parameter for MPL3115 only.
1001 You can further calibrate the sensor by supplying pressure and/or temperature
1002 offsets. This is added to the measured/caclulated value (i.e. if the measured
1003 value is too high then use negative offset).
1004 In C, default is 0.0.
1006 =item B<Normalization> I<method>
1008 Optional parameter, default value is 0.
1010 Normalization method - what approximation/model is used to compute the mean sea
1011 level pressure from the air absolute pressure.
1013 Supported values of the C<method> (integer between from 0 to 2) are:
1017 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1018 do not need to configure C<Altitude> or C<TemperatureSensor>.
1020 =item B<1> - international formula for conversion ,
1022 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1023 For this method you have to configure C<Altitude> but do not need
1024 C<TemperatureSensor> (uses fixed global temperature average instead).
1026 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1027 Meteorological Service).
1028 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1029 For this method you have to configure both C<Altitude> and
1030 C<TemperatureSensor>.
1035 =item B<Altitude> I<altitude>
1037 The altitude (in meters) of the location where you meassure the pressure.
1039 =item B<TemperatureSensor> I<reference>
1041 Temperature sensor(s) which should be used as a reference when normalizing the
1042 pressure using C<Normalization> method 2.
1043 When specified more sensors a minumum is found and used each time. The
1044 temperature reading directly from this pressure sensor/plugin is typically not
1045 suitable as the pressure sensor will be probably inside while we want outside
1046 temperature. The collectd reference name is something like
1047 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1048 (<type_instance> is usually omitted when there is just single value type). Or
1049 you can figure it out from the path of the output data files.
1053 =head2 Plugin C<battery>
1055 The I<battery plugin> reports the remaining capacity, power and voltage of
1060 =item B<ValuesPercentage> B<false>|B<true>
1062 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1063 capacity remaining". Otherwise the capacity is stored as reported by the
1064 battery, most likely in "Wh". This option does not work with all input methods,
1065 in particular when only C</proc/pmu> is available on an old Linux system.
1066 Defaults to B<false>.
1068 =item B<ReportDegraded> B<false>|B<true>
1070 Typical laptop batteries degrade over time, meaning the capacity decreases with
1071 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1072 "last full capacity" and used to determine that a battery is "fully charged".
1074 When this option is set to B<false>, the default, the I<battery plugin> will
1075 only report the remaining capacity. If the B<ValuesPercentage> option is
1076 enabled, the relative remaining capacity is calculated as the ratio of the
1077 "remaining capacity" and the "last full capacity". This is what most tools,
1078 such as the status bar of desktop environments, also do.
1080 When set to B<true>, the battery plugin will report three values: B<charged>
1081 (remaining capacity), B<discharged> (difference between "last full capacity"
1082 and "remaining capacity") and B<degraded> (difference between "design capacity"
1083 and "last full capacity").
1087 =head2 Plugin C<bind>
1089 Starting with BIND 9.5.0, the most widely used DNS server software provides
1090 extensive statistics about queries, responses and lots of other information.
1091 The bind plugin retrieves this information that's encoded in XML and provided
1092 via HTTP and submits the values to collectd.
1094 To use this plugin, you first need to tell BIND to make this information
1095 available. This is done with the C<statistics-channels> configuration option:
1097 statistics-channels {
1098 inet localhost port 8053;
1101 The configuration follows the grouping that can be seen when looking at the
1102 data with an XSLT compatible viewer, such as a modern web browser. It's
1103 probably a good idea to make yourself familiar with the provided values, so you
1104 can understand what the collected statistics actually mean.
1109 URL "http://localhost:8053/"
1124 Zone "127.in-addr.arpa/IN"
1128 The bind plugin accepts the following configuration options:
1134 URL from which to retrieve the XML data. If not specified,
1135 C<http://localhost:8053/> will be used.
1137 =item B<ParseTime> B<true>|B<false>
1139 When set to B<true>, the time provided by BIND will be parsed and used to
1140 dispatch the values. When set to B<false>, the local time source is queried.
1142 This setting is set to B<true> by default for backwards compatibility; setting
1143 this to B<false> is I<recommended> to avoid problems with timezones and
1146 =item B<OpCodes> B<true>|B<false>
1148 When enabled, statistics about the I<"OpCodes">, for example the number of
1149 C<QUERY> packets, are collected.
1153 =item B<QTypes> B<true>|B<false>
1155 When enabled, the number of I<incoming> queries by query types (for example
1156 C<A>, C<MX>, C<AAAA>) is collected.
1160 =item B<ServerStats> B<true>|B<false>
1162 Collect global server statistics, such as requests received over IPv4 and IPv6,
1163 successful queries, and failed updates.
1167 =item B<ZoneMaintStats> B<true>|B<false>
1169 Collect zone maintenance statistics, mostly information about notifications
1170 (zone updates) and zone transfers.
1174 =item B<ResolverStats> B<true>|B<false>
1176 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1177 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1178 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1179 default. Use the B<ResolverStats> option within a B<View "_default"> block
1180 instead for the same functionality.
1184 =item B<MemoryStats>
1186 Collect global memory statistics.
1190 =item B<Timeout> I<Milliseconds>
1192 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1193 milliseconds. By default, the configured B<Interval> is used to set the
1196 =item B<View> I<Name>
1198 Collect statistics about a specific I<"view">. BIND can behave different,
1199 mostly depending on the source IP-address of the request. These different
1200 configurations are called "views". If you don't use this feature, you most
1201 likely are only interested in the C<_default> view.
1203 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1204 information you want to collect about a view. If no B<View> block is
1205 configured, no detailed view statistics will be collected.
1209 =item B<QTypes> B<true>|B<false>
1211 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1212 C<MX>) is collected.
1216 =item B<ResolverStats> B<true>|B<false>
1218 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1219 (e.E<nbsp>g. queries over IPv4, lame servers).
1223 =item B<CacheRRSets> B<true>|B<false>
1225 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1226 type is collected. Negative entries (queries which resulted in an error, for
1227 example names that do not exist) are reported with a leading exclamation mark,
1232 =item B<Zone> I<Name>
1234 When given, collect detailed information about the given zone in the view. The
1235 information collected if very similar to the global B<ServerStats> information
1238 You can repeat this option to collect detailed information about multiple
1241 By default no detailed zone information is collected.
1247 =head2 Plugin C<ceph>
1249 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1250 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1252 A separate B<Daemon> block must be configured for each ceph daemon to be
1253 monitored. The following example will read daemon statistics from four
1254 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1257 LongRunAvgLatency false
1258 ConvertSpecialMetricTypes true
1260 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1263 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1266 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1269 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1273 The ceph plugin accepts the following configuration options:
1277 =item B<LongRunAvgLatency> B<true>|B<false>
1279 If enabled, latency values(sum,count pairs) are calculated as the long run
1280 average - average since the ceph daemon was started = (sum / count).
1281 When disabled, latency values are calculated as the average since the last
1282 collection = (sum_now - sum_last) / (count_now - count_last).
1286 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1288 If enabled, special metrics (metrics that differ in type from similar counters)
1289 are converted to the type of those similar counters. This currently only
1290 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1291 ceph schema reports this metric type as a sum,count pair while similar counters
1292 are treated as derive types. When converted, the sum is used as the counter
1293 value and is treated as a derive type.
1294 When disabled, all metrics are treated as the types received from the ceph schema.
1300 Each B<Daemon> block must have a string argument for the plugin instance name.
1301 A B<SocketPath> is also required for each B<Daemon> block:
1305 =item B<Daemon> I<DaemonName>
1307 Name to be used as the instance name for this daemon.
1309 =item B<SocketPath> I<SocketPath>
1311 Specifies the path to the UNIX admin socket of the ceph daemon.
1315 =head2 Plugin C<cgroups>
1317 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1318 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1319 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1323 =item B<CGroup> I<Directory>
1325 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1326 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1329 =item B<IgnoreSelected> B<true>|B<false>
1331 Invert the selection: If set to true, all cgroups I<except> the ones that
1332 match any one of the criteria are collected. By default only selected
1333 cgroups are collected if a selection is made. If no selection is configured
1334 at all, B<all> cgroups are selected.
1338 =head2 Plugin C<conntrack>
1340 This plugin collects IP conntrack statistics.
1346 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1347 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1351 =head2 Plugin C<cpu>
1353 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1354 as Jiffies, using the C<cpu> type. Two aggregations are available:
1360 Sum, per-state, over all CPUs installed in the system; and
1364 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1368 The two aggregations can be combined, leading to I<collectd> only emitting a
1369 single "active" metric for the entire system. As soon as one of these
1370 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1371 rather than Jiffies. In addition, you can request individual, per-state,
1372 per-CPU metrics to be reported as percentage.
1374 The following configuration options are available:
1378 =item B<ReportByState> B<true>|B<false>
1380 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1382 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1385 =item B<ReportByCpu> B<true>|B<false>
1387 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1388 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1389 global sum of CPU states is emitted.
1391 =item B<ValuesPercentage> B<false>|B<true>
1393 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1394 are set to B<true>. In this case, by default, metrics will be reported as
1395 Jiffies. By setting this option to B<true>, you can request percentage values
1396 in the un-aggregated (per-CPU, per-state) mode as well.
1400 =head2 Plugin C<cpufreq>
1402 This plugin doesn't have any options. It reads
1403 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1404 installed) to get the current CPU frequency. If this file does not exist make
1405 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1406 installed and an "cpu governor" (that's a kernel module) is loaded.
1408 =head2 Plugin C<csv>
1412 =item B<DataDir> I<Directory>
1414 Set the directory to store CSV-files under. Per default CSV-files are generated
1415 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1416 The special strings B<stdout> and B<stderr> can be used to write to the standard
1417 output and standard error channels, respectively. This, of course, only makes
1418 much sense when collectd is running in foreground- or non-daemon-mode.
1420 =item B<StoreRates> B<true|false>
1422 If set to B<true>, convert counter values to rates. If set to B<false> (the
1423 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1428 =head2 Plugin C<curl>
1430 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1431 and the match infrastructure (the same code used by the tail plugin) to use
1432 regular expressions with the received data.
1434 The following example will read the current value of AMD stock from Google's
1435 finance page and dispatch the value to collectd.
1438 <Page "stock_quotes">
1439 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1445 CACert "/path/to/ca.crt"
1446 Header "X-Custom-Header: foobar"
1449 MeasureResponseTime false
1450 MeasureResponseCode false
1453 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1454 DSType "GaugeAverage"
1455 # Note: `stock_value' is not a standard type.
1462 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1463 a web page and one or more "matches" to be performed on the returned data. The
1464 string argument to the B<Page> block is used as plugin instance.
1466 The following options are valid within B<Page> blocks:
1472 URL of the web site to retrieve. Since a regular expression will be used to
1473 extract information from this data, non-binary data is a big plus here ;)
1475 =item B<User> I<Name>
1477 Username to use if authorization is required to read the page.
1479 =item B<Password> I<Password>
1481 Password to use if authorization is required to read the page.
1483 =item B<Digest> B<true>|B<false>
1485 Enable HTTP digest authentication.
1487 =item B<VerifyPeer> B<true>|B<false>
1489 Enable or disable peer SSL certificate verification. See
1490 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1492 =item B<VerifyHost> B<true>|B<false>
1494 Enable or disable peer host name verification. If enabled, the plugin checks if
1495 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1496 matches the host name provided by the B<URL> option. If this identity check
1497 fails, the connection is aborted. Obviously, only works when connecting to a
1498 SSL enabled server. Enabled by default.
1500 =item B<CACert> I<file>
1502 File that holds one or more SSL certificates. If you want to use HTTPS you will
1503 possibly need this option. What CA certificates come bundled with C<libcurl>
1504 and are checked by default depends on the distribution you use.
1506 =item B<Header> I<Header>
1508 A HTTP header to add to the request. Multiple headers are added if this option
1509 is specified more than once.
1511 =item B<Post> I<Body>
1513 Specifies that the HTTP operation should be a POST instead of a GET. The
1514 complete data to be posted is given as the argument. This option will usually
1515 need to be accompanied by a B<Header> option to set an appropriate
1516 C<Content-Type> for the post body (e.g. to
1517 C<application/x-www-form-urlencoded>).
1519 =item B<MeasureResponseTime> B<true>|B<false>
1521 Measure response time for the request. If this setting is enabled, B<Match>
1522 blocks (see below) are optional. Disabled by default.
1524 Beware that requests will get aborted if they take too long to complete. Adjust
1525 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1528 =item B<MeasureResponseCode> B<true>|B<false>
1530 Measure response code for the request. If this setting is enabled, B<Match>
1531 blocks (see below) are optional. Disabled by default.
1533 =item B<E<lt>MatchE<gt>>
1535 One or more B<Match> blocks that define how to match information in the data
1536 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1537 used by the C<tail> plugin, so please see the documentation of the C<tail>
1538 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1539 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1542 =item B<Timeout> I<Milliseconds>
1544 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1545 milliseconds. By default, the configured B<Interval> is used to set the
1546 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1547 indefinitely. This legacy behaviour can be achieved by setting the value of
1550 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1551 network connection will stall one read thread. Adjust the B<ReadThreads> global
1552 setting accordingly to prevent this from blocking other plugins.
1556 =head2 Plugin C<curl_json>
1558 The B<curl_json plugin> collects values from JSON data to be parsed by
1559 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1560 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1561 unix socket. The former can be used, for example, to collect values
1562 from CouchDB documents (which are stored JSON notation), and the
1563 latter to collect values from a uWSGI stats socket.
1565 The following example will collect several values from the built-in
1566 C<_stats> runtime statistics module of I<CouchDB>
1567 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1570 <URL "http://localhost:5984/_stats">
1572 <Key "httpd/requests/count">
1573 Type "http_requests"
1576 <Key "httpd_request_methods/*/count">
1577 Type "http_request_methods"
1580 <Key "httpd_status_codes/*/count">
1581 Type "http_response_codes"
1586 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1589 <Sock "/var/run/uwsgi.stats.sock">
1591 <Key "workers/*/requests">
1592 Type "http_requests"
1595 <Key "workers/*/apps/*/requests">
1596 Type "http_requests"
1601 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1602 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1603 blocks defining a unix socket to read JSON from directly. Each of
1604 these blocks may have one or more B<Key> blocks.
1606 The B<Key> string argument must be in a path format. Each component is
1607 used to match the key from a JSON map or the index of an JSON
1608 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1609 values for all map keys or array indices will be collectd.
1611 The following options are valid within B<URL> blocks:
1615 =item B<Instance> I<Instance>
1617 Sets the plugin instance to I<Instance>.
1619 =item B<Interval> I<Interval>
1621 Sets the interval (in seconds) in which the values will be collected from this
1622 URL. By default the global B<Interval> setting will be used.
1624 =item B<User> I<Name>
1626 =item B<Password> I<Password>
1628 =item B<Digest> B<true>|B<false>
1630 =item B<VerifyPeer> B<true>|B<false>
1632 =item B<VerifyHost> B<true>|B<false>
1634 =item B<CACert> I<file>
1636 =item B<Header> I<Header>
1638 =item B<Post> I<Body>
1640 =item B<Timeout> I<Milliseconds>
1642 These options behave exactly equivalent to the appropriate options of the
1643 I<cURL> plugin. Please see there for a detailed description.
1647 The following options are valid within B<Key> blocks:
1651 =item B<Type> I<Type>
1653 Sets the type used to dispatch the values to the daemon. Detailed information
1654 about types and their configuration can be found in L<types.db(5)>. This
1655 option is mandatory.
1657 =item B<Instance> I<Instance>
1659 Type-instance to use. Defaults to the current map key or current string array element value.
1663 =head2 Plugin C<curl_xml>
1665 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1666 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1669 <URL "http://localhost/stats.xml">
1671 Instance "some_instance"
1676 CACert "/path/to/ca.crt"
1677 Header "X-Custom-Header: foobar"
1680 <XPath "table[@id=\"magic_level\"]/tr">
1682 #InstancePrefix "prefix-"
1683 InstanceFrom "td[1]"
1684 ValuesFrom "td[2]/span[@class=\"level\"]"
1689 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1690 URL to be fetched using libcurl. Within each B<URL> block there are
1691 options which specify the connection parameters, for example authentication
1692 information, and one or more B<XPath> blocks.
1694 Each B<XPath> block specifies how to get one type of information. The
1695 string argument must be a valid XPath expression which returns a list
1696 of "base elements". One value is dispatched for each "base element". The
1697 I<type instance> and values are looked up using further I<XPath> expressions
1698 that should be relative to the base element.
1700 Within the B<URL> block the following options are accepted:
1704 =item B<Host> I<Name>
1706 Use I<Name> as the host name when submitting values. Defaults to the global
1709 =item B<Instance> I<Instance>
1711 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1712 empty string (no plugin instance).
1714 =item B<Namespace> I<Prefix> I<URL>
1716 If an XPath expression references namespaces, they must be specified
1717 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1718 I<URL> is the "namespace name", an URI reference uniquely identifying the
1719 namespace. The option can be repeated to register multiple namespaces.
1723 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1724 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1726 =item B<User> I<User>
1728 =item B<Password> I<Password>
1730 =item B<Digest> B<true>|B<false>
1732 =item B<VerifyPeer> B<true>|B<false>
1734 =item B<VerifyHost> B<true>|B<false>
1736 =item B<CACert> I<CA Cert File>
1738 =item B<Header> I<Header>
1740 =item B<Post> I<Body>
1742 =item B<Timeout> I<Milliseconds>
1744 These options behave exactly equivalent to the appropriate options of the
1745 I<cURL plugin>. Please see there for a detailed description.
1747 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1749 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1750 B<XPath> block specifies how to get one type of information. The string
1751 argument must be a valid XPath expression which returns a list of "base
1752 elements". One value is dispatched for each "base element".
1754 Within the B<XPath> block the following options are accepted:
1758 =item B<Type> I<Type>
1760 Specifies the I<Type> used for submitting patches. This determines the number
1761 of values that are required / expected and whether the strings are parsed as
1762 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1763 This option is required.
1765 =item B<InstancePrefix> I<InstancePrefix>
1767 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1768 concatenated together without any separator.
1769 This option is optional.
1771 =item B<InstanceFrom> I<InstanceFrom>
1773 Specifies a XPath expression to use for determining the I<type instance>. The
1774 XPath expression must return exactly one element. The element's value is then
1775 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1777 This value is required. As a special exception, if the "base XPath expression"
1778 (the argument to the B<XPath> block) returns exactly one argument, then this
1779 option may be omitted.
1781 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1783 Specifies one or more XPath expression to use for reading the values. The
1784 number of XPath expressions must match the number of data sources in the
1785 I<type> specified with B<Type> (see above). Each XPath expression must return
1786 exactly one element. The element's value is then parsed as a number and used as
1787 value for the appropriate value in the value list dispatched to the daemon.
1793 =head2 Plugin C<dbi>
1795 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1796 connect to various databases, execute I<SQL> statements and read back the
1797 results. I<dbi> is an acronym for "database interface" in case you were
1798 wondering about the name. You can configure how each column is to be
1799 interpreted and the plugin will generate one or more data sets from each row
1800 returned according to these rules.
1802 Because the plugin is very generic, the configuration is a little more complex
1803 than those of other plugins. It usually looks something like this:
1806 <Query "out_of_stock">
1807 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1808 # Use with MySQL 5.0.0 or later
1812 InstancePrefix "out_of_stock"
1813 InstancesFrom "category"
1817 <Database "product_information">
1819 DriverOption "host" "localhost"
1820 DriverOption "username" "collectd"
1821 DriverOption "password" "aZo6daiw"
1822 DriverOption "dbname" "prod_info"
1823 SelectDB "prod_info"
1824 Query "out_of_stock"
1828 The configuration above defines one query with one result and one database. The
1829 query is then linked to the database with the B<Query> option I<within> the
1830 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1831 and you can also use the B<Include> statement to split up the configuration
1832 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1833 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1836 The following is a complete list of options:
1838 =head3 B<Query> blocks
1840 Query blocks define I<SQL> statements and how the returned data should be
1841 interpreted. They are identified by the name that is given in the opening line
1842 of the block. Thus the name needs to be unique. Other than that, the name is
1843 not used in collectd.
1845 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1846 define which column holds which value or instance information. You can use
1847 multiple B<Result> blocks to create multiple values from one returned row. This
1848 is especially useful, when queries take a long time and sending almost the same
1849 query again and again is not desirable.
1853 <Query "environment">
1854 Statement "select station, temperature, humidity from environment"
1857 # InstancePrefix "foo"
1858 InstancesFrom "station"
1859 ValuesFrom "temperature"
1863 InstancesFrom "station"
1864 ValuesFrom "humidity"
1868 The following options are accepted:
1872 =item B<Statement> I<SQL>
1874 Sets the statement that should be executed on the server. This is B<not>
1875 interpreted by collectd, but simply passed to the database server. Therefore,
1876 the SQL dialect that's used depends on the server collectd is connected to.
1878 The query has to return at least two columns, one for the instance and one
1879 value. You cannot omit the instance, even if the statement is guaranteed to
1880 always return exactly one line. In that case, you can usually specify something
1883 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1885 (That works with MySQL but may not be valid SQL according to the spec. If you
1886 use a more strict database server, you may have to select from a dummy table or
1889 Please note that some databases, for example B<Oracle>, will fail if you
1890 include a semicolon at the end of the statement.
1892 =item B<MinVersion> I<Version>
1894 =item B<MaxVersion> I<Value>
1896 Only use this query for the specified database version. You can use these
1897 options to provide multiple queries with the same name but with a slightly
1898 different syntax. The plugin will use only those queries, where the specified
1899 minimum and maximum versions fit the version of the database in use.
1901 The database version is determined by C<dbi_conn_get_engine_version>, see the
1902 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1903 for details. Basically, each part of the version is assumed to be in the range
1904 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1905 "40102", version "5.0.42" becomes "50042".
1907 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1908 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1909 happen. Don't to it! A valid example would be something along these lines:
1920 In the above example, there are three ranges that don't overlap. The last one
1921 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1922 before "4.0.0" are not specified.
1924 =item B<Type> I<Type>
1926 The B<type> that's used for each line returned. See L<types.db(5)> for more
1927 details on how types are defined. In short: A type is a predefined layout of
1928 data and the number of values and type of values has to match the type
1931 If you specify "temperature" here, you need exactly one gauge column. If you
1932 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1935 There must be exactly one B<Type> option inside each B<Result> block.
1937 =item B<InstancePrefix> I<prefix>
1939 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1940 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1941 all strings returned in the appropriate columns are concatenated together,
1942 separated by dashes I<("-")>.
1944 =item B<InstancesFrom> I<column0> [I<column1> ...]
1946 Specifies the columns whose values will be used to create the "type-instance"
1947 for each row. If you specify more than one column, the value of all columns
1948 will be joined together with dashes I<("-")> as separation characters.
1950 The plugin itself does not check whether or not all built instances are
1951 different. It's your responsibility to assure that each is unique. This is
1952 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1953 sure that only one row is returned in this case.
1955 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1958 =item B<ValuesFrom> I<column0> [I<column1> ...]
1960 Names the columns whose content is used as the actual data for the data sets
1961 that are dispatched to the daemon. How many such columns you need is determined
1962 by the B<Type> setting above. If you specify too many or not enough columns,
1963 the plugin will complain about that and no data will be submitted to the
1966 The actual data type in the columns is not that important. The plugin will
1967 automatically cast the values to the right type if it know how to do that. So
1968 it should be able to handle integer an floating point types, as well as strings
1969 (if they include a number at the beginning).
1971 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1973 =item B<MetadataFrom> [I<column0> I<column1> ...]
1975 Names the columns whose content is used as metadata for the data sets
1976 that are dispatched to the daemon.
1978 The actual data type in the columns is not that important. The plugin will
1979 automatically cast the values to the right type if it know how to do that. So
1980 it should be able to handle integer an floating point types, as well as strings
1981 (if they include a number at the beginning).
1985 =head3 B<Database> blocks
1987 Database blocks define a connection to a database and which queries should be
1988 sent to that database. Since the used "dbi" library can handle a wide variety
1989 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1990 documentationE<nbsp>- we stick as close to the terminology used there.
1992 Each database needs a "name" as string argument in the starting tag of the
1993 block. This name will be used as "PluginInstance" in the values submitted to
1994 the daemon. Other than that, that name is not used.
1998 =item B<Driver> I<Driver>
2000 Specifies the driver to use to connect to the database. In many cases those
2001 drivers are named after the database they can connect to, but this is not a
2002 technical necessity. These drivers are sometimes referred to as "DBD",
2003 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2004 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2005 project at L<http://libdbi-drivers.sourceforge.net/>.
2007 You need to give the driver name as expected by the "dbi" library here. You
2008 should be able to find that in the documentation for each driver. If you
2009 mistype the driver name, the plugin will dump a list of all known driver names
2012 =item B<DriverOption> I<Key> I<Value>
2014 Sets driver-specific options. What option a driver supports can be found in the
2015 documentation for each driver, somewhere at
2016 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2017 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2019 DBDs can register two types of options: String options and numeric options. The
2020 plugin will use the C<dbi_conn_set_option> function when the configuration
2021 provides a string and the C<dbi_conn_require_option_numeric> function when the
2022 configuration provides a number. So these two lines will actually result in
2023 different calls being used:
2025 DriverOption "Port" 1234 # numeric
2026 DriverOption "Port" "1234" # string
2028 Unfortunately, drivers are not too keen to report errors when an unknown option
2029 is passed to them, so invalid settings here may go unnoticed. This is not the
2030 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2031 the driver. If a driver complains about an option, the plugin will dump a
2032 complete list of all options understood by that driver to the log. There is no
2033 way to programatically find out if an option expects a string or a numeric
2034 argument, so you will have to refer to the appropriate DBD's documentation to
2035 find this out. Sorry.
2037 =item B<SelectDB> I<Database>
2039 In some cases, the database name you connect with is not the database name you
2040 want to use for querying data. If this option is set, the plugin will "select"
2041 (switch to) that database after the connection is established.
2043 =item B<Query> I<QueryName>
2045 Associates the query named I<QueryName> with this database connection. The
2046 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2047 blocks you want to refer to must be placed above the database block you want to
2050 =item B<Host> I<Hostname>
2052 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2053 values. Defaults to the global hostname setting.
2061 =item B<Device> I<Device>
2063 Select partitions based on the devicename.
2065 =item B<MountPoint> I<Directory>
2067 Select partitions based on the mountpoint.
2069 =item B<FSType> I<FSType>
2071 Select partitions based on the filesystem type.
2073 =item B<IgnoreSelected> B<true>|B<false>
2075 Invert the selection: If set to true, all partitions B<except> the ones that
2076 match any one of the criteria are collected. By default only selected
2077 partitions are collected if a selection is made. If no selection is configured
2078 at all, B<all> partitions are selected.
2080 =item B<ReportByDevice> B<true>|B<false>
2082 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2083 (the default), it will report a disk as "root", but with it I<true>, it will be
2084 "sda1" (or whichever).
2086 =item B<ReportInodes> B<true>|B<false>
2088 Enables or disables reporting of free, reserved and used inodes. Defaults to
2089 inode collection being disabled.
2091 Enable this option if inodes are a scarce resource for you, usually because
2092 many small files are stored on the disk. This is a usual scenario for mail
2093 transfer agents and web caches.
2095 =item B<ValuesAbsolute> B<true>|B<false>
2097 Enables or disables reporting of free and used disk space in 1K-blocks.
2098 Defaults to B<true>.
2100 =item B<ValuesPercentage> B<false>|B<true>
2102 Enables or disables reporting of free and used disk space in percentage.
2103 Defaults to B<false>.
2105 This is useful for deploying I<collectd> on the cloud, where machines with
2106 different disk size may exist. Then it is more practical to configure
2107 thresholds based on relative disk size.
2111 =head2 Plugin C<disk>
2113 The C<disk> plugin collects information about the usage of physical disks and
2114 logical disks (partitions). Values collected are the number of octets written
2115 to and read from a disk or partition, the number of read/write operations
2116 issued to the disk and a rather complex "time" it took for these commands to be
2119 Using the following two options you can ignore some disks or configure the
2120 collection only of specific disks.
2124 =item B<Disk> I<Name>
2126 Select the disk I<Name>. Whether it is collected or ignored depends on the
2127 B<IgnoreSelected> setting, see below. As with other plugins that use the
2128 daemon's ignorelist functionality, a string that starts and ends with a slash
2129 is interpreted as a regular expression. Examples:
2134 =item B<IgnoreSelected> B<true>|B<false>
2136 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2137 statements, are ignored or if all other disks are ignored. The behavior
2138 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2139 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2140 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2141 is set to B<true>, all disks are collected B<except> the ones matched.
2143 =item B<UseBSDName> B<true>|B<false>
2145 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2146 default major/minor numbers. Requires collectd to be built with Apple's
2149 =item B<UdevNameAttr> I<Attribute>
2151 Attempt to override disk instance name with the value of a specified udev
2152 attribute when built with B<libudev>. If the attribute is not defined for the
2153 given device, the default name is used. Example:
2155 UdevNameAttr "DM_NAME"
2159 =head2 Plugin C<dns>
2163 =item B<Interface> I<Interface>
2165 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2166 option sets the interface that should be used. If this option is not set, or
2167 set to "any", the plugin will try to get packets from B<all> interfaces. This
2168 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2170 =item B<IgnoreSource> I<IP-address>
2172 Ignore packets that originate from this address.
2174 =item B<SelectNumericQueryTypes> B<true>|B<false>
2176 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2180 =head2 Plugin C<email>
2184 =item B<SocketFile> I<Path>
2186 Sets the socket-file which is to be created.
2188 =item B<SocketGroup> I<Group>
2190 If running as root change the group of the UNIX-socket after it has been
2191 created. Defaults to B<collectd>.
2193 =item B<SocketPerms> I<Permissions>
2195 Change the file permissions of the UNIX-socket after it has been created. The
2196 permissions must be given as a numeric, octal value as you would pass to
2197 L<chmod(1)>. Defaults to B<0770>.
2199 =item B<MaxConns> I<Number>
2201 Sets the maximum number of connections that can be handled in parallel. Since
2202 this many threads will be started immediately setting this to a very high
2203 value will waste valuable resources. Defaults to B<5> and will be forced to be
2204 at most B<16384> to prevent typos and dumb mistakes.
2208 =head2 Plugin C<ethstat>
2210 The I<ethstat plugin> collects information about network interface cards (NICs)
2211 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2217 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2218 Map "multicast" "if_multicast"
2225 =item B<Interface> I<Name>
2227 Collect statistical information about interface I<Name>.
2229 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2231 By default, the plugin will submit values as type C<derive> and I<type
2232 instance> set to I<Name>, the name of the metric as reported by the driver. If
2233 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2234 I<TypeInstance> will be used.
2236 =item B<MappedOnly> B<true>|B<false>
2238 When set to B<true>, only metrics that can be mapped to to a I<type> will be
2239 collected, all other metrics will be ignored. Defaults to B<false>.
2243 =head2 Plugin C<exec>
2245 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2246 contains valuable information on when the executable is executed and the
2247 output that is expected from it.
2251 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2253 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2255 Execute the executable I<Executable> as user I<User>. If the user name is
2256 followed by a colon and a group name, the effective group is set to that group.
2257 The real group and saved-set group will be set to the default group of that
2258 user. If no group is given the effective group ID will be the same as the real
2261 Please note that in order to change the user and/or group the daemon needs
2262 superuser privileges. If the daemon is run as an unprivileged user you must
2263 specify the same user/group here. If the daemon is run with superuser
2264 privileges, you must supply a non-root user here.
2266 The executable may be followed by optional arguments that are passed to the
2267 program. Please note that due to the configuration parsing numbers and boolean
2268 values may be changed. If you want to be absolutely sure that something is
2269 passed as-is please enclose it in quotes.
2271 The B<Exec> and B<NotificationExec> statements change the semantics of the
2272 programs executed, i.E<nbsp>e. the data passed to them and the response
2273 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2277 =head2 Plugin C<fhcount>
2279 The C<fhcount> plugin provides statistics about used, unused and total number of
2282 The I<fhcount plugin> provides the following configuration options:
2286 =item B<ValuesAbsolute> B<true>|B<false>
2288 Enables or disables reporting of file handles usage in absolute numbers,
2289 e.g. file handles used. Defaults to B<true>.
2291 =item B<ValuesPercentage> B<false>|B<true>
2293 Enables or disables reporting of file handles usage in percentages, e.g.
2294 percent of file handles used. Defaults to B<false>.
2298 =head2 Plugin C<filecount>
2300 The C<filecount> plugin counts the number of files in a certain directory (and
2301 its subdirectories) and their combined size. The configuration is very straight
2304 <Plugin "filecount">
2305 <Directory "/var/qmail/queue/mess">
2306 Instance "qmail-message"
2308 <Directory "/var/qmail/queue/todo">
2309 Instance "qmail-todo"
2311 <Directory "/var/lib/php5">
2312 Instance "php5-sessions"
2317 The example above counts the number of files in QMail's queue directories and
2318 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2319 QMail has not yet looked at, the "message" queue holds the messages that were
2320 classified into "local" and "remote".
2322 As you can see, the configuration consists of one or more C<Directory> blocks,
2323 each of which specifies a directory in which to count the files. Within those
2324 blocks, the following options are recognized:
2328 =item B<Instance> I<Instance>
2330 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2331 it's your responsibility, the plugin doesn't check for that. If not given, the
2332 instance is set to the directory name with all slashes replaced by underscores
2333 and all leading underscores removed.
2335 =item B<Name> I<Pattern>
2337 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2338 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2339 against the pattern, not the entire path. In case this makes it easier for you:
2340 This option has been named after the B<-name> parameter to L<find(1)>.
2342 =item B<MTime> I<Age>
2344 Count only files of a specific age: If I<Age> is greater than zero, only files
2345 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2346 a negative number, this is inversed. For example, if B<-60> is specified, only
2347 files that have been modified in the last minute will be counted.
2349 The number can also be followed by a "multiplier" to easily specify a larger
2350 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2351 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2352 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2353 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2354 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2357 =item B<Size> I<Size>
2359 Count only files of a specific size. When I<Size> is a positive number, only
2360 files that are at least this big are counted. If I<Size> is a negative number,
2361 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2362 I<Size> are counted.
2364 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2365 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2366 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2367 note that there are 1000 bytes in a kilobyte, not 1024.
2369 =item B<Recursive> I<true>|I<false>
2371 Controls whether or not to recurse into subdirectories. Enabled by default.
2373 =item B<IncludeHidden> I<true>|I<false>
2375 Controls whether or not to include "hidden" files and directories in the count.
2376 "Hidden" files and directories are those, whose name begins with a dot.
2377 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2381 =head2 Plugin C<GenericJMX>
2383 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2384 L<collectd-java(5)>.
2386 =head2 Plugin C<gmond>
2388 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2389 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2390 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2395 MCReceiveFrom "239.2.11.71" "8649"
2396 <Metric "swap_total">
2398 TypeInstance "total"
2401 <Metric "swap_free">
2408 The following metrics are built-in:
2414 load_one, load_five, load_fifteen
2418 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2422 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2434 Available configuration options:
2438 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2440 Sets sets the multicast group and UDP port to which to subscribe.
2442 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2444 =item E<lt>B<Metric> I<Name>E<gt>
2446 These blocks add a new metric conversion to the internal table. I<Name>, the
2447 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2451 =item B<Type> I<Type>
2453 Type to map this metric to. Required.
2455 =item B<TypeInstance> I<Instance>
2457 Type-instance to use. Optional.
2459 =item B<DataSource> I<Name>
2461 Data source to map this metric to. If the configured type has exactly one data
2462 source, this is optional. Otherwise the option is required.
2468 =head2 Plugin C<hddtemp>
2470 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2471 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2472 default values, see below. C<hddtemp> has to be running to work correctly. If
2473 C<hddtemp> is not running timeouts may appear which may interfere with other
2476 The B<hddtemp> homepage can be found at
2477 L<http://www.guzu.net/linux/hddtemp.php>.
2481 =item B<Host> I<Hostname>
2483 Hostname to connect to. Defaults to B<127.0.0.1>.
2485 =item B<Port> I<Port>
2487 TCP-Port to connect to. Defaults to B<7634>.
2491 =head2 Plugin C<interface>
2495 =item B<Interface> I<Interface>
2497 Select this interface. By default these interfaces will then be collected. For
2498 a more detailed description see B<IgnoreSelected> below.
2500 =item B<IgnoreSelected> I<true>|I<false>
2502 If no configuration if given, the B<traffic>-plugin will collect data from
2503 all interfaces. This may not be practical, especially for loopback- and
2504 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2505 interfaces you're interested in. Sometimes, however, it's easier/preferred
2506 to collect all interfaces I<except> a few ones. This option enables you to
2507 do that: By setting B<IgnoreSelected> to I<true> the effect of
2508 B<Interface> is inverted: All selected interfaces are ignored and all
2509 other interfaces are collected.
2513 =head2 Plugin C<ipmi>
2517 =item B<Sensor> I<Sensor>
2519 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2521 =item B<IgnoreSelected> I<true>|I<false>
2523 If no configuration if given, the B<ipmi> plugin will collect data from all
2524 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2525 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2526 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2527 all other sensors are collected.
2529 =item B<NotifySensorAdd> I<true>|I<false>
2531 If a sensor appears after initialization time of a minute a notification
2534 =item B<NotifySensorRemove> I<true>|I<false>
2536 If a sensor disappears a notification is sent.
2538 =item B<NotifySensorNotPresent> I<true>|I<false>
2540 If you have for example dual power supply and one of them is (un)plugged then
2541 a notification is sent.
2545 =head2 Plugin C<iptables>
2549 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2551 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2552 will collect the counters of all rules which have a comment-match. The comment
2553 is then used as type-instance.
2555 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2556 the I<n>th rule will be collected. Again, the comment (or the number) will be
2557 used as the type-instance.
2559 If I<Name> is supplied, it will be used as the type-instance instead of the
2560 comment or the number.
2564 =head2 Plugin C<irq>
2570 Select this irq. By default these irqs will then be collected. For a more
2571 detailed description see B<IgnoreSelected> below.
2573 =item B<IgnoreSelected> I<true>|I<false>
2575 If no configuration if given, the B<irq>-plugin will collect data from all
2576 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2577 can use the B<Irq>-option to pick the interrupt you're interested in.
2578 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2579 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2580 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2581 and all other interrupts are collected.
2585 =head2 Plugin C<java>
2587 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2588 This section only discusses the syntax and semantic of the configuration
2589 options. For more in-depth information on the I<Java> plugin, please read
2590 L<collectd-java(5)>.
2595 JVMArg "-verbose:jni"
2596 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2597 LoadPlugin "org.collectd.java.Foobar"
2598 <Plugin "org.collectd.java.Foobar">
2599 # To be parsed by the plugin
2603 Available configuration options:
2607 =item B<JVMArg> I<Argument>
2609 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2610 exactly the way the arguments to the I<java> binary on the command line work.
2611 Execute C<javaE<nbsp>--help> for details.
2613 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2614 any other options! When another option is found, the JVM will be started and
2615 later options will have to be ignored!
2617 =item B<LoadPlugin> I<JavaClass>
2619 Instantiates a new I<JavaClass> object. The constructor of this object very
2620 likely then registers one or more callback methods with the server.
2622 See L<collectd-java(5)> for details.
2624 When the first such option is found, the virtual machine (JVM) is created. This
2625 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2626 B<LoadPlugin> options!
2628 =item B<Plugin> I<Name>
2630 The entire block is passed to the Java plugin as an
2631 I<org.collectd.api.OConfigItem> object.
2633 For this to work, the plugin has to register a configuration callback first,
2634 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2635 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2636 depends on the (Java) plugin registering the callback and is completely
2637 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2641 =head2 Plugin C<load>
2643 The I<Load plugin> collects the system load. These numbers give a rough overview
2644 over the utilization of a machine. The system load is defined as the number of
2645 runnable tasks in the run-queue and is provided by many operating systems as a
2646 one, five or fifteen minute average.
2648 The following configuration options are available:
2652 =item B<ReportRelative> B<false>|B<true>
2654 When enabled, system load divided by number of available CPU cores is reported
2655 for intervals 1 min, 5 min and 15 min. Defaults to false.
2660 =head2 Plugin C<logfile>
2664 =item B<LogLevel> B<debug|info|notice|warning|err>
2666 Sets the log-level. If, for example, set to B<notice>, then all events with
2667 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2669 Please note that B<debug> is only available if collectd has been compiled with
2672 =item B<File> I<File>
2674 Sets the file to write log messages to. The special strings B<stdout> and
2675 B<stderr> can be used to write to the standard output and standard error
2676 channels, respectively. This, of course, only makes much sense when I<collectd>
2677 is running in foreground- or non-daemon-mode.
2679 =item B<Timestamp> B<true>|B<false>
2681 Prefix all lines printed by the current time. Defaults to B<true>.
2683 =item B<PrintSeverity> B<true>|B<false>
2685 When enabled, all lines are prefixed by the severity of the log message, for
2686 example "warning". Defaults to B<false>.
2690 B<Note>: There is no need to notify the daemon after moving or removing the
2691 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2692 for each line it writes.
2694 =head2 Plugin C<log_logstash>
2696 The I<log logstash plugin> behaves like the logfile plugin but formats
2697 messages as JSON events for logstash to parse and input.
2701 =item B<LogLevel> B<debug|info|notice|warning|err>
2703 Sets the log-level. If, for example, set to B<notice>, then all events with
2704 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2706 Please note that B<debug> is only available if collectd has been compiled with
2709 =item B<File> I<File>
2711 Sets the file to write log messages to. The special strings B<stdout> and
2712 B<stderr> can be used to write to the standard output and standard error
2713 channels, respectively. This, of course, only makes much sense when I<collectd>
2714 is running in foreground- or non-daemon-mode.
2718 B<Note>: There is no need to notify the daemon after moving or removing the
2719 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2720 for each line it writes.
2722 =head2 Plugin C<lpar>
2724 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2725 virtualization technique for IBM POWER processors. It takes into account CPU
2726 time stolen from or donated to a partition, in addition to the usual user,
2727 system, I/O statistics.
2729 The following configuration options are available:
2733 =item B<CpuPoolStats> B<false>|B<true>
2735 When enabled, statistics about the processor pool are read, too. The partition
2736 needs to have pool authority in order to be able to acquire this information.
2739 =item B<ReportBySerial> B<false>|B<true>
2741 If enabled, the serial of the physical machine the partition is currently
2742 running on is reported as I<hostname> and the logical hostname of the machine
2743 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2744 used (just like other plugins) and the I<plugin instance> will be empty.
2749 =head2 Plugin C<mbmon>
2751 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2753 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2754 B<Host> and B<Port> options can be used to change these values, see below.
2755 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2756 timeouts may appear which may interfere with other statistics..
2758 C<mbmon> must be run with the -r option ("print TAG and Value format");
2759 Debian's F</etc/init.d/mbmon> script already does this, other people
2760 will need to ensure that this is the case.
2764 =item B<Host> I<Hostname>
2766 Hostname to connect to. Defaults to B<127.0.0.1>.
2768 =item B<Port> I<Port>
2770 TCP-Port to connect to. Defaults to B<411>.
2776 The C<md plugin> collects information from Linux Software-RAID devices (md).
2778 All reported values are of the type C<md_disks>. Reported type instances are
2779 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2780 I<missing> (physically absent) disks.
2784 =item B<Device> I<Device>
2786 Select md devices based on device name. The I<device name> is the basename of
2787 the device, i.e. the name of the block device without the leading C</dev/>.
2788 See B<IgnoreSelected> for more details.
2790 =item B<IgnoreSelected> B<true>|B<false>
2792 Invert device selection: If set to B<true>, all md devices B<except> those
2793 listed using B<Device> are collected. If B<false> (the default), only those
2794 listed are collected. If no configuration is given, the B<md> plugin will
2795 collect data from all md devices.
2799 =head2 Plugin C<memcachec>
2801 The C<memcachec plugin> connects to a memcached server, queries one or more
2802 given I<pages> and parses the returned data according to user specification.
2803 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2806 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2807 library. Please note that there is another library with a very similar name,
2808 libmemcache (notice the missing `d'), which is not applicable.
2810 Synopsis of the configuration:
2812 <Plugin "memcachec">
2813 <Page "plugin_instance">
2817 Regex "(\\d+) bytes sent"
2820 Instance "type_instance"
2825 The configuration options are:
2829 =item E<lt>B<Page> I<Name>E<gt>
2831 Each B<Page> block defines one I<page> to be queried from the memcached server.
2832 The block requires one string argument which is used as I<plugin instance>.
2834 =item B<Server> I<Address>
2836 Sets the server address to connect to when querying the page. Must be inside a
2841 When connected to the memcached server, asks for the page I<Key>.
2843 =item E<lt>B<Match>E<gt>
2845 Match blocks define which strings to look for and how matches substrings are
2846 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2850 =head2 Plugin C<memcached>
2852 The B<memcached plugin> connects to a memcached server and queries statistics
2853 about cache utilization, memory and bandwidth used.
2854 L<http://www.danga.com/memcached/>
2856 <Plugin "memcached">
2858 Host "memcache.example.com"
2863 The plugin configuration consists of one or more B<Instance> blocks which
2864 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2865 following options are allowed:
2869 =item B<Host> I<Hostname>
2871 Hostname to connect to. Defaults to B<127.0.0.1>.
2873 =item B<Port> I<Port>
2875 TCP-Port to connect to. Defaults to B<11211>.
2877 =item B<Socket> I<Path>
2879 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2880 setting is given, the B<Host> and B<Port> settings are ignored.
2884 =head2 Plugin C<mic>
2886 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2887 Intel's Many Integrated Core (MIC) systems.
2896 ShowTemperatures true
2899 IgnoreSelectedTemperature true
2904 IgnoreSelectedPower true
2907 The following options are valid inside the B<PluginE<nbsp>mic> block:
2911 =item B<ShowCPU> B<true>|B<false>
2913 If enabled (the default) a sum of the CPU usage across all cores is reported.
2915 =item B<ShowCPUCores> B<true>|B<false>
2917 If enabled (the default) per-core CPU usage is reported.
2919 =item B<ShowMemory> B<true>|B<false>
2921 If enabled (the default) the physical memory usage of the MIC system is
2924 =item B<ShowTemperatures> B<true>|B<false>
2926 If enabled (the default) various temperatures of the MIC system are reported.
2928 =item B<Temperature> I<Name>
2930 This option controls which temperatures are being reported. Whether matching
2931 temperatures are being ignored or I<only> matching temperatures are reported
2932 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2933 temperatures are reported.
2935 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2937 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2938 (the default) only temperatures matching a B<Temperature> option are reported
2939 or, if no B<Temperature> option is specified, all temperatures are reported. If
2940 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2943 Known temperature names are:
2977 =item B<ShowPower> B<true>|B<false>
2979 If enabled (the default) various temperatures of the MIC system are reported.
2981 =item B<Power> I<Name>
2983 This option controls which power readings are being reported. Whether matching
2984 power readings are being ignored or I<only> matching power readings are reported
2985 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2986 power readings are reported.
2988 =item B<IgnoreSelectedPower> B<false>|B<true>
2990 Controls the behavior of the B<Power> setting above. If set to B<false>
2991 (the default) only power readings matching a B<Power> option are reported
2992 or, if no B<Power> option is specified, all power readings are reported. If
2993 set to B<true>, matching power readings are I<ignored> and all other power readings
2996 Known power names are:
3002 Total power utilization averaged over Time Window 0 (uWatts).
3006 Total power utilization averaged over Time Window 0 (uWatts).
3010 Instantaneous power (uWatts).
3014 Max instantaneous power (uWatts).
3018 PCI-E connector power (uWatts).
3022 2x3 connector power (uWatts).
3026 2x4 connector power (uWatts).
3034 Uncore rail (uVolts).
3038 Memory subsystem rail (uVolts).
3044 =head2 Plugin C<memory>
3046 The I<memory plugin> provides the following configuration options:
3050 =item B<ValuesAbsolute> B<true>|B<false>
3052 Enables or disables reporting of physical memory usage in absolute numbers,
3053 i.e. bytes. Defaults to B<true>.
3055 =item B<ValuesPercentage> B<false>|B<true>
3057 Enables or disables reporting of physical memory usage in percentages, e.g.
3058 percent of physical memory used. Defaults to B<false>.
3060 This is useful for deploying I<collectd> in a heterogeneous environment in
3061 which the sizes of physical memory vary.
3065 =head2 Plugin C<modbus>
3067 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3068 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3069 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3070 values (two registers interpreted as IEEE floats in big endian notation).
3074 <Data "voltage-input-1">
3077 RegisterCmd ReadHolding
3082 <Data "voltage-input-2">
3085 RegisterCmd ReadHolding
3090 <Data "supply-temperature-1">
3093 RegisterCmd ReadHolding
3098 <Host "modbus.example.com">
3099 Address "192.168.0.42"
3104 Instance "power-supply"
3105 Collect "voltage-input-1"
3106 Collect "voltage-input-2"
3111 Device "/dev/ttyUSB0"
3116 Instance "temperature"
3117 Collect "supply-temperature-1"
3123 =item E<lt>B<Data> I<Name>E<gt> blocks
3125 Data blocks define a mapping between register numbers and the "types" used by
3128 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
3132 =item B<RegisterBase> I<Number>
3134 Configures the base register to read from the device. If the option
3135 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
3136 register will be read (the register number is increased by one).
3138 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
3140 Specifies what kind of data is returned by the device. If the type is B<Int32>,
3141 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
3142 combined into one value. Defaults to B<Uint16>.
3144 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
3146 Specifies register type to be collected from device. Works only with libmodbus
3147 2.9.2 or higher. Defaults to B<ReadHolding>.
3149 =item B<Type> I<Type>
3151 Specifies the "type" (data set) to use when dispatching the value to
3152 I<collectd>. Currently, only data sets with exactly one data source are
3155 =item B<Instance> I<Instance>
3157 Sets the type instance to use when dispatching the value to I<collectd>. If
3158 unset, an empty string (no type instance) is used.
3162 =item E<lt>B<Host> I<Name>E<gt> blocks
3164 Host blocks are used to specify to which hosts to connect and what data to read
3165 from their "slaves". The string argument I<Name> is used as hostname when
3166 dispatching the values to I<collectd>.
3168 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
3172 =item B<Address> I<Hostname>
3174 For Modbus/TCP, specifies the node name (the actual network address) used to
3175 connect to the host. This may be an IP address or a hostname. Please note that
3176 the used I<libmodbus> library only supports IPv4 at the moment.
3178 =item B<Port> I<Service>
3180 for Modbus/TCP, specifies the port used to connect to the host. The port can
3181 either be given as a number or as a service name. Please note that the
3182 I<Service> argument must be a string, even if ports are given in their numerical
3183 form. Defaults to "502".
3185 =item B<Device> I<Devicenode>
3187 For Modbus/RTU, specifies the path to the serial device being used.
3189 =item B<Baudrate> I<Baudrate>
3191 For Modbus/RTU, specifies the baud rate of the serial device.
3192 Note, connections currently support only 8/N/1.
3194 =item B<Interval> I<Interval>
3196 Sets the interval (in seconds) in which the values will be collected from this
3197 host. By default the global B<Interval> setting will be used.
3199 =item E<lt>B<Slave> I<ID>E<gt>
3201 Over each connection, multiple Modbus devices may be reached. The slave ID
3202 is used to specify which device should be addressed. For each device you want
3203 to query, one B<Slave> block must be given.
3205 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
3209 =item B<Instance> I<Instance>
3211 Specify the plugin instance to use when dispatching the values to I<collectd>.
3212 By default "slave_I<ID>" is used.
3214 =item B<Collect> I<DataName>
3216 Specifies which data to retrieve from the device. I<DataName> must be the same
3217 string as the I<Name> argument passed to a B<Data> block. You can specify this
3218 option multiple times to collect more than one value from a slave. At least one
3219 B<Collect> option is mandatory.
3227 =head2 Plugin C<mysql>
3229 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3230 one or more databases when started and keeps the connection up as long as
3231 possible. When the connection is interrupted for whatever reason it will try
3232 to re-connect. The plugin will complain loudly in case anything goes wrong.
3234 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3235 and collects information about MySQL network traffic, executed statements,
3236 requests, the query cache and threads by evaluating the
3237 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3238 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3239 Status Variables> for an explanation of these values.
3241 Optionally, master and slave statistics may be collected in a MySQL
3242 replication setup. In that case, information about the synchronization state
3243 of the nodes are collected by evaluating the C<Position> return value of the
3244 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3245 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3246 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3247 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3248 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3265 Socket "/var/run/mysql/mysqld.sock"
3267 SlaveNotifications true
3271 A B<Database> block defines one connection to a MySQL database. It accepts a
3272 single argument which specifies the name of the database. None of the other
3273 options are required. MySQL will use default values as documented in the
3274 section "mysql_real_connect()" in the B<MySQL reference manual>.
3278 =item B<Alias> I<Alias>
3280 Alias to use as sender instead of hostname when reporting. This may be useful
3281 when having cryptic hostnames.
3283 =item B<Host> I<Hostname>
3285 Hostname of the database server. Defaults to B<localhost>.
3287 =item B<User> I<Username>
3289 Username to use when connecting to the database. The user does not have to be
3290 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3291 unless you want to collectd replication statistics (see B<MasterStats> and
3292 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3293 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3295 =item B<Password> I<Password>
3297 Password needed to log into the database.
3299 =item B<Database> I<Database>
3301 Select this database. Defaults to I<no database> which is a perfectly reasonable
3302 option for what this plugin does.
3304 =item B<Port> I<Port>
3306 TCP-port to connect to. The port must be specified in its numeric form, but it
3307 must be passed as a string nonetheless. For example:
3311 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3312 See the documentation for the C<mysql_real_connect> function for details.
3314 =item B<Socket> I<Socket>
3316 Specifies the path to the UNIX domain socket of the MySQL server. This option
3317 only has any effect, if B<Host> is set to B<localhost> (the default).
3318 Otherwise, use the B<Port> option above. See the documentation for the
3319 C<mysql_real_connect> function for details.
3321 =item B<InnodbStats> I<true|false>
3323 If enabled, metrics about the InnoDB storage engine are collected.
3324 Disabled by default.
3326 =item B<MasterStats> I<true|false>
3328 =item B<SlaveStats> I<true|false>
3330 Enable the collection of master / slave statistics in a replication setup. In
3331 order to be able to get access to these statistics, the user needs special
3332 privileges. See the B<User> documentation above. Defaults to B<false>.
3334 =item B<SlaveNotifications> I<true|false>
3336 If enabled, the plugin sends a notification if the replication slave I/O and /
3337 or SQL threads are not running. Defaults to B<false>.
3339 =item B<ConnectTimeout> I<Seconds>
3341 Sets the connect timeout for the MySQL client.
3345 =head2 Plugin C<netapp>
3347 The netapp plugin can collect various performance and capacity information
3348 from a NetApp filer using the NetApp API.
3350 Please note that NetApp has a wide line of products and a lot of different
3351 software versions for each of these products. This plugin was developed for a
3352 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3353 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3354 model and software version but it is very hard to test this.
3355 If you have used this plugin with other models and/or software version, feel
3356 free to send us a mail to tell us about the results, even if it's just a short
3359 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3360 basic authentication.
3362 B<Do not use a regular user for this!> Create a special collectd user with just
3363 the minimum of capabilities needed. The user only needs the "login-http-admin"
3364 capability as well as a few more depending on which data will be collected.
3365 Required capabilities are documented below.
3370 <Host "netapp1.example.com">
3394 IgnoreSelectedIO false
3396 IgnoreSelectedOps false
3397 GetLatency "volume0"
3398 IgnoreSelectedLatency false
3405 IgnoreSelectedCapacity false
3408 IgnoreSelectedSnapshot false
3436 The netapp plugin accepts the following configuration options:
3440 =item B<Host> I<Name>
3442 A host block defines one NetApp filer. It will appear in collectd with the name
3443 you specify here which does not have to be its real name nor its hostname (see
3444 the B<Address> option below).
3446 =item B<VFiler> I<Name>
3448 A B<VFiler> block may only be used inside a host block. It accepts all the
3449 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3450 will execute all NetApp API commands in the context of the specified
3451 VFiler(R). It will appear in collectd with the name you specify here which
3452 does not have to be its real name. The VFiler name may be specified using the
3453 B<VFilerName> option. If this is not specified, it will default to the name
3456 The VFiler block inherits all connection related settings from the surrounding
3457 B<Host> block (which appear before the B<VFiler> block) but they may be
3458 overwritten inside the B<VFiler> block.
3460 This feature is useful, for example, when using a VFiler as SnapVault target
3461 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3462 available in the host filer (vfiler0) but only in the respective VFiler
3465 =item B<Protocol> B<httpd>|B<http>
3467 The protocol collectd will use to query this host.
3475 Valid options: http, https
3477 =item B<Address> I<Address>
3479 The hostname or IP address of the host.
3485 Default: The "host" block's name.
3487 =item B<Port> I<Port>
3489 The TCP port to connect to on the host.
3495 Default: 80 for protocol "http", 443 for protocol "https"
3497 =item B<User> I<User>
3499 =item B<Password> I<Password>
3501 The username and password to use to login to the NetApp.
3507 =item B<VFilerName> I<Name>
3509 The name of the VFiler in which context to execute API commands. If not
3510 specified, the name provided to the B<VFiler> block will be used instead.
3516 Default: name of the B<VFiler> block
3518 B<Note:> This option may only be used inside B<VFiler> blocks.
3520 =item B<Interval> I<Interval>
3526 The following options decide what kind of data will be collected. You can
3527 either use them as a block and fine tune various parameters inside this block,
3528 use them as a single statement to just accept all default values, or omit it to
3529 not collect any data.
3531 The following options are valid inside all blocks:
3535 =item B<Interval> I<Seconds>
3537 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3538 host specific setting.
3542 =head3 The System block
3544 This will collect various performance data about the whole system.
3546 B<Note:> To get this data the collectd user needs the
3547 "api-perf-object-get-instances" capability.
3551 =item B<Interval> I<Seconds>
3553 Collect disk statistics every I<Seconds> seconds.
3555 =item B<GetCPULoad> B<true>|B<false>
3557 If you set this option to true the current CPU usage will be read. This will be
3558 the average usage between all CPUs in your NetApp without any information about
3561 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3562 returns in the "CPU" field.
3570 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3572 =item B<GetInterfaces> B<true>|B<false>
3574 If you set this option to true the current traffic of the network interfaces
3575 will be read. This will be the total traffic over all interfaces of your NetApp
3576 without any information about individual interfaces.
3578 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3579 in the "Net kB/s" field.
3589 Result: One value list of type "if_octects".
3591 =item B<GetDiskIO> B<true>|B<false>
3593 If you set this option to true the current IO throughput will be read. This
3594 will be the total IO of your NetApp without any information about individual
3595 disks, volumes or aggregates.
3597 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3598 in the "DiskE<nbsp>kB/s" field.
3606 Result: One value list of type "disk_octets".
3608 =item B<GetDiskOps> B<true>|B<false>
3610 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3611 iSCSI, etc. operations will be read. This will be the total number of
3612 operations on your NetApp without any information about individual volumes or
3615 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3616 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3624 Result: A variable number of value lists of type "disk_ops_complex". Each type
3625 of operation will result in one value list with the name of the operation as
3630 =head3 The WAFL block
3632 This will collect various performance data about the WAFL file system. At the
3633 moment this just means cache performance.
3635 B<Note:> To get this data the collectd user needs the
3636 "api-perf-object-get-instances" capability.
3638 B<Note:> The interface to get these values is classified as "Diagnostics" by
3639 NetApp. This means that it is not guaranteed to be stable even between minor
3644 =item B<Interval> I<Seconds>
3646 Collect disk statistics every I<Seconds> seconds.
3648 =item B<GetNameCache> B<true>|B<false>
3656 Result: One value list of type "cache_ratio" and type instance
3659 =item B<GetDirCache> B<true>|B<false>
3667 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3669 =item B<GetInodeCache> B<true>|B<false>
3677 Result: One value list of type "cache_ratio" and type instance
3680 =item B<GetBufferCache> B<true>|B<false>
3682 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3683 in the "Cache hit" field.
3691 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3695 =head3 The Disks block
3697 This will collect performance data about the individual disks in the NetApp.
3699 B<Note:> To get this data the collectd user needs the
3700 "api-perf-object-get-instances" capability.
3704 =item B<Interval> I<Seconds>
3706 Collect disk statistics every I<Seconds> seconds.
3708 =item B<GetBusy> B<true>|B<false>
3710 If you set this option to true the busy time of all disks will be calculated
3711 and the value of the busiest disk in the system will be written.
3713 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3714 in the "Disk util" field. Probably.
3722 Result: One value list of type "percent" and type instance "disk_busy".
3726 =head3 The VolumePerf block
3728 This will collect various performance data about the individual volumes.
3730 You can select which data to collect about which volume using the following
3731 options. They follow the standard ignorelist semantic.
3733 B<Note:> To get this data the collectd user needs the
3734 I<api-perf-object-get-instances> capability.
3738 =item B<Interval> I<Seconds>
3740 Collect volume performance data every I<Seconds> seconds.
3742 =item B<GetIO> I<Volume>
3744 =item B<GetOps> I<Volume>
3746 =item B<GetLatency> I<Volume>
3748 Select the given volume for IO, operations or latency statistics collection.
3749 The argument is the name of the volume without the C</vol/> prefix.
3751 Since the standard ignorelist functionality is used here, you can use a string
3752 starting and ending with a slash to specify regular expression matching: To
3753 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3756 GetIO "/^vol[027]$/"
3758 If no regular expression is specified, an exact match is required. Both,
3759 regular and exact matching are case sensitive.
3761 If no volume was specified at all for either of the three options, that data
3762 will be collected for all available volumes.
3764 =item B<IgnoreSelectedIO> B<true>|B<false>
3766 =item B<IgnoreSelectedOps> B<true>|B<false>
3768 =item B<IgnoreSelectedLatency> B<true>|B<false>
3770 When set to B<true>, the volumes selected for IO, operations or latency
3771 statistics collection will be ignored and the data will be collected for all
3774 When set to B<false>, data will only be collected for the specified volumes and
3775 all other volumes will be ignored.
3777 If no volumes have been specified with the above B<Get*> options, all volumes
3778 will be collected regardless of the B<IgnoreSelected*> option.
3780 Defaults to B<false>
3784 =head3 The VolumeUsage block
3786 This will collect capacity data about the individual volumes.
3788 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3793 =item B<Interval> I<Seconds>
3795 Collect volume usage statistics every I<Seconds> seconds.
3797 =item B<GetCapacity> I<VolumeName>
3799 The current capacity of the volume will be collected. This will result in two
3800 to four value lists, depending on the configuration of the volume. All data
3801 sources are of type "df_complex" with the name of the volume as
3804 There will be type_instances "used" and "free" for the number of used and
3805 available bytes on the volume. If the volume has some space reserved for
3806 snapshots, a type_instance "snap_reserved" will be available. If the volume
3807 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3808 number of bytes saved by the SIS feature.
3810 B<Note:> The current NetApp API has a bug that results in this value being
3811 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3812 number which works most of the time. If you see strange values here, bug
3813 NetApp support to fix this.
3815 Repeat this option to specify multiple volumes.
3817 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3819 Specify whether to collect only the volumes selected by the B<GetCapacity>
3820 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3821 B<false>. However, if no B<GetCapacity> option is specified at all, all
3822 capacities will be selected anyway.
3824 =item B<GetSnapshot> I<VolumeName>
3826 Select volumes from which to collect snapshot information.
3828 Usually, the space used for snapshots is included in the space reported as
3829 "used". If snapshot information is collected as well, the space used for
3830 snapshots is subtracted from the used space.
3832 To make things even more interesting, it is possible to reserve space to be
3833 used for snapshots. If the space required for snapshots is less than that
3834 reserved space, there is "reserved free" and "reserved used" space in addition
3835 to "free" and "used". If the space required for snapshots exceeds the reserved
3836 space, that part allocated in the normal space is subtracted from the "used"
3839 Repeat this option to specify multiple volumes.
3841 =item B<IgnoreSelectedSnapshot>
3843 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3844 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3845 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3846 capacities will be selected anyway.
3850 =head3 The Quota block
3852 This will collect (tree) quota statistics (used disk space and number of used
3853 files). This mechanism is useful to get usage information for single qtrees.
3854 In case the quotas are not used for any other purpose, an entry similar to the
3855 following in C</etc/quotas> would be sufficient:
3857 /vol/volA/some_qtree tree - - - - -
3859 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3863 =item B<Interval> I<Seconds>
3865 Collect SnapVault(R) statistics every I<Seconds> seconds.
3869 =head3 The SnapVault block
3871 This will collect statistics about the time and traffic of SnapVault(R)
3876 =item B<Interval> I<Seconds>
3878 Collect SnapVault(R) statistics every I<Seconds> seconds.
3882 =head2 Plugin C<netcmd>
3884 The C<netcmd> plugin provides a management interface for I<collectd> much like
3885 the C<unixsock> plugin. Please see L<collectd-unixsock(5)> for a description of
3886 the commands understood on the socket.
3888 Optionally, network traffic is encrypted and authenticated using I<Transport
3889 Layer Security> (TLS). To use TLS you have to specify the B<TLSCertFile> and
3890 B<TLSKeyFile> options.
3892 The configuration of the C<netcmd> plugin consists of one or more B<Listen>
3893 block, each defining a socket to bind to and listen on. Example:
3899 TLSCertFile "/path/to/cert"
3900 TLSKeyFile "/path/to/key"
3901 TLSCAFile "/path/to/ca"
3902 TLSCRLFile "/path/to/crl"
3907 Valid options inside a B<Listen> block are:
3911 =item B<Address> I<Address>|I<Hostname>
3913 Address or hostname to bind to. If not specified, bind to the I<any> address.
3915 =item B<Port> I<Port>|I<Service>
3917 Port number or service name to bind to. Defaults to C<"25826">.
3919 =item B<TLSCertFile> I<Path>
3921 Path to the TLS certificate file.
3922 If this option is unset, TLS will not be enabled.
3924 =item B<TLSKeyFile> I<Path>
3926 Path to the TLS key file.
3927 If this option is unset, TLS will not be enabled.
3929 =item B<TLSCAFile> I<Path>
3931 Path to the TLS I<Certificate Authority> (CA) file.
3933 =item B<TLSCRLFile> I<Path>
3935 Path to the TLS I<Certificate Revokation List> (CRL) file.
3937 =item B<TLSVerifyPeer> B<true>|B<false>
3939 Controls whether or not to verify the client certificate of connecting peers.
3940 The plugin will I<request> a client certificate either way, but it will only
3941 I<require> a valid certificate when this option is set to B<true>. Defaults to
3944 If set to B<true>, the options B<TLSCertFile>, B<TLSKeyFile> and B<TLSCAFile>
3947 =item B<TLSDHBits> I<Num>
3949 Sets the number of bits used for I<Diffie-Hellman> (DH) key generation. By
3950 default, the number of bits of the server's I<public key> is used, i.e. if
3951 you're using a certificate with a 4096E<nbsp>bit RSA key, then 4096E<nbsp>bit
3952 will be used for DH as well. Don't change this setting unless you know what
3957 =head2 Plugin C<netlink>
3959 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3960 statistics of various interface and routing aspects.
3964 =item B<Interface> I<Interface>
3966 =item B<VerboseInterface> I<Interface>
3968 Instruct the plugin to collect interface statistics. This is basically the same
3969 as the statistics provided by the C<interface> plugin (see above) but
3970 potentially much more detailed.
3972 When configuring with B<Interface> only the basic statistics will be collected,
3973 namely octets, packets, and errors. These statistics are collected by
3974 the C<interface> plugin, too, so using both at the same time is no benefit.
3976 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3977 so that no data needs to be collected twice if you use the C<interface> plugin.
3978 This includes dropped packets, received multicast packets, collisions and a
3979 whole zoo of differentiated RX and TX errors. You can try the following command
3980 to get an idea of what awaits you:
3984 If I<Interface> is B<All>, all interfaces will be selected.
3986 =item B<QDisc> I<Interface> [I<QDisc>]
3988 =item B<Class> I<Interface> [I<Class>]
3990 =item B<Filter> I<Interface> [I<Filter>]
3992 Collect the octets and packets that pass a certain qdisc, class or filter.
3994 QDiscs and classes are identified by their type and handle (or classid).
3995 Filters don't necessarily have a handle, therefore the parent's handle is used.
3996 The notation used in collectd differs from that used in tc(1) in that it
3997 doesn't skip the major or minor number if it's zero and doesn't print special
3998 ids by their name. So, for example, a qdisc may be identified by
3999 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4000 thus not displayed by tc(1).
4002 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4003 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4004 associated with that interface will be collected.
4006 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4007 used. This may lead to problems when more than one filter is attached to a
4008 qdisc or class. This isn't nice, but we don't know how this could be done any
4009 better. If you have a idea, please don't hesitate to tell us.
4011 As with the B<Interface> option you can specify B<All> as the interface,
4012 meaning all interfaces.
4014 Here are some examples to help you understand the above text more easily:
4017 VerboseInterface "All"
4018 QDisc "eth0" "pfifo_fast-1:0"
4020 Class "ppp0" "htb-1:10"
4021 Filter "ppp0" "u32-1:0"
4024 =item B<IgnoreSelected>
4026 The behavior is the same as with all other similar plugins: If nothing is
4027 selected at all, everything is collected. If some things are selected using the
4028 options described above, only these statistics are collected. If you set
4029 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
4030 specified statistics will not be collected.
4034 =head2 Plugin C<network>
4036 The Network plugin sends data to a remote instance of collectd, receives data
4037 from a remote instance, or both at the same time. Data which has been received
4038 from the network is usually not transmitted again, but this can be activated, see
4039 the B<Forward> option below.
4041 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
4042 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
4044 Both, B<Server> and B<Listen> can be used as single option or as block. When
4045 used as block, given options are valid for this socket only. The following
4046 example will export the metrics twice: Once to an "internal" server (without
4047 encryption and signing) and one to an external server (with cryptographic
4051 # Export to an internal server
4052 # (demonstrates usage without additional options)
4053 Server "collectd.internal.tld"
4055 # Export to an external server
4056 # (demonstrates usage with signature options)
4057 <Server "collectd.external.tld">
4058 SecurityLevel "sign"
4059 Username "myhostname"
4066 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
4068 The B<Server> statement/block sets the server to send datagrams to. The
4069 statement may occur multiple times to send each datagram to multiple
4072 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
4073 optional second argument specifies a port number or a service name. If not
4074 given, the default, B<25826>, is used.
4076 The following options are recognized within B<Server> blocks:
4080 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4082 Set the security you require for network communication. When the security level
4083 has been set to B<Encrypt>, data sent over the network will be encrypted using
4084 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
4085 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
4086 authentication code. When set to B<None>, data is sent without any security.
4088 This feature is only available if the I<network> plugin was linked with
4091 =item B<Username> I<Username>
4093 Sets the username to transmit. This is used by the server to lookup the
4094 password. See B<AuthFile> below. All security levels except B<None> require
4097 This feature is only available if the I<network> plugin was linked with
4100 =item B<Password> I<Password>
4102 Sets a password (shared secret) for this socket. All security levels except
4103 B<None> require this setting.
4105 This feature is only available if the I<network> plugin was linked with
4108 =item B<Interface> I<Interface name>
4110 Set the outgoing interface for IP packets. This applies at least
4111 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4112 undefined or a non-existent interface name is specified, the default
4113 behavior is to let the kernel choose the appropriate interface. Be warned
4114 that the manual selection of an interface for unicast traffic is only
4115 necessary in rare cases.
4117 =item B<ResolveInterval> I<Seconds>
4119 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
4120 useful to force a regular DNS lookup to support a high availability setup. If
4121 not specified, re-resolves are never attempted.
4125 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
4127 The B<Listen> statement sets the interfaces to bind to. When multiple
4128 statements are found the daemon will bind to multiple interfaces.
4130 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
4131 the argument is a multicast address the daemon will join that multicast group.
4132 The optional second argument specifies a port number or a service name. If not
4133 given, the default, B<25826>, is used.
4135 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
4139 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
4141 Set the security you require for network communication. When the security level
4142 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
4143 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
4144 signed and encrypted data is accepted. When set to B<None>, all data will be
4145 accepted. If an B<AuthFile> option was given (see below), encrypted data is
4146 decrypted if possible.
4148 This feature is only available if the I<network> plugin was linked with
4151 =item B<AuthFile> I<Filename>
4153 Sets a file in which usernames are mapped to passwords. These passwords are
4154 used to verify signatures and to decrypt encrypted network packets. If
4155 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
4156 verified and encrypted packets are decrypted. Otherwise, signed data is
4157 accepted without checking the signature and encrypted data cannot be decrypted.
4158 For the other security levels this option is mandatory.
4160 The file format is very simple: Each line consists of a username followed by a
4161 colon and any number of spaces followed by the password. To demonstrate, an
4162 example file could look like this:
4167 Each time a packet is received, the modification time of the file is checked
4168 using L<stat(2)>. If the file has been changed, the contents is re-read. While
4169 the file is being read, it is locked using L<fcntl(2)>.
4171 =item B<Interface> I<Interface name>
4173 Set the incoming interface for IP packets explicitly. This applies at least
4174 to IPv6 packets and if possible to IPv4. If this option is not applicable,
4175 undefined or a non-existent interface name is specified, the default
4176 behavior is, to let the kernel choose the appropriate interface. Thus incoming
4177 traffic gets only accepted, if it arrives on the given interface.
4181 =item B<TimeToLive> I<1-255>
4183 Set the time-to-live of sent packets. This applies to all, unicast and
4184 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
4185 That means that multicast packets will be sent with a TTL of C<1> (one) on most
4188 =item B<MaxPacketSize> I<1024-65535>
4190 Set the maximum size for datagrams received over the network. Packets larger
4191 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
4192 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
4195 On the server side, this limit should be set to the largest value used on
4196 I<any> client. Likewise, the value on the client must not be larger than the
4197 value on the server, or data will be lost.
4199 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
4200 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
4201 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
4204 =item B<Forward> I<true|false>
4206 If set to I<true>, write packets that were received via the network plugin to
4207 the sending sockets. This should only be activated when the B<Listen>- and
4208 B<Server>-statements differ. Otherwise packets may be send multiple times to
4209 the same multicast group. While this results in more network traffic than
4210 necessary it's not a huge problem since the plugin has a duplicate detection,
4211 so the values will not loop.
4213 =item B<ReportStats> B<true>|B<false>
4215 The network plugin cannot only receive and send statistics, it can also create
4216 statistics about itself. Collected data included the number of received and
4217 sent octets and packets, the length of the receive queue and the number of
4218 values handled. When set to B<true>, the I<Network plugin> will make these
4219 statistics available. Defaults to B<false>.
4223 =head2 Plugin C<nginx>
4225 This plugin collects the number of connections and requests handled by the
4226 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
4227 queries the page provided by the C<ngx_http_stub_status_module> module, which
4228 isn't compiled by default. Please refer to
4229 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
4230 how to compile and configure nginx and this module.
4232 The following options are accepted by the C<nginx plugin>:
4236 =item B<URL> I<http://host/nginx_status>
4238 Sets the URL of the C<ngx_http_stub_status_module> output.
4240 =item B<User> I<Username>
4242 Optional user name needed for authentication.
4244 =item B<Password> I<Password>
4246 Optional password needed for authentication.
4248 =item B<VerifyPeer> B<true|false>
4250 Enable or disable peer SSL certificate verification. See
4251 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
4253 =item B<VerifyHost> B<true|false>
4255 Enable or disable peer host name verification. If enabled, the plugin checks
4256 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4257 certificate matches the host name provided by the B<URL> option. If this
4258 identity check fails, the connection is aborted. Obviously, only works when
4259 connecting to a SSL enabled server. Enabled by default.
4261 =item B<CACert> I<File>
4263 File that holds one or more SSL certificates. If you want to use HTTPS you will
4264 possibly need this option. What CA certificates come bundled with C<libcurl>
4265 and are checked by default depends on the distribution you use.
4267 =item B<Timeout> I<Milliseconds>
4269 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
4270 milliseconds. By default, the configured B<Interval> is used to set the
4275 =head2 Plugin C<notify_desktop>
4277 This plugin sends a desktop notification to a notification daemon, as defined
4278 in the Desktop Notification Specification. To actually display the
4279 notifications, B<notification-daemon> is required and B<collectd> has to be
4280 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
4281 environment variables have to be set correctly) and the D-Bus message bus.
4283 The Desktop Notification Specification can be found at
4284 L<http://www.galago-project.org/specs/notification/>.
4288 =item B<OkayTimeout> I<timeout>
4290 =item B<WarningTimeout> I<timeout>
4292 =item B<FailureTimeout> I<timeout>
4294 Set the I<timeout>, in milliseconds, after which to expire the notification
4295 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
4296 been specified, the displayed notification will not be closed at all - the
4297 user has to do so herself. These options default to 5000. If a negative number
4298 has been specified, the default is used as well.
4302 =head2 Plugin C<notify_email>
4304 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
4305 configured email address.
4307 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4309 Available configuration options:
4313 =item B<From> I<Address>
4315 Email address from which the emails should appear to come from.
4317 Default: C<root@localhost>
4319 =item B<Recipient> I<Address>
4321 Configures the email address(es) to which the notifications should be mailed.
4322 May be repeated to send notifications to multiple addresses.
4324 At least one B<Recipient> must be present for the plugin to work correctly.
4326 =item B<SMTPServer> I<Hostname>
4328 Hostname of the SMTP server to connect to.
4330 Default: C<localhost>
4332 =item B<SMTPPort> I<Port>
4334 TCP port to connect to.
4338 =item B<SMTPUser> I<Username>
4340 Username for ASMTP authentication. Optional.
4342 =item B<SMTPPassword> I<Password>
4344 Password for ASMTP authentication. Optional.
4346 =item B<Subject> I<Subject>
4348 Subject-template to use when sending emails. There must be exactly two
4349 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4350 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4353 Default: C<Collectd notify: %s@%s>
4357 =head2 Plugin C<ntpd>
4361 =item B<Host> I<Hostname>
4363 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4365 =item B<Port> I<Port>
4367 UDP-Port to connect to. Defaults to B<123>.
4369 =item B<ReverseLookups> B<true>|B<false>
4371 Sets whether or not to perform reverse lookups on peers. Since the name or
4372 IP-address may be used in a filename it is recommended to disable reverse
4373 lookups. The default is to do reverse lookups to preserve backwards
4374 compatibility, though.
4376 =item B<IncludeUnitID> B<true>|B<false>
4378 When a peer is a refclock, include the unit ID in the I<type instance>.
4379 Defaults to B<false> for backward compatibility.
4381 If two refclock peers use the same driver and this is B<false>, the plugin will
4382 try to write simultaneous measurements from both to the same type instance.
4383 This will result in error messages in the log and only one set of measurements
4388 =head2 Plugin C<nut>
4392 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4394 Add a UPS to collect data from. The format is identical to the one accepted by
4399 =head2 Plugin C<olsrd>
4401 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4402 the Optimized Link State Routing daemon and reads information about the current
4403 state of the meshed network.
4405 The following configuration options are understood:
4409 =item B<Host> I<Host>
4411 Connect to I<Host>. Defaults to B<"localhost">.
4413 =item B<Port> I<Port>
4415 Specifies the port to connect to. This must be a string, even if you give the
4416 port as a number rather than a service name. Defaults to B<"2006">.
4418 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4420 Specifies what information to collect about links, i.E<nbsp>e. direct
4421 connections of the daemon queried. If set to B<No>, no information is
4422 collected. If set to B<Summary>, the number of links and the average of all
4423 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4424 If set to B<Detail> LQ and NLQ are collected per link.
4426 Defaults to B<Detail>.
4428 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4430 Specifies what information to collect about routes of the daemon queried. If
4431 set to B<No>, no information is collected. If set to B<Summary>, the number of
4432 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4433 metric and ETX are collected per route.
4435 Defaults to B<Summary>.
4437 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4439 Specifies what information to collect about the global topology. If set to
4440 B<No>, no information is collected. If set to B<Summary>, the number of links
4441 in the entire topology and the average I<link quality> (LQ) is calculated.
4442 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4444 Defaults to B<Summary>.
4448 =head2 Plugin C<onewire>
4450 B<EXPERIMENTAL!> See notes below.
4452 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4453 L<http://owfs.org/> to read sensors connected via the onewire bus.
4455 It can be used in two possible modes - standard or advanced.
4457 In the standard mode only temperature sensors (sensors with the family code
4458 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4459 other sensors you would like to have included, please send a sort request to
4460 the mailing list. You can select sensors to be read or to be ignored depending
4461 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4462 walked and all sensors are read.
4464 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4465 experimental, below.
4467 In the advanced mode you can configure any sensor to be read (only numerical
4468 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4469 In this mode you have to list all the sensors. Neither default bus walk nor
4470 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4471 the path automatically and should produce compatible structure with the "standard"
4472 mode (basically the path is expected as for example
4473 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4474 "F10FCA000800" and the rest after the slash is considered the type - here
4476 There are two advantages to this mode - you can access virtually any sensor
4477 (not just temperature), select whether to use cached or directly read values
4478 and it is slighlty faster. The downside is more complex configuration.
4480 The two modes are distinguished automatically by the format of the address.
4481 It is not possible to mix the two modes. Once a full path is detected in any
4482 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4483 (and as standard addresses will fail parsing they will be ignored).
4487 =item B<Device> I<Device>
4489 Sets the device to read the values from. This can either be a "real" hardware
4490 device, such as a serial port or an USB port, or the address of the
4491 L<owserver(1)> socket, usually B<localhost:4304>.
4493 Though the documentation claims to automatically recognize the given address
4494 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4495 with that version, the following configuration worked for us:
4498 Device "-s localhost:4304"
4501 This directive is B<required> and does not have a default value.
4503 =item B<Sensor> I<Sensor>
4505 In the standard mode selects sensors to collect or to ignore
4506 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4507 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4508 and B<not> include the leading C<10.> family byte and point.
4509 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4510 sensors (see above) are read.
4512 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4513 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4514 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4516 As there can be multiple devices on the bus you can list multiple sensor (use
4517 multiple B<Sensor> elements).
4519 =item B<IgnoreSelected> I<true>|I<false>
4521 If no configuration is given, the B<onewire> plugin will collect data from all
4522 sensors found. This may not be practical, especially if sensors are added and
4523 removed regularly. Sometimes, however, it's easier/preferred to collect only
4524 specific sensors or all sensors I<except> a few specified ones. This option
4525 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4526 B<Sensor> is inverted: All selected interfaces are ignored and all other
4527 interfaces are collected.
4529 Used only in the standard mode - see above.
4531 =item B<Interval> I<Seconds>
4533 Sets the interval in which all sensors should be read. If not specified, the
4534 global B<Interval> setting is used.
4538 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4539 work with big setups. It works with one sensor being attached to one
4540 controller, but as soon as you throw in a couple more senors and maybe a hub
4541 or two, reading all values will take more than ten seconds (the default
4542 interval). We will probably add some separate thread for reading the sensors
4543 and some cache or something like that, but it's not done yet. We will try to
4544 maintain backwards compatibility in the future, but we can't promise. So in
4545 short: If it works for you: Great! But keep in mind that the config I<might>
4546 change, though this is unlikely. Oh, and if you want to help improving this
4547 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4549 =head2 Plugin C<openldap>
4551 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
4552 server correctly. The backend database C<monitor> needs to be loaded and
4553 working. See slapd-monitor(5) for the details.
4555 The configuration of the C<openldap> plugin consists of one or more B<Instance>
4556 blocks. Each block requires one string argument as the instance name. For
4561 URL "ldap://localhost/"
4564 URL "ldaps://localhost/"
4568 The instance name will be used as the I<plugin instance>. To emulate the old
4569 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4570 plugin to work correctly, each instance name must be unique. This is not
4571 enforced by the plugin and it is your responsibility to ensure it is.
4573 The following options are accepted within each B<Instance> block:
4577 =item B<URL> I<ldap://host/binddn>
4579 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
4582 =item B<StartTLS> B<true|false>
4584 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
4585 Disabled by default.
4587 =item B<VerifyHost> B<true|false>
4589 Enables or disables peer host name verification. If enabled, the plugin checks
4590 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4591 certificate matches the host name provided by the B<URL> option. If this
4592 identity check fails, the connection is aborted. Enabled by default.
4594 =item B<CACert> I<File>
4596 File that holds one or more SSL certificates. If you want to use TLS/SSL you
4597 may possibly need this option. What CA certificates are checked by default
4598 depends on the distribution you use and can be changed with the usual ldap
4599 client configuration mechanisms. See ldap.conf(5) for the details.
4601 =item B<Timeout> I<Seconds>
4603 Sets the timeout value for ldap operations. Defaults to B<-1> which results in
4604 an infinite timeout.
4606 =item B<Version> I<Version>
4608 An integer which sets the LDAP protocol version number to use when connecting
4609 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
4613 =head2 Plugin C<openvpn>
4615 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4616 traffic statistics about connected clients.
4618 To set up OpenVPN to write to the status file periodically, use the
4619 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4620 you need to set the required format, too. This is done by setting
4621 B<--status-version> to B<2>.
4623 So, in a nutshell you need:
4625 openvpn $OTHER_OPTIONS \
4626 --status "/var/run/openvpn-status" 10 \
4633 =item B<StatusFile> I<File>
4635 Specifies the location of the status file.
4637 =item B<ImprovedNamingSchema> B<true>|B<false>
4639 When enabled, the filename of the status file will be used as plugin instance
4640 and the client's "common name" will be used as type instance. This is required
4641 when reading multiple status files. Enabling this option is recommended, but to
4642 maintain backwards compatibility this option is disabled by default.
4644 =item B<CollectCompression> B<true>|B<false>
4646 Sets whether or not statistics about the compression used by OpenVPN should be
4647 collected. This information is only available in I<single> mode. Enabled by
4650 =item B<CollectIndividualUsers> B<true>|B<false>
4652 Sets whether or not traffic information is collected for each connected client
4653 individually. If set to false, currently no traffic data is collected at all
4654 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4656 =item B<CollectUserCount> B<true>|B<false>
4658 When enabled, the number of currently connected clients or users is collected.
4659 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4660 can be configured independently from that option. Defaults to B<false>.
4664 =head2 Plugin C<oracle>
4666 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4667 Oracle® Database and lets you execute SQL statements there. It is very similar
4668 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4669 plugin's documentation above for details.
4672 <Query "out_of_stock">
4673 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4676 # InstancePrefix "foo"
4677 InstancesFrom "category"
4681 <Database "product_information">
4685 Query "out_of_stock"
4689 =head3 B<Query> blocks
4691 The Query blocks are handled identically to the Query blocks of the "dbi"
4692 plugin. Please see its documentation above for details on how to specify
4695 =head3 B<Database> blocks
4697 Database blocks define a connection to a database and which queries should be
4698 sent to that database. Each database needs a "name" as string argument in the
4699 starting tag of the block. This name will be used as "PluginInstance" in the
4700 values submitted to the daemon. Other than that, that name is not used.
4704 =item B<ConnectID> I<ID>
4706 Defines the "database alias" or "service name" to connect to. Usually, these
4707 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4709 =item B<Host> I<Host>
4711 Hostname to use when dispatching values for this database. Defaults to using
4712 the global hostname of the I<collectd> instance.
4714 =item B<Username> I<Username>
4716 Username used for authentication.
4718 =item B<Password> I<Password>
4720 Password used for authentication.
4722 =item B<Query> I<QueryName>
4724 Associates the query named I<QueryName> with this database connection. The
4725 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4726 blocks you want to refer to must be placed above the database block you want to
4731 =head2 Plugin C<perl>
4733 This plugin embeds a Perl-interpreter into collectd and provides an interface
4734 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4736 =head2 Plugin C<pinba>
4738 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4739 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4740 PHP-based webpage has been delivered, the extension will send a UDP packet
4741 containing timing information, peak memory usage and so on. The plugin will
4742 wait for such packets, parse them and account the provided information, which
4743 is then dispatched to the daemon once per interval.
4750 # Overall statistics for the website.
4752 Server "www.example.com"
4754 # Statistics for www-a only
4756 Host "www-a.example.com"
4757 Server "www.example.com"
4759 # Statistics for www-b only
4761 Host "www-b.example.com"
4762 Server "www.example.com"
4766 The plugin provides the following configuration options:
4770 =item B<Address> I<Node>
4772 Configures the address used to open a listening socket. By default, plugin will
4773 bind to the I<any> address C<::0>.
4775 =item B<Port> I<Service>
4777 Configures the port (service) to bind to. By default the default Pinba port
4778 "30002" will be used. The option accepts service names in addition to port
4779 numbers and thus requires a I<string> argument.
4781 =item E<lt>B<View> I<Name>E<gt> block
4783 The packets sent by the Pinba extension include the hostname of the server, the
4784 server name (the name of the virtual host) and the script that was executed.
4785 Using B<View> blocks it is possible to separate the data into multiple groups
4786 to get more meaningful statistics. Each packet is added to all matching groups,
4787 so that a packet may be accounted for more than once.
4791 =item B<Host> I<Host>
4793 Matches the hostname of the system the webserver / script is running on. This
4794 will contain the result of the L<gethostname(2)> system call. If not
4795 configured, all hostnames will be accepted.
4797 =item B<Server> I<Server>
4799 Matches the name of the I<virtual host>, i.e. the contents of the
4800 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4801 server names will be accepted.
4803 =item B<Script> I<Script>
4805 Matches the name of the I<script name>, i.e. the contents of the
4806 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4807 script names will be accepted.
4813 =head2 Plugin C<ping>
4815 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4816 configured hosts periodically and measures the network latency. Whenever the
4817 C<read> function of the plugin is called, it submits the average latency, the
4818 standard deviation and the drop rate for each host.
4820 Available configuration options:
4824 =item B<Host> I<IP-address>
4826 Host to ping periodically. This option may be repeated several times to ping
4829 =item B<Interval> I<Seconds>
4831 Sets the interval in which to send ICMP echo packets to the configured hosts.
4832 This is B<not> the interval in which statistics are queries from the plugin but
4833 the interval in which the hosts are "pinged". Therefore, the setting here
4834 should be smaller than or equal to the global B<Interval> setting. Fractional
4835 times, such as "1.24" are allowed.
4839 =item B<Timeout> I<Seconds>
4841 Time to wait for a response from the host to which an ICMP packet had been
4842 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4843 to be down or the packet to be dropped. This setting must be smaller than the
4844 B<Interval> setting above for the plugin to work correctly. Fractional
4845 arguments are accepted.
4849 =item B<TTL> I<0-255>
4851 Sets the Time-To-Live of generated ICMP packets.
4853 =item B<SourceAddress> I<host>
4855 Sets the source address to use. I<host> may either be a numerical network
4856 address or a network hostname.
4858 =item B<Device> I<name>
4860 Sets the outgoing network device to be used. I<name> has to specify an
4861 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4864 =item B<MaxMissed> I<Packets>
4866 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4867 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4869 Default: B<-1> (disabled)
4873 =head2 Plugin C<postgresql>
4875 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4876 keeps a persistent connection to all configured databases and tries to
4877 reconnect if the connection has been interrupted. A database is configured by
4878 specifying a B<Database> block as described below. The default statistics are
4879 collected from PostgreSQL's B<statistics collector> which thus has to be
4880 enabled for this plugin to work correctly. This should usually be the case by
4881 default. See the section "The Statistics Collector" of the B<PostgreSQL
4882 Documentation> for details.
4884 By specifying custom database queries using a B<Query> block as described
4885 below, you may collect any data that is available from some PostgreSQL
4886 database. This way, you are able to access statistics of external daemons
4887 which are available in a PostgreSQL database or use future or special
4888 statistics provided by PostgreSQL without the need to upgrade your collectd
4891 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4892 PostgreSQL databases as well. This has been implemented in a generic way. You
4893 need to specify an SQL statement which will then be executed by collectd in
4894 order to write the data (see below for details). The benefit of that approach
4895 is that there is no fixed database layout. Rather, the layout may be optimized
4896 for the current setup.
4898 The B<PostgreSQL Documentation> manual can be found at
4899 L<http://www.postgresql.org/docs/manuals/>.
4903 Statement "SELECT magic FROM wizard WHERE host = $1;"
4907 InstancePrefix "magic"
4912 <Query rt36_tickets>
4913 Statement "SELECT COUNT(type) AS count, type \
4915 WHEN resolved = 'epoch' THEN 'open' \
4916 ELSE 'resolved' END AS type \
4917 FROM tickets) type \
4921 InstancePrefix "rt36_tickets"
4922 InstancesFrom "type"
4928 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4938 KRBSrvName "kerberos_service_name"
4944 Service "service_name"
4945 Query backend # predefined
4956 The B<Query> block defines one database query which may later be used by a
4957 database definition. It accepts a single mandatory argument which specifies
4958 the name of the query. The names of all queries have to be unique (see the
4959 B<MinVersion> and B<MaxVersion> options below for an exception to this
4960 rule). The following configuration options are available to define the query:
4962 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4963 blocks define how to handle the values returned from the query. They define
4964 which column holds which value and how to dispatch that value to the daemon.
4965 Multiple B<Result> blocks may be used to extract multiple values from a single
4970 =item B<Statement> I<sql query statement>
4972 Specify the I<sql query statement> which the plugin should execute. The string
4973 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4974 first, second, etc. parameter. The value of the parameters is specified by the
4975 B<Param> configuration option - see below for details. To include a literal
4976 B<$> character followed by a number, surround it with single quotes (B<'>).
4978 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4979 allowed. Note, however, that only a single command may be used. Semicolons are
4980 allowed as long as a single non-empty command has been specified only.
4982 The returned lines will be handled separately one after another.
4984 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4986 Specify the parameters which should be passed to the SQL query. The parameters
4987 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4988 they appear in the configuration file. The value of the parameter is
4989 determined depending on the value of the B<Param> option as follows:
4995 The configured hostname of the database connection. If a UNIX domain socket is
4996 used, the parameter expands to "localhost".
5000 The name of the database of the current connection.
5004 The name of the database plugin instance. See the B<Instance> option of the
5005 database specification below for details.
5009 The username used to connect to the database.
5013 The interval with which this database is queried (as specified by the database
5014 specific or global B<Interval> options).
5018 Please note that parameters are only supported by PostgreSQL's protocol
5019 version 3 and above which was introduced in version 7.4 of PostgreSQL.
5021 =item B<Type> I<type>
5023 The I<type> name to be used when dispatching the values. The type describes
5024 how to handle the data and where to store it. See L<types.db(5)> for more
5025 details on types and their configuration. The number and type of values (as
5026 selected by the B<ValuesFrom> option) has to match the type of the given name.
5028 This option is required inside a B<Result> block.
5030 =item B<InstancePrefix> I<prefix>
5032 =item B<InstancesFrom> I<column0> [I<column1> ...]
5034 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
5035 B<InstancePrefix> defines a static prefix that will be prepended to all type
5036 instances. B<InstancesFrom> defines the column names whose values will be used
5037 to create the type instance. Multiple values will be joined together using the
5038 hyphen (C<->) as separation character.
5040 The plugin itself does not check whether or not all built instances are
5041 different. It is your responsibility to assure that each is unique.
5043 Both options are optional. If none is specified, the type instance will be
5046 =item B<ValuesFrom> I<column0> [I<column1> ...]
5048 Names the columns whose content is used as the actual data for the data sets
5049 that are dispatched to the daemon. How many such columns you need is
5050 determined by the B<Type> setting as explained above. If you specify too many
5051 or not enough columns, the plugin will complain about that and no data will be
5052 submitted to the daemon.
5054 The actual data type, as seen by PostgreSQL, is not that important as long as
5055 it represents numbers. The plugin will automatically cast the values to the
5056 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
5057 L<strtod(3)> functions, so anything supported by those functions is supported
5058 by the plugin as well.
5060 This option is required inside a B<Result> block and may be specified multiple
5061 times. If multiple B<ValuesFrom> options are specified, the columns are read
5064 =item B<MinVersion> I<version>
5066 =item B<MaxVersion> I<version>
5068 Specify the minimum or maximum version of PostgreSQL that this query should be
5069 used with. Some statistics might only be available with certain versions of
5070 PostgreSQL. This allows you to specify multiple queries with the same name but
5071 which apply to different versions, thus allowing you to use the same
5072 configuration in a heterogeneous environment.
5074 The I<version> has to be specified as the concatenation of the major, minor
5075 and patch-level versions, each represented as two-decimal-digit numbers. For
5076 example, version 8.2.3 will become 80203.
5080 The following predefined queries are available (the definitions can be found
5081 in the F<postgresql_default.conf> file which, by default, is available at
5082 C<I<prefix>/share/collectd/>):
5088 This query collects the number of backends, i.E<nbsp>e. the number of
5091 =item B<transactions>
5093 This query collects the numbers of committed and rolled-back transactions of
5098 This query collects the numbers of various table modifications (i.E<nbsp>e.
5099 insertions, updates, deletions) of the user tables.
5101 =item B<query_plans>
5103 This query collects the numbers of various table scans and returned tuples of
5106 =item B<table_states>
5108 This query collects the numbers of live and dead rows in the user tables.
5112 This query collects disk block access counts for user tables.
5116 This query collects the on-disk size of the database in bytes.
5120 In addition, the following detailed queries are available by default. Please
5121 note that each of those queries collects information B<by table>, thus,
5122 potentially producing B<a lot> of data. For details see the description of the
5123 non-by_table queries above.
5127 =item B<queries_by_table>
5129 =item B<query_plans_by_table>
5131 =item B<table_states_by_table>
5133 =item B<disk_io_by_table>
5137 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
5138 mandatory argument specifying the name of the writer. This will then be used
5139 in the B<Database> specification in order to activate the writer instance. The
5140 names of all writers have to be unique. The following options may be
5145 =item B<Statement> I<sql statement>
5147 This mandatory option specifies the SQL statement that will be executed for
5148 each submitted value. A single SQL statement is allowed only. Anything after
5149 the first semicolon will be ignored.
5151 Nine parameters will be passed to the statement and should be specified as
5152 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
5153 values are made available through those parameters:
5159 The timestamp of the queried value as a floating point number.
5163 The hostname of the queried value.
5167 The plugin name of the queried value.
5171 The plugin instance of the queried value. This value may be B<NULL> if there
5172 is no plugin instance.
5176 The type of the queried value (cf. L<types.db(5)>).
5180 The type instance of the queried value. This value may be B<NULL> if there is
5185 An array of names for the submitted values (i.E<nbsp>e., the name of the data
5186 sources of the submitted value-list).
5190 An array of types for the submitted values (i.E<nbsp>e., the type of the data
5191 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
5192 B<StoreRates> is enabled (which is the default, see below), all types will be
5197 An array of the submitted values. The dimensions of the value name and value
5202 In general, it is advisable to create and call a custom function in the
5203 PostgreSQL database for this purpose. Any procedural language supported by
5204 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
5207 =item B<StoreRates> B<false>|B<true>
5209 If set to B<true> (the default), convert counter values to rates. If set to
5210 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
5215 The B<Database> block defines one PostgreSQL database for which to collect
5216 statistics. It accepts a single mandatory argument which specifies the
5217 database name. None of the other options are required. PostgreSQL will use
5218 default values as documented in the section "CONNECTING TO A DATABASE" in the
5219 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
5220 the user collectd is run as and special environment variables. See the manpage
5225 =item B<Interval> I<seconds>
5227 Specify the interval with which the database should be queried. The default is
5228 to use the global B<Interval> setting.
5230 =item B<CommitInterval> I<seconds>
5232 This option may be used for database connections which have "writers" assigned
5233 (see above). If specified, it causes a writer to put several updates into a
5234 single transaction. This transaction will last for the specified amount of
5235 time. By default, each update will be executed in a separate transaction. Each
5236 transaction generates a fair amount of overhead which can, thus, be reduced by
5237 activating this option. The draw-back is, that data covering the specified
5238 amount of time will be lost, for example, if a single statement within the
5239 transaction fails or if the database server crashes.
5241 =item B<Instance> I<name>
5243 Specify the plugin instance name that should be used instead of the database
5244 name (which is the default, if this option has not been specified). This
5245 allows to query multiple databases of the same name on the same host (e.g.
5246 when running multiple database server versions in parallel).
5248 =item B<Host> I<hostname>
5250 Specify the hostname or IP of the PostgreSQL server to connect to. If the
5251 value begins with a slash, it is interpreted as the directory name in which to
5252 look for the UNIX domain socket.
5254 This option is also used to determine the hostname that is associated with a
5255 collected data set. If it has been omitted or either begins with with a slash
5256 or equals B<localhost> it will be replaced with the global hostname definition
5257 of collectd. Any other value will be passed literally to collectd when
5258 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
5260 =item B<Port> I<port>
5262 Specify the TCP port or the local UNIX domain socket file extension of the
5265 =item B<User> I<username>
5267 Specify the username to be used when connecting to the server.
5269 =item B<Password> I<password>
5271 Specify the password to be used when connecting to the server.
5273 =item B<ExpireDelay> I<delay>
5275 Skip expired values in query output.
5277 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
5279 Specify whether to use an SSL connection when contacting the server. The
5280 following modes are supported:
5286 Do not use SSL at all.
5290 First, try to connect without using SSL. If that fails, try using SSL.
5292 =item I<prefer> (default)
5294 First, try to connect using SSL. If that fails, try without using SSL.
5302 =item B<Instance> I<name>
5304 Specify the plugin instance name that should be used instead of the database
5305 name (which is the default, if this option has not been specified). This
5306 allows to query multiple databases of the same name on the same host (e.g.
5307 when running multiple database server versions in parallel).
5309 =item B<KRBSrvName> I<kerberos_service_name>
5311 Specify the Kerberos service name to use when authenticating with Kerberos 5
5312 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
5313 B<PostgreSQL Documentation> for details.
5315 =item B<Service> I<service_name>
5317 Specify the PostgreSQL service name to use for additional parameters. That
5318 service has to be defined in F<pg_service.conf> and holds additional
5319 connection parameters. See the section "The Connection Service File" in the
5320 B<PostgreSQL Documentation> for details.
5322 =item B<Query> I<query>
5324 Specifies a I<query> which should be executed in the context of the database
5325 connection. This may be any of the predefined or user-defined queries. If no
5326 such option is given, it defaults to "backends", "transactions", "queries",
5327 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
5328 has been specified). Else, the specified queries are used only.
5330 =item B<Writer> I<writer>
5332 Assigns the specified I<writer> backend to the database connection. This
5333 causes all collected data to be send to the database using the settings
5334 defined in the writer configuration (see the section "FILTER CONFIGURATION"
5335 below for details on how to selectively send data to certain plugins).
5337 Each writer will register a flush callback which may be used when having long
5338 transactions enabled (see the B<CommitInterval> option above). When issuing
5339 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
5340 transaction will be committed right away. Two different kinds of flush
5341 callbacks are available with the C<postgresql> plugin:
5347 Flush all writer backends.
5349 =item B<postgresql->I<database>
5351 Flush all writers of the specified I<database> only.
5357 =head2 Plugin C<powerdns>
5359 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5360 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5361 values, many of which are probably meaningless to most users, but may be useful
5362 for some. So you may chose which values to collect, but if you don't, some
5363 reasonable defaults will be collected.
5366 <Server "server_name">
5368 Collect "udp-answers" "udp-queries"
5369 Socket "/var/run/pdns.controlsocket"
5371 <Recursor "recursor_name">
5373 Collect "cache-hits" "cache-misses"
5374 Socket "/var/run/pdns_recursor.controlsocket"
5376 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5381 =item B<Server> and B<Recursor> block
5383 The B<Server> block defines one authoritative server to query, the B<Recursor>
5384 does the same for an recursing server. The possible options in both blocks are
5385 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5390 =item B<Collect> I<Field>
5392 Using the B<Collect> statement you can select which values to collect. Here,
5393 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5394 C<dlg-only-drops>, C<answers10-100>.
5396 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5397 When querying the server a C<SHOW *> command is issued in any case, because
5398 that's the only way of getting multiple values out of the server at once.
5399 collectd then picks out the values you have selected. When querying the
5400 recursor, a command is generated to query exactly these values. So if you
5401 specify invalid fields when querying the recursor, a syntax error may be
5402 returned by the daemon and collectd may not collect any values at all.
5404 If no B<Collect> statement is given, the following B<Server> values will be
5411 =item packetcache-hit
5413 =item packetcache-miss
5415 =item packetcache-size
5417 =item query-cache-hit
5419 =item query-cache-miss
5421 =item recursing-answers
5423 =item recursing-questions
5435 The following B<Recursor> values will be collected by default:
5439 =item noerror-answers
5441 =item nxdomain-answers
5443 =item servfail-answers
5461 Please note that up to that point collectd doesn't know what values are
5462 available on the server and values that are added do not need a change of the
5463 mechanism so far. However, the values must be mapped to collectd's naming
5464 scheme, which is done using a lookup table that lists all known values. If
5465 values are added in the future and collectd does not know about them, you will
5466 get an error much like this:
5468 powerdns plugin: submit: Not found in lookup table: foobar = 42
5470 In this case please file a bug report with the collectd team.
5472 =item B<Socket> I<Path>
5474 Configures the path to the UNIX domain socket to be used when connecting to the
5475 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5476 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5477 will be used for the recursor.
5481 =item B<LocalSocket> I<Path>
5483 Querying the recursor is done using UDP. When using UDP over UNIX domain
5484 sockets, the client socket needs a name in the file system, too. You can set
5485 this local name to I<Path> using the B<LocalSocket> option. The default is
5486 C<I<prefix>/var/run/collectd-powerdns>.
5490 =head2 Plugin C<processes>
5494 =item B<Process> I<Name>
5496 Select more detailed statistics of processes matching this name. The statistics
5497 collected for these selected processes are size of the resident segment size
5498 (RSS), user- and system-time used, number of processes and number of threads,
5499 io data (where available) and minor and major pagefaults.
5501 =item B<ProcessMatch> I<name> I<regex>
5503 Similar to the B<Process> option this allows to select more detailed
5504 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5505 details). The statistics of all matching processes are summed up and
5506 dispatched to the daemon using the specified I<name> as an identifier. This
5507 allows to "group" several processes together. I<name> must not contain
5510 =item B<CollectContextSwitch> I<Boolean>
5512 Collect context switch of the process.
5516 =head2 Plugin C<protocols>
5518 Collects a lot of information about various network protocols, such as I<IP>,
5519 I<TCP>, I<UDP>, etc.
5521 Available configuration options:
5525 =item B<Value> I<Selector>
5527 Selects whether or not to select a specific value. The string being matched is
5528 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5529 plugin instance and I<ValueName> will be used as type instance. An example of
5530 the string being used would be C<Tcp:RetransSegs>.
5532 You can use regular expressions to match a large number of values with just one
5533 configuration option. To select all "extended" I<TCP> values, you could use the
5534 following statement:
5538 Whether only matched values are selected or all matched values are ignored
5539 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5540 If no value is configured at all, all values will be selected.
5542 =item B<IgnoreSelected> B<true>|B<false>
5544 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5545 matching values will be ignored.
5549 =head2 Plugin C<python>
5551 This plugin embeds a Python-interpreter into collectd and provides an interface
5552 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5554 =head2 Plugin C<routeros>
5556 The C<routeros> plugin connects to a device running I<RouterOS>, the
5557 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5558 I<librouteros> to connect and reads information about the interfaces and
5559 wireless connections of the device. The configuration supports querying
5564 Host "router0.example.com"
5567 CollectInterface true
5572 Host "router1.example.com"
5575 CollectInterface true
5576 CollectRegistrationTable true
5582 As you can see above, the configuration of the I<routeros> plugin consists of
5583 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5584 options are understood:
5588 =item B<Host> I<Host>
5590 Hostname or IP-address of the router to connect to.
5592 =item B<Port> I<Port>
5594 Port name or port number used when connecting. If left unspecified, the default
5595 will be chosen by I<librouteros>, currently "8728". This option expects a
5596 string argument, even when a numeric port number is given.
5598 =item B<User> I<User>
5600 Use the user name I<User> to authenticate. Defaults to "admin".
5602 =item B<Password> I<Password>
5604 Set the password used to authenticate.
5606 =item B<CollectInterface> B<true>|B<false>
5608 When set to B<true>, interface statistics will be collected for all interfaces
5609 present on the device. Defaults to B<false>.
5611 =item B<CollectRegistrationTable> B<true>|B<false>
5613 When set to B<true>, information about wireless LAN connections will be
5614 collected. Defaults to B<false>.
5616 =item B<CollectCPULoad> B<true>|B<false>
5618 When set to B<true>, information about the CPU usage will be collected. The
5619 number is a dimensionless value where zero indicates no CPU usage at all.
5620 Defaults to B<false>.
5622 =item B<CollectMemory> B<true>|B<false>
5624 When enabled, the amount of used and free memory will be collected. How used
5625 memory is calculated is unknown, for example whether or not caches are counted
5627 Defaults to B<false>.
5629 =item B<CollectDF> B<true>|B<false>
5631 When enabled, the amount of used and free disk space will be collected.
5632 Defaults to B<false>.
5634 =item B<CollectDisk> B<true>|B<false>
5636 When enabled, the number of sectors written and bad blocks will be collected.
5637 Defaults to B<false>.
5641 =head2 Plugin C<redis>
5643 The I<Redis plugin> connects to one or more Redis servers and gathers
5644 information about each server's state. For each server there is a I<Node> block
5645 which configures the connection parameters for this node.
5652 <Query "LLEN myqueue">
5659 The information shown in the synopsis above is the I<default configuration>
5660 which is used by the plugin if no configuration is present.
5664 =item B<Node> I<Nodename>
5666 The B<Node> block identifies a new Redis node, that is a new Redis instance
5667 running in an specified host and port. The name for node is a canonical
5668 identifier which is used as I<plugin instance>. It is limited to
5669 64E<nbsp>characters in length.
5671 =item B<Host> I<Hostname>
5673 The B<Host> option is the hostname or IP-address where the Redis instance is
5676 =item B<Port> I<Port>
5678 The B<Port> option is the TCP port on which the Redis instance accepts
5679 connections. Either a service name of a port number may be given. Please note
5680 that numerical port numbers must be given as a string, too.
5682 =item B<Password> I<Password>
5684 Use I<Password> to authenticate when connecting to I<Redis>.
5686 =item B<Timeout> I<Milliseconds>
5688 The B<Timeout> option set the socket timeout for node response. Since the Redis
5689 read function is blocking, you should keep this value as low as possible. Keep
5690 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5691 than B<Interval> defined globally.
5693 =item B<Query> I<Querystring>
5695 The B<Query> block identifies a query to execute against the redis server.
5696 There may be an arbitrary number of queries to execute.
5698 =item B<Type> I<Collectd type>
5700 Within a query definition, a valid collectd type to use as when submitting
5701 the result of the query. When not supplied, will default to B<gauge>.
5703 =item B<Instance> I<Type instance>
5705 Within a query definition, an optional type instance to use when submitting
5706 the result of the query. When not supplied will default to the escaped
5707 command, up to 64 chars.
5711 =head2 Plugin C<rrdcached>
5713 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5714 to store values to RRD files in an efficient manner. The combination of the
5715 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5716 way the C<rrdtool> plugin works (see below). The added abstraction layer
5717 provides a number of benefits, though: Because the cache is not within
5718 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5719 restarted. This results in much shorter (if any) gaps in graphs, especially
5720 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5721 daemon so that it can flush values to disk automatically when needed. This
5722 allows to integrate automated flushing of values into graphing solutions much
5725 There are disadvantages, though: The daemon may reside on a different host, so
5726 it may not be possible for C<collectd> to create the appropriate RRD files
5727 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5728 different base directory, so relative paths may do weird stuff if you're not
5731 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5732 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5733 setting should be set to an absolute path, so that a changed base directory
5734 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5738 =item B<DaemonAddress> I<Address>
5740 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5741 library. See L<rrdcached(1)> for details. Example:
5743 <Plugin "rrdcached">
5744 DaemonAddress "unix:/var/run/rrdcached.sock"
5747 =item B<DataDir> I<Directory>
5749 Set the base directory in which the RRD files reside. If this is a relative
5750 path, it is relative to the working base directory of the C<rrdcached> daemon!
5751 Use of an absolute path is recommended.
5753 =item B<CreateFiles> B<true>|B<false>
5755 Enables or disables the creation of RRD files. If the daemon is not running
5756 locally, or B<DataDir> is set to a relative path, this will not work as
5757 expected. Default is B<true>.
5759 =item B<CreateFilesAsync> B<false>|B<true>
5761 When enabled, new RRD files are enabled asynchronously, using a separate thread
5762 that runs in the background. This prevents writes to block, which is a problem
5763 especially when many hundreds of files need to be created at once. However,
5764 since the purpose of creating the files asynchronously is I<not> to block until
5765 the file is available, values before the file is available will be discarded.
5766 When disabled (the default) files are created synchronously, blocking for a
5767 short while, while the file is being written.
5769 =item B<StepSize> I<Seconds>
5771 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5772 this setting is unset and the stepsize is set to the interval in which the data
5773 is collected. Do not use this option unless you absolutely have to for some
5774 reason. Setting this option may cause problems with the C<snmp plugin>, the
5775 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5777 =item B<HeartBeat> I<Seconds>
5779 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5780 in which case the heartbeat is set to twice the B<StepSize> which should equal
5781 the interval in which data is collected. Do not set this option unless you have
5782 a very good reason to do so.
5784 =item B<RRARows> I<NumRows>
5786 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5787 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5788 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5789 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5790 week, one month, and one year.
5792 So for each timespan, it calculates how many PDPs need to be consolidated into
5793 one CDP by calculating:
5794 number of PDPs = timespan / (stepsize * rrarows)
5796 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5799 =item B<RRATimespan> I<Seconds>
5801 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5802 more then one RRA. If this option is never used, the built-in default of (3600,
5803 86400, 604800, 2678400, 31622400) is used.
5805 For more information on how RRA-sizes are calculated see B<RRARows> above.
5807 =item B<XFF> I<Factor>
5809 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5810 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5813 =item B<CollectStatistics> B<false>|B<true>
5815 When set to B<true>, various statistics about the I<rrdcached> daemon will be
5816 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
5818 Statistics are read via I<rrdcached>s socket using the STATS command.
5819 See L<rrdcached(1)> for details.
5823 =head2 Plugin C<rrdtool>
5825 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5826 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5827 using these settings. If you don't want to dive into the depths of RRDtool, you
5828 can safely ignore these settings.
5832 =item B<DataDir> I<Directory>
5834 Set the directory to store RRD files under. By default RRD files are generated
5835 beneath the daemon's working directory, i.e. the B<BaseDir>.
5837 =item B<CreateFilesAsync> B<false>|B<true>
5839 When enabled, new RRD files are enabled asynchronously, using a separate thread
5840 that runs in the background. This prevents writes to block, which is a problem
5841 especially when many hundreds of files need to be created at once. However,
5842 since the purpose of creating the files asynchronously is I<not> to block until
5843 the file is available, values before the file is available will be discarded.
5844 When disabled (the default) files are created synchronously, blocking for a
5845 short while, while the file is being written.
5847 =item B<StepSize> I<Seconds>
5849 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5850 this setting is unset and the stepsize is set to the interval in which the data
5851 is collected. Do not use this option unless you absolutely have to for some
5852 reason. Setting this option may cause problems with the C<snmp plugin>, the
5853 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5855 =item B<HeartBeat> I<Seconds>
5857 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5858 in which case the heartbeat is set to twice the B<StepSize> which should equal
5859 the interval in which data is collected. Do not set this option unless you have
5860 a very good reason to do so.
5862 =item B<RRARows> I<NumRows>
5864 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5865 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5866 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5867 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5868 week, one month, and one year.
5870 So for each timespan, it calculates how many PDPs need to be consolidated into
5871 one CDP by calculating:
5872 number of PDPs = timespan / (stepsize * rrarows)
5874 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5877 =item B<RRATimespan> I<Seconds>
5879 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5880 more then one RRA. If this option is never used, the built-in default of (3600,
5881 86400, 604800, 2678400, 31622400) is used.
5883 For more information on how RRA-sizes are calculated see B<RRARows> above.
5885 =item B<XFF> I<Factor>
5887 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5888 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5891 =item B<CacheFlush> I<Seconds>
5893 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5894 it writes all values for a certain RRD-file if the oldest value is older than
5895 (or equal to) the number of seconds specified. If some RRD-file is not updated
5896 anymore for some reason (the computer was shut down, the network is broken,
5897 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5898 entire cache is searched for entries older than B<CacheTimeout> seconds and
5899 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5900 does nothing under normal circumstances, this value should not be too small.
5901 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5902 normally do much harm either.
5904 =item B<CacheTimeout> I<Seconds>
5906 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5907 save values in a cache, as described above. Writing multiple values at once
5908 reduces IO-operations and thus lessens the load produced by updating the files.
5909 The trade off is that the graphs kind of "drag behind" and that more memory is
5912 =item B<WritesPerSecond> I<Updates>
5914 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5915 will run serious performance problems. The B<CacheFlush> setting and the
5916 internal update queue assert that collectd continues to work just fine even
5917 under heavy load, but the system may become very unresponsive and slow. This is
5918 a problem especially if you create graphs from the RRD files on the same
5919 machine, for example using the C<graph.cgi> script included in the
5920 C<contrib/collection3/> directory.
5922 This setting is designed for very large setups. Setting this option to a value
5923 between 25 and 80 updates per second, depending on your hardware, will leave
5924 the server responsive enough to draw graphs even while all the cached values
5925 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5926 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5927 written as fast as possible, so that web frontends have up to date data when
5930 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5931 updates per second, writing all values to disk will take approximately
5932 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5933 "collection3" you'll end up with a responsive and fast system, up to date
5934 graphs and basically a "backup" of your values every hour.
5936 =item B<RandomTimeout> I<Seconds>
5938 When set, the actual timeout for each value is chosen randomly between
5939 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5940 intention is to avoid high load situations that appear when many values timeout
5941 at the same time. This is especially a problem shortly after the daemon starts,
5942 because all values were added to the internal cache at roughly the same time.
5946 =head2 Plugin C<sensors>
5948 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5949 that all the needed modules have to be loaded and lm_sensors has to be
5950 configured (most likely by editing F</etc/sensors.conf>. Read
5951 L<sensors.conf(5)> for details.
5953 The B<lm_sensors> homepage can be found at
5954 L<http://secure.netroedge.com/~lm78/>.
5958 =item B<SensorConfigFile> I<File>
5960 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5961 the library's default will be used.
5963 =item B<Sensor> I<chip-bus-address/type-feature>
5965 Selects the name of the sensor which you want to collect or ignore, depending
5966 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5967 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5968 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5970 =item B<IgnoreSelected> I<true>|I<false>
5972 If no configuration if given, the B<sensors>-plugin will collect data from all
5973 sensors. This may not be practical, especially for uninteresting sensors.
5974 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5975 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5976 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5977 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5978 and all other sensors are collected.
5982 =head2 Plugin C<sigrok>
5984 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5985 supported by the L<sigrok|http://sigrok.org/> project.
5991 <Device "AC Voltage">
5996 <Device "Sound Level">
5997 Driver "cem-dt-885x"
6004 =item B<LogLevel> B<0-5>
6006 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
6007 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
6008 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
6009 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
6010 their level, are always submitted to I<collectd> at its INFO log level.
6012 =item E<lt>B<Device> I<Name>E<gt>
6014 A sigrok-supported device, uniquely identified by this section's options. The
6015 I<Name> is passed to I<collectd> as the I<plugin instance>.
6017 =item B<Driver> I<DriverName>
6019 The sigrok driver to use for this device.
6021 =item B<Conn> I<ConnectionSpec>
6023 If the device cannot be auto-discovered, or more than one might be discovered
6024 by the driver, I<ConnectionSpec> specifies the connection string to the device.
6025 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
6026 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
6027 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
6028 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
6030 =item B<SerialComm> I<SerialSpec>
6032 For serial devices with non-standard port settings, this option can be used
6033 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
6034 This should not be necessary; drivers know how to communicate with devices they
6037 =item B<MinimumInterval> I<Seconds>
6039 Specifies the minimum time between measurement dispatches to I<collectd>, in
6040 seconds. Since some I<sigrok> supported devices can acquire measurements many
6041 times per second, it may be necessary to throttle these. For example, the
6042 I<RRD plugin> cannot process writes more than once per second.
6044 The default B<MinimumInterval> is B<0>, meaning measurements received from the
6045 device are always dispatched to I<collectd>. When throttled, unused
6046 measurements are discarded.
6050 =head2 Plugin C<smart>
6052 The C<smart> plugin collects SMART information from physical
6053 disks. Values collectd include temperature, power cycle count, poweron
6054 time and bad sectors. Also, all SMART attributes are collected along
6055 with the normalized current value, the worst value, the threshold and
6056 a human readable value.
6058 Using the following two options you can ignore some disks or configure the
6059 collection only of specific disks.
6063 =item B<Disk> I<Name>
6065 Select the disk I<Name>. Whether it is collected or ignored depends on the
6066 B<IgnoreSelected> setting, see below. As with other plugins that use the
6067 daemon's ignorelist functionality, a string that starts and ends with a slash
6068 is interpreted as a regular expression. Examples:
6073 =item B<IgnoreSelected> B<true>|B<false>
6075 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
6076 statements, are ignored or if all other disks are ignored. The behavior
6077 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
6078 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
6079 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
6080 is set to B<true>, all disks are collected B<except> the ones matched.
6084 =head2 Plugin C<snmp>
6086 Since the configuration of the C<snmp plugin> is a little more complicated than
6087 other plugins, its documentation has been moved to an own manpage,
6088 L<collectd-snmp(5)>. Please see there for details.
6090 =head2 Plugin C<statsd>
6092 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
6093 protocol and dispatches rates or other aggregates of these numbers
6096 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
6097 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
6098 C<objects> respectively.
6100 The following configuration options are valid:
6104 =item B<Host> I<Host>
6106 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
6107 "any" address, i.e. accept packets sent to any of the hosts addresses.
6109 =item B<Port> I<Port>
6111 UDP port to listen to. This can be either a service name or a port number.
6112 Defaults to C<8125>.
6114 =item B<DeleteCounters> B<false>|B<true>
6116 =item B<DeleteTimers> B<false>|B<true>
6118 =item B<DeleteGauges> B<false>|B<true>
6120 =item B<DeleteSets> B<false>|B<true>
6122 These options control what happens if metrics are not updated in an interval.
6123 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
6124 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
6125 are unchanged. If set to B<True>, the such metrics are not dispatched and
6126 removed from the internal cache.
6128 =item B<TimerPercentile> I<Percent>
6130 Calculate and dispatch the configured percentile, i.e. compute the latency, so
6131 that I<Percent> of all reported timers are smaller than or equal to the
6132 computed latency. This is useful for cutting off the long tail latency, as it's
6133 often done in I<Service Level Agreements> (SLAs).
6135 Different percentiles can be calculated by setting this option several times.
6136 If none are specified, no percentiles are calculated / dispatched.
6138 =item B<TimerLower> B<false>|B<true>
6140 =item B<TimerUpper> B<false>|B<true>
6142 =item B<TimerSum> B<false>|B<true>
6144 =item B<TimerCount> B<false>|B<true>
6146 Calculate and dispatch various values out of I<Timer> metrics received during
6147 an interval. If set to B<False>, the default, these values aren't calculated /
6152 =head2 Plugin C<swap>
6154 The I<Swap plugin> collects information about used and available swap space. On
6155 I<Linux> and I<Solaris>, the following options are available:
6159 =item B<ReportByDevice> B<false>|B<true>
6161 Configures how to report physical swap devices. If set to B<false> (the
6162 default), the summary over all swap devices is reported only, i.e. the globally
6163 used and available space over all devices. If B<true> is configured, the used
6164 and available space of each device will be reported separately.
6166 This option is only available if the I<Swap plugin> can read C</proc/swaps>
6167 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
6169 =item B<ReportBytes> B<false>|B<true>
6171 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
6172 I<swap I/O> is reported in pages. This option is available under Linux only.
6174 =item B<ValuesAbsolute> B<true>|B<false>
6176 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
6177 available and used. Defaults to B<true>.
6179 =item B<ValuesPercentage> B<false>|B<true>
6181 Enables or disables reporting of relative swap metrics, i.e. I<percent>
6182 available and free. Defaults to B<false>.
6184 This is useful for deploying I<collectd> in a heterogeneous environment, where
6185 swap sizes differ and you want to specify generic thresholds or similar.
6189 =head2 Plugin C<syslog>
6193 =item B<LogLevel> B<debug|info|notice|warning|err>
6195 Sets the log-level. If, for example, set to B<notice>, then all events with
6196 severity B<notice>, B<warning>, or B<err> will be submitted to the
6199 Please note that B<debug> is only available if collectd has been compiled with
6202 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
6204 Controls which notifications should be sent to syslog. The default behaviour is
6205 not to send any. Less severe notifications always imply logging more severe
6206 notifications: Setting this to B<OKAY> means all notifications will be sent to
6207 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
6208 notifications but will dismiss B<OKAY> notifications. Setting this option to
6209 B<FAILURE> will only send failures to syslog.
6213 =head2 Plugin C<table>
6215 The C<table plugin> provides generic means to parse tabular data and dispatch
6216 user specified values. Values are selected based on column numbers. For
6217 example, this plugin may be used to get values from the Linux L<proc(5)>
6218 filesystem or CSV (comma separated values) files.
6221 <Table "/proc/slabinfo">
6226 InstancePrefix "active_objs"
6232 InstancePrefix "objperslab"
6239 The configuration consists of one or more B<Table> blocks, each of which
6240 configures one file to parse. Within each B<Table> block, there are one or
6241 more B<Result> blocks, which configure which data to select and how to
6244 The following options are available inside a B<Table> block:
6248 =item B<Instance> I<instance>
6250 If specified, I<instance> is used as the plugin instance. So, in the above
6251 example, the plugin name C<table-slabinfo> would be used. If omitted, the
6252 filename of the table is used instead, with all special characters replaced
6253 with an underscore (C<_>).
6255 =item B<Separator> I<string>
6257 Any character of I<string> is interpreted as a delimiter between the different
6258 columns of the table. A sequence of two or more contiguous delimiters in the
6259 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
6260 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
6261 of a table - see its documentation for more details. This option is mandatory.
6263 A horizontal tab, newline and carriage return may be specified by C<\\t>,
6264 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
6265 required because of collectd's config parsing.
6269 The following options are available inside a B<Result> block:
6273 =item B<Type> I<type>
6275 Sets the type used to dispatch the values to the daemon. Detailed information
6276 about types and their configuration can be found in L<types.db(5)>. This
6277 option is mandatory.
6279 =item B<InstancePrefix> I<prefix>
6281 If specified, prepend I<prefix> to the type instance. If omitted, only the
6282 B<InstancesFrom> option is considered for the type instance.
6284 =item B<InstancesFrom> I<column0> [I<column1> ...]
6286 If specified, the content of the given columns (identified by the column
6287 number starting at zero) will be used to create the type instance for each
6288 row. Multiple values (and the instance prefix) will be joined together with
6289 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
6290 option is considered for the type instance.
6292 The plugin itself does not check whether or not all built instances are
6293 different. It’s your responsibility to assure that each is unique. This is
6294 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
6295 sure that the table only contains one row.
6297 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
6300 =item B<ValuesFrom> I<column0> [I<column1> ...]
6302 Specifies the columns (identified by the column numbers starting at zero)
6303 whose content is used as the actual data for the data sets that are dispatched
6304 to the daemon. How many such columns you need is determined by the B<Type>
6305 setting above. If you specify too many or not enough columns, the plugin will
6306 complain about that and no data will be submitted to the daemon. The plugin
6307 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
6308 respectively, so anything supported by those functions is supported by the
6309 plugin as well. This option is mandatory.
6313 =head2 Plugin C<tail>
6315 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
6316 each line and dispatches found values. What is matched can be configured by the
6317 user using (extended) regular expressions, as described in L<regex(7)>.
6320 <File "/var/log/exim4/mainlog">
6324 Regex "S=([1-9][0-9]*)"
6330 Regex "\\<R=local_user\\>"
6331 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
6334 Instance "local_user"
6339 The config consists of one or more B<File> blocks, each of which configures one
6340 logfile to parse. Within each B<File> block, there are one or more B<Match>
6341 blocks, which configure a regular expression to search for.
6343 The B<Instance> option in the B<File> block may be used to set the plugin
6344 instance. So in the above example the plugin name C<tail-foo> would be used.
6345 This plugin instance is for all B<Match> blocks that B<follow> it, until the
6346 next B<Instance> option. This way you can extract several plugin instances from
6347 one logfile, handy when parsing syslog and the like.
6349 The B<Interval> option allows you to define the length of time between reads. If
6350 this is not set, the default Interval will be used.
6352 Each B<Match> block has the following options to describe how the match should
6357 =item B<Regex> I<regex>
6359 Sets the regular expression to use for matching against a line. The first
6360 subexpression has to match something that can be turned into a number by
6361 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
6362 below. Because B<extended> regular expressions are used, you do not need to use
6363 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
6364 collectd's config parsing you need to escape backslashes, though. So if you
6365 want to match literal parentheses you need to do the following:
6367 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
6369 =item B<ExcludeRegex> I<regex>
6371 Sets an optional regular expression to use for excluding lines from the match.
6372 An example which excludes all connections from localhost from the match:
6374 ExcludeRegex "127\\.0\\.0\\.1"
6376 =item B<DSType> I<Type>
6378 Sets how the values are cumulated. I<Type> is one of:
6382 =item B<GaugeAverage>
6384 Calculate the average.
6388 Use the smallest number only.
6392 Use the greatest number only.
6396 Use the last number found.
6402 =item B<AbsoluteSet>
6404 The matched number is a counter. Simply I<sets> the internal counter to this
6405 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
6413 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
6414 matched number may be negative, which will effectively subtract from the
6423 Increase the internal counter by one. These B<DSType> are the only ones that do
6424 not use the matched subexpression, but simply count the number of matched
6425 lines. Thus, you may use a regular expression without submatch in this case.
6429 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6430 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6431 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6432 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6433 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6436 =item B<Type> I<Type>
6438 Sets the type used to dispatch this value. Detailed information about types and
6439 their configuration can be found in L<types.db(5)>.
6441 =item B<Instance> I<TypeInstance>
6443 This optional setting sets the type instance to use.
6447 =head2 Plugin C<tail_csv>
6449 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6450 written by I<Snort>.
6455 <Metric "snort-dropped">
6460 <File "/var/log/snort/snort.stats">
6461 Instance "snort-eth0"
6463 Collect "snort-dropped"
6467 The configuration consists of one or more B<Metric> blocks that define an index
6468 into the line of the CSV file and how this value is mapped to I<collectd's>
6469 internal representation. These are followed by one or more B<Instance> blocks
6470 which configure which file to read, in which interval and which metrics to
6475 =item E<lt>B<Metric> I<Name>E<gt>
6477 The B<Metric> block configures a new metric to be extracted from the statistics
6478 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6479 only used inside the B<Instance> blocks to refer to this block, so you can use
6480 one B<Metric> block for multiple CSV files.
6484 =item B<Type> I<Type>
6486 Configures which I<Type> to use when dispatching this metric. Types are defined
6487 in the L<types.db(5)> file, see the appropriate manual page for more
6488 information on specifying types. Only types with a single I<data source> are
6489 supported by the I<tail_csv plugin>. The information whether the value is an
6490 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6491 I<Type's> definition.
6493 =item B<Instance> I<TypeInstance>
6495 If set, I<TypeInstance> is used to populate the type instance field of the
6496 created value lists. Otherwise, no type instance is used.
6498 =item B<ValueFrom> I<Index>
6500 Configure to read the value from the field with the zero-based index I<Index>.
6501 If the value is parsed as signed integer, unsigned integer or double depends on
6502 the B<Type> setting, see above.
6506 =item E<lt>B<File> I<Path>E<gt>
6508 Each B<File> block represents one CSV file to read. There must be at least one
6509 I<File> block but there can be multiple if you have multiple CSV files.
6513 =item B<Instance> I<PluginInstance>
6515 Sets the I<plugin instance> used when dispatching the values.
6517 =item B<Collect> I<Metric>
6519 Specifies which I<Metric> to collect. This option must be specified at least
6520 once, and you can use this option multiple times to specify more than one
6521 metric to be extracted from this statistic file.
6523 =item B<Interval> I<Seconds>
6525 Configures the interval in which to read values from this instance / file.
6526 Defaults to the plugin's default interval.
6528 =item B<TimeFrom> I<Index>
6530 Rather than using the local time when dispatching a value, read the timestamp
6531 from the field with the zero-based index I<Index>. The value is interpreted as
6532 seconds since epoch. The value is parsed as a double and may be factional.
6538 =head2 Plugin C<teamspeak2>
6540 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6541 polls interesting global and virtual server data. The plugin can query only one
6542 physical server but unlimited virtual servers. You can use the following
6543 options to configure it:
6547 =item B<Host> I<hostname/ip>
6549 The hostname or ip which identifies the physical server.
6552 =item B<Port> I<port>
6554 The query port of the physical server. This needs to be a string.
6557 =item B<Server> I<port>
6559 This option has to be added once for every virtual server the plugin should
6560 query. If you want to query the virtual server on port 8767 this is what the
6561 option would look like:
6565 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6566 use quotes around it! If no such statement is given only global information
6571 =head2 Plugin C<ted>
6573 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6574 measure power consumption. These devices are usually connected to a serial
6575 (RS232) or USB port. The plugin opens a configured device and tries to read the
6576 current energy readings. For more information on TED, visit
6577 L<http://www.theenergydetective.com/>.
6579 Available configuration options:
6583 =item B<Device> I<Path>
6585 Path to the device on which TED is connected. collectd will need read and write
6586 permissions on that file.
6588 Default: B</dev/ttyUSB0>
6590 =item B<Retries> I<Num>
6592 Apparently reading from TED is not that reliable. You can therefore configure a
6593 number of retries here. You only configure the I<retries> here, to if you
6594 specify zero, one reading will be performed (but no retries if that fails); if
6595 you specify three, a maximum of four readings are performed. Negative values
6602 =head2 Plugin C<tcpconns>
6604 The C<tcpconns plugin> counts the number of currently established TCP
6605 connections based on the local port and/or the remote port. Since there may be
6606 a lot of connections the default if to count all connections with a local port,
6607 for which a listening socket is opened. You can use the following options to
6608 fine-tune the ports you are interested in:
6612 =item B<ListeningPorts> I<true>|I<false>
6614 If this option is set to I<true>, statistics for all local ports for which a
6615 listening socket exists are collected. The default depends on B<LocalPort> and
6616 B<RemotePort> (see below): If no port at all is specifically selected, the
6617 default is to collect listening ports. If specific ports (no matter if local or
6618 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6619 the selected ports will be collected unless this option is set to I<true>
6622 =item B<LocalPort> I<Port>
6624 Count the connections to a specific local port. This can be used to see how
6625 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6626 You have to specify the port in numeric form, so for the mailserver example
6627 you'd need to set B<25>.
6629 =item B<RemotePort> I<Port>
6631 Count the connections to a specific remote port. This is useful to see how
6632 much a remote service is used. This is most useful if you want to know how many
6633 connections a local service has opened to remote services, e.E<nbsp>g. how many
6634 connections a mail server or news server has to other mail or news servers, or
6635 how many connections a web proxy holds to web servers. You have to give the
6636 port in numeric form.
6638 =item B<AllPortsSummary> I<true>|I<false>
6640 If this option is set to I<true> a summary of statistics from all connections
6641 are collectd. This option defaults to I<false>.
6645 =head2 Plugin C<thermal>
6649 =item B<ForceUseProcfs> I<true>|I<false>
6651 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6652 C<sysfs> interface. If that is not available, the plugin falls back to the
6653 C<procfs> interface. By setting this option to I<true>, you can force the
6654 plugin to use the latter. This option defaults to I<false>.
6656 =item B<Device> I<Device>
6658 Selects the name of the thermal device that you want to collect or ignore,
6659 depending on the value of the B<IgnoreSelected> option. This option may be
6660 used multiple times to specify a list of devices.
6662 =item B<IgnoreSelected> I<true>|I<false>
6664 Invert the selection: If set to true, all devices B<except> the ones that
6665 match the device names specified by the B<Device> option are collected. By
6666 default only selected devices are collected if a selection is made. If no
6667 selection is configured at all, B<all> devices are selected.
6671 =head2 Plugin C<threshold>
6673 The I<Threshold plugin> checks values collected or received by I<collectd>
6674 against a configurable I<threshold> and issues I<notifications> if values are
6677 Documentation for this plugin is available in the L<collectd-threshold(5)>
6680 =head2 Plugin C<tokyotyrant>
6682 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6683 couple metrics: number of records, and database size on disk.
6687 =item B<Host> I<Hostname/IP>
6689 The hostname or ip which identifies the server.
6690 Default: B<127.0.0.1>
6692 =item B<Port> I<Service/Port>
6694 The query port of the server. This needs to be a string, even if the port is
6695 given in its numeric form.
6700 =head2 Plugin C<turbostat>
6702 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
6703 Intel processors by using the new Model Specific Registers.
6707 =item B<CoreCstates> I<Bitmask(Integer)>
6709 Bitmask of the list of core C states supported by the processor.
6710 This option should only be used if the automated detection fails.
6711 Default value extracted from the cpu model and family.
6713 Currently supported C-states (by this plugin): 3, 6, 7
6715 Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states
6717 =item B<PackageCstates> I<Bitmask(Integer)>
6719 Bitmask of the list of pacages C states supported by the processor.
6720 This option should only be used if the automated detection fails.
6721 Default value extracted from the cpu model and family.
6723 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
6725 Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7
6727 =item B<SystemManagementInterrupt> I<true>|I<false>
6729 Boolean enabling the collection of the I/O System-Management Interrupt
6730 counter'. This option should only be used if the automated detection
6731 fails or if you want to disable this feature.
6733 =item B<DigitalTemperatureSensor> I<true>|I<false>
6735 Boolean enabling the collection of the temperature of each core.
6736 This option should only be used if the automated detectionfails or
6737 if you want to disable this feature.
6739 =item B<DigitalTemperatureSensor> I<true>|I<false>
6741 Boolean enabling the collection of the temperature of each package.
6742 This option should only be used if the automated detectionfails or
6743 if you want to disable this feature.
6745 =item B<TCCActivationTemp> I<Temperature>
6747 Thermal Control Circuit Activation Temperature of the installed
6748 CPU. This temperature is used when collecting the temperature of
6749 cores or packages. This option should only be used if the automated
6750 detection fails. Default value extracted from B<MSR_IA32_TEMPERATURE_TARGET>
6752 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
6754 Bitmask of the list of elements to be thermally monitored. This option
6755 should only be used if the automated detection fails or if you want to
6756 disable some collections. The different bits of this bitmask accepted
6761 =item 0 ('1'): Package
6765 =item 2 ('4'): Cores
6767 =item 3 ('8'): Embedded graphic device
6773 =head2 Plugin C<unixsock>
6777 =item B<SocketFile> I<Path>
6779 Sets the socket-file which is to be created.
6781 =item B<SocketGroup> I<Group>
6783 If running as root change the group of the UNIX-socket after it has been
6784 created. Defaults to B<collectd>.
6786 =item B<SocketPerms> I<Permissions>
6788 Change the file permissions of the UNIX-socket after it has been created. The
6789 permissions must be given as a numeric, octal value as you would pass to
6790 L<chmod(1)>. Defaults to B<0770>.
6792 =item B<DeleteSocket> B<false>|B<true>
6794 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6795 with the given name already exists. If I<collectd> crashes a socket file may be
6796 left over, preventing the daemon from opening a new socket when restarted.
6797 Since this is potentially dangerous, this defaults to B<false>.
6801 =head2 Plugin C<uuid>
6803 This plugin, if loaded, causes the Hostname to be taken from the machine's
6804 UUID. The UUID is a universally unique designation for the machine, usually
6805 taken from the machine's BIOS. This is most useful if the machine is running in
6806 a virtual environment such as Xen, in which case the UUID is preserved across
6807 shutdowns and migration.
6809 The following methods are used to find the machine's UUID, in order:
6815 Check I</etc/uuid> (or I<UUIDFile>).
6819 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6824 Check for UUID from C<dmidecode> / SMBIOS.
6828 Check for UUID from Xen hypervisor.
6832 If no UUID can be found then the hostname is not modified.
6836 =item B<UUIDFile> I<Path>
6838 Take the UUID from the given file (default I</etc/uuid>).
6842 =head2 Plugin C<varnish>
6844 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6845 It collects a subset of the values displayed by L<varnishstat(1)>, and
6846 organizes them in categories which can be enabled or disabled. Currently only
6847 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
6848 meaning of each metric can be found in L<varnish-counters(7)>.
6853 <Instance "example">
6857 CollectConnections true
6858 CollectDirectorDNS false
6862 CollectObjects false
6864 CollectSession false
6874 CollectWorkers false
6878 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6879 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6880 will collectd statistics from the default "varnishd" instance (this should work
6881 fine in most cases).
6883 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6887 =item B<CollectBackend> B<true>|B<false>
6889 Back-end connection statistics, such as successful, reused,
6890 and closed connections. True by default.
6892 =item B<CollectBan> B<true>|B<false>
6894 Statistics about ban operations, such as number of bans added, retired, and
6895 number of objects tested against ban operations. Only available with Varnish
6896 3.x and above. False by default.
6898 =item B<CollectCache> B<true>|B<false>
6900 Cache hits and misses. True by default.
6902 =item B<CollectConnections> B<true>|B<false>
6904 Number of client connections received, accepted and dropped. True by default.
6906 =item B<CollectDirectorDNS> B<true>|B<false>
6908 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6911 =item B<CollectESI> B<true>|B<false>
6913 Edge Side Includes (ESI) parse statistics. False by default.
6915 =item B<CollectFetch> B<true>|B<false>
6917 Statistics about fetches (HTTP requests sent to the backend). False by default.
6919 =item B<CollectHCB> B<true>|B<false>
6921 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6922 divided into locked and unlocked look-ups. False by default.
6924 =item B<CollectObjects> B<true>|B<false>
6926 Statistics on cached objects: number of objects expired, nuked (prematurely
6927 expired), saved, moved, etc. False by default.
6929 =item B<CollectPurge> B<true>|B<false>
6931 Statistics about purge operations, such as number of purges added, retired, and
6932 number of objects tested against purge operations. Only available with Varnish
6933 2.x. False by default.
6935 =item B<CollectSession> B<true>|B<false>
6937 Client session statistics. Number of past and current sessions, session herd and
6938 linger counters, etc. False by default. Note that if using Varnish 4.x, some
6939 metrics found in the Connections and Threads sections with previous versions of
6940 Varnish have been moved here.
6942 =item B<CollectSHM> B<true>|B<false>
6944 Statistics about the shared memory log, a memory region to store
6945 log messages which is flushed to disk when full. True by default.
6947 =item B<CollectSMA> B<true>|B<false>
6949 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6950 component is Solaris specific. Only available with Varnish 2.x. False by
6953 =item B<CollectSMS> B<true>|B<false>
6955 synth (synthetic content) storage statistics. This storage
6956 component is used internally only. False by default.
6958 =item B<CollectSM> B<true>|B<false>
6960 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6963 =item B<CollectStruct> B<true>|B<false>
6965 Current varnish internal state statistics. Number of current sessions, objects
6966 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6969 =item B<CollectTotals> B<true>|B<false>
6971 Collects overview counters, such as the number of sessions created,
6972 the number of requests and bytes transferred. False by default.
6974 =item B<CollectUptime> B<true>|B<false>
6976 Varnish uptime. Only available with Varnish 3.x and above. False by default.
6978 =item B<CollectVCL> B<true>|B<false>
6980 Number of total (available + discarded) VCL (config files). False by default.
6982 =item B<CollectVSM> B<true>|B<false>
6984 Collect statistics about Varnish's shared memory usage (used by the logging and
6985 statistics subsystems). Only available with Varnish 4.x. False by default.
6987 =item B<CollectWorkers> B<true>|B<false>
6989 Collect statistics about worker threads. False by default.
6993 =head2 Plugin C<virt>
6995 This plugin allows CPU, disk and network load to be collected for virtualized
6996 guests on the machine. This means that these metrics can be collected for guest
6997 systems without installing any software on them - I<collectd> only runs on the
6998 host system. The statistics are collected through libvirt
6999 (L<http://libvirt.org/>).
7001 Only I<Connection> is required.
7005 =item B<Connection> I<uri>
7007 Connect to the hypervisor given by I<uri>. For example if using Xen use:
7009 Connection "xen:///"
7011 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
7013 =item B<RefreshInterval> I<seconds>
7015 Refresh the list of domains and devices every I<seconds>. The default is 60
7016 seconds. Setting this to be the same or smaller than the I<Interval> will cause
7017 the list of domains and devices to be refreshed on every iteration.
7019 Refreshing the devices in particular is quite a costly operation, so if your
7020 virtualization setup is static you might consider increasing this. If this
7021 option is set to 0, refreshing is disabled completely.
7023 =item B<Domain> I<name>
7025 =item B<BlockDevice> I<name:dev>
7027 =item B<InterfaceDevice> I<name:dev>
7029 =item B<IgnoreSelected> B<true>|B<false>
7031 Select which domains and devices are collected.
7033 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
7034 disk/network devices are collected.
7036 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
7037 domains and disk/network devices are ignored, while the rest are collected.
7039 The domain name and device names may use a regular expression, if the name is
7040 surrounded by I</.../> and collectd was compiled with support for regexps.
7042 The default is to collect statistics for all domains and all their devices.
7046 BlockDevice "/:hdb/"
7047 IgnoreSelected "true"
7049 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
7052 =item B<HostnameFormat> B<name|uuid|hostname|...>
7054 When the virt plugin logs data, it sets the hostname of the collected data
7055 according to this setting. The default is to use the guest name as provided by
7056 the hypervisor, which is equal to setting B<name>.
7058 B<uuid> means use the guest's UUID. This is useful if you want to track the
7059 same guest across migrations.
7061 B<hostname> means to use the global B<Hostname> setting, which is probably not
7062 useful on its own because all guests will appear to have the same name.
7064 You can also specify combinations of these fields. For example B<name uuid>
7065 means to concatenate the guest name and UUID (with a literal colon character
7066 between, thus I<"foo:1234-1234-1234-1234">).
7068 =item B<InterfaceFormat> B<name>|B<address>
7070 When the virt plugin logs interface data, it sets the name of the collected
7071 data according to this setting. The default is to use the path as provided by
7072 the hypervisor (the "dev" property of the target node), which is equal to
7075 B<address> means use the interface's mac address. This is useful since the
7076 interface path might change between reboots of a guest or across migrations.
7078 =item B<PluginInstanceFormat> B<name|uuid>
7080 When the virt plugin logs data, it sets the plugin_instance of the collected
7081 data according to this setting. The default is to use the guest name as provided
7082 by the hypervisor, which is equal to setting B<name>.
7084 B<uuid> means use the guest's UUID.
7088 =head2 Plugin C<vmem>
7090 The C<vmem> plugin collects information about the usage of virtual memory.
7091 Since the statistics provided by the Linux kernel are very detailed, they are
7092 collected very detailed. However, to get all the details, you have to switch
7093 them on manually. Most people just want an overview over, such as the number of
7094 pages read from swap space.
7098 =item B<Verbose> B<true>|B<false>
7100 Enables verbose collection of information. This will start collecting page
7101 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
7102 Part of these statistics are collected on a "per zone" basis.
7106 =head2 Plugin C<vserver>
7108 This plugin doesn't have any options. B<VServer> support is only available for
7109 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
7110 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
7111 need to apply the patches and compile your own kernel, which will then provide
7112 the F</proc/virtual> filesystem that is required by this plugin.
7114 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
7116 B<Note>: The traffic collected by this plugin accounts for the amount of
7117 traffic passing a socket which might be a lot less than the actual on-wire
7118 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
7119 collect on-wire traffic you could, for example, use the logging facilities of
7120 iptables to feed data for the guest IPs into the iptables plugin.
7122 =head2 Plugin C<write_graphite>
7124 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
7125 storage and graphing project. The plugin connects to I<Carbon>, the data layer
7126 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
7127 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
7128 of at most 1428 bytes to minimize the number of network packets.
7132 <Plugin write_graphite>
7142 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7143 blocks. Inside the B<Node> blocks, the following options are recognized:
7147 =item B<Host> I<Address>
7149 Hostname or address to connect to. Defaults to C<localhost>.
7151 =item B<Port> I<Service>
7153 Service name or port number to connect to. Defaults to C<2003>.
7155 =item B<Protocol> I<String>
7157 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
7159 =item B<LogSendErrors> B<false>|B<true>
7161 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
7162 If set to B<false>, it will not log the errors. This is especially useful when
7163 using Protocol UDP since many times we want to use the "fire-and-forget"
7164 approach and logging errors fills syslog with unneeded messages.
7166 =item B<Prefix> I<String>
7168 When set, I<String> is added in front of the host name. Dots and whitespace are
7169 I<not> escaped in this string (see B<EscapeCharacter> below).
7171 =item B<Postfix> I<String>
7173 When set, I<String> is appended to the host name. Dots and whitespace are
7174 I<not> escaped in this string (see B<EscapeCharacter> below).
7176 =item B<EscapeCharacter> I<Char>
7178 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
7179 in the identifier. The B<EscapeCharacter> option determines which character
7180 dots, whitespace and control characters are replaced with. Defaults to
7183 =item B<StoreRates> B<false>|B<true>
7185 If set to B<true> (the default), convert counter values to rates. If set to
7186 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
7189 =item B<SeparateInstances> B<false>|B<true>
7191 If set to B<true>, the plugin instance and type instance will be in their own
7192 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7193 default), the plugin and plugin instance (and likewise the type and type
7194 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7196 =item B<AlwaysAppendDS> B<false>|B<true>
7198 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
7199 identifier. If set to B<false> (the default), this is only done when there is
7204 =head2 Plugin C<write_tsdb>
7206 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
7207 time series database. The plugin connects to a I<TSD>, a masterless, no shared
7208 state daemon that ingests metrics and stores them in HBase. The plugin uses
7209 I<TCP> over the "line based" protocol with a default port 4242. The data will
7210 be sent in blocks of at most 1428 bytes to minimize the number of network
7217 Host "tsd-1.my.domain"
7219 HostTags "status=production"
7223 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
7224 blocks. Inside the B<Node> blocks, the following options are recognized:
7228 =item B<Host> I<Address>
7230 Hostname or address to connect to. Defaults to C<localhost>.
7232 =item B<Port> I<Service>
7234 Service name or port number to connect to. Defaults to C<4242>.
7237 =item B<HostTags> I<String>
7239 When set, I<HostTags> is added to the end of the metric. It is intended to be
7240 used for name=value pairs that the TSD will tag the metric with. Dots and
7241 whitespace are I<not> escaped in this string.
7243 =item B<StoreRates> B<false>|B<true>
7245 If set to B<true>, convert counter values to rates. If set to B<false>
7246 (the default) counter values are stored as is, as an increasing
7249 =item B<AlwaysAppendDS> B<false>|B<true>
7251 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
7252 identifier. If set to B<false> (the default), this is only done when there is
7257 =head2 Plugin C<write_mongodb>
7259 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
7264 <Plugin "write_mongodb">
7273 The plugin can send values to multiple instances of I<MongoDB> by specifying
7274 one B<Node> block for each instance. Within the B<Node> blocks, the following
7275 options are available:
7279 =item B<Host> I<Address>
7281 Hostname or address to connect to. Defaults to C<localhost>.
7283 =item B<Port> I<Service>
7285 Service name or port number to connect to. Defaults to C<27017>.
7287 =item B<Timeout> I<Milliseconds>
7289 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
7290 Setting this option to zero means no timeout, which is the default.
7292 =item B<StoreRates> B<false>|B<true>
7294 If set to B<true> (the default), convert counter values to rates. If set to
7295 B<false> counter values are stored as is, i.e. as an increasing integer
7298 =item B<Database> I<Database>
7300 =item B<User> I<User>
7302 =item B<Password> I<Password>
7304 Sets the information used when authenticating to a I<MongoDB> database. The
7305 fields are optional (in which case no authentication is attempted), but if you
7306 want to use authentication all three fields must be set.
7310 =head2 Plugin C<write_http>
7312 This output plugin submits values to an HTTP server using POST requests and
7313 encoding metrics with JSON or using the C<PUTVAL> command described in
7314 L<collectd-unixsock(5)>.
7318 <Plugin "write_http">
7320 URL "http://example.com/post-collectd"
7327 The plugin can send values to multiple HTTP servers by specifying one
7328 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
7329 block, the following options are available:
7335 URL to which the values are submitted to. Mandatory.
7337 =item B<User> I<Username>
7339 Optional user name needed for authentication.
7341 =item B<Password> I<Password>
7343 Optional password needed for authentication.
7345 =item B<VerifyPeer> B<true>|B<false>
7347 Enable or disable peer SSL certificate verification. See
7348 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
7350 =item B<VerifyHost> B<true|false>
7352 Enable or disable peer host name verification. If enabled, the plugin checks if
7353 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
7354 matches the host name provided by the B<URL> option. If this identity check
7355 fails, the connection is aborted. Obviously, only works when connecting to a
7356 SSL enabled server. Enabled by default.
7358 =item B<CACert> I<File>
7360 File that holds one or more SSL certificates. If you want to use HTTPS you will
7361 possibly need this option. What CA certificates come bundled with C<libcurl>
7362 and are checked by default depends on the distribution you use.
7364 =item B<CAPath> I<Directory>
7366 Directory holding one or more CA certificate files. You can use this if for
7367 some reason all the needed CA certificates aren't in the same file and can't be
7368 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
7371 =item B<ClientKey> I<File>
7373 File that holds the private key in PEM format to be used for certificate-based
7376 =item B<ClientCert> I<File>
7378 File that holds the SSL certificate to be used for certificate-based
7381 =item B<ClientKeyPass> I<Password>
7383 Password required to load the private key in B<ClientKey>.
7385 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
7387 Define which SSL protocol version must be used. By default C<libcurl> will
7388 attempt to figure out the remote SSL protocol version. See
7389 L<curl_easy_setopt(3)> for more details.
7391 =item B<Format> B<Command>|B<JSON>
7393 Format of the output to generate. If set to B<Command>, will create output that
7394 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
7395 create output in the I<JavaScript Object Notation> (JSON).
7397 Defaults to B<Command>.
7399 =item B<StoreRates> B<true|false>
7401 If set to B<true>, convert counter values to rates. If set to B<false> (the
7402 default) counter values are stored as is, i.e. as an increasing integer number.
7404 =item B<BufferSize> I<Bytes>
7406 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
7407 requests will be generated, but more metrics will be batched / metrics are
7408 cached for longer before being sent, introducing additional delay until they
7409 are available on the server side. I<Bytes> must be at least 1024 and cannot
7410 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
7411 Defaults to C<4096>.
7413 =item B<LowSpeedLimit> I<Bytes per Second>
7415 Sets the minimal transfer rate in I<Bytes per Second> below which the
7416 connection with the HTTP server will be considered too slow and aborted. All
7417 the data submitted over this connection will probably be lost. Defaults to 0,
7418 which means no minimum transfer rate is enforced.
7420 =item B<Timeout> I<Timeout>
7422 Sets the maximum time in milliseconds given for HTTP POST operations to
7423 complete. When this limit is reached, the POST operation will be aborted, and
7424 all the data in the current send buffer will probably be lost. Defaults to 0,
7425 which means the connection never times out.
7427 The C<write_http> plugin regularly submits the collected values to the HTTP
7428 server. How frequently this happens depends on how much data you are collecting
7429 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
7430 slightly below this interval, which you can estimate by monitoring the network
7431 traffic between collectd and the HTTP server.
7435 =head2 Plugin C<write_kafka>
7437 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
7441 <Plugin "write_kafka">
7442 Property "metadata.broker.list" "broker1:9092,broker2:9092"
7448 The following options are understood by the I<write_kafka plugin>:
7452 =item E<lt>B<Topic> I<Name>E<gt>
7454 The plugin's configuration consists of one or more B<Topic> blocks. Each block
7455 is given a unique I<Name> and specifies one kafka producer.
7456 Inside the B<Topic> block, the following per-topic options are
7461 =item B<Property> I<String> I<String>
7463 Configure the named property for the current topic. Properties are
7464 forwarded to the kafka producer library B<librdkafka>.
7466 =item B<Key> I<String>
7468 Use the specified string as a partioning key for the topic. Kafka breaks
7469 topic into partitions and guarantees that for a given topology, the same
7470 consumer will be used for a specific key. The special (case insensitive)
7471 string B<Random> can be used to specify that an arbitrary partition should
7474 =item B<Format> B<Command>|B<JSON>|B<Graphite>
7476 Selects the format in which messages are sent to the broker. If set to
7477 B<Command> (the default), values are sent as C<PUTVAL> commands which are
7478 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
7480 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
7481 an easy and straight forward exchange format.
7483 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
7484 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
7486 =item B<StoreRates> B<true>|B<false>
7488 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
7489 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
7490 default), no conversion is performed. Otherwise the conversion is performed
7491 using the internal value cache.
7493 Please note that currently this option is only used if the B<Format> option has
7494 been set to B<JSON>.
7496 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
7498 A prefix can be added in the metric name when outputting in the I<Graphite>
7499 format. It's added before the I<Host> name.
7501 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>>
7503 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
7505 A postfix can be added in the metric name when outputting in the I<Graphite>
7506 format. It's added after the I<Host> name.
7508 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>>
7510 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
7512 Specify a character to replace dots (.) in the host part of the metric name.
7513 In I<Graphite> metric name, dots are used as separators between different
7514 metric parts (host, plugin, type).
7515 Default is C<_> (I<Underscore>).
7517 =item B<GraphiteSeparateInstances> B<false>|B<true>
7519 If set to B<true>, the plugin instance and type instance will be in their own
7520 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
7521 default), the plugin and plugin instance (and likewise the type and type
7522 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
7524 =item B<StoreRates> B<true>|B<false>
7526 If set to B<true> (the default), convert counter values to rates. If set to
7527 B<false> counter values are stored as is, i.e. as an increasing integer number.
7529 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7530 converted values will have "rate" appended to the data source type, e.g.
7531 C<ds_type:derive:rate>.
7535 =item B<Property> I<String> I<String>
7537 Configure the kafka producer through properties, you almost always will
7538 want to set B<metadata.broker.list> to your Kafka broker list.
7542 =head2 Plugin C<write_redis>
7544 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
7548 <Plugin "write_redis">
7556 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
7557 the timestamp as the score. Retrieving a date range can then be done using the
7558 C<ZRANGEBYSCORE> I<Redis> command. Additionnally, all the identifiers of these
7559 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> and can be
7560 retrieved using the C<SMEMBERS> I<Redis> command. See
7561 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
7564 The information shown in the synopsis above is the I<default configuration>
7565 which is used by the plugin if no configuration is present.
7567 The plugin can send values to multiple instances of I<Redis> by specifying
7568 one B<Node> block for each instance. Within the B<Node> blocks, the following
7569 options are available:
7573 =item B<Node> I<Nodename>
7575 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
7576 instance running in an specified host and port. The name for node is a
7577 canonical identifier which is used as I<plugin instance>. It is limited to
7578 64E<nbsp>characters in length.
7580 =item B<Host> I<Hostname>
7582 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
7585 =item B<Port> I<Port>
7587 The B<Port> option is the TCP port on which the Redis instance accepts
7588 connections. Either a service name of a port number may be given. Please note
7589 that numerical port numbers must be given as a string, too.
7591 =item B<Timeout> I<Milliseconds>
7593 The B<Timeout> option sets the socket connection timeout, in milliseconds.
7597 =head2 Plugin C<write_riemann>
7599 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
7600 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
7601 I<Riemann> using UDP packets.
7605 <Plugin "write_riemann">
7611 AlwaysAppendDS false
7615 Attribute "foo" "bar"
7618 The following options are understood by the I<write_riemann plugin>:
7622 =item E<lt>B<Node> I<Name>E<gt>
7624 The plugin's configuration consists of one or more B<Node> blocks. Each block
7625 is given a unique I<Name> and specifies one connection to an instance of
7626 I<Riemann>. Indise the B<Node> block, the following per-connection options are
7631 =item B<Host> I<Address>
7633 Hostname or address to connect to. Defaults to C<localhost>.
7635 =item B<Port> I<Service>
7637 Service name or port number to connect to. Defaults to C<5555>.
7639 =item B<Protocol> B<UDP>|B<TCP>
7641 Specify the protocol to use when communicating with I<Riemann>. Defaults to
7644 =item B<Batch> B<true>|B<false>
7646 If set to B<true> and B<Protocol> is set to B<TCP>,
7647 events will be batched in memory and flushed at
7648 regular intervals or when B<BatchMaxSize> is exceeded.
7650 Notifications are not batched and sent as soon as possible.
7652 When enabled, it can occur that events get processed by the Riemann server
7653 close to or after their expiration time. Tune the B<TTLFactor> and
7654 B<BatchMaxSize> settings according to the amount of values collected, if this
7659 =item B<BatchMaxSize> I<size>
7661 Maximum payload size for a riemann packet. Defaults to 8192
7663 =item B<StoreRates> B<true>|B<false>
7665 If set to B<true> (the default), convert counter values to rates. If set to
7666 B<false> counter values are stored as is, i.e. as an increasing integer number.
7668 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
7669 converted values will have "rate" appended to the data source type, e.g.
7670 C<ds_type:derive:rate>.
7672 =item B<AlwaysAppendDS> B<false>|B<true>
7674 If set the B<true>, append the name of the I<Data Source> (DS) to the
7675 "service", i.e. the field that, together with the "host" field, uniquely
7676 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
7677 only done when there is more than one DS.
7679 =item B<TTLFactor> I<Factor>
7681 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
7682 event is considered active. I<collectd> populates this field based on the
7683 metrics interval setting. This setting controls the factor with which the
7684 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
7685 know exactly what you're doing, you should only increase this setting from its
7688 =item B<Notifications> B<false>|B<true>
7690 If set to B<true>, create riemann events for notifications. This is B<true>
7691 by default. When processing thresholds from write_riemann, it might prove
7692 useful to avoid getting notification events.
7694 =item B<CheckThresholds> B<false>|B<true>
7696 If set to B<true>, attach state to events based on thresholds defined
7697 in the B<Threshold> plugin. Defaults to B<false>.
7699 =item B<EventServicePrefix> I<String>
7701 Add the given string as a prefix to the event service name.
7702 If B<EventServicePrefix> not set or set to an empty string (""),
7703 no prefix will be used.
7707 =item B<Tag> I<String>
7709 Add the given string as an additional tag to the metric being sent to
7712 =item B<Attribute> I<String> I<String>
7714 Consider the two given strings to be the key and value of an additional
7715 attribute for each metric being sent out to I<Riemann>.
7719 =head2 Plugin C<write_sensu>
7721 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
7722 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
7723 a local I<Sensu> client using a TCP socket.
7725 At the moment, the I<write_sensu plugin> does not send over a collectd_host
7726 parameter so it is not possible to use one collectd instance as a gateway for
7727 others. Each collectd host must pair with one I<Sensu> client.
7731 <Plugin "write_sensu">
7736 AlwaysAppendDS false
7737 MetricHandler "influx"
7738 MetricHandler "default"
7739 NotificationHandler "flapjack"
7740 NotificationHandler "howling_monkey"
7744 Attribute "foo" "bar"
7747 The following options are understood by the I<write_sensu plugin>:
7751 =item E<lt>B<Node> I<Name>E<gt>
7753 The plugin's configuration consists of one or more B<Node> blocks. Each block
7754 is given a unique I<Name> and specifies one connection to an instance of
7755 I<Sensu>. Inside the B<Node> block, the following per-connection options are
7760 =item B<Host> I<Address>
7762 Hostname or address to connect to. Defaults to C<localhost>.
7764 =item B<Port> I<Service>
7766 Service name or port number to connect to. Defaults to C<3030>.
7768 =item B<StoreRates> B<true>|B<false>
7770 If set to B<true> (the default), convert counter values to rates. If set to
7771 B<false> counter values are stored as is, i.e. as an increasing integer number.
7773 This will be reflected in the C<collectd_data_source_type> tag: If
7774 B<StoreRates> is enabled, converted values will have "rate" appended to the
7775 data source type, e.g. C<collectd_data_source_type:derive:rate>.
7777 =item B<AlwaysAppendDS> B<false>|B<true>
7779 If set the B<true>, append the name of the I<Data Source> (DS) to the
7780 "service", i.e. the field that, together with the "host" field, uniquely
7781 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
7782 only done when there is more than one DS.
7784 =item B<Notifications> B<false>|B<true>
7786 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
7787 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7789 =item B<Metrics> B<false>|B<true>
7791 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
7792 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
7795 =item B<Separator> I<String>
7797 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
7799 =item B<MetricHandler> I<String>
7801 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
7802 several of them, one per line. Defaults to no handler.
7804 =item B<NotificationHandler> I<String>
7806 Add a handler that will be set when notifications are sent to I<Sensu>. You can
7807 add several of them, one per line. Defaults to no handler.
7809 =item B<EventServicePrefix> I<String>
7811 Add the given string as a prefix to the event service name.
7812 If B<EventServicePrefix> not set or set to an empty string (""),
7813 no prefix will be used.
7817 =item B<Tag> I<String>
7819 Add the given string as an additional tag to the metric being sent to
7822 =item B<Attribute> I<String> I<String>
7824 Consider the two given strings to be the key and value of an additional
7825 attribute for each metric being sent out to I<Sensu>.
7829 =head2 Plugin C<zookeeper>
7831 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
7832 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
7837 <Plugin "zookeeper">
7844 =item B<Host> I<Address>
7846 Hostname or address to connect to. Defaults to C<localhost>.
7848 =item B<Port> I<Service>
7850 Service name or port number to connect to. Defaults to C<2181>.
7854 =head1 THRESHOLD CONFIGURATION
7856 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
7857 we mean that the values are not only stored or sent somewhere, but that they
7858 are judged and, if a problem is recognized, acted upon. The only action
7859 collectd takes itself is to generate and dispatch a "notification". Plugins can
7860 register to receive notifications and perform appropriate further actions.
7862 Since systems and what you expect them to do differ a lot, you can configure
7863 B<thresholds> for your values freely. This gives you a lot of flexibility but
7864 also a lot of responsibility.
7866 Every time a value is out of range a notification is dispatched. This means
7867 that the idle percentage of your CPU needs to be less then the configured
7868 threshold only once for a notification to be generated. There's no such thing
7869 as a moving average or similar - at least not now.
7871 Also, all values that match a threshold are considered to be relevant or
7872 "interesting". As a consequence collectd will issue a notification if they are
7873 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7874 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7875 "2" (the default) and some hosts sends it's CPU statistics to the server every
7876 60 seconds, a notification will be dispatched after about 120 seconds. It may
7877 take a little longer because the timeout is checked only once each B<Interval>
7880 When a value comes within range again or is received after it was missing, an
7881 "OKAY-notification" is dispatched.
7883 Here is a configuration example to get you started. Read below for more
7896 <Plugin "interface">
7913 WarningMin 100000000
7919 There are basically two types of configuration statements: The C<Host>,
7920 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7921 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7922 C<Instance> option. You can combine the block by nesting the blocks, though
7923 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7924 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7925 C<Type> may not contain other blocks. If multiple blocks apply to the same
7926 value the most specific block is used.
7928 The other statements specify the threshold to configure. They B<must> be
7929 included in a C<Type> block. Currently the following statements are recognized:
7933 =item B<FailureMax> I<Value>
7935 =item B<WarningMax> I<Value>
7937 Sets the upper bound of acceptable values. If unset defaults to positive
7938 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7939 will be created. If the value is greater than B<WarningMax> but less than (or
7940 equal to) B<FailureMax> a B<WARNING> notification will be created.
7942 =item B<FailureMin> I<Value>
7944 =item B<WarningMin> I<Value>
7946 Sets the lower bound of acceptable values. If unset defaults to negative
7947 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7948 be created. If the value is less than B<WarningMin> but greater than (or equal
7949 to) B<FailureMin> a B<WARNING> notification will be created.
7951 =item B<DataSource> I<DSName>
7953 Some data sets have more than one "data source". Interesting examples are the
7954 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7955 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7956 system load data set, C<load>, even has three data sources: C<shortterm>,
7957 C<midterm>, and C<longterm>.
7959 Normally, all data sources are checked against a configured threshold. If this
7960 is undesirable, or if you want to specify different limits for each data
7961 source, you can use the B<DataSource> option to have a threshold apply only to
7964 =item B<Invert> B<true>|B<false>
7966 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7967 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7968 B<WarningMax>) are not okay. Defaults to B<false>.
7970 =item B<Persist> B<true>|B<false>
7972 Sets how often notifications are generated. If set to B<true> one notification
7973 will be generated for each value that is out of the acceptable range. If set to
7974 B<false> (the default) then a notification is only generated if a value is out
7975 of range but the previous value was okay.
7977 This applies to missing values, too: If set to B<true> a notification about a
7978 missing value is generated once every B<Interval> seconds. If set to B<false>
7979 only one such notification is generated until the value appears again.
7981 =item B<Percentage> B<true>|B<false>
7983 If set to B<true>, the minimum and maximum values given are interpreted as
7984 percentage value, relative to the other data sources. This is helpful for
7985 example for the "df" type, where you may want to issue a warning when less than
7986 5E<nbsp>% of the total space is available. Defaults to B<false>.
7988 =item B<Hits> I<Number>
7990 Delay creating the notification until the threshold has been passed I<Number>
7991 times. When a notification has been generated, or when a subsequent value is
7992 inside the threshold, the counter is reset. If, for example, a value is
7993 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7994 will be dispatched at most once every 30E<nbsp>seconds.
7996 This is useful when short bursts are not a problem. If, for example, 100% CPU
7997 usage for up to a minute is normal (and data is collected every
7998 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
8000 =item B<Hysteresis> I<Number>
8002 When set to non-zero, a hysteresis value is applied when checking minimum and
8003 maximum bounds. This is useful for values that increase slowly and fluctuate a
8004 bit while doing so. When these values come close to the threshold, they may
8005 "flap", i.e. switch between failure / warning case and okay case repeatedly.
8007 If, for example, the threshold is configures as
8012 then a I<Warning> notification is created when the value exceeds I<101> and the
8013 corresponding I<Okay> notification is only created once the value falls below
8014 I<99>, thus avoiding the "flapping".
8018 =head1 FILTER CONFIGURATION
8020 Starting with collectd 4.6 there is a powerful filtering infrastructure
8021 implemented in the daemon. The concept has mostly been copied from
8022 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
8023 terminology, so that users that are familiar with iptables feel right at home.
8027 The following are the terms used in the remainder of the filter configuration
8028 documentation. For an ASCII-art schema of the mechanism, see
8029 L<"General structure"> below.
8035 A I<match> is a criteria to select specific values. Examples are, of course, the
8036 name of the value or it's current value.
8038 Matches are implemented in plugins which you have to load prior to using the
8039 match. The name of such plugins starts with the "match_" prefix.
8043 A I<target> is some action that is to be performed with data. Such actions
8044 could, for example, be to change part of the value's identifier or to ignore
8045 the value completely.
8047 Some of these targets are built into the daemon, see L<"Built-in targets">
8048 below. Other targets are implemented in plugins which you have to load prior to
8049 using the target. The name of such plugins starts with the "target_" prefix.
8053 The combination of any number of matches and at least one target is called a
8054 I<rule>. The target actions will be performed for all values for which B<all>
8055 matches apply. If the rule does not have any matches associated with it, the
8056 target action will be performed for all values.
8060 A I<chain> is a list of rules and possibly default targets. The rules are tried
8061 in order and if one matches, the associated target will be called. If a value
8062 is handled by a rule, it depends on the target whether or not any subsequent
8063 rules are considered or if traversal of the chain is aborted, see
8064 L<"Flow control"> below. After all rules have been checked, the default targets
8069 =head2 General structure
8071 The following shows the resulting structure:
8078 +---------+ +---------+ +---------+ +---------+
8079 ! Rule !->! Match !->! Match !->! Target !
8080 +---------+ +---------+ +---------+ +---------+
8083 +---------+ +---------+ +---------+
8084 ! Rule !->! Target !->! Target !
8085 +---------+ +---------+ +---------+
8092 +---------+ +---------+ +---------+
8093 ! Rule !->! Match !->! Target !
8094 +---------+ +---------+ +---------+
8104 There are four ways to control which way a value takes through the filter
8111 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
8112 process the value with another chain. When the called chain finishes, usually
8113 the next target or rule after the jump is executed.
8117 The stop condition, signaled for example by the built-in target B<stop>, causes
8118 all processing of the value to be stopped immediately.
8122 Causes processing in the current chain to be aborted, but processing of the
8123 value generally will continue. This means that if the chain was called via
8124 B<Jump>, the next target or rule after the jump will be executed. If the chain
8125 was not called by another chain, control will be returned to the daemon and it
8126 may pass the value to another chain.
8130 Most targets will signal the B<continue> condition, meaning that processing
8131 should continue normally. There is no special built-in target for this
8138 The configuration reflects this structure directly:
8140 PostCacheChain "PostCache"
8142 <Rule "ignore_mysql_show">
8145 Type "^mysql_command$"
8146 TypeInstance "^show_"
8156 The above configuration example will ignore all values where the plugin field
8157 is "mysql", the type is "mysql_command" and the type instance begins with
8158 "show_". All other values will be sent to the C<rrdtool> write plugin via the
8159 default target of the chain. Since this chain is run after the value has been
8160 added to the cache, the MySQL C<show_*> command statistics will be available
8161 via the C<unixsock> plugin.
8163 =head2 List of configuration options
8167 =item B<PreCacheChain> I<ChainName>
8169 =item B<PostCacheChain> I<ChainName>
8171 Configure the name of the "pre-cache chain" and the "post-cache chain". The
8172 argument is the name of a I<chain> that should be executed before and/or after
8173 the values have been added to the cache.
8175 To understand the implications, it's important you know what is going on inside
8176 I<collectd>. The following diagram shows how values are passed from the
8177 read-plugins to the write-plugins:
8183 + - - - - V - - - - +
8184 : +---------------+ :
8187 : +-------+-------+ :
8190 : +-------+-------+ : +---------------+
8191 : ! Cache !--->! Value Cache !
8192 : ! insert ! : +---+---+-------+
8193 : +-------+-------+ : ! !
8194 : ! ,------------' !
8196 : +-------+---+---+ : +-------+-------+
8197 : ! Post-Cache +--->! Write-Plugins !
8198 : ! Chain ! : +---------------+
8199 : +---------------+ :
8202 + - - - - - - - - - +
8204 After the values are passed from the "read" plugins to the dispatch functions,
8205 the pre-cache chain is run first. The values are added to the internal cache
8206 afterwards. The post-cache chain is run after the values have been added to the
8207 cache. So why is it such a huge deal if chains are run before or after the
8208 values have been added to this cache?
8210 Targets that change the identifier of a value list should be executed before
8211 the values are added to the cache, so that the name in the cache matches the
8212 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
8213 this cache to receive a list of all available values. If you change the
8214 identifier after the value list has been added to the cache, this may easily
8215 lead to confusion, but it's not forbidden of course.
8217 The cache is also used to convert counter values to rates. These rates are, for
8218 example, used by the C<value> match (see below). If you use the rate stored in
8219 the cache B<before> the new value is added, you will use the old, B<previous>
8220 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
8221 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
8224 Last but not last, the B<stop> target makes a difference: If the pre-cache
8225 chain returns the stop condition, the value will not be added to the cache and
8226 the post-cache chain will not be run.
8228 =item B<Chain> I<Name>
8230 Adds a new chain with a certain name. This name can be used to refer to a
8231 specific chain, for example to jump to it.
8233 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
8235 =item B<Rule> [I<Name>]
8237 Adds a new rule to the current chain. The name of the rule is optional and
8238 currently has no meaning for the daemon.
8240 Within the B<Rule> block, there may be any number of B<Match> blocks and there
8241 must be at least one B<Target> block.
8243 =item B<Match> I<Name>
8245 Adds a match to a B<Rule> block. The name specifies what kind of match should
8246 be performed. Available matches depend on the plugins that have been loaded.
8248 The arguments inside the B<Match> block are passed to the plugin implementing
8249 the match, so which arguments are valid here depends on the plugin being used.
8250 If you do not need any to pass any arguments to a match, you can use the
8255 Which is equivalent to:
8260 =item B<Target> I<Name>
8262 Add a target to a rule or a default target to a chain. The name specifies what
8263 kind of target is to be added. Which targets are available depends on the
8264 plugins being loaded.
8266 The arguments inside the B<Target> block are passed to the plugin implementing
8267 the target, so which arguments are valid here depends on the plugin being used.
8268 If you do not need any to pass any arguments to a target, you can use the
8273 This is the same as writing:
8280 =head2 Built-in targets
8282 The following targets are built into the core daemon and therefore need no
8283 plugins to be loaded:
8289 Signals the "return" condition, see the L<"Flow control"> section above. This
8290 causes the current chain to stop processing the value and returns control to
8291 the calling chain. The calling chain will continue processing targets and rules
8292 just after the B<jump> target (see below). This is very similar to the
8293 B<RETURN> target of iptables, see L<iptables(8)>.
8295 This target does not have any options.
8303 Signals the "stop" condition, see the L<"Flow control"> section above. This
8304 causes processing of the value to be aborted immediately. This is similar to
8305 the B<DROP> target of iptables, see L<iptables(8)>.
8307 This target does not have any options.
8315 Sends the value to "write" plugins.
8321 =item B<Plugin> I<Name>
8323 Name of the write plugin to which the data should be sent. This option may be
8324 given multiple times to send the data to more than one write plugin. If the
8325 plugin supports multiple instances, the plugin's instance(s) must also be
8330 If no plugin is explicitly specified, the values will be sent to all available
8333 Single-instance plugin example:
8339 Multi-instance plugin example:
8341 <Plugin "write_graphite">
8351 Plugin "write_graphite/foo"
8356 Starts processing the rules of another chain, see L<"Flow control"> above. If
8357 the end of that chain is reached, or a stop condition is encountered,
8358 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
8359 next target or the next rule. This is similar to the B<-j> command line option
8360 of iptables, see L<iptables(8)>.
8366 =item B<Chain> I<Name>
8368 Jumps to the chain I<Name>. This argument is required and may appear only once.
8380 =head2 Available matches
8386 Matches a value using regular expressions.
8392 =item B<Host> I<Regex>
8394 =item B<Plugin> I<Regex>
8396 =item B<PluginInstance> I<Regex>
8398 =item B<Type> I<Regex>
8400 =item B<TypeInstance> I<Regex>
8402 Match values where the given regular expressions match the various fields of
8403 the identifier of a value. If multiple regular expressions are given, B<all>
8404 regexen must match for a value to match.
8406 =item B<Invert> B<false>|B<true>
8408 When set to B<true>, the result of the match is inverted, i.e. all value lists
8409 where all regular expressions apply are not matched, all other value lists are
8410 matched. Defaults to B<false>.
8417 Host "customer[0-9]+"
8423 Matches values that have a time which differs from the time on the server.
8425 This match is mainly intended for servers that receive values over the
8426 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
8427 is very sensitive to the timestamp used when updating the RRD files. In
8428 particular, the time must be ever increasing. If a misbehaving client sends one
8429 packet with a timestamp far in the future, all further packets with a correct
8430 time will be ignored because of that one packet. What's worse, such corrupted
8431 RRD files are hard to fix.
8433 This match lets one match all values B<outside> a specified time range
8434 (relative to the server's time), so you can use the B<stop> target (see below)
8435 to ignore the value, for example.
8441 =item B<Future> I<Seconds>
8443 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
8444 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8447 =item B<Past> I<Seconds>
8449 Matches all values that are I<behind> of the server's time by I<Seconds> or
8450 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
8462 This example matches all values that are five minutes or more ahead of the
8463 server or one hour (or more) lagging behind.
8467 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
8468 values. If a data-set consists of more than one data-source, all data-sources
8469 must match the specified ranges for a positive match.
8475 =item B<Min> I<Value>
8477 Sets the smallest value which still results in a match. If unset, behaves like
8480 =item B<Max> I<Value>
8482 Sets the largest value which still results in a match. If unset, behaves like
8485 =item B<Invert> B<true>|B<false>
8487 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
8488 no-match is returned and vice versa. Please note that the B<Invert> setting
8489 only effects how B<Min> and B<Max> are applied to a specific value. Especially
8490 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
8492 =item B<DataSource> I<DSName> [I<DSName> ...]
8494 Select one or more of the data sources. If no data source is configured, all
8495 data sources will be checked. If the type handled by the match does not have a
8496 data source of the specified name(s), this will always result in no match
8497 (independent of the B<Invert> setting).
8499 =item B<Satisfy> B<Any>|B<All>
8501 Specifies how checking with several data sources is performed. If set to
8502 B<Any>, the match succeeds if one of the data sources is in the configured
8503 range. If set to B<All> the match only succeeds if all data sources are within
8504 the configured range. Default is B<All>.
8506 Usually B<All> is used for positive matches, B<Any> is used for negative
8507 matches. This means that with B<All> you usually check that all values are in a
8508 "good" range, while with B<Any> you check if any value is within a "bad" range
8509 (or outside the "good" range).
8513 Either B<Min> or B<Max>, but not both, may be unset.
8517 # Match all values smaller than or equal to 100. Matches only if all data
8518 # sources are below 100.
8524 # Match if the value of any data source is outside the range of 0 - 100.
8532 =item B<empty_counter>
8534 Matches all values with one or more data sources of type B<COUNTER> and where
8535 all counter values are zero. These counters usually I<never> increased since
8536 they started existing (and are therefore uninteresting), or got reset recently
8537 or overflowed and you had really, I<really> bad luck.
8539 Please keep in mind that ignoring such counters can result in confusing
8540 behavior: Counters which hardly ever increase will be zero for long periods of
8541 time. If the counter is reset for some reason (machine or service restarted,
8542 usually), the graph will be empty (NAN) for a long time. People may not
8547 Calculates a hash value of the host name and matches values according to that
8548 hash value. This makes it possible to divide all hosts into groups and match
8549 only values that are in a specific group. The intended use is in load
8550 balancing, where you want to handle only part of all data and leave the rest
8553 The hashing function used tries to distribute the hosts evenly. First, it
8554 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
8557 for (i = 0; host[i] != 0; i++)
8558 hash_value = (hash_value * 251) + host[i];
8560 The constant 251 is a prime number which is supposed to make this hash value
8561 more random. The code then checks the group for this host according to the
8562 I<Total> and I<Match> arguments:
8564 if ((hash_value % Total) == Match)
8569 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
8570 groups), then the least significant bit of the hash value will be the XOR of
8571 all least significant bits in the host name. One consequence is that when you
8572 have two hosts, "server0.example.com" and "server1.example.com", where the host
8573 name differs in one digit only and the digits differ by one, those hosts will
8574 never end up in the same group.
8580 =item B<Match> I<Match> I<Total>
8582 Divide the data into I<Total> groups and match all hosts in group I<Match> as
8583 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
8584 be smaller than I<Total>. I<Total> must be at least one, although only values
8585 greater than one really do make any sense.
8587 You can repeat this option to match multiple groups, for example:
8592 The above config will divide the data into seven groups and match groups three
8593 and five. One use would be to keep every value on two hosts so that if one
8594 fails the missing data can later be reconstructed from the second host.
8600 # Operate on the pre-cache chain, so that ignored values are not even in the
8605 # Divide all received hosts in seven groups and accept all hosts in
8609 # If matched: Return and continue.
8612 # If not matched: Return and stop.
8618 =head2 Available targets
8622 =item B<notification>
8624 Creates and dispatches a notification.
8630 =item B<Message> I<String>
8632 This required option sets the message of the notification. The following
8633 placeholders will be replaced by an appropriate value:
8641 =item B<%{plugin_instance}>
8645 =item B<%{type_instance}>
8647 These placeholders are replaced by the identifier field of the same name.
8649 =item B<%{ds:>I<name>B<}>
8651 These placeholders are replaced by a (hopefully) human readable representation
8652 of the current rate of this data source. If you changed the instance name
8653 (using the B<set> or B<replace> targets, see below), it may not be possible to
8654 convert counter values to rates.
8658 Please note that these placeholders are B<case sensitive>!
8660 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
8662 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
8669 <Target "notification">
8670 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
8676 Replaces parts of the identifier using regular expressions.
8682 =item B<Host> I<Regex> I<Replacement>
8684 =item B<Plugin> I<Regex> I<Replacement>
8686 =item B<PluginInstance> I<Regex> I<Replacement>
8688 =item B<TypeInstance> I<Regex> I<Replacement>
8690 Match the appropriate field with the given regular expression I<Regex>. If the
8691 regular expression matches, that part that matches is replaced with
8692 I<Replacement>. If multiple places of the input buffer match a given regular
8693 expression, only the first occurrence will be replaced.
8695 You can specify each option multiple times to use multiple regular expressions
8703 # Replace "example.net" with "example.com"
8704 Host "\\<example.net\\>" "example.com"
8706 # Strip "www." from hostnames
8712 Sets part of the identifier of a value to a given string.
8718 =item B<Host> I<String>
8720 =item B<Plugin> I<String>
8722 =item B<PluginInstance> I<String>
8724 =item B<TypeInstance> I<String>
8726 Set the appropriate field to the given string. The strings for plugin instance
8727 and type instance may be empty, the strings for host and plugin may not be
8728 empty. It's currently not possible to set the type of a value this way.
8735 PluginInstance "coretemp"
8736 TypeInstance "core3"
8741 =head2 Backwards compatibility
8743 If you use collectd with an old configuration, i.E<nbsp>e. one without a
8744 B<Chain> block, it will behave as it used to. This is equivalent to the
8745 following configuration:
8751 If you specify a B<PostCacheChain>, the B<write> target will not be added
8752 anywhere and you will have to make sure that it is called where appropriate. We
8753 suggest to add the above snippet as default target to your "PostCache" chain.
8757 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
8773 L<collectd-exec(5)>,
8774 L<collectd-perl(5)>,
8775 L<collectd-unixsock(5)>,
8788 Florian Forster E<lt>octo@collectd.orgE<gt>