5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/path/to/data/"
10 PIDFile "/path/to/pidfile/collectd.pid"
11 Server "123.123.123.123" 12345
28 This config file controls how the system statistics collection daemon
29 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
30 controls which plugins to load. These plugins ultimately define collectd's
33 The syntax of this config file is similar to the config file of the famous
34 I<Apache> webserver. Each line contains either an option (a key and a list of
35 one or more values) or a section-start or -end. Empty lines and everything
36 after a non-quoted hash-symbol (C<#>) is ignored. I<Keys> are unquoted
37 strings, consisting only of alphanumeric characters and the underscore (C<_>)
38 character. Keys are handled case insensitive by I<collectd> itself and all
39 plugins included with it. I<Values> can either be an I<unquoted string>, a
40 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
41 expression. I<Unquoted strings> consist of only alphanumeric characters and
42 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
43 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
44 to include double quotes as part of the string. I<Numbers> can be specified in
45 decimal and floating point format (using a dot C<.> as decimal separator),
46 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
47 I<Boolean> values are either B<true> or B<false>.
49 Lines may be wrapped by using C<\> as the last character before the newline.
50 This allows long lines to be split into multiple lines. Quoted strings may be
51 wrapped as well. However, those are treated special in that whitespace at the
52 beginning of the following lines will be ignored, which allows for nicely
53 indenting the wrapped lines.
55 The configuration is read and processed in order, i.e. from top to bottom. So
56 the plugins are loaded in the order listed in this config file. It is a good
57 idea to load any logging plugins first in order to catch messages from plugins
58 during configuration. Also, the C<LoadPlugin> option B<must> occur B<before>
59 the appropriate C<E<lt>Plugin ...E<gt>> block.
65 =item B<BaseDir> I<Directory>
67 Sets the base directory. This is the directory beneath all RRD-files are
68 created. Possibly more subdirectories are created. This is also the working
69 directory for the daemon.
71 =item B<LoadPlugin> I<Plugin>
73 Loads the plugin I<Plugin>. This is required to load plugins, unless the
74 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
75 I<collectd> will be mostly useless.
77 Only the first B<LoadPlugin> statement or block for a given plugin name has any
78 effect. This is useful when you want to split up the configuration into smaller
79 files and want each file to be "self contained", i.e. it contains a B<Plugin>
80 block I<and> then appropriate B<LoadPlugin> statement. The downside is that if
81 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
82 different intervals, only one of them (the first one encountered) will take
83 effect and all others will be silently ignored.
85 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
86 with additional options, affecting the behavior of B<LoadPlugin>. A simple
87 statement looks like this:
91 Options inside a B<LoadPlugin> block can override default settings and
92 influence the way plugins are loaded, e.g.:
99 The following options are valid inside B<LoadPlugin> blocks:
103 =item B<Globals> B<true|false>
105 If enabled, collectd will export all global symbols of the plugin (and of all
106 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
107 available for resolving unresolved symbols in subsequently loaded plugins if
108 that is supported by your system.
110 This is useful (or possibly even required), e.g., when loading a plugin that
111 embeds some scripting language into the daemon (e.g. the I<Perl> and
112 I<Python plugins>). Scripting languages usually provide means to load
113 extensions written in C. Those extensions require symbols provided by the
114 interpreter, which is loaded as a dependency of the respective collectd plugin.
115 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
116 L<collectd-python(5)>) for details.
118 By default, this is disabled. As a special exception, if the plugin name is
119 either C<perl> or C<python>, the default is changed to enabled in order to keep
120 the average user from ever having to deal with this low level linking stuff.
122 =item B<Interval> I<Seconds>
124 Sets a plugin-specific interval for collecting metrics. This overrides the
125 global B<Interval> setting. If a plugin provides own support for specifying an
126 interval, that setting will take precedence.
130 =item B<AutoLoadPlugin> B<false>|B<true>
132 When set to B<false> (the default), each plugin needs to be loaded explicitly,
133 using the B<LoadPlugin> statement documented above. If a
134 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
135 handling callback for this plugin has been registered, a warning is logged and
136 the block is ignored.
138 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
139 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
140 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
141 plugins that don't provide any configuration, e.g. the I<Load plugin>.
143 =item B<Include> I<Path> [I<pattern>]
145 If I<Path> points to a file, includes that file. If I<Path> points to a
146 directory, recursively includes all files within that directory and its
147 subdirectories. If the C<wordexp> function is available on your system,
148 shell-like wildcards are expanded before files are included. This means you can
149 use statements like the following:
151 Include "/etc/collectd.d/*.conf"
153 Starting with version 5.3, this may also be a block in which further options
154 affecting the behavior of B<Include> may be specified. The following option is
157 <Include "/etc/collectd.d">
163 =item B<Filter> I<pattern>
165 If the C<fnmatch> function is available on your system, a shell-like wildcard
166 I<pattern> may be specified to filter which files to include. This may be used
167 in combination with recursively including a directory to easily be able to
168 arbitrarily mix configuration files and other documents (e.g. README files).
169 The given example is similar to the first example above but includes all files
170 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
172 Include "/etc/collectd.d" "*.conf"
176 If more than one files are included by a single B<Include> option, the files
177 will be included in lexicographical order (as defined by the C<strcmp>
178 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
179 order in which the files are loaded.
181 To prevent loops and shooting yourself in the foot in interesting ways the
182 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
183 most uses. Since symlinks are followed it is still possible to crash the daemon
184 by looping symlinks. In our opinion significant stupidity should result in an
185 appropriate amount of pain.
187 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
188 file, but you cannot include files from within blocks.
190 =item B<PIDFile> I<File>
192 Sets where to write the PID file to. This file is overwritten when it exists
193 and deleted when the program is stopped. Some init-scripts might override this
194 setting using the B<-P> command-line option.
196 =item B<PluginDir> I<Directory>
198 Path to the plugins (shared objects) of collectd.
200 =item B<TypesDB> I<File> [I<File> ...]
202 Set one or more files that contain the data-set descriptions. See
203 L<types.db(5)> for a description of the format of this file.
205 =item B<Interval> I<Seconds>
207 Configures the interval in which to query the read plugins. Obviously smaller
208 values lead to a higher system load produced by collectd, while higher values
209 lead to more coarse statistics.
211 B<Warning:> You should set this once and then never touch it again. If you do,
212 I<you will have to delete all your RRD files> or know some serious RRDtool
213 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
215 =item B<Timeout> I<Iterations>
217 Consider a value list "missing" when no update has been read or received for
218 I<Iterations> iterations. By default, I<collectd> considers a value list
219 missing when no update has been received for twice the update interval. Since
220 this setting uses iterations, the maximum allowed time without update depends
221 on the I<Interval> information contained in each value list. This is used in
222 the I<Threshold> configuration to dispatch notifications about missing values,
223 see L<collectd-threshold(5)> for details.
225 =item B<ReadThreads> I<Num>
227 Number of threads to start for reading plugins. The default value is B<5>, but
228 you may want to increase this if you have more than five plugins that take a
229 long time to read. Mostly those are plugins that do network-IO. Setting this to
230 a value higher than the number of registered read callbacks is not recommended.
232 =item B<WriteThreads> I<Num>
234 Number of threads to start for dispatching value lists to write plugins. The
235 default value is B<5>, but you may want to increase this if you have more than
236 five plugins that may take relatively long to write to.
238 =item B<WriteQueueLimitHigh> I<HighNum>
240 =item B<WriteQueueLimitLow> I<LowNum>
242 Metrics are read by the I<read threads> and then put into a queue to be handled
243 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
244 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
245 running into memory issues in such a case, you can limit the size of this
248 By default, there is no limit and memory may grow indefinitely. This is most
249 likely not an issue for clients, i.e. instances that only handle the local
250 metrics. For servers it is recommended to set this to a non-zero value, though.
252 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
253 Each of them takes a numerical argument which is the number of metrics in the
254 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
255 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
256 I<will> be enqueued. If the number of metrics currently in the queue is between
257 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
258 proportional to the number of metrics in the queue (i.e. it increases linearly
259 until it reaches 100%.)
261 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
262 unset, the latter will default to half of B<WriteQueueLimitHigh>.
264 If you do not want to randomly drop values when the queue size is between
265 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
266 B<WriteQueueLimitLow> to same value.
268 =item B<Hostname> I<Name>
270 Sets the hostname that identifies a host. If you omit this setting, the
271 hostname will be determined using the L<gethostname(2)> system call.
273 =item B<FQDNLookup> B<true|false>
275 If B<Hostname> is determined automatically this setting controls whether or not
276 the daemon should try to figure out the "fully qualified domain name", FQDN.
277 This is done using a lookup of the name returned by C<gethostname>. This option
278 is enabled by default.
280 =item B<PreCacheChain> I<ChainName>
282 =item B<PostCacheChain> I<ChainName>
284 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
285 see L<FILTER CONFIGURATION> below on information on chains and how these
286 setting change the daemon's behavior.
290 =head1 PLUGIN OPTIONS
292 Some plugins may register own options. These options must be enclosed in a
293 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
294 require external configuration, too. The C<apache plugin>, for example,
295 required C<mod_status> to be configured in the webserver you're going to
296 collect data from. These plugins are listed below as well, even if they don't
297 require any configuration within collectd's configuration file.
299 A list of all plugins and a short summary for each plugin can be found in the
300 F<README> file shipped with the sourcecode and hopefully binary packets as
303 =head2 Plugin C<aggregation>
305 The I<Aggregation plugin> makes it possible to aggregate several values into
306 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
307 This can be put to a wide variety of uses, e.g. average and total CPU
308 statistics for your entire fleet.
310 The grouping is powerful but, as with many powerful tools, may be a bit
311 difficult to wrap your head around. The grouping will therefore be
312 demonstrated using an example: The average and sum of the CPU usage across
313 all CPUs of each host is to be calculated.
315 To select all the affected values for our example, set C<Plugin cpu> and
316 C<Type cpu>. The other values are left unspecified, meaning "all values". The
317 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
318 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
324 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
325 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
326 example, the intention is to have a new value for each host / type instance
327 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
328 It can be specified multiple times to group by more than one field.
331 GroupBy "TypeInstance"
333 We do neither specify nor group by I<plugin instance> (the CPU number), so all
334 metrics that differ in the CPU number only will be aggregated. Each
335 aggregation needs I<at least one> such field, otherwise no aggregation would
338 The full example configuration looks like this:
340 <Plugin "aggregation">
346 GroupBy "TypeInstance"
349 CalculateAverage true
353 There are a couple of limitations you should be aware of:
359 The I<Type> cannot be left unspecified, because it is not reasonable to add
360 apples to oranges. Also, the internal lookup structure won't work if you try
365 There must be at least one unspecified, ungrouped field. Otherwise nothing
370 As you can see in the example above, each aggregation has its own
371 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
372 blocks may match the same values, i.e. one value list can update multiple
373 aggregations. The following options are valid inside B<Aggregation> blocks:
377 =item B<Host> I<Host>
379 =item B<Plugin> I<Plugin>
381 =item B<PluginInstance> I<PluginInstance>
383 =item B<Type> I<Type>
385 =item B<TypeInstance> I<TypeInstance>
387 Selects the value lists to be added to this aggregation. B<Type> must be a
388 valid data set name, see L<types.db(5)> for details.
390 If the string starts with and ends with a slash (C</>), the string is
391 interpreted as a I<regular expression>. The regex flavor used are POSIX
392 extended regular expressions as described in L<regex(7)>. Example usage:
394 Host "/^db[0-9]\\.example\\.com$/"
396 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
398 Group valued by the specified field. The B<GroupBy> option may be repeated to
399 group by multiple fields.
401 =item B<SetHost> I<Host>
403 =item B<SetPlugin> I<Plugin>
405 =item B<SetPluginInstance> I<PluginInstance>
407 =item B<SetTypeInstance> I<TypeInstance>
409 Sets the appropriate part of the identifier to the provided string.
411 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
412 will be replaced with the aggregation function, e.g. "average". Not including
413 the placeholder will result in duplication warnings and/or messed up values if
414 more than one aggregation function are enabled.
416 The following example calculates the average usage of all "even" CPUs:
418 <Plugin "aggregation">
421 PluginInstance "/[0,2,4,6,8]$/"
425 SetPluginInstance "even-%{aggregation}"
428 GroupBy "TypeInstance"
430 CalculateAverage true
434 This will create the files:
440 foo.example.com/cpu-even-average/cpu-idle
444 foo.example.com/cpu-even-average/cpu-system
448 foo.example.com/cpu-even-average/cpu-user
456 =item B<CalculateNum> B<true>|B<false>
458 =item B<CalculateSum> B<true>|B<false>
460 =item B<CalculateAverage> B<true>|B<false>
462 =item B<CalculateMinimum> B<true>|B<false>
464 =item B<CalculateMaximum> B<true>|B<false>
466 =item B<CalculateStddev> B<true>|B<false>
468 Boolean options for enabling calculation of the number of value lists, their
469 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
470 are disabled by default.
474 =head2 Plugin C<amqp>
476 The I<AMQMP plugin> can be used to communicate with other instances of
477 I<collectd> or third party applications using an AMQP message broker. Values
478 are sent to or received from the broker, which handles routing, queueing and
479 possibly filtering or messages.
482 # Send values to an AMQP broker
483 <Publish "some_name">
489 Exchange "amq.fanout"
490 # ExchangeType "fanout"
491 # RoutingKey "collectd"
495 # GraphitePrefix "collectd."
496 # GraphiteEscapeChar "_"
497 # GraphiteSeparateInstances false
498 # GraphiteAlwaysAppendDS false
501 # Receive values from an AMQP broker
502 <Subscribe "some_name">
508 Exchange "amq.fanout"
509 # ExchangeType "fanout"
512 # QueueAutoDelete true
513 # RoutingKey "collectd.#"
517 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
518 blocks, which configure sending and receiving of values respectively. The two
519 blocks are very similar, so unless otherwise noted, an option can be used in
520 either block. The name given in the blocks starting tag is only used for
521 reporting messages, but may be used to support I<flushing> of certain
522 I<Publish> blocks in the future.
526 =item B<Host> I<Host>
528 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
529 the underlying communications library, I<rabbitmq-c>, which is "localhost".
531 =item B<Port> I<Port>
533 Service name or port number on which the AMQP broker accepts connections. This
534 argument must be a string, even if the numeric form is used. Defaults to
537 =item B<VHost> I<VHost>
539 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
541 =item B<User> I<User>
543 =item B<Password> I<Password>
545 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
548 =item B<Exchange> I<Exchange>
550 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
551 By default, "amq.fanout" will be used.
553 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
554 the given exchange and the I<queue> is created, using the I<routing key> if
555 configured. See the B<Queue> and B<RoutingKey> options below.
557 =item B<ExchangeType> I<Type>
559 If given, the plugin will try to create the configured I<exchange> with this
560 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
561 be bound to this exchange.
563 =item B<Queue> I<Queue> (Subscribe only)
565 Configures the I<queue> name to subscribe to. If no queue name was configured
566 explicitly, a unique queue name will be created by the broker.
568 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
570 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
571 or transient (will disappear if the AMQP broker is restarted). Defaults to
574 This option should be used in conjunction with the I<Persistent> option on the
577 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
579 Defines if the I<queue> subscribed to will be deleted once the last consumer
580 unsubscribes. Defaults to "true".
582 =item B<RoutingKey> I<Key>
584 In I<Publish> blocks, this configures the routing key to set on all outgoing
585 messages. If not given, the routing key will be computed from the I<identifier>
586 of the value. The host, plugin, type and the two instances are concatenated
587 together using dots as the separator and all containing dots replaced with
588 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
589 possible to receive only specific values using a "topic" exchange.
591 In I<Subscribe> blocks, configures the I<routing key> used when creating a
592 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
593 used to filter messages when using a "topic" exchange. If you're only
594 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
597 =item B<Persistent> B<true>|B<false> (Publish only)
599 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
600 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
601 default), the I<transient> delivery mode will be used, i.e. messages may be
602 lost due to high load, overflowing queues or similar issues.
604 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
606 Selects the format in which messages are sent to the broker. If set to
607 B<Command> (the default), values are sent as C<PUTVAL> commands which are
608 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
609 case, the C<Content-Type> header field will be set to C<text/collectd>.
611 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
612 an easy and straight forward exchange format. The C<Content-Type> header field
613 will be set to C<application/json>.
615 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
616 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
619 A subscribing client I<should> use the C<Content-Type> header field to
620 determine how to decode the values. Currently, the I<AMQP plugin> itself can
621 only decode the B<Command> format.
623 =item B<StoreRates> B<true>|B<false> (Publish only)
625 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
626 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
627 default), no conversion is performed. Otherwise the conversion is performed
628 using the internal value cache.
630 Please note that currently this option is only used if the B<Format> option has
633 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
635 A prefix can be added in the metric name when outputting in the I<Graphite> format.
636 It's added before the I<Host> name.
637 Metric name will be "<prefix><host><postfix><plugin><type><name>"
639 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
641 A postfix can be added in the metric name when outputting in the I<Graphite> format.
642 It's added after the I<Host> name.
643 Metric name will be "<prefix><host><postfix><plugin><type><name>"
645 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
647 Specify a character to replace dots (.) in the host part of the metric name.
648 In I<Graphite> metric name, dots are used as separators between different
649 metric parts (host, plugin, type).
650 Default is "_" (I<Underscore>).
652 =item B<GraphiteSeparateInstances> B<true>|B<false>
654 If set to B<true>, the plugin instance and type instance will be in their own
655 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
656 default), the plugin and plugin instance (and likewise the type and type
657 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
659 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
661 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
662 identifier. If set to B<false> (the default), this is only done when there is
667 =head2 Plugin C<apache>
669 To configure the C<apache>-plugin you first need to configure the Apache
670 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
671 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
672 the following snipped to base your Apache config upon:
675 <IfModule mod_status.c>
676 <Location /mod_status>
677 SetHandler server-status
681 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
682 also supported. It introduces a new field, called C<BusyServers>, to count the
683 number of currently connected clients. This field is also supported.
685 The configuration of the I<Apache> plugin consists of one or more
686 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
687 as the instance name. For example:
691 URL "http://www1.example.com/mod_status?auto"
694 URL "http://www2.example.com/mod_status?auto"
698 The instance name will be used as the I<plugin instance>. To emulate the old
699 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
700 plugin to work correctly, each instance name must be unique. This is not
701 enforced by the plugin and it is your responsibility to ensure it.
703 The following options are accepted within each I<Instance> block:
707 =item B<URL> I<http://host/mod_status?auto>
709 Sets the URL of the C<mod_status> output. This needs to be the output generated
710 by C<ExtendedStatus on> and it needs to be the machine readable output
711 generated by appending the C<?auto> argument. This option is I<mandatory>.
713 =item B<User> I<Username>
715 Optional user name needed for authentication.
717 =item B<Password> I<Password>
719 Optional password needed for authentication.
721 =item B<VerifyPeer> B<true|false>
723 Enable or disable peer SSL certificate verification. See
724 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
726 =item B<VerifyHost> B<true|false>
728 Enable or disable peer host name verification. If enabled, the plugin checks
729 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
730 certificate matches the host name provided by the B<URL> option. If this
731 identity check fails, the connection is aborted. Obviously, only works when
732 connecting to a SSL enabled server. Enabled by default.
734 =item B<CACert> I<File>
736 File that holds one or more SSL certificates. If you want to use HTTPS you will
737 possibly need this option. What CA certificates come bundled with C<libcurl>
738 and are checked by default depends on the distribution you use.
742 =head2 Plugin C<apcups>
746 =item B<Host> I<Hostname>
748 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
749 that IPv6 support has been disabled unless someone can confirm or decline that
750 B<apcupsd> can handle it.
752 =item B<Port> I<Port>
754 TCP-Port to connect to. Defaults to B<3551>.
756 =item B<ReportSeconds> B<true|false>
758 If set to B<true>, the time reported in the C<timeleft> metric will be
759 converted to seconds. This is the recommended setting. If set to B<false>, the
760 default for backwards compatibility, the time will be reported in minutes.
764 =head2 Plugin C<aquaero>
766 This plugin collects the value of the available sensors in an
767 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
768 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
769 connection for monitoring and configuration. The board can handle multiple
770 temperature sensors, fans, water pumps and water level sensors and adjust the
771 output settings such as fan voltage or power used by the water pump based on
772 the available inputs using a configurable controller included in the board.
773 This plugin collects all the available inputs as well as some of the output
774 values chosen by this controller. The plugin is based on the I<libaquaero5>
775 library provided by I<aquatools-ng>.
779 =item B<Device> I<DevicePath>
781 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
782 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
783 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
787 =head2 Plugin C<ascent>
789 This plugin collects information about an Ascent server, a free server for the
790 "World of Warcraft" game. This plugin gathers the information by fetching the
791 XML status page using C<libcurl> and parses it using C<libxml2>.
793 The configuration options are the same as for the C<apache> plugin above:
797 =item B<URL> I<http://localhost/ascent/status/>
799 Sets the URL of the XML status output.
801 =item B<User> I<Username>
803 Optional user name needed for authentication.
805 =item B<Password> I<Password>
807 Optional password needed for authentication.
809 =item B<VerifyPeer> B<true|false>
811 Enable or disable peer SSL certificate verification. See
812 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
814 =item B<VerifyHost> B<true|false>
816 Enable or disable peer host name verification. If enabled, the plugin checks
817 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
818 certificate matches the host name provided by the B<URL> option. If this
819 identity check fails, the connection is aborted. Obviously, only works when
820 connecting to a SSL enabled server. Enabled by default.
822 =item B<CACert> I<File>
824 File that holds one or more SSL certificates. If you want to use HTTPS you will
825 possibly need this option. What CA certificates come bundled with C<libcurl>
826 and are checked by default depends on the distribution you use.
830 =head2 Plugin C<barometer>
832 This plugin reads absolute air pressure using digital barometer sensor MPL115A2
833 or MPL3115 from Freescale (sensor attached to any I2C bus available in
834 the computer, for HW details see
835 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A> or
836 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>).
837 The sensor type - one fo these two - is detected automatically by the plugin
838 and indicated in the plugin_instance (typically you will see subdirectory
839 "barometer-mpl115" or "barometer-mpl3115").
841 The plugin provides absolute barometric pressure, air pressure reduced to sea
842 level (several possible approximations) and as an auxiliary value also internal
843 sensor temperature. It uses (expects/provides) typical metric units - pressure
844 in [hPa], temperature in [C], altitude in [m].
846 It was developed and tested under Linux only. The only platform dependency is
847 the standard Linux i2c-dev interface (the particular bus driver has to
848 support the SM Bus command subset).
850 The reduction or normalization to mean sea level pressure requires (depedning on
851 selected method/approximation) also altitude and reference to temperature sensor(s).
852 When multiple temperature sensors are configured the minumum of their values is
853 always used (expecting that the warmer ones are affected by e.g. direct sun light
862 TemperatureOffset 0.0
865 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
870 =item B<Device> I<device>
872 Device name of the I2C bus to which the sensor is connected. Note that typically
873 you need to have loaded the i2c-dev module.
874 Using i2c-tools you can check/list i2c buses available on your system by:
878 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
882 This way you should be able to verify that the pressure sensor (either type) is
883 connected and detected on address 0x60.
885 =item B<Oversampling> I<value>
887 For MPL115 this is the size of the averaging window. To filter out sensor noise
888 a simple averaging using floating window of configurable size is used. The plugin
889 will use average of the last C<value> measurements (value of 1 means no averaging).
890 Minimal size is 1, maximal 1024.
892 For MPL3115 this is the oversampling value. The actual oversampling is performed
893 by the sensor and the higher value the higher accuracy and longer conversion time
894 (although nothing to worry about in the collectd context). Supported values are:
895 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
896 the closest supported one. Default is 128.
898 =item B<PressureOffset> I<offset>
900 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
901 This is added to the measured/caclulated value (i.e. if the measured value is too high
902 then use negative offset).
903 In hPa, default is 0.0.
905 =item B<TemperatureOffset> I<offset>
907 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
908 This is added to the measured/caclulated value (i.e. if the measured value is too high
909 then use negative offset).
910 In C, default is 0.0.
912 =item B<Normalization> I<method>
914 Normalization method - what approximation/model is used to compute mean sea
915 level pressure from the air absolute pressure.
917 Supported values of the C<method> (integer between from 0 to 2) are:
921 =item B<0> - no conversion, absolute pressrure is simply copied over. For this method you
922 do not need to configure C<Altitude> or C<TemperatureSensor>.
924 =item B<1> - international formula for conversion ,
925 See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
926 For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
927 (uses fixed global temperature average instead).
929 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
930 Meteorological Service).
931 See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
932 For this method you have to configure both C<Altitude> and C<TemperatureSensor>.
937 =item B<Altitude> I<altitude>
939 The altitude (in meters) of the location where you meassure the pressure.
941 =item B<TemperatureSensor> I<reference>
943 Temperature sensor which should be used as a reference when normalizing the pressure.
944 When specified more sensors a minumum is found and uses each time.
945 The temperature reading directly from this pressure sensor/plugin
946 is typically not suitable as the pressure sensor
947 will be probably inside while we want outside temperature.
948 The collectd reference name is something like
949 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
950 (<type_instance> is usually omitted when there is just single value type).
951 Or you can figure it out from the path of the output data files.
955 =head2 Plugin C<bind>
957 Starting with BIND 9.5.0, the most widely used DNS server software provides
958 extensive statistics about queries, responses and lots of other information.
959 The bind plugin retrieves this information that's encoded in XML and provided
960 via HTTP and submits the values to collectd.
962 To use this plugin, you first need to tell BIND to make this information
963 available. This is done with the C<statistics-channels> configuration option:
965 statistics-channels {
966 inet localhost port 8053;
969 The configuration follows the grouping that can be seen when looking at the
970 data with an XSLT compatible viewer, such as a modern web browser. It's
971 probably a good idea to make yourself familiar with the provided values, so you
972 can understand what the collected statistics actually mean.
977 URL "http://localhost:8053/"
992 Zone "127.in-addr.arpa/IN"
996 The bind plugin accepts the following configuration options:
1002 URL from which to retrieve the XML data. If not specified,
1003 C<http://localhost:8053/> will be used.
1005 =item B<ParseTime> B<true>|B<false>
1007 When set to B<true>, the time provided by BIND will be parsed and used to
1008 dispatch the values. When set to B<false>, the local time source is queried.
1010 This setting is set to B<true> by default for backwards compatibility; setting
1011 this to B<false> is I<recommended> to avoid problems with timezones and
1014 =item B<OpCodes> B<true>|B<false>
1016 When enabled, statistics about the I<"OpCodes">, for example the number of
1017 C<QUERY> packets, are collected.
1021 =item B<QTypes> B<true>|B<false>
1023 When enabled, the number of I<incoming> queries by query types (for example
1024 C<A>, C<MX>, C<AAAA>) is collected.
1028 =item B<ServerStats> B<true>|B<false>
1030 Collect global server statistics, such as requests received over IPv4 and IPv6,
1031 successful queries, and failed updates.
1035 =item B<ZoneMaintStats> B<true>|B<false>
1037 Collect zone maintenance statistics, mostly information about notifications
1038 (zone updates) and zone transfers.
1042 =item B<ResolverStats> B<true>|B<false>
1044 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1045 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1046 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1047 default. Use the B<ResolverStats> option within a B<View "_default"> block
1048 instead for the same functionality.
1052 =item B<MemoryStats>
1054 Collect global memory statistics.
1058 =item B<View> I<Name>
1060 Collect statistics about a specific I<"view">. BIND can behave different,
1061 mostly depending on the source IP-address of the request. These different
1062 configurations are called "views". If you don't use this feature, you most
1063 likely are only interested in the C<_default> view.
1065 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1066 information you want to collect about a view. If no B<View> block is
1067 configured, no detailed view statistics will be collected.
1071 =item B<QTypes> B<true>|B<false>
1073 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1074 C<MX>) is collected.
1078 =item B<ResolverStats> B<true>|B<false>
1080 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1081 (e.E<nbsp>g. queries over IPv4, lame servers).
1085 =item B<CacheRRSets> B<true>|B<false>
1087 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1088 type is collected. Negative entries (queries which resulted in an error, for
1089 example names that do not exist) are reported with a leading exclamation mark,
1094 =item B<Zone> I<Name>
1096 When given, collect detailed information about the given zone in the view. The
1097 information collected if very similar to the global B<ServerStats> information
1100 You can repeat this option to collect detailed information about multiple
1103 By default no detailed zone information is collected.
1109 =head2 Plugin C<cgroups>
1111 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1112 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1113 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1117 =item B<CGroup> I<Directory>
1119 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1120 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1123 =item B<IgnoreSelected> B<true>|B<false>
1125 Invert the selection: If set to true, all cgroups I<except> the ones that
1126 match any one of the criteria are collected. By default only selected
1127 cgroups are collected if a selection is made. If no selection is configured
1128 at all, B<all> cgroups are selected.
1132 =head2 Plugin C<conntrack>
1134 This plugin collects IP conntrack statistics.
1140 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1141 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1145 =head2 Plugin C<cpu>
1147 The I<CPU plugin> collects CPU usage metrics.
1149 The following configuration options are available:
1153 =item B<ReportActive> B<false>|B<true>
1155 Reports non-idle CPU usage as the "active" value. Defaults to false.
1157 =item B<ReportByCpu> B<false>|B<true>
1159 When true reports usage for all cores. When false, reports cpu usage
1160 aggregated over all cores.
1163 =item B<ValuesPercentage> B<false>|B<true>
1165 When true report percentage usage instead of tick values. Defaults to false.
1170 =head2 Plugin C<cpufreq>
1172 This plugin doesn't have any options. It reads
1173 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1174 installed) to get the current CPU frequency. If this file does not exist make
1175 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1176 installed and an "cpu governor" (that's a kernel module) is loaded.
1178 =head2 Plugin C<csv>
1182 =item B<DataDir> I<Directory>
1184 Set the directory to store CSV-files under. Per default CSV-files are generated
1185 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1186 The special strings B<stdout> and B<stderr> can be used to write to the standard
1187 output and standard error channels, respectively. This, of course, only makes
1188 much sense when collectd is running in foreground- or non-daemon-mode.
1190 =item B<StoreRates> B<true|false>
1192 If set to B<true>, convert counter values to rates. If set to B<false> (the
1193 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1198 =head2 Plugin C<curl>
1200 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1201 and the match infrastructure (the same code used by the tail plugin) to use
1202 regular expressions with the received data.
1204 The following example will read the current value of AMD stock from Google's
1205 finance page and dispatch the value to collectd.
1208 <Page "stock_quotes">
1209 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1213 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1214 DSType "GaugeAverage"
1215 # Note: `stock_value' is not a standard type.
1222 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1223 a web page and one or more "matches" to be performed on the returned data. The
1224 string argument to the B<Page> block is used as plugin instance.
1226 The following options are valid within B<Page> blocks:
1232 URL of the web site to retrieve. Since a regular expression will be used to
1233 extract information from this data, non-binary data is a big plus here ;)
1235 =item B<User> I<Name>
1237 Username to use if authorization is required to read the page.
1239 =item B<Password> I<Password>
1241 Password to use if authorization is required to read the page.
1243 =item B<Digest> B<true>|B<false>
1245 Enable HTTP digest authentication.
1247 =item B<VerifyPeer> B<true>|B<false>
1249 Enable or disable peer SSL certificate verification. See
1250 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1252 =item B<VerifyHost> B<true>|B<false>
1254 Enable or disable peer host name verification. If enabled, the plugin checks if
1255 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1256 matches the host name provided by the B<URL> option. If this identity check
1257 fails, the connection is aborted. Obviously, only works when connecting to a
1258 SSL enabled server. Enabled by default.
1260 =item B<CACert> I<file>
1262 File that holds one or more SSL certificates. If you want to use HTTPS you will
1263 possibly need this option. What CA certificates come bundled with C<libcurl>
1264 and are checked by default depends on the distribution you use.
1266 =item B<Header> I<Header>
1268 A HTTP header to add to the request. Multiple headers are added if this option
1269 is specified more than once.
1271 =item B<Post> I<Body>
1273 Specifies that the HTTP operation should be a POST instead of a GET. The
1274 complete data to be posted is given as the argument. This option will usually
1275 need to be accompanied by a B<Header> option to set an appropriate
1276 C<Content-Type> for the post body (e.g. to
1277 C<application/x-www-form-urlencoded>).
1279 =item B<MeasureResponseTime> B<true>|B<false>
1281 Measure response time for the request. If this setting is enabled, B<Match>
1282 blocks (see below) are optional. Disabled by default.
1284 =item B<E<lt>MatchE<gt>>
1286 One or more B<Match> blocks that define how to match information in the data
1287 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1288 used by the C<tail> plugin, so please see the documentation of the C<tail>
1289 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1290 is set to B<true>, B<Match> blocks are optional.
1294 =head2 Plugin C<curl_json>
1296 The B<curl_json plugin> collects values from JSON data to be parsed by
1297 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1298 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1299 unix socket. The former can be used, for example, to collect values
1300 from CouchDB documents (which are stored JSON notation), and the
1301 latter to collect values from a uWSGI stats socket.
1303 The following example will collect several values from the built-in
1304 C<_stats> runtime statistics module of I<CouchDB>
1305 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1308 <URL "http://localhost:5984/_stats">
1310 <Key "httpd/requests/count">
1311 Type "http_requests"
1314 <Key "httpd_request_methods/*/count">
1315 Type "http_request_methods"
1318 <Key "httpd_status_codes/*/count">
1319 Type "http_response_codes"
1324 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1327 <Sock "/var/run/uwsgi.stats.sock">
1329 <Key "workers/*/requests">
1330 Type "http_requests"
1333 <Key "workers/*/apps/*/requests">
1334 Type "http_requests"
1339 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1340 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1341 blocks defining a unix socket to read JSON from directly. Each of
1342 these blocks may have one or more B<Key> blocks.
1344 The B<Key> string argument must be in a path format. Each component is
1345 used to match the key from a JSON map or the index of an JSON
1346 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1347 values for all map keys or array indices will be collectd.
1349 The following options are valid within B<URL> blocks:
1353 =item B<Instance> I<Instance>
1355 Sets the plugin instance to I<Instance>.
1357 =item B<Interval> I<Interval>
1359 Sets the interval (in seconds) in which the values will be collected from this
1360 URL. By default the global B<Interval> setting will be used.
1362 =item B<User> I<Name>
1364 =item B<Password> I<Password>
1366 =item B<Digest> B<true>|B<false>
1368 =item B<VerifyPeer> B<true>|B<false>
1370 =item B<VerifyHost> B<true>|B<false>
1372 =item B<CACert> I<file>
1374 =item B<Header> I<Header>
1376 =item B<Post> I<Body>
1378 These options behave exactly equivalent to the appropriate options of the
1379 I<cURL> plugin. Please see there for a detailed description.
1383 The following options are valid within B<Key> blocks:
1387 =item B<Type> I<Type>
1389 Sets the type used to dispatch the values to the daemon. Detailed information
1390 about types and their configuration can be found in L<types.db(5)>. This
1391 option is mandatory.
1393 =item B<Instance> I<Instance>
1395 Type-instance to use. Defaults to the current map key or current string array element value.
1399 =head2 Plugin C<curl_xml>
1401 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1402 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1405 <URL "http://localhost/stats.xml">
1407 Instance "some_instance"
1412 CACert "/path/to/ca.crt"
1414 <XPath "table[@id=\"magic_level\"]/tr">
1416 #InstancePrefix "prefix-"
1417 InstanceFrom "td[1]"
1418 ValuesFrom "td[2]/span[@class=\"level\"]"
1423 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1424 URL to be fetched using libcurl. Within each B<URL> block there are
1425 options which specify the connection parameters, for example authentication
1426 information, and one or more B<XPath> blocks.
1428 Each B<XPath> block specifies how to get one type of information. The
1429 string argument must be a valid XPath expression which returns a list
1430 of "base elements". One value is dispatched for each "base element". The
1431 I<type instance> and values are looked up using further I<XPath> expressions
1432 that should be relative to the base element.
1434 Within the B<URL> block the following options are accepted:
1438 =item B<Host> I<Name>
1440 Use I<Name> as the host name when submitting values. Defaults to the global
1443 =item B<Instance> I<Instance>
1445 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1446 empty string (no plugin instance).
1448 =item B<Namespace> I<Prefix> I<URL>
1450 If an XPath expression references namespaces, they must be specified
1451 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1452 I<URL> is the "namespace name", an URI reference uniquely identifying the
1453 namespace. The option can be repeated to register multiple namespaces.
1457 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1458 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1460 =item B<User> I<User>
1462 =item B<Password> I<Password>
1464 =item B<Digest> B<true>|B<false>
1466 =item B<VerifyPeer> B<true>|B<false>
1468 =item B<VerifyHost> B<true>|B<false>
1470 =item B<CACert> I<CA Cert File>
1472 =item B<Header> I<Header>
1474 =item B<Post> I<Body>
1476 These options behave exactly equivalent to the appropriate options of the
1477 I<cURL plugin>. Please see there for a detailed description.
1479 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1481 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1482 B<XPath> block specifies how to get one type of information. The string
1483 argument must be a valid XPath expression which returns a list of "base
1484 elements". One value is dispatched for each "base element".
1486 Within the B<XPath> block the following options are accepted:
1490 =item B<Type> I<Type>
1492 Specifies the I<Type> used for submitting patches. This determines the number
1493 of values that are required / expected and whether the strings are parsed as
1494 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1495 This option is required.
1497 =item B<InstancePrefix> I<InstancePrefix>
1499 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1500 concatenated together without any separator.
1501 This option is optional.
1503 =item B<InstanceFrom> I<InstanceFrom>
1505 Specifies a XPath expression to use for determining the I<type instance>. The
1506 XPath expression must return exactly one element. The element's value is then
1507 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1509 This value is required. As a special exception, if the "base XPath expression"
1510 (the argument to the B<XPath> block) returns exactly one argument, then this
1511 option may be omitted.
1513 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1515 Specifies one or more XPath expression to use for reading the values. The
1516 number of XPath expressions must match the number of data sources in the
1517 I<type> specified with B<Type> (see above). Each XPath expression must return
1518 exactly one element. The element's value is then parsed as a number and used as
1519 value for the appropriate value in the value list dispatched to the daemon.
1525 =head2 Plugin C<dbi>
1527 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1528 connect to various databases, execute I<SQL> statements and read back the
1529 results. I<dbi> is an acronym for "database interface" in case you were
1530 wondering about the name. You can configure how each column is to be
1531 interpreted and the plugin will generate one or more data sets from each row
1532 returned according to these rules.
1534 Because the plugin is very generic, the configuration is a little more complex
1535 than those of other plugins. It usually looks something like this:
1538 <Query "out_of_stock">
1539 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1540 # Use with MySQL 5.0.0 or later
1544 InstancePrefix "out_of_stock"
1545 InstancesFrom "category"
1549 <Database "product_information">
1551 DriverOption "host" "localhost"
1552 DriverOption "username" "collectd"
1553 DriverOption "password" "aZo6daiw"
1554 DriverOption "dbname" "prod_info"
1555 SelectDB "prod_info"
1556 Query "out_of_stock"
1560 The configuration above defines one query with one result and one database. The
1561 query is then linked to the database with the B<Query> option I<within> the
1562 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1563 and you can also use the B<Include> statement to split up the configuration
1564 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1565 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1568 The following is a complete list of options:
1570 =head3 B<Query> blocks
1572 Query blocks define I<SQL> statements and how the returned data should be
1573 interpreted. They are identified by the name that is given in the opening line
1574 of the block. Thus the name needs to be unique. Other than that, the name is
1575 not used in collectd.
1577 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1578 define which column holds which value or instance information. You can use
1579 multiple B<Result> blocks to create multiple values from one returned row. This
1580 is especially useful, when queries take a long time and sending almost the same
1581 query again and again is not desirable.
1585 <Query "environment">
1586 Statement "select station, temperature, humidity from environment"
1589 # InstancePrefix "foo"
1590 InstancesFrom "station"
1591 ValuesFrom "temperature"
1595 InstancesFrom "station"
1596 ValuesFrom "humidity"
1600 The following options are accepted:
1604 =item B<Statement> I<SQL>
1606 Sets the statement that should be executed on the server. This is B<not>
1607 interpreted by collectd, but simply passed to the database server. Therefore,
1608 the SQL dialect that's used depends on the server collectd is connected to.
1610 The query has to return at least two columns, one for the instance and one
1611 value. You cannot omit the instance, even if the statement is guaranteed to
1612 always return exactly one line. In that case, you can usually specify something
1615 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1617 (That works with MySQL but may not be valid SQL according to the spec. If you
1618 use a more strict database server, you may have to select from a dummy table or
1621 Please note that some databases, for example B<Oracle>, will fail if you
1622 include a semicolon at the end of the statement.
1624 =item B<MinVersion> I<Version>
1626 =item B<MaxVersion> I<Value>
1628 Only use this query for the specified database version. You can use these
1629 options to provide multiple queries with the same name but with a slightly
1630 different syntax. The plugin will use only those queries, where the specified
1631 minimum and maximum versions fit the version of the database in use.
1633 The database version is determined by C<dbi_conn_get_engine_version>, see the
1634 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1635 for details. Basically, each part of the version is assumed to be in the range
1636 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1637 "40102", version "5.0.42" becomes "50042".
1639 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1640 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1641 happen. Don't to it! A valid example would be something along these lines:
1652 In the above example, there are three ranges that don't overlap. The last one
1653 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1654 before "4.0.0" are not specified.
1656 =item B<Type> I<Type>
1658 The B<type> that's used for each line returned. See L<types.db(5)> for more
1659 details on how types are defined. In short: A type is a predefined layout of
1660 data and the number of values and type of values has to match the type
1663 If you specify "temperature" here, you need exactly one gauge column. If you
1664 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1667 There must be exactly one B<Type> option inside each B<Result> block.
1669 =item B<InstancePrefix> I<prefix>
1671 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1672 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1673 all strings returned in the appropriate columns are concatenated together,
1674 separated by dashes I<("-")>.
1676 =item B<InstancesFrom> I<column0> [I<column1> ...]
1678 Specifies the columns whose values will be used to create the "type-instance"
1679 for each row. If you specify more than one column, the value of all columns
1680 will be joined together with dashes I<("-")> as separation characters.
1682 The plugin itself does not check whether or not all built instances are
1683 different. It's your responsibility to assure that each is unique. This is
1684 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1685 sure that only one row is returned in this case.
1687 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1690 =item B<ValuesFrom> I<column0> [I<column1> ...]
1692 Names the columns whose content is used as the actual data for the data sets
1693 that are dispatched to the daemon. How many such columns you need is determined
1694 by the B<Type> setting above. If you specify too many or not enough columns,
1695 the plugin will complain about that and no data will be submitted to the
1698 The actual data type in the columns is not that important. The plugin will
1699 automatically cast the values to the right type if it know how to do that. So
1700 it should be able to handle integer an floating point types, as well as strings
1701 (if they include a number at the beginning).
1703 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1705 =item B<MetadataFrom> [I<column0> I<column1> ...]
1707 Names the columns whose content is used as metadata for the data sets
1708 that are dispatched to the daemon.
1710 The actual data type in the columns is not that important. The plugin will
1711 automatically cast the values to the right type if it know how to do that. So
1712 it should be able to handle integer an floating point types, as well as strings
1713 (if they include a number at the beginning).
1717 =head3 B<Database> blocks
1719 Database blocks define a connection to a database and which queries should be
1720 sent to that database. Since the used "dbi" library can handle a wide variety
1721 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1722 documentationE<nbsp>- we stick as close to the terminology used there.
1724 Each database needs a "name" as string argument in the starting tag of the
1725 block. This name will be used as "PluginInstance" in the values submitted to
1726 the daemon. Other than that, that name is not used.
1730 =item B<Driver> I<Driver>
1732 Specifies the driver to use to connect to the database. In many cases those
1733 drivers are named after the database they can connect to, but this is not a
1734 technical necessity. These drivers are sometimes referred to as "DBD",
1735 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1736 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1737 project at L<http://libdbi-drivers.sourceforge.net/>.
1739 You need to give the driver name as expected by the "dbi" library here. You
1740 should be able to find that in the documentation for each driver. If you
1741 mistype the driver name, the plugin will dump a list of all known driver names
1744 =item B<DriverOption> I<Key> I<Value>
1746 Sets driver-specific options. What option a driver supports can be found in the
1747 documentation for each driver, somewhere at
1748 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1749 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1751 DBDs can register two types of options: String options and numeric options. The
1752 plugin will use the C<dbi_conn_set_option> function when the configuration
1753 provides a string and the C<dbi_conn_require_option_numeric> function when the
1754 configuration provides a number. So these two lines will actually result in
1755 different calls being used:
1757 DriverOption "Port" 1234 # numeric
1758 DriverOption "Port" "1234" # string
1760 Unfortunately, drivers are not too keen to report errors when an unknown option
1761 is passed to them, so invalid settings here may go unnoticed. This is not the
1762 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1763 the driver. If a driver complains about an option, the plugin will dump a
1764 complete list of all options understood by that driver to the log. There is no
1765 way to programatically find out if an option expects a string or a numeric
1766 argument, so you will have to refer to the appropriate DBD's documentation to
1767 find this out. Sorry.
1769 =item B<SelectDB> I<Database>
1771 In some cases, the database name you connect with is not the database name you
1772 want to use for querying data. If this option is set, the plugin will "select"
1773 (switch to) that database after the connection is established.
1775 =item B<Query> I<QueryName>
1777 Associates the query named I<QueryName> with this database connection. The
1778 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1779 blocks you want to refer to must be placed above the database block you want to
1782 =item B<Host> I<Hostname>
1784 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1785 values. Defaults to the global hostname setting.
1793 =item B<Device> I<Device>
1795 Select partitions based on the devicename.
1797 =item B<MountPoint> I<Directory>
1799 Select partitions based on the mountpoint.
1801 =item B<FSType> I<FSType>
1803 Select partitions based on the filesystem type.
1805 =item B<IgnoreSelected> B<true>|B<false>
1807 Invert the selection: If set to true, all partitions B<except> the ones that
1808 match any one of the criteria are collected. By default only selected
1809 partitions are collected if a selection is made. If no selection is configured
1810 at all, B<all> partitions are selected.
1812 =item B<ReportByDevice> B<true>|B<false>
1814 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1815 (the default), it will report a disk as "root", but with it I<true>, it will be
1816 "sda1" (or whichever).
1818 =item B<ReportInodes> B<true>|B<false>
1820 Enables or disables reporting of free, reserved and used inodes. Defaults to
1821 inode collection being disabled.
1823 Enable this option if inodes are a scarce resource for you, usually because
1824 many small files are stored on the disk. This is a usual scenario for mail
1825 transfer agents and web caches.
1827 =item B<ValuesAbsolute> B<true>|B<false>
1829 Enables or disables reporting of free and used disk space in 1K-blocks.
1830 Defaults to B<true>.
1832 =item B<ValuesPercentage> B<false>|B<true>
1834 Enables or disables reporting of free and used disk space in percentage.
1835 Defaults to B<false>.
1837 This is useful for deploying I<collectd> on the cloud, where machines with
1838 different disk size may exist. Then it is more practical to configure
1839 thresholds based on relative disk size.
1843 =head2 Plugin C<disk>
1845 The C<disk> plugin collects information about the usage of physical disks and
1846 logical disks (partitions). Values collected are the number of octets written
1847 to and read from a disk or partition, the number of read/write operations
1848 issued to the disk and a rather complex "time" it took for these commands to be
1851 Using the following two options you can ignore some disks or configure the
1852 collection only of specific disks.
1856 =item B<Disk> I<Name>
1858 Select the disk I<Name>. Whether it is collected or ignored depends on the
1859 B<IgnoreSelected> setting, see below. As with other plugins that use the
1860 daemon's ignorelist functionality, a string that starts and ends with a slash
1861 is interpreted as a regular expression. Examples:
1866 =item B<IgnoreSelected> B<true>|B<false>
1868 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1869 statements, are ignored or if all other disks are ignored. The behavior
1870 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1871 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1872 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1873 is set to B<true>, all disks are collected B<except> the ones matched.
1875 =item B<UseBSDName> B<true>|B<false>
1877 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1878 default major/minor numbers. Requires collectd to be built with Apple's
1881 =item B<UdevNameAttr> I<Attribute>
1883 Attempt to override disk instance name with the value of a specified udev
1884 attribute when built with B<libudev>. If the attribute is not defined for the
1885 given device, the default name is used. Example:
1887 UdevNameAttr "DM_NAME"
1891 =head2 Plugin C<dns>
1895 =item B<Interface> I<Interface>
1897 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1898 option sets the interface that should be used. If this option is not set, or
1899 set to "any", the plugin will try to get packets from B<all> interfaces. This
1900 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1902 =item B<IgnoreSource> I<IP-address>
1904 Ignore packets that originate from this address.
1906 =item B<SelectNumericQueryTypes> B<true>|B<false>
1908 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1912 =head2 Plugin C<email>
1916 =item B<SocketFile> I<Path>
1918 Sets the socket-file which is to be created.
1920 =item B<SocketGroup> I<Group>
1922 If running as root change the group of the UNIX-socket after it has been
1923 created. Defaults to B<collectd>.
1925 =item B<SocketPerms> I<Permissions>
1927 Change the file permissions of the UNIX-socket after it has been created. The
1928 permissions must be given as a numeric, octal value as you would pass to
1929 L<chmod(1)>. Defaults to B<0770>.
1931 =item B<MaxConns> I<Number>
1933 Sets the maximum number of connections that can be handled in parallel. Since
1934 this many threads will be started immediately setting this to a very high
1935 value will waste valuable resources. Defaults to B<5> and will be forced to be
1936 at most B<16384> to prevent typos and dumb mistakes.
1940 =head2 Plugin C<ethstat>
1942 The I<ethstat plugin> collects information about network interface cards (NICs)
1943 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1949 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1950 Map "multicast" "if_multicast"
1957 =item B<Interface> I<Name>
1959 Collect statistical information about interface I<Name>.
1961 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1963 By default, the plugin will submit values as type C<derive> and I<type
1964 instance> set to I<Name>, the name of the metric as reported by the driver. If
1965 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1966 I<TypeInstance> will be used.
1968 =item B<MappedOnly> B<true>|B<false>
1970 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1971 collected, all other metrics will be ignored. Defaults to B<false>.
1975 =head2 Plugin C<exec>
1977 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1978 contains valuable information on when the executable is executed and the
1979 output that is expected from it.
1983 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1985 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1987 Execute the executable I<Executable> as user I<User>. If the user name is
1988 followed by a colon and a group name, the effective group is set to that group.
1989 The real group and saved-set group will be set to the default group of that
1990 user. If no group is given the effective group ID will be the same as the real
1993 Please note that in order to change the user and/or group the daemon needs
1994 superuser privileges. If the daemon is run as an unprivileged user you must
1995 specify the same user/group here. If the daemon is run with superuser
1996 privileges, you must supply a non-root user here.
1998 The executable may be followed by optional arguments that are passed to the
1999 program. Please note that due to the configuration parsing numbers and boolean
2000 values may be changed. If you want to be absolutely sure that something is
2001 passed as-is please enclose it in quotes.
2003 The B<Exec> and B<NotificationExec> statements change the semantics of the
2004 programs executed, i.E<nbsp>e. the data passed to them and the response
2005 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2009 =head2 Plugin C<filecount>
2011 The C<filecount> plugin counts the number of files in a certain directory (and
2012 its subdirectories) and their combined size. The configuration is very straight
2015 <Plugin "filecount">
2016 <Directory "/var/qmail/queue/mess">
2017 Instance "qmail-message"
2019 <Directory "/var/qmail/queue/todo">
2020 Instance "qmail-todo"
2022 <Directory "/var/lib/php5">
2023 Instance "php5-sessions"
2028 The example above counts the number of files in QMail's queue directories and
2029 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2030 QMail has not yet looked at, the "message" queue holds the messages that were
2031 classified into "local" and "remote".
2033 As you can see, the configuration consists of one or more C<Directory> blocks,
2034 each of which specifies a directory in which to count the files. Within those
2035 blocks, the following options are recognized:
2039 =item B<Instance> I<Instance>
2041 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2042 it's your responsibility, the plugin doesn't check for that. If not given, the
2043 instance is set to the directory name with all slashes replaced by underscores
2044 and all leading underscores removed.
2046 =item B<Name> I<Pattern>
2048 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2049 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2050 against the pattern, not the entire path. In case this makes it easier for you:
2051 This option has been named after the B<-name> parameter to L<find(1)>.
2053 =item B<MTime> I<Age>
2055 Count only files of a specific age: If I<Age> is greater than zero, only files
2056 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2057 a negative number, this is inversed. For example, if B<-60> is specified, only
2058 files that have been modified in the last minute will be counted.
2060 The number can also be followed by a "multiplier" to easily specify a larger
2061 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2062 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2063 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2064 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2065 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2068 =item B<Size> I<Size>
2070 Count only files of a specific size. When I<Size> is a positive number, only
2071 files that are at least this big are counted. If I<Size> is a negative number,
2072 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2073 I<Size> are counted.
2075 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2076 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2077 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2078 note that there are 1000 bytes in a kilobyte, not 1024.
2080 =item B<Recursive> I<true>|I<false>
2082 Controls whether or not to recurse into subdirectories. Enabled by default.
2084 =item B<IncludeHidden> I<true>|I<false>
2086 Controls whether or not to include "hidden" files and directories in the count.
2087 "Hidden" files and directories are those, whose name begins with a dot.
2088 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2092 =head2 Plugin C<GenericJMX>
2094 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2095 L<collectd-java(5)>.
2097 =head2 Plugin C<gmond>
2099 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2100 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2101 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2106 MCReceiveFrom "239.2.11.71" "8649"
2107 <Metric "swap_total">
2109 TypeInstance "total"
2112 <Metric "swap_free">
2119 The following metrics are built-in:
2125 load_one, load_five, load_fifteen
2129 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2133 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2145 Available configuration options:
2149 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2151 Sets sets the multicast group and UDP port to which to subscribe.
2153 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2155 =item E<lt>B<Metric> I<Name>E<gt>
2157 These blocks add a new metric conversion to the internal table. I<Name>, the
2158 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2162 =item B<Type> I<Type>
2164 Type to map this metric to. Required.
2166 =item B<TypeInstance> I<Instance>
2168 Type-instance to use. Optional.
2170 =item B<DataSource> I<Name>
2172 Data source to map this metric to. If the configured type has exactly one data
2173 source, this is optional. Otherwise the option is required.
2179 =head2 Plugin C<hddtemp>
2181 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2182 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2183 default values, see below. C<hddtemp> has to be running to work correctly. If
2184 C<hddtemp> is not running timeouts may appear which may interfere with other
2187 The B<hddtemp> homepage can be found at
2188 L<http://www.guzu.net/linux/hddtemp.php>.
2192 =item B<Host> I<Hostname>
2194 Hostname to connect to. Defaults to B<127.0.0.1>.
2196 =item B<Port> I<Port>
2198 TCP-Port to connect to. Defaults to B<7634>.
2202 =head2 Plugin C<interface>
2206 =item B<Interface> I<Interface>
2208 Select this interface. By default these interfaces will then be collected. For
2209 a more detailed description see B<IgnoreSelected> below.
2211 =item B<IgnoreSelected> I<true>|I<false>
2213 If no configuration if given, the B<traffic>-plugin will collect data from
2214 all interfaces. This may not be practical, especially for loopback- and
2215 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2216 interfaces you're interested in. Sometimes, however, it's easier/preferred
2217 to collect all interfaces I<except> a few ones. This option enables you to
2218 do that: By setting B<IgnoreSelected> to I<true> the effect of
2219 B<Interface> is inverted: All selected interfaces are ignored and all
2220 other interfaces are collected.
2224 =head2 Plugin C<ipmi>
2228 =item B<Sensor> I<Sensor>
2230 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2232 =item B<IgnoreSelected> I<true>|I<false>
2234 If no configuration if given, the B<ipmi> plugin will collect data from all
2235 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2236 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2237 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2238 all other sensors are collected.
2240 =item B<NotifySensorAdd> I<true>|I<false>
2242 If a sensor appears after initialization time of a minute a notification
2245 =item B<NotifySensorRemove> I<true>|I<false>
2247 If a sensor disappears a notification is sent.
2249 =item B<NotifySensorNotPresent> I<true>|I<false>
2251 If you have for example dual power supply and one of them is (un)plugged then
2252 a notification is sent.
2256 =head2 Plugin C<iptables>
2260 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2262 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2263 will collect the counters of all rules which have a comment-match. The comment
2264 is then used as type-instance.
2266 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2267 the I<n>th rule will be collected. Again, the comment (or the number) will be
2268 used as the type-instance.
2270 If I<Name> is supplied, it will be used as the type-instance instead of the
2271 comment or the number.
2275 =head2 Plugin C<irq>
2281 Select this irq. By default these irqs will then be collected. For a more
2282 detailed description see B<IgnoreSelected> below.
2284 =item B<IgnoreSelected> I<true>|I<false>
2286 If no configuration if given, the B<irq>-plugin will collect data from all
2287 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2288 can use the B<Irq>-option to pick the interrupt you're interested in.
2289 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2290 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2291 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2292 and all other interrupts are collected.
2296 =head2 Plugin C<java>
2298 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2299 This section only discusses the syntax and semantic of the configuration
2300 options. For more in-depth information on the I<Java> plugin, please read
2301 L<collectd-java(5)>.
2306 JVMArg "-verbose:jni"
2307 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2308 LoadPlugin "org.collectd.java.Foobar"
2309 <Plugin "org.collectd.java.Foobar">
2310 # To be parsed by the plugin
2314 Available configuration options:
2318 =item B<JVMArg> I<Argument>
2320 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2321 exactly the way the arguments to the I<java> binary on the command line work.
2322 Execute C<javaE<nbsp>--help> for details.
2324 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2325 any other options! When another option is found, the JVM will be started and
2326 later options will have to be ignored!
2328 =item B<LoadPlugin> I<JavaClass>
2330 Instantiates a new I<JavaClass> object. The constructor of this object very
2331 likely then registers one or more callback methods with the server.
2333 See L<collectd-java(5)> for details.
2335 When the first such option is found, the virtual machine (JVM) is created. This
2336 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2337 B<LoadPlugin> options!
2339 =item B<Plugin> I<Name>
2341 The entire block is passed to the Java plugin as an
2342 I<org.collectd.api.OConfigItem> object.
2344 For this to work, the plugin has to register a configuration callback first,
2345 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2346 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2347 depends on the (Java) plugin registering the callback and is completely
2348 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2352 =head2 Plugin C<libvirt>
2354 This plugin allows CPU, disk and network load to be collected for virtualized
2355 guests on the machine. This means that these characteristics can be collected
2356 for guest systems without installing any software on them - collectd only runs
2357 on the hosting system. The statistics are collected through libvirt
2358 (L<http://libvirt.org/>).
2360 Only I<Connection> is required.
2364 =item B<Connection> I<uri>
2366 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2368 Connection "xen:///"
2370 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2372 =item B<RefreshInterval> I<seconds>
2374 Refresh the list of domains and devices every I<seconds>. The default is 60
2375 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2376 the list of domains and devices to be refreshed on every iteration.
2378 Refreshing the devices in particular is quite a costly operation, so if your
2379 virtualization setup is static you might consider increasing this. If this
2380 option is set to 0, refreshing is disabled completely.
2382 =item B<Domain> I<name>
2384 =item B<BlockDevice> I<name:dev>
2386 =item B<InterfaceDevice> I<name:dev>
2388 =item B<IgnoreSelected> I<true>|I<false>
2390 Select which domains and devices are collected.
2392 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2393 disk/network devices are collected.
2395 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2396 domains and disk/network devices are ignored, while the rest are collected.
2398 The domain name and device names may use a regular expression, if the name is
2399 surrounded by I</.../> and collectd was compiled with support for regexps.
2401 The default is to collect statistics for all domains and all their devices.
2405 BlockDevice "/:hdb/"
2406 IgnoreSelected "true"
2408 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2411 =item B<HostnameFormat> B<name|uuid|hostname|...>
2413 When the libvirt plugin logs data, it sets the hostname of the collected data
2414 according to this setting. The default is to use the guest name as provided by
2415 the hypervisor, which is equal to setting B<name>.
2417 B<uuid> means use the guest's UUID. This is useful if you want to track the
2418 same guest across migrations.
2420 B<hostname> means to use the global B<Hostname> setting, which is probably not
2421 useful on its own because all guests will appear to have the same name.
2423 You can also specify combinations of these fields. For example B<name uuid>
2424 means to concatenate the guest name and UUID (with a literal colon character
2425 between, thus I<"foo:1234-1234-1234-1234">).
2427 =item B<InterfaceFormat> B<name>|B<address>
2429 When the libvirt plugin logs interface data, it sets the name of the collected
2430 data according to this setting. The default is to use the path as provided by
2431 the hypervisor (the "dev" property of the target node), which is equal to
2434 B<address> means use the interface's mac address. This is useful since the
2435 interface path might change between reboots of a guest or across migrations.
2437 =item B<PluginInstanceFormat> B<name|uuid>
2439 When the libvirt plugin logs data, it sets the plugin_instance of the collected
2440 data according to this setting. The default is to use the guest name as provided
2441 by the hypervisor, which is equal to setting B<name>.
2443 B<uuid> means use the guest's UUID.
2447 =head2 Plugin C<load>
2449 The I<Load plugin> collects the system load. These numbers give a rough overview
2450 over the utilization of a machine. The system load is defined as the number of
2451 runnable tasks in the run-queue and is provided by many operating systems as a
2452 one, five or fifteen minute average.
2454 The following configuration options are available:
2458 =item B<ReportRelative> B<false>|B<true>
2460 When enabled, system load divided by number of available CPU cores is reported
2461 for intervals 1 min, 5 min and 15 min. Defaults to false.
2466 =head2 Plugin C<logfile>
2470 =item B<LogLevel> B<debug|info|notice|warning|err>
2472 Sets the log-level. If, for example, set to B<notice>, then all events with
2473 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2475 Please note that B<debug> is only available if collectd has been compiled with
2478 =item B<File> I<File>
2480 Sets the file to write log messages to. The special strings B<stdout> and
2481 B<stderr> can be used to write to the standard output and standard error
2482 channels, respectively. This, of course, only makes much sense when I<collectd>
2483 is running in foreground- or non-daemon-mode.
2485 =item B<Timestamp> B<true>|B<false>
2487 Prefix all lines printed by the current time. Defaults to B<true>.
2489 =item B<PrintSeverity> B<true>|B<false>
2491 When enabled, all lines are prefixed by the severity of the log message, for
2492 example "warning". Defaults to B<false>.
2496 B<Note>: There is no need to notify the daemon after moving or removing the
2497 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2498 for each line it writes.
2500 =head2 Plugin C<log_logstash>
2502 The I<log logstash plugin> behaves like the logfile plugin but formats
2503 messages as JSON events for logstash to parse and input.
2507 =item B<LogLevel> B<debug|info|notice|warning|err>
2509 Sets the log-level. If, for example, set to B<notice>, then all events with
2510 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2512 Please note that B<debug> is only available if collectd has been compiled with
2515 =item B<File> I<File>
2517 Sets the file to write log messages to. The special strings B<stdout> and
2518 B<stderr> can be used to write to the standard output and standard error
2519 channels, respectively. This, of course, only makes much sense when I<collectd>
2520 is running in foreground- or non-daemon-mode.
2524 B<Note>: There is no need to notify the daemon after moving or removing the
2525 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2526 for each line it writes.
2528 =head2 Plugin C<lpar>
2530 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2531 virtualization technique for IBM POWER processors. It takes into account CPU
2532 time stolen from or donated to a partition, in addition to the usual user,
2533 system, I/O statistics.
2535 The following configuration options are available:
2539 =item B<CpuPoolStats> B<false>|B<true>
2541 When enabled, statistics about the processor pool are read, too. The partition
2542 needs to have pool authority in order to be able to acquire this information.
2545 =item B<ReportBySerial> B<false>|B<true>
2547 If enabled, the serial of the physical machine the partition is currently
2548 running on is reported as I<hostname> and the logical hostname of the machine
2549 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2550 used (just like other plugins) and the I<plugin instance> will be empty.
2555 =head2 Plugin C<mbmon>
2557 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2559 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2560 B<Host> and B<Port> options can be used to change these values, see below.
2561 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2562 timeouts may appear which may interfere with other statistics..
2564 C<mbmon> must be run with the -r option ("print TAG and Value format");
2565 Debian's F</etc/init.d/mbmon> script already does this, other people
2566 will need to ensure that this is the case.
2570 =item B<Host> I<Hostname>
2572 Hostname to connect to. Defaults to B<127.0.0.1>.
2574 =item B<Port> I<Port>
2576 TCP-Port to connect to. Defaults to B<411>.
2582 The C<md plugin> collects information from Linux Software-RAID devices (md).
2584 All reported values are of the type C<md_disks>. Reported type instances are
2585 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2586 I<missing> (physically absent) disks.
2590 =item B<Device> I<Device>
2592 Select md devices based on device name. The I<device name> is the basename of
2593 the device, i.e. the name of the block device without the leading C</dev/>.
2594 See B<IgnoreSelected> for more details.
2596 =item B<IgnoreSelected> B<true>|B<false>
2598 Invert device selection: If set to B<true>, all md devices B<except> those
2599 listed using B<Device> are collected. If B<false> (the default), only those
2600 listed are collected. If no configuration is given, the B<md> plugin will
2601 collect data from all md devices.
2605 =head2 Plugin C<memcachec>
2607 The C<memcachec plugin> connects to a memcached server, queries one or more
2608 given I<pages> and parses the returned data according to user specification.
2609 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2612 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2613 library. Please note that there is another library with a very similar name,
2614 libmemcache (notice the missing `d'), which is not applicable.
2616 Synopsis of the configuration:
2618 <Plugin "memcachec">
2619 <Page "plugin_instance">
2623 Regex "(\\d+) bytes sent"
2626 Instance "type_instance"
2631 The configuration options are:
2635 =item E<lt>B<Page> I<Name>E<gt>
2637 Each B<Page> block defines one I<page> to be queried from the memcached server.
2638 The block requires one string argument which is used as I<plugin instance>.
2640 =item B<Server> I<Address>
2642 Sets the server address to connect to when querying the page. Must be inside a
2647 When connected to the memcached server, asks for the page I<Key>.
2649 =item E<lt>B<Match>E<gt>
2651 Match blocks define which strings to look for and how matches substrings are
2652 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2656 =head2 Plugin C<memcached>
2658 The B<memcached plugin> connects to a memcached server and queries statistics
2659 about cache utilization, memory and bandwidth used.
2660 L<http://www.danga.com/memcached/>
2662 <Plugin "memcached">
2664 Host "memcache.example.com"
2669 The plugin configuration consists of one or more B<Instance> blocks which
2670 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2671 following options are allowed:
2675 =item B<Host> I<Hostname>
2677 Hostname to connect to. Defaults to B<127.0.0.1>.
2679 =item B<Port> I<Port>
2681 TCP-Port to connect to. Defaults to B<11211>.
2683 =item B<Socket> I<Path>
2685 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2686 setting is given, the B<Host> and B<Port> settings are ignored.
2690 =head2 Plugin C<mic>
2692 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2693 Intel's Many Integrated Core (MIC) systems.
2702 ShowTemperatures true
2705 IgnoreSelectedTemperature true
2710 IgnoreSelectedPower true
2713 The following options are valid inside the B<PluginE<nbsp>mic> block:
2717 =item B<ShowCPU> B<true>|B<false>
2719 If enabled (the default) a sum of the CPU usage across all cores is reported.
2721 =item B<ShowCPUCores> B<true>|B<false>
2723 If enabled (the default) per-core CPU usage is reported.
2725 =item B<ShowMemory> B<true>|B<false>
2727 If enabled (the default) the physical memory usage of the MIC system is
2730 =item B<ShowTemperatures> B<true>|B<false>
2732 If enabled (the default) various temperatures of the MIC system are reported.
2734 =item B<Temperature> I<Name>
2736 This option controls which temperatures are being reported. Whether matching
2737 temperatures are being ignored or I<only> matching temperatures are reported
2738 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2739 temperatures are reported.
2741 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2743 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2744 (the default) only temperatures matching a B<Temperature> option are reported
2745 or, if no B<Temperature> option is specified, all temperatures are reported. If
2746 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2749 Known temperature names are:
2783 =item B<ShowPower> B<true>|B<false>
2785 If enabled (the default) various temperatures of the MIC system are reported.
2787 =item B<Power> I<Name>
2789 This option controls which power readings are being reported. Whether matching
2790 power readings are being ignored or I<only> matching power readings are reported
2791 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2792 power readings are reported.
2794 =item B<IgnoreSelectedPower> B<false>|B<true>
2796 Controls the behavior of the B<Power> setting above. If set to B<false>
2797 (the default) only power readings matching a B<Power> option are reported
2798 or, if no B<Power> option is specified, all power readings are reported. If
2799 set to B<true>, matching power readings are I<ignored> and all other power readings
2802 Known power names are:
2808 Total power utilization averaged over Time Window 0 (uWatts).
2812 Total power utilization averaged over Time Window 0 (uWatts).
2816 Instantaneous power (uWatts).
2820 Max instantaneous power (uWatts).
2824 PCI-E connector power (uWatts).
2828 2x3 connector power (uWatts).
2832 2x4 connector power (uWatts).
2840 Uncore rail (uVolts).
2844 Memory subsystem rail (uVolts).
2850 =head2 Plugin C<memory>
2852 The I<memory plugin> provides the following configuration options:
2856 =item B<ValuesAbsolute> B<true>|B<false>
2858 Enables or disables reporting of physical memory usage in absolute numbers,
2859 i.e. bytes. Defaults to B<true>.
2861 =item B<ValuesPercentage> B<false>|B<true>
2863 Enables or disables reporting of physical memory usage in percentages, e.g.
2864 percent of physical memory used. Defaults to B<false>.
2866 This is useful for deploying I<collectd> in a heterogeneous environment in
2867 which the sizes of physical memory vary.
2871 =head2 Plugin C<modbus>
2873 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2874 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2875 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2876 values (two registers interpreted as IEEE floats in big endian notation).
2880 <Data "voltage-input-1">
2887 <Data "voltage-input-2">
2894 <Host "modbus.example.com">
2895 Address "192.168.0.42"
2900 Instance "power-supply"
2901 Collect "voltage-input-1"
2902 Collect "voltage-input-2"
2908 =item E<lt>B<Data> I<Name>E<gt> blocks
2910 Data blocks define a mapping between register numbers and the "types" used by
2913 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2917 =item B<RegisterBase> I<Number>
2919 Configures the base register to read from the device. If the option
2920 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2921 register will be read (the register number is increased by one).
2923 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2925 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2926 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2927 combined into one value. Defaults to B<Uint16>.
2929 =item B<Type> I<Type>
2931 Specifies the "type" (data set) to use when dispatching the value to
2932 I<collectd>. Currently, only data sets with exactly one data source are
2935 =item B<Instance> I<Instance>
2937 Sets the type instance to use when dispatching the value to I<collectd>. If
2938 unset, an empty string (no type instance) is used.
2942 =item E<lt>B<Host> I<Name>E<gt> blocks
2944 Host blocks are used to specify to which hosts to connect and what data to read
2945 from their "slaves". The string argument I<Name> is used as hostname when
2946 dispatching the values to I<collectd>.
2948 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2952 =item B<Address> I<Hostname>
2954 Specifies the node name (the actual network address) used to connect to the
2955 host. This may be an IP address or a hostname. Please note that the used
2956 I<libmodbus> library only supports IPv4 at the moment.
2958 =item B<Port> I<Service>
2960 Specifies the port used to connect to the host. The port can either be given as
2961 a number or as a service name. Please note that the I<Service> argument must be
2962 a string, even if ports are given in their numerical form. Defaults to "502".
2964 =item B<Interval> I<Interval>
2966 Sets the interval (in seconds) in which the values will be collected from this
2967 host. By default the global B<Interval> setting will be used.
2969 =item E<lt>B<Slave> I<ID>E<gt>
2971 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2972 is used to specify which device should be addressed. For each device you want
2973 to query, one B<Slave> block must be given.
2975 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2979 =item B<Instance> I<Instance>
2981 Specify the plugin instance to use when dispatching the values to I<collectd>.
2982 By default "slave_I<ID>" is used.
2984 =item B<Collect> I<DataName>
2986 Specifies which data to retrieve from the device. I<DataName> must be the same
2987 string as the I<Name> argument passed to a B<Data> block. You can specify this
2988 option multiple times to collect more than one value from a slave. At least one
2989 B<Collect> option is mandatory.
2997 =head2 Plugin C<mysql>
2999 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3000 one or more databases when started and keeps the connection up as long as
3001 possible. When the connection is interrupted for whatever reason it will try
3002 to re-connect. The plugin will complain loudly in case anything goes wrong.
3004 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3005 and collects information about MySQL network traffic, executed statements,
3006 requests, the query cache and threads by evaluating the
3007 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3008 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3009 Status Variables> for an explanation of these values.
3011 Optionally, master and slave statistics may be collected in a MySQL
3012 replication setup. In that case, information about the synchronization state
3013 of the nodes are collected by evaluating the C<Position> return value of the
3014 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3015 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3016 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3017 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3018 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3035 Socket "/var/run/mysql/mysqld.sock"
3037 SlaveNotifications true
3041 A B<Database> block defines one connection to a MySQL database. It accepts a
3042 single argument which specifies the name of the database. None of the other
3043 options are required. MySQL will use default values as documented in the
3044 section "mysql_real_connect()" in the B<MySQL reference manual>.
3048 =item B<Alias> I<Alias>
3050 Alias to use as sender instead of hostname when reporting. This may be useful
3051 when having cryptic hostnames.
3053 =item B<Host> I<Hostname>
3055 Hostname of the database server. Defaults to B<localhost>.
3057 =item B<User> I<Username>
3059 Username to use when connecting to the database. The user does not have to be
3060 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3061 unless you want to collectd replication statistics (see B<MasterStats> and
3062 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3063 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3065 =item B<Password> I<Password>
3067 Password needed to log into the database.
3069 =item B<Database> I<Database>
3071 Select this database. Defaults to I<no database> which is a perfectly reasonable
3072 option for what this plugin does.
3074 =item B<Port> I<Port>
3076 TCP-port to connect to. The port must be specified in its numeric form, but it
3077 must be passed as a string nonetheless. For example:
3081 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3082 See the documentation for the C<mysql_real_connect> function for details.
3084 =item B<Socket> I<Socket>
3086 Specifies the path to the UNIX domain socket of the MySQL server. This option
3087 only has any effect, if B<Host> is set to B<localhost> (the default).
3088 Otherwise, use the B<Port> option above. See the documentation for the
3089 C<mysql_real_connect> function for details.
3091 =item B<InnodbStats> I<true|false>
3093 If enabled, metrics about the InnoDB storage engine are collected.
3094 Disabled by default.
3096 =item B<MasterStats> I<true|false>
3098 =item B<SlaveStats> I<true|false>
3100 Enable the collection of master / slave statistics in a replication setup. In
3101 order to be able to get access to these statistics, the user needs special
3102 privileges. See the B<User> documentation above.
3104 =item B<SlaveNotifications> I<true|false>
3106 If enabled, the plugin sends a notification if the replication slave I/O and /
3107 or SQL threads are not running.
3109 =item B<ConnectTimeout> I<Seconds>
3111 Sets the connect timeout for the MySQL client.
3115 =head2 Plugin C<netapp>
3117 The netapp plugin can collect various performance and capacity information
3118 from a NetApp filer using the NetApp API.
3120 Please note that NetApp has a wide line of products and a lot of different
3121 software versions for each of these products. This plugin was developed for a
3122 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3123 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3124 model and software version but it is very hard to test this.
3125 If you have used this plugin with other models and/or software version, feel
3126 free to send us a mail to tell us about the results, even if it's just a short
3129 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3130 basic authentication.
3132 B<Do not use a regular user for this!> Create a special collectd user with just
3133 the minimum of capabilities needed. The user only needs the "login-http-admin"
3134 capability as well as a few more depending on which data will be collected.
3135 Required capabilities are documented below.
3140 <Host "netapp1.example.com">
3164 IgnoreSelectedIO false
3166 IgnoreSelectedOps false
3167 GetLatency "volume0"
3168 IgnoreSelectedLatency false
3175 IgnoreSelectedCapacity false
3178 IgnoreSelectedSnapshot false
3206 The netapp plugin accepts the following configuration options:
3210 =item B<Host> I<Name>
3212 A host block defines one NetApp filer. It will appear in collectd with the name
3213 you specify here which does not have to be its real name nor its hostname (see
3214 the B<Address> option below).
3216 =item B<VFiler> I<Name>
3218 A B<VFiler> block may only be used inside a host block. It accepts all the
3219 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3220 will execute all NetApp API commands in the context of the specified
3221 VFiler(R). It will appear in collectd with the name you specify here which
3222 does not have to be its real name. The VFiler name may be specified using the
3223 B<VFilerName> option. If this is not specified, it will default to the name
3226 The VFiler block inherits all connection related settings from the surrounding
3227 B<Host> block (which appear before the B<VFiler> block) but they may be
3228 overwritten inside the B<VFiler> block.
3230 This feature is useful, for example, when using a VFiler as SnapVault target
3231 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3232 available in the host filer (vfiler0) but only in the respective VFiler
3235 =item B<Protocol> B<httpd>|B<http>
3237 The protocol collectd will use to query this host.
3245 Valid options: http, https
3247 =item B<Address> I<Address>
3249 The hostname or IP address of the host.
3255 Default: The "host" block's name.
3257 =item B<Port> I<Port>
3259 The TCP port to connect to on the host.
3265 Default: 80 for protocol "http", 443 for protocol "https"
3267 =item B<User> I<User>
3269 =item B<Password> I<Password>
3271 The username and password to use to login to the NetApp.
3277 =item B<VFilerName> I<Name>
3279 The name of the VFiler in which context to execute API commands. If not
3280 specified, the name provided to the B<VFiler> block will be used instead.
3286 Default: name of the B<VFiler> block
3288 B<Note:> This option may only be used inside B<VFiler> blocks.
3290 =item B<Interval> I<Interval>
3296 The following options decide what kind of data will be collected. You can
3297 either use them as a block and fine tune various parameters inside this block,
3298 use them as a single statement to just accept all default values, or omit it to
3299 not collect any data.
3301 The following options are valid inside all blocks:
3305 =item B<Interval> I<Seconds>
3307 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3308 host specific setting.
3312 =head3 The System block
3314 This will collect various performance data about the whole system.
3316 B<Note:> To get this data the collectd user needs the
3317 "api-perf-object-get-instances" capability.
3321 =item B<Interval> I<Seconds>
3323 Collect disk statistics every I<Seconds> seconds.
3325 =item B<GetCPULoad> B<true>|B<false>
3327 If you set this option to true the current CPU usage will be read. This will be
3328 the average usage between all CPUs in your NetApp without any information about
3331 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3332 returns in the "CPU" field.
3340 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3342 =item B<GetInterfaces> B<true>|B<false>
3344 If you set this option to true the current traffic of the network interfaces
3345 will be read. This will be the total traffic over all interfaces of your NetApp
3346 without any information about individual interfaces.
3348 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3349 in the "Net kB/s" field.
3359 Result: One value list of type "if_octects".
3361 =item B<GetDiskIO> B<true>|B<false>
3363 If you set this option to true the current IO throughput will be read. This
3364 will be the total IO of your NetApp without any information about individual
3365 disks, volumes or aggregates.
3367 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3368 in the "DiskE<nbsp>kB/s" field.
3376 Result: One value list of type "disk_octets".
3378 =item B<GetDiskOps> B<true>|B<false>
3380 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3381 iSCSI, etc. operations will be read. This will be the total number of
3382 operations on your NetApp without any information about individual volumes or
3385 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3386 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3394 Result: A variable number of value lists of type "disk_ops_complex". Each type
3395 of operation will result in one value list with the name of the operation as
3400 =head3 The WAFL block
3402 This will collect various performance data about the WAFL file system. At the
3403 moment this just means cache performance.
3405 B<Note:> To get this data the collectd user needs the
3406 "api-perf-object-get-instances" capability.
3408 B<Note:> The interface to get these values is classified as "Diagnostics" by
3409 NetApp. This means that it is not guaranteed to be stable even between minor
3414 =item B<Interval> I<Seconds>
3416 Collect disk statistics every I<Seconds> seconds.
3418 =item B<GetNameCache> B<true>|B<false>
3426 Result: One value list of type "cache_ratio" and type instance
3429 =item B<GetDirCache> B<true>|B<false>
3437 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3439 =item B<GetInodeCache> B<true>|B<false>
3447 Result: One value list of type "cache_ratio" and type instance
3450 =item B<GetBufferCache> B<true>|B<false>
3452 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3453 in the "Cache hit" field.
3461 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3465 =head3 The Disks block
3467 This will collect performance data about the individual disks in the NetApp.
3469 B<Note:> To get this data the collectd user needs the
3470 "api-perf-object-get-instances" capability.
3474 =item B<Interval> I<Seconds>
3476 Collect disk statistics every I<Seconds> seconds.
3478 =item B<GetBusy> B<true>|B<false>
3480 If you set this option to true the busy time of all disks will be calculated
3481 and the value of the busiest disk in the system will be written.
3483 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3484 in the "Disk util" field. Probably.
3492 Result: One value list of type "percent" and type instance "disk_busy".
3496 =head3 The VolumePerf block
3498 This will collect various performance data about the individual volumes.
3500 You can select which data to collect about which volume using the following
3501 options. They follow the standard ignorelist semantic.
3503 B<Note:> To get this data the collectd user needs the
3504 I<api-perf-object-get-instances> capability.
3508 =item B<Interval> I<Seconds>
3510 Collect volume performance data every I<Seconds> seconds.
3512 =item B<GetIO> I<Volume>
3514 =item B<GetOps> I<Volume>
3516 =item B<GetLatency> I<Volume>
3518 Select the given volume for IO, operations or latency statistics collection.
3519 The argument is the name of the volume without the C</vol/> prefix.
3521 Since the standard ignorelist functionality is used here, you can use a string
3522 starting and ending with a slash to specify regular expression matching: To
3523 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3526 GetIO "/^vol[027]$/"
3528 If no regular expression is specified, an exact match is required. Both,
3529 regular and exact matching are case sensitive.
3531 If no volume was specified at all for either of the three options, that data
3532 will be collected for all available volumes.
3534 =item B<IgnoreSelectedIO> B<true>|B<false>
3536 =item B<IgnoreSelectedOps> B<true>|B<false>
3538 =item B<IgnoreSelectedLatency> B<true>|B<false>
3540 When set to B<true>, the volumes selected for IO, operations or latency
3541 statistics collection will be ignored and the data will be collected for all
3544 When set to B<false>, data will only be collected for the specified volumes and
3545 all other volumes will be ignored.
3547 If no volumes have been specified with the above B<Get*> options, all volumes
3548 will be collected regardless of the B<IgnoreSelected*> option.
3550 Defaults to B<false>
3554 =head3 The VolumeUsage block
3556 This will collect capacity data about the individual volumes.
3558 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3563 =item B<Interval> I<Seconds>
3565 Collect volume usage statistics every I<Seconds> seconds.
3567 =item B<GetCapacity> I<VolumeName>
3569 The current capacity of the volume will be collected. This will result in two
3570 to four value lists, depending on the configuration of the volume. All data
3571 sources are of type "df_complex" with the name of the volume as
3574 There will be type_instances "used" and "free" for the number of used and
3575 available bytes on the volume. If the volume has some space reserved for
3576 snapshots, a type_instance "snap_reserved" will be available. If the volume
3577 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3578 number of bytes saved by the SIS feature.
3580 B<Note:> The current NetApp API has a bug that results in this value being
3581 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3582 number which works most of the time. If you see strange values here, bug
3583 NetApp support to fix this.
3585 Repeat this option to specify multiple volumes.
3587 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3589 Specify whether to collect only the volumes selected by the B<GetCapacity>
3590 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3591 B<false>. However, if no B<GetCapacity> option is specified at all, all
3592 capacities will be selected anyway.
3594 =item B<GetSnapshot> I<VolumeName>
3596 Select volumes from which to collect snapshot information.
3598 Usually, the space used for snapshots is included in the space reported as
3599 "used". If snapshot information is collected as well, the space used for
3600 snapshots is subtracted from the used space.
3602 To make things even more interesting, it is possible to reserve space to be
3603 used for snapshots. If the space required for snapshots is less than that
3604 reserved space, there is "reserved free" and "reserved used" space in addition
3605 to "free" and "used". If the space required for snapshots exceeds the reserved
3606 space, that part allocated in the normal space is subtracted from the "used"
3609 Repeat this option to specify multiple volumes.
3611 =item B<IgnoreSelectedSnapshot>
3613 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3614 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3615 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3616 capacities will be selected anyway.
3620 =head3 The Quota block
3622 This will collect (tree) quota statistics (used disk space and number of used
3623 files). This mechanism is useful to get usage information for single qtrees.
3624 In case the quotas are not used for any other purpose, an entry similar to the
3625 following in C</etc/quotas> would be sufficient:
3627 /vol/volA/some_qtree tree - - - - -
3629 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3633 =item B<Interval> I<Seconds>
3635 Collect SnapVault(R) statistics every I<Seconds> seconds.
3639 =head3 The SnapVault block
3641 This will collect statistics about the time and traffic of SnapVault(R)
3646 =item B<Interval> I<Seconds>
3648 Collect SnapVault(R) statistics every I<Seconds> seconds.
3652 =head2 Plugin C<netlink>
3654 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3655 statistics of various interface and routing aspects.
3659 =item B<Interface> I<Interface>
3661 =item B<VerboseInterface> I<Interface>
3663 Instruct the plugin to collect interface statistics. This is basically the same
3664 as the statistics provided by the C<interface> plugin (see above) but
3665 potentially much more detailed.
3667 When configuring with B<Interface> only the basic statistics will be collected,
3668 namely octets, packets, and errors. These statistics are collected by
3669 the C<interface> plugin, too, so using both at the same time is no benefit.
3671 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3672 so that no data needs to be collected twice if you use the C<interface> plugin.
3673 This includes dropped packets, received multicast packets, collisions and a
3674 whole zoo of differentiated RX and TX errors. You can try the following command
3675 to get an idea of what awaits you:
3679 If I<Interface> is B<All>, all interfaces will be selected.
3681 =item B<QDisc> I<Interface> [I<QDisc>]
3683 =item B<Class> I<Interface> [I<Class>]
3685 =item B<Filter> I<Interface> [I<Filter>]
3687 Collect the octets and packets that pass a certain qdisc, class or filter.
3689 QDiscs and classes are identified by their type and handle (or classid).
3690 Filters don't necessarily have a handle, therefore the parent's handle is used.
3691 The notation used in collectd differs from that used in tc(1) in that it
3692 doesn't skip the major or minor number if it's zero and doesn't print special
3693 ids by their name. So, for example, a qdisc may be identified by
3694 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3695 thus not displayed by tc(1).
3697 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3698 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3699 associated with that interface will be collected.
3701 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3702 used. This may lead to problems when more than one filter is attached to a
3703 qdisc or class. This isn't nice, but we don't know how this could be done any
3704 better. If you have a idea, please don't hesitate to tell us.
3706 As with the B<Interface> option you can specify B<All> as the interface,
3707 meaning all interfaces.
3709 Here are some examples to help you understand the above text more easily:
3712 VerboseInterface "All"
3713 QDisc "eth0" "pfifo_fast-1:0"
3715 Class "ppp0" "htb-1:10"
3716 Filter "ppp0" "u32-1:0"
3719 =item B<IgnoreSelected>
3721 The behavior is the same as with all other similar plugins: If nothing is
3722 selected at all, everything is collected. If some things are selected using the
3723 options described above, only these statistics are collected. If you set
3724 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3725 specified statistics will not be collected.
3729 =head2 Plugin C<network>
3731 The Network plugin sends data to a remote instance of collectd, receives data
3732 from a remote instance, or both at the same time. Data which has been received
3733 from the network is usually not transmitted again, but this can be activated, see
3734 the B<Forward> option below.
3736 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3737 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3739 Both, B<Server> and B<Listen> can be used as single option or as block. When
3740 used as block, given options are valid for this socket only. The following
3741 example will export the metrics twice: Once to an "internal" server (without
3742 encryption and signing) and one to an external server (with cryptographic
3746 # Export to an internal server
3747 # (demonstrates usage without additional options)
3748 Server "collectd.internal.tld"
3750 # Export to an external server
3751 # (demonstrates usage with signature options)
3752 <Server "collectd.external.tld">
3753 SecurityLevel "sign"
3754 Username "myhostname"
3761 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3763 The B<Server> statement/block sets the server to send datagrams to. The
3764 statement may occur multiple times to send each datagram to multiple
3767 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3768 optional second argument specifies a port number or a service name. If not
3769 given, the default, B<25826>, is used.
3771 The following options are recognized within B<Server> blocks:
3775 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3777 Set the security you require for network communication. When the security level
3778 has been set to B<Encrypt>, data sent over the network will be encrypted using
3779 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3780 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3781 authentication code. When set to B<None>, data is sent without any security.
3783 This feature is only available if the I<network> plugin was linked with
3786 =item B<Username> I<Username>
3788 Sets the username to transmit. This is used by the server to lookup the
3789 password. See B<AuthFile> below. All security levels except B<None> require
3792 This feature is only available if the I<network> plugin was linked with
3795 =item B<Password> I<Password>
3797 Sets a password (shared secret) for this socket. All security levels except
3798 B<None> require this setting.
3800 This feature is only available if the I<network> plugin was linked with
3803 =item B<Interface> I<Interface name>
3805 Set the outgoing interface for IP packets. This applies at least
3806 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3807 undefined or a non-existent interface name is specified, the default
3808 behavior is to let the kernel choose the appropriate interface. Be warned
3809 that the manual selection of an interface for unicast traffic is only
3810 necessary in rare cases.
3814 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3816 The B<Listen> statement sets the interfaces to bind to. When multiple
3817 statements are found the daemon will bind to multiple interfaces.
3819 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3820 the argument is a multicast address the daemon will join that multicast group.
3821 The optional second argument specifies a port number or a service name. If not
3822 given, the default, B<25826>, is used.
3824 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3828 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3830 Set the security you require for network communication. When the security level
3831 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3832 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3833 signed and encrypted data is accepted. When set to B<None>, all data will be
3834 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3835 decrypted if possible.
3837 This feature is only available if the I<network> plugin was linked with
3840 =item B<AuthFile> I<Filename>
3842 Sets a file in which usernames are mapped to passwords. These passwords are
3843 used to verify signatures and to decrypt encrypted network packets. If
3844 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3845 verified and encrypted packets are decrypted. Otherwise, signed data is
3846 accepted without checking the signature and encrypted data cannot be decrypted.
3847 For the other security levels this option is mandatory.
3849 The file format is very simple: Each line consists of a username followed by a
3850 colon and any number of spaces followed by the password. To demonstrate, an
3851 example file could look like this:
3856 Each time a packet is received, the modification time of the file is checked
3857 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3858 the file is being read, it is locked using L<fcntl(2)>.
3860 =item B<Interface> I<Interface name>
3862 Set the incoming interface for IP packets explicitly. This applies at least
3863 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3864 undefined or a non-existent interface name is specified, the default
3865 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3866 traffic gets only accepted, if it arrives on the given interface.
3870 =item B<TimeToLive> I<1-255>
3872 Set the time-to-live of sent packets. This applies to all, unicast and
3873 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3874 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3877 =item B<MaxPacketSize> I<1024-65535>
3879 Set the maximum size for datagrams received over the network. Packets larger
3880 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3881 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3884 On the server side, this limit should be set to the largest value used on
3885 I<any> client. Likewise, the value on the client must not be larger than the
3886 value on the server, or data will be lost.
3888 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3889 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3890 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3893 =item B<Forward> I<true|false>
3895 If set to I<true>, write packets that were received via the network plugin to
3896 the sending sockets. This should only be activated when the B<Listen>- and
3897 B<Server>-statements differ. Otherwise packets may be send multiple times to
3898 the same multicast group. While this results in more network traffic than
3899 necessary it's not a huge problem since the plugin has a duplicate detection,
3900 so the values will not loop.
3902 =item B<ReportStats> B<true>|B<false>
3904 The network plugin cannot only receive and send statistics, it can also create
3905 statistics about itself. Collected data included the number of received and
3906 sent octets and packets, the length of the receive queue and the number of
3907 values handled. When set to B<true>, the I<Network plugin> will make these
3908 statistics available. Defaults to B<false>.
3912 =head2 Plugin C<nginx>
3914 This plugin collects the number of connections and requests handled by the
3915 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3916 queries the page provided by the C<ngx_http_stub_status_module> module, which
3917 isn't compiled by default. Please refer to
3918 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3919 how to compile and configure nginx and this module.
3921 The following options are accepted by the C<nginx plugin>:
3925 =item B<URL> I<http://host/nginx_status>
3927 Sets the URL of the C<ngx_http_stub_status_module> output.
3929 =item B<User> I<Username>
3931 Optional user name needed for authentication.
3933 =item B<Password> I<Password>
3935 Optional password needed for authentication.
3937 =item B<VerifyPeer> B<true|false>
3939 Enable or disable peer SSL certificate verification. See
3940 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3942 =item B<VerifyHost> B<true|false>
3944 Enable or disable peer host name verification. If enabled, the plugin checks
3945 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3946 certificate matches the host name provided by the B<URL> option. If this
3947 identity check fails, the connection is aborted. Obviously, only works when
3948 connecting to a SSL enabled server. Enabled by default.
3950 =item B<CACert> I<File>
3952 File that holds one or more SSL certificates. If you want to use HTTPS you will
3953 possibly need this option. What CA certificates come bundled with C<libcurl>
3954 and are checked by default depends on the distribution you use.
3958 =head2 Plugin C<notify_desktop>
3960 This plugin sends a desktop notification to a notification daemon, as defined
3961 in the Desktop Notification Specification. To actually display the
3962 notifications, B<notification-daemon> is required and B<collectd> has to be
3963 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3964 environment variables have to be set correctly) and the D-Bus message bus.
3966 The Desktop Notification Specification can be found at
3967 L<http://www.galago-project.org/specs/notification/>.
3971 =item B<OkayTimeout> I<timeout>
3973 =item B<WarningTimeout> I<timeout>
3975 =item B<FailureTimeout> I<timeout>
3977 Set the I<timeout>, in milliseconds, after which to expire the notification
3978 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3979 been specified, the displayed notification will not be closed at all - the
3980 user has to do so herself. These options default to 5000. If a negative number
3981 has been specified, the default is used as well.
3985 =head2 Plugin C<notify_email>
3987 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3988 configured email address.
3990 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
3992 Available configuration options:
3996 =item B<From> I<Address>
3998 Email address from which the emails should appear to come from.
4000 Default: C<root@localhost>
4002 =item B<Recipient> I<Address>
4004 Configures the email address(es) to which the notifications should be mailed.
4005 May be repeated to send notifications to multiple addresses.
4007 At least one B<Recipient> must be present for the plugin to work correctly.
4009 =item B<SMTPServer> I<Hostname>
4011 Hostname of the SMTP server to connect to.
4013 Default: C<localhost>
4015 =item B<SMTPPort> I<Port>
4017 TCP port to connect to.
4021 =item B<SMTPUser> I<Username>
4023 Username for ASMTP authentication. Optional.
4025 =item B<SMTPPassword> I<Password>
4027 Password for ASMTP authentication. Optional.
4029 =item B<Subject> I<Subject>
4031 Subject-template to use when sending emails. There must be exactly two
4032 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4033 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4036 Default: C<Collectd notify: %s@%s>
4040 =head2 Plugin C<ntpd>
4044 =item B<Host> I<Hostname>
4046 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4048 =item B<Port> I<Port>
4050 UDP-Port to connect to. Defaults to B<123>.
4052 =item B<ReverseLookups> B<true>|B<false>
4054 Sets whether or not to perform reverse lookups on peers. Since the name or
4055 IP-address may be used in a filename it is recommended to disable reverse
4056 lookups. The default is to do reverse lookups to preserve backwards
4057 compatibility, though.
4059 =item B<IncludeUnitID> B<true>|B<false>
4061 When a peer is a refclock, include the unit ID in the I<type instance>.
4062 Defaults to B<false> for backward compatibility.
4064 If two refclock peers use the same driver and this is B<false>, the plugin will
4065 try to write simultaneous measurements from both to the same type instance.
4066 This will result in error messages in the log and only one set of measurements
4071 =head2 Plugin C<nut>
4075 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4077 Add a UPS to collect data from. The format is identical to the one accepted by
4082 =head2 Plugin C<olsrd>
4084 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4085 the Optimized Link State Routing daemon and reads information about the current
4086 state of the meshed network.
4088 The following configuration options are understood:
4092 =item B<Host> I<Host>
4094 Connect to I<Host>. Defaults to B<"localhost">.
4096 =item B<Port> I<Port>
4098 Specifies the port to connect to. This must be a string, even if you give the
4099 port as a number rather than a service name. Defaults to B<"2006">.
4101 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4103 Specifies what information to collect about links, i.E<nbsp>e. direct
4104 connections of the daemon queried. If set to B<No>, no information is
4105 collected. If set to B<Summary>, the number of links and the average of all
4106 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4107 If set to B<Detail> LQ and NLQ are collected per link.
4109 Defaults to B<Detail>.
4111 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4113 Specifies what information to collect about routes of the daemon queried. If
4114 set to B<No>, no information is collected. If set to B<Summary>, the number of
4115 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4116 metric and ETX are collected per route.
4118 Defaults to B<Summary>.
4120 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4122 Specifies what information to collect about the global topology. If set to
4123 B<No>, no information is collected. If set to B<Summary>, the number of links
4124 in the entire topology and the average I<link quality> (LQ) is calculated.
4125 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4127 Defaults to B<Summary>.
4131 =head2 Plugin C<onewire>
4133 B<EXPERIMENTAL!> See notes below.
4135 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4136 L<http://owfs.org/> to read sensors connected via the onewire bus.
4138 It can be used in two possible modes - standard or advanced.
4140 In the standard mode only temperature sensors (sensors with the family code
4141 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4142 other sensors you would like to have included, please send a sort request to
4143 the mailing list. You can select sensors to be read or to be ignored depending
4144 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4145 walked and all sensors are read.
4147 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4148 experimental, below.
4150 In the advanced mode you can configure any sensor to be read (only numerical
4151 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4152 In this mode you have to list all the sensors. Neither default bus walk nor
4153 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4154 the path automatically and should produce compatible structure with the "standard"
4155 mode (basically the path is expected as for example
4156 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4157 "F10FCA000800" and the rest after the slash is considered the type - here
4159 There are two advantages to this mode - you can access virtually any sensor
4160 (not just temperature), select whether to use cached or directly read values
4161 and it is slighlty faster. The downside is more complex configuration.
4163 The two modes are distinguished automatically by the format of the address.
4164 It is not possible to mix the two modes. Once a full path is detected in any
4165 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4166 (and as standard addresses will fail parsing they will be ignored).
4170 =item B<Device> I<Device>
4172 Sets the device to read the values from. This can either be a "real" hardware
4173 device, such as a serial port or an USB port, or the address of the
4174 L<owserver(1)> socket, usually B<localhost:4304>.
4176 Though the documentation claims to automatically recognize the given address
4177 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4178 with that version, the following configuration worked for us:
4181 Device "-s localhost:4304"
4184 This directive is B<required> and does not have a default value.
4186 =item B<Sensor> I<Sensor>
4188 In the standard mode selects sensors to collect or to ignore
4189 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4190 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4191 and B<not> include the leading C<10.> family byte and point.
4192 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4193 sensors (see above) are read.
4195 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4196 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4197 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4199 As there can be multiple devices on the bus you can list multiple sensor (use
4200 multiple B<Sensor> elements).
4202 =item B<IgnoreSelected> I<true>|I<false>
4204 If no configuration is given, the B<onewire> plugin will collect data from all
4205 sensors found. This may not be practical, especially if sensors are added and
4206 removed regularly. Sometimes, however, it's easier/preferred to collect only
4207 specific sensors or all sensors I<except> a few specified ones. This option
4208 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4209 B<Sensor> is inverted: All selected interfaces are ignored and all other
4210 interfaces are collected.
4212 Used only in the standard mode - see above.
4214 =item B<Interval> I<Seconds>
4216 Sets the interval in which all sensors should be read. If not specified, the
4217 global B<Interval> setting is used.
4221 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4222 work with big setups. It works with one sensor being attached to one
4223 controller, but as soon as you throw in a couple more senors and maybe a hub
4224 or two, reading all values will take more than ten seconds (the default
4225 interval). We will probably add some separate thread for reading the sensors
4226 and some cache or something like that, but it's not done yet. We will try to
4227 maintain backwards compatibility in the future, but we can't promise. So in
4228 short: If it works for you: Great! But keep in mind that the config I<might>
4229 change, though this is unlikely. Oh, and if you want to help improving this
4230 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4232 =head2 Plugin C<openldap>
4234 To configure the C<openldap>-plugin you first need to configure the OpenLDAP
4235 server correctly. The backend database C<monitor> needs to be loaded and
4238 The configuration of the I<openldap> plugin consists of one or more
4239 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
4240 as the instance name. For example:
4244 URL "ldap://localhost/"
4247 URL "ldaps://localhost/"
4251 The instance name will be used as the I<plugin instance>. To emulate the old
4252 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
4253 plugin to work correctly, each instance name must be unique. This is not
4254 enforced by the plugin and it is your responsibility to ensure it.
4256 The following options are accepted within each I<Instance> block:
4260 =item B<URL> I<ldap://host/binddn>
4262 Sets the URL of the C<openldap> server. This option is I<mandatory>.
4264 =item B<VerifyHost> B<true|false>
4266 Enable or disable peer host name verification. If enabled, the plugin checks
4267 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
4268 certificate matches the host name provided by the B<URL> option. If this
4269 identity check fails, the connection is aborted. Enabled by default.
4271 =item B<CACert> I<File>
4273 File that holds one or more SSL certificates. If you want to use TLS/SSL you may
4274 possibly need this option. What CA certificates come bundled with C<libldap>
4275 and are checked by default depends on the distribution you use.
4279 =head2 Plugin C<openvpn>
4281 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4282 traffic statistics about connected clients.
4284 To set up OpenVPN to write to the status file periodically, use the
4285 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4286 you need to set the required format, too. This is done by setting
4287 B<--status-version> to B<2>.
4289 So, in a nutshell you need:
4291 openvpn $OTHER_OPTIONS \
4292 --status "/var/run/openvpn-status" 10 \
4299 =item B<StatusFile> I<File>
4301 Specifies the location of the status file.
4303 =item B<ImprovedNamingSchema> B<true>|B<false>
4305 When enabled, the filename of the status file will be used as plugin instance
4306 and the client's "common name" will be used as type instance. This is required
4307 when reading multiple status files. Enabling this option is recommended, but to
4308 maintain backwards compatibility this option is disabled by default.
4310 =item B<CollectCompression> B<true>|B<false>
4312 Sets whether or not statistics about the compression used by OpenVPN should be
4313 collected. This information is only available in I<single> mode. Enabled by
4316 =item B<CollectIndividualUsers> B<true>|B<false>
4318 Sets whether or not traffic information is collected for each connected client
4319 individually. If set to false, currently no traffic data is collected at all
4320 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4322 =item B<CollectUserCount> B<true>|B<false>
4324 When enabled, the number of currently connected clients or users is collected.
4325 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4326 can be configured independently from that option. Defaults to B<false>.
4330 =head2 Plugin C<oracle>
4332 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4333 Oracle® Database and lets you execute SQL statements there. It is very similar
4334 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4335 plugin's documentation above for details.
4338 <Query "out_of_stock">
4339 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4342 # InstancePrefix "foo"
4343 InstancesFrom "category"
4347 <Database "product_information">
4351 Query "out_of_stock"
4355 =head3 B<Query> blocks
4357 The Query blocks are handled identically to the Query blocks of the "dbi"
4358 plugin. Please see its documentation above for details on how to specify
4361 =head3 B<Database> blocks
4363 Database blocks define a connection to a database and which queries should be
4364 sent to that database. Each database needs a "name" as string argument in the
4365 starting tag of the block. This name will be used as "PluginInstance" in the
4366 values submitted to the daemon. Other than that, that name is not used.
4370 =item B<ConnectID> I<ID>
4372 Defines the "database alias" or "service name" to connect to. Usually, these
4373 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4375 =item B<Host> I<Host>
4377 Hostname to use when dispatching values for this database. Defaults to using
4378 the global hostname of the I<collectd> instance.
4380 =item B<Username> I<Username>
4382 Username used for authentication.
4384 =item B<Password> I<Password>
4386 Password used for authentication.
4388 =item B<Query> I<QueryName>
4390 Associates the query named I<QueryName> with this database connection. The
4391 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4392 blocks you want to refer to must be placed above the database block you want to
4397 =head2 Plugin C<perl>
4399 This plugin embeds a Perl-interpreter into collectd and provides an interface
4400 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4402 =head2 Plugin C<pinba>
4404 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4405 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4406 PHP-based webpage has been delivered, the extension will send a UDP packet
4407 containing timing information, peak memory usage and so on. The plugin will
4408 wait for such packets, parse them and account the provided information, which
4409 is then dispatched to the daemon once per interval.
4416 # Overall statistics for the website.
4418 Server "www.example.com"
4420 # Statistics for www-a only
4422 Host "www-a.example.com"
4423 Server "www.example.com"
4425 # Statistics for www-b only
4427 Host "www-b.example.com"
4428 Server "www.example.com"
4432 The plugin provides the following configuration options:
4436 =item B<Address> I<Node>
4438 Configures the address used to open a listening socket. By default, plugin will
4439 bind to the I<any> address C<::0>.
4441 =item B<Port> I<Service>
4443 Configures the port (service) to bind to. By default the default Pinba port
4444 "30002" will be used. The option accepts service names in addition to port
4445 numbers and thus requires a I<string> argument.
4447 =item E<lt>B<View> I<Name>E<gt> block
4449 The packets sent by the Pinba extension include the hostname of the server, the
4450 server name (the name of the virtual host) and the script that was executed.
4451 Using B<View> blocks it is possible to separate the data into multiple groups
4452 to get more meaningful statistics. Each packet is added to all matching groups,
4453 so that a packet may be accounted for more than once.
4457 =item B<Host> I<Host>
4459 Matches the hostname of the system the webserver / script is running on. This
4460 will contain the result of the L<gethostname(2)> system call. If not
4461 configured, all hostnames will be accepted.
4463 =item B<Server> I<Server>
4465 Matches the name of the I<virtual host>, i.e. the contents of the
4466 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4467 server names will be accepted.
4469 =item B<Script> I<Script>
4471 Matches the name of the I<script name>, i.e. the contents of the
4472 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4473 script names will be accepted.
4479 =head2 Plugin C<ping>
4481 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4482 configured hosts periodically and measures the network latency. Whenever the
4483 C<read> function of the plugin is called, it submits the average latency, the
4484 standard deviation and the drop rate for each host.
4486 Available configuration options:
4490 =item B<Host> I<IP-address>
4492 Host to ping periodically. This option may be repeated several times to ping
4495 =item B<Interval> I<Seconds>
4497 Sets the interval in which to send ICMP echo packets to the configured hosts.
4498 This is B<not> the interval in which statistics are queries from the plugin but
4499 the interval in which the hosts are "pinged". Therefore, the setting here
4500 should be smaller than or equal to the global B<Interval> setting. Fractional
4501 times, such as "1.24" are allowed.
4505 =item B<Timeout> I<Seconds>
4507 Time to wait for a response from the host to which an ICMP packet had been
4508 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4509 to be down or the packet to be dropped. This setting must be smaller than the
4510 B<Interval> setting above for the plugin to work correctly. Fractional
4511 arguments are accepted.
4515 =item B<TTL> I<0-255>
4517 Sets the Time-To-Live of generated ICMP packets.
4519 =item B<SourceAddress> I<host>
4521 Sets the source address to use. I<host> may either be a numerical network
4522 address or a network hostname.
4524 =item B<Device> I<name>
4526 Sets the outgoing network device to be used. I<name> has to specify an
4527 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4530 =item B<MaxMissed> I<Packets>
4532 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4533 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4535 Default: B<-1> (disabled)
4539 =head2 Plugin C<postgresql>
4541 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4542 keeps a persistent connection to all configured databases and tries to
4543 reconnect if the connection has been interrupted. A database is configured by
4544 specifying a B<Database> block as described below. The default statistics are
4545 collected from PostgreSQL's B<statistics collector> which thus has to be
4546 enabled for this plugin to work correctly. This should usually be the case by
4547 default. See the section "The Statistics Collector" of the B<PostgreSQL
4548 Documentation> for details.
4550 By specifying custom database queries using a B<Query> block as described
4551 below, you may collect any data that is available from some PostgreSQL
4552 database. This way, you are able to access statistics of external daemons
4553 which are available in a PostgreSQL database or use future or special
4554 statistics provided by PostgreSQL without the need to upgrade your collectd
4557 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4558 PostgreSQL databases as well. This has been implemented in a generic way. You
4559 need to specify an SQL statement which will then be executed by collectd in
4560 order to write the data (see below for details). The benefit of that approach
4561 is that there is no fixed database layout. Rather, the layout may be optimized
4562 for the current setup.
4564 The B<PostgreSQL Documentation> manual can be found at
4565 L<http://www.postgresql.org/docs/manuals/>.
4569 Statement "SELECT magic FROM wizard WHERE host = $1;"
4573 InstancePrefix "magic"
4578 <Query rt36_tickets>
4579 Statement "SELECT COUNT(type) AS count, type \
4581 WHEN resolved = 'epoch' THEN 'open' \
4582 ELSE 'resolved' END AS type \
4583 FROM tickets) type \
4587 InstancePrefix "rt36_tickets"
4588 InstancesFrom "type"
4594 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4604 KRBSrvName "kerberos_service_name"
4610 Service "service_name"
4611 Query backend # predefined
4622 The B<Query> block defines one database query which may later be used by a
4623 database definition. It accepts a single mandatory argument which specifies
4624 the name of the query. The names of all queries have to be unique (see the
4625 B<MinVersion> and B<MaxVersion> options below for an exception to this
4626 rule). The following configuration options are available to define the query:
4628 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4629 blocks define how to handle the values returned from the query. They define
4630 which column holds which value and how to dispatch that value to the daemon.
4631 Multiple B<Result> blocks may be used to extract multiple values from a single
4636 =item B<Statement> I<sql query statement>
4638 Specify the I<sql query statement> which the plugin should execute. The string
4639 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4640 first, second, etc. parameter. The value of the parameters is specified by the
4641 B<Param> configuration option - see below for details. To include a literal
4642 B<$> character followed by a number, surround it with single quotes (B<'>).
4644 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4645 allowed. Note, however, that only a single command may be used. Semicolons are
4646 allowed as long as a single non-empty command has been specified only.
4648 The returned lines will be handled separately one after another.
4650 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4652 Specify the parameters which should be passed to the SQL query. The parameters
4653 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4654 they appear in the configuration file. The value of the parameter is
4655 determined depending on the value of the B<Param> option as follows:
4661 The configured hostname of the database connection. If a UNIX domain socket is
4662 used, the parameter expands to "localhost".
4666 The name of the database of the current connection.
4670 The name of the database plugin instance. See the B<Instance> option of the
4671 database specification below for details.
4675 The username used to connect to the database.
4679 The interval with which this database is queried (as specified by the database
4680 specific or global B<Interval> options).
4684 Please note that parameters are only supported by PostgreSQL's protocol
4685 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4687 =item B<Type> I<type>
4689 The I<type> name to be used when dispatching the values. The type describes
4690 how to handle the data and where to store it. See L<types.db(5)> for more
4691 details on types and their configuration. The number and type of values (as
4692 selected by the B<ValuesFrom> option) has to match the type of the given name.
4694 This option is required inside a B<Result> block.
4696 =item B<InstancePrefix> I<prefix>
4698 =item B<InstancesFrom> I<column0> [I<column1> ...]
4700 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4701 B<InstancePrefix> defines a static prefix that will be prepended to all type
4702 instances. B<InstancesFrom> defines the column names whose values will be used
4703 to create the type instance. Multiple values will be joined together using the
4704 hyphen (C<->) as separation character.
4706 The plugin itself does not check whether or not all built instances are
4707 different. It is your responsibility to assure that each is unique.
4709 Both options are optional. If none is specified, the type instance will be
4712 =item B<ValuesFrom> I<column0> [I<column1> ...]
4714 Names the columns whose content is used as the actual data for the data sets
4715 that are dispatched to the daemon. How many such columns you need is
4716 determined by the B<Type> setting as explained above. If you specify too many
4717 or not enough columns, the plugin will complain about that and no data will be
4718 submitted to the daemon.
4720 The actual data type, as seen by PostgreSQL, is not that important as long as
4721 it represents numbers. The plugin will automatically cast the values to the
4722 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4723 L<strtod(3)> functions, so anything supported by those functions is supported
4724 by the plugin as well.
4726 This option is required inside a B<Result> block and may be specified multiple
4727 times. If multiple B<ValuesFrom> options are specified, the columns are read
4730 =item B<MinVersion> I<version>
4732 =item B<MaxVersion> I<version>
4734 Specify the minimum or maximum version of PostgreSQL that this query should be
4735 used with. Some statistics might only be available with certain versions of
4736 PostgreSQL. This allows you to specify multiple queries with the same name but
4737 which apply to different versions, thus allowing you to use the same
4738 configuration in a heterogeneous environment.
4740 The I<version> has to be specified as the concatenation of the major, minor
4741 and patch-level versions, each represented as two-decimal-digit numbers. For
4742 example, version 8.2.3 will become 80203.
4746 The following predefined queries are available (the definitions can be found
4747 in the F<postgresql_default.conf> file which, by default, is available at
4748 C<I<prefix>/share/collectd/>):
4754 This query collects the number of backends, i.E<nbsp>e. the number of
4757 =item B<transactions>
4759 This query collects the numbers of committed and rolled-back transactions of
4764 This query collects the numbers of various table modifications (i.E<nbsp>e.
4765 insertions, updates, deletions) of the user tables.
4767 =item B<query_plans>
4769 This query collects the numbers of various table scans and returned tuples of
4772 =item B<table_states>
4774 This query collects the numbers of live and dead rows in the user tables.
4778 This query collects disk block access counts for user tables.
4782 This query collects the on-disk size of the database in bytes.
4786 In addition, the following detailed queries are available by default. Please
4787 note that each of those queries collects information B<by table>, thus,
4788 potentially producing B<a lot> of data. For details see the description of the
4789 non-by_table queries above.
4793 =item B<queries_by_table>
4795 =item B<query_plans_by_table>
4797 =item B<table_states_by_table>
4799 =item B<disk_io_by_table>
4803 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4804 mandatory argument specifying the name of the writer. This will then be used
4805 in the B<Database> specification in order to activate the writer instance. The
4806 names of all writers have to be unique. The following options may be
4811 =item B<Statement> I<sql statement>
4813 This mandatory option specifies the SQL statement that will be executed for
4814 each submitted value. A single SQL statement is allowed only. Anything after
4815 the first semicolon will be ignored.
4817 Nine parameters will be passed to the statement and should be specified as
4818 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4819 values are made available through those parameters:
4825 The timestamp of the queried value as a floating point number.
4829 The hostname of the queried value.
4833 The plugin name of the queried value.
4837 The plugin instance of the queried value. This value may be B<NULL> if there
4838 is no plugin instance.
4842 The type of the queried value (cf. L<types.db(5)>).
4846 The type instance of the queried value. This value may be B<NULL> if there is
4851 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4852 sources of the submitted value-list).
4856 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4857 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4858 B<StoreRates> is enabled (which is the default, see below), all types will be
4863 An array of the submitted values. The dimensions of the value name and value
4868 In general, it is advisable to create and call a custom function in the
4869 PostgreSQL database for this purpose. Any procedural language supported by
4870 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4873 =item B<StoreRates> B<false>|B<true>
4875 If set to B<true> (the default), convert counter values to rates. If set to
4876 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4881 The B<Database> block defines one PostgreSQL database for which to collect
4882 statistics. It accepts a single mandatory argument which specifies the
4883 database name. None of the other options are required. PostgreSQL will use
4884 default values as documented in the section "CONNECTING TO A DATABASE" in the
4885 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4886 the user collectd is run as and special environment variables. See the manpage
4891 =item B<Interval> I<seconds>
4893 Specify the interval with which the database should be queried. The default is
4894 to use the global B<Interval> setting.
4896 =item B<CommitInterval> I<seconds>
4898 This option may be used for database connections which have "writers" assigned
4899 (see above). If specified, it causes a writer to put several updates into a
4900 single transaction. This transaction will last for the specified amount of
4901 time. By default, each update will be executed in a separate transaction. Each
4902 transaction generates a fair amount of overhead which can, thus, be reduced by
4903 activating this option. The draw-back is, that data covering the specified
4904 amount of time will be lost, for example, if a single statement within the
4905 transaction fails or if the database server crashes.
4907 =item B<Host> I<hostname>
4909 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4910 value begins with a slash, it is interpreted as the directory name in which to
4911 look for the UNIX domain socket.
4913 This option is also used to determine the hostname that is associated with a
4914 collected data set. If it has been omitted or either begins with with a slash
4915 or equals B<localhost> it will be replaced with the global hostname definition
4916 of collectd. Any other value will be passed literally to collectd when
4917 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4919 =item B<Port> I<port>
4921 Specify the TCP port or the local UNIX domain socket file extension of the
4924 =item B<User> I<username>
4926 Specify the username to be used when connecting to the server.
4928 =item B<Password> I<password>
4930 Specify the password to be used when connecting to the server.
4932 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4934 Specify whether to use an SSL connection when contacting the server. The
4935 following modes are supported:
4941 Do not use SSL at all.
4945 First, try to connect without using SSL. If that fails, try using SSL.
4947 =item I<prefer> (default)
4949 First, try to connect using SSL. If that fails, try without using SSL.
4957 =item B<Instance> I<name>
4959 Specify the plugin instance name that should be used instead of the database
4960 name (which is the default, if this option has not been specified). This
4961 allows to query multiple databases of the same name on the same host (e.g.
4962 when running multiple database server versions in parallel).
4964 =item B<KRBSrvName> I<kerberos_service_name>
4966 Specify the Kerberos service name to use when authenticating with Kerberos 5
4967 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4968 B<PostgreSQL Documentation> for details.
4970 =item B<Service> I<service_name>
4972 Specify the PostgreSQL service name to use for additional parameters. That
4973 service has to be defined in F<pg_service.conf> and holds additional
4974 connection parameters. See the section "The Connection Service File" in the
4975 B<PostgreSQL Documentation> for details.
4977 =item B<Query> I<query>
4979 Specifies a I<query> which should be executed in the context of the database
4980 connection. This may be any of the predefined or user-defined queries. If no
4981 such option is given, it defaults to "backends", "transactions", "queries",
4982 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4983 has been specified). Else, the specified queries are used only.
4985 =item B<Writer> I<writer>
4987 Assigns the specified I<writer> backend to the database connection. This
4988 causes all collected data to be send to the database using the settings
4989 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4990 below for details on how to selectively send data to certain plugins).
4992 Each writer will register a flush callback which may be used when having long
4993 transactions enabled (see the B<CommitInterval> option above). When issuing
4994 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4995 transaction will be committed right away. Two different kinds of flush
4996 callbacks are available with the C<postgresql> plugin:
5002 Flush all writer backends.
5004 =item B<postgresql->I<database>
5006 Flush all writers of the specified I<database> only.
5012 =head2 Plugin C<powerdns>
5014 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
5015 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
5016 values, many of which are probably meaningless to most users, but may be useful
5017 for some. So you may chose which values to collect, but if you don't, some
5018 reasonable defaults will be collected.
5021 <Server "server_name">
5023 Collect "udp-answers" "udp-queries"
5024 Socket "/var/run/pdns.controlsocket"
5026 <Recursor "recursor_name">
5028 Collect "cache-hits" "cache-misses"
5029 Socket "/var/run/pdns_recursor.controlsocket"
5031 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
5036 =item B<Server> and B<Recursor> block
5038 The B<Server> block defines one authoritative server to query, the B<Recursor>
5039 does the same for an recursing server. The possible options in both blocks are
5040 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5045 =item B<Collect> I<Field>
5047 Using the B<Collect> statement you can select which values to collect. Here,
5048 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5049 C<dlg-only-drops>, C<answers10-100>.
5051 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5052 When querying the server a C<SHOW *> command is issued in any case, because
5053 that's the only way of getting multiple values out of the server at once.
5054 collectd then picks out the values you have selected. When querying the
5055 recursor, a command is generated to query exactly these values. So if you
5056 specify invalid fields when querying the recursor, a syntax error may be
5057 returned by the daemon and collectd may not collect any values at all.
5059 If no B<Collect> statement is given, the following B<Server> values will be
5066 =item packetcache-hit
5068 =item packetcache-miss
5070 =item packetcache-size
5072 =item query-cache-hit
5074 =item query-cache-miss
5076 =item recursing-answers
5078 =item recursing-questions
5090 The following B<Recursor> values will be collected by default:
5094 =item noerror-answers
5096 =item nxdomain-answers
5098 =item servfail-answers
5116 Please note that up to that point collectd doesn't know what values are
5117 available on the server and values that are added do not need a change of the
5118 mechanism so far. However, the values must be mapped to collectd's naming
5119 scheme, which is done using a lookup table that lists all known values. If
5120 values are added in the future and collectd does not know about them, you will
5121 get an error much like this:
5123 powerdns plugin: submit: Not found in lookup table: foobar = 42
5125 In this case please file a bug report with the collectd team.
5127 =item B<Socket> I<Path>
5129 Configures the path to the UNIX domain socket to be used when connecting to the
5130 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5131 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5132 will be used for the recursor.
5136 =item B<LocalSocket> I<Path>
5138 Querying the recursor is done using UDP. When using UDP over UNIX domain
5139 sockets, the client socket needs a name in the file system, too. You can set
5140 this local name to I<Path> using the B<LocalSocket> option. The default is
5141 C<I<prefix>/var/run/collectd-powerdns>.
5145 =head2 Plugin C<processes>
5149 =item B<Process> I<Name>
5151 Select more detailed statistics of processes matching this name. The statistics
5152 collected for these selected processes are size of the resident segment size
5153 (RSS), user- and system-time used, number of processes and number of threads,
5154 io data (where available) and minor and major pagefaults.
5156 =item B<ProcessMatch> I<name> I<regex>
5158 Similar to the B<Process> option this allows to select more detailed
5159 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5160 details). The statistics of all matching processes are summed up and
5161 dispatched to the daemon using the specified I<name> as an identifier. This
5162 allows to "group" several processes together. I<name> must not contain
5167 =head2 Plugin C<protocols>
5169 Collects a lot of information about various network protocols, such as I<IP>,
5170 I<TCP>, I<UDP>, etc.
5172 Available configuration options:
5176 =item B<Value> I<Selector>
5178 Selects whether or not to select a specific value. The string being matched is
5179 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5180 plugin instance and I<ValueName> will be used as type instance. An example of
5181 the string being used would be C<Tcp:RetransSegs>.
5183 You can use regular expressions to match a large number of values with just one
5184 configuration option. To select all "extended" I<TCP> values, you could use the
5185 following statement:
5189 Whether only matched values are selected or all matched values are ignored
5190 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5191 If no value is configured at all, all values will be selected.
5193 =item B<IgnoreSelected> B<true>|B<false>
5195 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5196 matching values will be ignored.
5200 =head2 Plugin C<python>
5202 This plugin embeds a Python-interpreter into collectd and provides an interface
5203 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5205 =head2 Plugin C<routeros>
5207 The C<routeros> plugin connects to a device running I<RouterOS>, the
5208 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5209 I<librouteros> to connect and reads information about the interfaces and
5210 wireless connections of the device. The configuration supports querying
5215 Host "router0.example.com"
5218 CollectInterface true
5223 Host "router1.example.com"
5226 CollectInterface true
5227 CollectRegistrationTable true
5233 As you can see above, the configuration of the I<routeros> plugin consists of
5234 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5235 options are understood:
5239 =item B<Host> I<Host>
5241 Hostname or IP-address of the router to connect to.
5243 =item B<Port> I<Port>
5245 Port name or port number used when connecting. If left unspecified, the default
5246 will be chosen by I<librouteros>, currently "8728". This option expects a
5247 string argument, even when a numeric port number is given.
5249 =item B<User> I<User>
5251 Use the user name I<User> to authenticate. Defaults to "admin".
5253 =item B<Password> I<Password>
5255 Set the password used to authenticate.
5257 =item B<CollectInterface> B<true>|B<false>
5259 When set to B<true>, interface statistics will be collected for all interfaces
5260 present on the device. Defaults to B<false>.
5262 =item B<CollectRegistrationTable> B<true>|B<false>
5264 When set to B<true>, information about wireless LAN connections will be
5265 collected. Defaults to B<false>.
5267 =item B<CollectCPULoad> B<true>|B<false>
5269 When set to B<true>, information about the CPU usage will be collected. The
5270 number is a dimensionless value where zero indicates no CPU usage at all.
5271 Defaults to B<false>.
5273 =item B<CollectMemory> B<true>|B<false>
5275 When enabled, the amount of used and free memory will be collected. How used
5276 memory is calculated is unknown, for example whether or not caches are counted
5278 Defaults to B<false>.
5280 =item B<CollectDF> B<true>|B<false>
5282 When enabled, the amount of used and free disk space will be collected.
5283 Defaults to B<false>.
5285 =item B<CollectDisk> B<true>|B<false>
5287 When enabled, the number of sectors written and bad blocks will be collected.
5288 Defaults to B<false>.
5292 =head2 Plugin C<redis>
5294 The I<Redis plugin> connects to one or more Redis servers and gathers
5295 information about each server's state. For each server there is a I<Node> block
5296 which configures the connection parameters for this node.
5306 The information shown in the synopsis above is the I<default configuration>
5307 which is used by the plugin if no configuration is present.
5311 =item B<Node> I<Nodename>
5313 The B<Node> block identifies a new Redis node, that is a new Redis instance
5314 running in an specified host and port. The name for node is a canonical
5315 identifier which is used as I<plugin instance>. It is limited to
5316 64E<nbsp>characters in length.
5318 =item B<Host> I<Hostname>
5320 The B<Host> option is the hostname or IP-address where the Redis instance is
5323 =item B<Port> I<Port>
5325 The B<Port> option is the TCP port on which the Redis instance accepts
5326 connections. Either a service name of a port number may be given. Please note
5327 that numerical port numbers must be given as a string, too.
5329 =item B<Password> I<Password>
5331 Use I<Password> to authenticate when connecting to I<Redis>.
5333 =item B<Timeout> I<Timeout in miliseconds>
5335 The B<Timeout> option set the socket timeout for node response. Since the Redis
5336 read function is blocking, you should keep this value as low as possible. Keep
5337 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5338 than B<Interval> defined globally.
5342 =head2 Plugin C<rrdcached>
5344 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5345 to store values to RRD files in an efficient manner. The combination of the
5346 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5347 way the C<rrdtool> plugin works (see below). The added abstraction layer
5348 provides a number of benefits, though: Because the cache is not within
5349 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5350 restarted. This results in much shorter (if any) gaps in graphs, especially
5351 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5352 daemon so that it can flush values to disk automatically when needed. This
5353 allows to integrate automated flushing of values into graphing solutions much
5356 There are disadvantages, though: The daemon may reside on a different host, so
5357 it may not be possible for C<collectd> to create the appropriate RRD files
5358 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5359 different base directory, so relative paths may do weird stuff if you're not
5362 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5363 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5364 setting should be set to an absolute path, so that a changed base directory
5365 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5369 =item B<DaemonAddress> I<Address>
5371 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5372 library. See L<rrdcached(1)> for details. Example:
5374 <Plugin "rrdcached">
5375 DaemonAddress "unix:/var/run/rrdcached.sock"
5378 =item B<DataDir> I<Directory>
5380 Set the base directory in which the RRD files reside. If this is a relative
5381 path, it is relative to the working base directory of the C<rrdcached> daemon!
5382 Use of an absolute path is recommended.
5384 =item B<CreateFiles> B<true>|B<false>
5386 Enables or disables the creation of RRD files. If the daemon is not running
5387 locally, or B<DataDir> is set to a relative path, this will not work as
5388 expected. Default is B<true>.
5390 =item B<CreateFilesAsync> B<false>|B<true>
5392 When enabled, new RRD files are enabled asynchronously, using a separate thread
5393 that runs in the background. This prevents writes to block, which is a problem
5394 especially when many hundreds of files need to be created at once. However,
5395 since the purpose of creating the files asynchronously is I<not> to block until
5396 the file is available, values before the file is available will be discarded.
5397 When disabled (the default) files are created synchronously, blocking for a
5398 short while, while the file is being written.
5400 =item B<StepSize> I<Seconds>
5402 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5403 this setting is unset and the stepsize is set to the interval in which the data
5404 is collected. Do not use this option unless you absolutely have to for some
5405 reason. Setting this option may cause problems with the C<snmp plugin>, the
5406 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5408 =item B<HeartBeat> I<Seconds>
5410 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5411 in which case the heartbeat is set to twice the B<StepSize> which should equal
5412 the interval in which data is collected. Do not set this option unless you have
5413 a very good reason to do so.
5415 =item B<RRARows> I<NumRows>
5417 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5418 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5419 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5420 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5421 week, one month, and one year.
5423 So for each timespan, it calculates how many PDPs need to be consolidated into
5424 one CDP by calculating:
5425 number of PDPs = timespan / (stepsize * rrarows)
5427 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5430 =item B<RRATimespan> I<Seconds>
5432 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5433 more then one RRA. If this option is never used, the built-in default of (3600,
5434 86400, 604800, 2678400, 31622400) is used.
5436 For more information on how RRA-sizes are calculated see B<RRARows> above.
5438 =item B<XFF> I<Factor>
5440 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5441 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5446 =head2 Plugin C<rrdtool>
5448 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5449 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5450 using these settings. If you don't want to dive into the depths of RRDtool, you
5451 can safely ignore these settings.
5455 =item B<DataDir> I<Directory>
5457 Set the directory to store RRD files under. By default RRD files are generated
5458 beneath the daemon's working directory, i.e. the B<BaseDir>.
5460 =item B<CreateFilesAsync> B<false>|B<true>
5462 When enabled, new RRD files are enabled asynchronously, using a separate thread
5463 that runs in the background. This prevents writes to block, which is a problem
5464 especially when many hundreds of files need to be created at once. However,
5465 since the purpose of creating the files asynchronously is I<not> to block until
5466 the file is available, values before the file is available will be discarded.
5467 When disabled (the default) files are created synchronously, blocking for a
5468 short while, while the file is being written.
5470 =item B<StepSize> I<Seconds>
5472 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5473 this setting is unset and the stepsize is set to the interval in which the data
5474 is collected. Do not use this option unless you absolutely have to for some
5475 reason. Setting this option may cause problems with the C<snmp plugin>, the
5476 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5478 =item B<HeartBeat> I<Seconds>
5480 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5481 in which case the heartbeat is set to twice the B<StepSize> which should equal
5482 the interval in which data is collected. Do not set this option unless you have
5483 a very good reason to do so.
5485 =item B<RRARows> I<NumRows>
5487 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5488 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5489 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5490 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5491 week, one month, and one year.
5493 So for each timespan, it calculates how many PDPs need to be consolidated into
5494 one CDP by calculating:
5495 number of PDPs = timespan / (stepsize * rrarows)
5497 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5500 =item B<RRATimespan> I<Seconds>
5502 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5503 more then one RRA. If this option is never used, the built-in default of (3600,
5504 86400, 604800, 2678400, 31622400) is used.
5506 For more information on how RRA-sizes are calculated see B<RRARows> above.
5508 =item B<XFF> I<Factor>
5510 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5511 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5514 =item B<CacheFlush> I<Seconds>
5516 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5517 it writes all values for a certain RRD-file if the oldest value is older than
5518 (or equal to) the number of seconds specified. If some RRD-file is not updated
5519 anymore for some reason (the computer was shut down, the network is broken,
5520 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5521 entire cache is searched for entries older than B<CacheTimeout> seconds and
5522 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5523 does nothing under normal circumstances, this value should not be too small.
5524 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5525 normally do much harm either.
5527 =item B<CacheTimeout> I<Seconds>
5529 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5530 save values in a cache, as described above. Writing multiple values at once
5531 reduces IO-operations and thus lessens the load produced by updating the files.
5532 The trade off is that the graphs kind of "drag behind" and that more memory is
5535 =item B<WritesPerSecond> I<Updates>
5537 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5538 will run serious performance problems. The B<CacheFlush> setting and the
5539 internal update queue assert that collectd continues to work just fine even
5540 under heavy load, but the system may become very unresponsive and slow. This is
5541 a problem especially if you create graphs from the RRD files on the same
5542 machine, for example using the C<graph.cgi> script included in the
5543 C<contrib/collection3/> directory.
5545 This setting is designed for very large setups. Setting this option to a value
5546 between 25 and 80 updates per second, depending on your hardware, will leave
5547 the server responsive enough to draw graphs even while all the cached values
5548 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5549 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5550 written as fast as possible, so that web frontends have up to date data when
5553 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5554 updates per second, writing all values to disk will take approximately
5555 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5556 "collection3" you'll end up with a responsive and fast system, up to date
5557 graphs and basically a "backup" of your values every hour.
5559 =item B<RandomTimeout> I<Seconds>
5561 When set, the actual timeout for each value is chosen randomly between
5562 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5563 intention is to avoid high load situations that appear when many values timeout
5564 at the same time. This is especially a problem shortly after the daemon starts,
5565 because all values were added to the internal cache at roughly the same time.
5569 =head2 Plugin C<sensors>
5571 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5572 that all the needed modules have to be loaded and lm_sensors has to be
5573 configured (most likely by editing F</etc/sensors.conf>. Read
5574 L<sensors.conf(5)> for details.
5576 The B<lm_sensors> homepage can be found at
5577 L<http://secure.netroedge.com/~lm78/>.
5581 =item B<SensorConfigFile> I<File>
5583 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5584 the library's default will be used.
5586 =item B<Sensor> I<chip-bus-address/type-feature>
5588 Selects the name of the sensor which you want to collect or ignore, depending
5589 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5590 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5591 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5593 =item B<IgnoreSelected> I<true>|I<false>
5595 If no configuration if given, the B<sensors>-plugin will collect data from all
5596 sensors. This may not be practical, especially for uninteresting sensors.
5597 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5598 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5599 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5600 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5601 and all other sensors are collected.
5605 =head2 Plugin C<sigrok>
5607 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5608 supported by the L<sigrok|http://sigrok.org/> project.
5614 <Device "AC Voltage">
5619 <Device "Sound Level">
5620 Driver "cem-dt-885x"
5627 =item B<LogLevel> B<0-5>
5629 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5630 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5631 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5632 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5633 their level, are always submitted to I<collectd> at its INFO log level.
5635 =item E<lt>B<Device> I<Name>E<gt>
5637 A sigrok-supported device, uniquely identified by this section's options. The
5638 I<Name> is passed to I<collectd> as the I<plugin instance>.
5640 =item B<Driver> I<DriverName>
5642 The sigrok driver to use for this device.
5644 =item B<Conn> I<ConnectionSpec>
5646 If the device cannot be auto-discovered, or more than one might be discovered
5647 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5648 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5649 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5650 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5651 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5653 =item B<SerialComm> I<SerialSpec>
5655 For serial devices with non-standard port settings, this option can be used
5656 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5657 This should not be necessary; drivers know how to communicate with devices they
5660 =item B<MinimumInterval> I<Seconds>
5662 Specifies the minimum time between measurement dispatches to I<collectd>, in
5663 seconds. Since some I<sigrok> supported devices can acquire measurements many
5664 times per second, it may be necessary to throttle these. For example, the
5665 I<RRD plugin> cannot process writes more than once per second.
5667 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5668 device are always dispatched to I<collectd>. When throttled, unused
5669 measurements are discarded.
5673 =head2 Plugin C<snmp>
5675 Since the configuration of the C<snmp plugin> is a little more complicated than
5676 other plugins, its documentation has been moved to an own manpage,
5677 L<collectd-snmp(5)>. Please see there for details.
5679 =head2 Plugin C<statsd>
5681 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5682 protocol and dispatches rates or other aggregates of these numbers
5685 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5686 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5687 C<objects> respectively.
5689 The following configuration options are valid:
5693 =item B<Host> I<Host>
5695 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5696 "any" address, i.e. accept packets sent to any of the hosts addresses.
5698 =item B<Port> I<Port>
5700 UDP port to listen to. This can be either a service name or a port number.
5701 Defaults to C<8125>.
5703 =item B<DeleteCounters> B<false>|B<true>
5705 =item B<DeleteTimers> B<false>|B<true>
5707 =item B<DeleteGauges> B<false>|B<true>
5709 =item B<DeleteSets> B<false>|B<true>
5711 These options control what happens if metrics are not updated in an interval.
5712 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5713 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5714 are unchanged. If set to B<True>, the such metrics are not dispatched and
5715 removed from the internal cache.
5717 =item B<TimerPercentile> I<Percent>
5719 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5720 that I<Percent> of all reported timers are smaller than or equal to the
5721 computed latency. This is useful for cutting off the long tail latency, as it's
5722 often done in I<Service Level Agreements> (SLAs).
5724 If not specified, no percentile is calculated / dispatched.
5728 =head2 Plugin C<swap>
5730 The I<Swap plugin> collects information about used and available swap space. On
5731 I<Linux> and I<Solaris>, the following options are available:
5735 =item B<ReportByDevice> B<false>|B<true>
5737 Configures how to report physical swap devices. If set to B<false> (the
5738 default), the summary over all swap devices is reported only, i.e. the globally
5739 used and available space over all devices. If B<true> is configured, the used
5740 and available space of each device will be reported separately.
5742 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5743 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5745 =item B<ReportBytes> B<false>|B<true>
5747 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5748 I<swap I/O> is reported in pages. This option is available under Linux only.
5750 =item B<ValuesAbsolute> B<true>|B<false>
5752 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5753 available and used. Defaults to B<true>.
5755 =item B<ValuesPercentage> B<false>|B<true>
5757 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5758 available and free. Defaults to B<false>.
5760 This is useful for deploying I<collectd> in a heterogeneous environment, where
5761 swap sizes differ and you want to specify generic thresholds or similar.
5765 =head2 Plugin C<syslog>
5769 =item B<LogLevel> B<debug|info|notice|warning|err>
5771 Sets the log-level. If, for example, set to B<notice>, then all events with
5772 severity B<notice>, B<warning>, or B<err> will be submitted to the
5775 Please note that B<debug> is only available if collectd has been compiled with
5778 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5780 Controls which notifications should be sent to syslog. The default behaviour is
5781 not to send any. Less severe notifications always imply logging more severe
5782 notifications: Setting this to B<OKAY> means all notifications will be sent to
5783 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5784 notifications but will dismiss B<OKAY> notifications. Setting this option to
5785 B<FAILURE> will only send failures to syslog.
5789 =head2 Plugin C<table>
5791 The C<table plugin> provides generic means to parse tabular data and dispatch
5792 user specified values. Values are selected based on column numbers. For
5793 example, this plugin may be used to get values from the Linux L<proc(5)>
5794 filesystem or CSV (comma separated values) files.
5797 <Table "/proc/slabinfo">
5802 InstancePrefix "active_objs"
5808 InstancePrefix "objperslab"
5815 The configuration consists of one or more B<Table> blocks, each of which
5816 configures one file to parse. Within each B<Table> block, there are one or
5817 more B<Result> blocks, which configure which data to select and how to
5820 The following options are available inside a B<Table> block:
5824 =item B<Instance> I<instance>
5826 If specified, I<instance> is used as the plugin instance. So, in the above
5827 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5828 filename of the table is used instead, with all special characters replaced
5829 with an underscore (C<_>).
5831 =item B<Separator> I<string>
5833 Any character of I<string> is interpreted as a delimiter between the different
5834 columns of the table. A sequence of two or more contiguous delimiters in the
5835 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5836 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5837 of a table - see its documentation for more details. This option is mandatory.
5839 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5840 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5841 required because of collectd's config parsing.
5845 The following options are available inside a B<Result> block:
5849 =item B<Type> I<type>
5851 Sets the type used to dispatch the values to the daemon. Detailed information
5852 about types and their configuration can be found in L<types.db(5)>. This
5853 option is mandatory.
5855 =item B<InstancePrefix> I<prefix>
5857 If specified, prepend I<prefix> to the type instance. If omitted, only the
5858 B<InstancesFrom> option is considered for the type instance.
5860 =item B<InstancesFrom> I<column0> [I<column1> ...]
5862 If specified, the content of the given columns (identified by the column
5863 number starting at zero) will be used to create the type instance for each
5864 row. Multiple values (and the instance prefix) will be joined together with
5865 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5866 option is considered for the type instance.
5868 The plugin itself does not check whether or not all built instances are
5869 different. It’s your responsibility to assure that each is unique. This is
5870 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5871 sure that the table only contains one row.
5873 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5876 =item B<ValuesFrom> I<column0> [I<column1> ...]
5878 Specifies the columns (identified by the column numbers starting at zero)
5879 whose content is used as the actual data for the data sets that are dispatched
5880 to the daemon. How many such columns you need is determined by the B<Type>
5881 setting above. If you specify too many or not enough columns, the plugin will
5882 complain about that and no data will be submitted to the daemon. The plugin
5883 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5884 respectively, so anything supported by those functions is supported by the
5885 plugin as well. This option is mandatory.
5889 =head2 Plugin C<tail>
5891 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5892 each line and dispatches found values. What is matched can be configured by the
5893 user using (extended) regular expressions, as described in L<regex(7)>.
5896 <File "/var/log/exim4/mainlog">
5900 Regex "S=([1-9][0-9]*)"
5906 Regex "\\<R=local_user\\>"
5907 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5910 Instance "local_user"
5915 The config consists of one or more B<File> blocks, each of which configures one
5916 logfile to parse. Within each B<File> block, there are one or more B<Match>
5917 blocks, which configure a regular expression to search for.
5919 The B<Instance> option in the B<File> block may be used to set the plugin
5920 instance. So in the above example the plugin name C<tail-foo> would be used.
5921 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5922 next B<Instance> option. This way you can extract several plugin instances from
5923 one logfile, handy when parsing syslog and the like.
5925 The B<Interval> option allows you to define the length of time between reads. If
5926 this is not set, the default Interval will be used.
5928 Each B<Match> block has the following options to describe how the match should
5933 =item B<Regex> I<regex>
5935 Sets the regular expression to use for matching against a line. The first
5936 subexpression has to match something that can be turned into a number by
5937 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5938 below. Because B<extended> regular expressions are used, you do not need to use
5939 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5940 collectd's config parsing you need to escape backslashes, though. So if you
5941 want to match literal parentheses you need to do the following:
5943 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5945 =item B<ExcludeRegex> I<regex>
5947 Sets an optional regular expression to use for excluding lines from the match.
5948 An example which excludes all connections from localhost from the match:
5950 ExcludeRegex "127\\.0\\.0\\.1"
5952 =item B<DSType> I<Type>
5954 Sets how the values are cumulated. I<Type> is one of:
5958 =item B<GaugeAverage>
5960 Calculate the average.
5964 Use the smallest number only.
5968 Use the greatest number only.
5972 Use the last number found.
5978 =item B<AbsoluteSet>
5980 The matched number is a counter. Simply I<sets> the internal counter to this
5981 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5987 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5988 matched number may be negative, which will effectively subtract from the
5995 Increase the internal counter by one. These B<DSType> are the only ones that do
5996 not use the matched subexpression, but simply count the number of matched
5997 lines. Thus, you may use a regular expression without submatch in this case.
6001 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
6002 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
6003 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
6004 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
6005 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
6008 =item B<Type> I<Type>
6010 Sets the type used to dispatch this value. Detailed information about types and
6011 their configuration can be found in L<types.db(5)>.
6013 =item B<Instance> I<TypeInstance>
6015 This optional setting sets the type instance to use.
6019 =head2 Plugin C<tail_csv>
6021 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
6022 written by I<Snort>.
6027 <Metric "snort-dropped">
6032 <File "/var/log/snort/snort.stats">
6033 Instance "snort-eth0"
6035 Collect "snort-dropped"
6039 The configuration consists of one or more B<Metric> blocks that define an index
6040 into the line of the CSV file and how this value is mapped to I<collectd's>
6041 internal representation. These are followed by one or more B<Instance> blocks
6042 which configure which file to read, in which interval and which metrics to
6047 =item E<lt>B<Metric> I<Name>E<gt>
6049 The B<Metric> block configures a new metric to be extracted from the statistics
6050 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6051 only used inside the B<Instance> blocks to refer to this block, so you can use
6052 one B<Metric> block for multiple CSV files.
6056 =item B<Type> I<Type>
6058 Configures which I<Type> to use when dispatching this metric. Types are defined
6059 in the L<types.db(5)> file, see the appropriate manual page for more
6060 information on specifying types. Only types with a single I<data source> are
6061 supported by the I<tail_csv plugin>. The information whether the value is an
6062 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6063 I<Type's> definition.
6065 =item B<Instance> I<TypeInstance>
6067 If set, I<TypeInstance> is used to populate the type instance field of the
6068 created value lists. Otherwise, no type instance is used.
6070 =item B<ValueFrom> I<Index>
6072 Configure to read the value from the field with the zero-based index I<Index>.
6073 If the value is parsed as signed integer, unsigned integer or double depends on
6074 the B<Type> setting, see above.
6078 =item E<lt>B<File> I<Path>E<gt>
6080 Each B<File> block represents one CSV file to read. There must be at least one
6081 I<File> block but there can be multiple if you have multiple CSV files.
6085 =item B<Instance> I<PluginInstance>
6087 Sets the I<plugin instance> used when dispatching the values.
6089 =item B<Collect> I<Metric>
6091 Specifies which I<Metric> to collect. This option must be specified at least
6092 once, and you can use this option multiple times to specify more than one
6093 metric to be extracted from this statistic file.
6095 =item B<Interval> I<Seconds>
6097 Configures the interval in which to read values from this instance / file.
6098 Defaults to the plugin's default interval.
6100 =item B<TimeFrom> I<Index>
6102 Rather than using the local time when dispatching a value, read the timestamp
6103 from the field with the zero-based index I<Index>. The value is interpreted as
6104 seconds since epoch. The value is parsed as a double and may be factional.
6110 =head2 Plugin C<teamspeak2>
6112 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6113 polls interesting global and virtual server data. The plugin can query only one
6114 physical server but unlimited virtual servers. You can use the following
6115 options to configure it:
6119 =item B<Host> I<hostname/ip>
6121 The hostname or ip which identifies the physical server.
6124 =item B<Port> I<port>
6126 The query port of the physical server. This needs to be a string.
6129 =item B<Server> I<port>
6131 This option has to be added once for every virtual server the plugin should
6132 query. If you want to query the virtual server on port 8767 this is what the
6133 option would look like:
6137 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6138 use quotes around it! If no such statement is given only global information
6143 =head2 Plugin C<ted>
6145 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6146 measure power consumption. These devices are usually connected to a serial
6147 (RS232) or USB port. The plugin opens a configured device and tries to read the
6148 current energy readings. For more information on TED, visit
6149 L<http://www.theenergydetective.com/>.
6151 Available configuration options:
6155 =item B<Device> I<Path>
6157 Path to the device on which TED is connected. collectd will need read and write
6158 permissions on that file.
6160 Default: B</dev/ttyUSB0>
6162 =item B<Retries> I<Num>
6164 Apparently reading from TED is not that reliable. You can therefore configure a
6165 number of retries here. You only configure the I<retries> here, to if you
6166 specify zero, one reading will be performed (but no retries if that fails); if
6167 you specify three, a maximum of four readings are performed. Negative values
6174 =head2 Plugin C<tcpconns>
6176 The C<tcpconns plugin> counts the number of currently established TCP
6177 connections based on the local port and/or the remote port. Since there may be
6178 a lot of connections the default if to count all connections with a local port,
6179 for which a listening socket is opened. You can use the following options to
6180 fine-tune the ports you are interested in:
6184 =item B<ListeningPorts> I<true>|I<false>
6186 If this option is set to I<true>, statistics for all local ports for which a
6187 listening socket exists are collected. The default depends on B<LocalPort> and
6188 B<RemotePort> (see below): If no port at all is specifically selected, the
6189 default is to collect listening ports. If specific ports (no matter if local or
6190 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6191 the selected ports will be collected unless this option is set to I<true>
6194 =item B<LocalPort> I<Port>
6196 Count the connections to a specific local port. This can be used to see how
6197 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6198 You have to specify the port in numeric form, so for the mailserver example
6199 you'd need to set B<25>.
6201 =item B<RemotePort> I<Port>
6203 Count the connections to a specific remote port. This is useful to see how
6204 much a remote service is used. This is most useful if you want to know how many
6205 connections a local service has opened to remote services, e.E<nbsp>g. how many
6206 connections a mail server or news server has to other mail or news servers, or
6207 how many connections a web proxy holds to web servers. You have to give the
6208 port in numeric form.
6212 =head2 Plugin C<thermal>
6216 =item B<ForceUseProcfs> I<true>|I<false>
6218 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6219 C<sysfs> interface. If that is not available, the plugin falls back to the
6220 C<procfs> interface. By setting this option to I<true>, you can force the
6221 plugin to use the latter. This option defaults to I<false>.
6223 =item B<Device> I<Device>
6225 Selects the name of the thermal device that you want to collect or ignore,
6226 depending on the value of the B<IgnoreSelected> option. This option may be
6227 used multiple times to specify a list of devices.
6229 =item B<IgnoreSelected> I<true>|I<false>
6231 Invert the selection: If set to true, all devices B<except> the ones that
6232 match the device names specified by the B<Device> option are collected. By
6233 default only selected devices are collected if a selection is made. If no
6234 selection is configured at all, B<all> devices are selected.
6238 =head2 Plugin C<threshold>
6240 The I<Threshold plugin> checks values collected or received by I<collectd>
6241 against a configurable I<threshold> and issues I<notifications> if values are
6244 Documentation for this plugin is available in the L<collectd-threshold(5)>
6247 =head2 Plugin C<tokyotyrant>
6249 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6250 couple metrics: number of records, and database size on disk.
6254 =item B<Host> I<Hostname/IP>
6256 The hostname or ip which identifies the server.
6257 Default: B<127.0.0.1>
6259 =item B<Port> I<Service/Port>
6261 The query port of the server. This needs to be a string, even if the port is
6262 given in its numeric form.
6267 =head2 Plugin C<unixsock>
6271 =item B<SocketFile> I<Path>
6273 Sets the socket-file which is to be created.
6275 =item B<SocketGroup> I<Group>
6277 If running as root change the group of the UNIX-socket after it has been
6278 created. Defaults to B<collectd>.
6280 =item B<SocketPerms> I<Permissions>
6282 Change the file permissions of the UNIX-socket after it has been created. The
6283 permissions must be given as a numeric, octal value as you would pass to
6284 L<chmod(1)>. Defaults to B<0770>.
6286 =item B<DeleteSocket> B<false>|B<true>
6288 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6289 with the given name already exists. If I<collectd> crashes a socket file may be
6290 left over, preventing the daemon from opening a new socket when restarted.
6291 Since this is potentially dangerous, this defaults to B<false>.
6295 =head2 Plugin C<uuid>
6297 This plugin, if loaded, causes the Hostname to be taken from the machine's
6298 UUID. The UUID is a universally unique designation for the machine, usually
6299 taken from the machine's BIOS. This is most useful if the machine is running in
6300 a virtual environment such as Xen, in which case the UUID is preserved across
6301 shutdowns and migration.
6303 The following methods are used to find the machine's UUID, in order:
6309 Check I</etc/uuid> (or I<UUIDFile>).
6313 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6318 Check for UUID from C<dmidecode> / SMBIOS.
6322 Check for UUID from Xen hypervisor.
6326 If no UUID can be found then the hostname is not modified.
6330 =item B<UUIDFile> I<Path>
6332 Take the UUID from the given file (default I</etc/uuid>).
6336 =head2 Plugin C<varnish>
6338 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6343 <Instance "example">
6345 CollectConnections true
6355 CollectWorkers false
6359 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6360 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6361 will collectd statistics from the default "varnishd" instance (this should work
6362 fine in most cases).
6364 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6368 =item B<CollectCache> B<true>|B<false>
6370 Cache hits and misses. True by default.
6372 =item B<CollectConnections> B<true>|B<false>
6374 Number of client connections received, accepted and dropped. True by default.
6376 =item B<CollectBackend> B<true>|B<false>
6378 Back-end connection statistics, such as successful, reused,
6379 and closed connections. True by default.
6381 =item B<CollectSHM> B<true>|B<false>
6383 Statistics about the shared memory log, a memory region to store
6384 log messages which is flushed to disk when full. True by default.
6386 =item B<CollectBan> B<true>|B<false>
6388 Statistics about ban operations, such as number of bans added, retired, and
6389 number of objects tested against ban operations. Only available with Varnish
6390 3.x. False by default.
6392 =item B<CollectDirectorDNS> B<true>|B<false>
6394 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6397 =item B<CollectESI> B<true>|B<false>
6399 Edge Side Includes (ESI) parse statistics. False by default.
6401 =item B<CollectFetch> B<true>|B<false>
6403 Statistics about fetches (HTTP requests sent to the backend). False by default.
6405 =item B<CollectHCB> B<true>|B<false>
6407 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6408 divided into locked and unlocked look-ups. False by default.
6410 =item B<CollectObjects> B<true>|B<false>
6412 Statistics on cached objects: number of objects expired, nuked (prematurely
6413 expired), saved, moved, etc. False by default.
6415 =item B<CollectPurge> B<true>|B<false>
6417 Statistics about purge operations, such as number of purges added, retired, and
6418 number of objects tested against purge operations. Only available with Varnish
6419 2.x. False by default.
6421 =item B<CollectSession> B<true>|B<false>
6423 Client session statistics. Number of past and current sessions, session herd and
6424 linger counters, etc. False by default.
6426 =item B<CollectSMA> B<true>|B<false>
6428 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6429 component is Solaris specific. Only available with Varnish 2.x. False by
6432 =item B<CollectSMS> B<true>|B<false>
6434 synth (synthetic content) storage statistics. This storage
6435 component is used internally only. False by default.
6437 =item B<CollectSM> B<true>|B<false>
6439 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6442 =item B<CollectStruct> B<true>|B<false>
6444 Current varnish internal state statistics. Number of current sessions, objects
6445 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6448 =item B<CollectTotals> B<true>|B<false>
6450 Collects overview counters, such as the number of sessions created,
6451 the number of requests and bytes transferred. False by default.
6453 =item B<CollectUptime> B<true>|B<false>
6455 Varnish uptime. False by default.
6457 =item B<CollectVCL> B<true>|B<false>
6459 Number of total (available + discarded) VCL (config files). False by default.
6461 =item B<CollectWorkers> B<true>|B<false>
6463 Collect statistics about worker threads. False by default.
6467 =head2 Plugin C<vmem>
6469 The C<vmem> plugin collects information about the usage of virtual memory.
6470 Since the statistics provided by the Linux kernel are very detailed, they are
6471 collected very detailed. However, to get all the details, you have to switch
6472 them on manually. Most people just want an overview over, such as the number of
6473 pages read from swap space.
6477 =item B<Verbose> B<true>|B<false>
6479 Enables verbose collection of information. This will start collecting page
6480 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6481 Part of these statistics are collected on a "per zone" basis.
6485 =head2 Plugin C<vserver>
6487 This plugin doesn't have any options. B<VServer> support is only available for
6488 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6489 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6490 need to apply the patches and compile your own kernel, which will then provide
6491 the F</proc/virtual> filesystem that is required by this plugin.
6493 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6495 B<Note>: The traffic collected by this plugin accounts for the amount of
6496 traffic passing a socket which might be a lot less than the actual on-wire
6497 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6498 collect on-wire traffic you could, for example, use the logging facilities of
6499 iptables to feed data for the guest IPs into the iptables plugin.
6501 =head2 Plugin C<write_graphite>
6503 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6504 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6505 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6506 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6507 of at most 1428 bytes to minimize the number of network packets.
6511 <Plugin write_graphite>
6521 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6522 blocks. Inside the B<Node> blocks, the following options are recognized:
6526 =item B<Host> I<Address>
6528 Hostname or address to connect to. Defaults to C<localhost>.
6530 =item B<Port> I<Service>
6532 Service name or port number to connect to. Defaults to C<2003>.
6534 =item B<Protocol> I<String>
6536 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6538 =item B<LogSendErrors> B<false>|B<true>
6540 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6541 If set to B<false>, it will not log the errors. This is especially useful when
6542 using Protocol UDP since many times we want to use the "fire-and-forget"
6543 approach and logging errors fills syslog with unneeded messages.
6545 =item B<Prefix> I<String>
6547 When set, I<String> is added in front of the host name. Dots and whitespace are
6548 I<not> escaped in this string (see B<EscapeCharacter> below).
6550 =item B<Postfix> I<String>
6552 When set, I<String> is appended to the host name. Dots and whitespace are
6553 I<not> escaped in this string (see B<EscapeCharacter> below).
6555 =item B<EscapeCharacter> I<Char>
6557 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6558 in the identifier. The B<EscapeCharacter> option determines which character
6559 dots, whitespace and control characters are replaced with. Defaults to
6562 =item B<StoreRates> B<false>|B<true>
6564 If set to B<true> (the default), convert counter values to rates. If set to
6565 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6568 =item B<SeparateInstances> B<false>|B<true>
6570 If set to B<true>, the plugin instance and type instance will be in their own
6571 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6572 default), the plugin and plugin instance (and likewise the type and type
6573 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6575 =item B<AlwaysAppendDS> B<false>|B<true>
6577 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6578 identifier. If set to B<false> (the default), this is only done when there is
6583 =head2 Plugin C<write_tsdb>
6585 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6586 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6587 state daemon that ingests metrics and stores them in HBase. The plugin uses
6588 I<TCP> over the "line based" protocol with a default port 4242. The data will
6589 be sent in blocks of at most 1428 bytes to minimize the number of network
6596 Host "tsd-1.my.domain"
6598 HostTags "status=production"
6602 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6603 blocks. Inside the B<Node> blocks, the following options are recognized:
6607 =item B<Host> I<Address>
6609 Hostname or address to connect to. Defaults to C<localhost>.
6611 =item B<Port> I<Service>
6613 Service name or port number to connect to. Defaults to C<4242>.
6616 =item B<HostTags> I<String>
6618 When set, I<HostTags> is added to the end of the metric. It is intended to be
6619 used for name=value pairs that the TSD will tag the metric with. Dots and
6620 whitespace are I<not> escaped in this string.
6622 =item B<StoreRates> B<false>|B<true>
6624 If set to B<true>, convert counter values to rates. If set to B<false>
6625 (the default) counter values are stored as is, as an increasing
6628 =item B<AlwaysAppendDS> B<false>|B<true>
6630 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6631 identifier. If set to B<false> (the default), this is only done when there is
6636 =head2 Plugin C<write_mongodb>
6638 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6643 <Plugin "write_mongodb">
6652 The plugin can send values to multiple instances of I<MongoDB> by specifying
6653 one B<Node> block for each instance. Within the B<Node> blocks, the following
6654 options are available:
6658 =item B<Host> I<Address>
6660 Hostname or address to connect to. Defaults to C<localhost>.
6662 =item B<Port> I<Service>
6664 Service name or port number to connect to. Defaults to C<27017>.
6666 =item B<Timeout> I<Timeout>
6668 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6669 Setting this option to zero means no timeout, which is the default.
6671 =item B<StoreRates> B<false>|B<true>
6673 If set to B<true> (the default), convert counter values to rates. If set to
6674 B<false> counter values are stored as is, i.e. as an increasing integer
6677 =item B<Database> I<Database>
6679 =item B<User> I<User>
6681 =item B<Password> I<Password>
6683 Sets the information used when authenticating to a I<MongoDB> database. The
6684 fields are optional (in which case no authentication is attempted), but if you
6685 want to use authentication all three fields must be set.
6689 =head2 Plugin C<write_http>
6691 This output plugin submits values to an http server by POST them using the
6692 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6693 have one B<URL> block, within which the destination can be configured further,
6694 for example by specifying authentication data.
6698 <Plugin "write_http">
6699 <URL "http://example.com/post-collectd">
6705 B<URL> blocks need one string argument which is used as the URL to which data
6706 is posted. The following options are understood within B<URL> blocks.
6710 =item B<User> I<Username>
6712 Optional user name needed for authentication.
6714 =item B<Password> I<Password>
6716 Optional password needed for authentication.
6718 =item B<VerifyPeer> B<true>|B<false>
6720 Enable or disable peer SSL certificate verification. See
6721 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6723 =item B<VerifyHost> B<true|false>
6725 Enable or disable peer host name verification. If enabled, the plugin checks if
6726 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6727 matches the host name provided by the B<URL> option. If this identity check
6728 fails, the connection is aborted. Obviously, only works when connecting to a
6729 SSL enabled server. Enabled by default.
6731 =item B<CACert> I<File>
6733 File that holds one or more SSL certificates. If you want to use HTTPS you will
6734 possibly need this option. What CA certificates come bundled with C<libcurl>
6735 and are checked by default depends on the distribution you use.
6737 =item B<CAPath> I<Directory>
6739 Directory holding one or more CA certificate files. You can use this if for
6740 some reason all the needed CA certificates aren't in the same file and can't be
6741 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
6744 =item B<ClientKey> I<File>
6746 File that holds the private key in PEM format to be used for certificate-based
6749 =item B<ClientCert> I<File>
6751 File that holds the SSL certificate to be used for certificate-based
6754 =item B<ClientKeyPass> I<Password>
6756 Password required to load the private key in B<ClientKey>.
6758 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
6760 Define which SSL protocol version must be used. By default C<libcurl> will
6761 attempt to figure out the remote SSL protocol version. See
6762 L<curl_easy_setopt(3)> for more details.
6764 =item B<Format> B<Command>|B<JSON>
6766 Format of the output to generate. If set to B<Command>, will create output that
6767 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6768 create output in the I<JavaScript Object Notation> (JSON).
6770 Defaults to B<Command>.
6772 =item B<StoreRates> B<true|false>
6774 If set to B<true>, convert counter values to rates. If set to B<false> (the
6775 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6780 =head2 Plugin C<write_kafka>
6782 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6786 <Plugin "write_kafka">
6787 Property "metadata.broker.list" "broker1:9092,broker2:9092"
6793 The following options are understood by the I<write_kafka plugin>:
6797 =item E<lt>B<Topic> I<Name>E<gt>
6799 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6800 is given a unique I<Name> and specifies one kafka producer.
6801 Inside the B<Topic> block, the following per-topic options are
6806 =item B<Property> I<String> I<String>
6808 Configure the named property for the current topic. Properties are
6809 forwarded to the kafka producer library B<librdkafka>.
6811 =item B<Key> I<String>
6813 Use the specified string as a partioning key for the topic. Kafka breaks
6814 topic into partitions and guarantees that for a given topology, the same
6815 consumer will be used for a specific key. The special (case insensitive)
6816 string B<Random> can be used to specify that an arbitrary partition should
6819 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6821 Selects the format in which messages are sent to the broker. If set to
6822 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6823 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6825 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6826 an easy and straight forward exchange format.
6828 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6829 "<metric> <value> <timestamp>\n".
6831 =item B<StoreRates> B<true>|B<false>
6833 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6834 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6835 default), no conversion is performed. Otherwise the conversion is performed
6836 using the internal value cache.
6838 Please note that currently this option is only used if the B<Format> option has
6839 been set to B<JSON>.
6841 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6843 A prefix can be added in the metric name when outputting in the I<Graphite> format.
6844 It's added before the I<Host> name.
6845 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6847 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6849 A postfix can be added in the metric name when outputting in the I<Graphite> format.
6850 It's added after the I<Host> name.
6851 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6853 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6855 Specify a character to replace dots (.) in the host part of the metric name.
6856 In I<Graphite> metric name, dots are used as separators between different
6857 metric parts (host, plugin, type).
6858 Default is "_" (I<Underscore>).
6860 =item B<GraphiteSeparateInstances> B<false>|B<true>
6862 If set to B<true>, the plugin instance and type instance will be in their own
6863 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6864 default), the plugin and plugin instance (and likewise the type and type
6865 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6867 =item B<StoreRates> B<true>|B<false>
6869 If set to B<true> (the default), convert counter values to rates. If set to
6870 B<false> counter values are stored as is, i.e. as an increasing integer number.
6872 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6873 converted values will have "rate" appended to the data source type, e.g.
6874 C<ds_type:derive:rate>.
6878 =item B<Property> I<String> I<String>
6880 Configure the kafka producer through properties, you almost always will
6881 want to set B<metadata.broker.list> to your Kafka broker list.
6885 =head2 Plugin C<write_riemann>
6887 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
6888 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6889 I<Riemann> using UDP packets.
6893 <Plugin "write_riemann">
6899 AlwaysAppendDS false
6903 Attribute "foo" "bar"
6906 The following options are understood by the I<write_riemann plugin>:
6910 =item E<lt>B<Node> I<Name>E<gt>
6912 The plugin's configuration consists of one or more B<Node> blocks. Each block
6913 is given a unique I<Name> and specifies one connection to an instance of
6914 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6919 =item B<Host> I<Address>
6921 Hostname or address to connect to. Defaults to C<localhost>.
6923 =item B<Port> I<Service>
6925 Service name or port number to connect to. Defaults to C<5555>.
6927 =item B<Protocol> B<UDP>|B<TCP>
6929 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6932 =item B<StoreRates> B<true>|B<false>
6934 If set to B<true> (the default), convert counter values to rates. If set to
6935 B<false> counter values are stored as is, i.e. as an increasing integer number.
6937 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6938 converted values will have "rate" appended to the data source type, e.g.
6939 C<ds_type:derive:rate>.
6941 =item B<AlwaysAppendDS> B<false>|B<true>
6943 If set the B<true>, append the name of the I<Data Source> (DS) to the
6944 "service", i.e. the field that, together with the "host" field, uniquely
6945 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6946 only done when there is more than one DS.
6948 =item B<TTLFactor> I<Factor>
6950 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6951 event is considered active. I<collectd> populates this field based on the
6952 metrics interval setting. This setting controls the factor with which the
6953 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6954 know exactly what you're doing, you should only increase this setting from its
6957 =item B<Notifications> B<false>|B<true>
6959 If set to B<true>, create riemann events for notifications. This is B<true>
6960 by default. When processing thresholds from write_riemann, it might prove
6961 useful to avoid getting notification events.
6963 =item B<CheckThresholds> B<false>|B<true>
6965 If set to B<true>, attach state to events based on thresholds defined
6966 in the B<Threshold> plugin. Defaults to B<false>.
6968 =item B<EventServicePrefix> I<String>
6970 Add the given string as a prefix to the event service name.
6971 If B<EventServicePrefix> not set or set to an empty string (""),
6972 no prefix will be used.
6976 =item B<Tag> I<String>
6978 Add the given string as an additional tag to the metric being sent to
6981 =item B<Attribute> I<String> I<String>
6983 Consider the two given strings to be the key and value of an additional
6984 attribute for each metric being sent out to I<Riemann>.
6988 =head1 THRESHOLD CONFIGURATION
6990 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6991 we mean that the values are not only stored or sent somewhere, but that they
6992 are judged and, if a problem is recognized, acted upon. The only action
6993 collectd takes itself is to generate and dispatch a "notification". Plugins can
6994 register to receive notifications and perform appropriate further actions.
6996 Since systems and what you expect them to do differ a lot, you can configure
6997 B<thresholds> for your values freely. This gives you a lot of flexibility but
6998 also a lot of responsibility.
7000 Every time a value is out of range a notification is dispatched. This means
7001 that the idle percentage of your CPU needs to be less then the configured
7002 threshold only once for a notification to be generated. There's no such thing
7003 as a moving average or similar - at least not now.
7005 Also, all values that match a threshold are considered to be relevant or
7006 "interesting". As a consequence collectd will issue a notification if they are
7007 not received for B<Timeout> iterations. The B<Timeout> configuration option is
7008 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
7009 "2" (the default) and some hosts sends it's CPU statistics to the server every
7010 60 seconds, a notification will be dispatched after about 120 seconds. It may
7011 take a little longer because the timeout is checked only once each B<Interval>
7014 When a value comes within range again or is received after it was missing, an
7015 "OKAY-notification" is dispatched.
7017 Here is a configuration example to get you started. Read below for more
7030 <Plugin "interface">
7047 WarningMin 100000000
7053 There are basically two types of configuration statements: The C<Host>,
7054 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7055 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7056 C<Instance> option. You can combine the block by nesting the blocks, though
7057 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7058 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7059 C<Type> may not contain other blocks. If multiple blocks apply to the same
7060 value the most specific block is used.
7062 The other statements specify the threshold to configure. They B<must> be
7063 included in a C<Type> block. Currently the following statements are recognized:
7067 =item B<FailureMax> I<Value>
7069 =item B<WarningMax> I<Value>
7071 Sets the upper bound of acceptable values. If unset defaults to positive
7072 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7073 will be created. If the value is greater than B<WarningMax> but less than (or
7074 equal to) B<FailureMax> a B<WARNING> notification will be created.
7076 =item B<FailureMin> I<Value>
7078 =item B<WarningMin> I<Value>
7080 Sets the lower bound of acceptable values. If unset defaults to negative
7081 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7082 be created. If the value is less than B<WarningMin> but greater than (or equal
7083 to) B<FailureMin> a B<WARNING> notification will be created.
7085 =item B<DataSource> I<DSName>
7087 Some data sets have more than one "data source". Interesting examples are the
7088 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7089 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7090 system load data set, C<load>, even has three data sources: C<shortterm>,
7091 C<midterm>, and C<longterm>.
7093 Normally, all data sources are checked against a configured threshold. If this
7094 is undesirable, or if you want to specify different limits for each data
7095 source, you can use the B<DataSource> option to have a threshold apply only to
7098 =item B<Invert> B<true>|B<false>
7100 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7101 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7102 B<WarningMax>) are not okay. Defaults to B<false>.
7104 =item B<Persist> B<true>|B<false>
7106 Sets how often notifications are generated. If set to B<true> one notification
7107 will be generated for each value that is out of the acceptable range. If set to
7108 B<false> (the default) then a notification is only generated if a value is out
7109 of range but the previous value was okay.
7111 This applies to missing values, too: If set to B<true> a notification about a
7112 missing value is generated once every B<Interval> seconds. If set to B<false>
7113 only one such notification is generated until the value appears again.
7115 =item B<Percentage> B<true>|B<false>
7117 If set to B<true>, the minimum and maximum values given are interpreted as
7118 percentage value, relative to the other data sources. This is helpful for
7119 example for the "df" type, where you may want to issue a warning when less than
7120 5E<nbsp>% of the total space is available. Defaults to B<false>.
7122 =item B<Hits> I<Number>
7124 Delay creating the notification until the threshold has been passed I<Number>
7125 times. When a notification has been generated, or when a subsequent value is
7126 inside the threshold, the counter is reset. If, for example, a value is
7127 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7128 will be dispatched at most once every 30E<nbsp>seconds.
7130 This is useful when short bursts are not a problem. If, for example, 100% CPU
7131 usage for up to a minute is normal (and data is collected every
7132 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7134 =item B<Hysteresis> I<Number>
7136 When set to non-zero, a hysteresis value is applied when checking minimum and
7137 maximum bounds. This is useful for values that increase slowly and fluctuate a
7138 bit while doing so. When these values come close to the threshold, they may
7139 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7141 If, for example, the threshold is configures as
7146 then a I<Warning> notification is created when the value exceeds I<101> and the
7147 corresponding I<Okay> notification is only created once the value falls below
7148 I<99>, thus avoiding the "flapping".
7152 =head1 FILTER CONFIGURATION
7154 Starting with collectd 4.6 there is a powerful filtering infrastructure
7155 implemented in the daemon. The concept has mostly been copied from
7156 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7157 terminology, so that users that are familiar with iptables feel right at home.
7161 The following are the terms used in the remainder of the filter configuration
7162 documentation. For an ASCII-art schema of the mechanism, see
7163 L<"General structure"> below.
7169 A I<match> is a criteria to select specific values. Examples are, of course, the
7170 name of the value or it's current value.
7172 Matches are implemented in plugins which you have to load prior to using the
7173 match. The name of such plugins starts with the "match_" prefix.
7177 A I<target> is some action that is to be performed with data. Such actions
7178 could, for example, be to change part of the value's identifier or to ignore
7179 the value completely.
7181 Some of these targets are built into the daemon, see L<"Built-in targets">
7182 below. Other targets are implemented in plugins which you have to load prior to
7183 using the target. The name of such plugins starts with the "target_" prefix.
7187 The combination of any number of matches and at least one target is called a
7188 I<rule>. The target actions will be performed for all values for which B<all>
7189 matches apply. If the rule does not have any matches associated with it, the
7190 target action will be performed for all values.
7194 A I<chain> is a list of rules and possibly default targets. The rules are tried
7195 in order and if one matches, the associated target will be called. If a value
7196 is handled by a rule, it depends on the target whether or not any subsequent
7197 rules are considered or if traversal of the chain is aborted, see
7198 L<"Flow control"> below. After all rules have been checked, the default targets
7203 =head2 General structure
7205 The following shows the resulting structure:
7212 +---------+ +---------+ +---------+ +---------+
7213 ! Rule !->! Match !->! Match !->! Target !
7214 +---------+ +---------+ +---------+ +---------+
7217 +---------+ +---------+ +---------+
7218 ! Rule !->! Target !->! Target !
7219 +---------+ +---------+ +---------+
7226 +---------+ +---------+ +---------+
7227 ! Rule !->! Match !->! Target !
7228 +---------+ +---------+ +---------+
7238 There are four ways to control which way a value takes through the filter
7245 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7246 process the value with another chain. When the called chain finishes, usually
7247 the next target or rule after the jump is executed.
7251 The stop condition, signaled for example by the built-in target B<stop>, causes
7252 all processing of the value to be stopped immediately.
7256 Causes processing in the current chain to be aborted, but processing of the
7257 value generally will continue. This means that if the chain was called via
7258 B<Jump>, the next target or rule after the jump will be executed. If the chain
7259 was not called by another chain, control will be returned to the daemon and it
7260 may pass the value to another chain.
7264 Most targets will signal the B<continue> condition, meaning that processing
7265 should continue normally. There is no special built-in target for this
7272 The configuration reflects this structure directly:
7274 PostCacheChain "PostCache"
7276 <Rule "ignore_mysql_show">
7279 Type "^mysql_command$"
7280 TypeInstance "^show_"
7290 The above configuration example will ignore all values where the plugin field
7291 is "mysql", the type is "mysql_command" and the type instance begins with
7292 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7293 default target of the chain. Since this chain is run after the value has been
7294 added to the cache, the MySQL C<show_*> command statistics will be available
7295 via the C<unixsock> plugin.
7297 =head2 List of configuration options
7301 =item B<PreCacheChain> I<ChainName>
7303 =item B<PostCacheChain> I<ChainName>
7305 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7306 argument is the name of a I<chain> that should be executed before and/or after
7307 the values have been added to the cache.
7309 To understand the implications, it's important you know what is going on inside
7310 I<collectd>. The following diagram shows how values are passed from the
7311 read-plugins to the write-plugins:
7317 + - - - - V - - - - +
7318 : +---------------+ :
7321 : +-------+-------+ :
7324 : +-------+-------+ : +---------------+
7325 : ! Cache !--->! Value Cache !
7326 : ! insert ! : +---+---+-------+
7327 : +-------+-------+ : ! !
7328 : ! ,------------' !
7330 : +-------+---+---+ : +-------+-------+
7331 : ! Post-Cache +--->! Write-Plugins !
7332 : ! Chain ! : +---------------+
7333 : +---------------+ :
7336 + - - - - - - - - - +
7338 After the values are passed from the "read" plugins to the dispatch functions,
7339 the pre-cache chain is run first. The values are added to the internal cache
7340 afterwards. The post-cache chain is run after the values have been added to the
7341 cache. So why is it such a huge deal if chains are run before or after the
7342 values have been added to this cache?
7344 Targets that change the identifier of a value list should be executed before
7345 the values are added to the cache, so that the name in the cache matches the
7346 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7347 this cache to receive a list of all available values. If you change the
7348 identifier after the value list has been added to the cache, this may easily
7349 lead to confusion, but it's not forbidden of course.
7351 The cache is also used to convert counter values to rates. These rates are, for
7352 example, used by the C<value> match (see below). If you use the rate stored in
7353 the cache B<before> the new value is added, you will use the old, B<previous>
7354 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7355 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7358 Last but not last, the B<stop> target makes a difference: If the pre-cache
7359 chain returns the stop condition, the value will not be added to the cache and
7360 the post-cache chain will not be run.
7362 =item B<Chain> I<Name>
7364 Adds a new chain with a certain name. This name can be used to refer to a
7365 specific chain, for example to jump to it.
7367 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7369 =item B<Rule> [I<Name>]
7371 Adds a new rule to the current chain. The name of the rule is optional and
7372 currently has no meaning for the daemon.
7374 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7375 must be at least one B<Target> block.
7377 =item B<Match> I<Name>
7379 Adds a match to a B<Rule> block. The name specifies what kind of match should
7380 be performed. Available matches depend on the plugins that have been loaded.
7382 The arguments inside the B<Match> block are passed to the plugin implementing
7383 the match, so which arguments are valid here depends on the plugin being used.
7384 If you do not need any to pass any arguments to a match, you can use the
7389 Which is equivalent to:
7394 =item B<Target> I<Name>
7396 Add a target to a rule or a default target to a chain. The name specifies what
7397 kind of target is to be added. Which targets are available depends on the
7398 plugins being loaded.
7400 The arguments inside the B<Target> block are passed to the plugin implementing
7401 the target, so which arguments are valid here depends on the plugin being used.
7402 If you do not need any to pass any arguments to a target, you can use the
7407 This is the same as writing:
7414 =head2 Built-in targets
7416 The following targets are built into the core daemon and therefore need no
7417 plugins to be loaded:
7423 Signals the "return" condition, see the L<"Flow control"> section above. This
7424 causes the current chain to stop processing the value and returns control to
7425 the calling chain. The calling chain will continue processing targets and rules
7426 just after the B<jump> target (see below). This is very similar to the
7427 B<RETURN> target of iptables, see L<iptables(8)>.
7429 This target does not have any options.
7437 Signals the "stop" condition, see the L<"Flow control"> section above. This
7438 causes processing of the value to be aborted immediately. This is similar to
7439 the B<DROP> target of iptables, see L<iptables(8)>.
7441 This target does not have any options.
7449 Sends the value to "write" plugins.
7455 =item B<Plugin> I<Name>
7457 Name of the write plugin to which the data should be sent. This option may be
7458 given multiple times to send the data to more than one write plugin. If the
7459 plugin supports multiple instances, the plugin's instance(s) must also be
7464 If no plugin is explicitly specified, the values will be sent to all available
7467 Single-instance plugin example:
7473 Multi-instance plugin example:
7475 <Plugin "write_graphite">
7485 Plugin "write_graphite/foo"
7490 Starts processing the rules of another chain, see L<"Flow control"> above. If
7491 the end of that chain is reached, or a stop condition is encountered,
7492 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7493 next target or the next rule. This is similar to the B<-j> command line option
7494 of iptables, see L<iptables(8)>.
7500 =item B<Chain> I<Name>
7502 Jumps to the chain I<Name>. This argument is required and may appear only once.
7514 =head2 Available matches
7520 Matches a value using regular expressions.
7526 =item B<Host> I<Regex>
7528 =item B<Plugin> I<Regex>
7530 =item B<PluginInstance> I<Regex>
7532 =item B<Type> I<Regex>
7534 =item B<TypeInstance> I<Regex>
7536 Match values where the given regular expressions match the various fields of
7537 the identifier of a value. If multiple regular expressions are given, B<all>
7538 regexen must match for a value to match.
7540 =item B<Invert> B<false>|B<true>
7542 When set to B<true>, the result of the match is inverted, i.e. all value lists
7543 where all regular expressions apply are not matched, all other value lists are
7544 matched. Defaults to B<false>.
7551 Host "customer[0-9]+"
7557 Matches values that have a time which differs from the time on the server.
7559 This match is mainly intended for servers that receive values over the
7560 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7561 is very sensitive to the timestamp used when updating the RRD files. In
7562 particular, the time must be ever increasing. If a misbehaving client sends one
7563 packet with a timestamp far in the future, all further packets with a correct
7564 time will be ignored because of that one packet. What's worse, such corrupted
7565 RRD files are hard to fix.
7567 This match lets one match all values B<outside> a specified time range
7568 (relative to the server's time), so you can use the B<stop> target (see below)
7569 to ignore the value, for example.
7575 =item B<Future> I<Seconds>
7577 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7578 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7581 =item B<Past> I<Seconds>
7583 Matches all values that are I<behind> of the server's time by I<Seconds> or
7584 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7596 This example matches all values that are five minutes or more ahead of the
7597 server or one hour (or more) lagging behind.
7601 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7602 values. If a data-set consists of more than one data-source, all data-sources
7603 must match the specified ranges for a positive match.
7609 =item B<Min> I<Value>
7611 Sets the smallest value which still results in a match. If unset, behaves like
7614 =item B<Max> I<Value>
7616 Sets the largest value which still results in a match. If unset, behaves like
7619 =item B<Invert> B<true>|B<false>
7621 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7622 no-match is returned and vice versa. Please note that the B<Invert> setting
7623 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7624 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7626 =item B<DataSource> I<DSName> [I<DSName> ...]
7628 Select one or more of the data sources. If no data source is configured, all
7629 data sources will be checked. If the type handled by the match does not have a
7630 data source of the specified name(s), this will always result in no match
7631 (independent of the B<Invert> setting).
7633 =item B<Satisfy> B<Any>|B<All>
7635 Specifies how checking with several data sources is performed. If set to
7636 B<Any>, the match succeeds if one of the data sources is in the configured
7637 range. If set to B<All> the match only succeeds if all data sources are within
7638 the configured range. Default is B<All>.
7640 Usually B<All> is used for positive matches, B<Any> is used for negative
7641 matches. This means that with B<All> you usually check that all values are in a
7642 "good" range, while with B<Any> you check if any value is within a "bad" range
7643 (or outside the "good" range).
7647 Either B<Min> or B<Max>, but not both, may be unset.
7651 # Match all values smaller than or equal to 100. Matches only if all data
7652 # sources are below 100.
7658 # Match if the value of any data source is outside the range of 0 - 100.
7666 =item B<empty_counter>
7668 Matches all values with one or more data sources of type B<COUNTER> and where
7669 all counter values are zero. These counters usually I<never> increased since
7670 they started existing (and are therefore uninteresting), or got reset recently
7671 or overflowed and you had really, I<really> bad luck.
7673 Please keep in mind that ignoring such counters can result in confusing
7674 behavior: Counters which hardly ever increase will be zero for long periods of
7675 time. If the counter is reset for some reason (machine or service restarted,
7676 usually), the graph will be empty (NAN) for a long time. People may not
7681 Calculates a hash value of the host name and matches values according to that
7682 hash value. This makes it possible to divide all hosts into groups and match
7683 only values that are in a specific group. The intended use is in load
7684 balancing, where you want to handle only part of all data and leave the rest
7687 The hashing function used tries to distribute the hosts evenly. First, it
7688 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7691 for (i = 0; host[i] != 0; i++)
7692 hash_value = (hash_value * 251) + host[i];
7694 The constant 251 is a prime number which is supposed to make this hash value
7695 more random. The code then checks the group for this host according to the
7696 I<Total> and I<Match> arguments:
7698 if ((hash_value % Total) == Match)
7703 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7704 groups), then the least significant bit of the hash value will be the XOR of
7705 all least significant bits in the host name. One consequence is that when you
7706 have two hosts, "server0.example.com" and "server1.example.com", where the host
7707 name differs in one digit only and the digits differ by one, those hosts will
7708 never end up in the same group.
7714 =item B<Match> I<Match> I<Total>
7716 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7717 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7718 be smaller than I<Total>. I<Total> must be at least one, although only values
7719 greater than one really do make any sense.
7721 You can repeat this option to match multiple groups, for example:
7726 The above config will divide the data into seven groups and match groups three
7727 and five. One use would be to keep every value on two hosts so that if one
7728 fails the missing data can later be reconstructed from the second host.
7734 # Operate on the pre-cache chain, so that ignored values are not even in the
7739 # Divide all received hosts in seven groups and accept all hosts in
7743 # If matched: Return and continue.
7746 # If not matched: Return and stop.
7752 =head2 Available targets
7756 =item B<notification>
7758 Creates and dispatches a notification.
7764 =item B<Message> I<String>
7766 This required option sets the message of the notification. The following
7767 placeholders will be replaced by an appropriate value:
7775 =item B<%{plugin_instance}>
7779 =item B<%{type_instance}>
7781 These placeholders are replaced by the identifier field of the same name.
7783 =item B<%{ds:>I<name>B<}>
7785 These placeholders are replaced by a (hopefully) human readable representation
7786 of the current rate of this data source. If you changed the instance name
7787 (using the B<set> or B<replace> targets, see below), it may not be possible to
7788 convert counter values to rates.
7792 Please note that these placeholders are B<case sensitive>!
7794 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7796 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7803 <Target "notification">
7804 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7810 Replaces parts of the identifier using regular expressions.
7816 =item B<Host> I<Regex> I<Replacement>
7818 =item B<Plugin> I<Regex> I<Replacement>
7820 =item B<PluginInstance> I<Regex> I<Replacement>
7822 =item B<TypeInstance> I<Regex> I<Replacement>
7824 Match the appropriate field with the given regular expression I<Regex>. If the
7825 regular expression matches, that part that matches is replaced with
7826 I<Replacement>. If multiple places of the input buffer match a given regular
7827 expression, only the first occurrence will be replaced.
7829 You can specify each option multiple times to use multiple regular expressions
7837 # Replace "example.net" with "example.com"
7838 Host "\\<example.net\\>" "example.com"
7840 # Strip "www." from hostnames
7846 Sets part of the identifier of a value to a given string.
7852 =item B<Host> I<String>
7854 =item B<Plugin> I<String>
7856 =item B<PluginInstance> I<String>
7858 =item B<TypeInstance> I<String>
7860 Set the appropriate field to the given string. The strings for plugin instance
7861 and type instance may be empty, the strings for host and plugin may not be
7862 empty. It's currently not possible to set the type of a value this way.
7869 PluginInstance "coretemp"
7870 TypeInstance "core3"
7875 =head2 Backwards compatibility
7877 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7878 B<Chain> block, it will behave as it used to. This is equivalent to the
7879 following configuration:
7885 If you specify a B<PostCacheChain>, the B<write> target will not be added
7886 anywhere and you will have to make sure that it is called where appropriate. We
7887 suggest to add the above snippet as default target to your "PostCache" chain.
7891 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7907 L<collectd-exec(5)>,
7908 L<collectd-perl(5)>,
7909 L<collectd-unixsock(5)>,
7922 Florian Forster E<lt>octo@collectd.orgE<gt>