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<MaxReadInterval> I<Seconds>
217 Read plugin doubles interval between queries after each failed attempt
220 This options limits the maximum value of the interval. The default value is
223 =item B<Timeout> I<Iterations>
225 Consider a value list "missing" when no update has been read or received for
226 I<Iterations> iterations. By default, I<collectd> considers a value list
227 missing when no update has been received for twice the update interval. Since
228 this setting uses iterations, the maximum allowed time without update depends
229 on the I<Interval> information contained in each value list. This is used in
230 the I<Threshold> configuration to dispatch notifications about missing values,
231 see L<collectd-threshold(5)> for details.
233 =item B<ReadThreads> I<Num>
235 Number of threads to start for reading plugins. The default value is B<5>, but
236 you may want to increase this if you have more than five plugins that take a
237 long time to read. Mostly those are plugins that do network-IO. Setting this to
238 a value higher than the number of registered read callbacks is not recommended.
240 =item B<WriteThreads> I<Num>
242 Number of threads to start for dispatching value lists to write plugins. The
243 default value is B<5>, but you may want to increase this if you have more than
244 five plugins that may take relatively long to write to.
246 =item B<WriteQueueLimitHigh> I<HighNum>
248 =item B<WriteQueueLimitLow> I<LowNum>
250 Metrics are read by the I<read threads> and then put into a queue to be handled
251 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
252 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
253 running into memory issues in such a case, you can limit the size of this
256 By default, there is no limit and memory may grow indefinitely. This is most
257 likely not an issue for clients, i.e. instances that only handle the local
258 metrics. For servers it is recommended to set this to a non-zero value, though.
260 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
261 Each of them takes a numerical argument which is the number of metrics in the
262 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
263 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
264 I<will> be enqueued. If the number of metrics currently in the queue is between
265 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
266 proportional to the number of metrics in the queue (i.e. it increases linearly
267 until it reaches 100%.)
269 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
270 unset, the latter will default to half of B<WriteQueueLimitHigh>.
272 If you do not want to randomly drop values when the queue size is between
273 I<LowNum> and I<HighNum>, set If B<WriteQueueLimitHigh> and
274 B<WriteQueueLimitLow> to same value.
276 =item B<Hostname> I<Name>
278 Sets the hostname that identifies a host. If you omit this setting, the
279 hostname will be determined using the L<gethostname(2)> system call.
281 =item B<FQDNLookup> B<true|false>
283 If B<Hostname> is determined automatically this setting controls whether or not
284 the daemon should try to figure out the "fully qualified domain name", FQDN.
285 This is done using a lookup of the name returned by C<gethostname>. This option
286 is enabled by default.
288 =item B<PreCacheChain> I<ChainName>
290 =item B<PostCacheChain> I<ChainName>
292 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
293 see L<FILTER CONFIGURATION> below on information on chains and how these
294 setting change the daemon's behavior.
298 =head1 PLUGIN OPTIONS
300 Some plugins may register own options. These options must be enclosed in a
301 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
302 require external configuration, too. The C<apache plugin>, for example,
303 required C<mod_status> to be configured in the webserver you're going to
304 collect data from. These plugins are listed below as well, even if they don't
305 require any configuration within collectd's configuration file.
307 A list of all plugins and a short summary for each plugin can be found in the
308 F<README> file shipped with the sourcecode and hopefully binary packets as
311 =head2 Plugin C<aggregation>
313 The I<Aggregation plugin> makes it possible to aggregate several values into
314 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
315 This can be put to a wide variety of uses, e.g. average and total CPU
316 statistics for your entire fleet.
318 The grouping is powerful but, as with many powerful tools, may be a bit
319 difficult to wrap your head around. The grouping will therefore be
320 demonstrated using an example: The average and sum of the CPU usage across
321 all CPUs of each host is to be calculated.
323 To select all the affected values for our example, set C<Plugin cpu> and
324 C<Type cpu>. The other values are left unspecified, meaning "all values". The
325 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
326 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
332 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
333 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
334 example, the intention is to have a new value for each host / type instance
335 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
336 It can be specified multiple times to group by more than one field.
339 GroupBy "TypeInstance"
341 We do neither specify nor group by I<plugin instance> (the CPU number), so all
342 metrics that differ in the CPU number only will be aggregated. Each
343 aggregation needs I<at least one> such field, otherwise no aggregation would
346 The full example configuration looks like this:
348 <Plugin "aggregation">
354 GroupBy "TypeInstance"
357 CalculateAverage true
361 There are a couple of limitations you should be aware of:
367 The I<Type> cannot be left unspecified, because it is not reasonable to add
368 apples to oranges. Also, the internal lookup structure won't work if you try
373 There must be at least one unspecified, ungrouped field. Otherwise nothing
378 As you can see in the example above, each aggregation has its own
379 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
380 blocks may match the same values, i.e. one value list can update multiple
381 aggregations. The following options are valid inside B<Aggregation> blocks:
385 =item B<Host> I<Host>
387 =item B<Plugin> I<Plugin>
389 =item B<PluginInstance> I<PluginInstance>
391 =item B<Type> I<Type>
393 =item B<TypeInstance> I<TypeInstance>
395 Selects the value lists to be added to this aggregation. B<Type> must be a
396 valid data set name, see L<types.db(5)> for details.
398 If the string starts with and ends with a slash (C</>), the string is
399 interpreted as a I<regular expression>. The regex flavor used are POSIX
400 extended regular expressions as described in L<regex(7)>. Example usage:
402 Host "/^db[0-9]\\.example\\.com$/"
404 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
406 Group valued by the specified field. The B<GroupBy> option may be repeated to
407 group by multiple fields.
409 =item B<SetHost> I<Host>
411 =item B<SetPlugin> I<Plugin>
413 =item B<SetPluginInstance> I<PluginInstance>
415 =item B<SetTypeInstance> I<TypeInstance>
417 Sets the appropriate part of the identifier to the provided string.
419 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
420 will be replaced with the aggregation function, e.g. "average". Not including
421 the placeholder will result in duplication warnings and/or messed up values if
422 more than one aggregation function are enabled.
424 The following example calculates the average usage of all "even" CPUs:
426 <Plugin "aggregation">
429 PluginInstance "/[0,2,4,6,8]$/"
433 SetPluginInstance "even-%{aggregation}"
436 GroupBy "TypeInstance"
438 CalculateAverage true
442 This will create the files:
448 foo.example.com/cpu-even-average/cpu-idle
452 foo.example.com/cpu-even-average/cpu-system
456 foo.example.com/cpu-even-average/cpu-user
464 =item B<CalculateNum> B<true>|B<false>
466 =item B<CalculateSum> B<true>|B<false>
468 =item B<CalculateAverage> B<true>|B<false>
470 =item B<CalculateMinimum> B<true>|B<false>
472 =item B<CalculateMaximum> B<true>|B<false>
474 =item B<CalculateStddev> B<true>|B<false>
476 Boolean options for enabling calculation of the number of value lists, their
477 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
478 are disabled by default.
482 =head2 Plugin C<amqp>
484 The I<AMQMP plugin> can be used to communicate with other instances of
485 I<collectd> or third party applications using an AMQP message broker. Values
486 are sent to or received from the broker, which handles routing, queueing and
487 possibly filtering or messages.
490 # Send values to an AMQP broker
491 <Publish "some_name">
497 Exchange "amq.fanout"
498 # ExchangeType "fanout"
499 # RoutingKey "collectd"
503 # GraphitePrefix "collectd."
504 # GraphiteEscapeChar "_"
505 # GraphiteSeparateInstances false
506 # GraphiteAlwaysAppendDS false
509 # Receive values from an AMQP broker
510 <Subscribe "some_name">
516 Exchange "amq.fanout"
517 # ExchangeType "fanout"
520 # QueueAutoDelete true
521 # RoutingKey "collectd.#"
525 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
526 blocks, which configure sending and receiving of values respectively. The two
527 blocks are very similar, so unless otherwise noted, an option can be used in
528 either block. The name given in the blocks starting tag is only used for
529 reporting messages, but may be used to support I<flushing> of certain
530 I<Publish> blocks in the future.
534 =item B<Host> I<Host>
536 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
537 the underlying communications library, I<rabbitmq-c>, which is "localhost".
539 =item B<Port> I<Port>
541 Service name or port number on which the AMQP broker accepts connections. This
542 argument must be a string, even if the numeric form is used. Defaults to
545 =item B<VHost> I<VHost>
547 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
549 =item B<User> I<User>
551 =item B<Password> I<Password>
553 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
556 =item B<Exchange> I<Exchange>
558 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
559 By default, "amq.fanout" will be used.
561 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
562 the given exchange and the I<queue> is created, using the I<routing key> if
563 configured. See the B<Queue> and B<RoutingKey> options below.
565 =item B<ExchangeType> I<Type>
567 If given, the plugin will try to create the configured I<exchange> with this
568 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
569 be bound to this exchange.
571 =item B<Queue> I<Queue> (Subscribe only)
573 Configures the I<queue> name to subscribe to. If no queue name was configured
574 explicitly, a unique queue name will be created by the broker.
576 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
578 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
579 or transient (will disappear if the AMQP broker is restarted). Defaults to
582 This option should be used in conjunction with the I<Persistent> option on the
585 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
587 Defines if the I<queue> subscribed to will be deleted once the last consumer
588 unsubscribes. Defaults to "true".
590 =item B<RoutingKey> I<Key>
592 In I<Publish> blocks, this configures the routing key to set on all outgoing
593 messages. If not given, the routing key will be computed from the I<identifier>
594 of the value. The host, plugin, type and the two instances are concatenated
595 together using dots as the separator and all containing dots replaced with
596 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
597 possible to receive only specific values using a "topic" exchange.
599 In I<Subscribe> blocks, configures the I<routing key> used when creating a
600 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
601 used to filter messages when using a "topic" exchange. If you're only
602 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
605 =item B<Persistent> B<true>|B<false> (Publish only)
607 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
608 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
609 default), the I<transient> delivery mode will be used, i.e. messages may be
610 lost due to high load, overflowing queues or similar issues.
612 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
614 Selects the format in which messages are sent to the broker. If set to
615 B<Command> (the default), values are sent as C<PUTVAL> commands which are
616 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
617 case, the C<Content-Type> header field will be set to C<text/collectd>.
619 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
620 an easy and straight forward exchange format. The C<Content-Type> header field
621 will be set to C<application/json>.
623 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
624 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
627 A subscribing client I<should> use the C<Content-Type> header field to
628 determine how to decode the values. Currently, the I<AMQP plugin> itself can
629 only decode the B<Command> format.
631 =item B<StoreRates> B<true>|B<false> (Publish only)
633 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
634 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
635 default), no conversion is performed. Otherwise the conversion is performed
636 using the internal value cache.
638 Please note that currently this option is only used if the B<Format> option has
641 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
643 A prefix can be added in the metric name when outputting in the I<Graphite> format.
644 It's added before the I<Host> name.
645 Metric name will be "<prefix><host><postfix><plugin><type><name>"
647 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
649 A postfix can be added in the metric name when outputting in the I<Graphite> format.
650 It's added after the I<Host> name.
651 Metric name will be "<prefix><host><postfix><plugin><type><name>"
653 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
655 Specify a character to replace dots (.) in the host part of the metric name.
656 In I<Graphite> metric name, dots are used as separators between different
657 metric parts (host, plugin, type).
658 Default is "_" (I<Underscore>).
660 =item B<GraphiteSeparateInstances> B<true>|B<false>
662 If set to B<true>, the plugin instance and type instance will be in their own
663 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
664 default), the plugin and plugin instance (and likewise the type and type
665 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
667 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
669 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
670 identifier. If set to B<false> (the default), this is only done when there is
675 =head2 Plugin C<apache>
677 To configure the C<apache>-plugin you first need to configure the Apache
678 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
679 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
680 the following snipped to base your Apache config upon:
683 <IfModule mod_status.c>
684 <Location /mod_status>
685 SetHandler server-status
689 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
690 also supported. It introduces a new field, called C<BusyServers>, to count the
691 number of currently connected clients. This field is also supported.
693 The configuration of the I<Apache> plugin consists of one or more
694 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
695 as the instance name. For example:
699 URL "http://www1.example.com/mod_status?auto"
702 URL "http://www2.example.com/mod_status?auto"
706 The instance name will be used as the I<plugin instance>. To emulate the old
707 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
708 plugin to work correctly, each instance name must be unique. This is not
709 enforced by the plugin and it is your responsibility to ensure it.
711 The following options are accepted within each I<Instance> block:
715 =item B<URL> I<http://host/mod_status?auto>
717 Sets the URL of the C<mod_status> output. This needs to be the output generated
718 by C<ExtendedStatus on> and it needs to be the machine readable output
719 generated by appending the C<?auto> argument. This option is I<mandatory>.
721 =item B<User> I<Username>
723 Optional user name needed for authentication.
725 =item B<Password> I<Password>
727 Optional password needed for authentication.
729 =item B<VerifyPeer> B<true|false>
731 Enable or disable peer SSL certificate verification. See
732 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
734 =item B<VerifyHost> B<true|false>
736 Enable or disable peer host name verification. If enabled, the plugin checks
737 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
738 certificate matches the host name provided by the B<URL> option. If this
739 identity check fails, the connection is aborted. Obviously, only works when
740 connecting to a SSL enabled server. Enabled by default.
742 =item B<CACert> I<File>
744 File that holds one or more SSL certificates. If you want to use HTTPS you will
745 possibly need this option. What CA certificates come bundled with C<libcurl>
746 and are checked by default depends on the distribution you use.
750 =head2 Plugin C<apcups>
754 =item B<Host> I<Hostname>
756 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
757 that IPv6 support has been disabled unless someone can confirm or decline that
758 B<apcupsd> can handle it.
760 =item B<Port> I<Port>
762 TCP-Port to connect to. Defaults to B<3551>.
764 =item B<ReportSeconds> B<true|false>
766 If set to B<true>, the time reported in the C<timeleft> metric will be
767 converted to seconds. This is the recommended setting. If set to B<false>, the
768 default for backwards compatibility, the time will be reported in minutes.
772 =head2 Plugin C<aquaero>
774 This plugin collects the value of the available sensors in an
775 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
776 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
777 connection for monitoring and configuration. The board can handle multiple
778 temperature sensors, fans, water pumps and water level sensors and adjust the
779 output settings such as fan voltage or power used by the water pump based on
780 the available inputs using a configurable controller included in the board.
781 This plugin collects all the available inputs as well as some of the output
782 values chosen by this controller. The plugin is based on the I<libaquaero5>
783 library provided by I<aquatools-ng>.
787 =item B<Device> I<DevicePath>
789 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
790 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
791 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
795 =head2 Plugin C<ascent>
797 This plugin collects information about an Ascent server, a free server for the
798 "World of Warcraft" game. This plugin gathers the information by fetching the
799 XML status page using C<libcurl> and parses it using C<libxml2>.
801 The configuration options are the same as for the C<apache> plugin above:
805 =item B<URL> I<http://localhost/ascent/status/>
807 Sets the URL of the XML status output.
809 =item B<User> I<Username>
811 Optional user name needed for authentication.
813 =item B<Password> I<Password>
815 Optional password needed for authentication.
817 =item B<VerifyPeer> B<true|false>
819 Enable or disable peer SSL certificate verification. See
820 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
822 =item B<VerifyHost> B<true|false>
824 Enable or disable peer host name verification. If enabled, the plugin checks
825 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
826 certificate matches the host name provided by the B<URL> option. If this
827 identity check fails, the connection is aborted. Obviously, only works when
828 connecting to a SSL enabled server. Enabled by default.
830 =item B<CACert> I<File>
832 File that holds one or more SSL certificates. If you want to use HTTPS you will
833 possibly need this option. What CA certificates come bundled with C<libcurl>
834 and are checked by default depends on the distribution you use.
838 =head2 Plugin C<barometer>
840 This plugin reads absolute air pressure using digital barometer sensor MPL115A2
841 or MPL3115 from Freescale (sensor attached to any I2C bus available in
842 the computer, for HW details see
843 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A> or
844 I<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>).
845 The sensor type - one fo these two - is detected automatically by the plugin
846 and indicated in the plugin_instance (typically you will see subdirectory
847 "barometer-mpl115" or "barometer-mpl3115").
849 The plugin provides absolute barometric pressure, air pressure reduced to sea
850 level (several possible approximations) and as an auxiliary value also internal
851 sensor temperature. It uses (expects/provides) typical metric units - pressure
852 in [hPa], temperature in [C], altitude in [m].
854 It was developed and tested under Linux only. The only platform dependency is
855 the standard Linux i2c-dev interface (the particular bus driver has to
856 support the SM Bus command subset).
858 The reduction or normalization to mean sea level pressure requires (depedning on
859 selected method/approximation) also altitude and reference to temperature sensor(s).
860 When multiple temperature sensors are configured the minumum of their values is
861 always used (expecting that the warmer ones are affected by e.g. direct sun light
870 TemperatureOffset 0.0
873 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
878 =item B<Device> I<device>
880 Device name of the I2C bus to which the sensor is connected. Note that typically
881 you need to have loaded the i2c-dev module.
882 Using i2c-tools you can check/list i2c buses available on your system by:
886 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
890 This way you should be able to verify that the pressure sensor (either type) is
891 connected and detected on address 0x60.
893 =item B<Oversampling> I<value>
895 For MPL115 this is the size of the averaging window. To filter out sensor noise
896 a simple averaging using floating window of configurable size is used. The plugin
897 will use average of the last C<value> measurements (value of 1 means no averaging).
898 Minimal size is 1, maximal 1024.
900 For MPL3115 this is the oversampling value. The actual oversampling is performed
901 by the sensor and the higher value the higher accuracy and longer conversion time
902 (although nothing to worry about in the collectd context). Supported values are:
903 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is adjusted by the plugin to
904 the closest supported one. Default is 128.
906 =item B<PressureOffset> I<offset>
908 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
909 This is added to the measured/caclulated value (i.e. if the measured value is too high
910 then use negative offset).
911 In hPa, default is 0.0.
913 =item B<TemperatureOffset> I<offset>
915 You can further calibrate the sensor by supplying pressure and/or temperature offsets.
916 This is added to the measured/caclulated value (i.e. if the measured value is too high
917 then use negative offset).
918 In C, default is 0.0.
920 =item B<Normalization> I<method>
922 Normalization method - what approximation/model is used to compute mean sea
923 level pressure from the air absolute pressure.
925 Supported values of the C<method> (integer between from 0 to 2) are:
929 =item B<0> - no conversion, absolute pressrure is simply copied over. For this method you
930 do not need to configure C<Altitude> or C<TemperatureSensor>.
932 =item B<1> - international formula for conversion ,
933 See I<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
934 For this method you have to configure C<Altitude> but do not need C<TemperatureSensor>
935 (uses fixed global temperature average instead).
937 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
938 Meteorological Service).
939 See I<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
940 For this method you have to configure both C<Altitude> and C<TemperatureSensor>.
945 =item B<Altitude> I<altitude>
947 The altitude (in meters) of the location where you meassure the pressure.
949 =item B<TemperatureSensor> I<reference>
951 Temperature sensor which should be used as a reference when normalizing the pressure.
952 When specified more sensors a minumum is found and uses each time.
953 The temperature reading directly from this pressure sensor/plugin
954 is typically not suitable as the pressure sensor
955 will be probably inside while we want outside temperature.
956 The collectd reference name is something like
957 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
958 (<type_instance> is usually omitted when there is just single value type).
959 Or you can figure it out from the path of the output data files.
963 =head2 Plugin C<bind>
965 Starting with BIND 9.5.0, the most widely used DNS server software provides
966 extensive statistics about queries, responses and lots of other information.
967 The bind plugin retrieves this information that's encoded in XML and provided
968 via HTTP and submits the values to collectd.
970 To use this plugin, you first need to tell BIND to make this information
971 available. This is done with the C<statistics-channels> configuration option:
973 statistics-channels {
974 inet localhost port 8053;
977 The configuration follows the grouping that can be seen when looking at the
978 data with an XSLT compatible viewer, such as a modern web browser. It's
979 probably a good idea to make yourself familiar with the provided values, so you
980 can understand what the collected statistics actually mean.
985 URL "http://localhost:8053/"
1000 Zone "127.in-addr.arpa/IN"
1004 The bind plugin accepts the following configuration options:
1010 URL from which to retrieve the XML data. If not specified,
1011 C<http://localhost:8053/> will be used.
1013 =item B<ParseTime> B<true>|B<false>
1015 When set to B<true>, the time provided by BIND will be parsed and used to
1016 dispatch the values. When set to B<false>, the local time source is queried.
1018 This setting is set to B<true> by default for backwards compatibility; setting
1019 this to B<false> is I<recommended> to avoid problems with timezones and
1022 =item B<OpCodes> B<true>|B<false>
1024 When enabled, statistics about the I<"OpCodes">, for example the number of
1025 C<QUERY> packets, are collected.
1029 =item B<QTypes> B<true>|B<false>
1031 When enabled, the number of I<incoming> queries by query types (for example
1032 C<A>, C<MX>, C<AAAA>) is collected.
1036 =item B<ServerStats> B<true>|B<false>
1038 Collect global server statistics, such as requests received over IPv4 and IPv6,
1039 successful queries, and failed updates.
1043 =item B<ZoneMaintStats> B<true>|B<false>
1045 Collect zone maintenance statistics, mostly information about notifications
1046 (zone updates) and zone transfers.
1050 =item B<ResolverStats> B<true>|B<false>
1052 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1053 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1054 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1055 default. Use the B<ResolverStats> option within a B<View "_default"> block
1056 instead for the same functionality.
1060 =item B<MemoryStats>
1062 Collect global memory statistics.
1066 =item B<View> I<Name>
1068 Collect statistics about a specific I<"view">. BIND can behave different,
1069 mostly depending on the source IP-address of the request. These different
1070 configurations are called "views". If you don't use this feature, you most
1071 likely are only interested in the C<_default> view.
1073 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1074 information you want to collect about a view. If no B<View> block is
1075 configured, no detailed view statistics will be collected.
1079 =item B<QTypes> B<true>|B<false>
1081 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1082 C<MX>) is collected.
1086 =item B<ResolverStats> B<true>|B<false>
1088 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1089 (e.E<nbsp>g. queries over IPv4, lame servers).
1093 =item B<CacheRRSets> B<true>|B<false>
1095 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1096 type is collected. Negative entries (queries which resulted in an error, for
1097 example names that do not exist) are reported with a leading exclamation mark,
1102 =item B<Zone> I<Name>
1104 When given, collect detailed information about the given zone in the view. The
1105 information collected if very similar to the global B<ServerStats> information
1108 You can repeat this option to collect detailed information about multiple
1111 By default no detailed zone information is collected.
1117 =head2 Plugin C<cgroups>
1119 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1120 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1121 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1125 =item B<CGroup> I<Directory>
1127 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1128 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1131 =item B<IgnoreSelected> B<true>|B<false>
1133 Invert the selection: If set to true, all cgroups I<except> the ones that
1134 match any one of the criteria are collected. By default only selected
1135 cgroups are collected if a selection is made. If no selection is configured
1136 at all, B<all> cgroups are selected.
1140 =head2 Plugin C<conntrack>
1142 This plugin collects IP conntrack statistics.
1148 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1149 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1153 =head2 Plugin C<cpu>
1155 The I<CPU plugin> collects CPU usage metrics.
1157 The following configuration options are available:
1161 =item B<ReportActive> B<false>|B<true>
1163 Reports non-idle CPU usage as the "active" value. Defaults to false.
1165 =item B<ReportByCpu> B<false>|B<true>
1167 When true reports usage for all cores. When false, reports cpu usage
1168 aggregated over all cores.
1171 =item B<ValuesPercentage> B<false>|B<true>
1173 When true report percentage usage instead of tick values. Defaults to false.
1178 =head2 Plugin C<cpufreq>
1180 This plugin doesn't have any options. It reads
1181 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1182 installed) to get the current CPU frequency. If this file does not exist make
1183 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1184 installed and an "cpu governor" (that's a kernel module) is loaded.
1186 =head2 Plugin C<csv>
1190 =item B<DataDir> I<Directory>
1192 Set the directory to store CSV-files under. Per default CSV-files are generated
1193 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1194 The special strings B<stdout> and B<stderr> can be used to write to the standard
1195 output and standard error channels, respectively. This, of course, only makes
1196 much sense when collectd is running in foreground- or non-daemon-mode.
1198 =item B<StoreRates> B<true|false>
1200 If set to B<true>, convert counter values to rates. If set to B<false> (the
1201 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1206 =head2 Plugin C<curl>
1208 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1209 and the match infrastructure (the same code used by the tail plugin) to use
1210 regular expressions with the received data.
1212 The following example will read the current value of AMD stock from Google's
1213 finance page and dispatch the value to collectd.
1216 <Page "stock_quotes">
1217 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1221 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1222 DSType "GaugeAverage"
1223 # Note: `stock_value' is not a standard type.
1230 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1231 a web page and one or more "matches" to be performed on the returned data. The
1232 string argument to the B<Page> block is used as plugin instance.
1234 The following options are valid within B<Page> blocks:
1240 URL of the web site to retrieve. Since a regular expression will be used to
1241 extract information from this data, non-binary data is a big plus here ;)
1243 =item B<User> I<Name>
1245 Username to use if authorization is required to read the page.
1247 =item B<Password> I<Password>
1249 Password to use if authorization is required to read the page.
1251 =item B<Digest> B<true>|B<false>
1253 Enable HTTP digest authentication.
1255 =item B<VerifyPeer> B<true>|B<false>
1257 Enable or disable peer SSL certificate verification. See
1258 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1260 =item B<VerifyHost> B<true>|B<false>
1262 Enable or disable peer host name verification. If enabled, the plugin checks if
1263 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1264 matches the host name provided by the B<URL> option. If this identity check
1265 fails, the connection is aborted. Obviously, only works when connecting to a
1266 SSL enabled server. Enabled by default.
1268 =item B<CACert> I<file>
1270 File that holds one or more SSL certificates. If you want to use HTTPS you will
1271 possibly need this option. What CA certificates come bundled with C<libcurl>
1272 and are checked by default depends on the distribution you use.
1274 =item B<Header> I<Header>
1276 A HTTP header to add to the request. Multiple headers are added if this option
1277 is specified more than once.
1279 =item B<Post> I<Body>
1281 Specifies that the HTTP operation should be a POST instead of a GET. The
1282 complete data to be posted is given as the argument. This option will usually
1283 need to be accompanied by a B<Header> option to set an appropriate
1284 C<Content-Type> for the post body (e.g. to
1285 C<application/x-www-form-urlencoded>).
1287 =item B<MeasureResponseTime> B<true>|B<false>
1289 Measure response time for the request. If this setting is enabled, B<Match>
1290 blocks (see below) are optional. Disabled by default.
1292 =item B<E<lt>MatchE<gt>>
1294 One or more B<Match> blocks that define how to match information in the data
1295 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1296 used by the C<tail> plugin, so please see the documentation of the C<tail>
1297 plugin below on how matches are defined. If the B<MeasureResponseTime> option
1298 is set to B<true>, B<Match> blocks are optional.
1302 =head2 Plugin C<curl_json>
1304 The B<curl_json plugin> collects values from JSON data to be parsed by
1305 B<libyajl> (L<http://www.lloydforge.org/projects/yajl/>) retrieved via
1306 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1307 unix socket. The former can be used, for example, to collect values
1308 from CouchDB documents (which are stored JSON notation), and the
1309 latter to collect values from a uWSGI stats socket.
1311 The following example will collect several values from the built-in
1312 C<_stats> runtime statistics module of I<CouchDB>
1313 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1316 <URL "http://localhost:5984/_stats">
1318 <Key "httpd/requests/count">
1319 Type "http_requests"
1322 <Key "httpd_request_methods/*/count">
1323 Type "http_request_methods"
1326 <Key "httpd_status_codes/*/count">
1327 Type "http_response_codes"
1332 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1335 <Sock "/var/run/uwsgi.stats.sock">
1337 <Key "workers/*/requests">
1338 Type "http_requests"
1341 <Key "workers/*/apps/*/requests">
1342 Type "http_requests"
1347 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1348 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1349 blocks defining a unix socket to read JSON from directly. Each of
1350 these blocks may have one or more B<Key> blocks.
1352 The B<Key> string argument must be in a path format. Each component is
1353 used to match the key from a JSON map or the index of an JSON
1354 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1355 values for all map keys or array indices will be collectd.
1357 The following options are valid within B<URL> blocks:
1361 =item B<Instance> I<Instance>
1363 Sets the plugin instance to I<Instance>.
1365 =item B<Interval> I<Interval>
1367 Sets the interval (in seconds) in which the values will be collected from this
1368 URL. By default the global B<Interval> setting will be used.
1370 =item B<User> I<Name>
1372 =item B<Password> I<Password>
1374 =item B<Digest> B<true>|B<false>
1376 =item B<VerifyPeer> B<true>|B<false>
1378 =item B<VerifyHost> B<true>|B<false>
1380 =item B<CACert> I<file>
1382 =item B<Header> I<Header>
1384 =item B<Post> I<Body>
1386 These options behave exactly equivalent to the appropriate options of the
1387 I<cURL> plugin. Please see there for a detailed description.
1391 The following options are valid within B<Key> blocks:
1395 =item B<Type> I<Type>
1397 Sets the type used to dispatch the values to the daemon. Detailed information
1398 about types and their configuration can be found in L<types.db(5)>. This
1399 option is mandatory.
1401 =item B<Instance> I<Instance>
1403 Type-instance to use. Defaults to the current map key or current string array element value.
1407 =head2 Plugin C<curl_xml>
1409 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1410 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1413 <URL "http://localhost/stats.xml">
1415 Instance "some_instance"
1420 CACert "/path/to/ca.crt"
1422 <XPath "table[@id=\"magic_level\"]/tr">
1424 #InstancePrefix "prefix-"
1425 InstanceFrom "td[1]"
1426 ValuesFrom "td[2]/span[@class=\"level\"]"
1431 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1432 URL to be fetched using libcurl. Within each B<URL> block there are
1433 options which specify the connection parameters, for example authentication
1434 information, and one or more B<XPath> blocks.
1436 Each B<XPath> block specifies how to get one type of information. The
1437 string argument must be a valid XPath expression which returns a list
1438 of "base elements". One value is dispatched for each "base element". The
1439 I<type instance> and values are looked up using further I<XPath> expressions
1440 that should be relative to the base element.
1442 Within the B<URL> block the following options are accepted:
1446 =item B<Host> I<Name>
1448 Use I<Name> as the host name when submitting values. Defaults to the global
1451 =item B<Instance> I<Instance>
1453 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1454 empty string (no plugin instance).
1456 =item B<Namespace> I<Prefix> I<URL>
1458 If an XPath expression references namespaces, they must be specified
1459 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1460 I<URL> is the "namespace name", an URI reference uniquely identifying the
1461 namespace. The option can be repeated to register multiple namespaces.
1465 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1466 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1468 =item B<User> I<User>
1470 =item B<Password> I<Password>
1472 =item B<Digest> B<true>|B<false>
1474 =item B<VerifyPeer> B<true>|B<false>
1476 =item B<VerifyHost> B<true>|B<false>
1478 =item B<CACert> I<CA Cert File>
1480 =item B<Header> I<Header>
1482 =item B<Post> I<Body>
1484 These options behave exactly equivalent to the appropriate options of the
1485 I<cURL plugin>. Please see there for a detailed description.
1487 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1489 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1490 B<XPath> block specifies how to get one type of information. The string
1491 argument must be a valid XPath expression which returns a list of "base
1492 elements". One value is dispatched for each "base element".
1494 Within the B<XPath> block the following options are accepted:
1498 =item B<Type> I<Type>
1500 Specifies the I<Type> used for submitting patches. This determines the number
1501 of values that are required / expected and whether the strings are parsed as
1502 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1503 This option is required.
1505 =item B<InstancePrefix> I<InstancePrefix>
1507 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1508 concatenated together without any separator.
1509 This option is optional.
1511 =item B<InstanceFrom> I<InstanceFrom>
1513 Specifies a XPath expression to use for determining the I<type instance>. The
1514 XPath expression must return exactly one element. The element's value is then
1515 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1517 This value is required. As a special exception, if the "base XPath expression"
1518 (the argument to the B<XPath> block) returns exactly one argument, then this
1519 option may be omitted.
1521 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
1523 Specifies one or more XPath expression to use for reading the values. The
1524 number of XPath expressions must match the number of data sources in the
1525 I<type> specified with B<Type> (see above). Each XPath expression must return
1526 exactly one element. The element's value is then parsed as a number and used as
1527 value for the appropriate value in the value list dispatched to the daemon.
1533 =head2 Plugin C<dbi>
1535 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
1536 connect to various databases, execute I<SQL> statements and read back the
1537 results. I<dbi> is an acronym for "database interface" in case you were
1538 wondering about the name. You can configure how each column is to be
1539 interpreted and the plugin will generate one or more data sets from each row
1540 returned according to these rules.
1542 Because the plugin is very generic, the configuration is a little more complex
1543 than those of other plugins. It usually looks something like this:
1546 <Query "out_of_stock">
1547 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
1548 # Use with MySQL 5.0.0 or later
1552 InstancePrefix "out_of_stock"
1553 InstancesFrom "category"
1557 <Database "product_information">
1559 DriverOption "host" "localhost"
1560 DriverOption "username" "collectd"
1561 DriverOption "password" "aZo6daiw"
1562 DriverOption "dbname" "prod_info"
1563 SelectDB "prod_info"
1564 Query "out_of_stock"
1568 The configuration above defines one query with one result and one database. The
1569 query is then linked to the database with the B<Query> option I<within> the
1570 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
1571 and you can also use the B<Include> statement to split up the configuration
1572 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
1573 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
1576 The following is a complete list of options:
1578 =head3 B<Query> blocks
1580 Query blocks define I<SQL> statements and how the returned data should be
1581 interpreted. They are identified by the name that is given in the opening line
1582 of the block. Thus the name needs to be unique. Other than that, the name is
1583 not used in collectd.
1585 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
1586 define which column holds which value or instance information. You can use
1587 multiple B<Result> blocks to create multiple values from one returned row. This
1588 is especially useful, when queries take a long time and sending almost the same
1589 query again and again is not desirable.
1593 <Query "environment">
1594 Statement "select station, temperature, humidity from environment"
1597 # InstancePrefix "foo"
1598 InstancesFrom "station"
1599 ValuesFrom "temperature"
1603 InstancesFrom "station"
1604 ValuesFrom "humidity"
1608 The following options are accepted:
1612 =item B<Statement> I<SQL>
1614 Sets the statement that should be executed on the server. This is B<not>
1615 interpreted by collectd, but simply passed to the database server. Therefore,
1616 the SQL dialect that's used depends on the server collectd is connected to.
1618 The query has to return at least two columns, one for the instance and one
1619 value. You cannot omit the instance, even if the statement is guaranteed to
1620 always return exactly one line. In that case, you can usually specify something
1623 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
1625 (That works with MySQL but may not be valid SQL according to the spec. If you
1626 use a more strict database server, you may have to select from a dummy table or
1629 Please note that some databases, for example B<Oracle>, will fail if you
1630 include a semicolon at the end of the statement.
1632 =item B<MinVersion> I<Version>
1634 =item B<MaxVersion> I<Value>
1636 Only use this query for the specified database version. You can use these
1637 options to provide multiple queries with the same name but with a slightly
1638 different syntax. The plugin will use only those queries, where the specified
1639 minimum and maximum versions fit the version of the database in use.
1641 The database version is determined by C<dbi_conn_get_engine_version>, see the
1642 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
1643 for details. Basically, each part of the version is assumed to be in the range
1644 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
1645 "40102", version "5.0.42" becomes "50042".
1647 B<Warning:> The plugin will use B<all> matching queries, so if you specify
1648 multiple queries with the same name and B<overlapping> ranges, weird stuff will
1649 happen. Don't to it! A valid example would be something along these lines:
1660 In the above example, there are three ranges that don't overlap. The last one
1661 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
1662 before "4.0.0" are not specified.
1664 =item B<Type> I<Type>
1666 The B<type> that's used for each line returned. See L<types.db(5)> for more
1667 details on how types are defined. In short: A type is a predefined layout of
1668 data and the number of values and type of values has to match the type
1671 If you specify "temperature" here, you need exactly one gauge column. If you
1672 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
1675 There must be exactly one B<Type> option inside each B<Result> block.
1677 =item B<InstancePrefix> I<prefix>
1679 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
1680 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
1681 all strings returned in the appropriate columns are concatenated together,
1682 separated by dashes I<("-")>.
1684 =item B<InstancesFrom> I<column0> [I<column1> ...]
1686 Specifies the columns whose values will be used to create the "type-instance"
1687 for each row. If you specify more than one column, the value of all columns
1688 will be joined together with dashes I<("-")> as separation characters.
1690 The plugin itself does not check whether or not all built instances are
1691 different. It's your responsibility to assure that each is unique. This is
1692 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
1693 sure that only one row is returned in this case.
1695 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
1698 =item B<ValuesFrom> I<column0> [I<column1> ...]
1700 Names the columns whose content is used as the actual data for the data sets
1701 that are dispatched to the daemon. How many such columns you need is determined
1702 by the B<Type> setting above. If you specify too many or not enough columns,
1703 the plugin will complain about that and no data will be submitted to the
1706 The actual data type in the columns is not that important. The plugin will
1707 automatically cast the values to the right type if it know how to do that. So
1708 it should be able to handle integer an floating point types, as well as strings
1709 (if they include a number at the beginning).
1711 There must be at least one B<ValuesFrom> option inside each B<Result> block.
1713 =item B<MetadataFrom> [I<column0> I<column1> ...]
1715 Names the columns whose content is used as metadata for the data sets
1716 that are dispatched to the daemon.
1718 The actual data type in the columns is not that important. The plugin will
1719 automatically cast the values to the right type if it know how to do that. So
1720 it should be able to handle integer an floating point types, as well as strings
1721 (if they include a number at the beginning).
1725 =head3 B<Database> blocks
1727 Database blocks define a connection to a database and which queries should be
1728 sent to that database. Since the used "dbi" library can handle a wide variety
1729 of databases, the configuration is very generic. If in doubt, refer to libdbi's
1730 documentationE<nbsp>- we stick as close to the terminology used there.
1732 Each database needs a "name" as string argument in the starting tag of the
1733 block. This name will be used as "PluginInstance" in the values submitted to
1734 the daemon. Other than that, that name is not used.
1738 =item B<Driver> I<Driver>
1740 Specifies the driver to use to connect to the database. In many cases those
1741 drivers are named after the database they can connect to, but this is not a
1742 technical necessity. These drivers are sometimes referred to as "DBD",
1743 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
1744 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
1745 project at L<http://libdbi-drivers.sourceforge.net/>.
1747 You need to give the driver name as expected by the "dbi" library here. You
1748 should be able to find that in the documentation for each driver. If you
1749 mistype the driver name, the plugin will dump a list of all known driver names
1752 =item B<DriverOption> I<Key> I<Value>
1754 Sets driver-specific options. What option a driver supports can be found in the
1755 documentation for each driver, somewhere at
1756 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
1757 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
1759 DBDs can register two types of options: String options and numeric options. The
1760 plugin will use the C<dbi_conn_set_option> function when the configuration
1761 provides a string and the C<dbi_conn_require_option_numeric> function when the
1762 configuration provides a number. So these two lines will actually result in
1763 different calls being used:
1765 DriverOption "Port" 1234 # numeric
1766 DriverOption "Port" "1234" # string
1768 Unfortunately, drivers are not too keen to report errors when an unknown option
1769 is passed to them, so invalid settings here may go unnoticed. This is not the
1770 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
1771 the driver. If a driver complains about an option, the plugin will dump a
1772 complete list of all options understood by that driver to the log. There is no
1773 way to programatically find out if an option expects a string or a numeric
1774 argument, so you will have to refer to the appropriate DBD's documentation to
1775 find this out. Sorry.
1777 =item B<SelectDB> I<Database>
1779 In some cases, the database name you connect with is not the database name you
1780 want to use for querying data. If this option is set, the plugin will "select"
1781 (switch to) that database after the connection is established.
1783 =item B<Query> I<QueryName>
1785 Associates the query named I<QueryName> with this database connection. The
1786 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
1787 blocks you want to refer to must be placed above the database block you want to
1790 =item B<Host> I<Hostname>
1792 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
1793 values. Defaults to the global hostname setting.
1801 =item B<Device> I<Device>
1803 Select partitions based on the devicename.
1805 =item B<MountPoint> I<Directory>
1807 Select partitions based on the mountpoint.
1809 =item B<FSType> I<FSType>
1811 Select partitions based on the filesystem type.
1813 =item B<IgnoreSelected> B<true>|B<false>
1815 Invert the selection: If set to true, all partitions B<except> the ones that
1816 match any one of the criteria are collected. By default only selected
1817 partitions are collected if a selection is made. If no selection is configured
1818 at all, B<all> partitions are selected.
1820 =item B<ReportByDevice> B<true>|B<false>
1822 Report using the device name rather than the mountpoint. i.e. with this I<false>,
1823 (the default), it will report a disk as "root", but with it I<true>, it will be
1824 "sda1" (or whichever).
1826 =item B<ReportInodes> B<true>|B<false>
1828 Enables or disables reporting of free, reserved and used inodes. Defaults to
1829 inode collection being disabled.
1831 Enable this option if inodes are a scarce resource for you, usually because
1832 many small files are stored on the disk. This is a usual scenario for mail
1833 transfer agents and web caches.
1835 =item B<ValuesAbsolute> B<true>|B<false>
1837 Enables or disables reporting of free and used disk space in 1K-blocks.
1838 Defaults to B<true>.
1840 =item B<ValuesPercentage> B<false>|B<true>
1842 Enables or disables reporting of free and used disk space in percentage.
1843 Defaults to B<false>.
1845 This is useful for deploying I<collectd> on the cloud, where machines with
1846 different disk size may exist. Then it is more practical to configure
1847 thresholds based on relative disk size.
1851 =head2 Plugin C<disk>
1853 The C<disk> plugin collects information about the usage of physical disks and
1854 logical disks (partitions). Values collected are the number of octets written
1855 to and read from a disk or partition, the number of read/write operations
1856 issued to the disk and a rather complex "time" it took for these commands to be
1859 Using the following two options you can ignore some disks or configure the
1860 collection only of specific disks.
1864 =item B<Disk> I<Name>
1866 Select the disk I<Name>. Whether it is collected or ignored depends on the
1867 B<IgnoreSelected> setting, see below. As with other plugins that use the
1868 daemon's ignorelist functionality, a string that starts and ends with a slash
1869 is interpreted as a regular expression. Examples:
1874 =item B<IgnoreSelected> B<true>|B<false>
1876 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
1877 statements, are ignored or if all other disks are ignored. The behavior
1878 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
1879 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
1880 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
1881 is set to B<true>, all disks are collected B<except> the ones matched.
1883 =item B<UseBSDName> B<true>|B<false>
1885 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
1886 default major/minor numbers. Requires collectd to be built with Apple's
1889 =item B<UdevNameAttr> I<Attribute>
1891 Attempt to override disk instance name with the value of a specified udev
1892 attribute when built with B<libudev>. If the attribute is not defined for the
1893 given device, the default name is used. Example:
1895 UdevNameAttr "DM_NAME"
1899 =head2 Plugin C<dns>
1903 =item B<Interface> I<Interface>
1905 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
1906 option sets the interface that should be used. If this option is not set, or
1907 set to "any", the plugin will try to get packets from B<all> interfaces. This
1908 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
1910 =item B<IgnoreSource> I<IP-address>
1912 Ignore packets that originate from this address.
1914 =item B<SelectNumericQueryTypes> B<true>|B<false>
1916 Enabled by default, collects unknown (and thus presented as numeric only) query types.
1920 =head2 Plugin C<email>
1924 =item B<SocketFile> I<Path>
1926 Sets the socket-file which is to be created.
1928 =item B<SocketGroup> I<Group>
1930 If running as root change the group of the UNIX-socket after it has been
1931 created. Defaults to B<collectd>.
1933 =item B<SocketPerms> I<Permissions>
1935 Change the file permissions of the UNIX-socket after it has been created. The
1936 permissions must be given as a numeric, octal value as you would pass to
1937 L<chmod(1)>. Defaults to B<0770>.
1939 =item B<MaxConns> I<Number>
1941 Sets the maximum number of connections that can be handled in parallel. Since
1942 this many threads will be started immediately setting this to a very high
1943 value will waste valuable resources. Defaults to B<5> and will be forced to be
1944 at most B<16384> to prevent typos and dumb mistakes.
1948 =head2 Plugin C<ethstat>
1950 The I<ethstat plugin> collects information about network interface cards (NICs)
1951 by talking directly with the underlying kernel driver using L<ioctl(2)>.
1957 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
1958 Map "multicast" "if_multicast"
1965 =item B<Interface> I<Name>
1967 Collect statistical information about interface I<Name>.
1969 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
1971 By default, the plugin will submit values as type C<derive> and I<type
1972 instance> set to I<Name>, the name of the metric as reported by the driver. If
1973 an appropriate B<Map> option exists, the given I<Type> and, optionally,
1974 I<TypeInstance> will be used.
1976 =item B<MappedOnly> B<true>|B<false>
1978 When set to B<true>, only metrics that can be mapped to to a I<type> will be
1979 collected, all other metrics will be ignored. Defaults to B<false>.
1983 =head2 Plugin C<exec>
1985 Please make sure to read L<collectd-exec(5)> before using this plugin. It
1986 contains valuable information on when the executable is executed and the
1987 output that is expected from it.
1991 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1993 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
1995 Execute the executable I<Executable> as user I<User>. If the user name is
1996 followed by a colon and a group name, the effective group is set to that group.
1997 The real group and saved-set group will be set to the default group of that
1998 user. If no group is given the effective group ID will be the same as the real
2001 Please note that in order to change the user and/or group the daemon needs
2002 superuser privileges. If the daemon is run as an unprivileged user you must
2003 specify the same user/group here. If the daemon is run with superuser
2004 privileges, you must supply a non-root user here.
2006 The executable may be followed by optional arguments that are passed to the
2007 program. Please note that due to the configuration parsing numbers and boolean
2008 values may be changed. If you want to be absolutely sure that something is
2009 passed as-is please enclose it in quotes.
2011 The B<Exec> and B<NotificationExec> statements change the semantics of the
2012 programs executed, i.E<nbsp>e. the data passed to them and the response
2013 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2017 =head2 Plugin C<filecount>
2019 The C<filecount> plugin counts the number of files in a certain directory (and
2020 its subdirectories) and their combined size. The configuration is very straight
2023 <Plugin "filecount">
2024 <Directory "/var/qmail/queue/mess">
2025 Instance "qmail-message"
2027 <Directory "/var/qmail/queue/todo">
2028 Instance "qmail-todo"
2030 <Directory "/var/lib/php5">
2031 Instance "php5-sessions"
2036 The example above counts the number of files in QMail's queue directories and
2037 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2038 QMail has not yet looked at, the "message" queue holds the messages that were
2039 classified into "local" and "remote".
2041 As you can see, the configuration consists of one or more C<Directory> blocks,
2042 each of which specifies a directory in which to count the files. Within those
2043 blocks, the following options are recognized:
2047 =item B<Instance> I<Instance>
2049 Sets the plugin instance to I<Instance>. That instance name must be unique, but
2050 it's your responsibility, the plugin doesn't check for that. If not given, the
2051 instance is set to the directory name with all slashes replaced by underscores
2052 and all leading underscores removed.
2054 =item B<Name> I<Pattern>
2056 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2057 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2058 against the pattern, not the entire path. In case this makes it easier for you:
2059 This option has been named after the B<-name> parameter to L<find(1)>.
2061 =item B<MTime> I<Age>
2063 Count only files of a specific age: If I<Age> is greater than zero, only files
2064 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2065 a negative number, this is inversed. For example, if B<-60> is specified, only
2066 files that have been modified in the last minute will be counted.
2068 The number can also be followed by a "multiplier" to easily specify a larger
2069 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2070 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2071 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2072 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2073 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2076 =item B<Size> I<Size>
2078 Count only files of a specific size. When I<Size> is a positive number, only
2079 files that are at least this big are counted. If I<Size> is a negative number,
2080 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2081 I<Size> are counted.
2083 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2084 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2085 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2086 note that there are 1000 bytes in a kilobyte, not 1024.
2088 =item B<Recursive> I<true>|I<false>
2090 Controls whether or not to recurse into subdirectories. Enabled by default.
2092 =item B<IncludeHidden> I<true>|I<false>
2094 Controls whether or not to include "hidden" files and directories in the count.
2095 "Hidden" files and directories are those, whose name begins with a dot.
2096 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2100 =head2 Plugin C<GenericJMX>
2102 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2103 L<collectd-java(5)>.
2105 =head2 Plugin C<gmond>
2107 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2108 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2109 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2114 MCReceiveFrom "239.2.11.71" "8649"
2115 <Metric "swap_total">
2117 TypeInstance "total"
2120 <Metric "swap_free">
2127 The following metrics are built-in:
2133 load_one, load_five, load_fifteen
2137 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2141 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2153 Available configuration options:
2157 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2159 Sets sets the multicast group and UDP port to which to subscribe.
2161 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2163 =item E<lt>B<Metric> I<Name>E<gt>
2165 These blocks add a new metric conversion to the internal table. I<Name>, the
2166 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2170 =item B<Type> I<Type>
2172 Type to map this metric to. Required.
2174 =item B<TypeInstance> I<Instance>
2176 Type-instance to use. Optional.
2178 =item B<DataSource> I<Name>
2180 Data source to map this metric to. If the configured type has exactly one data
2181 source, this is optional. Otherwise the option is required.
2187 =head2 Plugin C<hddtemp>
2189 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
2190 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
2191 default values, see below. C<hddtemp> has to be running to work correctly. If
2192 C<hddtemp> is not running timeouts may appear which may interfere with other
2195 The B<hddtemp> homepage can be found at
2196 L<http://www.guzu.net/linux/hddtemp.php>.
2200 =item B<Host> I<Hostname>
2202 Hostname to connect to. Defaults to B<127.0.0.1>.
2204 =item B<Port> I<Port>
2206 TCP-Port to connect to. Defaults to B<7634>.
2210 =head2 Plugin C<interface>
2214 =item B<Interface> I<Interface>
2216 Select this interface. By default these interfaces will then be collected. For
2217 a more detailed description see B<IgnoreSelected> below.
2219 =item B<IgnoreSelected> I<true>|I<false>
2221 If no configuration if given, the B<traffic>-plugin will collect data from
2222 all interfaces. This may not be practical, especially for loopback- and
2223 similar interfaces. Thus, you can use the B<Interface>-option to pick the
2224 interfaces you're interested in. Sometimes, however, it's easier/preferred
2225 to collect all interfaces I<except> a few ones. This option enables you to
2226 do that: By setting B<IgnoreSelected> to I<true> the effect of
2227 B<Interface> is inverted: All selected interfaces are ignored and all
2228 other interfaces are collected.
2232 =head2 Plugin C<ipmi>
2236 =item B<Sensor> I<Sensor>
2238 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
2240 =item B<IgnoreSelected> I<true>|I<false>
2242 If no configuration if given, the B<ipmi> plugin will collect data from all
2243 sensors found of type "temperature", "voltage", "current" and "fanspeed".
2244 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
2245 the effect of B<Sensor> is inverted: All selected sensors are ignored and
2246 all other sensors are collected.
2248 =item B<NotifySensorAdd> I<true>|I<false>
2250 If a sensor appears after initialization time of a minute a notification
2253 =item B<NotifySensorRemove> I<true>|I<false>
2255 If a sensor disappears a notification is sent.
2257 =item B<NotifySensorNotPresent> I<true>|I<false>
2259 If you have for example dual power supply and one of them is (un)plugged then
2260 a notification is sent.
2264 =head2 Plugin C<iptables>
2268 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
2270 Select the rules to count. If only I<Table> and I<Chain> are given, this plugin
2271 will collect the counters of all rules which have a comment-match. The comment
2272 is then used as type-instance.
2274 If I<Comment> or I<Number> is given, only the rule with the matching comment or
2275 the I<n>th rule will be collected. Again, the comment (or the number) will be
2276 used as the type-instance.
2278 If I<Name> is supplied, it will be used as the type-instance instead of the
2279 comment or the number.
2283 =head2 Plugin C<irq>
2289 Select this irq. By default these irqs will then be collected. For a more
2290 detailed description see B<IgnoreSelected> below.
2292 =item B<IgnoreSelected> I<true>|I<false>
2294 If no configuration if given, the B<irq>-plugin will collect data from all
2295 irqs. This may not be practical, especially if no interrupts happen. Thus, you
2296 can use the B<Irq>-option to pick the interrupt you're interested in.
2297 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
2298 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
2299 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
2300 and all other interrupts are collected.
2304 =head2 Plugin C<java>
2306 The I<Java> plugin makes it possible to write extensions for collectd in Java.
2307 This section only discusses the syntax and semantic of the configuration
2308 options. For more in-depth information on the I<Java> plugin, please read
2309 L<collectd-java(5)>.
2314 JVMArg "-verbose:jni"
2315 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
2316 LoadPlugin "org.collectd.java.Foobar"
2317 <Plugin "org.collectd.java.Foobar">
2318 # To be parsed by the plugin
2322 Available configuration options:
2326 =item B<JVMArg> I<Argument>
2328 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
2329 exactly the way the arguments to the I<java> binary on the command line work.
2330 Execute C<javaE<nbsp>--help> for details.
2332 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
2333 any other options! When another option is found, the JVM will be started and
2334 later options will have to be ignored!
2336 =item B<LoadPlugin> I<JavaClass>
2338 Instantiates a new I<JavaClass> object. The constructor of this object very
2339 likely then registers one or more callback methods with the server.
2341 See L<collectd-java(5)> for details.
2343 When the first such option is found, the virtual machine (JVM) is created. This
2344 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
2345 B<LoadPlugin> options!
2347 =item B<Plugin> I<Name>
2349 The entire block is passed to the Java plugin as an
2350 I<org.collectd.api.OConfigItem> object.
2352 For this to work, the plugin has to register a configuration callback first,
2353 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
2354 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
2355 depends on the (Java) plugin registering the callback and is completely
2356 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
2360 =head2 Plugin C<libvirt>
2362 This plugin allows CPU, disk and network load to be collected for virtualized
2363 guests on the machine. This means that these characteristics can be collected
2364 for guest systems without installing any software on them - collectd only runs
2365 on the hosting system. The statistics are collected through libvirt
2366 (L<http://libvirt.org/>).
2368 Only I<Connection> is required.
2372 =item B<Connection> I<uri>
2374 Connect to the hypervisor given by I<uri>. For example if using Xen use:
2376 Connection "xen:///"
2378 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
2380 =item B<RefreshInterval> I<seconds>
2382 Refresh the list of domains and devices every I<seconds>. The default is 60
2383 seconds. Setting this to be the same or smaller than the I<Interval> will cause
2384 the list of domains and devices to be refreshed on every iteration.
2386 Refreshing the devices in particular is quite a costly operation, so if your
2387 virtualization setup is static you might consider increasing this. If this
2388 option is set to 0, refreshing is disabled completely.
2390 =item B<Domain> I<name>
2392 =item B<BlockDevice> I<name:dev>
2394 =item B<InterfaceDevice> I<name:dev>
2396 =item B<IgnoreSelected> I<true>|I<false>
2398 Select which domains and devices are collected.
2400 If I<IgnoreSelected> is not given or I<false> then only the listed domains and
2401 disk/network devices are collected.
2403 If I<IgnoreSelected> is I<true> then the test is reversed and the listed
2404 domains and disk/network devices are ignored, while the rest are collected.
2406 The domain name and device names may use a regular expression, if the name is
2407 surrounded by I</.../> and collectd was compiled with support for regexps.
2409 The default is to collect statistics for all domains and all their devices.
2413 BlockDevice "/:hdb/"
2414 IgnoreSelected "true"
2416 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
2419 =item B<HostnameFormat> B<name|uuid|hostname|...>
2421 When the libvirt plugin logs data, it sets the hostname of the collected data
2422 according to this setting. The default is to use the guest name as provided by
2423 the hypervisor, which is equal to setting B<name>.
2425 B<uuid> means use the guest's UUID. This is useful if you want to track the
2426 same guest across migrations.
2428 B<hostname> means to use the global B<Hostname> setting, which is probably not
2429 useful on its own because all guests will appear to have the same name.
2431 You can also specify combinations of these fields. For example B<name uuid>
2432 means to concatenate the guest name and UUID (with a literal colon character
2433 between, thus I<"foo:1234-1234-1234-1234">).
2435 =item B<InterfaceFormat> B<name>|B<address>
2437 When the libvirt plugin logs interface data, it sets the name of the collected
2438 data according to this setting. The default is to use the path as provided by
2439 the hypervisor (the "dev" property of the target node), which is equal to
2442 B<address> means use the interface's mac address. This is useful since the
2443 interface path might change between reboots of a guest or across migrations.
2445 =item B<PluginInstanceFormat> B<name|uuid>
2447 When the libvirt plugin logs data, it sets the plugin_instance of the collected
2448 data according to this setting. The default is to use the guest name as provided
2449 by the hypervisor, which is equal to setting B<name>.
2451 B<uuid> means use the guest's UUID.
2455 =head2 Plugin C<load>
2457 The I<Load plugin> collects the system load. These numbers give a rough overview
2458 over the utilization of a machine. The system load is defined as the number of
2459 runnable tasks in the run-queue and is provided by many operating systems as a
2460 one, five or fifteen minute average.
2462 The following configuration options are available:
2466 =item B<ReportRelative> B<false>|B<true>
2468 When enabled, system load divided by number of available CPU cores is reported
2469 for intervals 1 min, 5 min and 15 min. Defaults to false.
2474 =head2 Plugin C<logfile>
2478 =item B<LogLevel> B<debug|info|notice|warning|err>
2480 Sets the log-level. If, for example, set to B<notice>, then all events with
2481 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2483 Please note that B<debug> is only available if collectd has been compiled with
2486 =item B<File> I<File>
2488 Sets the file to write log messages to. The special strings B<stdout> and
2489 B<stderr> can be used to write to the standard output and standard error
2490 channels, respectively. This, of course, only makes much sense when I<collectd>
2491 is running in foreground- or non-daemon-mode.
2493 =item B<Timestamp> B<true>|B<false>
2495 Prefix all lines printed by the current time. Defaults to B<true>.
2497 =item B<PrintSeverity> B<true>|B<false>
2499 When enabled, all lines are prefixed by the severity of the log message, for
2500 example "warning". Defaults to B<false>.
2504 B<Note>: There is no need to notify the daemon after moving or removing the
2505 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2506 for each line it writes.
2508 =head2 Plugin C<log_logstash>
2510 The I<log logstash plugin> behaves like the logfile plugin but formats
2511 messages as JSON events for logstash to parse and input.
2515 =item B<LogLevel> B<debug|info|notice|warning|err>
2517 Sets the log-level. If, for example, set to B<notice>, then all events with
2518 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
2520 Please note that B<debug> is only available if collectd has been compiled with
2523 =item B<File> I<File>
2525 Sets the file to write log messages to. The special strings B<stdout> and
2526 B<stderr> can be used to write to the standard output and standard error
2527 channels, respectively. This, of course, only makes much sense when I<collectd>
2528 is running in foreground- or non-daemon-mode.
2532 B<Note>: There is no need to notify the daemon after moving or removing the
2533 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
2534 for each line it writes.
2536 =head2 Plugin C<lpar>
2538 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
2539 virtualization technique for IBM POWER processors. It takes into account CPU
2540 time stolen from or donated to a partition, in addition to the usual user,
2541 system, I/O statistics.
2543 The following configuration options are available:
2547 =item B<CpuPoolStats> B<false>|B<true>
2549 When enabled, statistics about the processor pool are read, too. The partition
2550 needs to have pool authority in order to be able to acquire this information.
2553 =item B<ReportBySerial> B<false>|B<true>
2555 If enabled, the serial of the physical machine the partition is currently
2556 running on is reported as I<hostname> and the logical hostname of the machine
2557 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
2558 used (just like other plugins) and the I<plugin instance> will be empty.
2563 =head2 Plugin C<mbmon>
2565 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
2567 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
2568 B<Host> and B<Port> options can be used to change these values, see below.
2569 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
2570 timeouts may appear which may interfere with other statistics..
2572 C<mbmon> must be run with the -r option ("print TAG and Value format");
2573 Debian's F</etc/init.d/mbmon> script already does this, other people
2574 will need to ensure that this is the case.
2578 =item B<Host> I<Hostname>
2580 Hostname to connect to. Defaults to B<127.0.0.1>.
2582 =item B<Port> I<Port>
2584 TCP-Port to connect to. Defaults to B<411>.
2590 The C<md plugin> collects information from Linux Software-RAID devices (md).
2592 All reported values are of the type C<md_disks>. Reported type instances are
2593 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
2594 I<missing> (physically absent) disks.
2598 =item B<Device> I<Device>
2600 Select md devices based on device name. The I<device name> is the basename of
2601 the device, i.e. the name of the block device without the leading C</dev/>.
2602 See B<IgnoreSelected> for more details.
2604 =item B<IgnoreSelected> B<true>|B<false>
2606 Invert device selection: If set to B<true>, all md devices B<except> those
2607 listed using B<Device> are collected. If B<false> (the default), only those
2608 listed are collected. If no configuration is given, the B<md> plugin will
2609 collect data from all md devices.
2613 =head2 Plugin C<memcachec>
2615 The C<memcachec plugin> connects to a memcached server, queries one or more
2616 given I<pages> and parses the returned data according to user specification.
2617 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
2620 In order to talk to the memcached server, this plugin uses the I<libmemcached>
2621 library. Please note that there is another library with a very similar name,
2622 libmemcache (notice the missing `d'), which is not applicable.
2624 Synopsis of the configuration:
2626 <Plugin "memcachec">
2627 <Page "plugin_instance">
2631 Regex "(\\d+) bytes sent"
2634 Instance "type_instance"
2639 The configuration options are:
2643 =item E<lt>B<Page> I<Name>E<gt>
2645 Each B<Page> block defines one I<page> to be queried from the memcached server.
2646 The block requires one string argument which is used as I<plugin instance>.
2648 =item B<Server> I<Address>
2650 Sets the server address to connect to when querying the page. Must be inside a
2655 When connected to the memcached server, asks for the page I<Key>.
2657 =item E<lt>B<Match>E<gt>
2659 Match blocks define which strings to look for and how matches substrings are
2660 interpreted. For a description of match blocks, please see L<"Plugin tail">.
2664 =head2 Plugin C<memcached>
2666 The B<memcached plugin> connects to a memcached server and queries statistics
2667 about cache utilization, memory and bandwidth used.
2668 L<http://www.danga.com/memcached/>
2670 <Plugin "memcached">
2672 Host "memcache.example.com"
2677 The plugin configuration consists of one or more B<Instance> blocks which
2678 specify one I<memcached> connection each. Within the B<Instance> blocks, the
2679 following options are allowed:
2683 =item B<Host> I<Hostname>
2685 Hostname to connect to. Defaults to B<127.0.0.1>.
2687 =item B<Port> I<Port>
2689 TCP-Port to connect to. Defaults to B<11211>.
2691 =item B<Socket> I<Path>
2693 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
2694 setting is given, the B<Host> and B<Port> settings are ignored.
2698 =head2 Plugin C<mic>
2700 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
2701 Intel's Many Integrated Core (MIC) systems.
2710 ShowTemperatures true
2713 IgnoreSelectedTemperature true
2718 IgnoreSelectedPower true
2721 The following options are valid inside the B<PluginE<nbsp>mic> block:
2725 =item B<ShowCPU> B<true>|B<false>
2727 If enabled (the default) a sum of the CPU usage across all cores is reported.
2729 =item B<ShowCPUCores> B<true>|B<false>
2731 If enabled (the default) per-core CPU usage is reported.
2733 =item B<ShowMemory> B<true>|B<false>
2735 If enabled (the default) the physical memory usage of the MIC system is
2738 =item B<ShowTemperatures> B<true>|B<false>
2740 If enabled (the default) various temperatures of the MIC system are reported.
2742 =item B<Temperature> I<Name>
2744 This option controls which temperatures are being reported. Whether matching
2745 temperatures are being ignored or I<only> matching temperatures are reported
2746 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
2747 temperatures are reported.
2749 =item B<IgnoreSelectedTemperature> B<false>|B<true>
2751 Controls the behavior of the B<Temperature> setting above. If set to B<false>
2752 (the default) only temperatures matching a B<Temperature> option are reported
2753 or, if no B<Temperature> option is specified, all temperatures are reported. If
2754 set to B<true>, matching temperatures are I<ignored> and all other temperatures
2757 Known temperature names are:
2791 =item B<ShowPower> B<true>|B<false>
2793 If enabled (the default) various temperatures of the MIC system are reported.
2795 =item B<Power> I<Name>
2797 This option controls which power readings are being reported. Whether matching
2798 power readings are being ignored or I<only> matching power readings are reported
2799 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
2800 power readings are reported.
2802 =item B<IgnoreSelectedPower> B<false>|B<true>
2804 Controls the behavior of the B<Power> setting above. If set to B<false>
2805 (the default) only power readings matching a B<Power> option are reported
2806 or, if no B<Power> option is specified, all power readings are reported. If
2807 set to B<true>, matching power readings are I<ignored> and all other power readings
2810 Known power names are:
2816 Total power utilization averaged over Time Window 0 (uWatts).
2820 Total power utilization averaged over Time Window 0 (uWatts).
2824 Instantaneous power (uWatts).
2828 Max instantaneous power (uWatts).
2832 PCI-E connector power (uWatts).
2836 2x3 connector power (uWatts).
2840 2x4 connector power (uWatts).
2848 Uncore rail (uVolts).
2852 Memory subsystem rail (uVolts).
2858 =head2 Plugin C<memory>
2860 The I<memory plugin> provides the following configuration options:
2864 =item B<ValuesAbsolute> B<true>|B<false>
2866 Enables or disables reporting of physical memory usage in absolute numbers,
2867 i.e. bytes. Defaults to B<true>.
2869 =item B<ValuesPercentage> B<false>|B<true>
2871 Enables or disables reporting of physical memory usage in percentages, e.g.
2872 percent of physical memory used. Defaults to B<false>.
2874 This is useful for deploying I<collectd> in a heterogeneous environment in
2875 which the sizes of physical memory vary.
2879 =head2 Plugin C<modbus>
2881 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP and reads
2882 register values. It supports reading single registers (unsigned 16E<nbsp>bit
2883 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
2884 values (two registers interpreted as IEEE floats in big endian notation).
2888 <Data "voltage-input-1">
2895 <Data "voltage-input-2">
2902 <Host "modbus.example.com">
2903 Address "192.168.0.42"
2908 Instance "power-supply"
2909 Collect "voltage-input-1"
2910 Collect "voltage-input-2"
2916 =item E<lt>B<Data> I<Name>E<gt> blocks
2918 Data blocks define a mapping between register numbers and the "types" used by
2921 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
2925 =item B<RegisterBase> I<Number>
2927 Configures the base register to read from the device. If the option
2928 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
2929 register will be read (the register number is increased by one).
2931 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
2933 Specifies what kind of data is returned by the device. If the type is B<Int32>,
2934 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
2935 combined into one value. Defaults to B<Uint16>.
2937 =item B<Type> I<Type>
2939 Specifies the "type" (data set) to use when dispatching the value to
2940 I<collectd>. Currently, only data sets with exactly one data source are
2943 =item B<Instance> I<Instance>
2945 Sets the type instance to use when dispatching the value to I<collectd>. If
2946 unset, an empty string (no type instance) is used.
2950 =item E<lt>B<Host> I<Name>E<gt> blocks
2952 Host blocks are used to specify to which hosts to connect and what data to read
2953 from their "slaves". The string argument I<Name> is used as hostname when
2954 dispatching the values to I<collectd>.
2956 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
2960 =item B<Address> I<Hostname>
2962 Specifies the node name (the actual network address) used to connect to the
2963 host. This may be an IP address or a hostname. Please note that the used
2964 I<libmodbus> library only supports IPv4 at the moment.
2966 =item B<Port> I<Service>
2968 Specifies the port used to connect to the host. The port can either be given as
2969 a number or as a service name. Please note that the I<Service> argument must be
2970 a string, even if ports are given in their numerical form. Defaults to "502".
2972 =item B<Interval> I<Interval>
2974 Sets the interval (in seconds) in which the values will be collected from this
2975 host. By default the global B<Interval> setting will be used.
2977 =item E<lt>B<Slave> I<ID>E<gt>
2979 Over each TCP connection, multiple Modbus devices may be reached. The slave ID
2980 is used to specify which device should be addressed. For each device you want
2981 to query, one B<Slave> block must be given.
2983 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
2987 =item B<Instance> I<Instance>
2989 Specify the plugin instance to use when dispatching the values to I<collectd>.
2990 By default "slave_I<ID>" is used.
2992 =item B<Collect> I<DataName>
2994 Specifies which data to retrieve from the device. I<DataName> must be the same
2995 string as the I<Name> argument passed to a B<Data> block. You can specify this
2996 option multiple times to collect more than one value from a slave. At least one
2997 B<Collect> option is mandatory.
3005 =head2 Plugin C<mysql>
3007 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
3008 one or more databases when started and keeps the connection up as long as
3009 possible. When the connection is interrupted for whatever reason it will try
3010 to re-connect. The plugin will complain loudly in case anything goes wrong.
3012 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
3013 and collects information about MySQL network traffic, executed statements,
3014 requests, the query cache and threads by evaluating the
3015 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
3016 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
3017 Status Variables> for an explanation of these values.
3019 Optionally, master and slave statistics may be collected in a MySQL
3020 replication setup. In that case, information about the synchronization state
3021 of the nodes are collected by evaluating the C<Position> return value of the
3022 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
3023 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
3024 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
3025 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
3026 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
3043 Socket "/var/run/mysql/mysqld.sock"
3045 SlaveNotifications true
3049 A B<Database> block defines one connection to a MySQL database. It accepts a
3050 single argument which specifies the name of the database. None of the other
3051 options are required. MySQL will use default values as documented in the
3052 section "mysql_real_connect()" in the B<MySQL reference manual>.
3056 =item B<Alias> I<Alias>
3058 Alias to use as sender instead of hostname when reporting. This may be useful
3059 when having cryptic hostnames.
3061 =item B<Host> I<Hostname>
3063 Hostname of the database server. Defaults to B<localhost>.
3065 =item B<User> I<Username>
3067 Username to use when connecting to the database. The user does not have to be
3068 granted any privileges (which is synonym to granting the C<USAGE> privilege),
3069 unless you want to collectd replication statistics (see B<MasterStats> and
3070 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
3071 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
3073 =item B<Password> I<Password>
3075 Password needed to log into the database.
3077 =item B<Database> I<Database>
3079 Select this database. Defaults to I<no database> which is a perfectly reasonable
3080 option for what this plugin does.
3082 =item B<Port> I<Port>
3084 TCP-port to connect to. The port must be specified in its numeric form, but it
3085 must be passed as a string nonetheless. For example:
3089 If B<Host> is set to B<localhost> (the default), this setting has no effect.
3090 See the documentation for the C<mysql_real_connect> function for details.
3092 =item B<Socket> I<Socket>
3094 Specifies the path to the UNIX domain socket of the MySQL server. This option
3095 only has any effect, if B<Host> is set to B<localhost> (the default).
3096 Otherwise, use the B<Port> option above. See the documentation for the
3097 C<mysql_real_connect> function for details.
3099 =item B<InnodbStats> I<true|false>
3101 If enabled, metrics about the InnoDB storage engine are collected.
3102 Disabled by default.
3104 =item B<MasterStats> I<true|false>
3106 =item B<SlaveStats> I<true|false>
3108 Enable the collection of master / slave statistics in a replication setup. In
3109 order to be able to get access to these statistics, the user needs special
3110 privileges. See the B<User> documentation above.
3112 =item B<SlaveNotifications> I<true|false>
3114 If enabled, the plugin sends a notification if the replication slave I/O and /
3115 or SQL threads are not running.
3117 =item B<ConnectTimeout> I<Seconds>
3119 Sets the connect timeout for the MySQL client.
3123 =head2 Plugin C<netapp>
3125 The netapp plugin can collect various performance and capacity information
3126 from a NetApp filer using the NetApp API.
3128 Please note that NetApp has a wide line of products and a lot of different
3129 software versions for each of these products. This plugin was developed for a
3130 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
3131 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
3132 model and software version but it is very hard to test this.
3133 If you have used this plugin with other models and/or software version, feel
3134 free to send us a mail to tell us about the results, even if it's just a short
3137 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
3138 basic authentication.
3140 B<Do not use a regular user for this!> Create a special collectd user with just
3141 the minimum of capabilities needed. The user only needs the "login-http-admin"
3142 capability as well as a few more depending on which data will be collected.
3143 Required capabilities are documented below.
3148 <Host "netapp1.example.com">
3172 IgnoreSelectedIO false
3174 IgnoreSelectedOps false
3175 GetLatency "volume0"
3176 IgnoreSelectedLatency false
3183 IgnoreSelectedCapacity false
3186 IgnoreSelectedSnapshot false
3214 The netapp plugin accepts the following configuration options:
3218 =item B<Host> I<Name>
3220 A host block defines one NetApp filer. It will appear in collectd with the name
3221 you specify here which does not have to be its real name nor its hostname (see
3222 the B<Address> option below).
3224 =item B<VFiler> I<Name>
3226 A B<VFiler> block may only be used inside a host block. It accepts all the
3227 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
3228 will execute all NetApp API commands in the context of the specified
3229 VFiler(R). It will appear in collectd with the name you specify here which
3230 does not have to be its real name. The VFiler name may be specified using the
3231 B<VFilerName> option. If this is not specified, it will default to the name
3234 The VFiler block inherits all connection related settings from the surrounding
3235 B<Host> block (which appear before the B<VFiler> block) but they may be
3236 overwritten inside the B<VFiler> block.
3238 This feature is useful, for example, when using a VFiler as SnapVault target
3239 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
3240 available in the host filer (vfiler0) but only in the respective VFiler
3243 =item B<Protocol> B<httpd>|B<http>
3245 The protocol collectd will use to query this host.
3253 Valid options: http, https
3255 =item B<Address> I<Address>
3257 The hostname or IP address of the host.
3263 Default: The "host" block's name.
3265 =item B<Port> I<Port>
3267 The TCP port to connect to on the host.
3273 Default: 80 for protocol "http", 443 for protocol "https"
3275 =item B<User> I<User>
3277 =item B<Password> I<Password>
3279 The username and password to use to login to the NetApp.
3285 =item B<VFilerName> I<Name>
3287 The name of the VFiler in which context to execute API commands. If not
3288 specified, the name provided to the B<VFiler> block will be used instead.
3294 Default: name of the B<VFiler> block
3296 B<Note:> This option may only be used inside B<VFiler> blocks.
3298 =item B<Interval> I<Interval>
3304 The following options decide what kind of data will be collected. You can
3305 either use them as a block and fine tune various parameters inside this block,
3306 use them as a single statement to just accept all default values, or omit it to
3307 not collect any data.
3309 The following options are valid inside all blocks:
3313 =item B<Interval> I<Seconds>
3315 Collect the respective statistics every I<Seconds> seconds. Defaults to the
3316 host specific setting.
3320 =head3 The System block
3322 This will collect various performance data about the whole system.
3324 B<Note:> To get this data the collectd user needs the
3325 "api-perf-object-get-instances" capability.
3329 =item B<Interval> I<Seconds>
3331 Collect disk statistics every I<Seconds> seconds.
3333 =item B<GetCPULoad> B<true>|B<false>
3335 If you set this option to true the current CPU usage will be read. This will be
3336 the average usage between all CPUs in your NetApp without any information about
3339 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3340 returns in the "CPU" field.
3348 Result: Two value lists of type "cpu", and type instances "idle" and "system".
3350 =item B<GetInterfaces> B<true>|B<false>
3352 If you set this option to true the current traffic of the network interfaces
3353 will be read. This will be the total traffic over all interfaces of your NetApp
3354 without any information about individual interfaces.
3356 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3357 in the "Net kB/s" field.
3367 Result: One value list of type "if_octects".
3369 =item B<GetDiskIO> B<true>|B<false>
3371 If you set this option to true the current IO throughput will be read. This
3372 will be the total IO of your NetApp without any information about individual
3373 disks, volumes or aggregates.
3375 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3376 in the "DiskE<nbsp>kB/s" field.
3384 Result: One value list of type "disk_octets".
3386 =item B<GetDiskOps> B<true>|B<false>
3388 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
3389 iSCSI, etc. operations will be read. This will be the total number of
3390 operations on your NetApp without any information about individual volumes or
3393 B<Note:> These are the same values that the NetApp CLI command "sysstat"
3394 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
3402 Result: A variable number of value lists of type "disk_ops_complex". Each type
3403 of operation will result in one value list with the name of the operation as
3408 =head3 The WAFL block
3410 This will collect various performance data about the WAFL file system. At the
3411 moment this just means cache performance.
3413 B<Note:> To get this data the collectd user needs the
3414 "api-perf-object-get-instances" capability.
3416 B<Note:> The interface to get these values is classified as "Diagnostics" by
3417 NetApp. This means that it is not guaranteed to be stable even between minor
3422 =item B<Interval> I<Seconds>
3424 Collect disk statistics every I<Seconds> seconds.
3426 =item B<GetNameCache> B<true>|B<false>
3434 Result: One value list of type "cache_ratio" and type instance
3437 =item B<GetDirCache> B<true>|B<false>
3445 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
3447 =item B<GetInodeCache> B<true>|B<false>
3455 Result: One value list of type "cache_ratio" and type instance
3458 =item B<GetBufferCache> B<true>|B<false>
3460 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
3461 in the "Cache hit" field.
3469 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
3473 =head3 The Disks block
3475 This will collect performance data about the individual disks in the NetApp.
3477 B<Note:> To get this data the collectd user needs the
3478 "api-perf-object-get-instances" capability.
3482 =item B<Interval> I<Seconds>
3484 Collect disk statistics every I<Seconds> seconds.
3486 =item B<GetBusy> B<true>|B<false>
3488 If you set this option to true the busy time of all disks will be calculated
3489 and the value of the busiest disk in the system will be written.
3491 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
3492 in the "Disk util" field. Probably.
3500 Result: One value list of type "percent" and type instance "disk_busy".
3504 =head3 The VolumePerf block
3506 This will collect various performance data about the individual volumes.
3508 You can select which data to collect about which volume using the following
3509 options. They follow the standard ignorelist semantic.
3511 B<Note:> To get this data the collectd user needs the
3512 I<api-perf-object-get-instances> capability.
3516 =item B<Interval> I<Seconds>
3518 Collect volume performance data every I<Seconds> seconds.
3520 =item B<GetIO> I<Volume>
3522 =item B<GetOps> I<Volume>
3524 =item B<GetLatency> I<Volume>
3526 Select the given volume for IO, operations or latency statistics collection.
3527 The argument is the name of the volume without the C</vol/> prefix.
3529 Since the standard ignorelist functionality is used here, you can use a string
3530 starting and ending with a slash to specify regular expression matching: To
3531 match the volumes "vol0", "vol2" and "vol7", you can use this regular
3534 GetIO "/^vol[027]$/"
3536 If no regular expression is specified, an exact match is required. Both,
3537 regular and exact matching are case sensitive.
3539 If no volume was specified at all for either of the three options, that data
3540 will be collected for all available volumes.
3542 =item B<IgnoreSelectedIO> B<true>|B<false>
3544 =item B<IgnoreSelectedOps> B<true>|B<false>
3546 =item B<IgnoreSelectedLatency> B<true>|B<false>
3548 When set to B<true>, the volumes selected for IO, operations or latency
3549 statistics collection will be ignored and the data will be collected for all
3552 When set to B<false>, data will only be collected for the specified volumes and
3553 all other volumes will be ignored.
3555 If no volumes have been specified with the above B<Get*> options, all volumes
3556 will be collected regardless of the B<IgnoreSelected*> option.
3558 Defaults to B<false>
3562 =head3 The VolumeUsage block
3564 This will collect capacity data about the individual volumes.
3566 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
3571 =item B<Interval> I<Seconds>
3573 Collect volume usage statistics every I<Seconds> seconds.
3575 =item B<GetCapacity> I<VolumeName>
3577 The current capacity of the volume will be collected. This will result in two
3578 to four value lists, depending on the configuration of the volume. All data
3579 sources are of type "df_complex" with the name of the volume as
3582 There will be type_instances "used" and "free" for the number of used and
3583 available bytes on the volume. If the volume has some space reserved for
3584 snapshots, a type_instance "snap_reserved" will be available. If the volume
3585 has SIS enabled, a type_instance "sis_saved" will be available. This is the
3586 number of bytes saved by the SIS feature.
3588 B<Note:> The current NetApp API has a bug that results in this value being
3589 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
3590 number which works most of the time. If you see strange values here, bug
3591 NetApp support to fix this.
3593 Repeat this option to specify multiple volumes.
3595 =item B<IgnoreSelectedCapacity> B<true>|B<false>
3597 Specify whether to collect only the volumes selected by the B<GetCapacity>
3598 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
3599 B<false>. However, if no B<GetCapacity> option is specified at all, all
3600 capacities will be selected anyway.
3602 =item B<GetSnapshot> I<VolumeName>
3604 Select volumes from which to collect snapshot information.
3606 Usually, the space used for snapshots is included in the space reported as
3607 "used". If snapshot information is collected as well, the space used for
3608 snapshots is subtracted from the used space.
3610 To make things even more interesting, it is possible to reserve space to be
3611 used for snapshots. If the space required for snapshots is less than that
3612 reserved space, there is "reserved free" and "reserved used" space in addition
3613 to "free" and "used". If the space required for snapshots exceeds the reserved
3614 space, that part allocated in the normal space is subtracted from the "used"
3617 Repeat this option to specify multiple volumes.
3619 =item B<IgnoreSelectedSnapshot>
3621 Specify whether to collect only the volumes selected by the B<GetSnapshot>
3622 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
3623 B<false>. However, if no B<GetSnapshot> option is specified at all, all
3624 capacities will be selected anyway.
3628 =head3 The Quota block
3630 This will collect (tree) quota statistics (used disk space and number of used
3631 files). This mechanism is useful to get usage information for single qtrees.
3632 In case the quotas are not used for any other purpose, an entry similar to the
3633 following in C</etc/quotas> would be sufficient:
3635 /vol/volA/some_qtree tree - - - - -
3637 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
3641 =item B<Interval> I<Seconds>
3643 Collect SnapVault(R) statistics every I<Seconds> seconds.
3647 =head3 The SnapVault block
3649 This will collect statistics about the time and traffic of SnapVault(R)
3654 =item B<Interval> I<Seconds>
3656 Collect SnapVault(R) statistics every I<Seconds> seconds.
3660 =head2 Plugin C<netlink>
3662 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
3663 statistics of various interface and routing aspects.
3667 =item B<Interface> I<Interface>
3669 =item B<VerboseInterface> I<Interface>
3671 Instruct the plugin to collect interface statistics. This is basically the same
3672 as the statistics provided by the C<interface> plugin (see above) but
3673 potentially much more detailed.
3675 When configuring with B<Interface> only the basic statistics will be collected,
3676 namely octets, packets, and errors. These statistics are collected by
3677 the C<interface> plugin, too, so using both at the same time is no benefit.
3679 When configured with B<VerboseInterface> all counters B<except> the basic ones,
3680 so that no data needs to be collected twice if you use the C<interface> plugin.
3681 This includes dropped packets, received multicast packets, collisions and a
3682 whole zoo of differentiated RX and TX errors. You can try the following command
3683 to get an idea of what awaits you:
3687 If I<Interface> is B<All>, all interfaces will be selected.
3689 =item B<QDisc> I<Interface> [I<QDisc>]
3691 =item B<Class> I<Interface> [I<Class>]
3693 =item B<Filter> I<Interface> [I<Filter>]
3695 Collect the octets and packets that pass a certain qdisc, class or filter.
3697 QDiscs and classes are identified by their type and handle (or classid).
3698 Filters don't necessarily have a handle, therefore the parent's handle is used.
3699 The notation used in collectd differs from that used in tc(1) in that it
3700 doesn't skip the major or minor number if it's zero and doesn't print special
3701 ids by their name. So, for example, a qdisc may be identified by
3702 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
3703 thus not displayed by tc(1).
3705 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
3706 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
3707 associated with that interface will be collected.
3709 Since a filter itself doesn't necessarily have a handle, the parent's handle is
3710 used. This may lead to problems when more than one filter is attached to a
3711 qdisc or class. This isn't nice, but we don't know how this could be done any
3712 better. If you have a idea, please don't hesitate to tell us.
3714 As with the B<Interface> option you can specify B<All> as the interface,
3715 meaning all interfaces.
3717 Here are some examples to help you understand the above text more easily:
3720 VerboseInterface "All"
3721 QDisc "eth0" "pfifo_fast-1:0"
3723 Class "ppp0" "htb-1:10"
3724 Filter "ppp0" "u32-1:0"
3727 =item B<IgnoreSelected>
3729 The behavior is the same as with all other similar plugins: If nothing is
3730 selected at all, everything is collected. If some things are selected using the
3731 options described above, only these statistics are collected. If you set
3732 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
3733 specified statistics will not be collected.
3737 =head2 Plugin C<network>
3739 The Network plugin sends data to a remote instance of collectd, receives data
3740 from a remote instance, or both at the same time. Data which has been received
3741 from the network is usually not transmitted again, but this can be activated, see
3742 the B<Forward> option below.
3744 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
3745 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
3747 Both, B<Server> and B<Listen> can be used as single option or as block. When
3748 used as block, given options are valid for this socket only. The following
3749 example will export the metrics twice: Once to an "internal" server (without
3750 encryption and signing) and one to an external server (with cryptographic
3754 # Export to an internal server
3755 # (demonstrates usage without additional options)
3756 Server "collectd.internal.tld"
3758 # Export to an external server
3759 # (demonstrates usage with signature options)
3760 <Server "collectd.external.tld">
3761 SecurityLevel "sign"
3762 Username "myhostname"
3769 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
3771 The B<Server> statement/block sets the server to send datagrams to. The
3772 statement may occur multiple times to send each datagram to multiple
3775 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
3776 optional second argument specifies a port number or a service name. If not
3777 given, the default, B<25826>, is used.
3779 The following options are recognized within B<Server> blocks:
3783 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3785 Set the security you require for network communication. When the security level
3786 has been set to B<Encrypt>, data sent over the network will be encrypted using
3787 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
3788 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
3789 authentication code. When set to B<None>, data is sent without any security.
3791 This feature is only available if the I<network> plugin was linked with
3794 =item B<Username> I<Username>
3796 Sets the username to transmit. This is used by the server to lookup the
3797 password. See B<AuthFile> below. All security levels except B<None> require
3800 This feature is only available if the I<network> plugin was linked with
3803 =item B<Password> I<Password>
3805 Sets a password (shared secret) for this socket. All security levels except
3806 B<None> require this setting.
3808 This feature is only available if the I<network> plugin was linked with
3811 =item B<Interface> I<Interface name>
3813 Set the outgoing interface for IP packets. This applies at least
3814 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3815 undefined or a non-existent interface name is specified, the default
3816 behavior is to let the kernel choose the appropriate interface. Be warned
3817 that the manual selection of an interface for unicast traffic is only
3818 necessary in rare cases.
3822 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
3824 The B<Listen> statement sets the interfaces to bind to. When multiple
3825 statements are found the daemon will bind to multiple interfaces.
3827 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
3828 the argument is a multicast address the daemon will join that multicast group.
3829 The optional second argument specifies a port number or a service name. If not
3830 given, the default, B<25826>, is used.
3832 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
3836 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
3838 Set the security you require for network communication. When the security level
3839 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
3840 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
3841 signed and encrypted data is accepted. When set to B<None>, all data will be
3842 accepted. If an B<AuthFile> option was given (see below), encrypted data is
3843 decrypted if possible.
3845 This feature is only available if the I<network> plugin was linked with
3848 =item B<AuthFile> I<Filename>
3850 Sets a file in which usernames are mapped to passwords. These passwords are
3851 used to verify signatures and to decrypt encrypted network packets. If
3852 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
3853 verified and encrypted packets are decrypted. Otherwise, signed data is
3854 accepted without checking the signature and encrypted data cannot be decrypted.
3855 For the other security levels this option is mandatory.
3857 The file format is very simple: Each line consists of a username followed by a
3858 colon and any number of spaces followed by the password. To demonstrate, an
3859 example file could look like this:
3864 Each time a packet is received, the modification time of the file is checked
3865 using L<stat(2)>. If the file has been changed, the contents is re-read. While
3866 the file is being read, it is locked using L<fcntl(2)>.
3868 =item B<Interface> I<Interface name>
3870 Set the incoming interface for IP packets explicitly. This applies at least
3871 to IPv6 packets and if possible to IPv4. If this option is not applicable,
3872 undefined or a non-existent interface name is specified, the default
3873 behavior is, to let the kernel choose the appropriate interface. Thus incoming
3874 traffic gets only accepted, if it arrives on the given interface.
3878 =item B<TimeToLive> I<1-255>
3880 Set the time-to-live of sent packets. This applies to all, unicast and
3881 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
3882 That means that multicast packets will be sent with a TTL of C<1> (one) on most
3885 =item B<MaxPacketSize> I<1024-65535>
3887 Set the maximum size for datagrams received over the network. Packets larger
3888 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
3889 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
3892 On the server side, this limit should be set to the largest value used on
3893 I<any> client. Likewise, the value on the client must not be larger than the
3894 value on the server, or data will be lost.
3896 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
3897 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
3898 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
3901 =item B<Forward> I<true|false>
3903 If set to I<true>, write packets that were received via the network plugin to
3904 the sending sockets. This should only be activated when the B<Listen>- and
3905 B<Server>-statements differ. Otherwise packets may be send multiple times to
3906 the same multicast group. While this results in more network traffic than
3907 necessary it's not a huge problem since the plugin has a duplicate detection,
3908 so the values will not loop.
3910 =item B<ReportStats> B<true>|B<false>
3912 The network plugin cannot only receive and send statistics, it can also create
3913 statistics about itself. Collected data included the number of received and
3914 sent octets and packets, the length of the receive queue and the number of
3915 values handled. When set to B<true>, the I<Network plugin> will make these
3916 statistics available. Defaults to B<false>.
3920 =head2 Plugin C<nginx>
3922 This plugin collects the number of connections and requests handled by the
3923 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
3924 queries the page provided by the C<ngx_http_stub_status_module> module, which
3925 isn't compiled by default. Please refer to
3926 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
3927 how to compile and configure nginx and this module.
3929 The following options are accepted by the C<nginx plugin>:
3933 =item B<URL> I<http://host/nginx_status>
3935 Sets the URL of the C<ngx_http_stub_status_module> output.
3937 =item B<User> I<Username>
3939 Optional user name needed for authentication.
3941 =item B<Password> I<Password>
3943 Optional password needed for authentication.
3945 =item B<VerifyPeer> B<true|false>
3947 Enable or disable peer SSL certificate verification. See
3948 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
3950 =item B<VerifyHost> B<true|false>
3952 Enable or disable peer host name verification. If enabled, the plugin checks
3953 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
3954 certificate matches the host name provided by the B<URL> option. If this
3955 identity check fails, the connection is aborted. Obviously, only works when
3956 connecting to a SSL enabled server. Enabled by default.
3958 =item B<CACert> I<File>
3960 File that holds one or more SSL certificates. If you want to use HTTPS you will
3961 possibly need this option. What CA certificates come bundled with C<libcurl>
3962 and are checked by default depends on the distribution you use.
3966 =head2 Plugin C<notify_desktop>
3968 This plugin sends a desktop notification to a notification daemon, as defined
3969 in the Desktop Notification Specification. To actually display the
3970 notifications, B<notification-daemon> is required and B<collectd> has to be
3971 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
3972 environment variables have to be set correctly) and the D-Bus message bus.
3974 The Desktop Notification Specification can be found at
3975 L<http://www.galago-project.org/specs/notification/>.
3979 =item B<OkayTimeout> I<timeout>
3981 =item B<WarningTimeout> I<timeout>
3983 =item B<FailureTimeout> I<timeout>
3985 Set the I<timeout>, in milliseconds, after which to expire the notification
3986 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
3987 been specified, the displayed notification will not be closed at all - the
3988 user has to do so herself. These options default to 5000. If a negative number
3989 has been specified, the default is used as well.
3993 =head2 Plugin C<notify_email>
3995 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
3996 configured email address.
3998 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
4000 Available configuration options:
4004 =item B<From> I<Address>
4006 Email address from which the emails should appear to come from.
4008 Default: C<root@localhost>
4010 =item B<Recipient> I<Address>
4012 Configures the email address(es) to which the notifications should be mailed.
4013 May be repeated to send notifications to multiple addresses.
4015 At least one B<Recipient> must be present for the plugin to work correctly.
4017 =item B<SMTPServer> I<Hostname>
4019 Hostname of the SMTP server to connect to.
4021 Default: C<localhost>
4023 =item B<SMTPPort> I<Port>
4025 TCP port to connect to.
4029 =item B<SMTPUser> I<Username>
4031 Username for ASMTP authentication. Optional.
4033 =item B<SMTPPassword> I<Password>
4035 Password for ASMTP authentication. Optional.
4037 =item B<Subject> I<Subject>
4039 Subject-template to use when sending emails. There must be exactly two
4040 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
4041 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
4044 Default: C<Collectd notify: %s@%s>
4048 =head2 Plugin C<ntpd>
4052 =item B<Host> I<Hostname>
4054 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
4056 =item B<Port> I<Port>
4058 UDP-Port to connect to. Defaults to B<123>.
4060 =item B<ReverseLookups> B<true>|B<false>
4062 Sets whether or not to perform reverse lookups on peers. Since the name or
4063 IP-address may be used in a filename it is recommended to disable reverse
4064 lookups. The default is to do reverse lookups to preserve backwards
4065 compatibility, though.
4067 =item B<IncludeUnitID> B<true>|B<false>
4069 When a peer is a refclock, include the unit ID in the I<type instance>.
4070 Defaults to B<false> for backward compatibility.
4072 If two refclock peers use the same driver and this is B<false>, the plugin will
4073 try to write simultaneous measurements from both to the same type instance.
4074 This will result in error messages in the log and only one set of measurements
4079 =head2 Plugin C<nut>
4083 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
4085 Add a UPS to collect data from. The format is identical to the one accepted by
4090 =head2 Plugin C<olsrd>
4092 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
4093 the Optimized Link State Routing daemon and reads information about the current
4094 state of the meshed network.
4096 The following configuration options are understood:
4100 =item B<Host> I<Host>
4102 Connect to I<Host>. Defaults to B<"localhost">.
4104 =item B<Port> I<Port>
4106 Specifies the port to connect to. This must be a string, even if you give the
4107 port as a number rather than a service name. Defaults to B<"2006">.
4109 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
4111 Specifies what information to collect about links, i.E<nbsp>e. direct
4112 connections of the daemon queried. If set to B<No>, no information is
4113 collected. If set to B<Summary>, the number of links and the average of all
4114 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
4115 If set to B<Detail> LQ and NLQ are collected per link.
4117 Defaults to B<Detail>.
4119 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
4121 Specifies what information to collect about routes of the daemon queried. If
4122 set to B<No>, no information is collected. If set to B<Summary>, the number of
4123 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
4124 metric and ETX are collected per route.
4126 Defaults to B<Summary>.
4128 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
4130 Specifies what information to collect about the global topology. If set to
4131 B<No>, no information is collected. If set to B<Summary>, the number of links
4132 in the entire topology and the average I<link quality> (LQ) is calculated.
4133 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
4135 Defaults to B<Summary>.
4139 =head2 Plugin C<onewire>
4141 B<EXPERIMENTAL!> See notes below.
4143 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
4144 L<http://owfs.org/> to read sensors connected via the onewire bus.
4146 It can be used in two possible modes - standard or advanced.
4148 In the standard mode only temperature sensors (sensors with the family code
4149 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
4150 other sensors you would like to have included, please send a sort request to
4151 the mailing list. You can select sensors to be read or to be ignored depending
4152 on the option B<IgnoreSelected>). When no list is provided the whole bus is
4153 walked and all sensors are read.
4155 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
4156 experimental, below.
4158 In the advanced mode you can configure any sensor to be read (only numerical
4159 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
4160 In this mode you have to list all the sensors. Neither default bus walk nor
4161 B<IgnoreSelected> are used here. Address and type (file) is extracted from
4162 the path automatically and should produce compatible structure with the "standard"
4163 mode (basically the path is expected as for example
4164 "/uncached/10.F10FCA000800/temperature" where it would extract address part
4165 "F10FCA000800" and the rest after the slash is considered the type - here
4167 There are two advantages to this mode - you can access virtually any sensor
4168 (not just temperature), select whether to use cached or directly read values
4169 and it is slighlty faster. The downside is more complex configuration.
4171 The two modes are distinguished automatically by the format of the address.
4172 It is not possible to mix the two modes. Once a full path is detected in any
4173 B<Sensor> then the whole addressing (all sensors) is considered to be this way
4174 (and as standard addresses will fail parsing they will be ignored).
4178 =item B<Device> I<Device>
4180 Sets the device to read the values from. This can either be a "real" hardware
4181 device, such as a serial port or an USB port, or the address of the
4182 L<owserver(1)> socket, usually B<localhost:4304>.
4184 Though the documentation claims to automatically recognize the given address
4185 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
4186 with that version, the following configuration worked for us:
4189 Device "-s localhost:4304"
4192 This directive is B<required> and does not have a default value.
4194 =item B<Sensor> I<Sensor>
4196 In the standard mode selects sensors to collect or to ignore
4197 (depending on B<IgnoreSelected>, see below). Sensors are specified without
4198 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
4199 and B<not> include the leading C<10.> family byte and point.
4200 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
4201 sensors (see above) are read.
4203 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
4204 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
4205 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
4207 As there can be multiple devices on the bus you can list multiple sensor (use
4208 multiple B<Sensor> elements).
4210 =item B<IgnoreSelected> I<true>|I<false>
4212 If no configuration is given, the B<onewire> plugin will collect data from all
4213 sensors found. This may not be practical, especially if sensors are added and
4214 removed regularly. Sometimes, however, it's easier/preferred to collect only
4215 specific sensors or all sensors I<except> a few specified ones. This option
4216 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
4217 B<Sensor> is inverted: All selected interfaces are ignored and all other
4218 interfaces are collected.
4220 Used only in the standard mode - see above.
4222 =item B<Interval> I<Seconds>
4224 Sets the interval in which all sensors should be read. If not specified, the
4225 global B<Interval> setting is used.
4229 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
4230 work with big setups. It works with one sensor being attached to one
4231 controller, but as soon as you throw in a couple more senors and maybe a hub
4232 or two, reading all values will take more than ten seconds (the default
4233 interval). We will probably add some separate thread for reading the sensors
4234 and some cache or something like that, but it's not done yet. We will try to
4235 maintain backwards compatibility in the future, but we can't promise. So in
4236 short: If it works for you: Great! But keep in mind that the config I<might>
4237 change, though this is unlikely. Oh, and if you want to help improving this
4238 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
4240 =head2 Plugin C<openvpn>
4242 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
4243 traffic statistics about connected clients.
4245 To set up OpenVPN to write to the status file periodically, use the
4246 B<--status> option of OpenVPN. Since OpenVPN can write two different formats,
4247 you need to set the required format, too. This is done by setting
4248 B<--status-version> to B<2>.
4250 So, in a nutshell you need:
4252 openvpn $OTHER_OPTIONS \
4253 --status "/var/run/openvpn-status" 10 \
4260 =item B<StatusFile> I<File>
4262 Specifies the location of the status file.
4264 =item B<ImprovedNamingSchema> B<true>|B<false>
4266 When enabled, the filename of the status file will be used as plugin instance
4267 and the client's "common name" will be used as type instance. This is required
4268 when reading multiple status files. Enabling this option is recommended, but to
4269 maintain backwards compatibility this option is disabled by default.
4271 =item B<CollectCompression> B<true>|B<false>
4273 Sets whether or not statistics about the compression used by OpenVPN should be
4274 collected. This information is only available in I<single> mode. Enabled by
4277 =item B<CollectIndividualUsers> B<true>|B<false>
4279 Sets whether or not traffic information is collected for each connected client
4280 individually. If set to false, currently no traffic data is collected at all
4281 because aggregating this data in a save manner is tricky. Defaults to B<true>.
4283 =item B<CollectUserCount> B<true>|B<false>
4285 When enabled, the number of currently connected clients or users is collected.
4286 This is especially interesting when B<CollectIndividualUsers> is disabled, but
4287 can be configured independently from that option. Defaults to B<false>.
4291 =head2 Plugin C<oracle>
4293 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
4294 Oracle® Database and lets you execute SQL statements there. It is very similar
4295 to the "dbi" plugin, because it was written around the same time. See the "dbi"
4296 plugin's documentation above for details.
4299 <Query "out_of_stock">
4300 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
4303 # InstancePrefix "foo"
4304 InstancesFrom "category"
4308 <Database "product_information">
4312 Query "out_of_stock"
4316 =head3 B<Query> blocks
4318 The Query blocks are handled identically to the Query blocks of the "dbi"
4319 plugin. Please see its documentation above for details on how to specify
4322 =head3 B<Database> blocks
4324 Database blocks define a connection to a database and which queries should be
4325 sent to that database. Each database needs a "name" as string argument in the
4326 starting tag of the block. This name will be used as "PluginInstance" in the
4327 values submitted to the daemon. Other than that, that name is not used.
4331 =item B<ConnectID> I<ID>
4333 Defines the "database alias" or "service name" to connect to. Usually, these
4334 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
4336 =item B<Host> I<Host>
4338 Hostname to use when dispatching values for this database. Defaults to using
4339 the global hostname of the I<collectd> instance.
4341 =item B<Username> I<Username>
4343 Username used for authentication.
4345 =item B<Password> I<Password>
4347 Password used for authentication.
4349 =item B<Query> I<QueryName>
4351 Associates the query named I<QueryName> with this database connection. The
4352 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
4353 blocks you want to refer to must be placed above the database block you want to
4358 =head2 Plugin C<perl>
4360 This plugin embeds a Perl-interpreter into collectd and provides an interface
4361 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
4363 =head2 Plugin C<pinba>
4365 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
4366 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
4367 PHP-based webpage has been delivered, the extension will send a UDP packet
4368 containing timing information, peak memory usage and so on. The plugin will
4369 wait for such packets, parse them and account the provided information, which
4370 is then dispatched to the daemon once per interval.
4377 # Overall statistics for the website.
4379 Server "www.example.com"
4381 # Statistics for www-a only
4383 Host "www-a.example.com"
4384 Server "www.example.com"
4386 # Statistics for www-b only
4388 Host "www-b.example.com"
4389 Server "www.example.com"
4393 The plugin provides the following configuration options:
4397 =item B<Address> I<Node>
4399 Configures the address used to open a listening socket. By default, plugin will
4400 bind to the I<any> address C<::0>.
4402 =item B<Port> I<Service>
4404 Configures the port (service) to bind to. By default the default Pinba port
4405 "30002" will be used. The option accepts service names in addition to port
4406 numbers and thus requires a I<string> argument.
4408 =item E<lt>B<View> I<Name>E<gt> block
4410 The packets sent by the Pinba extension include the hostname of the server, the
4411 server name (the name of the virtual host) and the script that was executed.
4412 Using B<View> blocks it is possible to separate the data into multiple groups
4413 to get more meaningful statistics. Each packet is added to all matching groups,
4414 so that a packet may be accounted for more than once.
4418 =item B<Host> I<Host>
4420 Matches the hostname of the system the webserver / script is running on. This
4421 will contain the result of the L<gethostname(2)> system call. If not
4422 configured, all hostnames will be accepted.
4424 =item B<Server> I<Server>
4426 Matches the name of the I<virtual host>, i.e. the contents of the
4427 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
4428 server names will be accepted.
4430 =item B<Script> I<Script>
4432 Matches the name of the I<script name>, i.e. the contents of the
4433 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
4434 script names will be accepted.
4440 =head2 Plugin C<ping>
4442 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
4443 configured hosts periodically and measures the network latency. Whenever the
4444 C<read> function of the plugin is called, it submits the average latency, the
4445 standard deviation and the drop rate for each host.
4447 Available configuration options:
4451 =item B<Host> I<IP-address>
4453 Host to ping periodically. This option may be repeated several times to ping
4456 =item B<Interval> I<Seconds>
4458 Sets the interval in which to send ICMP echo packets to the configured hosts.
4459 This is B<not> the interval in which statistics are queries from the plugin but
4460 the interval in which the hosts are "pinged". Therefore, the setting here
4461 should be smaller than or equal to the global B<Interval> setting. Fractional
4462 times, such as "1.24" are allowed.
4466 =item B<Timeout> I<Seconds>
4468 Time to wait for a response from the host to which an ICMP packet had been
4469 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
4470 to be down or the packet to be dropped. This setting must be smaller than the
4471 B<Interval> setting above for the plugin to work correctly. Fractional
4472 arguments are accepted.
4476 =item B<TTL> I<0-255>
4478 Sets the Time-To-Live of generated ICMP packets.
4480 =item B<SourceAddress> I<host>
4482 Sets the source address to use. I<host> may either be a numerical network
4483 address or a network hostname.
4485 =item B<Device> I<name>
4487 Sets the outgoing network device to be used. I<name> has to specify an
4488 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
4491 =item B<MaxMissed> I<Packets>
4493 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
4494 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
4496 Default: B<-1> (disabled)
4500 =head2 Plugin C<postgresql>
4502 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
4503 keeps a persistent connection to all configured databases and tries to
4504 reconnect if the connection has been interrupted. A database is configured by
4505 specifying a B<Database> block as described below. The default statistics are
4506 collected from PostgreSQL's B<statistics collector> which thus has to be
4507 enabled for this plugin to work correctly. This should usually be the case by
4508 default. See the section "The Statistics Collector" of the B<PostgreSQL
4509 Documentation> for details.
4511 By specifying custom database queries using a B<Query> block as described
4512 below, you may collect any data that is available from some PostgreSQL
4513 database. This way, you are able to access statistics of external daemons
4514 which are available in a PostgreSQL database or use future or special
4515 statistics provided by PostgreSQL without the need to upgrade your collectd
4518 Starting with version 5.2, the C<postgresql> plugin supports writing data to
4519 PostgreSQL databases as well. This has been implemented in a generic way. You
4520 need to specify an SQL statement which will then be executed by collectd in
4521 order to write the data (see below for details). The benefit of that approach
4522 is that there is no fixed database layout. Rather, the layout may be optimized
4523 for the current setup.
4525 The B<PostgreSQL Documentation> manual can be found at
4526 L<http://www.postgresql.org/docs/manuals/>.
4530 Statement "SELECT magic FROM wizard WHERE host = $1;"
4534 InstancePrefix "magic"
4539 <Query rt36_tickets>
4540 Statement "SELECT COUNT(type) AS count, type \
4542 WHEN resolved = 'epoch' THEN 'open' \
4543 ELSE 'resolved' END AS type \
4544 FROM tickets) type \
4548 InstancePrefix "rt36_tickets"
4549 InstancesFrom "type"
4555 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
4565 KRBSrvName "kerberos_service_name"
4571 Service "service_name"
4572 Query backend # predefined
4583 The B<Query> block defines one database query which may later be used by a
4584 database definition. It accepts a single mandatory argument which specifies
4585 the name of the query. The names of all queries have to be unique (see the
4586 B<MinVersion> and B<MaxVersion> options below for an exception to this
4587 rule). The following configuration options are available to define the query:
4589 In each B<Query> block, there is one or more B<Result> blocks. B<Result>
4590 blocks define how to handle the values returned from the query. They define
4591 which column holds which value and how to dispatch that value to the daemon.
4592 Multiple B<Result> blocks may be used to extract multiple values from a single
4597 =item B<Statement> I<sql query statement>
4599 Specify the I<sql query statement> which the plugin should execute. The string
4600 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
4601 first, second, etc. parameter. The value of the parameters is specified by the
4602 B<Param> configuration option - see below for details. To include a literal
4603 B<$> character followed by a number, surround it with single quotes (B<'>).
4605 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
4606 allowed. Note, however, that only a single command may be used. Semicolons are
4607 allowed as long as a single non-empty command has been specified only.
4609 The returned lines will be handled separately one after another.
4611 =item B<Param> I<hostname>|I<database>|I<username>|I<interval>
4613 Specify the parameters which should be passed to the SQL query. The parameters
4614 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
4615 they appear in the configuration file. The value of the parameter is
4616 determined depending on the value of the B<Param> option as follows:
4622 The configured hostname of the database connection. If a UNIX domain socket is
4623 used, the parameter expands to "localhost".
4627 The name of the database of the current connection.
4631 The name of the database plugin instance. See the B<Instance> option of the
4632 database specification below for details.
4636 The username used to connect to the database.
4640 The interval with which this database is queried (as specified by the database
4641 specific or global B<Interval> options).
4645 Please note that parameters are only supported by PostgreSQL's protocol
4646 version 3 and above which was introduced in version 7.4 of PostgreSQL.
4648 =item B<Type> I<type>
4650 The I<type> name to be used when dispatching the values. The type describes
4651 how to handle the data and where to store it. See L<types.db(5)> for more
4652 details on types and their configuration. The number and type of values (as
4653 selected by the B<ValuesFrom> option) has to match the type of the given name.
4655 This option is required inside a B<Result> block.
4657 =item B<InstancePrefix> I<prefix>
4659 =item B<InstancesFrom> I<column0> [I<column1> ...]
4661 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
4662 B<InstancePrefix> defines a static prefix that will be prepended to all type
4663 instances. B<InstancesFrom> defines the column names whose values will be used
4664 to create the type instance. Multiple values will be joined together using the
4665 hyphen (C<->) as separation character.
4667 The plugin itself does not check whether or not all built instances are
4668 different. It is your responsibility to assure that each is unique.
4670 Both options are optional. If none is specified, the type instance will be
4673 =item B<ValuesFrom> I<column0> [I<column1> ...]
4675 Names the columns whose content is used as the actual data for the data sets
4676 that are dispatched to the daemon. How many such columns you need is
4677 determined by the B<Type> setting as explained above. If you specify too many
4678 or not enough columns, the plugin will complain about that and no data will be
4679 submitted to the daemon.
4681 The actual data type, as seen by PostgreSQL, is not that important as long as
4682 it represents numbers. The plugin will automatically cast the values to the
4683 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
4684 L<strtod(3)> functions, so anything supported by those functions is supported
4685 by the plugin as well.
4687 This option is required inside a B<Result> block and may be specified multiple
4688 times. If multiple B<ValuesFrom> options are specified, the columns are read
4691 =item B<MinVersion> I<version>
4693 =item B<MaxVersion> I<version>
4695 Specify the minimum or maximum version of PostgreSQL that this query should be
4696 used with. Some statistics might only be available with certain versions of
4697 PostgreSQL. This allows you to specify multiple queries with the same name but
4698 which apply to different versions, thus allowing you to use the same
4699 configuration in a heterogeneous environment.
4701 The I<version> has to be specified as the concatenation of the major, minor
4702 and patch-level versions, each represented as two-decimal-digit numbers. For
4703 example, version 8.2.3 will become 80203.
4707 The following predefined queries are available (the definitions can be found
4708 in the F<postgresql_default.conf> file which, by default, is available at
4709 C<I<prefix>/share/collectd/>):
4715 This query collects the number of backends, i.E<nbsp>e. the number of
4718 =item B<transactions>
4720 This query collects the numbers of committed and rolled-back transactions of
4725 This query collects the numbers of various table modifications (i.E<nbsp>e.
4726 insertions, updates, deletions) of the user tables.
4728 =item B<query_plans>
4730 This query collects the numbers of various table scans and returned tuples of
4733 =item B<table_states>
4735 This query collects the numbers of live and dead rows in the user tables.
4739 This query collects disk block access counts for user tables.
4743 This query collects the on-disk size of the database in bytes.
4747 In addition, the following detailed queries are available by default. Please
4748 note that each of those queries collects information B<by table>, thus,
4749 potentially producing B<a lot> of data. For details see the description of the
4750 non-by_table queries above.
4754 =item B<queries_by_table>
4756 =item B<query_plans_by_table>
4758 =item B<table_states_by_table>
4760 =item B<disk_io_by_table>
4764 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
4765 mandatory argument specifying the name of the writer. This will then be used
4766 in the B<Database> specification in order to activate the writer instance. The
4767 names of all writers have to be unique. The following options may be
4772 =item B<Statement> I<sql statement>
4774 This mandatory option specifies the SQL statement that will be executed for
4775 each submitted value. A single SQL statement is allowed only. Anything after
4776 the first semicolon will be ignored.
4778 Nine parameters will be passed to the statement and should be specified as
4779 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
4780 values are made available through those parameters:
4786 The timestamp of the queried value as a floating point number.
4790 The hostname of the queried value.
4794 The plugin name of the queried value.
4798 The plugin instance of the queried value. This value may be B<NULL> if there
4799 is no plugin instance.
4803 The type of the queried value (cf. L<types.db(5)>).
4807 The type instance of the queried value. This value may be B<NULL> if there is
4812 An array of names for the submitted values (i.E<nbsp>e., the name of the data
4813 sources of the submitted value-list).
4817 An array of types for the submitted values (i.E<nbsp>e., the type of the data
4818 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
4819 B<StoreRates> is enabled (which is the default, see below), all types will be
4824 An array of the submitted values. The dimensions of the value name and value
4829 In general, it is advisable to create and call a custom function in the
4830 PostgreSQL database for this purpose. Any procedural language supported by
4831 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
4834 =item B<StoreRates> B<false>|B<true>
4836 If set to B<true> (the default), convert counter values to rates. If set to
4837 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
4842 The B<Database> block defines one PostgreSQL database for which to collect
4843 statistics. It accepts a single mandatory argument which specifies the
4844 database name. None of the other options are required. PostgreSQL will use
4845 default values as documented in the section "CONNECTING TO A DATABASE" in the
4846 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
4847 the user collectd is run as and special environment variables. See the manpage
4852 =item B<Interval> I<seconds>
4854 Specify the interval with which the database should be queried. The default is
4855 to use the global B<Interval> setting.
4857 =item B<CommitInterval> I<seconds>
4859 This option may be used for database connections which have "writers" assigned
4860 (see above). If specified, it causes a writer to put several updates into a
4861 single transaction. This transaction will last for the specified amount of
4862 time. By default, each update will be executed in a separate transaction. Each
4863 transaction generates a fair amount of overhead which can, thus, be reduced by
4864 activating this option. The draw-back is, that data covering the specified
4865 amount of time will be lost, for example, if a single statement within the
4866 transaction fails or if the database server crashes.
4868 =item B<Host> I<hostname>
4870 Specify the hostname or IP of the PostgreSQL server to connect to. If the
4871 value begins with a slash, it is interpreted as the directory name in which to
4872 look for the UNIX domain socket.
4874 This option is also used to determine the hostname that is associated with a
4875 collected data set. If it has been omitted or either begins with with a slash
4876 or equals B<localhost> it will be replaced with the global hostname definition
4877 of collectd. Any other value will be passed literally to collectd when
4878 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
4880 =item B<Port> I<port>
4882 Specify the TCP port or the local UNIX domain socket file extension of the
4885 =item B<User> I<username>
4887 Specify the username to be used when connecting to the server.
4889 =item B<Password> I<password>
4891 Specify the password to be used when connecting to the server.
4893 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
4895 Specify whether to use an SSL connection when contacting the server. The
4896 following modes are supported:
4902 Do not use SSL at all.
4906 First, try to connect without using SSL. If that fails, try using SSL.
4908 =item I<prefer> (default)
4910 First, try to connect using SSL. If that fails, try without using SSL.
4918 =item B<Instance> I<name>
4920 Specify the plugin instance name that should be used instead of the database
4921 name (which is the default, if this option has not been specified). This
4922 allows to query multiple databases of the same name on the same host (e.g.
4923 when running multiple database server versions in parallel).
4925 =item B<KRBSrvName> I<kerberos_service_name>
4927 Specify the Kerberos service name to use when authenticating with Kerberos 5
4928 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
4929 B<PostgreSQL Documentation> for details.
4931 =item B<Service> I<service_name>
4933 Specify the PostgreSQL service name to use for additional parameters. That
4934 service has to be defined in F<pg_service.conf> and holds additional
4935 connection parameters. See the section "The Connection Service File" in the
4936 B<PostgreSQL Documentation> for details.
4938 =item B<Query> I<query>
4940 Specifies a I<query> which should be executed in the context of the database
4941 connection. This may be any of the predefined or user-defined queries. If no
4942 such option is given, it defaults to "backends", "transactions", "queries",
4943 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
4944 has been specified). Else, the specified queries are used only.
4946 =item B<Writer> I<writer>
4948 Assigns the specified I<writer> backend to the database connection. This
4949 causes all collected data to be send to the database using the settings
4950 defined in the writer configuration (see the section "FILTER CONFIGURATION"
4951 below for details on how to selectively send data to certain plugins).
4953 Each writer will register a flush callback which may be used when having long
4954 transactions enabled (see the B<CommitInterval> option above). When issuing
4955 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
4956 transaction will be committed right away. Two different kinds of flush
4957 callbacks are available with the C<postgresql> plugin:
4963 Flush all writer backends.
4965 =item B<postgresql->I<database>
4967 Flush all writers of the specified I<database> only.
4973 =head2 Plugin C<powerdns>
4975 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
4976 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
4977 values, many of which are probably meaningless to most users, but may be useful
4978 for some. So you may chose which values to collect, but if you don't, some
4979 reasonable defaults will be collected.
4982 <Server "server_name">
4984 Collect "udp-answers" "udp-queries"
4985 Socket "/var/run/pdns.controlsocket"
4987 <Recursor "recursor_name">
4989 Collect "cache-hits" "cache-misses"
4990 Socket "/var/run/pdns_recursor.controlsocket"
4992 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
4997 =item B<Server> and B<Recursor> block
4999 The B<Server> block defines one authoritative server to query, the B<Recursor>
5000 does the same for an recursing server. The possible options in both blocks are
5001 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
5006 =item B<Collect> I<Field>
5008 Using the B<Collect> statement you can select which values to collect. Here,
5009 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
5010 C<dlg-only-drops>, C<answers10-100>.
5012 The method of getting the values differs for B<Server> and B<Recursor> blocks:
5013 When querying the server a C<SHOW *> command is issued in any case, because
5014 that's the only way of getting multiple values out of the server at once.
5015 collectd then picks out the values you have selected. When querying the
5016 recursor, a command is generated to query exactly these values. So if you
5017 specify invalid fields when querying the recursor, a syntax error may be
5018 returned by the daemon and collectd may not collect any values at all.
5020 If no B<Collect> statement is given, the following B<Server> values will be
5027 =item packetcache-hit
5029 =item packetcache-miss
5031 =item packetcache-size
5033 =item query-cache-hit
5035 =item query-cache-miss
5037 =item recursing-answers
5039 =item recursing-questions
5051 The following B<Recursor> values will be collected by default:
5055 =item noerror-answers
5057 =item nxdomain-answers
5059 =item servfail-answers
5077 Please note that up to that point collectd doesn't know what values are
5078 available on the server and values that are added do not need a change of the
5079 mechanism so far. However, the values must be mapped to collectd's naming
5080 scheme, which is done using a lookup table that lists all known values. If
5081 values are added in the future and collectd does not know about them, you will
5082 get an error much like this:
5084 powerdns plugin: submit: Not found in lookup table: foobar = 42
5086 In this case please file a bug report with the collectd team.
5088 =item B<Socket> I<Path>
5090 Configures the path to the UNIX domain socket to be used when connecting to the
5091 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
5092 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
5093 will be used for the recursor.
5097 =item B<LocalSocket> I<Path>
5099 Querying the recursor is done using UDP. When using UDP over UNIX domain
5100 sockets, the client socket needs a name in the file system, too. You can set
5101 this local name to I<Path> using the B<LocalSocket> option. The default is
5102 C<I<prefix>/var/run/collectd-powerdns>.
5106 =head2 Plugin C<processes>
5110 =item B<Process> I<Name>
5112 Select more detailed statistics of processes matching this name. The statistics
5113 collected for these selected processes are size of the resident segment size
5114 (RSS), user- and system-time used, number of processes and number of threads,
5115 io data (where available) and minor and major pagefaults.
5117 =item B<ProcessMatch> I<name> I<regex>
5119 Similar to the B<Process> option this allows to select more detailed
5120 statistics of processes matching the specified I<regex> (see L<regex(7)> for
5121 details). The statistics of all matching processes are summed up and
5122 dispatched to the daemon using the specified I<name> as an identifier. This
5123 allows to "group" several processes together. I<name> must not contain
5128 =head2 Plugin C<protocols>
5130 Collects a lot of information about various network protocols, such as I<IP>,
5131 I<TCP>, I<UDP>, etc.
5133 Available configuration options:
5137 =item B<Value> I<Selector>
5139 Selects whether or not to select a specific value. The string being matched is
5140 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
5141 plugin instance and I<ValueName> will be used as type instance. An example of
5142 the string being used would be C<Tcp:RetransSegs>.
5144 You can use regular expressions to match a large number of values with just one
5145 configuration option. To select all "extended" I<TCP> values, you could use the
5146 following statement:
5150 Whether only matched values are selected or all matched values are ignored
5151 depends on the B<IgnoreSelected>. By default, only matched values are selected.
5152 If no value is configured at all, all values will be selected.
5154 =item B<IgnoreSelected> B<true>|B<false>
5156 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
5157 matching values will be ignored.
5161 =head2 Plugin C<python>
5163 This plugin embeds a Python-interpreter into collectd and provides an interface
5164 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
5166 =head2 Plugin C<routeros>
5168 The C<routeros> plugin connects to a device running I<RouterOS>, the
5169 Linux-based operating system for routers by I<MikroTik>. The plugin uses
5170 I<librouteros> to connect and reads information about the interfaces and
5171 wireless connections of the device. The configuration supports querying
5176 Host "router0.example.com"
5179 CollectInterface true
5184 Host "router1.example.com"
5187 CollectInterface true
5188 CollectRegistrationTable true
5194 As you can see above, the configuration of the I<routeros> plugin consists of
5195 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
5196 options are understood:
5200 =item B<Host> I<Host>
5202 Hostname or IP-address of the router to connect to.
5204 =item B<Port> I<Port>
5206 Port name or port number used when connecting. If left unspecified, the default
5207 will be chosen by I<librouteros>, currently "8728". This option expects a
5208 string argument, even when a numeric port number is given.
5210 =item B<User> I<User>
5212 Use the user name I<User> to authenticate. Defaults to "admin".
5214 =item B<Password> I<Password>
5216 Set the password used to authenticate.
5218 =item B<CollectInterface> B<true>|B<false>
5220 When set to B<true>, interface statistics will be collected for all interfaces
5221 present on the device. Defaults to B<false>.
5223 =item B<CollectRegistrationTable> B<true>|B<false>
5225 When set to B<true>, information about wireless LAN connections will be
5226 collected. Defaults to B<false>.
5228 =item B<CollectCPULoad> B<true>|B<false>
5230 When set to B<true>, information about the CPU usage will be collected. The
5231 number is a dimensionless value where zero indicates no CPU usage at all.
5232 Defaults to B<false>.
5234 =item B<CollectMemory> B<true>|B<false>
5236 When enabled, the amount of used and free memory will be collected. How used
5237 memory is calculated is unknown, for example whether or not caches are counted
5239 Defaults to B<false>.
5241 =item B<CollectDF> B<true>|B<false>
5243 When enabled, the amount of used and free disk space will be collected.
5244 Defaults to B<false>.
5246 =item B<CollectDisk> B<true>|B<false>
5248 When enabled, the number of sectors written and bad blocks will be collected.
5249 Defaults to B<false>.
5253 =head2 Plugin C<redis>
5255 The I<Redis plugin> connects to one or more Redis servers and gathers
5256 information about each server's state. For each server there is a I<Node> block
5257 which configures the connection parameters for this node.
5267 The information shown in the synopsis above is the I<default configuration>
5268 which is used by the plugin if no configuration is present.
5272 =item B<Node> I<Nodename>
5274 The B<Node> block identifies a new Redis node, that is a new Redis instance
5275 running in an specified host and port. The name for node is a canonical
5276 identifier which is used as I<plugin instance>. It is limited to
5277 64E<nbsp>characters in length.
5279 =item B<Host> I<Hostname>
5281 The B<Host> option is the hostname or IP-address where the Redis instance is
5284 =item B<Port> I<Port>
5286 The B<Port> option is the TCP port on which the Redis instance accepts
5287 connections. Either a service name of a port number may be given. Please note
5288 that numerical port numbers must be given as a string, too.
5290 =item B<Password> I<Password>
5292 Use I<Password> to authenticate when connecting to I<Redis>.
5294 =item B<Timeout> I<Timeout in miliseconds>
5296 The B<Timeout> option set the socket timeout for node response. Since the Redis
5297 read function is blocking, you should keep this value as low as possible. Keep
5298 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
5299 than B<Interval> defined globally.
5303 =head2 Plugin C<rrdcached>
5305 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
5306 to store values to RRD files in an efficient manner. The combination of the
5307 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
5308 way the C<rrdtool> plugin works (see below). The added abstraction layer
5309 provides a number of benefits, though: Because the cache is not within
5310 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
5311 restarted. This results in much shorter (if any) gaps in graphs, especially
5312 under heavy load. Also, the C<rrdtool> command line utility is aware of the
5313 daemon so that it can flush values to disk automatically when needed. This
5314 allows to integrate automated flushing of values into graphing solutions much
5317 There are disadvantages, though: The daemon may reside on a different host, so
5318 it may not be possible for C<collectd> to create the appropriate RRD files
5319 anymore. And even if C<rrdcached> runs on the same host, it may run in a
5320 different base directory, so relative paths may do weird stuff if you're not
5323 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
5324 on the same host, communicating via a UNIX domain socket. The B<DataDir>
5325 setting should be set to an absolute path, so that a changed base directory
5326 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
5330 =item B<DaemonAddress> I<Address>
5332 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
5333 library. See L<rrdcached(1)> for details. Example:
5335 <Plugin "rrdcached">
5336 DaemonAddress "unix:/var/run/rrdcached.sock"
5339 =item B<DataDir> I<Directory>
5341 Set the base directory in which the RRD files reside. If this is a relative
5342 path, it is relative to the working base directory of the C<rrdcached> daemon!
5343 Use of an absolute path is recommended.
5345 =item B<CreateFiles> B<true>|B<false>
5347 Enables or disables the creation of RRD files. If the daemon is not running
5348 locally, or B<DataDir> is set to a relative path, this will not work as
5349 expected. Default is B<true>.
5351 =item B<CreateFilesAsync> B<false>|B<true>
5353 When enabled, new RRD files are enabled asynchronously, using a separate thread
5354 that runs in the background. This prevents writes to block, which is a problem
5355 especially when many hundreds of files need to be created at once. However,
5356 since the purpose of creating the files asynchronously is I<not> to block until
5357 the file is available, values before the file is available will be discarded.
5358 When disabled (the default) files are created synchronously, blocking for a
5359 short while, while the file is being written.
5361 =item B<StepSize> I<Seconds>
5363 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5364 this setting is unset and the stepsize is set to the interval in which the data
5365 is collected. Do not use this option unless you absolutely have to for some
5366 reason. Setting this option may cause problems with the C<snmp plugin>, the
5367 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5369 =item B<HeartBeat> I<Seconds>
5371 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5372 in which case the heartbeat is set to twice the B<StepSize> which should equal
5373 the interval in which data is collected. Do not set this option unless you have
5374 a very good reason to do so.
5376 =item B<RRARows> I<NumRows>
5378 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5379 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5380 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5381 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5382 week, one month, and one year.
5384 So for each timespan, it calculates how many PDPs need to be consolidated into
5385 one CDP by calculating:
5386 number of PDPs = timespan / (stepsize * rrarows)
5388 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5391 =item B<RRATimespan> I<Seconds>
5393 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5394 more then one RRA. If this option is never used, the built-in default of (3600,
5395 86400, 604800, 2678400, 31622400) is used.
5397 For more information on how RRA-sizes are calculated see B<RRARows> above.
5399 =item B<XFF> I<Factor>
5401 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5402 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5407 =head2 Plugin C<rrdtool>
5409 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
5410 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
5411 using these settings. If you don't want to dive into the depths of RRDtool, you
5412 can safely ignore these settings.
5416 =item B<DataDir> I<Directory>
5418 Set the directory to store RRD files under. By default RRD files are generated
5419 beneath the daemon's working directory, i.e. the B<BaseDir>.
5421 =item B<CreateFilesAsync> B<false>|B<true>
5423 When enabled, new RRD files are enabled asynchronously, using a separate thread
5424 that runs in the background. This prevents writes to block, which is a problem
5425 especially when many hundreds of files need to be created at once. However,
5426 since the purpose of creating the files asynchronously is I<not> to block until
5427 the file is available, values before the file is available will be discarded.
5428 When disabled (the default) files are created synchronously, blocking for a
5429 short while, while the file is being written.
5431 =item B<StepSize> I<Seconds>
5433 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
5434 this setting is unset and the stepsize is set to the interval in which the data
5435 is collected. Do not use this option unless you absolutely have to for some
5436 reason. Setting this option may cause problems with the C<snmp plugin>, the
5437 C<exec plugin> or when the daemon is set up to receive data from other hosts.
5439 =item B<HeartBeat> I<Seconds>
5441 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
5442 in which case the heartbeat is set to twice the B<StepSize> which should equal
5443 the interval in which data is collected. Do not set this option unless you have
5444 a very good reason to do so.
5446 =item B<RRARows> I<NumRows>
5448 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
5449 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
5450 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
5451 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
5452 week, one month, and one year.
5454 So for each timespan, it calculates how many PDPs need to be consolidated into
5455 one CDP by calculating:
5456 number of PDPs = timespan / (stepsize * rrarows)
5458 Bottom line is, set this no smaller than the width of you graphs in pixels. The
5461 =item B<RRATimespan> I<Seconds>
5463 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
5464 more then one RRA. If this option is never used, the built-in default of (3600,
5465 86400, 604800, 2678400, 31622400) is used.
5467 For more information on how RRA-sizes are calculated see B<RRARows> above.
5469 =item B<XFF> I<Factor>
5471 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
5472 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
5475 =item B<CacheFlush> I<Seconds>
5477 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
5478 it writes all values for a certain RRD-file if the oldest value is older than
5479 (or equal to) the number of seconds specified. If some RRD-file is not updated
5480 anymore for some reason (the computer was shut down, the network is broken,
5481 etc.) some values may still be in the cache. If B<CacheFlush> is set, then the
5482 entire cache is searched for entries older than B<CacheTimeout> seconds and
5483 written to disk every I<Seconds> seconds. Since this is kind of expensive and
5484 does nothing under normal circumstances, this value should not be too small.
5485 900 seconds might be a good value, though setting this to 7200 seconds doesn't
5486 normally do much harm either.
5488 =item B<CacheTimeout> I<Seconds>
5490 If this option is set to a value greater than zero, the C<rrdtool plugin> will
5491 save values in a cache, as described above. Writing multiple values at once
5492 reduces IO-operations and thus lessens the load produced by updating the files.
5493 The trade off is that the graphs kind of "drag behind" and that more memory is
5496 =item B<WritesPerSecond> I<Updates>
5498 When collecting many statistics with collectd and the C<rrdtool> plugin, you
5499 will run serious performance problems. The B<CacheFlush> setting and the
5500 internal update queue assert that collectd continues to work just fine even
5501 under heavy load, but the system may become very unresponsive and slow. This is
5502 a problem especially if you create graphs from the RRD files on the same
5503 machine, for example using the C<graph.cgi> script included in the
5504 C<contrib/collection3/> directory.
5506 This setting is designed for very large setups. Setting this option to a value
5507 between 25 and 80 updates per second, depending on your hardware, will leave
5508 the server responsive enough to draw graphs even while all the cached values
5509 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
5510 by the B<FLUSH> command, are B<not> effected by this limit. They are still
5511 written as fast as possible, so that web frontends have up to date data when
5514 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
5515 updates per second, writing all values to disk will take approximately
5516 56E<nbsp>minutes. Together with the flushing ability that's integrated into
5517 "collection3" you'll end up with a responsive and fast system, up to date
5518 graphs and basically a "backup" of your values every hour.
5520 =item B<RandomTimeout> I<Seconds>
5522 When set, the actual timeout for each value is chosen randomly between
5523 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
5524 intention is to avoid high load situations that appear when many values timeout
5525 at the same time. This is especially a problem shortly after the daemon starts,
5526 because all values were added to the internal cache at roughly the same time.
5530 =head2 Plugin C<sensors>
5532 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
5533 that all the needed modules have to be loaded and lm_sensors has to be
5534 configured (most likely by editing F</etc/sensors.conf>. Read
5535 L<sensors.conf(5)> for details.
5537 The B<lm_sensors> homepage can be found at
5538 L<http://secure.netroedge.com/~lm78/>.
5542 =item B<SensorConfigFile> I<File>
5544 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
5545 the library's default will be used.
5547 =item B<Sensor> I<chip-bus-address/type-feature>
5549 Selects the name of the sensor which you want to collect or ignore, depending
5550 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
5551 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
5552 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
5554 =item B<IgnoreSelected> I<true>|I<false>
5556 If no configuration if given, the B<sensors>-plugin will collect data from all
5557 sensors. This may not be practical, especially for uninteresting sensors.
5558 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
5559 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
5560 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
5561 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
5562 and all other sensors are collected.
5566 =head2 Plugin C<sigrok>
5568 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
5569 supported by the L<sigrok|http://sigrok.org/> project.
5575 <Device "AC Voltage">
5580 <Device "Sound Level">
5581 Driver "cem-dt-885x"
5588 =item B<LogLevel> B<0-5>
5590 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
5591 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
5592 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
5593 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
5594 their level, are always submitted to I<collectd> at its INFO log level.
5596 =item E<lt>B<Device> I<Name>E<gt>
5598 A sigrok-supported device, uniquely identified by this section's options. The
5599 I<Name> is passed to I<collectd> as the I<plugin instance>.
5601 =item B<Driver> I<DriverName>
5603 The sigrok driver to use for this device.
5605 =item B<Conn> I<ConnectionSpec>
5607 If the device cannot be auto-discovered, or more than one might be discovered
5608 by the driver, I<ConnectionSpec> specifies the connection string to the device.
5609 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
5610 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
5611 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
5612 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
5614 =item B<SerialComm> I<SerialSpec>
5616 For serial devices with non-standard port settings, this option can be used
5617 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
5618 This should not be necessary; drivers know how to communicate with devices they
5621 =item B<MinimumInterval> I<Seconds>
5623 Specifies the minimum time between measurement dispatches to I<collectd>, in
5624 seconds. Since some I<sigrok> supported devices can acquire measurements many
5625 times per second, it may be necessary to throttle these. For example, the
5626 I<RRD plugin> cannot process writes more than once per second.
5628 The default B<MinimumInterval> is B<0>, meaning measurements received from the
5629 device are always dispatched to I<collectd>. When throttled, unused
5630 measurements are discarded.
5634 =head2 Plugin C<snmp>
5636 Since the configuration of the C<snmp plugin> is a little more complicated than
5637 other plugins, its documentation has been moved to an own manpage,
5638 L<collectd-snmp(5)>. Please see there for details.
5640 =head2 Plugin C<statsd>
5642 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
5643 protocol and dispatches rates or other aggregates of these numbers
5646 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
5647 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
5648 C<objects> respectively.
5650 The following configuration options are valid:
5654 =item B<Host> I<Host>
5656 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
5657 "any" address, i.e. accept packets sent to any of the hosts addresses.
5659 =item B<Port> I<Port>
5661 UDP port to listen to. This can be either a service name or a port number.
5662 Defaults to C<8125>.
5664 =item B<DeleteCounters> B<false>|B<true>
5666 =item B<DeleteTimers> B<false>|B<true>
5668 =item B<DeleteGauges> B<false>|B<true>
5670 =item B<DeleteSets> B<false>|B<true>
5672 These options control what happens if metrics are not updated in an interval.
5673 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
5674 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
5675 are unchanged. If set to B<True>, the such metrics are not dispatched and
5676 removed from the internal cache.
5678 =item B<TimerPercentile> I<Percent>
5680 Calculate and dispatch the configured percentile, i.e. compute the latency, so
5681 that I<Percent> of all reported timers are smaller than or equal to the
5682 computed latency. This is useful for cutting off the long tail latency, as it's
5683 often done in I<Service Level Agreements> (SLAs).
5685 If not specified, no percentile is calculated / dispatched.
5689 =head2 Plugin C<swap>
5691 The I<Swap plugin> collects information about used and available swap space. On
5692 I<Linux> and I<Solaris>, the following options are available:
5696 =item B<ReportByDevice> B<false>|B<true>
5698 Configures how to report physical swap devices. If set to B<false> (the
5699 default), the summary over all swap devices is reported only, i.e. the globally
5700 used and available space over all devices. If B<true> is configured, the used
5701 and available space of each device will be reported separately.
5703 This option is only available if the I<Swap plugin> can read C</proc/swaps>
5704 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
5706 =item B<ReportBytes> B<false>|B<true>
5708 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
5709 I<swap I/O> is reported in pages. This option is available under Linux only.
5711 =item B<ValuesAbsolute> B<true>|B<false>
5713 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
5714 available and used. Defaults to B<true>.
5716 =item B<ValuesPercentage> B<false>|B<true>
5718 Enables or disables reporting of relative swap metrics, i.e. I<percent>
5719 available and free. Defaults to B<false>.
5721 This is useful for deploying I<collectd> in a heterogeneous environment, where
5722 swap sizes differ and you want to specify generic thresholds or similar.
5726 =head2 Plugin C<syslog>
5730 =item B<LogLevel> B<debug|info|notice|warning|err>
5732 Sets the log-level. If, for example, set to B<notice>, then all events with
5733 severity B<notice>, B<warning>, or B<err> will be submitted to the
5736 Please note that B<debug> is only available if collectd has been compiled with
5739 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
5741 Controls which notifications should be sent to syslog. The default behaviour is
5742 not to send any. Less severe notifications always imply logging more severe
5743 notifications: Setting this to B<OKAY> means all notifications will be sent to
5744 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
5745 notifications but will dismiss B<OKAY> notifications. Setting this option to
5746 B<FAILURE> will only send failures to syslog.
5750 =head2 Plugin C<table>
5752 The C<table plugin> provides generic means to parse tabular data and dispatch
5753 user specified values. Values are selected based on column numbers. For
5754 example, this plugin may be used to get values from the Linux L<proc(5)>
5755 filesystem or CSV (comma separated values) files.
5758 <Table "/proc/slabinfo">
5763 InstancePrefix "active_objs"
5769 InstancePrefix "objperslab"
5776 The configuration consists of one or more B<Table> blocks, each of which
5777 configures one file to parse. Within each B<Table> block, there are one or
5778 more B<Result> blocks, which configure which data to select and how to
5781 The following options are available inside a B<Table> block:
5785 =item B<Instance> I<instance>
5787 If specified, I<instance> is used as the plugin instance. So, in the above
5788 example, the plugin name C<table-slabinfo> would be used. If omitted, the
5789 filename of the table is used instead, with all special characters replaced
5790 with an underscore (C<_>).
5792 =item B<Separator> I<string>
5794 Any character of I<string> is interpreted as a delimiter between the different
5795 columns of the table. A sequence of two or more contiguous delimiters in the
5796 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
5797 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
5798 of a table - see its documentation for more details. This option is mandatory.
5800 A horizontal tab, newline and carriage return may be specified by C<\\t>,
5801 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
5802 required because of collectd's config parsing.
5806 The following options are available inside a B<Result> block:
5810 =item B<Type> I<type>
5812 Sets the type used to dispatch the values to the daemon. Detailed information
5813 about types and their configuration can be found in L<types.db(5)>. This
5814 option is mandatory.
5816 =item B<InstancePrefix> I<prefix>
5818 If specified, prepend I<prefix> to the type instance. If omitted, only the
5819 B<InstancesFrom> option is considered for the type instance.
5821 =item B<InstancesFrom> I<column0> [I<column1> ...]
5823 If specified, the content of the given columns (identified by the column
5824 number starting at zero) will be used to create the type instance for each
5825 row. Multiple values (and the instance prefix) will be joined together with
5826 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
5827 option is considered for the type instance.
5829 The plugin itself does not check whether or not all built instances are
5830 different. It’s your responsibility to assure that each is unique. This is
5831 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
5832 sure that the table only contains one row.
5834 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
5837 =item B<ValuesFrom> I<column0> [I<column1> ...]
5839 Specifies the columns (identified by the column numbers starting at zero)
5840 whose content is used as the actual data for the data sets that are dispatched
5841 to the daemon. How many such columns you need is determined by the B<Type>
5842 setting above. If you specify too many or not enough columns, the plugin will
5843 complain about that and no data will be submitted to the daemon. The plugin
5844 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
5845 respectively, so anything supported by those functions is supported by the
5846 plugin as well. This option is mandatory.
5850 =head2 Plugin C<tail>
5852 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
5853 each line and dispatches found values. What is matched can be configured by the
5854 user using (extended) regular expressions, as described in L<regex(7)>.
5857 <File "/var/log/exim4/mainlog">
5861 Regex "S=([1-9][0-9]*)"
5867 Regex "\\<R=local_user\\>"
5868 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
5871 Instance "local_user"
5876 The config consists of one or more B<File> blocks, each of which configures one
5877 logfile to parse. Within each B<File> block, there are one or more B<Match>
5878 blocks, which configure a regular expression to search for.
5880 The B<Instance> option in the B<File> block may be used to set the plugin
5881 instance. So in the above example the plugin name C<tail-foo> would be used.
5882 This plugin instance is for all B<Match> blocks that B<follow> it, until the
5883 next B<Instance> option. This way you can extract several plugin instances from
5884 one logfile, handy when parsing syslog and the like.
5886 The B<Interval> option allows you to define the length of time between reads. If
5887 this is not set, the default Interval will be used.
5889 Each B<Match> block has the following options to describe how the match should
5894 =item B<Regex> I<regex>
5896 Sets the regular expression to use for matching against a line. The first
5897 subexpression has to match something that can be turned into a number by
5898 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
5899 below. Because B<extended> regular expressions are used, you do not need to use
5900 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
5901 collectd's config parsing you need to escape backslashes, though. So if you
5902 want to match literal parentheses you need to do the following:
5904 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
5906 =item B<ExcludeRegex> I<regex>
5908 Sets an optional regular expression to use for excluding lines from the match.
5909 An example which excludes all connections from localhost from the match:
5911 ExcludeRegex "127\\.0\\.0\\.1"
5913 =item B<DSType> I<Type>
5915 Sets how the values are cumulated. I<Type> is one of:
5919 =item B<GaugeAverage>
5921 Calculate the average.
5925 Use the smallest number only.
5929 Use the greatest number only.
5933 Use the last number found.
5939 =item B<AbsoluteSet>
5941 The matched number is a counter. Simply I<sets> the internal counter to this
5942 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
5948 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
5949 matched number may be negative, which will effectively subtract from the
5956 Increase the internal counter by one. These B<DSType> are the only ones that do
5957 not use the matched subexpression, but simply count the number of matched
5958 lines. Thus, you may use a regular expression without submatch in this case.
5962 As you'd expect the B<Gauge*> types interpret the submatch as a floating point
5963 number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types interpret
5964 the submatch as an unsigned integer using L<strtoull(3)>. The B<Derive*> types
5965 interpret the submatch as a signed integer using L<strtoll(3)>. B<CounterInc>
5966 and B<DeriveInc> do not use the submatch at all and it may be omitted in this
5969 =item B<Type> I<Type>
5971 Sets the type used to dispatch this value. Detailed information about types and
5972 their configuration can be found in L<types.db(5)>.
5974 =item B<Instance> I<TypeInstance>
5976 This optional setting sets the type instance to use.
5980 =head2 Plugin C<tail_csv>
5982 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
5983 written by I<Snort>.
5988 <Metric "snort-dropped">
5993 <File "/var/log/snort/snort.stats">
5994 Instance "snort-eth0"
5996 Collect "snort-dropped"
6000 The configuration consists of one or more B<Metric> blocks that define an index
6001 into the line of the CSV file and how this value is mapped to I<collectd's>
6002 internal representation. These are followed by one or more B<Instance> blocks
6003 which configure which file to read, in which interval and which metrics to
6008 =item E<lt>B<Metric> I<Name>E<gt>
6010 The B<Metric> block configures a new metric to be extracted from the statistics
6011 file and how it is mapped on I<collectd's> data model. The string I<Name> is
6012 only used inside the B<Instance> blocks to refer to this block, so you can use
6013 one B<Metric> block for multiple CSV files.
6017 =item B<Type> I<Type>
6019 Configures which I<Type> to use when dispatching this metric. Types are defined
6020 in the L<types.db(5)> file, see the appropriate manual page for more
6021 information on specifying types. Only types with a single I<data source> are
6022 supported by the I<tail_csv plugin>. The information whether the value is an
6023 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
6024 I<Type's> definition.
6026 =item B<Instance> I<TypeInstance>
6028 If set, I<TypeInstance> is used to populate the type instance field of the
6029 created value lists. Otherwise, no type instance is used.
6031 =item B<ValueFrom> I<Index>
6033 Configure to read the value from the field with the zero-based index I<Index>.
6034 If the value is parsed as signed integer, unsigned integer or double depends on
6035 the B<Type> setting, see above.
6039 =item E<lt>B<File> I<Path>E<gt>
6041 Each B<File> block represents one CSV file to read. There must be at least one
6042 I<File> block but there can be multiple if you have multiple CSV files.
6046 =item B<Instance> I<PluginInstance>
6048 Sets the I<plugin instance> used when dispatching the values.
6050 =item B<Collect> I<Metric>
6052 Specifies which I<Metric> to collect. This option must be specified at least
6053 once, and you can use this option multiple times to specify more than one
6054 metric to be extracted from this statistic file.
6056 =item B<Interval> I<Seconds>
6058 Configures the interval in which to read values from this instance / file.
6059 Defaults to the plugin's default interval.
6061 =item B<TimeFrom> I<Index>
6063 Rather than using the local time when dispatching a value, read the timestamp
6064 from the field with the zero-based index I<Index>. The value is interpreted as
6065 seconds since epoch. The value is parsed as a double and may be factional.
6071 =head2 Plugin C<teamspeak2>
6073 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
6074 polls interesting global and virtual server data. The plugin can query only one
6075 physical server but unlimited virtual servers. You can use the following
6076 options to configure it:
6080 =item B<Host> I<hostname/ip>
6082 The hostname or ip which identifies the physical server.
6085 =item B<Port> I<port>
6087 The query port of the physical server. This needs to be a string.
6090 =item B<Server> I<port>
6092 This option has to be added once for every virtual server the plugin should
6093 query. If you want to query the virtual server on port 8767 this is what the
6094 option would look like:
6098 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
6099 use quotes around it! If no such statement is given only global information
6104 =head2 Plugin C<ted>
6106 The I<TED> plugin connects to a device of "The Energy Detective", a device to
6107 measure power consumption. These devices are usually connected to a serial
6108 (RS232) or USB port. The plugin opens a configured device and tries to read the
6109 current energy readings. For more information on TED, visit
6110 L<http://www.theenergydetective.com/>.
6112 Available configuration options:
6116 =item B<Device> I<Path>
6118 Path to the device on which TED is connected. collectd will need read and write
6119 permissions on that file.
6121 Default: B</dev/ttyUSB0>
6123 =item B<Retries> I<Num>
6125 Apparently reading from TED is not that reliable. You can therefore configure a
6126 number of retries here. You only configure the I<retries> here, to if you
6127 specify zero, one reading will be performed (but no retries if that fails); if
6128 you specify three, a maximum of four readings are performed. Negative values
6135 =head2 Plugin C<tcpconns>
6137 The C<tcpconns plugin> counts the number of currently established TCP
6138 connections based on the local port and/or the remote port. Since there may be
6139 a lot of connections the default if to count all connections with a local port,
6140 for which a listening socket is opened. You can use the following options to
6141 fine-tune the ports you are interested in:
6145 =item B<ListeningPorts> I<true>|I<false>
6147 If this option is set to I<true>, statistics for all local ports for which a
6148 listening socket exists are collected. The default depends on B<LocalPort> and
6149 B<RemotePort> (see below): If no port at all is specifically selected, the
6150 default is to collect listening ports. If specific ports (no matter if local or
6151 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
6152 the selected ports will be collected unless this option is set to I<true>
6155 =item B<LocalPort> I<Port>
6157 Count the connections to a specific local port. This can be used to see how
6158 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
6159 You have to specify the port in numeric form, so for the mailserver example
6160 you'd need to set B<25>.
6162 =item B<RemotePort> I<Port>
6164 Count the connections to a specific remote port. This is useful to see how
6165 much a remote service is used. This is most useful if you want to know how many
6166 connections a local service has opened to remote services, e.E<nbsp>g. how many
6167 connections a mail server or news server has to other mail or news servers, or
6168 how many connections a web proxy holds to web servers. You have to give the
6169 port in numeric form.
6173 =head2 Plugin C<thermal>
6177 =item B<ForceUseProcfs> I<true>|I<false>
6179 By default, the I<Thermal plugin> tries to read the statistics from the Linux
6180 C<sysfs> interface. If that is not available, the plugin falls back to the
6181 C<procfs> interface. By setting this option to I<true>, you can force the
6182 plugin to use the latter. This option defaults to I<false>.
6184 =item B<Device> I<Device>
6186 Selects the name of the thermal device that you want to collect or ignore,
6187 depending on the value of the B<IgnoreSelected> option. This option may be
6188 used multiple times to specify a list of devices.
6190 =item B<IgnoreSelected> I<true>|I<false>
6192 Invert the selection: If set to true, all devices B<except> the ones that
6193 match the device names specified by the B<Device> option are collected. By
6194 default only selected devices are collected if a selection is made. If no
6195 selection is configured at all, B<all> devices are selected.
6199 =head2 Plugin C<threshold>
6201 The I<Threshold plugin> checks values collected or received by I<collectd>
6202 against a configurable I<threshold> and issues I<notifications> if values are
6205 Documentation for this plugin is available in the L<collectd-threshold(5)>
6208 =head2 Plugin C<tokyotyrant>
6210 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
6211 couple metrics: number of records, and database size on disk.
6215 =item B<Host> I<Hostname/IP>
6217 The hostname or ip which identifies the server.
6218 Default: B<127.0.0.1>
6220 =item B<Port> I<Service/Port>
6222 The query port of the server. This needs to be a string, even if the port is
6223 given in its numeric form.
6228 =head2 Plugin C<unixsock>
6232 =item B<SocketFile> I<Path>
6234 Sets the socket-file which is to be created.
6236 =item B<SocketGroup> I<Group>
6238 If running as root change the group of the UNIX-socket after it has been
6239 created. Defaults to B<collectd>.
6241 =item B<SocketPerms> I<Permissions>
6243 Change the file permissions of the UNIX-socket after it has been created. The
6244 permissions must be given as a numeric, octal value as you would pass to
6245 L<chmod(1)>. Defaults to B<0770>.
6247 =item B<DeleteSocket> B<false>|B<true>
6249 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
6250 with the given name already exists. If I<collectd> crashes a socket file may be
6251 left over, preventing the daemon from opening a new socket when restarted.
6252 Since this is potentially dangerous, this defaults to B<false>.
6256 =head2 Plugin C<uuid>
6258 This plugin, if loaded, causes the Hostname to be taken from the machine's
6259 UUID. The UUID is a universally unique designation for the machine, usually
6260 taken from the machine's BIOS. This is most useful if the machine is running in
6261 a virtual environment such as Xen, in which case the UUID is preserved across
6262 shutdowns and migration.
6264 The following methods are used to find the machine's UUID, in order:
6270 Check I</etc/uuid> (or I<UUIDFile>).
6274 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
6279 Check for UUID from C<dmidecode> / SMBIOS.
6283 Check for UUID from Xen hypervisor.
6287 If no UUID can be found then the hostname is not modified.
6291 =item B<UUIDFile> I<Path>
6293 Take the UUID from the given file (default I</etc/uuid>).
6297 =head2 Plugin C<varnish>
6299 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
6304 <Instance "example">
6306 CollectConnections true
6316 CollectWorkers false
6320 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
6321 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
6322 will collectd statistics from the default "varnishd" instance (this should work
6323 fine in most cases).
6325 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
6329 =item B<CollectCache> B<true>|B<false>
6331 Cache hits and misses. True by default.
6333 =item B<CollectConnections> B<true>|B<false>
6335 Number of client connections received, accepted and dropped. True by default.
6337 =item B<CollectBackend> B<true>|B<false>
6339 Back-end connection statistics, such as successful, reused,
6340 and closed connections. True by default.
6342 =item B<CollectSHM> B<true>|B<false>
6344 Statistics about the shared memory log, a memory region to store
6345 log messages which is flushed to disk when full. True by default.
6347 =item B<CollectBan> B<true>|B<false>
6349 Statistics about ban operations, such as number of bans added, retired, and
6350 number of objects tested against ban operations. Only available with Varnish
6351 3.x. False by default.
6353 =item B<CollectDirectorDNS> B<true>|B<false>
6355 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
6358 =item B<CollectESI> B<true>|B<false>
6360 Edge Side Includes (ESI) parse statistics. False by default.
6362 =item B<CollectFetch> B<true>|B<false>
6364 Statistics about fetches (HTTP requests sent to the backend). False by default.
6366 =item B<CollectHCB> B<true>|B<false>
6368 Inserts and look-ups in the crit bit tree based hash. Look-ups are
6369 divided into locked and unlocked look-ups. False by default.
6371 =item B<CollectObjects> B<true>|B<false>
6373 Statistics on cached objects: number of objects expired, nuked (prematurely
6374 expired), saved, moved, etc. False by default.
6376 =item B<CollectPurge> B<true>|B<false>
6378 Statistics about purge operations, such as number of purges added, retired, and
6379 number of objects tested against purge operations. Only available with Varnish
6380 2.x. False by default.
6382 =item B<CollectSession> B<true>|B<false>
6384 Client session statistics. Number of past and current sessions, session herd and
6385 linger counters, etc. False by default.
6387 =item B<CollectSMA> B<true>|B<false>
6389 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
6390 component is Solaris specific. Only available with Varnish 2.x. False by
6393 =item B<CollectSMS> B<true>|B<false>
6395 synth (synthetic content) storage statistics. This storage
6396 component is used internally only. False by default.
6398 =item B<CollectSM> B<true>|B<false>
6400 file (memory mapped file) storage statistics. Only available with Varnish 2.x.
6403 =item B<CollectStruct> B<true>|B<false>
6405 Current varnish internal state statistics. Number of current sessions, objects
6406 in cache store, open connections to backends (with Varnish 2.x), etc. False by
6409 =item B<CollectTotals> B<true>|B<false>
6411 Collects overview counters, such as the number of sessions created,
6412 the number of requests and bytes transferred. False by default.
6414 =item B<CollectUptime> B<true>|B<false>
6416 Varnish uptime. False by default.
6418 =item B<CollectVCL> B<true>|B<false>
6420 Number of total (available + discarded) VCL (config files). False by default.
6422 =item B<CollectWorkers> B<true>|B<false>
6424 Collect statistics about worker threads. False by default.
6428 =head2 Plugin C<vmem>
6430 The C<vmem> plugin collects information about the usage of virtual memory.
6431 Since the statistics provided by the Linux kernel are very detailed, they are
6432 collected very detailed. However, to get all the details, you have to switch
6433 them on manually. Most people just want an overview over, such as the number of
6434 pages read from swap space.
6438 =item B<Verbose> B<true>|B<false>
6440 Enables verbose collection of information. This will start collecting page
6441 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
6442 Part of these statistics are collected on a "per zone" basis.
6446 =head2 Plugin C<vserver>
6448 This plugin doesn't have any options. B<VServer> support is only available for
6449 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
6450 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
6451 need to apply the patches and compile your own kernel, which will then provide
6452 the F</proc/virtual> filesystem that is required by this plugin.
6454 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
6456 B<Note>: The traffic collected by this plugin accounts for the amount of
6457 traffic passing a socket which might be a lot less than the actual on-wire
6458 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
6459 collect on-wire traffic you could, for example, use the logging facilities of
6460 iptables to feed data for the guest IPs into the iptables plugin.
6462 =head2 Plugin C<write_graphite>
6464 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
6465 storage and graphing project. The plugin connects to I<Carbon>, the data layer
6466 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
6467 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
6468 of at most 1428 bytes to minimize the number of network packets.
6472 <Plugin write_graphite>
6482 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6483 blocks. Inside the B<Node> blocks, the following options are recognized:
6487 =item B<Host> I<Address>
6489 Hostname or address to connect to. Defaults to C<localhost>.
6491 =item B<Port> I<Service>
6493 Service name or port number to connect to. Defaults to C<2003>.
6495 =item B<Protocol> I<String>
6497 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
6499 =item B<LogSendErrors> B<false>|B<true>
6501 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
6502 If set to B<false>, it will not log the errors. This is especially useful when
6503 using Protocol UDP since many times we want to use the "fire-and-forget"
6504 approach and logging errors fills syslog with unneeded messages.
6506 =item B<Prefix> I<String>
6508 When set, I<String> is added in front of the host name. Dots and whitespace are
6509 I<not> escaped in this string (see B<EscapeCharacter> below).
6511 =item B<Postfix> I<String>
6513 When set, I<String> is appended to the host name. Dots and whitespace are
6514 I<not> escaped in this string (see B<EscapeCharacter> below).
6516 =item B<EscapeCharacter> I<Char>
6518 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
6519 in the identifier. The B<EscapeCharacter> option determines which character
6520 dots, whitespace and control characters are replaced with. Defaults to
6523 =item B<StoreRates> B<false>|B<true>
6525 If set to B<true> (the default), convert counter values to rates. If set to
6526 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6529 =item B<SeparateInstances> B<false>|B<true>
6531 If set to B<true>, the plugin instance and type instance will be in their own
6532 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6533 default), the plugin and plugin instance (and likewise the type and type
6534 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6536 =item B<AlwaysAppendDS> B<false>|B<true>
6538 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
6539 identifier. If set to B<false> (the default), this is only done when there is
6544 =head2 Plugin C<write_tsdb>
6546 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
6547 time series database. The plugin connects to a I<TSD>, a masterless, no shared
6548 state daemon that ingests metrics and stores them in HBase. The plugin uses
6549 I<TCP> over the "line based" protocol with a default port 4242. The data will
6550 be sent in blocks of at most 1428 bytes to minimize the number of network
6557 Host "tsd-1.my.domain"
6559 HostTags "status=production"
6563 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
6564 blocks. Inside the B<Node> blocks, the following options are recognized:
6568 =item B<Host> I<Address>
6570 Hostname or address to connect to. Defaults to C<localhost>.
6572 =item B<Port> I<Service>
6574 Service name or port number to connect to. Defaults to C<4242>.
6577 =item B<HostTags> I<String>
6579 When set, I<HostTags> is added to the end of the metric. It is intended to be
6580 used for name=value pairs that the TSD will tag the metric with. Dots and
6581 whitespace are I<not> escaped in this string.
6583 =item B<StoreRates> B<false>|B<true>
6585 If set to B<true>, convert counter values to rates. If set to B<false>
6586 (the default) counter values are stored as is, as an increasing
6589 =item B<AlwaysAppendDS> B<false>|B<true>
6591 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
6592 identifier. If set to B<false> (the default), this is only done when there is
6597 =head2 Plugin C<write_mongodb>
6599 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
6604 <Plugin "write_mongodb">
6613 The plugin can send values to multiple instances of I<MongoDB> by specifying
6614 one B<Node> block for each instance. Within the B<Node> blocks, the following
6615 options are available:
6619 =item B<Host> I<Address>
6621 Hostname or address to connect to. Defaults to C<localhost>.
6623 =item B<Port> I<Service>
6625 Service name or port number to connect to. Defaults to C<27017>.
6627 =item B<Timeout> I<Timeout>
6629 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
6630 Setting this option to zero means no timeout, which is the default.
6632 =item B<StoreRates> B<false>|B<true>
6634 If set to B<true> (the default), convert counter values to rates. If set to
6635 B<false> counter values are stored as is, i.e. as an increasing integer
6638 =item B<Database> I<Database>
6640 =item B<User> I<User>
6642 =item B<Password> I<Password>
6644 Sets the information used when authenticating to a I<MongoDB> database. The
6645 fields are optional (in which case no authentication is attempted), but if you
6646 want to use authentication all three fields must be set.
6650 =head2 Plugin C<write_http>
6652 This output plugin submits values to an http server by POST them using the
6653 PUTVAL plain-text protocol. Each destination you want to post data to needs to
6654 have one B<URL> block, within which the destination can be configured further,
6655 for example by specifying authentication data.
6659 <Plugin "write_http">
6660 <URL "http://example.com/post-collectd">
6666 B<URL> blocks need one string argument which is used as the URL to which data
6667 is posted. The following options are understood within B<URL> blocks.
6671 =item B<User> I<Username>
6673 Optional user name needed for authentication.
6675 =item B<Password> I<Password>
6677 Optional password needed for authentication.
6679 =item B<VerifyPeer> B<true>|B<false>
6681 Enable or disable peer SSL certificate verification. See
6682 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
6684 =item B<VerifyHost> B<true|false>
6686 Enable or disable peer host name verification. If enabled, the plugin checks if
6687 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
6688 matches the host name provided by the B<URL> option. If this identity check
6689 fails, the connection is aborted. Obviously, only works when connecting to a
6690 SSL enabled server. Enabled by default.
6692 =item B<CACert> I<File>
6694 File that holds one or more SSL certificates. If you want to use HTTPS you will
6695 possibly need this option. What CA certificates come bundled with C<libcurl>
6696 and are checked by default depends on the distribution you use.
6698 =item B<CAPath> I<Directory>
6700 Directory holding one or more CA certificate files. You can use this if for
6701 some reason all the needed CA certificates aren't in the same file and can't be
6702 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
6705 =item B<ClientKey> I<File>
6707 File that holds the private key in PEM format to be used for certificate-based
6710 =item B<ClientCert> I<File>
6712 File that holds the SSL certificate to be used for certificate-based
6715 =item B<ClientKeyPass> I<Password>
6717 Password required to load the private key in B<ClientKey>.
6719 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
6721 Define which SSL protocol version must be used. By default C<libcurl> will
6722 attempt to figure out the remote SSL protocol version. See
6723 L<curl_easy_setopt(3)> for more details.
6725 =item B<Format> B<Command>|B<JSON>
6727 Format of the output to generate. If set to B<Command>, will create output that
6728 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
6729 create output in the I<JavaScript Object Notation> (JSON).
6731 Defaults to B<Command>.
6733 =item B<StoreRates> B<true|false>
6735 If set to B<true>, convert counter values to rates. If set to B<false> (the
6736 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
6741 =head2 Plugin C<write_kafka>
6743 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
6747 <Plugin "write_kafka">
6748 Property "metadata.broker.list" "broker1:9092,broker2:9092"
6754 The following options are understood by the I<write_kafka plugin>:
6758 =item E<lt>B<Topic> I<Name>E<gt>
6760 The plugin's configuration consists of one or more B<Topic> blocks. Each block
6761 is given a unique I<Name> and specifies one kafka producer.
6762 Inside the B<Topic> block, the following per-topic options are
6767 =item B<Property> I<String> I<String>
6769 Configure the named property for the current topic. Properties are
6770 forwarded to the kafka producer library B<librdkafka>.
6772 =item B<Key> I<String>
6774 Use the specified string as a partioning key for the topic. Kafka breaks
6775 topic into partitions and guarantees that for a given topology, the same
6776 consumer will be used for a specific key. The special (case insensitive)
6777 string B<Random> can be used to specify that an arbitrary partition should
6780 =item B<Format> B<Command>|B<JSON>|B<Graphite>
6782 Selects the format in which messages are sent to the broker. If set to
6783 B<Command> (the default), values are sent as C<PUTVAL> commands which are
6784 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
6786 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
6787 an easy and straight forward exchange format.
6789 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
6790 "<metric> <value> <timestamp>\n".
6792 =item B<StoreRates> B<true>|B<false>
6794 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
6795 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
6796 default), no conversion is performed. Otherwise the conversion is performed
6797 using the internal value cache.
6799 Please note that currently this option is only used if the B<Format> option has
6800 been set to B<JSON>.
6802 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
6804 A prefix can be added in the metric name when outputting in the I<Graphite> format.
6805 It's added before the I<Host> name.
6806 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6808 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
6810 A postfix can be added in the metric name when outputting in the I<Graphite> format.
6811 It's added after the I<Host> name.
6812 Metric name will be "<prefix><host><postfix><plugin><type><name>"
6814 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
6816 Specify a character to replace dots (.) in the host part of the metric name.
6817 In I<Graphite> metric name, dots are used as separators between different
6818 metric parts (host, plugin, type).
6819 Default is "_" (I<Underscore>).
6821 =item B<GraphiteSeparateInstances> B<false>|B<true>
6823 If set to B<true>, the plugin instance and type instance will be in their own
6824 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
6825 default), the plugin and plugin instance (and likewise the type and type
6826 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
6828 =item B<StoreRates> B<true>|B<false>
6830 If set to B<true> (the default), convert counter values to rates. If set to
6831 B<false> counter values are stored as is, i.e. as an increasing integer number.
6833 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6834 converted values will have "rate" appended to the data source type, e.g.
6835 C<ds_type:derive:rate>.
6839 =item B<Property> I<String> I<String>
6841 Configure the kafka producer through properties, you almost always will
6842 want to set B<metadata.broker.list> to your Kafka broker list.
6846 =head2 Plugin C<write_riemann>
6848 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
6849 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
6850 I<Riemann> using UDP packets.
6854 <Plugin "write_riemann">
6860 AlwaysAppendDS false
6864 Attribute "foo" "bar"
6867 The following options are understood by the I<write_riemann plugin>:
6871 =item E<lt>B<Node> I<Name>E<gt>
6873 The plugin's configuration consists of one or more B<Node> blocks. Each block
6874 is given a unique I<Name> and specifies one connection to an instance of
6875 I<Riemann>. Indise the B<Node> block, the following per-connection options are
6880 =item B<Host> I<Address>
6882 Hostname or address to connect to. Defaults to C<localhost>.
6884 =item B<Port> I<Service>
6886 Service name or port number to connect to. Defaults to C<5555>.
6888 =item B<Protocol> B<UDP>|B<TCP>
6890 Specify the protocol to use when communicating with I<Riemann>. Defaults to
6893 =item B<StoreRates> B<true>|B<false>
6895 If set to B<true> (the default), convert counter values to rates. If set to
6896 B<false> counter values are stored as is, i.e. as an increasing integer number.
6898 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
6899 converted values will have "rate" appended to the data source type, e.g.
6900 C<ds_type:derive:rate>.
6902 =item B<AlwaysAppendDS> B<false>|B<true>
6904 If set the B<true>, append the name of the I<Data Source> (DS) to the
6905 "service", i.e. the field that, together with the "host" field, uniquely
6906 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
6907 only done when there is more than one DS.
6909 =item B<TTLFactor> I<Factor>
6911 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
6912 event is considered active. I<collectd> populates this field based on the
6913 metrics interval setting. This setting controls the factor with which the
6914 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
6915 know exactly what you're doing, you should only increase this setting from its
6918 =item B<Notifications> B<false>|B<true>
6920 If set to B<true>, create riemann events for notifications. This is B<true>
6921 by default. When processing thresholds from write_riemann, it might prove
6922 useful to avoid getting notification events.
6924 =item B<CheckThresholds> B<false>|B<true>
6926 If set to B<true>, attach state to events based on thresholds defined
6927 in the B<Threshold> plugin. Defaults to B<false>.
6929 =item B<EventServicePrefix> I<String>
6931 Add the given string as a prefix to the event service name.
6932 If B<EventServicePrefix> not set or set to an empty string (""),
6933 no prefix will be used.
6937 =item B<Tag> I<String>
6939 Add the given string as an additional tag to the metric being sent to
6942 =item B<Attribute> I<String> I<String>
6944 Consider the two given strings to be the key and value of an additional
6945 attribute for each metric being sent out to I<Riemann>.
6949 =head1 THRESHOLD CONFIGURATION
6951 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
6952 we mean that the values are not only stored or sent somewhere, but that they
6953 are judged and, if a problem is recognized, acted upon. The only action
6954 collectd takes itself is to generate and dispatch a "notification". Plugins can
6955 register to receive notifications and perform appropriate further actions.
6957 Since systems and what you expect them to do differ a lot, you can configure
6958 B<thresholds> for your values freely. This gives you a lot of flexibility but
6959 also a lot of responsibility.
6961 Every time a value is out of range a notification is dispatched. This means
6962 that the idle percentage of your CPU needs to be less then the configured
6963 threshold only once for a notification to be generated. There's no such thing
6964 as a moving average or similar - at least not now.
6966 Also, all values that match a threshold are considered to be relevant or
6967 "interesting". As a consequence collectd will issue a notification if they are
6968 not received for B<Timeout> iterations. The B<Timeout> configuration option is
6969 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
6970 "2" (the default) and some hosts sends it's CPU statistics to the server every
6971 60 seconds, a notification will be dispatched after about 120 seconds. It may
6972 take a little longer because the timeout is checked only once each B<Interval>
6975 When a value comes within range again or is received after it was missing, an
6976 "OKAY-notification" is dispatched.
6978 Here is a configuration example to get you started. Read below for more
6991 <Plugin "interface">
7008 WarningMin 100000000
7014 There are basically two types of configuration statements: The C<Host>,
7015 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
7016 configured. The C<Plugin> and C<Type> blocks may be specified further using the
7017 C<Instance> option. You can combine the block by nesting the blocks, though
7018 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
7019 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
7020 C<Type> may not contain other blocks. If multiple blocks apply to the same
7021 value the most specific block is used.
7023 The other statements specify the threshold to configure. They B<must> be
7024 included in a C<Type> block. Currently the following statements are recognized:
7028 =item B<FailureMax> I<Value>
7030 =item B<WarningMax> I<Value>
7032 Sets the upper bound of acceptable values. If unset defaults to positive
7033 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
7034 will be created. If the value is greater than B<WarningMax> but less than (or
7035 equal to) B<FailureMax> a B<WARNING> notification will be created.
7037 =item B<FailureMin> I<Value>
7039 =item B<WarningMin> I<Value>
7041 Sets the lower bound of acceptable values. If unset defaults to negative
7042 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
7043 be created. If the value is less than B<WarningMin> but greater than (or equal
7044 to) B<FailureMin> a B<WARNING> notification will be created.
7046 =item B<DataSource> I<DSName>
7048 Some data sets have more than one "data source". Interesting examples are the
7049 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
7050 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
7051 system load data set, C<load>, even has three data sources: C<shortterm>,
7052 C<midterm>, and C<longterm>.
7054 Normally, all data sources are checked against a configured threshold. If this
7055 is undesirable, or if you want to specify different limits for each data
7056 source, you can use the B<DataSource> option to have a threshold apply only to
7059 =item B<Invert> B<true>|B<false>
7061 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
7062 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
7063 B<WarningMax>) are not okay. Defaults to B<false>.
7065 =item B<Persist> B<true>|B<false>
7067 Sets how often notifications are generated. If set to B<true> one notification
7068 will be generated for each value that is out of the acceptable range. If set to
7069 B<false> (the default) then a notification is only generated if a value is out
7070 of range but the previous value was okay.
7072 This applies to missing values, too: If set to B<true> a notification about a
7073 missing value is generated once every B<Interval> seconds. If set to B<false>
7074 only one such notification is generated until the value appears again.
7076 =item B<Percentage> B<true>|B<false>
7078 If set to B<true>, the minimum and maximum values given are interpreted as
7079 percentage value, relative to the other data sources. This is helpful for
7080 example for the "df" type, where you may want to issue a warning when less than
7081 5E<nbsp>% of the total space is available. Defaults to B<false>.
7083 =item B<Hits> I<Number>
7085 Delay creating the notification until the threshold has been passed I<Number>
7086 times. When a notification has been generated, or when a subsequent value is
7087 inside the threshold, the counter is reset. If, for example, a value is
7088 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
7089 will be dispatched at most once every 30E<nbsp>seconds.
7091 This is useful when short bursts are not a problem. If, for example, 100% CPU
7092 usage for up to a minute is normal (and data is collected every
7093 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
7095 =item B<Hysteresis> I<Number>
7097 When set to non-zero, a hysteresis value is applied when checking minimum and
7098 maximum bounds. This is useful for values that increase slowly and fluctuate a
7099 bit while doing so. When these values come close to the threshold, they may
7100 "flap", i.e. switch between failure / warning case and okay case repeatedly.
7102 If, for example, the threshold is configures as
7107 then a I<Warning> notification is created when the value exceeds I<101> and the
7108 corresponding I<Okay> notification is only created once the value falls below
7109 I<99>, thus avoiding the "flapping".
7113 =head1 FILTER CONFIGURATION
7115 Starting with collectd 4.6 there is a powerful filtering infrastructure
7116 implemented in the daemon. The concept has mostly been copied from
7117 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
7118 terminology, so that users that are familiar with iptables feel right at home.
7122 The following are the terms used in the remainder of the filter configuration
7123 documentation. For an ASCII-art schema of the mechanism, see
7124 L<"General structure"> below.
7130 A I<match> is a criteria to select specific values. Examples are, of course, the
7131 name of the value or it's current value.
7133 Matches are implemented in plugins which you have to load prior to using the
7134 match. The name of such plugins starts with the "match_" prefix.
7138 A I<target> is some action that is to be performed with data. Such actions
7139 could, for example, be to change part of the value's identifier or to ignore
7140 the value completely.
7142 Some of these targets are built into the daemon, see L<"Built-in targets">
7143 below. Other targets are implemented in plugins which you have to load prior to
7144 using the target. The name of such plugins starts with the "target_" prefix.
7148 The combination of any number of matches and at least one target is called a
7149 I<rule>. The target actions will be performed for all values for which B<all>
7150 matches apply. If the rule does not have any matches associated with it, the
7151 target action will be performed for all values.
7155 A I<chain> is a list of rules and possibly default targets. The rules are tried
7156 in order and if one matches, the associated target will be called. If a value
7157 is handled by a rule, it depends on the target whether or not any subsequent
7158 rules are considered or if traversal of the chain is aborted, see
7159 L<"Flow control"> below. After all rules have been checked, the default targets
7164 =head2 General structure
7166 The following shows the resulting structure:
7173 +---------+ +---------+ +---------+ +---------+
7174 ! Rule !->! Match !->! Match !->! Target !
7175 +---------+ +---------+ +---------+ +---------+
7178 +---------+ +---------+ +---------+
7179 ! Rule !->! Target !->! Target !
7180 +---------+ +---------+ +---------+
7187 +---------+ +---------+ +---------+
7188 ! Rule !->! Match !->! Target !
7189 +---------+ +---------+ +---------+
7199 There are four ways to control which way a value takes through the filter
7206 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
7207 process the value with another chain. When the called chain finishes, usually
7208 the next target or rule after the jump is executed.
7212 The stop condition, signaled for example by the built-in target B<stop>, causes
7213 all processing of the value to be stopped immediately.
7217 Causes processing in the current chain to be aborted, but processing of the
7218 value generally will continue. This means that if the chain was called via
7219 B<Jump>, the next target or rule after the jump will be executed. If the chain
7220 was not called by another chain, control will be returned to the daemon and it
7221 may pass the value to another chain.
7225 Most targets will signal the B<continue> condition, meaning that processing
7226 should continue normally. There is no special built-in target for this
7233 The configuration reflects this structure directly:
7235 PostCacheChain "PostCache"
7237 <Rule "ignore_mysql_show">
7240 Type "^mysql_command$"
7241 TypeInstance "^show_"
7251 The above configuration example will ignore all values where the plugin field
7252 is "mysql", the type is "mysql_command" and the type instance begins with
7253 "show_". All other values will be sent to the C<rrdtool> write plugin via the
7254 default target of the chain. Since this chain is run after the value has been
7255 added to the cache, the MySQL C<show_*> command statistics will be available
7256 via the C<unixsock> plugin.
7258 =head2 List of configuration options
7262 =item B<PreCacheChain> I<ChainName>
7264 =item B<PostCacheChain> I<ChainName>
7266 Configure the name of the "pre-cache chain" and the "post-cache chain". The
7267 argument is the name of a I<chain> that should be executed before and/or after
7268 the values have been added to the cache.
7270 To understand the implications, it's important you know what is going on inside
7271 I<collectd>. The following diagram shows how values are passed from the
7272 read-plugins to the write-plugins:
7278 + - - - - V - - - - +
7279 : +---------------+ :
7282 : +-------+-------+ :
7285 : +-------+-------+ : +---------------+
7286 : ! Cache !--->! Value Cache !
7287 : ! insert ! : +---+---+-------+
7288 : +-------+-------+ : ! !
7289 : ! ,------------' !
7291 : +-------+---+---+ : +-------+-------+
7292 : ! Post-Cache +--->! Write-Plugins !
7293 : ! Chain ! : +---------------+
7294 : +---------------+ :
7297 + - - - - - - - - - +
7299 After the values are passed from the "read" plugins to the dispatch functions,
7300 the pre-cache chain is run first. The values are added to the internal cache
7301 afterwards. The post-cache chain is run after the values have been added to the
7302 cache. So why is it such a huge deal if chains are run before or after the
7303 values have been added to this cache?
7305 Targets that change the identifier of a value list should be executed before
7306 the values are added to the cache, so that the name in the cache matches the
7307 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
7308 this cache to receive a list of all available values. If you change the
7309 identifier after the value list has been added to the cache, this may easily
7310 lead to confusion, but it's not forbidden of course.
7312 The cache is also used to convert counter values to rates. These rates are, for
7313 example, used by the C<value> match (see below). If you use the rate stored in
7314 the cache B<before> the new value is added, you will use the old, B<previous>
7315 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
7316 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
7319 Last but not last, the B<stop> target makes a difference: If the pre-cache
7320 chain returns the stop condition, the value will not be added to the cache and
7321 the post-cache chain will not be run.
7323 =item B<Chain> I<Name>
7325 Adds a new chain with a certain name. This name can be used to refer to a
7326 specific chain, for example to jump to it.
7328 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
7330 =item B<Rule> [I<Name>]
7332 Adds a new rule to the current chain. The name of the rule is optional and
7333 currently has no meaning for the daemon.
7335 Within the B<Rule> block, there may be any number of B<Match> blocks and there
7336 must be at least one B<Target> block.
7338 =item B<Match> I<Name>
7340 Adds a match to a B<Rule> block. The name specifies what kind of match should
7341 be performed. Available matches depend on the plugins that have been loaded.
7343 The arguments inside the B<Match> block are passed to the plugin implementing
7344 the match, so which arguments are valid here depends on the plugin being used.
7345 If you do not need any to pass any arguments to a match, you can use the
7350 Which is equivalent to:
7355 =item B<Target> I<Name>
7357 Add a target to a rule or a default target to a chain. The name specifies what
7358 kind of target is to be added. Which targets are available depends on the
7359 plugins being loaded.
7361 The arguments inside the B<Target> block are passed to the plugin implementing
7362 the target, so which arguments are valid here depends on the plugin being used.
7363 If you do not need any to pass any arguments to a target, you can use the
7368 This is the same as writing:
7375 =head2 Built-in targets
7377 The following targets are built into the core daemon and therefore need no
7378 plugins to be loaded:
7384 Signals the "return" condition, see the L<"Flow control"> section above. This
7385 causes the current chain to stop processing the value and returns control to
7386 the calling chain. The calling chain will continue processing targets and rules
7387 just after the B<jump> target (see below). This is very similar to the
7388 B<RETURN> target of iptables, see L<iptables(8)>.
7390 This target does not have any options.
7398 Signals the "stop" condition, see the L<"Flow control"> section above. This
7399 causes processing of the value to be aborted immediately. This is similar to
7400 the B<DROP> target of iptables, see L<iptables(8)>.
7402 This target does not have any options.
7410 Sends the value to "write" plugins.
7416 =item B<Plugin> I<Name>
7418 Name of the write plugin to which the data should be sent. This option may be
7419 given multiple times to send the data to more than one write plugin. If the
7420 plugin supports multiple instances, the plugin's instance(s) must also be
7425 If no plugin is explicitly specified, the values will be sent to all available
7428 Single-instance plugin example:
7434 Multi-instance plugin example:
7436 <Plugin "write_graphite">
7446 Plugin "write_graphite/foo"
7451 Starts processing the rules of another chain, see L<"Flow control"> above. If
7452 the end of that chain is reached, or a stop condition is encountered,
7453 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
7454 next target or the next rule. This is similar to the B<-j> command line option
7455 of iptables, see L<iptables(8)>.
7461 =item B<Chain> I<Name>
7463 Jumps to the chain I<Name>. This argument is required and may appear only once.
7475 =head2 Available matches
7481 Matches a value using regular expressions.
7487 =item B<Host> I<Regex>
7489 =item B<Plugin> I<Regex>
7491 =item B<PluginInstance> I<Regex>
7493 =item B<Type> I<Regex>
7495 =item B<TypeInstance> I<Regex>
7497 Match values where the given regular expressions match the various fields of
7498 the identifier of a value. If multiple regular expressions are given, B<all>
7499 regexen must match for a value to match.
7501 =item B<Invert> B<false>|B<true>
7503 When set to B<true>, the result of the match is inverted, i.e. all value lists
7504 where all regular expressions apply are not matched, all other value lists are
7505 matched. Defaults to B<false>.
7512 Host "customer[0-9]+"
7518 Matches values that have a time which differs from the time on the server.
7520 This match is mainly intended for servers that receive values over the
7521 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
7522 is very sensitive to the timestamp used when updating the RRD files. In
7523 particular, the time must be ever increasing. If a misbehaving client sends one
7524 packet with a timestamp far in the future, all further packets with a correct
7525 time will be ignored because of that one packet. What's worse, such corrupted
7526 RRD files are hard to fix.
7528 This match lets one match all values B<outside> a specified time range
7529 (relative to the server's time), so you can use the B<stop> target (see below)
7530 to ignore the value, for example.
7536 =item B<Future> I<Seconds>
7538 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
7539 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7542 =item B<Past> I<Seconds>
7544 Matches all values that are I<behind> of the server's time by I<Seconds> or
7545 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
7557 This example matches all values that are five minutes or more ahead of the
7558 server or one hour (or more) lagging behind.
7562 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
7563 values. If a data-set consists of more than one data-source, all data-sources
7564 must match the specified ranges for a positive match.
7570 =item B<Min> I<Value>
7572 Sets the smallest value which still results in a match. If unset, behaves like
7575 =item B<Max> I<Value>
7577 Sets the largest value which still results in a match. If unset, behaves like
7580 =item B<Invert> B<true>|B<false>
7582 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
7583 no-match is returned and vice versa. Please note that the B<Invert> setting
7584 only effects how B<Min> and B<Max> are applied to a specific value. Especially
7585 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
7587 =item B<DataSource> I<DSName> [I<DSName> ...]
7589 Select one or more of the data sources. If no data source is configured, all
7590 data sources will be checked. If the type handled by the match does not have a
7591 data source of the specified name(s), this will always result in no match
7592 (independent of the B<Invert> setting).
7594 =item B<Satisfy> B<Any>|B<All>
7596 Specifies how checking with several data sources is performed. If set to
7597 B<Any>, the match succeeds if one of the data sources is in the configured
7598 range. If set to B<All> the match only succeeds if all data sources are within
7599 the configured range. Default is B<All>.
7601 Usually B<All> is used for positive matches, B<Any> is used for negative
7602 matches. This means that with B<All> you usually check that all values are in a
7603 "good" range, while with B<Any> you check if any value is within a "bad" range
7604 (or outside the "good" range).
7608 Either B<Min> or B<Max>, but not both, may be unset.
7612 # Match all values smaller than or equal to 100. Matches only if all data
7613 # sources are below 100.
7619 # Match if the value of any data source is outside the range of 0 - 100.
7627 =item B<empty_counter>
7629 Matches all values with one or more data sources of type B<COUNTER> and where
7630 all counter values are zero. These counters usually I<never> increased since
7631 they started existing (and are therefore uninteresting), or got reset recently
7632 or overflowed and you had really, I<really> bad luck.
7634 Please keep in mind that ignoring such counters can result in confusing
7635 behavior: Counters which hardly ever increase will be zero for long periods of
7636 time. If the counter is reset for some reason (machine or service restarted,
7637 usually), the graph will be empty (NAN) for a long time. People may not
7642 Calculates a hash value of the host name and matches values according to that
7643 hash value. This makes it possible to divide all hosts into groups and match
7644 only values that are in a specific group. The intended use is in load
7645 balancing, where you want to handle only part of all data and leave the rest
7648 The hashing function used tries to distribute the hosts evenly. First, it
7649 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
7652 for (i = 0; host[i] != 0; i++)
7653 hash_value = (hash_value * 251) + host[i];
7655 The constant 251 is a prime number which is supposed to make this hash value
7656 more random. The code then checks the group for this host according to the
7657 I<Total> and I<Match> arguments:
7659 if ((hash_value % Total) == Match)
7664 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
7665 groups), then the least significant bit of the hash value will be the XOR of
7666 all least significant bits in the host name. One consequence is that when you
7667 have two hosts, "server0.example.com" and "server1.example.com", where the host
7668 name differs in one digit only and the digits differ by one, those hosts will
7669 never end up in the same group.
7675 =item B<Match> I<Match> I<Total>
7677 Divide the data into I<Total> groups and match all hosts in group I<Match> as
7678 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
7679 be smaller than I<Total>. I<Total> must be at least one, although only values
7680 greater than one really do make any sense.
7682 You can repeat this option to match multiple groups, for example:
7687 The above config will divide the data into seven groups and match groups three
7688 and five. One use would be to keep every value on two hosts so that if one
7689 fails the missing data can later be reconstructed from the second host.
7695 # Operate on the pre-cache chain, so that ignored values are not even in the
7700 # Divide all received hosts in seven groups and accept all hosts in
7704 # If matched: Return and continue.
7707 # If not matched: Return and stop.
7713 =head2 Available targets
7717 =item B<notification>
7719 Creates and dispatches a notification.
7725 =item B<Message> I<String>
7727 This required option sets the message of the notification. The following
7728 placeholders will be replaced by an appropriate value:
7736 =item B<%{plugin_instance}>
7740 =item B<%{type_instance}>
7742 These placeholders are replaced by the identifier field of the same name.
7744 =item B<%{ds:>I<name>B<}>
7746 These placeholders are replaced by a (hopefully) human readable representation
7747 of the current rate of this data source. If you changed the instance name
7748 (using the B<set> or B<replace> targets, see below), it may not be possible to
7749 convert counter values to rates.
7753 Please note that these placeholders are B<case sensitive>!
7755 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
7757 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
7764 <Target "notification">
7765 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
7771 Replaces parts of the identifier using regular expressions.
7777 =item B<Host> I<Regex> I<Replacement>
7779 =item B<Plugin> I<Regex> I<Replacement>
7781 =item B<PluginInstance> I<Regex> I<Replacement>
7783 =item B<TypeInstance> I<Regex> I<Replacement>
7785 Match the appropriate field with the given regular expression I<Regex>. If the
7786 regular expression matches, that part that matches is replaced with
7787 I<Replacement>. If multiple places of the input buffer match a given regular
7788 expression, only the first occurrence will be replaced.
7790 You can specify each option multiple times to use multiple regular expressions
7798 # Replace "example.net" with "example.com"
7799 Host "\\<example.net\\>" "example.com"
7801 # Strip "www." from hostnames
7807 Sets part of the identifier of a value to a given string.
7813 =item B<Host> I<String>
7815 =item B<Plugin> I<String>
7817 =item B<PluginInstance> I<String>
7819 =item B<TypeInstance> I<String>
7821 Set the appropriate field to the given string. The strings for plugin instance
7822 and type instance may be empty, the strings for host and plugin may not be
7823 empty. It's currently not possible to set the type of a value this way.
7830 PluginInstance "coretemp"
7831 TypeInstance "core3"
7836 =head2 Backwards compatibility
7838 If you use collectd with an old configuration, i.E<nbsp>e. one without a
7839 B<Chain> block, it will behave as it used to. This is equivalent to the
7840 following configuration:
7846 If you specify a B<PostCacheChain>, the B<write> target will not be added
7847 anywhere and you will have to make sure that it is called where appropriate. We
7848 suggest to add the above snippet as default target to your "PostCache" chain.
7852 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
7868 L<collectd-exec(5)>,
7869 L<collectd-perl(5)>,
7870 L<collectd-unixsock(5)>,
7883 Florian Forster E<lt>octo@collectd.orgE<gt>