5 collectd.conf - Configuration for the system statistics collection daemon B<collectd>
9 BaseDir "/var/lib/collectd"
10 PIDFile "/run/collectd.pid"
31 This config file controls how the system statistics collection daemon
32 B<collectd> behaves. The most significant option is B<LoadPlugin>, which
33 controls which plugins to load. These plugins ultimately define collectd's
34 behavior. If the B<AutoLoadPlugin> option has been enabled, the explicit
35 B<LoadPlugin> lines may be omitted for all plugins with a configuration block,
36 i.e. a C<E<lt>PluginE<nbsp>...E<gt>> block.
38 The syntax of this config file is similar to the config file of the famous
39 I<Apache> webserver. Each line contains either an option (a key and a list of
40 one or more values) or a section-start or -end. Empty lines and everything
41 after a non-quoted hash-symbol (C<#>) are ignored. I<Keys> are unquoted
42 strings, consisting only of alphanumeric characters and the underscore (C<_>)
43 character. Keys are handled case insensitive by I<collectd> itself and all
44 plugins included with it. I<Values> can either be an I<unquoted string>, a
45 I<quoted string> (enclosed in double-quotes) a I<number> or a I<boolean>
46 expression. I<Unquoted strings> consist of only alphanumeric characters and
47 underscores (C<_>) and do not need to be quoted. I<Quoted strings> are
48 enclosed in double quotes (C<">). You can use the backslash character (C<\>)
49 to include double quotes as part of the string. I<Numbers> can be specified in
50 decimal and floating point format (using a dot C<.> as decimal separator),
51 hexadecimal when using the C<0x> prefix and octal with a leading zero (C<0>).
52 I<Boolean> values are either B<true> or B<false>.
54 Lines may be wrapped by using C<\> as the last character before the newline.
55 This allows long lines to be split into multiple lines. Quoted strings may be
56 wrapped as well. However, those are treated special in that whitespace at the
57 beginning of the following lines will be ignored, which allows for nicely
58 indenting the wrapped lines.
60 The configuration is read and processed in order, i.e. from top to bottom. So
61 the plugins are loaded in the order listed in this config file. It is a good
62 idea to load any logging plugins first in order to catch messages from plugins
63 during configuration. Also, unless B<AutoLoadPlugin> is enabled, the
64 B<LoadPlugin> option I<must> occur I<before> the appropriate
65 C<E<lt>B<Plugin> ...E<gt>> block.
71 =item B<BaseDir> I<Directory>
73 Sets the base directory. This is the directory beneath which all RRD-files are
74 created. Possibly more subdirectories are created. This is also the working
75 directory for the daemon.
77 =item B<LoadPlugin> I<Plugin>
79 Loads the plugin I<Plugin>. This is required to load plugins, unless the
80 B<AutoLoadPlugin> option is enabled (see below). Without any loaded plugins,
81 I<collectd> will be mostly useless.
83 Only the first B<LoadPlugin> statement or block for a given plugin name has any
84 effect. This is useful when you want to split up the configuration into smaller
85 files and want each file to be "self contained", i.e. it contains a B<Plugin>
86 block I<and> the appropriate B<LoadPlugin> statement. The downside is that if
87 you have multiple conflicting B<LoadPlugin> blocks, e.g. when they specify
88 different intervals, only one of them (the first one encountered) will take
89 effect and all others will be silently ignored.
91 B<LoadPlugin> may either be a simple configuration I<statement> or a I<block>
92 with additional options, affecting the behavior of B<LoadPlugin>. A simple
93 statement looks like this:
97 Options inside a B<LoadPlugin> block can override default settings and
98 influence the way plugins are loaded, e.g.:
104 The following options are valid inside B<LoadPlugin> blocks:
108 =item B<Globals> B<true|false>
110 If enabled, collectd will export all global symbols of the plugin (and of all
111 libraries loaded as dependencies of the plugin) and, thus, makes those symbols
112 available for resolving unresolved symbols in subsequently loaded plugins if
113 that is supported by your system.
115 This is useful (or possibly even required), e.g., when loading a plugin that
116 embeds some scripting language into the daemon (e.g. the I<Perl> and
117 I<Python plugins>). Scripting languages usually provide means to load
118 extensions written in C. Those extensions require symbols provided by the
119 interpreter, which is loaded as a dependency of the respective collectd plugin.
120 See the documentation of those plugins (e.g., L<collectd-perl(5)> or
121 L<collectd-python(5)>) for details.
123 By default, this is disabled. As a special exception, if the plugin name is
124 either C<perl> or C<python>, the default is changed to enabled in order to keep
125 the average user from ever having to deal with this low level linking stuff.
127 =item B<Interval> I<Seconds>
129 Sets a plugin-specific interval for collecting metrics. This overrides the
130 global B<Interval> setting. If a plugin provides its own support for specifying
131 an interval, that setting will take precedence.
133 =item B<FlushInterval> I<Seconds>
135 Specifies the interval, in seconds, to call the flush callback if it's
136 defined in this plugin. By default, this is disabled.
138 =item B<FlushTimeout> I<Seconds>
140 Specifies the value of the timeout argument of the flush callback.
144 =item B<AutoLoadPlugin> B<false>|B<true>
146 When set to B<false> (the default), each plugin needs to be loaded explicitly,
147 using the B<LoadPlugin> statement documented above. If a
148 B<E<lt>PluginE<nbsp>...E<gt>> block is encountered and no configuration
149 handling callback for this plugin has been registered, a warning is logged and
150 the block is ignored.
152 When set to B<true>, explicit B<LoadPlugin> statements are not required. Each
153 B<E<lt>PluginE<nbsp>...E<gt>> block acts as if it was immediately preceded by a
154 B<LoadPlugin> statement. B<LoadPlugin> statements are still required for
155 plugins that don't provide any configuration, e.g. the I<Load plugin>.
157 =item B<CollectInternalStats> B<false>|B<true>
159 When set to B<true>, various statistics about the I<collectd> daemon will be
160 collected, with "collectd" as the I<plugin name>. Defaults to B<false>.
162 The following metrics are reported:
166 =item C<collectd-write_queue/queue_length>
168 The number of metrics currently in the write queue. You can limit the queue
169 length with the B<WriteQueueLimitLow> and B<WriteQueueLimitHigh> options.
171 =item C<collectd-write_queue/derive-dropped>
173 The number of metrics dropped due to a queue length limitation.
174 If this value is non-zero, your system can't handle all incoming metrics and
175 protects itself against overload by dropping metrics.
177 =item C<collectd-cache/cache_size>
179 The number of elements in the metric cache (the cache you can interact with
180 using L<collectd-unixsock(5)>).
184 =item B<Include> I<Path> [I<pattern>]
186 If I<Path> points to a file, includes that file. If I<Path> points to a
187 directory, recursively includes all files within that directory and its
188 subdirectories. If the C<wordexp> function is available on your system,
189 shell-like wildcards are expanded before files are included. This means you can
190 use statements like the following:
192 Include "/etc/collectd.d/*.conf"
194 Starting with version 5.3, this may also be a block in which further options
195 affecting the behavior of B<Include> may be specified. The following option is
198 <Include "/etc/collectd.d">
204 =item B<Filter> I<pattern>
206 If the C<fnmatch> function is available on your system, a shell-like wildcard
207 I<pattern> may be specified to filter which files to include. This may be used
208 in combination with recursively including a directory to easily be able to
209 arbitrarily mix configuration files and other documents (e.g. README files).
210 The given example is similar to the first example above but includes all files
211 matching C<*.conf> in any subdirectory of C</etc/collectd.d>.
215 If more than one file is included by a single B<Include> option, the files
216 will be included in lexicographical order (as defined by the C<strcmp>
217 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the
218 order in which the files are loaded.
220 To prevent loops and shooting yourself in the foot in interesting ways the
221 nesting is limited to a depth of 8E<nbsp>levels, which should be sufficient for
222 most uses. Since symlinks are followed it is still possible to crash the daemon
223 by looping symlinks. In our opinion significant stupidity should result in an
224 appropriate amount of pain.
226 It is no problem to have a block like C<E<lt>Plugin fooE<gt>> in more than one
227 file, but you cannot include files from within blocks.
229 =item B<PIDFile> I<File>
231 Sets where to write the PID file to. This file is overwritten when it exists
232 and deleted when the program is stopped. Some init-scripts might override this
233 setting using the B<-P> command-line option.
235 =item B<PluginDir> I<Directory>
237 Path to the plugins (shared objects) of collectd.
239 =item B<TypesDB> I<File> [I<File> ...]
241 Set one or more files that contain the data-set descriptions. See
242 L<types.db(5)> for a description of the format of this file.
244 If this option is not specified, a default file is read. If you need to define
245 custom types in addition to the types defined in the default file, you need to
246 explicitly load both. In other words, if the B<TypesDB> option is encountered
247 the default behavior is disabled and if you need the default types you have to
248 also explicitly load them.
250 =item B<Interval> I<Seconds>
252 Configures the interval in which to query the read plugins. Obviously smaller
253 values lead to a higher system load produced by collectd, while higher values
254 lead to more coarse statistics.
256 B<Warning:> You should set this once and then never touch it again. If you do,
257 I<you will have to delete all your RRD files> or know some serious RRDtool
258 magic! (Assuming you're using the I<RRDtool> or I<RRDCacheD> plugin.)
260 =item B<MaxReadInterval> I<Seconds>
262 A read plugin doubles the interval between queries after each failed attempt
265 This options limits the maximum value of the interval. The default value is
268 =item B<Timeout> I<Iterations>
270 Consider a value list "missing" when no update has been read or received for
271 I<Iterations> iterations. By default, I<collectd> considers a value list
272 missing when no update has been received for twice the update interval. Since
273 this setting uses iterations, the maximum allowed time without update depends
274 on the I<Interval> information contained in each value list. This is used in
275 the I<Threshold> configuration to dispatch notifications about missing values,
276 see L<collectd-threshold(5)> for details.
278 =item B<ReadThreads> I<Num>
280 Number of threads to start for reading plugins. The default value is B<5>, but
281 you may want to increase this if you have more than five plugins that take a
282 long time to read. Mostly those are plugins that do network-IO. Setting this to
283 a value higher than the number of registered read callbacks is not recommended.
285 =item B<WriteThreads> I<Num>
287 Number of threads to start for dispatching value lists to write plugins. The
288 default value is B<5>, but you may want to increase this if you have more than
289 five plugins that may take relatively long to write to.
291 =item B<WriteQueueLimitHigh> I<HighNum>
293 =item B<WriteQueueLimitLow> I<LowNum>
295 Metrics are read by the I<read threads> and then put into a queue to be handled
296 by the I<write threads>. If one of the I<write plugins> is slow (e.g. network
297 timeouts, I/O saturation of the disk) this queue will grow. In order to avoid
298 running into memory issues in such a case, you can limit the size of this
301 By default, there is no limit and memory may grow indefinitely. This is most
302 likely not an issue for clients, i.e. instances that only handle the local
303 metrics. For servers it is recommended to set this to a non-zero value, though.
305 You can set the limits using B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>.
306 Each of them takes a numerical argument which is the number of metrics in the
307 queue. If there are I<HighNum> metrics in the queue, any new metrics I<will> be
308 dropped. If there are less than I<LowNum> metrics in the queue, all new metrics
309 I<will> be enqueued. If the number of metrics currently in the queue is between
310 I<LowNum> and I<HighNum>, the metric is dropped with a probability that is
311 proportional to the number of metrics in the queue (i.e. it increases linearly
312 until it reaches 100%.)
314 If B<WriteQueueLimitHigh> is set to non-zero and B<WriteQueueLimitLow> is
315 unset, the latter will default to half of B<WriteQueueLimitHigh>.
317 If you do not want to randomly drop values when the queue size is between
318 I<LowNum> and I<HighNum>, set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow>
321 Enabling the B<CollectInternalStats> option is of great help to figure out the
322 values to set B<WriteQueueLimitHigh> and B<WriteQueueLimitLow> to.
324 =item B<Hostname> I<Name>
326 Sets the hostname that identifies a host. If you omit this setting, the
327 hostname will be determined using the L<gethostname(2)> system call.
329 =item B<FQDNLookup> B<true|false>
331 If B<Hostname> is determined automatically this setting controls whether or not
332 the daemon should try to figure out the "fully qualified domain name", FQDN.
333 This is done using a lookup of the name returned by C<gethostname>. This option
334 is enabled by default.
336 =item B<PreCacheChain> I<ChainName>
338 =item B<PostCacheChain> I<ChainName>
340 Configure the name of the "pre-cache chain" and the "post-cache chain". Please
341 see L</"FILTER CONFIGURATION"> below on information on chains and how these
342 setting change the daemon's behavior.
346 =head1 PLUGIN OPTIONS
348 Some plugins may register own options. These options must be enclosed in a
349 C<Plugin>-Section. Which options exist depends on the plugin used. Some plugins
350 require external configuration, too. The C<apache plugin>, for example,
351 required C<mod_status> to be configured in the webserver you're going to
352 collect data from. These plugins are listed below as well, even if they don't
353 require any configuration within collectd's configuration file.
355 A list of all plugins and a short summary for each plugin can be found in the
356 F<README> file shipped with the sourcecode and hopefully binary packets as
359 =head2 Plugin C<aggregation>
361 The I<Aggregation plugin> makes it possible to aggregate several values into
362 one using aggregation functions such as I<sum>, I<average>, I<min> and I<max>.
363 This can be put to a wide variety of uses, e.g. average and total CPU
364 statistics for your entire fleet.
366 The grouping is powerful but, as with many powerful tools, may be a bit
367 difficult to wrap your head around. The grouping will therefore be
368 demonstrated using an example: The average and sum of the CPU usage across
369 all CPUs of each host is to be calculated.
371 To select all the affected values for our example, set C<Plugin cpu> and
372 C<Type cpu>. The other values are left unspecified, meaning "all values". The
373 I<Host>, I<Plugin>, I<PluginInstance>, I<Type> and I<TypeInstance> options
374 work as if they were specified in the C<WHERE> clause of an C<SELECT> SQL
380 Although the I<Host>, I<PluginInstance> (CPU number, i.e. 0, 1, 2, ...) and
381 I<TypeInstance> (idle, user, system, ...) fields are left unspecified in the
382 example, the intention is to have a new value for each host / type instance
383 pair. This is achieved by "grouping" the values using the C<GroupBy> option.
384 It can be specified multiple times to group by more than one field.
387 GroupBy "TypeInstance"
389 We do neither specify nor group by I<plugin instance> (the CPU number), so all
390 metrics that differ in the CPU number only will be aggregated. Each
391 aggregation needs I<at least one> such field, otherwise no aggregation would
394 The full example configuration looks like this:
396 <Plugin "aggregation">
402 GroupBy "TypeInstance"
405 CalculateAverage true
409 There are a couple of limitations you should be aware of:
415 The I<Type> cannot be left unspecified, because it is not reasonable to add
416 apples to oranges. Also, the internal lookup structure won't work if you try
421 There must be at least one unspecified, ungrouped field. Otherwise nothing
426 As you can see in the example above, each aggregation has its own
427 B<Aggregation> block. You can have multiple aggregation blocks and aggregation
428 blocks may match the same values, i.e. one value list can update multiple
429 aggregations. The following options are valid inside B<Aggregation> blocks:
433 =item B<Host> I<Host>
435 =item B<Plugin> I<Plugin>
437 =item B<PluginInstance> I<PluginInstance>
439 =item B<Type> I<Type>
441 =item B<TypeInstance> I<TypeInstance>
443 Selects the value lists to be added to this aggregation. B<Type> must be a
444 valid data set name, see L<types.db(5)> for details.
446 If the string starts with and ends with a slash (C</>), the string is
447 interpreted as a I<regular expression>. The regex flavor used are POSIX
448 extended regular expressions as described in L<regex(7)>. Example usage:
450 Host "/^db[0-9]\\.example\\.com$/"
452 =item B<GroupBy> B<Host>|B<Plugin>|B<PluginInstance>|B<TypeInstance>
454 Group valued by the specified field. The B<GroupBy> option may be repeated to
455 group by multiple fields.
457 =item B<SetHost> I<Host>
459 =item B<SetPlugin> I<Plugin>
461 =item B<SetPluginInstance> I<PluginInstance>
463 =item B<SetTypeInstance> I<TypeInstance>
465 Sets the appropriate part of the identifier to the provided string.
467 The I<PluginInstance> should include the placeholder C<%{aggregation}> which
468 will be replaced with the aggregation function, e.g. "average". Not including
469 the placeholder will result in duplication warnings and/or messed up values if
470 more than one aggregation function are enabled.
472 The following example calculates the average usage of all "even" CPUs:
474 <Plugin "aggregation">
477 PluginInstance "/[0,2,4,6,8]$/"
481 SetPluginInstance "even-%{aggregation}"
484 GroupBy "TypeInstance"
486 CalculateAverage true
490 This will create the files:
496 foo.example.com/cpu-even-average/cpu-idle
500 foo.example.com/cpu-even-average/cpu-system
504 foo.example.com/cpu-even-average/cpu-user
512 =item B<CalculateNum> B<true>|B<false>
514 =item B<CalculateSum> B<true>|B<false>
516 =item B<CalculateAverage> B<true>|B<false>
518 =item B<CalculateMinimum> B<true>|B<false>
520 =item B<CalculateMaximum> B<true>|B<false>
522 =item B<CalculateStddev> B<true>|B<false>
524 Boolean options for enabling calculation of the number of value lists, their
525 sum, average, minimum, maximum andE<nbsp>/ or standard deviation. All options
526 are disabled by default.
530 =head2 Plugin C<amqp>
532 The I<AMQP plugin> can be used to communicate with other instances of
533 I<collectd> or third party applications using an AMQP message broker. Values
534 are sent to or received from the broker, which handles routing, queueing and
535 possibly filtering out messages.
540 # Send values to an AMQP broker
541 <Publish "some_name">
547 Exchange "amq.fanout"
548 # ExchangeType "fanout"
549 # RoutingKey "collectd"
551 # ConnectionRetryDelay 0
554 # GraphitePrefix "collectd."
555 # GraphiteEscapeChar "_"
556 # GraphiteSeparateInstances false
557 # GraphiteAlwaysAppendDS false
558 # GraphitePreserveSeparator false
561 # Receive values from an AMQP broker
562 <Subscribe "some_name">
568 Exchange "amq.fanout"
569 # ExchangeType "fanout"
572 # QueueAutoDelete true
573 # RoutingKey "collectd.#"
574 # ConnectionRetryDelay 0
578 The plugin's configuration consists of a number of I<Publish> and I<Subscribe>
579 blocks, which configure sending and receiving of values respectively. The two
580 blocks are very similar, so unless otherwise noted, an option can be used in
581 either block. The name given in the blocks starting tag is only used for
582 reporting messages, but may be used to support I<flushing> of certain
583 I<Publish> blocks in the future.
587 =item B<Host> I<Host>
589 Hostname or IP-address of the AMQP broker. Defaults to the default behavior of
590 the underlying communications library, I<rabbitmq-c>, which is "localhost".
592 =item B<Port> I<Port>
594 Service name or port number on which the AMQP broker accepts connections. This
595 argument must be a string, even if the numeric form is used. Defaults to
598 =item B<VHost> I<VHost>
600 Name of the I<virtual host> on the AMQP broker to use. Defaults to "/".
602 =item B<User> I<User>
604 =item B<Password> I<Password>
606 Credentials used to authenticate to the AMQP broker. By default "guest"/"guest"
609 =item B<Exchange> I<Exchange>
611 In I<Publish> blocks, this option specifies the I<exchange> to send values to.
612 By default, "amq.fanout" will be used.
614 In I<Subscribe> blocks this option is optional. If given, a I<binding> between
615 the given exchange and the I<queue> is created, using the I<routing key> if
616 configured. See the B<Queue> and B<RoutingKey> options below.
618 =item B<ExchangeType> I<Type>
620 If given, the plugin will try to create the configured I<exchange> with this
621 I<type> after connecting. When in a I<Subscribe> block, the I<queue> will then
622 be bound to this exchange.
624 =item B<Queue> I<Queue> (Subscribe only)
626 Configures the I<queue> name to subscribe to. If no queue name was configured
627 explicitly, a unique queue name will be created by the broker.
629 =item B<QueueDurable> B<true>|B<false> (Subscribe only)
631 Defines if the I<queue> subscribed to is durable (saved to persistent storage)
632 or transient (will disappear if the AMQP broker is restarted). Defaults to
635 This option should be used in conjunction with the I<Persistent> option on the
638 =item B<QueueAutoDelete> B<true>|B<false> (Subscribe only)
640 Defines if the I<queue> subscribed to will be deleted once the last consumer
641 unsubscribes. Defaults to "true".
643 =item B<RoutingKey> I<Key>
645 In I<Publish> blocks, this configures the routing key to set on all outgoing
646 messages. If not given, the routing key will be computed from the I<identifier>
647 of the value. The host, plugin, type and the two instances are concatenated
648 together using dots as the separator and all containing dots replaced with
649 slashes. For example "collectd.host/example/com.cpu.0.cpu.user". This makes it
650 possible to receive only specific values using a "topic" exchange.
652 In I<Subscribe> blocks, configures the I<routing key> used when creating a
653 I<binding> between an I<exchange> and the I<queue>. The usual wildcards can be
654 used to filter messages when using a "topic" exchange. If you're only
655 interested in CPU statistics, you could use the routing key "collectd.*.cpu.#"
658 =item B<Persistent> B<true>|B<false> (Publish only)
660 Selects the I<delivery method> to use. If set to B<true>, the I<persistent>
661 mode will be used, i.e. delivery is guaranteed. If set to B<false> (the
662 default), the I<transient> delivery mode will be used, i.e. messages may be
663 lost due to high load, overflowing queues or similar issues.
665 =item B<ConnectionRetryDelay> I<Delay>
667 When the connection to the AMQP broker is lost, defines the time in seconds to
668 wait before attempting to reconnect. Defaults to 0, which implies collectd will
669 attempt to reconnect at each read interval (in Subscribe mode) or each time
670 values are ready for submission (in Publish mode).
672 =item B<Format> B<Command>|B<JSON>|B<Graphite> (Publish only)
674 Selects the format in which messages are sent to the broker. If set to
675 B<Command> (the default), values are sent as C<PUTVAL> commands which are
676 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
677 case, the C<Content-Type> header field will be set to C<text/collectd>.
679 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
680 an easy and straight forward exchange format. The C<Content-Type> header field
681 will be set to C<application/json>.
683 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
684 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
687 A subscribing client I<should> use the C<Content-Type> header field to
688 determine how to decode the values. Currently, the I<AMQP plugin> itself can
689 only decode the B<Command> format.
691 =item B<StoreRates> B<true>|B<false> (Publish only)
693 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
694 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
695 default), no conversion is performed. Otherwise the conversion is performed
696 using the internal value cache.
698 Please note that currently this option is only used if the B<Format> option has
701 =item B<GraphitePrefix> (Publish and B<Format>=I<Graphite> only)
703 A prefix can be added in the metric name when outputting in the I<Graphite> format.
704 It's added before the I<Host> name.
705 Metric name will be "<prefix><host><postfix><plugin><type><name>"
707 =item B<GraphitePostfix> (Publish and B<Format>=I<Graphite> only)
709 A postfix can be added in the metric name when outputting in the I<Graphite> format.
710 It's added after the I<Host> name.
711 Metric name will be "<prefix><host><postfix><plugin><type><name>"
713 =item B<GraphiteEscapeChar> (Publish and B<Format>=I<Graphite> only)
715 Specify a character to replace dots (.) in the host part of the metric name.
716 In I<Graphite> metric name, dots are used as separators between different
717 metric parts (host, plugin, type).
718 Default is "_" (I<Underscore>).
720 =item B<GraphiteSeparateInstances> B<true>|B<false>
722 If set to B<true>, the plugin instance and type instance will be in their own
723 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
724 default), the plugin and plugin instance (and likewise the type and type
725 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
727 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
729 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
730 identifier. If set to B<false> (the default), this is only done when there is
733 =item B<GraphitePreserveSeparator> B<false>|B<true>
735 If set to B<false> (the default) the C<.> (dot) character is replaced with
736 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
737 is preserved, i.e. passed through.
741 =head2 Plugin C<apache>
743 To configure the C<apache>-plugin you first need to configure the Apache
744 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
745 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
746 the following snipped to base your Apache config upon:
749 <IfModule mod_status.c>
750 <Location /mod_status>
751 SetHandler server-status
755 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
756 also supported. It introduces a new field, called C<BusyServers>, to count the
757 number of currently connected clients. This field is also supported.
759 The configuration of the I<Apache> plugin consists of one or more
760 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
761 as the instance name. For example:
765 URL "http://www1.example.com/mod_status?auto"
768 URL "http://www2.example.com/mod_status?auto"
772 The instance name will be used as the I<plugin instance>. To emulate the old
773 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
774 plugin to work correctly, each instance name must be unique. This is not
775 enforced by the plugin and it is your responsibility to ensure it.
777 The following options are accepted within each I<Instance> block:
781 =item B<URL> I<http://host/mod_status?auto>
783 Sets the URL of the C<mod_status> output. This needs to be the output generated
784 by C<ExtendedStatus on> and it needs to be the machine readable output
785 generated by appending the C<?auto> argument. This option is I<mandatory>.
787 =item B<User> I<Username>
789 Optional user name needed for authentication.
791 =item B<Password> I<Password>
793 Optional password needed for authentication.
795 =item B<VerifyPeer> B<true|false>
797 Enable or disable peer SSL certificate verification. See
798 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
800 =item B<VerifyHost> B<true|false>
802 Enable or disable peer host name verification. If enabled, the plugin checks
803 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
804 certificate matches the host name provided by the B<URL> option. If this
805 identity check fails, the connection is aborted. Obviously, only works when
806 connecting to a SSL enabled server. Enabled by default.
808 =item B<CACert> I<File>
810 File that holds one or more SSL certificates. If you want to use HTTPS you will
811 possibly need this option. What CA certificates come bundled with C<libcurl>
812 and are checked by default depends on the distribution you use.
814 =item B<SSLCiphers> I<list of ciphers>
816 Specifies which ciphers to use in the connection. The list of ciphers
817 must specify valid ciphers. See
818 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
820 =item B<Timeout> I<Milliseconds>
822 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
823 milliseconds. By default, the configured B<Interval> is used to set the
828 =head2 Plugin C<apcups>
832 =item B<Host> I<Hostname>
834 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
835 that IPv6 support has been disabled unless someone can confirm or decline that
836 B<apcupsd> can handle it.
838 =item B<Port> I<Port>
840 TCP-Port to connect to. Defaults to B<3551>.
842 =item B<ReportSeconds> B<true>|B<false>
844 If set to B<true>, the time reported in the C<timeleft> metric will be
845 converted to seconds. This is the recommended setting. If set to B<false>, the
846 default for backwards compatibility, the time will be reported in minutes.
848 =item B<PersistentConnection> B<true>|B<false>
850 The plugin is designed to keep the connection to I<apcupsd> open between reads.
851 If plugin poll interval is greater than 15 seconds (hardcoded socket close
852 timeout in I<apcupsd> NIS), then this option is B<false> by default.
854 You can instruct the plugin to close the connection after each read by setting
855 this option to B<false> or force keeping the connection by setting it to B<true>.
857 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
858 the plugin will try to detect this problem and switch to an open-read-close mode.
862 =head2 Plugin C<aquaero>
864 This plugin collects the value of the available sensors in an
865 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
866 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
867 connection for monitoring and configuration. The board can handle multiple
868 temperature sensors, fans, water pumps and water level sensors and adjust the
869 output settings such as fan voltage or power used by the water pump based on
870 the available inputs using a configurable controller included in the board.
871 This plugin collects all the available inputs as well as some of the output
872 values chosen by this controller. The plugin is based on the I<libaquaero5>
873 library provided by I<aquatools-ng>.
877 =item B<Device> I<DevicePath>
879 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
880 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
881 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
885 =head2 Plugin C<ascent>
887 This plugin collects information about an Ascent server, a free server for the
888 "World of Warcraft" game. This plugin gathers the information by fetching the
889 XML status page using C<libcurl> and parses it using C<libxml2>.
891 The configuration options are the same as for the C<apache> plugin above:
895 =item B<URL> I<http://localhost/ascent/status/>
897 Sets the URL of the XML status output.
899 =item B<User> I<Username>
901 Optional user name needed for authentication.
903 =item B<Password> I<Password>
905 Optional password needed for authentication.
907 =item B<VerifyPeer> B<true|false>
909 Enable or disable peer SSL certificate verification. See
910 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
912 =item B<VerifyHost> B<true|false>
914 Enable or disable peer host name verification. If enabled, the plugin checks
915 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
916 certificate matches the host name provided by the B<URL> option. If this
917 identity check fails, the connection is aborted. Obviously, only works when
918 connecting to a SSL enabled server. Enabled by default.
920 =item B<CACert> I<File>
922 File that holds one or more SSL certificates. If you want to use HTTPS you will
923 possibly need this option. What CA certificates come bundled with C<libcurl>
924 and are checked by default depends on the distribution you use.
926 =item B<Timeout> I<Milliseconds>
928 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
929 milliseconds. By default, the configured B<Interval> is used to set the
934 =head2 Plugin C<barometer>
936 This plugin reads absolute air pressure using digital barometer sensor on a I2C
937 bus. Supported sensors are:
941 =item I<MPL115A2> from Freescale,
942 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
945 =item I<MPL3115> from Freescale
946 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
949 =item I<BMP085> from Bosch Sensortec
953 The sensor type - one of the above - is detected automatically by the plugin
954 and indicated in the plugin_instance (you will see subdirectory
955 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
956 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
957 (only one sensor can be used by the plugin).
959 The plugin provides absolute barometric pressure, air pressure reduced to sea
960 level (several possible approximations) and as an auxiliary value also internal
961 sensor temperature. It uses (expects/provides) typical metric units - pressure
962 in [hPa], temperature in [C], altitude in [m].
964 It was developed and tested under Linux only. The only platform dependency is
965 the standard Linux i2c-dev interface (the particular bus driver has to
966 support the SM Bus command subset).
968 The reduction or normalization to mean sea level pressure requires (depending
969 on selected method/approximation) also altitude and reference to temperature
970 sensor(s). When multiple temperature sensors are configured the minimum of
971 their values is always used (expecting that the warmer ones are affected by
972 e.g. direct sun light at that moment).
980 TemperatureOffset 0.0
983 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
988 =item B<Device> I<device>
990 The only mandatory configuration parameter.
992 Device name of the I2C bus to which the sensor is connected. Note that
993 typically you need to have loaded the i2c-dev module.
994 Using i2c-tools you can check/list i2c buses available on your system by:
998 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1002 This way you should be able to verify that the pressure sensor (either type) is
1003 connected and detected on address 0x60.
1005 =item B<Oversampling> I<value>
1007 Optional parameter controlling the oversampling/accuracy. Default value
1008 is 1 providing fastest and least accurate reading.
1010 For I<MPL115> this is the size of the averaging window. To filter out sensor
1011 noise a simple averaging using floating window of this configurable size is
1012 used. The plugin will use average of the last C<value> measurements (value of 1
1013 means no averaging). Minimal size is 1, maximal 1024.
1015 For I<MPL3115> this is the oversampling value. The actual oversampling is
1016 performed by the sensor and the higher value the higher accuracy and longer
1017 conversion time (although nothing to worry about in the collectd context).
1018 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1019 adjusted by the plugin to the closest supported one.
1021 For I<BMP085> this is the oversampling value. The actual oversampling is
1022 performed by the sensor and the higher value the higher accuracy and longer
1023 conversion time (although nothing to worry about in the collectd context).
1024 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1025 the closest supported one.
1027 =item B<PressureOffset> I<offset>
1029 Optional parameter for MPL3115 only.
1031 You can further calibrate the sensor by supplying pressure and/or temperature
1032 offsets. This is added to the measured/caclulated value (i.e. if the measured
1033 value is too high then use negative offset).
1034 In hPa, default is 0.0.
1036 =item B<TemperatureOffset> I<offset>
1038 Optional parameter for MPL3115 only.
1040 You can further calibrate the sensor by supplying pressure and/or temperature
1041 offsets. This is added to the measured/caclulated value (i.e. if the measured
1042 value is too high then use negative offset).
1043 In C, default is 0.0.
1045 =item B<Normalization> I<method>
1047 Optional parameter, default value is 0.
1049 Normalization method - what approximation/model is used to compute the mean sea
1050 level pressure from the air absolute pressure.
1052 Supported values of the C<method> (integer between from 0 to 2) are:
1056 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1057 do not need to configure C<Altitude> or C<TemperatureSensor>.
1059 =item B<1> - international formula for conversion ,
1061 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1062 For this method you have to configure C<Altitude> but do not need
1063 C<TemperatureSensor> (uses fixed global temperature average instead).
1065 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1066 Meteorological Service).
1067 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1068 For this method you have to configure both C<Altitude> and
1069 C<TemperatureSensor>.
1074 =item B<Altitude> I<altitude>
1076 The altitude (in meters) of the location where you meassure the pressure.
1078 =item B<TemperatureSensor> I<reference>
1080 Temperature sensor(s) which should be used as a reference when normalizing the
1081 pressure using C<Normalization> method 2.
1082 When specified more sensors a minimum is found and used each time. The
1083 temperature reading directly from this pressure sensor/plugin is typically not
1084 suitable as the pressure sensor will be probably inside while we want outside
1085 temperature. The collectd reference name is something like
1086 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1087 (<type_instance> is usually omitted when there is just single value type). Or
1088 you can figure it out from the path of the output data files.
1092 =head2 Plugin C<battery>
1094 The I<battery plugin> reports the remaining capacity, power and voltage of
1099 =item B<ValuesPercentage> B<false>|B<true>
1101 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1102 capacity remaining". Otherwise the capacity is stored as reported by the
1103 battery, most likely in "Wh". This option does not work with all input methods,
1104 in particular when only C</proc/pmu> is available on an old Linux system.
1105 Defaults to B<false>.
1107 =item B<ReportDegraded> B<false>|B<true>
1109 Typical laptop batteries degrade over time, meaning the capacity decreases with
1110 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1111 "last full capacity" and used to determine that a battery is "fully charged".
1113 When this option is set to B<false>, the default, the I<battery plugin> will
1114 only report the remaining capacity. If the B<ValuesPercentage> option is
1115 enabled, the relative remaining capacity is calculated as the ratio of the
1116 "remaining capacity" and the "last full capacity". This is what most tools,
1117 such as the status bar of desktop environments, also do.
1119 When set to B<true>, the battery plugin will report three values: B<charged>
1120 (remaining capacity), B<discharged> (difference between "last full capacity"
1121 and "remaining capacity") and B<degraded> (difference between "design capacity"
1122 and "last full capacity").
1124 =item B<QueryStateFS> B<false>|B<true>
1126 When set to B<true>, the battery plugin will only read statistics
1127 related to battery performance as exposed by StateFS at
1128 /run/state. StateFS is used in Mer-based Sailfish OS, for
1133 =head2 Plugin C<bind>
1135 Starting with BIND 9.5.0, the most widely used DNS server software provides
1136 extensive statistics about queries, responses and lots of other information.
1137 The bind plugin retrieves this information that's encoded in XML and provided
1138 via HTTP and submits the values to collectd.
1140 To use this plugin, you first need to tell BIND to make this information
1141 available. This is done with the C<statistics-channels> configuration option:
1143 statistics-channels {
1144 inet localhost port 8053;
1147 The configuration follows the grouping that can be seen when looking at the
1148 data with an XSLT compatible viewer, such as a modern web browser. It's
1149 probably a good idea to make yourself familiar with the provided values, so you
1150 can understand what the collected statistics actually mean.
1155 URL "http://localhost:8053/"
1170 Zone "127.in-addr.arpa/IN"
1174 The bind plugin accepts the following configuration options:
1180 URL from which to retrieve the XML data. If not specified,
1181 C<http://localhost:8053/> will be used.
1183 =item B<ParseTime> B<true>|B<false>
1185 When set to B<true>, the time provided by BIND will be parsed and used to
1186 dispatch the values. When set to B<false>, the local time source is queried.
1188 This setting is set to B<true> by default for backwards compatibility; setting
1189 this to B<false> is I<recommended> to avoid problems with timezones and
1192 =item B<OpCodes> B<true>|B<false>
1194 When enabled, statistics about the I<"OpCodes">, for example the number of
1195 C<QUERY> packets, are collected.
1199 =item B<QTypes> B<true>|B<false>
1201 When enabled, the number of I<incoming> queries by query types (for example
1202 C<A>, C<MX>, C<AAAA>) is collected.
1206 =item B<ServerStats> B<true>|B<false>
1208 Collect global server statistics, such as requests received over IPv4 and IPv6,
1209 successful queries, and failed updates.
1213 =item B<ZoneMaintStats> B<true>|B<false>
1215 Collect zone maintenance statistics, mostly information about notifications
1216 (zone updates) and zone transfers.
1220 =item B<ResolverStats> B<true>|B<false>
1222 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1223 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1224 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1225 default. Use the B<ResolverStats> option within a B<View "_default"> block
1226 instead for the same functionality.
1230 =item B<MemoryStats>
1232 Collect global memory statistics.
1236 =item B<Timeout> I<Milliseconds>
1238 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1239 milliseconds. By default, the configured B<Interval> is used to set the
1242 =item B<View> I<Name>
1244 Collect statistics about a specific I<"view">. BIND can behave different,
1245 mostly depending on the source IP-address of the request. These different
1246 configurations are called "views". If you don't use this feature, you most
1247 likely are only interested in the C<_default> view.
1249 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1250 information you want to collect about a view. If no B<View> block is
1251 configured, no detailed view statistics will be collected.
1255 =item B<QTypes> B<true>|B<false>
1257 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1258 C<MX>) is collected.
1262 =item B<ResolverStats> B<true>|B<false>
1264 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1265 (e.E<nbsp>g. queries over IPv4, lame servers).
1269 =item B<CacheRRSets> B<true>|B<false>
1271 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1272 type is collected. Negative entries (queries which resulted in an error, for
1273 example names that do not exist) are reported with a leading exclamation mark,
1278 =item B<Zone> I<Name>
1280 When given, collect detailed information about the given zone in the view. The
1281 information collected if very similar to the global B<ServerStats> information
1284 You can repeat this option to collect detailed information about multiple
1287 By default no detailed zone information is collected.
1293 =head2 Plugin C<ceph>
1295 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1296 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1298 A separate B<Daemon> block must be configured for each ceph daemon to be
1299 monitored. The following example will read daemon statistics from four
1300 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1303 LongRunAvgLatency false
1304 ConvertSpecialMetricTypes true
1306 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1309 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1312 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1315 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1319 The ceph plugin accepts the following configuration options:
1323 =item B<LongRunAvgLatency> B<true>|B<false>
1325 If enabled, latency values(sum,count pairs) are calculated as the long run
1326 average - average since the ceph daemon was started = (sum / count).
1327 When disabled, latency values are calculated as the average since the last
1328 collection = (sum_now - sum_last) / (count_now - count_last).
1332 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1334 If enabled, special metrics (metrics that differ in type from similar counters)
1335 are converted to the type of those similar counters. This currently only
1336 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1337 ceph schema reports this metric type as a sum,count pair while similar counters
1338 are treated as derive types. When converted, the sum is used as the counter
1339 value and is treated as a derive type.
1340 When disabled, all metrics are treated as the types received from the ceph schema.
1346 Each B<Daemon> block must have a string argument for the plugin instance name.
1347 A B<SocketPath> is also required for each B<Daemon> block:
1351 =item B<Daemon> I<DaemonName>
1353 Name to be used as the instance name for this daemon.
1355 =item B<SocketPath> I<SocketPath>
1357 Specifies the path to the UNIX admin socket of the ceph daemon.
1361 =head2 Plugin C<cgroups>
1363 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1364 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1365 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1369 =item B<CGroup> I<Directory>
1371 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1372 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1375 See F</"IGNORELISTS"> for details.
1377 =item B<IgnoreSelected> B<true>|B<false>
1379 Invert the selection: If set to true, all cgroups I<except> the ones that
1380 match any one of the criteria are collected. By default only selected
1381 cgroups are collected if a selection is made. If no selection is configured
1382 at all, B<all> cgroups are selected.
1386 =head2 Plugin C<chrony>
1388 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1389 skew and per-peer stratum.
1391 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1394 Available configuration options for the C<chrony> plugin:
1398 =item B<Host> I<Hostname>
1400 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1402 =item B<Port> I<Port>
1404 UDP-Port to connect to. Defaults to B<323>.
1406 =item B<Timeout> I<Timeout>
1408 Connection timeout in seconds. Defaults to B<2>.
1412 =head2 Plugin C<conntrack>
1414 This plugin collects IP conntrack statistics.
1420 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1421 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1425 =head2 Plugin C<cpu>
1427 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1428 as Jiffies, using the C<cpu> type. Two aggregations are available:
1434 Sum, per-state, over all CPUs installed in the system; and
1438 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1442 The two aggregations can be combined, leading to I<collectd> only emitting a
1443 single "active" metric for the entire system. As soon as one of these
1444 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1445 rather than Jiffies. In addition, you can request individual, per-state,
1446 per-CPU metrics to be reported as percentage.
1448 The following configuration options are available:
1452 =item B<ReportByState> B<true>|B<false>
1454 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1456 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1459 =item B<ReportByCpu> B<true>|B<false>
1461 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1462 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1463 global sum of CPU states is emitted.
1465 =item B<ValuesPercentage> B<false>|B<true>
1467 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1468 are set to B<true>. In this case, by default, metrics will be reported as
1469 Jiffies. By setting this option to B<true>, you can request percentage values
1470 in the un-aggregated (per-CPU, per-state) mode as well.
1472 =item B<ReportNumCpu> B<false>|B<true>
1474 When set to B<true>, reports the number of available CPUs.
1475 Defaults to B<false>.
1477 =item B<ReportGuestState> B<false>|B<true>
1479 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1480 Defaults to B<false>.
1482 =item B<SubtractGuestState> B<false>|B<true>
1484 This option is only considered when B<ReportGuestState> is set to B<true>.
1485 "guest" and "guest_nice" are included in respectively "user" and "nice".
1486 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1487 will be subtracted from "nice".
1488 Defaults to B<true>.
1492 =head2 Plugin C<cpufreq>
1494 This plugin doesn't have any options. It reads
1495 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1496 installed) to get the current CPU frequency. If this file does not exist make
1497 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1498 installed and an "cpu governor" (that's a kernel module) is loaded.
1500 =head2 Plugin C<cpusleep>
1502 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1503 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1504 BOOTTIME clock increments while device is suspended and MONOTONIC
1505 clock does not, the derivative of the difference between these clocks
1506 gives the relative amount of time the device has spent in suspend
1507 state. The recorded value is in milliseconds of sleep per seconds of
1510 =head2 Plugin C<csv>
1514 =item B<DataDir> I<Directory>
1516 Set the directory to store CSV-files under. Per default CSV-files are generated
1517 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1518 The special strings B<stdout> and B<stderr> can be used to write to the standard
1519 output and standard error channels, respectively. This, of course, only makes
1520 much sense when collectd is running in foreground- or non-daemon-mode.
1522 =item B<StoreRates> B<true|false>
1524 If set to B<true>, convert counter values to rates. If set to B<false> (the
1525 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1530 =head2 cURL Statistics
1532 All cURL-based plugins support collection of generic, request-based
1533 statistics. These are disabled by default and can be enabled selectively for
1534 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1535 the documentation of those plugins for specific information. This section
1536 describes the available metrics that can be configured for each plugin. All
1537 options are disabled by default.
1539 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1543 =item B<TotalTime> B<true|false>
1545 Total time of the transfer, including name resolving, TCP connect, etc.
1547 =item B<NamelookupTime> B<true|false>
1549 Time it took from the start until name resolving was completed.
1551 =item B<ConnectTime> B<true|false>
1553 Time it took from the start until the connect to the remote host (or proxy)
1556 =item B<AppconnectTime> B<true|false>
1558 Time it took from the start until the SSL/SSH connect/handshake to the remote
1561 =item B<PretransferTime> B<true|false>
1563 Time it took from the start until just before the transfer begins.
1565 =item B<StarttransferTime> B<true|false>
1567 Time it took from the start until the first byte was received.
1569 =item B<RedirectTime> B<true|false>
1571 Time it took for all redirection steps include name lookup, connect,
1572 pre-transfer and transfer before final transaction was started.
1574 =item B<RedirectCount> B<true|false>
1576 The total number of redirections that were actually followed.
1578 =item B<SizeUpload> B<true|false>
1580 The total amount of bytes that were uploaded.
1582 =item B<SizeDownload> B<true|false>
1584 The total amount of bytes that were downloaded.
1586 =item B<SpeedDownload> B<true|false>
1588 The average download speed that curl measured for the complete download.
1590 =item B<SpeedUpload> B<true|false>
1592 The average upload speed that curl measured for the complete upload.
1594 =item B<HeaderSize> B<true|false>
1596 The total size of all the headers received.
1598 =item B<RequestSize> B<true|false>
1600 The total size of the issued requests.
1602 =item B<ContentLengthDownload> B<true|false>
1604 The content-length of the download.
1606 =item B<ContentLengthUpload> B<true|false>
1608 The specified size of the upload.
1610 =item B<NumConnects> B<true|false>
1612 The number of new connections that were created to achieve the transfer.
1616 =head2 Plugin C<curl>
1618 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1619 and the match infrastructure (the same code used by the tail plugin) to use
1620 regular expressions with the received data.
1622 The following example will read the current value of AMD stock from Google's
1623 finance page and dispatch the value to collectd.
1626 <Page "stock_quotes">
1627 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1633 CACert "/path/to/ca.crt"
1634 Header "X-Custom-Header: foobar"
1637 MeasureResponseTime false
1638 MeasureResponseCode false
1641 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1642 DSType "GaugeAverage"
1643 # Note: `stock_value' is not a standard type.
1650 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1651 a web page and one or more "matches" to be performed on the returned data. The
1652 string argument to the B<Page> block is used as plugin instance.
1654 The following options are valid within B<Page> blocks:
1660 URL of the web site to retrieve. Since a regular expression will be used to
1661 extract information from this data, non-binary data is a big plus here ;)
1663 =item B<User> I<Name>
1665 Username to use if authorization is required to read the page.
1667 =item B<Password> I<Password>
1669 Password to use if authorization is required to read the page.
1671 =item B<Digest> B<true>|B<false>
1673 Enable HTTP digest authentication.
1675 =item B<VerifyPeer> B<true>|B<false>
1677 Enable or disable peer SSL certificate verification. See
1678 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1680 =item B<VerifyHost> B<true>|B<false>
1682 Enable or disable peer host name verification. If enabled, the plugin checks if
1683 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1684 matches the host name provided by the B<URL> option. If this identity check
1685 fails, the connection is aborted. Obviously, only works when connecting to a
1686 SSL enabled server. Enabled by default.
1688 =item B<CACert> I<file>
1690 File that holds one or more SSL certificates. If you want to use HTTPS you will
1691 possibly need this option. What CA certificates come bundled with C<libcurl>
1692 and are checked by default depends on the distribution you use.
1694 =item B<Header> I<Header>
1696 A HTTP header to add to the request. Multiple headers are added if this option
1697 is specified more than once.
1699 =item B<Post> I<Body>
1701 Specifies that the HTTP operation should be a POST instead of a GET. The
1702 complete data to be posted is given as the argument. This option will usually
1703 need to be accompanied by a B<Header> option to set an appropriate
1704 C<Content-Type> for the post body (e.g. to
1705 C<application/x-www-form-urlencoded>).
1707 =item B<MeasureResponseTime> B<true>|B<false>
1709 Measure response time for the request. If this setting is enabled, B<Match>
1710 blocks (see below) are optional. Disabled by default.
1712 Beware that requests will get aborted if they take too long to complete. Adjust
1713 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1716 This option is similar to enabling the B<TotalTime> statistic but it's
1717 measured by collectd instead of cURL.
1719 =item B<MeasureResponseCode> B<true>|B<false>
1721 Measure response code for the request. If this setting is enabled, B<Match>
1722 blocks (see below) are optional. Disabled by default.
1724 =item B<E<lt>StatisticsE<gt>>
1726 One B<Statistics> block can be used to specify cURL statistics to be collected
1727 for each request to the remote web site. See the section "cURL Statistics"
1728 above for details. If this setting is enabled, B<Match> blocks (see below) are
1731 =item B<E<lt>MatchE<gt>>
1733 One or more B<Match> blocks that define how to match information in the data
1734 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1735 used by the C<tail> plugin, so please see the documentation of the C<tail>
1736 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1737 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1740 =item B<Timeout> I<Milliseconds>
1742 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1743 milliseconds. By default, the configured B<Interval> is used to set the
1744 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1745 indefinitely. This legacy behaviour can be achieved by setting the value of
1748 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1749 network connection will stall one read thread. Adjust the B<ReadThreads> global
1750 setting accordingly to prevent this from blocking other plugins.
1754 =head2 Plugin C<curl_json>
1756 The B<curl_json plugin> collects values from JSON data to be parsed by
1757 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1758 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1759 unix socket. The former can be used, for example, to collect values
1760 from CouchDB documents (which are stored JSON notation), and the
1761 latter to collect values from a uWSGI stats socket.
1763 The following example will collect several values from the built-in
1764 C<_stats> runtime statistics module of I<CouchDB>
1765 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1768 <URL "http://localhost:5984/_stats">
1770 <Key "httpd/requests/count">
1771 Type "http_requests"
1774 <Key "httpd_request_methods/*/count">
1775 Type "http_request_methods"
1778 <Key "httpd_status_codes/*/count">
1779 Type "http_response_codes"
1784 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1787 <Sock "/var/run/uwsgi.stats.sock">
1789 <Key "workers/*/requests">
1790 Type "http_requests"
1793 <Key "workers/*/apps/*/requests">
1794 Type "http_requests"
1799 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1800 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1801 blocks defining a unix socket to read JSON from directly. Each of
1802 these blocks may have one or more B<Key> blocks.
1804 The B<Key> string argument must be in a path format. Each component is
1805 used to match the key from a JSON map or the index of an JSON
1806 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1807 values for all map keys or array indices will be collectd.
1809 The following options are valid within B<URL> blocks:
1813 =item B<Host> I<Name>
1815 Use I<Name> as the host name when submitting values. Defaults to the global
1818 =item B<Plugin> I<Plugin>
1820 Use I<Plugin> as the plugin name when submitting values.
1821 Defaults to 'curl_json'.
1823 =item B<Instance> I<Instance>
1825 Sets the plugin instance to I<Instance>.
1827 =item B<Interval> I<Interval>
1829 Sets the interval (in seconds) in which the values will be collected from this
1830 URL. By default the global B<Interval> setting will be used.
1832 =item B<User> I<Name>
1834 =item B<Password> I<Password>
1836 =item B<Digest> B<true>|B<false>
1838 =item B<VerifyPeer> B<true>|B<false>
1840 =item B<VerifyHost> B<true>|B<false>
1842 =item B<CACert> I<file>
1844 =item B<Header> I<Header>
1846 =item B<Post> I<Body>
1848 =item B<Timeout> I<Milliseconds>
1850 These options behave exactly equivalent to the appropriate options of the
1851 I<cURL> plugin. Please see there for a detailed description.
1853 =item B<E<lt>StatisticsE<gt>>
1855 One B<Statistics> block can be used to specify cURL statistics to be collected
1856 for each request to the remote URL. See the section "cURL Statistics" above
1861 The following options are valid within B<Key> blocks:
1865 =item B<Type> I<Type>
1867 Sets the type used to dispatch the values to the daemon. Detailed information
1868 about types and their configuration can be found in L<types.db(5)>. This
1869 option is mandatory.
1871 =item B<Instance> I<Instance>
1873 Type-instance to use. Defaults to the current map key or current string array element value.
1877 =head2 Plugin C<curl_xml>
1879 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1880 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1883 <URL "http://localhost/stats.xml">
1885 Instance "some_instance"
1890 CACert "/path/to/ca.crt"
1891 Header "X-Custom-Header: foobar"
1894 <XPath "table[@id=\"magic_level\"]/tr">
1896 #InstancePrefix "prefix-"
1897 InstanceFrom "td[1]"
1898 ValuesFrom "td[2]/span[@class=\"level\"]"
1903 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1904 URL to be fetched using libcurl. Within each B<URL> block there are
1905 options which specify the connection parameters, for example authentication
1906 information, and one or more B<XPath> blocks.
1908 Each B<XPath> block specifies how to get one type of information. The
1909 string argument must be a valid XPath expression which returns a list
1910 of "base elements". One value is dispatched for each "base element". The
1911 I<type instance> and values are looked up using further I<XPath> expressions
1912 that should be relative to the base element.
1914 Within the B<URL> block the following options are accepted:
1918 =item B<Host> I<Name>
1920 Use I<Name> as the host name when submitting values. Defaults to the global
1923 =item B<Instance> I<Instance>
1925 Use I<Instance> as the plugin instance when submitting values. Defaults to an
1926 empty string (no plugin instance).
1928 =item B<Namespace> I<Prefix> I<URL>
1930 If an XPath expression references namespaces, they must be specified
1931 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1932 I<URL> is the "namespace name", an URI reference uniquely identifying the
1933 namespace. The option can be repeated to register multiple namespaces.
1937 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1938 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1940 =item B<User> I<User>
1942 =item B<Password> I<Password>
1944 =item B<Digest> B<true>|B<false>
1946 =item B<VerifyPeer> B<true>|B<false>
1948 =item B<VerifyHost> B<true>|B<false>
1950 =item B<CACert> I<CA Cert File>
1952 =item B<Header> I<Header>
1954 =item B<Post> I<Body>
1956 =item B<Timeout> I<Milliseconds>
1958 These options behave exactly equivalent to the appropriate options of the
1959 I<cURL plugin>. Please see there for a detailed description.
1961 =item B<E<lt>StatisticsE<gt>>
1963 One B<Statistics> block can be used to specify cURL statistics to be collected
1964 for each request to the remote URL. See the section "cURL Statistics" above
1967 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1969 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1970 B<XPath> block specifies how to get one type of information. The string
1971 argument must be a valid XPath expression which returns a list of "base
1972 elements". One value is dispatched for each "base element".
1974 Within the B<XPath> block the following options are accepted:
1978 =item B<Type> I<Type>
1980 Specifies the I<Type> used for submitting patches. This determines the number
1981 of values that are required / expected and whether the strings are parsed as
1982 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1983 This option is required.
1985 =item B<InstancePrefix> I<InstancePrefix>
1987 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
1988 concatenated together without any separator.
1989 This option is optional.
1991 =item B<InstanceFrom> I<InstanceFrom>
1993 Specifies a XPath expression to use for determining the I<type instance>. The
1994 XPath expression must return exactly one element. The element's value is then
1995 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
1997 This value is required. As a special exception, if the "base XPath expression"
1998 (the argument to the B<XPath> block) returns exactly one argument, then this
1999 option may be omitted.
2001 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2003 Specifies one or more XPath expression to use for reading the values. The
2004 number of XPath expressions must match the number of data sources in the
2005 I<type> specified with B<Type> (see above). Each XPath expression must return
2006 exactly one element. The element's value is then parsed as a number and used as
2007 value for the appropriate value in the value list dispatched to the daemon.
2013 =head2 Plugin C<dbi>
2015 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2016 connect to various databases, execute I<SQL> statements and read back the
2017 results. I<dbi> is an acronym for "database interface" in case you were
2018 wondering about the name. You can configure how each column is to be
2019 interpreted and the plugin will generate one or more data sets from each row
2020 returned according to these rules.
2022 Because the plugin is very generic, the configuration is a little more complex
2023 than those of other plugins. It usually looks something like this:
2026 <Query "out_of_stock">
2027 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2028 # Use with MySQL 5.0.0 or later
2032 InstancePrefix "out_of_stock"
2033 InstancesFrom "category"
2037 <Database "product_information">
2040 DriverOption "host" "localhost"
2041 DriverOption "username" "collectd"
2042 DriverOption "password" "aZo6daiw"
2043 DriverOption "dbname" "prod_info"
2044 SelectDB "prod_info"
2045 Query "out_of_stock"
2049 The configuration above defines one query with one result and one database. The
2050 query is then linked to the database with the B<Query> option I<within> the
2051 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2052 and you can also use the B<Include> statement to split up the configuration
2053 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2054 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2057 The following is a complete list of options:
2059 =head3 B<Query> blocks
2061 Query blocks define I<SQL> statements and how the returned data should be
2062 interpreted. They are identified by the name that is given in the opening line
2063 of the block. Thus the name needs to be unique. Other than that, the name is
2064 not used in collectd.
2066 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2067 define which column holds which value or instance information. You can use
2068 multiple B<Result> blocks to create multiple values from one returned row. This
2069 is especially useful, when queries take a long time and sending almost the same
2070 query again and again is not desirable.
2074 <Query "environment">
2075 Statement "select station, temperature, humidity from environment"
2078 # InstancePrefix "foo"
2079 InstancesFrom "station"
2080 ValuesFrom "temperature"
2084 InstancesFrom "station"
2085 ValuesFrom "humidity"
2089 The following options are accepted:
2093 =item B<Statement> I<SQL>
2095 Sets the statement that should be executed on the server. This is B<not>
2096 interpreted by collectd, but simply passed to the database server. Therefore,
2097 the SQL dialect that's used depends on the server collectd is connected to.
2099 The query has to return at least two columns, one for the instance and one
2100 value. You cannot omit the instance, even if the statement is guaranteed to
2101 always return exactly one line. In that case, you can usually specify something
2104 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2106 (That works with MySQL but may not be valid SQL according to the spec. If you
2107 use a more strict database server, you may have to select from a dummy table or
2110 Please note that some databases, for example B<Oracle>, will fail if you
2111 include a semicolon at the end of the statement.
2113 =item B<MinVersion> I<Version>
2115 =item B<MaxVersion> I<Value>
2117 Only use this query for the specified database version. You can use these
2118 options to provide multiple queries with the same name but with a slightly
2119 different syntax. The plugin will use only those queries, where the specified
2120 minimum and maximum versions fit the version of the database in use.
2122 The database version is determined by C<dbi_conn_get_engine_version>, see the
2123 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2124 for details. Basically, each part of the version is assumed to be in the range
2125 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2126 "40102", version "5.0.42" becomes "50042".
2128 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2129 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2130 happen. Don't to it! A valid example would be something along these lines:
2141 In the above example, there are three ranges that don't overlap. The last one
2142 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2143 before "4.0.0" are not specified.
2145 =item B<Type> I<Type>
2147 The B<type> that's used for each line returned. See L<types.db(5)> for more
2148 details on how types are defined. In short: A type is a predefined layout of
2149 data and the number of values and type of values has to match the type
2152 If you specify "temperature" here, you need exactly one gauge column. If you
2153 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2156 There must be exactly one B<Type> option inside each B<Result> block.
2158 =item B<InstancePrefix> I<prefix>
2160 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2161 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2162 all strings returned in the appropriate columns are concatenated together,
2163 separated by dashes I<("-")>.
2165 =item B<InstancesFrom> I<column0> [I<column1> ...]
2167 Specifies the columns whose values will be used to create the "type-instance"
2168 for each row. If you specify more than one column, the value of all columns
2169 will be joined together with dashes I<("-")> as separation characters.
2171 The plugin itself does not check whether or not all built instances are
2172 different. It's your responsibility to assure that each is unique. This is
2173 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2174 sure that only one row is returned in this case.
2176 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2179 =item B<ValuesFrom> I<column0> [I<column1> ...]
2181 Names the columns whose content is used as the actual data for the data sets
2182 that are dispatched to the daemon. How many such columns you need is determined
2183 by the B<Type> setting above. If you specify too many or not enough columns,
2184 the plugin will complain about that and no data will be submitted to the
2187 The actual data type in the columns is not that important. The plugin will
2188 automatically cast the values to the right type if it know how to do that. So
2189 it should be able to handle integer an floating point types, as well as strings
2190 (if they include a number at the beginning).
2192 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2194 =item B<MetadataFrom> [I<column0> I<column1> ...]
2196 Names the columns whose content is used as metadata for the data sets
2197 that are dispatched to the daemon.
2199 The actual data type in the columns is not that important. The plugin will
2200 automatically cast the values to the right type if it know how to do that. So
2201 it should be able to handle integer an floating point types, as well as strings
2202 (if they include a number at the beginning).
2206 =head3 B<Database> blocks
2208 Database blocks define a connection to a database and which queries should be
2209 sent to that database. Since the used "dbi" library can handle a wide variety
2210 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2211 documentationE<nbsp>- we stick as close to the terminology used there.
2213 Each database needs a "name" as string argument in the starting tag of the
2214 block. This name will be used as "PluginInstance" in the values submitted to
2215 the daemon. Other than that, that name is not used.
2219 =item B<Interval> I<Interval>
2221 Sets the interval (in seconds) in which the values will be collected from this
2222 database. By default the global B<Interval> setting will be used.
2224 =item B<Driver> I<Driver>
2226 Specifies the driver to use to connect to the database. In many cases those
2227 drivers are named after the database they can connect to, but this is not a
2228 technical necessity. These drivers are sometimes referred to as "DBD",
2229 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2230 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2231 project at L<http://libdbi-drivers.sourceforge.net/>.
2233 You need to give the driver name as expected by the "dbi" library here. You
2234 should be able to find that in the documentation for each driver. If you
2235 mistype the driver name, the plugin will dump a list of all known driver names
2238 =item B<DriverOption> I<Key> I<Value>
2240 Sets driver-specific options. What option a driver supports can be found in the
2241 documentation for each driver, somewhere at
2242 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2243 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2245 DBDs can register two types of options: String options and numeric options. The
2246 plugin will use the C<dbi_conn_set_option> function when the configuration
2247 provides a string and the C<dbi_conn_require_option_numeric> function when the
2248 configuration provides a number. So these two lines will actually result in
2249 different calls being used:
2251 DriverOption "Port" 1234 # numeric
2252 DriverOption "Port" "1234" # string
2254 Unfortunately, drivers are not too keen to report errors when an unknown option
2255 is passed to them, so invalid settings here may go unnoticed. This is not the
2256 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2257 the driver. If a driver complains about an option, the plugin will dump a
2258 complete list of all options understood by that driver to the log. There is no
2259 way to programmatically find out if an option expects a string or a numeric
2260 argument, so you will have to refer to the appropriate DBD's documentation to
2261 find this out. Sorry.
2263 =item B<SelectDB> I<Database>
2265 In some cases, the database name you connect with is not the database name you
2266 want to use for querying data. If this option is set, the plugin will "select"
2267 (switch to) that database after the connection is established.
2269 =item B<Query> I<QueryName>
2271 Associates the query named I<QueryName> with this database connection. The
2272 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2273 blocks you want to refer to must be placed above the database block you want to
2276 =item B<Host> I<Hostname>
2278 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2279 values. Defaults to the global hostname setting.
2287 =item B<Device> I<Device>
2289 Select partitions based on the devicename.
2291 See F</"IGNORELISTS"> for details.
2293 =item B<MountPoint> I<Directory>
2295 Select partitions based on the mountpoint.
2297 See F</"IGNORELISTS"> for details.
2299 =item B<FSType> I<FSType>
2301 Select partitions based on the filesystem type.
2303 See F</"IGNORELISTS"> for details.
2305 =item B<IgnoreSelected> B<true>|B<false>
2307 Invert the selection: If set to true, all partitions B<except> the ones that
2308 match any one of the criteria are collected. By default only selected
2309 partitions are collected if a selection is made. If no selection is configured
2310 at all, B<all> partitions are selected.
2312 =item B<ReportByDevice> B<true>|B<false>
2314 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2315 (the default), it will report a disk as "root", but with it I<true>, it will be
2316 "sda1" (or whichever).
2318 =item B<ReportInodes> B<true>|B<false>
2320 Enables or disables reporting of free, reserved and used inodes. Defaults to
2321 inode collection being disabled.
2323 Enable this option if inodes are a scarce resource for you, usually because
2324 many small files are stored on the disk. This is a usual scenario for mail
2325 transfer agents and web caches.
2327 =item B<ValuesAbsolute> B<true>|B<false>
2329 Enables or disables reporting of free and used disk space in 1K-blocks.
2330 Defaults to B<true>.
2332 =item B<ValuesPercentage> B<false>|B<true>
2334 Enables or disables reporting of free and used disk space in percentage.
2335 Defaults to B<false>.
2337 This is useful for deploying I<collectd> on the cloud, where machines with
2338 different disk size may exist. Then it is more practical to configure
2339 thresholds based on relative disk size.
2343 =head2 Plugin C<disk>
2345 The C<disk> plugin collects information about the usage of physical disks and
2346 logical disks (partitions). Values collected are the number of octets written
2347 to and read from a disk or partition, the number of read/write operations
2348 issued to the disk and a rather complex "time" it took for these commands to be
2351 Using the following two options you can ignore some disks or configure the
2352 collection only of specific disks.
2356 =item B<Disk> I<Name>
2358 Select the disk I<Name>. Whether it is collected or ignored depends on the
2359 B<IgnoreSelected> setting, see below. As with other plugins that use the
2360 daemon's ignorelist functionality, a string that starts and ends with a slash
2361 is interpreted as a regular expression. Examples:
2366 See F</"IGNORELISTS"> for details.
2368 =item B<IgnoreSelected> B<true>|B<false>
2370 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2371 statements, are ignored or if all other disks are ignored. The behavior
2372 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2373 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2374 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2375 is set to B<true>, all disks are collected B<except> the ones matched.
2377 =item B<UseBSDName> B<true>|B<false>
2379 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2380 default major/minor numbers. Requires collectd to be built with Apple's
2383 =item B<UdevNameAttr> I<Attribute>
2385 Attempt to override disk instance name with the value of a specified udev
2386 attribute when built with B<libudev>. If the attribute is not defined for the
2387 given device, the default name is used. Example:
2389 UdevNameAttr "DM_NAME"
2393 =head2 Plugin C<dns>
2397 =item B<Interface> I<Interface>
2399 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2400 option sets the interface that should be used. If this option is not set, or
2401 set to "any", the plugin will try to get packets from B<all> interfaces. This
2402 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2404 =item B<IgnoreSource> I<IP-address>
2406 Ignore packets that originate from this address.
2408 =item B<SelectNumericQueryTypes> B<true>|B<false>
2410 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2414 =head2 Plugin C<dpdkevents>
2416 The I<dpdkevents plugin> collects events from DPDK such as link status of
2417 network ports and Keep Alive status of DPDK logical cores.
2418 In order to get Keep Alive events following requirements must be met:
2420 - support for Keep Alive implemented in DPDK application. More details can
2421 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2425 <Plugin "dpdkevents">
2431 <Event "link_status">
2432 SendEventsOnUpdate true
2433 EnabledPortMask 0xffff
2434 PortName "interface1"
2435 PortName "interface2"
2436 SendNotification false
2438 <Event "keep_alive">
2439 SendEventsOnUpdate true
2441 KeepAliveShmName "/dpdk_keepalive_shm_name"
2442 SendNotification false
2449 =head3 The EAL block
2453 =item B<Coremask> I<Mask>
2455 =item B<Memorychannels> I<Channels>
2457 Number of memory channels per processor socket.
2459 =item B<FilePrefix> I<File>
2461 The prefix text used for hugepage filenames. The filename will be set to
2462 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2466 =head3 The Event block
2468 The B<Event> block defines configuration for specific event. It accepts a
2469 single argument which specifies the name of the event.
2471 =head4 Link Status event
2475 =item B<SendEventOnUpdate> I<true|false>
2477 If set to true link status value will be dispatched only when it is
2478 different from previously read value. This is an optional argument - default
2481 =item B<EnabledPortMask> I<Mask>
2483 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2484 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2485 that all ports will be enabled. This is an optional argument - by default
2486 all ports are enabled.
2488 =item B<PortName> I<Name>
2490 A string containing an optional name for the enabled DPDK ports. Each PortName
2491 option should contain only one port name; specify as many PortName options as
2492 desired. Default naming convention will be used if PortName is blank. If there
2493 are less PortName options than there are enabled ports, the default naming
2494 convention will be used for the additional ports.
2496 =item B<SendNotification> I<true|false>
2498 If set to true, link status notifications are sent, instead of link status
2499 being collected as a statistic. This is an optional argument - default
2504 =head4 Keep Alive event
2508 =item B<SendEventOnUpdate> I<true|false>
2510 If set to true keep alive value will be dispatched only when it is
2511 different from previously read value. This is an optional argument - default
2514 =item B<LCoreMask> I<Mask>
2516 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2518 =item B<KeepAliveShmName> I<Name>
2520 Shared memory name identifier that is used by secondary process to monitor
2521 the keep alive cores state.
2523 =item B<SendNotification> I<true|false>
2525 If set to true, keep alive notifications are sent, instead of keep alive
2526 information being collected as a statistic. This is an optional
2527 argument - default value is false.
2531 =head2 Plugin C<dpdkstat>
2533 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2534 extended NIC stats API in DPDK.
2545 SharedMemObj "dpdk_collectd_stats_0"
2546 EnabledPortMask 0xffff
2547 PortName "interface1"
2548 PortName "interface2"
2553 =head3 The EAL block
2557 =item B<Coremask> I<Mask>
2559 A string containing an hexadecimal bit mask of the cores to run on. Note that
2560 core numbering can change between platforms and should be determined beforehand.
2562 =item B<Memorychannels> I<Channels>
2564 A string containing a number of memory channels per processor socket.
2566 =item B<FilePrefix> I<File>
2568 The prefix text used for hugepage filenames. The filename will be set to
2569 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2571 =item B<SocketMemory> I<MB>
2573 A string containing amount of Memory to allocate from hugepages on specific
2574 sockets in MB. This is an optional value.
2580 =item B<SharedMemObj> I<Mask>
2582 A string containing the name of the shared memory object that should be used to
2583 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2584 Defaults to dpdk_collectd_stats if no other value is configured.
2586 =item B<EnabledPortMask> I<Mask>
2588 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2589 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2590 that all ports will be enabled. This is an optional argument - default
2591 is all ports enabled.
2593 =item B<PortName> I<Name>
2595 A string containing an optional name for the enabled DPDK ports. Each PortName
2596 option should contain only one port name; specify as many PortName options as
2597 desired. Default naming convention will be used if PortName is blank. If there
2598 are less PortName options than there are enabled ports, the default naming
2599 convention will be used for the additional ports.
2603 =head2 Plugin C<email>
2607 =item B<SocketFile> I<Path>
2609 Sets the socket-file which is to be created.
2611 =item B<SocketGroup> I<Group>
2613 If running as root change the group of the UNIX-socket after it has been
2614 created. Defaults to B<collectd>.
2616 =item B<SocketPerms> I<Permissions>
2618 Change the file permissions of the UNIX-socket after it has been created. The
2619 permissions must be given as a numeric, octal value as you would pass to
2620 L<chmod(1)>. Defaults to B<0770>.
2622 =item B<MaxConns> I<Number>
2624 Sets the maximum number of connections that can be handled in parallel. Since
2625 this many threads will be started immediately setting this to a very high
2626 value will waste valuable resources. Defaults to B<5> and will be forced to be
2627 at most B<16384> to prevent typos and dumb mistakes.
2631 =head2 Plugin C<ethstat>
2633 The I<ethstat plugin> collects information about network interface cards (NICs)
2634 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2640 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2641 Map "multicast" "if_multicast"
2648 =item B<Interface> I<Name>
2650 Collect statistical information about interface I<Name>.
2652 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2654 By default, the plugin will submit values as type C<derive> and I<type
2655 instance> set to I<Name>, the name of the metric as reported by the driver. If
2656 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2657 I<TypeInstance> will be used.
2659 =item B<MappedOnly> B<true>|B<false>
2661 When set to B<true>, only metrics that can be mapped to a I<type> will be
2662 collected, all other metrics will be ignored. Defaults to B<false>.
2666 =head2 Plugin C<exec>
2668 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2669 contains valuable information on when the executable is executed and the
2670 output that is expected from it.
2674 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2676 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2678 Execute the executable I<Executable> as user I<User>. If the user name is
2679 followed by a colon and a group name, the effective group is set to that group.
2680 The real group and saved-set group will be set to the default group of that
2681 user. If no group is given the effective group ID will be the same as the real
2684 Please note that in order to change the user and/or group the daemon needs
2685 superuser privileges. If the daemon is run as an unprivileged user you must
2686 specify the same user/group here. If the daemon is run with superuser
2687 privileges, you must supply a non-root user here.
2689 The executable may be followed by optional arguments that are passed to the
2690 program. Please note that due to the configuration parsing numbers and boolean
2691 values may be changed. If you want to be absolutely sure that something is
2692 passed as-is please enclose it in quotes.
2694 The B<Exec> and B<NotificationExec> statements change the semantics of the
2695 programs executed, i.E<nbsp>e. the data passed to them and the response
2696 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2700 =head2 Plugin C<fhcount>
2702 The C<fhcount> plugin provides statistics about used, unused and total number of
2703 file handles on Linux.
2705 The I<fhcount plugin> provides the following configuration options:
2709 =item B<ValuesAbsolute> B<true>|B<false>
2711 Enables or disables reporting of file handles usage in absolute numbers,
2712 e.g. file handles used. Defaults to B<true>.
2714 =item B<ValuesPercentage> B<false>|B<true>
2716 Enables or disables reporting of file handles usage in percentages, e.g.
2717 percent of file handles used. Defaults to B<false>.
2721 =head2 Plugin C<filecount>
2723 The C<filecount> plugin counts the number of files in a certain directory (and
2724 its subdirectories) and their combined size. The configuration is very straight
2727 <Plugin "filecount">
2728 <Directory "/var/qmail/queue/mess">
2729 Instance "qmail-message"
2731 <Directory "/var/qmail/queue/todo">
2732 Instance "qmail-todo"
2734 <Directory "/var/lib/php5">
2735 Instance "php5-sessions"
2740 The example above counts the number of files in QMail's queue directories and
2741 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2742 QMail has not yet looked at, the "message" queue holds the messages that were
2743 classified into "local" and "remote".
2745 As you can see, the configuration consists of one or more C<Directory> blocks,
2746 each of which specifies a directory in which to count the files. Within those
2747 blocks, the following options are recognized:
2751 =item B<Plugin> I<Plugin>
2753 Use I<Plugin> as the plugin name when submitting values.
2754 Defaults to B<filecount>.
2756 =item B<Instance> I<Instance>
2758 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2759 the directory name with all slashes replaced by underscores and all leading
2760 underscores removed. Empty value is allowed.
2762 =item B<Name> I<Pattern>
2764 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2765 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2766 against the pattern, not the entire path. In case this makes it easier for you:
2767 This option has been named after the B<-name> parameter to L<find(1)>.
2769 =item B<MTime> I<Age>
2771 Count only files of a specific age: If I<Age> is greater than zero, only files
2772 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2773 a negative number, this is inversed. For example, if B<-60> is specified, only
2774 files that have been modified in the last minute will be counted.
2776 The number can also be followed by a "multiplier" to easily specify a larger
2777 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2778 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2779 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2780 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2781 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2784 =item B<Size> I<Size>
2786 Count only files of a specific size. When I<Size> is a positive number, only
2787 files that are at least this big are counted. If I<Size> is a negative number,
2788 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2789 I<Size> are counted.
2791 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2792 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2793 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2794 note that there are 1000 bytes in a kilobyte, not 1024.
2796 =item B<Recursive> I<true>|I<false>
2798 Controls whether or not to recurse into subdirectories. Enabled by default.
2800 =item B<IncludeHidden> I<true>|I<false>
2802 Controls whether or not to include "hidden" files and directories in the count.
2803 "Hidden" files and directories are those, whose name begins with a dot.
2804 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2806 =item B<FilesSizeType> I<Type>
2808 Sets the type used to dispatch files combined size. Empty value ("") disables
2809 reporting. Defaults to B<bytes>.
2811 =item B<FilesCountType> I<Type>
2813 Sets the type used to dispatch number of files. Empty value ("") disables
2814 reporting. Defaults to B<files>.
2816 =item B<TypeInstance> I<Instance>
2818 Sets the I<type instance> used to dispatch values. Defaults to an empty string
2819 (no plugin instance).
2823 =head2 Plugin C<GenericJMX>
2825 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2826 L<collectd-java(5)>.
2828 =head2 Plugin C<gmond>
2830 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2831 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2832 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2837 MCReceiveFrom "239.2.11.71" "8649"
2838 <Metric "swap_total">
2840 TypeInstance "total"
2843 <Metric "swap_free">
2850 The following metrics are built-in:
2856 load_one, load_five, load_fifteen
2860 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2864 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2876 Available configuration options:
2880 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2882 Sets sets the multicast group and UDP port to which to subscribe.
2884 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2886 =item E<lt>B<Metric> I<Name>E<gt>
2888 These blocks add a new metric conversion to the internal table. I<Name>, the
2889 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2893 =item B<Type> I<Type>
2895 Type to map this metric to. Required.
2897 =item B<TypeInstance> I<Instance>
2899 Type-instance to use. Optional.
2901 =item B<DataSource> I<Name>
2903 Data source to map this metric to. If the configured type has exactly one data
2904 source, this is optional. Otherwise the option is required.
2910 =head2 Plugin C<gps>
2912 The C<gps plugin> connects to gpsd on the host machine.
2913 The host, port, timeout and pause are configurable.
2915 This is useful if you run an NTP server using a GPS for source and you want to
2918 Mind your GPS must send $--GSA for having the data reported!
2920 The following elements are collected:
2926 Number of satellites used for fix (type instance "used") and in view (type
2927 instance "visible"). 0 means no GPS satellites are visible.
2929 =item B<dilution_of_precision>
2931 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2932 It should be between 0 and 3.
2933 Look at the documentation of your GPS to know more.
2941 # Connect to localhost on gpsd regular port:
2946 # PauseConnect of 5 sec. between connection attempts.
2950 Available configuration options:
2954 =item B<Host> I<Host>
2956 The host on which gpsd daemon runs. Defaults to B<localhost>.
2958 =item B<Port> I<Port>
2960 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2962 =item B<Timeout> I<Seconds>
2964 Timeout in seconds (default 0.015 sec).
2966 The GPS data stream is fetch by the plugin form the daemon.
2967 It waits for data to be available, if none arrives it times out
2968 and loop for another reading.
2969 Mind to put a low value gpsd expects value in the micro-seconds area
2970 (recommended is 500 us) since the waiting function is blocking.
2971 Value must be between 500 us and 5 sec., if outside that range the
2972 default value is applied.
2974 This only applies from gpsd release-2.95.
2976 =item B<PauseConnect> I<Seconds>
2978 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
2982 =head2 Plugin C<grpc>
2984 The I<grpc> plugin provides an RPC interface to submit values to or query
2985 values from collectd based on the open source gRPC framework. It exposes an
2986 end-point for dispatching values to the daemon.
2988 The B<gRPC> homepage can be found at L<https://grpc.io/>.
2992 =item B<Server> I<Host> I<Port>
2994 The B<Server> statement sets the address of a server to which to send metrics
2995 via the C<DispatchValues> function.
2997 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
2999 Optionally, B<Server> may be specified as a configuration block which supports
3000 the following options:
3004 =item B<EnableSSL> B<false>|B<true>
3006 Whether to require SSL for outgoing connections. Default: false.
3008 =item B<SSLCACertificateFile> I<Filename>
3010 =item B<SSLCertificateFile> I<Filename>
3012 =item B<SSLCertificateKeyFile> I<Filename>
3014 Filenames specifying SSL certificate and key material to be used with SSL
3019 =item B<Listen> I<Host> I<Port>
3021 The B<Listen> statement sets the network address to bind to. When multiple
3022 statements are specified, the daemon will bind to all of them. If none are
3023 specified, it defaults to B<0.0.0.0:50051>.
3025 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3027 Optionally, B<Listen> may be specified as a configuration block which
3028 supports the following options:
3032 =item B<EnableSSL> I<true>|I<false>
3034 Whether to enable SSL for incoming connections. Default: false.
3036 =item B<SSLCACertificateFile> I<Filename>
3038 =item B<SSLCertificateFile> I<Filename>
3040 =item B<SSLCertificateKeyFile> I<Filename>
3042 Filenames specifying SSL certificate and key material to be used with SSL
3049 =head2 Plugin C<hddtemp>
3051 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3052 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3053 default values, see below. C<hddtemp> has to be running to work correctly. If
3054 C<hddtemp> is not running timeouts may appear which may interfere with other
3057 The B<hddtemp> homepage can be found at
3058 L<http://www.guzu.net/linux/hddtemp.php>.
3062 =item B<Host> I<Hostname>
3064 Hostname to connect to. Defaults to B<127.0.0.1>.
3066 =item B<Port> I<Port>
3068 TCP-Port to connect to. Defaults to B<7634>.
3072 =head2 Plugin C<hugepages>
3074 To collect B<hugepages> information, collectd reads directories
3075 "/sys/devices/system/node/*/hugepages" and
3076 "/sys/kernel/mm/hugepages".
3077 Reading of these directories can be disabled by the following
3078 options (default is enabled).
3082 =item B<ReportPerNodeHP> B<true>|B<false>
3084 If enabled, information will be collected from the hugepage
3085 counters in "/sys/devices/system/node/*/hugepages".
3086 This is used to check the per-node hugepage statistics on
3089 =item B<ReportRootHP> B<true>|B<false>
3091 If enabled, information will be collected from the hugepage
3092 counters in "/sys/kernel/mm/hugepages".
3093 This can be used on both NUMA and non-NUMA systems to check
3094 the overall hugepage statistics.
3096 =item B<ValuesPages> B<true>|B<false>
3098 Whether to report hugepages metrics in number of pages.
3099 Defaults to B<true>.
3101 =item B<ValuesBytes> B<false>|B<true>
3103 Whether to report hugepages metrics in bytes.
3104 Defaults to B<false>.
3106 =item B<ValuesPercentage> B<false>|B<true>
3108 Whether to report hugepages metrics as percentage.
3109 Defaults to B<false>.
3113 =head2 Plugin C<intel_pmu>
3115 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3116 Linux perf interface. All events are reported on a per core basis.
3121 ReportHardwareCacheEvents true
3122 ReportKernelPMUEvents true
3123 ReportSoftwareEvents true
3124 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3125 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3132 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3134 Enable or disable measuring of hardware CPU cache events:
3136 - L1-dcache-load-misses
3138 - L1-dcache-store-misses
3139 - L1-dcache-prefetches
3140 - L1-dcache-prefetch-misses
3142 - L1-icache-load-misses
3143 - L1-icache-prefetches
3144 - L1-icache-prefetch-misses
3150 - LLC-prefetch-misses
3156 - dTLB-prefetch-misses
3160 - branch-load-misses
3162 =item B<ReportKernelPMUEvents> B<false>|B<true>
3164 Enable or disable measuring of the following events:
3173 =item B<ReportSoftwareEvents> B<false>|B<true>
3175 Enable or disable measuring of software events provided by kernel:
3186 =item B<EventList> I<filename>
3188 JSON performance counter event list file name. To be able to monitor all Intel
3189 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3190 event_download.py script to download event list for current CPU.
3192 =item B<HardwareEvents> I<events>
3194 This field is a list of event names or groups of comma separated event names.
3195 This option requires B<EventList> option to be configured.
3199 =head2 Plugin C<intel_rdt>
3201 The I<intel_rdt> plugin collects information provided by monitoring features of
3202 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3203 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3204 information about utilization of shared resources. CMT monitors last level cache
3205 occupancy (LLC). MBM supports two types of events reporting local and remote
3206 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3207 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3208 reports the bandwidth of accessing the remote socket. Also this technology
3209 allows to monitor instructions per clock (IPC).
3210 Monitor events are hardware dependant. Monitoring capabilities are detected on
3211 plugin initialization and only supported events are monitored.
3213 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3214 require an additional capability to be enabled if collectd is run as a service.
3215 Please refer to I<contrib/systemd.collectd.service> file for more details.
3219 <Plugin "intel_rdt">
3220 Cores "0-2" "3,4,6" "8-10,15"
3227 =item B<Interval> I<seconds>
3229 The interval within which to retrieve statistics on monitored events in seconds.
3230 For milliseconds divide the time by 1000 for example if the desired interval
3231 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3232 recommended to set interval higher than 1 sec.
3234 =item B<Cores> I<cores groups>
3236 All events are reported on a per core basis. Monitoring of the events can be
3237 configured for group of cores (aggregated statistics). This field defines groups
3238 of cores on which to monitor supported events. The field is represented as list
3239 of strings with core group values. Each string represents a list of cores in a
3240 group. Allowed formats are:
3245 If an empty string is provided as value for this field default cores
3246 configuration is applied - a separate group is created for each core.
3250 B<Note:> By default global interval is used to retrieve statistics on monitored
3251 events. To configure a plugin specific interval use B<Interval> option of the
3252 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3253 example if the desired interval is 50ms, set interval to 0.05.
3254 Due to limited capacity of counters it is not recommended to set interval higher
3257 =head2 Plugin C<interface>
3261 =item B<Interface> I<Interface>
3263 Select this interface. By default these interfaces will then be collected. For
3264 a more detailed description see B<IgnoreSelected> below.
3266 See F</"IGNORELISTS"> for details.
3268 =item B<IgnoreSelected> I<true>|I<false>
3270 If no configuration is given, the B<interface>-plugin will collect data from
3271 all interfaces. This may not be practical, especially for loopback- and
3272 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3273 interfaces you're interested in. Sometimes, however, it's easier/preferred
3274 to collect all interfaces I<except> a few ones. This option enables you to
3275 do that: By setting B<IgnoreSelected> to I<true> the effect of
3276 B<Interface> is inverted: All selected interfaces are ignored and all
3277 other interfaces are collected.
3279 It is possible to use regular expressions to match interface names, if the
3280 name is surrounded by I</.../> and collectd was compiled with support for
3281 regexps. This is useful if there's a need to collect (or ignore) data
3282 for a group of interfaces that are similarly named, without the need to
3283 explicitly list all of them (especially useful if the list is dynamic).
3288 Interface "/^tun[0-9]+/"
3289 IgnoreSelected "true"
3291 This will ignore the loopback interface, all interfaces with names starting
3292 with I<veth> and all interfaces with names starting with I<tun> followed by
3295 =item B<ReportInactive> I<true>|I<false>
3297 When set to I<false>, only interfaces with non-zero traffic will be
3298 reported. Note that the check is done by looking into whether a
3299 package was sent at any time from boot and the corresponding counter
3300 is non-zero. So, if the interface has been sending data in the past
3301 since boot, but not during the reported time-interval, it will still
3304 The default value is I<true> and results in collection of the data
3305 from all interfaces that are selected by B<Interface> and
3306 B<IgnoreSelected> options.
3308 =item B<UniqueName> I<true>|I<false>
3310 Interface name is not unique on Solaris (KSTAT), interface name is unique
3311 only within a module/instance. Following tuple is considered unique:
3312 (ks_module, ks_instance, ks_name)
3313 If this option is set to true, interface name contains above three fields
3314 separated by an underscore. For more info on KSTAT, visit
3315 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3317 This option is only available on Solaris.
3321 =head2 Plugin C<ipmi>
3325 =item B<Sensor> I<Sensor>
3327 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3329 See F</"IGNORELISTS"> for details.
3331 =item B<IgnoreSelected> I<true>|I<false>
3333 If no configuration if given, the B<ipmi> plugin will collect data from all
3334 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3335 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3336 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3337 all other sensors are collected.
3339 =item B<NotifySensorAdd> I<true>|I<false>
3341 If a sensor appears after initialization time of a minute a notification
3344 =item B<NotifySensorRemove> I<true>|I<false>
3346 If a sensor disappears a notification is sent.
3348 =item B<NotifySensorNotPresent> I<true>|I<false>
3350 If you have for example dual power supply and one of them is (un)plugged then
3351 a notification is sent.
3355 =head2 Plugin C<iptables>
3359 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3361 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3363 Select the iptables/ip6tables filter rules to count packets and bytes from.
3365 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3366 of all rules which have a comment-match. The comment is then used as
3369 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3370 the I<n>th rule will be collected. Again, the comment (or the number) will be
3371 used as the type-instance.
3373 If I<Name> is supplied, it will be used as the type-instance instead of the
3374 comment or the number.
3378 =head2 Plugin C<irq>
3384 Select this irq. By default these irqs will then be collected. For a more
3385 detailed description see B<IgnoreSelected> below.
3387 See F</"IGNORELISTS"> for details.
3389 =item B<IgnoreSelected> I<true>|I<false>
3391 If no configuration if given, the B<irq>-plugin will collect data from all
3392 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3393 can use the B<Irq>-option to pick the interrupt you're interested in.
3394 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3395 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3396 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3397 and all other interrupts are collected.
3401 =head2 Plugin C<java>
3403 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3404 This section only discusses the syntax and semantic of the configuration
3405 options. For more in-depth information on the I<Java> plugin, please read
3406 L<collectd-java(5)>.
3411 JVMArg "-verbose:jni"
3412 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3413 LoadPlugin "org.collectd.java.Foobar"
3414 <Plugin "org.collectd.java.Foobar">
3415 # To be parsed by the plugin
3419 Available configuration options:
3423 =item B<JVMArg> I<Argument>
3425 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3426 exactly the way the arguments to the I<java> binary on the command line work.
3427 Execute C<javaE<nbsp>--help> for details.
3429 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3430 any other options! When another option is found, the JVM will be started and
3431 later options will have to be ignored!
3433 =item B<LoadPlugin> I<JavaClass>
3435 Instantiates a new I<JavaClass> object. The constructor of this object very
3436 likely then registers one or more callback methods with the server.
3438 See L<collectd-java(5)> for details.
3440 When the first such option is found, the virtual machine (JVM) is created. This
3441 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3442 B<LoadPlugin> options!
3444 =item B<Plugin> I<Name>
3446 The entire block is passed to the Java plugin as an
3447 I<org.collectd.api.OConfigItem> object.
3449 For this to work, the plugin has to register a configuration callback first,
3450 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3451 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3452 depends on the (Java) plugin registering the callback and is completely
3453 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3457 =head2 Plugin C<load>
3459 The I<Load plugin> collects the system load. These numbers give a rough overview
3460 over the utilization of a machine. The system load is defined as the number of
3461 runnable tasks in the run-queue and is provided by many operating systems as a
3462 one, five or fifteen minute average.
3464 The following configuration options are available:
3468 =item B<ReportRelative> B<false>|B<true>
3470 When enabled, system load divided by number of available CPU cores is reported
3471 for intervals 1 min, 5 min and 15 min. Defaults to false.
3476 =head2 Plugin C<logfile>
3480 =item B<LogLevel> B<debug|info|notice|warning|err>
3482 Sets the log-level. If, for example, set to B<notice>, then all events with
3483 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3485 Please note that B<debug> is only available if collectd has been compiled with
3488 =item B<File> I<File>
3490 Sets the file to write log messages to. The special strings B<stdout> and
3491 B<stderr> can be used to write to the standard output and standard error
3492 channels, respectively. This, of course, only makes much sense when I<collectd>
3493 is running in foreground- or non-daemon-mode.
3495 =item B<Timestamp> B<true>|B<false>
3497 Prefix all lines printed by the current time. Defaults to B<true>.
3499 =item B<PrintSeverity> B<true>|B<false>
3501 When enabled, all lines are prefixed by the severity of the log message, for
3502 example "warning". Defaults to B<false>.
3506 B<Note>: There is no need to notify the daemon after moving or removing the
3507 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3508 for each line it writes.
3510 =head2 Plugin C<log_logstash>
3512 The I<log logstash plugin> behaves like the logfile plugin but formats
3513 messages as JSON events for logstash to parse and input.
3517 =item B<LogLevel> B<debug|info|notice|warning|err>
3519 Sets the log-level. If, for example, set to B<notice>, then all events with
3520 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3522 Please note that B<debug> is only available if collectd has been compiled with
3525 =item B<File> I<File>
3527 Sets the file to write log messages to. The special strings B<stdout> and
3528 B<stderr> can be used to write to the standard output and standard error
3529 channels, respectively. This, of course, only makes much sense when I<collectd>
3530 is running in foreground- or non-daemon-mode.
3534 B<Note>: There is no need to notify the daemon after moving or removing the
3535 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3536 for each line it writes.
3538 =head2 Plugin C<lpar>
3540 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3541 virtualization technique for IBM POWER processors. It takes into account CPU
3542 time stolen from or donated to a partition, in addition to the usual user,
3543 system, I/O statistics.
3545 The following configuration options are available:
3549 =item B<CpuPoolStats> B<false>|B<true>
3551 When enabled, statistics about the processor pool are read, too. The partition
3552 needs to have pool authority in order to be able to acquire this information.
3555 =item B<ReportBySerial> B<false>|B<true>
3557 If enabled, the serial of the physical machine the partition is currently
3558 running on is reported as I<hostname> and the logical hostname of the machine
3559 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3560 used (just like other plugins) and the I<plugin instance> will be empty.
3565 =head2 Plugin C<lua>
3567 This plugin embeds a Lua interpreter into collectd and provides an interface
3568 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3571 =head2 Plugin C<mbmon>
3573 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3575 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3576 B<Host> and B<Port> options can be used to change these values, see below.
3577 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3578 timeouts may appear which may interfere with other statistics..
3580 C<mbmon> must be run with the -r option ("print TAG and Value format");
3581 Debian's F</etc/init.d/mbmon> script already does this, other people
3582 will need to ensure that this is the case.
3586 =item B<Host> I<Hostname>
3588 Hostname to connect to. Defaults to B<127.0.0.1>.
3590 =item B<Port> I<Port>
3592 TCP-Port to connect to. Defaults to B<411>.
3596 =head2 Plugin C<mcelog>
3598 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3600 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3601 mcelog server is running. When the server is running, the plugin will tail the
3602 specified logfile to retrieve machine check exception information and send a
3603 notification with the details from the logfile. The plugin will use the mcelog
3604 client protocol to retrieve memory related machine check exceptions. Note that
3605 for memory exceptions, notifications are only sent when there is a change in
3606 the number of corrected/uncorrected memory errors.
3608 =head3 The Memory block
3610 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3615 =item B<McelogClientSocket> I<Path>
3616 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3617 Defaults to B<"/var/run/mcelog-client">.
3619 =item B<PersistentNotification> B<true>|B<false>
3620 Override default configuration to only send notifications when sent when there
3621 is a change in the number of corrected/uncorrected memory errors. When set to
3622 true notifications will be sent for every read cycle. Default is false. Does
3623 not affect the stats being dispatched.
3629 =item B<McelogLogfile> I<Path>
3631 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3632 cannot be used in conjunction with the memory block options, they are mutually
3639 The C<md plugin> collects information from Linux Software-RAID devices (md).
3641 All reported values are of the type C<md_disks>. Reported type instances are
3642 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3643 I<missing> (physically absent) disks.
3647 =item B<Device> I<Device>
3649 Select md devices based on device name. The I<device name> is the basename of
3650 the device, i.e. the name of the block device without the leading C</dev/>.
3651 See B<IgnoreSelected> for more details.
3653 See F</"IGNORELISTS"> for details.
3655 =item B<IgnoreSelected> B<true>|B<false>
3657 Invert device selection: If set to B<true>, all md devices B<except> those
3658 listed using B<Device> are collected. If B<false> (the default), only those
3659 listed are collected. If no configuration is given, the B<md> plugin will
3660 collect data from all md devices.
3664 =head2 Plugin C<memcachec>
3666 The C<memcachec plugin> connects to a memcached server, queries one or more
3667 given I<pages> and parses the returned data according to user specification.
3668 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3671 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3672 library. Please note that there is another library with a very similar name,
3673 libmemcache (notice the missing `d'), which is not applicable.
3675 Synopsis of the configuration:
3677 <Plugin "memcachec">
3678 <Page "plugin_instance">
3682 Regex "(\\d+) bytes sent"
3685 Instance "type_instance"
3690 The configuration options are:
3694 =item E<lt>B<Page> I<Name>E<gt>
3696 Each B<Page> block defines one I<page> to be queried from the memcached server.
3697 The block requires one string argument which is used as I<plugin instance>.
3699 =item B<Server> I<Address>
3701 Sets the server address to connect to when querying the page. Must be inside a
3706 When connected to the memcached server, asks for the page I<Key>.
3708 =item E<lt>B<Match>E<gt>
3710 Match blocks define which strings to look for and how matches substrings are
3711 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3715 =head2 Plugin C<memcached>
3717 The B<memcached plugin> connects to a memcached server and queries statistics
3718 about cache utilization, memory and bandwidth used.
3719 L<http://memcached.org/>
3721 <Plugin "memcached">
3723 #Host "memcache.example.com"
3729 The plugin configuration consists of one or more B<Instance> blocks which
3730 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3731 following options are allowed:
3735 =item B<Host> I<Hostname>
3737 Sets the B<host> field of dispatched values. Defaults to the global hostname
3739 For backwards compatibility, values are also dispatched with the global
3740 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3743 =item B<Address> I<Address>
3745 Hostname or IP to connect to. For backwards compatibility, defaults to the
3746 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3748 =item B<Port> I<Port>
3750 TCP port to connect to. Defaults to B<11211>.
3752 =item B<Socket> I<Path>
3754 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3755 setting is given, the B<Address> and B<Port> settings are ignored.
3759 =head2 Plugin C<mic>
3761 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3762 Intel's Many Integrated Core (MIC) systems.
3771 ShowTemperatures true
3774 IgnoreSelectedTemperature true
3779 IgnoreSelectedPower true
3782 The following options are valid inside the B<PluginE<nbsp>mic> block:
3786 =item B<ShowCPU> B<true>|B<false>
3788 If enabled (the default) a sum of the CPU usage across all cores is reported.
3790 =item B<ShowCPUCores> B<true>|B<false>
3792 If enabled (the default) per-core CPU usage is reported.
3794 =item B<ShowMemory> B<true>|B<false>
3796 If enabled (the default) the physical memory usage of the MIC system is
3799 =item B<ShowTemperatures> B<true>|B<false>
3801 If enabled (the default) various temperatures of the MIC system are reported.
3803 =item B<Temperature> I<Name>
3805 This option controls which temperatures are being reported. Whether matching
3806 temperatures are being ignored or I<only> matching temperatures are reported
3807 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3808 temperatures are reported.
3810 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3812 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3813 (the default) only temperatures matching a B<Temperature> option are reported
3814 or, if no B<Temperature> option is specified, all temperatures are reported. If
3815 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3818 Known temperature names are:
3852 =item B<ShowPower> B<true>|B<false>
3854 If enabled (the default) various temperatures of the MIC system are reported.
3856 =item B<Power> I<Name>
3858 This option controls which power readings are being reported. Whether matching
3859 power readings are being ignored or I<only> matching power readings are reported
3860 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3861 power readings are reported.
3863 =item B<IgnoreSelectedPower> B<false>|B<true>
3865 Controls the behavior of the B<Power> setting above. If set to B<false>
3866 (the default) only power readings matching a B<Power> option are reported
3867 or, if no B<Power> option is specified, all power readings are reported. If
3868 set to B<true>, matching power readings are I<ignored> and all other power readings
3871 Known power names are:
3877 Total power utilization averaged over Time Window 0 (uWatts).
3881 Total power utilization averaged over Time Window 0 (uWatts).
3885 Instantaneous power (uWatts).
3889 Max instantaneous power (uWatts).
3893 PCI-E connector power (uWatts).
3897 2x3 connector power (uWatts).
3901 2x4 connector power (uWatts).
3909 Uncore rail (uVolts).
3913 Memory subsystem rail (uVolts).
3919 =head2 Plugin C<memory>
3921 The I<memory plugin> provides the following configuration options:
3925 =item B<ValuesAbsolute> B<true>|B<false>
3927 Enables or disables reporting of physical memory usage in absolute numbers,
3928 i.e. bytes. Defaults to B<true>.
3930 =item B<ValuesPercentage> B<false>|B<true>
3932 Enables or disables reporting of physical memory usage in percentages, e.g.
3933 percent of physical memory used. Defaults to B<false>.
3935 This is useful for deploying I<collectd> in a heterogeneous environment in
3936 which the sizes of physical memory vary.
3940 =head2 Plugin C<modbus>
3942 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3943 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3944 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3945 values (two registers interpreted as IEEE floats in big endian notation).
3949 <Data "voltage-input-1">
3952 RegisterCmd ReadHolding
3957 <Data "voltage-input-2">
3960 RegisterCmd ReadHolding
3965 <Data "supply-temperature-1">
3968 RegisterCmd ReadHolding
3973 <Host "modbus.example.com">
3974 Address "192.168.0.42"
3979 Instance "power-supply"
3980 Collect "voltage-input-1"
3981 Collect "voltage-input-2"
3986 Device "/dev/ttyUSB0"
3991 Instance "temperature"
3992 Collect "supply-temperature-1"
3998 =item E<lt>B<Data> I<Name>E<gt> blocks
4000 Data blocks define a mapping between register numbers and the "types" used by
4003 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4007 =item B<RegisterBase> I<Number>
4009 Configures the base register to read from the device. If the option
4010 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4011 register will be read (the register number is increased by one).
4013 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
4015 Specifies what kind of data is returned by the device. If the type is B<Int32>,
4016 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
4017 combined into one value. Defaults to B<Uint16>.
4019 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4021 Specifies register type to be collected from device. Works only with libmodbus
4022 2.9.2 or higher. Defaults to B<ReadHolding>.
4024 =item B<Type> I<Type>
4026 Specifies the "type" (data set) to use when dispatching the value to
4027 I<collectd>. Currently, only data sets with exactly one data source are
4030 =item B<Instance> I<Instance>
4032 Sets the type instance to use when dispatching the value to I<collectd>. If
4033 unset, an empty string (no type instance) is used.
4037 =item E<lt>B<Host> I<Name>E<gt> blocks
4039 Host blocks are used to specify to which hosts to connect and what data to read
4040 from their "slaves". The string argument I<Name> is used as hostname when
4041 dispatching the values to I<collectd>.
4043 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4047 =item B<Address> I<Hostname>
4049 For Modbus/TCP, specifies the node name (the actual network address) used to
4050 connect to the host. This may be an IP address or a hostname. Please note that
4051 the used I<libmodbus> library only supports IPv4 at the moment.
4053 =item B<Port> I<Service>
4055 for Modbus/TCP, specifies the port used to connect to the host. The port can
4056 either be given as a number or as a service name. Please note that the
4057 I<Service> argument must be a string, even if ports are given in their numerical
4058 form. Defaults to "502".
4060 =item B<Device> I<Devicenode>
4062 For Modbus/RTU, specifies the path to the serial device being used.
4064 =item B<Baudrate> I<Baudrate>
4066 For Modbus/RTU, specifies the baud rate of the serial device.
4067 Note, connections currently support only 8/N/1.
4069 =item B<Interval> I<Interval>
4071 Sets the interval (in seconds) in which the values will be collected from this
4072 host. By default the global B<Interval> setting will be used.
4074 =item E<lt>B<Slave> I<ID>E<gt>
4076 Over each connection, multiple Modbus devices may be reached. The slave ID
4077 is used to specify which device should be addressed. For each device you want
4078 to query, one B<Slave> block must be given.
4080 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4084 =item B<Instance> I<Instance>
4086 Specify the plugin instance to use when dispatching the values to I<collectd>.
4087 By default "slave_I<ID>" is used.
4089 =item B<Collect> I<DataName>
4091 Specifies which data to retrieve from the device. I<DataName> must be the same
4092 string as the I<Name> argument passed to a B<Data> block. You can specify this
4093 option multiple times to collect more than one value from a slave. At least one
4094 B<Collect> option is mandatory.
4102 =head2 Plugin C<mqtt>
4104 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4105 values from MQTT (B<Subscribe> blocks).
4111 Host "mqtt.example.com"
4115 Host "mqtt.example.com"
4120 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4121 configuring the sending and receiving direction respectively. The plugin will
4122 register a write callback named C<mqtt/I<name>> where I<name> is the string
4123 argument given to the B<Publish> block. Both types of blocks share many but not
4124 all of the following options. If an option is valid in only one of the blocks,
4125 it will be mentioned explicitly.
4131 =item B<Host> I<Hostname>
4133 Hostname of the MQTT broker to connect to.
4135 =item B<Port> I<Service>
4137 Port number or service name of the MQTT broker to connect to.
4139 =item B<User> I<UserName>
4141 Username used when authenticating to the MQTT broker.
4143 =item B<Password> I<Password>
4145 Password used when authenticating to the MQTT broker.
4147 =item B<ClientId> I<ClientId>
4149 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4151 =item B<QoS> [B<0>-B<2>]
4153 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4171 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4172 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4173 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4174 on a message is larger than the maximum accepted QoS of a subscriber, the
4175 message's QoS will be downgraded.
4177 =item B<Prefix> I<Prefix> (Publish only)
4179 This plugin will use one topic per I<value list> which will looks like a path.
4180 I<Prefix> is used as the first path element and defaults to B<collectd>.
4182 An example topic name would be:
4184 collectd/cpu-0/cpu-user
4186 =item B<Retain> B<false>|B<true> (Publish only)
4188 Controls whether the MQTT broker will retain (keep a copy of) the last message
4189 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4191 =item B<StoreRates> B<true>|B<false> (Publish only)
4193 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4194 before sending. Defaults to B<true>.
4196 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4198 Controls whether the MQTT "cleans" the session up after the subscriber
4199 disconnects or if it maintains the subscriber's subscriptions and all messages
4200 that arrive while the subscriber is disconnected. Defaults to B<true>.
4202 =item B<Topic> I<TopicName> (Subscribe only)
4204 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4205 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4206 the B<collectd> branch.
4208 =item B<CACert> I<file>
4210 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4211 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4212 port of the MQTT broker.
4213 This option enables the use of TLS.
4215 =item B<CertificateFile> I<file>
4217 Path to the PEM-encoded certificate file to use as client certificate when
4218 connecting to the MQTT broker.
4219 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4221 =item B<CertificateKeyFile> I<file>
4223 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4224 Only valid if B<CACert> and B<CertificateFile> are also set.
4226 =item B<TLSProtocol> I<protocol>
4228 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4229 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4230 version is used which depends on the version of OpenSSL the Mosquitto library
4232 Only valid if B<CACert> is set.
4234 =item B<CipherSuite> I<ciphersuite>
4236 A string describing the ciphers available for use. See L<ciphers(1)> and the
4237 C<openssl ciphers> utility for more information. If unset, the default ciphers
4239 Only valid if B<CACert> is set.
4243 =head2 Plugin C<mysql>
4245 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4246 one or more databases when started and keeps the connection up as long as
4247 possible. When the connection is interrupted for whatever reason it will try
4248 to re-connect. The plugin will complain loudly in case anything goes wrong.
4250 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4251 and collects information about MySQL network traffic, executed statements,
4252 requests, the query cache and threads by evaluating the
4253 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4254 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4255 Status Variables> for an explanation of these values.
4257 Optionally, master and slave statistics may be collected in a MySQL
4258 replication setup. In that case, information about the synchronization state
4259 of the nodes are collected by evaluating the C<Position> return value of the
4260 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4261 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4262 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4263 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4264 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4276 SSLKey "/path/to/key.pem"
4277 SSLCert "/path/to/cert.pem"
4278 SSLCA "/path/to/ca.pem"
4279 SSLCAPath "/path/to/cas/"
4280 SSLCipher "DHE-RSA-AES256-SHA"
4286 Socket "/var/run/mysql/mysqld.sock"
4288 SlaveNotifications true
4294 Socket "/var/run/mysql/mysqld.sock"
4299 A B<Database> block defines one connection to a MySQL database. It accepts a
4300 single argument which specifies the name of the database. None of the other
4301 options are required. MySQL will use default values as documented in the
4302 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4303 B<MySQL reference manual>.
4307 =item B<Alias> I<Alias>
4309 Alias to use as sender instead of hostname when reporting. This may be useful
4310 when having cryptic hostnames.
4312 =item B<Host> I<Hostname>
4314 Hostname of the database server. Defaults to B<localhost>.
4316 =item B<User> I<Username>
4318 Username to use when connecting to the database. The user does not have to be
4319 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4320 unless you want to collectd replication statistics (see B<MasterStats> and
4321 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4322 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4324 =item B<Password> I<Password>
4326 Password needed to log into the database.
4328 =item B<Database> I<Database>
4330 Select this database. Defaults to I<no database> which is a perfectly reasonable
4331 option for what this plugin does.
4333 =item B<Port> I<Port>
4335 TCP-port to connect to. The port must be specified in its numeric form, but it
4336 must be passed as a string nonetheless. For example:
4340 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4341 See the documentation for the C<mysql_real_connect> function for details.
4343 =item B<Socket> I<Socket>
4345 Specifies the path to the UNIX domain socket of the MySQL server. This option
4346 only has any effect, if B<Host> is set to B<localhost> (the default).
4347 Otherwise, use the B<Port> option above. See the documentation for the
4348 C<mysql_real_connect> function for details.
4350 =item B<InnodbStats> I<true|false>
4352 If enabled, metrics about the InnoDB storage engine are collected.
4353 Disabled by default.
4355 =item B<MasterStats> I<true|false>
4357 =item B<SlaveStats> I<true|false>
4359 Enable the collection of master / slave statistics in a replication setup. In
4360 order to be able to get access to these statistics, the user needs special
4361 privileges. See the B<User> documentation above. Defaults to B<false>.
4363 =item B<SlaveNotifications> I<true|false>
4365 If enabled, the plugin sends a notification if the replication slave I/O and /
4366 or SQL threads are not running. Defaults to B<false>.
4368 =item B<WsrepStats> I<true|false>
4370 Enable the collection of wsrep plugin statistics, used in Master-Master
4371 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4372 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4374 =item B<ConnectTimeout> I<Seconds>
4376 Sets the connect timeout for the MySQL client.
4378 =item B<SSLKey> I<Path>
4380 If provided, the X509 key in PEM format.
4382 =item B<SSLCert> I<Path>
4384 If provided, the X509 cert in PEM format.
4386 =item B<SSLCA> I<Path>
4388 If provided, the CA file in PEM format (check OpenSSL docs).
4390 =item B<SSLCAPath> I<Path>
4392 If provided, the CA directory (check OpenSSL docs).
4394 =item B<SSLCipher> I<String>
4396 If provided, the SSL cipher to use.
4400 =head2 Plugin C<netapp>
4402 The netapp plugin can collect various performance and capacity information
4403 from a NetApp filer using the NetApp API.
4405 Please note that NetApp has a wide line of products and a lot of different
4406 software versions for each of these products. This plugin was developed for a
4407 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4408 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4409 model and software version but it is very hard to test this.
4410 If you have used this plugin with other models and/or software version, feel
4411 free to send us a mail to tell us about the results, even if it's just a short
4414 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4415 basic authentication.
4417 B<Do not use a regular user for this!> Create a special collectd user with just
4418 the minimum of capabilities needed. The user only needs the "login-http-admin"
4419 capability as well as a few more depending on which data will be collected.
4420 Required capabilities are documented below.
4425 <Host "netapp1.example.com">
4449 IgnoreSelectedIO false
4451 IgnoreSelectedOps false
4452 GetLatency "volume0"
4453 IgnoreSelectedLatency false
4460 IgnoreSelectedCapacity false
4463 IgnoreSelectedSnapshot false
4491 The netapp plugin accepts the following configuration options:
4495 =item B<Host> I<Name>
4497 A host block defines one NetApp filer. It will appear in collectd with the name
4498 you specify here which does not have to be its real name nor its hostname (see
4499 the B<Address> option below).
4501 =item B<VFiler> I<Name>
4503 A B<VFiler> block may only be used inside a host block. It accepts all the
4504 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4505 will execute all NetApp API commands in the context of the specified
4506 VFiler(R). It will appear in collectd with the name you specify here which
4507 does not have to be its real name. The VFiler name may be specified using the
4508 B<VFilerName> option. If this is not specified, it will default to the name
4511 The VFiler block inherits all connection related settings from the surrounding
4512 B<Host> block (which appear before the B<VFiler> block) but they may be
4513 overwritten inside the B<VFiler> block.
4515 This feature is useful, for example, when using a VFiler as SnapVault target
4516 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4517 available in the host filer (vfiler0) but only in the respective VFiler
4520 =item B<Protocol> B<httpd>|B<http>
4522 The protocol collectd will use to query this host.
4530 Valid options: http, https
4532 =item B<Address> I<Address>
4534 The hostname or IP address of the host.
4540 Default: The "host" block's name.
4542 =item B<Port> I<Port>
4544 The TCP port to connect to on the host.
4550 Default: 80 for protocol "http", 443 for protocol "https"
4552 =item B<User> I<User>
4554 =item B<Password> I<Password>
4556 The username and password to use to login to the NetApp.
4562 =item B<VFilerName> I<Name>
4564 The name of the VFiler in which context to execute API commands. If not
4565 specified, the name provided to the B<VFiler> block will be used instead.
4571 Default: name of the B<VFiler> block
4573 B<Note:> This option may only be used inside B<VFiler> blocks.
4575 =item B<Interval> I<Interval>
4581 The following options decide what kind of data will be collected. You can
4582 either use them as a block and fine tune various parameters inside this block,
4583 use them as a single statement to just accept all default values, or omit it to
4584 not collect any data.
4586 The following options are valid inside all blocks:
4590 =item B<Interval> I<Seconds>
4592 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4593 host specific setting.
4597 =head3 The System block
4599 This will collect various performance data about the whole system.
4601 B<Note:> To get this data the collectd user needs the
4602 "api-perf-object-get-instances" capability.
4606 =item B<Interval> I<Seconds>
4608 Collect disk statistics every I<Seconds> seconds.
4610 =item B<GetCPULoad> B<true>|B<false>
4612 If you set this option to true the current CPU usage will be read. This will be
4613 the average usage between all CPUs in your NetApp without any information about
4616 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4617 returns in the "CPU" field.
4625 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4627 =item B<GetInterfaces> B<true>|B<false>
4629 If you set this option to true the current traffic of the network interfaces
4630 will be read. This will be the total traffic over all interfaces of your NetApp
4631 without any information about individual interfaces.
4633 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4634 in the "Net kB/s" field.
4644 Result: One value list of type "if_octects".
4646 =item B<GetDiskIO> B<true>|B<false>
4648 If you set this option to true the current IO throughput will be read. This
4649 will be the total IO of your NetApp without any information about individual
4650 disks, volumes or aggregates.
4652 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4653 in the "DiskE<nbsp>kB/s" field.
4661 Result: One value list of type "disk_octets".
4663 =item B<GetDiskOps> B<true>|B<false>
4665 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4666 iSCSI, etc. operations will be read. This will be the total number of
4667 operations on your NetApp without any information about individual volumes or
4670 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4671 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4679 Result: A variable number of value lists of type "disk_ops_complex". Each type
4680 of operation will result in one value list with the name of the operation as
4685 =head3 The WAFL block
4687 This will collect various performance data about the WAFL file system. At the
4688 moment this just means cache performance.
4690 B<Note:> To get this data the collectd user needs the
4691 "api-perf-object-get-instances" capability.
4693 B<Note:> The interface to get these values is classified as "Diagnostics" by
4694 NetApp. This means that it is not guaranteed to be stable even between minor
4699 =item B<Interval> I<Seconds>
4701 Collect disk statistics every I<Seconds> seconds.
4703 =item B<GetNameCache> B<true>|B<false>
4711 Result: One value list of type "cache_ratio" and type instance
4714 =item B<GetDirCache> B<true>|B<false>
4722 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4724 =item B<GetInodeCache> B<true>|B<false>
4732 Result: One value list of type "cache_ratio" and type instance
4735 =item B<GetBufferCache> B<true>|B<false>
4737 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4738 in the "Cache hit" field.
4746 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4750 =head3 The Disks block
4752 This will collect performance data about the individual disks in the NetApp.
4754 B<Note:> To get this data the collectd user needs the
4755 "api-perf-object-get-instances" capability.
4759 =item B<Interval> I<Seconds>
4761 Collect disk statistics every I<Seconds> seconds.
4763 =item B<GetBusy> B<true>|B<false>
4765 If you set this option to true the busy time of all disks will be calculated
4766 and the value of the busiest disk in the system will be written.
4768 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4769 in the "Disk util" field. Probably.
4777 Result: One value list of type "percent" and type instance "disk_busy".
4781 =head3 The VolumePerf block
4783 This will collect various performance data about the individual volumes.
4785 You can select which data to collect about which volume using the following
4786 options. They follow the standard ignorelist semantic.
4788 B<Note:> To get this data the collectd user needs the
4789 I<api-perf-object-get-instances> capability.
4793 =item B<Interval> I<Seconds>
4795 Collect volume performance data every I<Seconds> seconds.
4797 =item B<GetIO> I<Volume>
4799 =item B<GetOps> I<Volume>
4801 =item B<GetLatency> I<Volume>
4803 Select the given volume for IO, operations or latency statistics collection.
4804 The argument is the name of the volume without the C</vol/> prefix.
4806 Since the standard ignorelist functionality is used here, you can use a string
4807 starting and ending with a slash to specify regular expression matching: To
4808 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4811 GetIO "/^vol[027]$/"
4813 If no regular expression is specified, an exact match is required. Both,
4814 regular and exact matching are case sensitive.
4816 If no volume was specified at all for either of the three options, that data
4817 will be collected for all available volumes.
4819 See F</"IGNORELISTS"> for details.
4821 =item B<IgnoreSelectedIO> B<true>|B<false>
4823 =item B<IgnoreSelectedOps> B<true>|B<false>
4825 =item B<IgnoreSelectedLatency> B<true>|B<false>
4827 When set to B<true>, the volumes selected for IO, operations or latency
4828 statistics collection will be ignored and the data will be collected for all
4831 When set to B<false>, data will only be collected for the specified volumes and
4832 all other volumes will be ignored.
4834 If no volumes have been specified with the above B<Get*> options, all volumes
4835 will be collected regardless of the B<IgnoreSelected*> option.
4837 Defaults to B<false>
4841 =head3 The VolumeUsage block
4843 This will collect capacity data about the individual volumes.
4845 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4850 =item B<Interval> I<Seconds>
4852 Collect volume usage statistics every I<Seconds> seconds.
4854 =item B<GetCapacity> I<VolumeName>
4856 The current capacity of the volume will be collected. This will result in two
4857 to four value lists, depending on the configuration of the volume. All data
4858 sources are of type "df_complex" with the name of the volume as
4861 There will be type_instances "used" and "free" for the number of used and
4862 available bytes on the volume. If the volume has some space reserved for
4863 snapshots, a type_instance "snap_reserved" will be available. If the volume
4864 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4865 number of bytes saved by the SIS feature.
4867 B<Note:> The current NetApp API has a bug that results in this value being
4868 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4869 number which works most of the time. If you see strange values here, bug
4870 NetApp support to fix this.
4872 Repeat this option to specify multiple volumes.
4874 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4876 Specify whether to collect only the volumes selected by the B<GetCapacity>
4877 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4878 B<false>. However, if no B<GetCapacity> option is specified at all, all
4879 capacities will be selected anyway.
4881 =item B<GetSnapshot> I<VolumeName>
4883 Select volumes from which to collect snapshot information.
4885 Usually, the space used for snapshots is included in the space reported as
4886 "used". If snapshot information is collected as well, the space used for
4887 snapshots is subtracted from the used space.
4889 To make things even more interesting, it is possible to reserve space to be
4890 used for snapshots. If the space required for snapshots is less than that
4891 reserved space, there is "reserved free" and "reserved used" space in addition
4892 to "free" and "used". If the space required for snapshots exceeds the reserved
4893 space, that part allocated in the normal space is subtracted from the "used"
4896 Repeat this option to specify multiple volumes.
4898 =item B<IgnoreSelectedSnapshot>
4900 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4901 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4902 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4903 capacities will be selected anyway.
4907 =head3 The Quota block
4909 This will collect (tree) quota statistics (used disk space and number of used
4910 files). This mechanism is useful to get usage information for single qtrees.
4911 In case the quotas are not used for any other purpose, an entry similar to the
4912 following in C</etc/quotas> would be sufficient:
4914 /vol/volA/some_qtree tree - - - - -
4916 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4920 =item B<Interval> I<Seconds>
4922 Collect SnapVault(R) statistics every I<Seconds> seconds.
4926 =head3 The SnapVault block
4928 This will collect statistics about the time and traffic of SnapVault(R)
4933 =item B<Interval> I<Seconds>
4935 Collect SnapVault(R) statistics every I<Seconds> seconds.
4939 =head2 Plugin C<netlink>
4941 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4942 statistics of various interface and routing aspects.
4946 =item B<Interface> I<Interface>
4948 =item B<VerboseInterface> I<Interface>
4950 Instruct the plugin to collect interface statistics. This is basically the same
4951 as the statistics provided by the C<interface> plugin (see above) but
4952 potentially much more detailed.
4954 When configuring with B<Interface> only the basic statistics will be collected,
4955 namely octets, packets, and errors. These statistics are collected by
4956 the C<interface> plugin, too, so using both at the same time is no benefit.
4958 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4959 so that no data needs to be collected twice if you use the C<interface> plugin.
4960 This includes dropped packets, received multicast packets, collisions and a
4961 whole zoo of differentiated RX and TX errors. You can try the following command
4962 to get an idea of what awaits you:
4966 If I<Interface> is B<All>, all interfaces will be selected.
4968 =item B<QDisc> I<Interface> [I<QDisc>]
4970 =item B<Class> I<Interface> [I<Class>]
4972 =item B<Filter> I<Interface> [I<Filter>]
4974 Collect the octets and packets that pass a certain qdisc, class or filter.
4976 QDiscs and classes are identified by their type and handle (or classid).
4977 Filters don't necessarily have a handle, therefore the parent's handle is used.
4978 The notation used in collectd differs from that used in tc(1) in that it
4979 doesn't skip the major or minor number if it's zero and doesn't print special
4980 ids by their name. So, for example, a qdisc may be identified by
4981 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
4982 thus not displayed by tc(1).
4984 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
4985 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
4986 associated with that interface will be collected.
4988 Since a filter itself doesn't necessarily have a handle, the parent's handle is
4989 used. This may lead to problems when more than one filter is attached to a
4990 qdisc or class. This isn't nice, but we don't know how this could be done any
4991 better. If you have a idea, please don't hesitate to tell us.
4993 As with the B<Interface> option you can specify B<All> as the interface,
4994 meaning all interfaces.
4996 Here are some examples to help you understand the above text more easily:
4999 VerboseInterface "All"
5000 QDisc "eth0" "pfifo_fast-1:0"
5002 Class "ppp0" "htb-1:10"
5003 Filter "ppp0" "u32-1:0"
5006 See F</"IGNORELISTS"> for details.
5008 =item B<IgnoreSelected>
5010 The behavior is the same as with all other similar plugins: If nothing is
5011 selected at all, everything is collected. If some things are selected using the
5012 options described above, only these statistics are collected. If you set
5013 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5014 specified statistics will not be collected.
5018 =head2 Plugin C<network>
5020 The Network plugin sends data to a remote instance of collectd, receives data
5021 from a remote instance, or both at the same time. Data which has been received
5022 from the network is usually not transmitted again, but this can be activated, see
5023 the B<Forward> option below.
5025 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5026 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5028 Both, B<Server> and B<Listen> can be used as single option or as block. When
5029 used as block, given options are valid for this socket only. The following
5030 example will export the metrics twice: Once to an "internal" server (without
5031 encryption and signing) and one to an external server (with cryptographic
5035 # Export to an internal server
5036 # (demonstrates usage without additional options)
5037 Server "collectd.internal.tld"
5039 # Export to an external server
5040 # (demonstrates usage with signature options)
5041 <Server "collectd.external.tld">
5042 SecurityLevel "sign"
5043 Username "myhostname"
5050 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5052 The B<Server> statement/block sets the server to send datagrams to. The
5053 statement may occur multiple times to send each datagram to multiple
5056 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5057 optional second argument specifies a port number or a service name. If not
5058 given, the default, B<25826>, is used.
5060 The following options are recognized within B<Server> blocks:
5064 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5066 Set the security you require for network communication. When the security level
5067 has been set to B<Encrypt>, data sent over the network will be encrypted using
5068 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5069 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5070 authentication code. When set to B<None>, data is sent without any security.
5072 This feature is only available if the I<network> plugin was linked with
5075 =item B<Username> I<Username>
5077 Sets the username to transmit. This is used by the server to lookup the
5078 password. See B<AuthFile> below. All security levels except B<None> require
5081 This feature is only available if the I<network> plugin was linked with
5084 =item B<Password> I<Password>
5086 Sets a password (shared secret) for this socket. All security levels except
5087 B<None> require this setting.
5089 This feature is only available if the I<network> plugin was linked with
5092 =item B<Interface> I<Interface name>
5094 Set the outgoing interface for IP packets. This applies at least
5095 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5096 undefined or a non-existent interface name is specified, the default
5097 behavior is to let the kernel choose the appropriate interface. Be warned
5098 that the manual selection of an interface for unicast traffic is only
5099 necessary in rare cases.
5101 =item B<ResolveInterval> I<Seconds>
5103 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5104 useful to force a regular DNS lookup to support a high availability setup. If
5105 not specified, re-resolves are never attempted.
5109 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5111 The B<Listen> statement sets the interfaces to bind to. When multiple
5112 statements are found the daemon will bind to multiple interfaces.
5114 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5115 the argument is a multicast address the daemon will join that multicast group.
5116 The optional second argument specifies a port number or a service name. If not
5117 given, the default, B<25826>, is used.
5119 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5123 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5125 Set the security you require for network communication. When the security level
5126 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5127 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5128 signed and encrypted data is accepted. When set to B<None>, all data will be
5129 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5130 decrypted if possible.
5132 This feature is only available if the I<network> plugin was linked with
5135 =item B<AuthFile> I<Filename>
5137 Sets a file in which usernames are mapped to passwords. These passwords are
5138 used to verify signatures and to decrypt encrypted network packets. If
5139 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5140 verified and encrypted packets are decrypted. Otherwise, signed data is
5141 accepted without checking the signature and encrypted data cannot be decrypted.
5142 For the other security levels this option is mandatory.
5144 The file format is very simple: Each line consists of a username followed by a
5145 colon and any number of spaces followed by the password. To demonstrate, an
5146 example file could look like this:
5151 Each time a packet is received, the modification time of the file is checked
5152 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5153 the file is being read, it is locked using L<fcntl(2)>.
5155 =item B<Interface> I<Interface name>
5157 Set the incoming interface for IP packets explicitly. This applies at least
5158 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5159 undefined or a non-existent interface name is specified, the default
5160 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5161 traffic gets only accepted, if it arrives on the given interface.
5165 =item B<TimeToLive> I<1-255>
5167 Set the time-to-live of sent packets. This applies to all, unicast and
5168 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5169 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5172 =item B<MaxPacketSize> I<1024-65535>
5174 Set the maximum size for datagrams received over the network. Packets larger
5175 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5176 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5179 On the server side, this limit should be set to the largest value used on
5180 I<any> client. Likewise, the value on the client must not be larger than the
5181 value on the server, or data will be lost.
5183 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5184 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5185 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5188 =item B<Forward> I<true|false>
5190 If set to I<true>, write packets that were received via the network plugin to
5191 the sending sockets. This should only be activated when the B<Listen>- and
5192 B<Server>-statements differ. Otherwise packets may be send multiple times to
5193 the same multicast group. While this results in more network traffic than
5194 necessary it's not a huge problem since the plugin has a duplicate detection,
5195 so the values will not loop.
5197 =item B<ReportStats> B<true>|B<false>
5199 The network plugin cannot only receive and send statistics, it can also create
5200 statistics about itself. Collectd data included the number of received and
5201 sent octets and packets, the length of the receive queue and the number of
5202 values handled. When set to B<true>, the I<Network plugin> will make these
5203 statistics available. Defaults to B<false>.
5207 =head2 Plugin C<nfs>
5209 The I<nfs plugin> collects information about the usage of the Network File
5210 System (NFS). It counts the number of procedure calls for each procedure,
5211 grouped by version and whether the system runs as server or client.
5213 It is possibly to omit metrics for a specific NFS version by setting one or
5214 more of the following options to B<false> (all of them default to B<true>).
5218 =item B<ReportV2> B<true>|B<false>
5220 =item B<ReportV3> B<true>|B<false>
5222 =item B<ReportV4> B<true>|B<false>
5226 =head2 Plugin C<nginx>
5228 This plugin collects the number of connections and requests handled by the
5229 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5230 queries the page provided by the C<ngx_http_stub_status_module> module, which
5231 isn't compiled by default. Please refer to
5232 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5233 how to compile and configure nginx and this module.
5235 The following options are accepted by the C<nginx plugin>:
5239 =item B<URL> I<http://host/nginx_status>
5241 Sets the URL of the C<ngx_http_stub_status_module> output.
5243 =item B<User> I<Username>
5245 Optional user name needed for authentication.
5247 =item B<Password> I<Password>
5249 Optional password needed for authentication.
5251 =item B<VerifyPeer> B<true|false>
5253 Enable or disable peer SSL certificate verification. See
5254 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5256 =item B<VerifyHost> B<true|false>
5258 Enable or disable peer host name verification. If enabled, the plugin checks
5259 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5260 certificate matches the host name provided by the B<URL> option. If this
5261 identity check fails, the connection is aborted. Obviously, only works when
5262 connecting to a SSL enabled server. Enabled by default.
5264 =item B<CACert> I<File>
5266 File that holds one or more SSL certificates. If you want to use HTTPS you will
5267 possibly need this option. What CA certificates come bundled with C<libcurl>
5268 and are checked by default depends on the distribution you use.
5270 =item B<Timeout> I<Milliseconds>
5272 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5273 milliseconds. By default, the configured B<Interval> is used to set the
5278 =head2 Plugin C<notify_desktop>
5280 This plugin sends a desktop notification to a notification daemon, as defined
5281 in the Desktop Notification Specification. To actually display the
5282 notifications, B<notification-daemon> is required and B<collectd> has to be
5283 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5284 environment variables have to be set correctly) and the D-Bus message bus.
5286 The Desktop Notification Specification can be found at
5287 L<http://www.galago-project.org/specs/notification/>.
5291 =item B<OkayTimeout> I<timeout>
5293 =item B<WarningTimeout> I<timeout>
5295 =item B<FailureTimeout> I<timeout>
5297 Set the I<timeout>, in milliseconds, after which to expire the notification
5298 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5299 been specified, the displayed notification will not be closed at all - the
5300 user has to do so herself. These options default to 5000. If a negative number
5301 has been specified, the default is used as well.
5305 =head2 Plugin C<notify_email>
5307 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5308 configured email address.
5310 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5312 Available configuration options:
5316 =item B<From> I<Address>
5318 Email address from which the emails should appear to come from.
5320 Default: C<root@localhost>
5322 =item B<Recipient> I<Address>
5324 Configures the email address(es) to which the notifications should be mailed.
5325 May be repeated to send notifications to multiple addresses.
5327 At least one B<Recipient> must be present for the plugin to work correctly.
5329 =item B<SMTPServer> I<Hostname>
5331 Hostname of the SMTP server to connect to.
5333 Default: C<localhost>
5335 =item B<SMTPPort> I<Port>
5337 TCP port to connect to.
5341 =item B<SMTPUser> I<Username>
5343 Username for ASMTP authentication. Optional.
5345 =item B<SMTPPassword> I<Password>
5347 Password for ASMTP authentication. Optional.
5349 =item B<Subject> I<Subject>
5351 Subject-template to use when sending emails. There must be exactly two
5352 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5353 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5356 Default: C<Collectd notify: %s@%s>
5360 =head2 Plugin C<notify_nagios>
5362 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5363 a I<passive service check result>.
5365 Available configuration options:
5369 =item B<CommandFile> I<Path>
5371 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5375 =head2 Plugin C<ntpd>
5377 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5380 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5381 the wire - using B<mode 7> specific requests. This mode is deprecated with
5382 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5383 correctly with them, the ntp daemon must be explicitly configured to
5384 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5385 manual page for details.
5387 Available configuration options for the C<ntpd> plugin:
5391 =item B<Host> I<Hostname>
5393 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5395 =item B<Port> I<Port>
5397 UDP-Port to connect to. Defaults to B<123>.
5399 =item B<ReverseLookups> B<true>|B<false>
5401 Sets whether or not to perform reverse lookups on peers. Since the name or
5402 IP-address may be used in a filename it is recommended to disable reverse
5403 lookups. The default is to do reverse lookups to preserve backwards
5404 compatibility, though.
5406 =item B<IncludeUnitID> B<true>|B<false>
5408 When a peer is a refclock, include the unit ID in the I<type instance>.
5409 Defaults to B<false> for backward compatibility.
5411 If two refclock peers use the same driver and this is B<false>, the plugin will
5412 try to write simultaneous measurements from both to the same type instance.
5413 This will result in error messages in the log and only one set of measurements
5418 =head2 Plugin C<nut>
5422 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5424 Add a UPS to collect data from. The format is identical to the one accepted by
5427 =item B<ForceSSL> B<true>|B<false>
5429 Stops connections from falling back to unsecured if an SSL connection
5430 cannot be established. Defaults to false if undeclared.
5432 =item B<VerifyPeer> I<true>|I<false>
5434 If set to true, requires a CAPath be provided. Will use the CAPath to find
5435 certificates to use as Trusted Certificates to validate a upsd server certificate.
5436 If validation of the upsd server certificate fails, the connection will not be
5437 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5438 will override and set ForceSSL to true.
5440 =item B<CAPath> I/path/to/certs/folder
5442 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5443 The folder pointed at must contain certificate(s) named according to their hash.
5444 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5445 occur because two different certs have the same hash value, Y can be incremented
5446 in order to avoid conflict. To create a symbolic link to a certificate the following
5447 command can be used from within the directory where the cert resides:
5449 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5451 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5452 generate links like the one described above for ALL certs in a given folder.
5454 C<c_rehash /path/to/certs/folder>
5456 =item B<ConnectTimeout> I<Milliseconds>
5458 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5459 By default, the configured B<Interval> is used to set the timeout.
5463 =head2 Plugin C<olsrd>
5465 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5466 the Optimized Link State Routing daemon and reads information about the current
5467 state of the meshed network.
5469 The following configuration options are understood:
5473 =item B<Host> I<Host>
5475 Connect to I<Host>. Defaults to B<"localhost">.
5477 =item B<Port> I<Port>
5479 Specifies the port to connect to. This must be a string, even if you give the
5480 port as a number rather than a service name. Defaults to B<"2006">.
5482 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5484 Specifies what information to collect about links, i.E<nbsp>e. direct
5485 connections of the daemon queried. If set to B<No>, no information is
5486 collected. If set to B<Summary>, the number of links and the average of all
5487 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5488 If set to B<Detail> LQ and NLQ are collected per link.
5490 Defaults to B<Detail>.
5492 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5494 Specifies what information to collect about routes of the daemon queried. If
5495 set to B<No>, no information is collected. If set to B<Summary>, the number of
5496 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5497 metric and ETX are collected per route.
5499 Defaults to B<Summary>.
5501 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5503 Specifies what information to collect about the global topology. If set to
5504 B<No>, no information is collected. If set to B<Summary>, the number of links
5505 in the entire topology and the average I<link quality> (LQ) is calculated.
5506 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5508 Defaults to B<Summary>.
5512 =head2 Plugin C<onewire>
5514 B<EXPERIMENTAL!> See notes below.
5516 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5517 L<http://owfs.org/> to read sensors connected via the onewire bus.
5519 It can be used in two possible modes - standard or advanced.
5521 In the standard mode only temperature sensors (sensors with the family code
5522 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5523 other sensors you would like to have included, please send a sort request to
5524 the mailing list. You can select sensors to be read or to be ignored depending
5525 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5526 walked and all sensors are read.
5528 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5529 experimental, below.
5531 In the advanced mode you can configure any sensor to be read (only numerical
5532 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5533 In this mode you have to list all the sensors. Neither default bus walk nor
5534 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5535 the path automatically and should produce compatible structure with the "standard"
5536 mode (basically the path is expected as for example
5537 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5538 "F10FCA000800" and the rest after the slash is considered the type - here
5540 There are two advantages to this mode - you can access virtually any sensor
5541 (not just temperature), select whether to use cached or directly read values
5542 and it is slighlty faster. The downside is more complex configuration.
5544 The two modes are distinguished automatically by the format of the address.
5545 It is not possible to mix the two modes. Once a full path is detected in any
5546 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5547 (and as standard addresses will fail parsing they will be ignored).
5551 =item B<Device> I<Device>
5553 Sets the device to read the values from. This can either be a "real" hardware
5554 device, such as a serial port or an USB port, or the address of the
5555 L<owserver(1)> socket, usually B<localhost:4304>.
5557 Though the documentation claims to automatically recognize the given address
5558 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5559 with that version, the following configuration worked for us:
5562 Device "-s localhost:4304"
5565 This directive is B<required> and does not have a default value.
5567 =item B<Sensor> I<Sensor>
5569 In the standard mode selects sensors to collect or to ignore
5570 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5571 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5572 and B<not> include the leading C<10.> family byte and point.
5573 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5574 sensors (see above) are read.
5576 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5577 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5578 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5580 As there can be multiple devices on the bus you can list multiple sensor (use
5581 multiple B<Sensor> elements).
5583 See F</"IGNORELISTS"> for details.
5585 =item B<IgnoreSelected> I<true>|I<false>
5587 If no configuration is given, the B<onewire> plugin will collect data from all
5588 sensors found. This may not be practical, especially if sensors are added and
5589 removed regularly. Sometimes, however, it's easier/preferred to collect only
5590 specific sensors or all sensors I<except> a few specified ones. This option
5591 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5592 B<Sensor> is inverted: All selected interfaces are ignored and all other
5593 interfaces are collected.
5595 Used only in the standard mode - see above.
5597 =item B<Interval> I<Seconds>
5599 Sets the interval in which all sensors should be read. If not specified, the
5600 global B<Interval> setting is used.
5604 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5605 work with big setups. It works with one sensor being attached to one
5606 controller, but as soon as you throw in a couple more senors and maybe a hub
5607 or two, reading all values will take more than ten seconds (the default
5608 interval). We will probably add some separate thread for reading the sensors
5609 and some cache or something like that, but it's not done yet. We will try to
5610 maintain backwards compatibility in the future, but we can't promise. So in
5611 short: If it works for you: Great! But keep in mind that the config I<might>
5612 change, though this is unlikely. Oh, and if you want to help improving this
5613 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5615 =head2 Plugin C<openldap>
5617 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5618 server correctly. The backend database C<monitor> needs to be loaded and
5619 working. See slapd-monitor(5) for the details.
5621 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5622 blocks. Each block requires one string argument as the instance name. For
5627 URL "ldap://localhost/"
5630 URL "ldaps://localhost/"
5634 The instance name will be used as the I<plugin instance>. To emulate the old
5635 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5636 plugin to work correctly, each instance name must be unique. This is not
5637 enforced by the plugin and it is your responsibility to ensure it is.
5639 The following options are accepted within each B<Instance> block:
5643 =item B<URL> I<ldap://host/binddn>
5645 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5648 =item B<BindDN> I<BindDN>
5650 Name in the form of an LDAP distinguished name intended to be used for
5651 authentication. Defaults to empty string to establish an anonymous authorization.
5653 =item B<Password> I<Password>
5655 Password for simple bind authentication. If this option is not set,
5656 unauthenticated bind operation is used.
5658 =item B<StartTLS> B<true|false>
5660 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5661 Disabled by default.
5663 =item B<VerifyHost> B<true|false>
5665 Enables or disables peer host name verification. If enabled, the plugin checks
5666 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5667 certificate matches the host name provided by the B<URL> option. If this
5668 identity check fails, the connection is aborted. Enabled by default.
5670 =item B<CACert> I<File>
5672 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5673 may possibly need this option. What CA certificates are checked by default
5674 depends on the distribution you use and can be changed with the usual ldap
5675 client configuration mechanisms. See ldap.conf(5) for the details.
5677 =item B<Timeout> I<Seconds>
5679 Sets the timeout value for ldap operations, in seconds. By default, the
5680 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5683 =item B<Version> I<Version>
5685 An integer which sets the LDAP protocol version number to use when connecting
5686 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5690 =head2 Plugin C<openvpn>
5692 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5693 traffic statistics about connected clients.
5695 To set up OpenVPN to write to the status file periodically, use the
5696 B<--status> option of OpenVPN.
5698 So, in a nutshell you need:
5700 openvpn $OTHER_OPTIONS \
5701 --status "/var/run/openvpn-status" 10
5707 =item B<StatusFile> I<File>
5709 Specifies the location of the status file.
5711 =item B<ImprovedNamingSchema> B<true>|B<false>
5713 When enabled, the filename of the status file will be used as plugin instance
5714 and the client's "common name" will be used as type instance. This is required
5715 when reading multiple status files. Enabling this option is recommended, but to
5716 maintain backwards compatibility this option is disabled by default.
5718 =item B<CollectCompression> B<true>|B<false>
5720 Sets whether or not statistics about the compression used by OpenVPN should be
5721 collected. This information is only available in I<single> mode. Enabled by
5724 =item B<CollectIndividualUsers> B<true>|B<false>
5726 Sets whether or not traffic information is collected for each connected client
5727 individually. If set to false, currently no traffic data is collected at all
5728 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5730 =item B<CollectUserCount> B<true>|B<false>
5732 When enabled, the number of currently connected clients or users is collected.
5733 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5734 can be configured independently from that option. Defaults to B<false>.
5738 =head2 Plugin C<oracle>
5740 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5741 Oracle® Database and lets you execute SQL statements there. It is very similar
5742 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5743 plugin's documentation above for details.
5746 <Query "out_of_stock">
5747 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5750 # InstancePrefix "foo"
5751 InstancesFrom "category"
5755 <Database "product_information">
5759 Query "out_of_stock"
5763 =head3 B<Query> blocks
5765 The Query blocks are handled identically to the Query blocks of the "dbi"
5766 plugin. Please see its documentation above for details on how to specify
5769 =head3 B<Database> blocks
5771 Database blocks define a connection to a database and which queries should be
5772 sent to that database. Each database needs a "name" as string argument in the
5773 starting tag of the block. This name will be used as "PluginInstance" in the
5774 values submitted to the daemon. Other than that, that name is not used.
5778 =item B<ConnectID> I<ID>
5780 Defines the "database alias" or "service name" to connect to. Usually, these
5781 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5783 =item B<Host> I<Host>
5785 Hostname to use when dispatching values for this database. Defaults to using
5786 the global hostname of the I<collectd> instance.
5788 =item B<Username> I<Username>
5790 Username used for authentication.
5792 =item B<Password> I<Password>
5794 Password used for authentication.
5796 =item B<Query> I<QueryName>
5798 Associates the query named I<QueryName> with this database connection. The
5799 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5800 blocks you want to refer to must be placed above the database block you want to
5805 =head2 Plugin C<ovs_events>
5807 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5808 connected interfaces, dispatches the values to collectd and sends the
5809 notification whenever the link state change occurs. This plugin uses OVS
5810 database to get a link state change notification.
5814 <Plugin "ovs_events">
5817 Socket "/var/run/openvswitch/db.sock"
5818 Interfaces "br0" "veth0"
5819 SendNotification true
5820 DispatchValues false
5823 The plugin provides the following configuration options:
5827 =item B<Address> I<node>
5829 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5830 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5831 option. See L<ovsdb-server(1)> for more details. The option may be either
5832 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5833 format. Defaults to B<'localhost'>.
5835 =item B<Port> I<service>
5837 TCP-port to connect to. Either a service name or a port number may be given.
5838 Defaults to B<6640>.
5840 =item B<Socket> I<path>
5842 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5843 plugin. To enable the interface, the OVS DB daemon should be running with
5844 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5845 option is set, B<Address> and B<Port> options are ignored.
5847 =item B<Interfaces> [I<ifname> ...]
5849 List of interface names to be monitored by this plugin. If this option is not
5850 specified or is empty then all OVS connected interfaces on all bridges are
5853 Default: empty (all interfaces on all bridges are monitored)
5855 =item B<SendNotification> I<true|false>
5857 If set to true, OVS link notifications (interface status and OVS DB connection
5858 terminate) are sent to collectd. Default value is true.
5860 =item B<DispatchValues> I<true|false>
5862 Dispatch the OVS DB interface link status value with configured plugin interval.
5863 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
5864 options are false, no OVS information will be provided by the plugin.
5868 B<Note:> By default, the global interval setting is used within which to
5869 retrieve the OVS link status. To configure a plugin-specific interval, please
5870 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
5871 simple divide the time by 1000 for example if the desired interval is 50ms, set
5874 =head2 Plugin C<ovs_stats>
5876 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
5877 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
5878 statistics from OVSDB
5882 <Plugin "ovs_stats">
5885 Socket "/var/run/openvswitch/db.sock"
5886 Bridges "br0" "br_ext"
5889 The plugin provides the following configuration options:
5893 =item B<Address> I<node>
5895 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5896 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5897 option. See L<ovsdb-server(1)> for more details. The option may be either
5898 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5899 format. Defaults to B<'localhost'>.
5901 =item B<Port> I<service>
5903 TCP-port to connect to. Either a service name or a port number may be given.
5904 Defaults to B<6640>.
5906 =item B<Socket> I<path>
5908 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5909 plugin. To enable the interface, the OVS DB daemon should be running with
5910 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5911 option is set, B<Address> and B<Port> options are ignored.
5913 =item B<Bridges> [I<brname> ...]
5915 List of OVS bridge names to be monitored by this plugin. If this option is
5916 omitted or is empty then all OVS bridges will be monitored.
5918 Default: empty (monitor all bridges)
5922 =head2 Plugin C<perl>
5924 This plugin embeds a Perl-interpreter into collectd and provides an interface
5925 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5927 =head2 Plugin C<pinba>
5929 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5930 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5931 PHP-based webpage has been delivered, the extension will send a UDP packet
5932 containing timing information, peak memory usage and so on. The plugin will
5933 wait for such packets, parse them and account the provided information, which
5934 is then dispatched to the daemon once per interval.
5941 # Overall statistics for the website.
5943 Server "www.example.com"
5945 # Statistics for www-a only
5947 Host "www-a.example.com"
5948 Server "www.example.com"
5950 # Statistics for www-b only
5952 Host "www-b.example.com"
5953 Server "www.example.com"
5957 The plugin provides the following configuration options:
5961 =item B<Address> I<Node>
5963 Configures the address used to open a listening socket. By default, plugin will
5964 bind to the I<any> address C<::0>.
5966 =item B<Port> I<Service>
5968 Configures the port (service) to bind to. By default the default Pinba port
5969 "30002" will be used. The option accepts service names in addition to port
5970 numbers and thus requires a I<string> argument.
5972 =item E<lt>B<View> I<Name>E<gt> block
5974 The packets sent by the Pinba extension include the hostname of the server, the
5975 server name (the name of the virtual host) and the script that was executed.
5976 Using B<View> blocks it is possible to separate the data into multiple groups
5977 to get more meaningful statistics. Each packet is added to all matching groups,
5978 so that a packet may be accounted for more than once.
5982 =item B<Host> I<Host>
5984 Matches the hostname of the system the webserver / script is running on. This
5985 will contain the result of the L<gethostname(2)> system call. If not
5986 configured, all hostnames will be accepted.
5988 =item B<Server> I<Server>
5990 Matches the name of the I<virtual host>, i.e. the contents of the
5991 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
5992 server names will be accepted.
5994 =item B<Script> I<Script>
5996 Matches the name of the I<script name>, i.e. the contents of the
5997 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
5998 script names will be accepted.
6004 =head2 Plugin C<ping>
6006 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6007 configured hosts periodically and measures the network latency. Whenever the
6008 C<read> function of the plugin is called, it submits the average latency, the
6009 standard deviation and the drop rate for each host.
6011 Available configuration options:
6015 =item B<Host> I<IP-address>
6017 Host to ping periodically. This option may be repeated several times to ping
6020 =item B<Interval> I<Seconds>
6022 Sets the interval in which to send ICMP echo packets to the configured hosts.
6023 This is B<not> the interval in which metrics are read from the plugin but the
6024 interval in which the hosts are "pinged". Therefore, the setting here should be
6025 smaller than or equal to the global B<Interval> setting. Fractional times, such
6026 as "1.24" are allowed.
6030 =item B<Timeout> I<Seconds>
6032 Time to wait for a response from the host to which an ICMP packet had been
6033 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6034 to be down or the packet to be dropped. This setting must be smaller than the
6035 B<Interval> setting above for the plugin to work correctly. Fractional
6036 arguments are accepted.
6040 =item B<TTL> I<0-255>
6042 Sets the Time-To-Live of generated ICMP packets.
6044 =item B<Size> I<size>
6046 Sets the size of the data payload in ICMP packet to specified I<size> (it
6047 will be filled with regular ASCII pattern). If not set, default 56 byte
6048 long string is used so that the packet size of an ICMPv4 packet is exactly
6049 64 bytes, similar to the behaviour of normal ping(1) command.
6051 =item B<SourceAddress> I<host>
6053 Sets the source address to use. I<host> may either be a numerical network
6054 address or a network hostname.
6056 =item B<Device> I<name>
6058 Sets the outgoing network device to be used. I<name> has to specify an
6059 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6062 =item B<MaxMissed> I<Packets>
6064 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6065 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6067 Default: B<-1> (disabled)
6071 =head2 Plugin C<postgresql>
6073 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6074 keeps a persistent connection to all configured databases and tries to
6075 reconnect if the connection has been interrupted. A database is configured by
6076 specifying a B<Database> block as described below. The default statistics are
6077 collected from PostgreSQL's B<statistics collector> which thus has to be
6078 enabled for this plugin to work correctly. This should usually be the case by
6079 default. See the section "The Statistics Collector" of the B<PostgreSQL
6080 Documentation> for details.
6082 By specifying custom database queries using a B<Query> block as described
6083 below, you may collect any data that is available from some PostgreSQL
6084 database. This way, you are able to access statistics of external daemons
6085 which are available in a PostgreSQL database or use future or special
6086 statistics provided by PostgreSQL without the need to upgrade your collectd
6089 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6090 PostgreSQL databases as well. This has been implemented in a generic way. You
6091 need to specify an SQL statement which will then be executed by collectd in
6092 order to write the data (see below for details). The benefit of that approach
6093 is that there is no fixed database layout. Rather, the layout may be optimized
6094 for the current setup.
6096 The B<PostgreSQL Documentation> manual can be found at
6097 L<http://www.postgresql.org/docs/manuals/>.
6101 Statement "SELECT magic FROM wizard WHERE host = $1;"
6105 InstancePrefix "magic"
6110 <Query rt36_tickets>
6111 Statement "SELECT COUNT(type) AS count, type \
6113 WHEN resolved = 'epoch' THEN 'open' \
6114 ELSE 'resolved' END AS type \
6115 FROM tickets) type \
6119 InstancePrefix "rt36_tickets"
6120 InstancesFrom "type"
6126 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6136 KRBSrvName "kerberos_service_name"
6142 Service "service_name"
6143 Query backend # predefined
6154 The B<Query> block defines one database query which may later be used by a
6155 database definition. It accepts a single mandatory argument which specifies
6156 the name of the query. The names of all queries have to be unique (see the
6157 B<MinVersion> and B<MaxVersion> options below for an exception to this
6160 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6161 B<Result> blocks may be used to extract multiple values from a single query.
6163 The following configuration options are available to define the query:
6167 =item B<Statement> I<sql query statement>
6169 Specify the I<sql query statement> which the plugin should execute. The string
6170 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6171 first, second, etc. parameter. The value of the parameters is specified by the
6172 B<Param> configuration option - see below for details. To include a literal
6173 B<$> character followed by a number, surround it with single quotes (B<'>).
6175 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6176 allowed. Note, however, that only a single command may be used. Semicolons are
6177 allowed as long as a single non-empty command has been specified only.
6179 The returned lines will be handled separately one after another.
6181 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6183 Specify the parameters which should be passed to the SQL query. The parameters
6184 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6185 they appear in the configuration file. The value of the parameter is
6186 determined depending on the value of the B<Param> option as follows:
6192 The configured hostname of the database connection. If a UNIX domain socket is
6193 used, the parameter expands to "localhost".
6197 The name of the database of the current connection.
6201 The name of the database plugin instance. See the B<Instance> option of the
6202 database specification below for details.
6206 The username used to connect to the database.
6210 The interval with which this database is queried (as specified by the database
6211 specific or global B<Interval> options).
6215 Please note that parameters are only supported by PostgreSQL's protocol
6216 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6218 =item B<PluginInstanceFrom> I<column>
6220 Specify how to create the "PluginInstance" for reporting this query results.
6221 Only one column is supported. You may concatenate fields and string values in
6222 the query statement to get the required results.
6224 =item B<MinVersion> I<version>
6226 =item B<MaxVersion> I<version>
6228 Specify the minimum or maximum version of PostgreSQL that this query should be
6229 used with. Some statistics might only be available with certain versions of
6230 PostgreSQL. This allows you to specify multiple queries with the same name but
6231 which apply to different versions, thus allowing you to use the same
6232 configuration in a heterogeneous environment.
6234 The I<version> has to be specified as the concatenation of the major, minor
6235 and patch-level versions, each represented as two-decimal-digit numbers. For
6236 example, version 8.2.3 will become 80203.
6240 The B<Result> block defines how to handle the values returned from the query.
6241 It defines which column holds which value and how to dispatch that value to
6246 =item B<Type> I<type>
6248 The I<type> name to be used when dispatching the values. The type describes
6249 how to handle the data and where to store it. See L<types.db(5)> for more
6250 details on types and their configuration. The number and type of values (as
6251 selected by the B<ValuesFrom> option) has to match the type of the given name.
6253 This option is mandatory.
6255 =item B<InstancePrefix> I<prefix>
6257 =item B<InstancesFrom> I<column0> [I<column1> ...]
6259 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6260 B<InstancePrefix> defines a static prefix that will be prepended to all type
6261 instances. B<InstancesFrom> defines the column names whose values will be used
6262 to create the type instance. Multiple values will be joined together using the
6263 hyphen (C<->) as separation character.
6265 The plugin itself does not check whether or not all built instances are
6266 different. It is your responsibility to assure that each is unique.
6268 Both options are optional. If none is specified, the type instance will be
6271 =item B<ValuesFrom> I<column0> [I<column1> ...]
6273 Names the columns whose content is used as the actual data for the data sets
6274 that are dispatched to the daemon. How many such columns you need is
6275 determined by the B<Type> setting as explained above. If you specify too many
6276 or not enough columns, the plugin will complain about that and no data will be
6277 submitted to the daemon.
6279 The actual data type, as seen by PostgreSQL, is not that important as long as
6280 it represents numbers. The plugin will automatically cast the values to the
6281 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6282 L<strtod(3)> functions, so anything supported by those functions is supported
6283 by the plugin as well.
6285 This option is required inside a B<Result> block and may be specified multiple
6286 times. If multiple B<ValuesFrom> options are specified, the columns are read
6291 The following predefined queries are available (the definitions can be found
6292 in the F<postgresql_default.conf> file which, by default, is available at
6293 C<I<prefix>/share/collectd/>):
6299 This query collects the number of backends, i.E<nbsp>e. the number of
6302 =item B<transactions>
6304 This query collects the numbers of committed and rolled-back transactions of
6309 This query collects the numbers of various table modifications (i.E<nbsp>e.
6310 insertions, updates, deletions) of the user tables.
6312 =item B<query_plans>
6314 This query collects the numbers of various table scans and returned tuples of
6317 =item B<table_states>
6319 This query collects the numbers of live and dead rows in the user tables.
6323 This query collects disk block access counts for user tables.
6327 This query collects the on-disk size of the database in bytes.
6331 In addition, the following detailed queries are available by default. Please
6332 note that each of those queries collects information B<by table>, thus,
6333 potentially producing B<a lot> of data. For details see the description of the
6334 non-by_table queries above.
6338 =item B<queries_by_table>
6340 =item B<query_plans_by_table>
6342 =item B<table_states_by_table>
6344 =item B<disk_io_by_table>
6348 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6349 mandatory argument specifying the name of the writer. This will then be used
6350 in the B<Database> specification in order to activate the writer instance. The
6351 names of all writers have to be unique. The following options may be
6356 =item B<Statement> I<sql statement>
6358 This mandatory option specifies the SQL statement that will be executed for
6359 each submitted value. A single SQL statement is allowed only. Anything after
6360 the first semicolon will be ignored.
6362 Nine parameters will be passed to the statement and should be specified as
6363 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6364 values are made available through those parameters:
6370 The timestamp of the queried value as an RFC 3339-formatted local time.
6374 The hostname of the queried value.
6378 The plugin name of the queried value.
6382 The plugin instance of the queried value. This value may be B<NULL> if there
6383 is no plugin instance.
6387 The type of the queried value (cf. L<types.db(5)>).
6391 The type instance of the queried value. This value may be B<NULL> if there is
6396 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6397 sources of the submitted value-list).
6401 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6402 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6403 B<StoreRates> is enabled (which is the default, see below), all types will be
6408 An array of the submitted values. The dimensions of the value name and value
6413 In general, it is advisable to create and call a custom function in the
6414 PostgreSQL database for this purpose. Any procedural language supported by
6415 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6418 =item B<StoreRates> B<false>|B<true>
6420 If set to B<true> (the default), convert counter values to rates. If set to
6421 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6426 The B<Database> block defines one PostgreSQL database for which to collect
6427 statistics. It accepts a single mandatory argument which specifies the
6428 database name. None of the other options are required. PostgreSQL will use
6429 default values as documented in the section "CONNECTING TO A DATABASE" in the
6430 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6431 the user collectd is run as and special environment variables. See the manpage
6436 =item B<Interval> I<seconds>
6438 Specify the interval with which the database should be queried. The default is
6439 to use the global B<Interval> setting.
6441 =item B<CommitInterval> I<seconds>
6443 This option may be used for database connections which have "writers" assigned
6444 (see above). If specified, it causes a writer to put several updates into a
6445 single transaction. This transaction will last for the specified amount of
6446 time. By default, each update will be executed in a separate transaction. Each
6447 transaction generates a fair amount of overhead which can, thus, be reduced by
6448 activating this option. The draw-back is, that data covering the specified
6449 amount of time will be lost, for example, if a single statement within the
6450 transaction fails or if the database server crashes.
6452 =item B<Instance> I<name>
6454 Specify the plugin instance name that should be used instead of the database
6455 name (which is the default, if this option has not been specified). This
6456 allows one to query multiple databases of the same name on the same host (e.g.
6457 when running multiple database server versions in parallel).
6458 The plugin instance name can also be set from the query result using
6459 the B<PluginInstanceFrom> option in B<Query> block.
6461 =item B<Host> I<hostname>
6463 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6464 value begins with a slash, it is interpreted as the directory name in which to
6465 look for the UNIX domain socket.
6467 This option is also used to determine the hostname that is associated with a
6468 collected data set. If it has been omitted or either begins with with a slash
6469 or equals B<localhost> it will be replaced with the global hostname definition
6470 of collectd. Any other value will be passed literally to collectd when
6471 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6473 =item B<Port> I<port>
6475 Specify the TCP port or the local UNIX domain socket file extension of the
6478 =item B<User> I<username>
6480 Specify the username to be used when connecting to the server.
6482 =item B<Password> I<password>
6484 Specify the password to be used when connecting to the server.
6486 =item B<ExpireDelay> I<delay>
6488 Skip expired values in query output.
6490 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6492 Specify whether to use an SSL connection when contacting the server. The
6493 following modes are supported:
6499 Do not use SSL at all.
6503 First, try to connect without using SSL. If that fails, try using SSL.
6505 =item I<prefer> (default)
6507 First, try to connect using SSL. If that fails, try without using SSL.
6515 =item B<Instance> I<name>
6517 Specify the plugin instance name that should be used instead of the database
6518 name (which is the default, if this option has not been specified). This
6519 allows one to query multiple databases of the same name on the same host (e.g.
6520 when running multiple database server versions in parallel).
6522 =item B<KRBSrvName> I<kerberos_service_name>
6524 Specify the Kerberos service name to use when authenticating with Kerberos 5
6525 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6526 B<PostgreSQL Documentation> for details.
6528 =item B<Service> I<service_name>
6530 Specify the PostgreSQL service name to use for additional parameters. That
6531 service has to be defined in F<pg_service.conf> and holds additional
6532 connection parameters. See the section "The Connection Service File" in the
6533 B<PostgreSQL Documentation> for details.
6535 =item B<Query> I<query>
6537 Specifies a I<query> which should be executed in the context of the database
6538 connection. This may be any of the predefined or user-defined queries. If no
6539 such option is given, it defaults to "backends", "transactions", "queries",
6540 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6541 has been specified). Else, the specified queries are used only.
6543 =item B<Writer> I<writer>
6545 Assigns the specified I<writer> backend to the database connection. This
6546 causes all collected data to be send to the database using the settings
6547 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6548 below for details on how to selectively send data to certain plugins).
6550 Each writer will register a flush callback which may be used when having long
6551 transactions enabled (see the B<CommitInterval> option above). When issuing
6552 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6553 transaction will be committed right away. Two different kinds of flush
6554 callbacks are available with the C<postgresql> plugin:
6560 Flush all writer backends.
6562 =item B<postgresql->I<database>
6564 Flush all writers of the specified I<database> only.
6570 =head2 Plugin C<powerdns>
6572 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6573 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6574 values, many of which are probably meaningless to most users, but may be useful
6575 for some. So you may chose which values to collect, but if you don't, some
6576 reasonable defaults will be collected.
6579 <Server "server_name">
6581 Collect "udp-answers" "udp-queries"
6582 Socket "/var/run/pdns.controlsocket"
6584 <Recursor "recursor_name">
6586 Collect "cache-hits" "cache-misses"
6587 Socket "/var/run/pdns_recursor.controlsocket"
6589 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6594 =item B<Server> and B<Recursor> block
6596 The B<Server> block defines one authoritative server to query, the B<Recursor>
6597 does the same for an recursing server. The possible options in both blocks are
6598 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6603 =item B<Collect> I<Field>
6605 Using the B<Collect> statement you can select which values to collect. Here,
6606 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6607 C<dlg-only-drops>, C<answers10-100>.
6609 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6610 When querying the server a C<SHOW *> command is issued in any case, because
6611 that's the only way of getting multiple values out of the server at once.
6612 collectd then picks out the values you have selected. When querying the
6613 recursor, a command is generated to query exactly these values. So if you
6614 specify invalid fields when querying the recursor, a syntax error may be
6615 returned by the daemon and collectd may not collect any values at all.
6617 If no B<Collect> statement is given, the following B<Server> values will be
6624 =item packetcache-hit
6626 =item packetcache-miss
6628 =item packetcache-size
6630 =item query-cache-hit
6632 =item query-cache-miss
6634 =item recursing-answers
6636 =item recursing-questions
6648 The following B<Recursor> values will be collected by default:
6652 =item noerror-answers
6654 =item nxdomain-answers
6656 =item servfail-answers
6674 Please note that up to that point collectd doesn't know what values are
6675 available on the server and values that are added do not need a change of the
6676 mechanism so far. However, the values must be mapped to collectd's naming
6677 scheme, which is done using a lookup table that lists all known values. If
6678 values are added in the future and collectd does not know about them, you will
6679 get an error much like this:
6681 powerdns plugin: submit: Not found in lookup table: foobar = 42
6683 In this case please file a bug report with the collectd team.
6685 =item B<Socket> I<Path>
6687 Configures the path to the UNIX domain socket to be used when connecting to the
6688 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6689 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6690 will be used for the recursor.
6694 =item B<LocalSocket> I<Path>
6696 Querying the recursor is done using UDP. When using UDP over UNIX domain
6697 sockets, the client socket needs a name in the file system, too. You can set
6698 this local name to I<Path> using the B<LocalSocket> option. The default is
6699 C<I<prefix>/var/run/collectd-powerdns>.
6703 =head2 Plugin C<processes>
6707 =item B<Process> I<Name>
6709 Select more detailed statistics of processes matching this name. The statistics
6710 collected for these selected processes are:
6711 - size of the resident segment size (RSS)
6712 - user- and system-time used
6713 - number of processes
6715 - number of open files (under Linux)
6716 - io data (where available)
6717 - context switches (under Linux)
6718 - minor and major pagefaults.
6720 Some platforms have a limit on the length of process names. I<Name> must stay
6723 =item B<ProcessMatch> I<name> I<regex>
6725 Similar to the B<Process> option this allows one to select more detailed
6726 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6727 details). The statistics of all matching processes are summed up and
6728 dispatched to the daemon using the specified I<name> as an identifier. This
6729 allows one to "group" several processes together. I<name> must not contain
6732 =item B<CollectContextSwitch> I<Boolean>
6734 Collect context switch of the process.
6738 =head2 Plugin C<protocols>
6740 Collects a lot of information about various network protocols, such as I<IP>,
6741 I<TCP>, I<UDP>, etc.
6743 Available configuration options:
6747 =item B<Value> I<Selector>
6749 Selects whether or not to select a specific value. The string being matched is
6750 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6751 plugin instance and I<ValueName> will be used as type instance. An example of
6752 the string being used would be C<Tcp:RetransSegs>.
6754 You can use regular expressions to match a large number of values with just one
6755 configuration option. To select all "extended" I<TCP> values, you could use the
6756 following statement:
6760 Whether only matched values are selected or all matched values are ignored
6761 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6762 If no value is configured at all, all values will be selected.
6764 See F</"IGNORELISTS"> for details.
6766 =item B<IgnoreSelected> B<true>|B<false>
6768 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6769 matching values will be ignored.
6773 =head2 Plugin C<python>
6775 This plugin embeds a Python-interpreter into collectd and provides an interface
6776 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6778 =head2 Plugin C<routeros>
6780 The C<routeros> plugin connects to a device running I<RouterOS>, the
6781 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6782 I<librouteros> to connect and reads information about the interfaces and
6783 wireless connections of the device. The configuration supports querying
6788 Host "router0.example.com"
6791 CollectInterface true
6796 Host "router1.example.com"
6799 CollectInterface true
6800 CollectRegistrationTable true
6806 As you can see above, the configuration of the I<routeros> plugin consists of
6807 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6808 options are understood:
6812 =item B<Host> I<Host>
6814 Hostname or IP-address of the router to connect to.
6816 =item B<Port> I<Port>
6818 Port name or port number used when connecting. If left unspecified, the default
6819 will be chosen by I<librouteros>, currently "8728". This option expects a
6820 string argument, even when a numeric port number is given.
6822 =item B<User> I<User>
6824 Use the user name I<User> to authenticate. Defaults to "admin".
6826 =item B<Password> I<Password>
6828 Set the password used to authenticate.
6830 =item B<CollectInterface> B<true>|B<false>
6832 When set to B<true>, interface statistics will be collected for all interfaces
6833 present on the device. Defaults to B<false>.
6835 =item B<CollectRegistrationTable> B<true>|B<false>
6837 When set to B<true>, information about wireless LAN connections will be
6838 collected. Defaults to B<false>.
6840 =item B<CollectCPULoad> B<true>|B<false>
6842 When set to B<true>, information about the CPU usage will be collected. The
6843 number is a dimensionless value where zero indicates no CPU usage at all.
6844 Defaults to B<false>.
6846 =item B<CollectMemory> B<true>|B<false>
6848 When enabled, the amount of used and free memory will be collected. How used
6849 memory is calculated is unknown, for example whether or not caches are counted
6851 Defaults to B<false>.
6853 =item B<CollectDF> B<true>|B<false>
6855 When enabled, the amount of used and free disk space will be collected.
6856 Defaults to B<false>.
6858 =item B<CollectDisk> B<true>|B<false>
6860 When enabled, the number of sectors written and bad blocks will be collected.
6861 Defaults to B<false>.
6865 =head2 Plugin C<redis>
6867 The I<Redis plugin> connects to one or more Redis servers and gathers
6868 information about each server's state. For each server there is a I<Node> block
6869 which configures the connection parameters for this node.
6876 <Query "LLEN myqueue">
6883 The information shown in the synopsis above is the I<default configuration>
6884 which is used by the plugin if no configuration is present.
6888 =item B<Node> I<Nodename>
6890 The B<Node> block identifies a new Redis node, that is a new Redis instance
6891 running in an specified host and port. The name for node is a canonical
6892 identifier which is used as I<plugin instance>. It is limited to
6893 64E<nbsp>characters in length.
6895 =item B<Host> I<Hostname>
6897 The B<Host> option is the hostname or IP-address where the Redis instance is
6900 =item B<Port> I<Port>
6902 The B<Port> option is the TCP port on which the Redis instance accepts
6903 connections. Either a service name of a port number may be given. Please note
6904 that numerical port numbers must be given as a string, too.
6906 =item B<Password> I<Password>
6908 Use I<Password> to authenticate when connecting to I<Redis>.
6910 =item B<Timeout> I<Milliseconds>
6912 The B<Timeout> option set the socket timeout for node response. Since the Redis
6913 read function is blocking, you should keep this value as low as possible. Keep
6914 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6915 than B<Interval> defined globally.
6917 =item B<Query> I<Querystring>
6919 The B<Query> block identifies a query to execute against the redis server.
6920 There may be an arbitrary number of queries to execute.
6922 =item B<Type> I<Collectd type>
6924 Within a query definition, a valid collectd type to use as when submitting
6925 the result of the query. When not supplied, will default to B<gauge>.
6927 =item B<Instance> I<Type instance>
6929 Within a query definition, an optional type instance to use when submitting
6930 the result of the query. When not supplied will default to the escaped
6931 command, up to 64 chars.
6935 =head2 Plugin C<rrdcached>
6937 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6938 to store values to RRD files in an efficient manner. The combination of the
6939 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6940 way the C<rrdtool> plugin works (see below). The added abstraction layer
6941 provides a number of benefits, though: Because the cache is not within
6942 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6943 restarted. This results in much shorter (if any) gaps in graphs, especially
6944 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6945 daemon so that it can flush values to disk automatically when needed. This
6946 allows one to integrate automated flushing of values into graphing solutions
6949 There are disadvantages, though: The daemon may reside on a different host, so
6950 it may not be possible for C<collectd> to create the appropriate RRD files
6951 anymore. And even if C<rrdcached> runs on the same host, it may run in a
6952 different base directory, so relative paths may do weird stuff if you're not
6955 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
6956 on the same host, communicating via a UNIX domain socket. The B<DataDir>
6957 setting should be set to an absolute path, so that a changed base directory
6958 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
6962 =item B<DaemonAddress> I<Address>
6964 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
6965 library. See L<rrdcached(1)> for details. Example:
6967 <Plugin "rrdcached">
6968 DaemonAddress "unix:/var/run/rrdcached.sock"
6971 =item B<DataDir> I<Directory>
6973 Set the base directory in which the RRD files reside. If this is a relative
6974 path, it is relative to the working base directory of the C<rrdcached> daemon!
6975 Use of an absolute path is recommended.
6977 =item B<CreateFiles> B<true>|B<false>
6979 Enables or disables the creation of RRD files. If the daemon is not running
6980 locally, or B<DataDir> is set to a relative path, this will not work as
6981 expected. Default is B<true>.
6983 =item B<CreateFilesAsync> B<false>|B<true>
6985 When enabled, new RRD files are enabled asynchronously, using a separate thread
6986 that runs in the background. This prevents writes to block, which is a problem
6987 especially when many hundreds of files need to be created at once. However,
6988 since the purpose of creating the files asynchronously is I<not> to block until
6989 the file is available, values before the file is available will be discarded.
6990 When disabled (the default) files are created synchronously, blocking for a
6991 short while, while the file is being written.
6993 =item B<StepSize> I<Seconds>
6995 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
6996 this setting is unset and the stepsize is set to the interval in which the data
6997 is collected. Do not use this option unless you absolutely have to for some
6998 reason. Setting this option may cause problems with the C<snmp plugin>, the
6999 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7001 =item B<HeartBeat> I<Seconds>
7003 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7004 in which case the heartbeat is set to twice the B<StepSize> which should equal
7005 the interval in which data is collected. Do not set this option unless you have
7006 a very good reason to do so.
7008 =item B<RRARows> I<NumRows>
7010 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7011 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7012 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7013 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7014 week, one month, and one year.
7016 So for each timespan, it calculates how many PDPs need to be consolidated into
7017 one CDP by calculating:
7018 number of PDPs = timespan / (stepsize * rrarows)
7020 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7023 =item B<RRATimespan> I<Seconds>
7025 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7026 more then one RRA. If this option is never used, the built-in default of (3600,
7027 86400, 604800, 2678400, 31622400) is used.
7029 For more information on how RRA-sizes are calculated see B<RRARows> above.
7031 =item B<XFF> I<Factor>
7033 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7034 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7037 =item B<CollectStatistics> B<false>|B<true>
7039 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7040 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7042 Statistics are read via I<rrdcached>s socket using the STATS command.
7043 See L<rrdcached(1)> for details.
7047 =head2 Plugin C<rrdtool>
7049 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7050 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7051 using these settings. If you don't want to dive into the depths of RRDtool, you
7052 can safely ignore these settings.
7056 =item B<DataDir> I<Directory>
7058 Set the directory to store RRD files under. By default RRD files are generated
7059 beneath the daemon's working directory, i.e. the B<BaseDir>.
7061 =item B<CreateFilesAsync> B<false>|B<true>
7063 When enabled, new RRD files are enabled asynchronously, using a separate thread
7064 that runs in the background. This prevents writes to block, which is a problem
7065 especially when many hundreds of files need to be created at once. However,
7066 since the purpose of creating the files asynchronously is I<not> to block until
7067 the file is available, values before the file is available will be discarded.
7068 When disabled (the default) files are created synchronously, blocking for a
7069 short while, while the file is being written.
7071 =item B<StepSize> I<Seconds>
7073 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7074 this setting is unset and the stepsize is set to the interval in which the data
7075 is collected. Do not use this option unless you absolutely have to for some
7076 reason. Setting this option may cause problems with the C<snmp plugin>, the
7077 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7079 =item B<HeartBeat> I<Seconds>
7081 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7082 in which case the heartbeat is set to twice the B<StepSize> which should equal
7083 the interval in which data is collected. Do not set this option unless you have
7084 a very good reason to do so.
7086 =item B<RRARows> I<NumRows>
7088 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7089 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7090 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7091 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7092 week, one month, and one year.
7094 So for each timespan, it calculates how many PDPs need to be consolidated into
7095 one CDP by calculating:
7096 number of PDPs = timespan / (stepsize * rrarows)
7098 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7101 =item B<RRATimespan> I<Seconds>
7103 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7104 more then one RRA. If this option is never used, the built-in default of (3600,
7105 86400, 604800, 2678400, 31622400) is used.
7107 For more information on how RRA-sizes are calculated see B<RRARows> above.
7109 =item B<XFF> I<Factor>
7111 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7112 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7115 =item B<CacheFlush> I<Seconds>
7117 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7118 it writes all values for a certain RRD-file if the oldest value is older than
7119 (or equal to) the number of seconds specified by B<CacheTimeout>.
7120 That check happens on new values arriwal. If some RRD-file is not updated
7121 anymore for some reason (the computer was shut down, the network is broken,
7122 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7123 every I<Seconds> seconds the entire cache is searched for entries older than
7124 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7125 disk. Since scanning the entire cache is kind of expensive and does nothing
7126 under normal circumstances, this value should not be too small. 900 seconds
7127 might be a good value, though setting this to 7200 seconds doesn't normally
7128 do much harm either.
7130 Defaults to 10x B<CacheTimeout>.
7131 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7132 above default is used.
7134 =item B<CacheTimeout> I<Seconds>
7136 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7137 save values in a cache, as described above. Writing multiple values at once
7138 reduces IO-operations and thus lessens the load produced by updating the files.
7139 The trade off is that the graphs kind of "drag behind" and that more memory is
7142 =item B<WritesPerSecond> I<Updates>
7144 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7145 will run serious performance problems. The B<CacheFlush> setting and the
7146 internal update queue assert that collectd continues to work just fine even
7147 under heavy load, but the system may become very unresponsive and slow. This is
7148 a problem especially if you create graphs from the RRD files on the same
7149 machine, for example using the C<graph.cgi> script included in the
7150 C<contrib/collection3/> directory.
7152 This setting is designed for very large setups. Setting this option to a value
7153 between 25 and 80 updates per second, depending on your hardware, will leave
7154 the server responsive enough to draw graphs even while all the cached values
7155 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7156 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7157 written as fast as possible, so that web frontends have up to date data when
7160 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7161 updates per second, writing all values to disk will take approximately
7162 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7163 "collection3" you'll end up with a responsive and fast system, up to date
7164 graphs and basically a "backup" of your values every hour.
7166 =item B<RandomTimeout> I<Seconds>
7168 When set, the actual timeout for each value is chosen randomly between
7169 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7170 intention is to avoid high load situations that appear when many values timeout
7171 at the same time. This is especially a problem shortly after the daemon starts,
7172 because all values were added to the internal cache at roughly the same time.
7176 =head2 Plugin C<sensors>
7178 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7179 that all the needed modules have to be loaded and lm_sensors has to be
7180 configured (most likely by editing F</etc/sensors.conf>. Read
7181 L<sensors.conf(5)> for details.
7183 The B<lm_sensors> homepage can be found at
7184 L<http://secure.netroedge.com/~lm78/>.
7188 =item B<SensorConfigFile> I<File>
7190 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7191 the library's default will be used.
7193 =item B<Sensor> I<chip-bus-address/type-feature>
7195 Selects the name of the sensor which you want to collect or ignore, depending
7196 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7197 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7198 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7200 See F</"IGNORELISTS"> for details.
7202 =item B<IgnoreSelected> I<true>|I<false>
7204 If no configuration if given, the B<sensors>-plugin will collect data from all
7205 sensors. This may not be practical, especially for uninteresting sensors.
7206 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7207 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7208 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7209 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7210 and all other sensors are collected.
7212 =item B<UseLabels> I<true>|I<false>
7214 Configures how sensor readings are reported. When set to I<true>, sensor
7215 readings are reported using their descriptive label (e.g. "VCore"). When set to
7216 I<false> (the default) the sensor name is used ("in0").
7220 =head2 Plugin C<sigrok>
7222 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7223 supported by the L<sigrok|http://sigrok.org/> project.
7229 <Device "AC Voltage">
7234 <Device "Sound Level">
7235 Driver "cem-dt-885x"
7242 =item B<LogLevel> B<0-5>
7244 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7245 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7246 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7247 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7248 their level, are always submitted to I<collectd> at its INFO log level.
7250 =item E<lt>B<Device> I<Name>E<gt>
7252 A sigrok-supported device, uniquely identified by this section's options. The
7253 I<Name> is passed to I<collectd> as the I<plugin instance>.
7255 =item B<Driver> I<DriverName>
7257 The sigrok driver to use for this device.
7259 =item B<Conn> I<ConnectionSpec>
7261 If the device cannot be auto-discovered, or more than one might be discovered
7262 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7263 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7264 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7265 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7266 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7268 =item B<SerialComm> I<SerialSpec>
7270 For serial devices with non-standard port settings, this option can be used
7271 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7272 This should not be necessary; drivers know how to communicate with devices they
7275 =item B<MinimumInterval> I<Seconds>
7277 Specifies the minimum time between measurement dispatches to I<collectd>, in
7278 seconds. Since some I<sigrok> supported devices can acquire measurements many
7279 times per second, it may be necessary to throttle these. For example, the
7280 I<RRD plugin> cannot process writes more than once per second.
7282 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7283 device are always dispatched to I<collectd>. When throttled, unused
7284 measurements are discarded.
7288 =head2 Plugin C<smart>
7290 The C<smart> plugin collects SMART information from physical
7291 disks. Values collectd include temperature, power cycle count, poweron
7292 time and bad sectors. Also, all SMART attributes are collected along
7293 with the normalized current value, the worst value, the threshold and
7294 a human readable value.
7296 Using the following two options you can ignore some disks or configure the
7297 collection only of specific disks.
7301 =item B<Disk> I<Name>
7303 Select the disk I<Name>. Whether it is collected or ignored depends on the
7304 B<IgnoreSelected> setting, see below. As with other plugins that use the
7305 daemon's ignorelist functionality, a string that starts and ends with a slash
7306 is interpreted as a regular expression. Examples:
7311 See F</"IGNORELISTS"> for details.
7313 =item B<IgnoreSelected> B<true>|B<false>
7315 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7316 statements, are ignored or if all other disks are ignored. The behavior
7317 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7318 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7319 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7320 is set to B<true>, all disks are collected B<except> the ones matched.
7322 =item B<IgnoreSleepMode> B<true>|B<false>
7324 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7325 This option disables the sleep mode check and allows the plugin to collect data
7326 from these disks anyway. This is useful in cases where libatasmart mistakenly
7327 reports disks as asleep because it has not been updated to incorporate support
7328 for newer idle states in the ATA spec.
7330 =item B<UseSerial> B<true>|B<false>
7332 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7333 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7334 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7335 storing data. This ensures that the data for a given disk will be kept together
7336 even if the kernel name changes.
7340 =head2 Plugin C<snmp>
7342 Since the configuration of the C<snmp plugin> is a little more complicated than
7343 other plugins, its documentation has been moved to an own manpage,
7344 L<collectd-snmp(5)>. Please see there for details.
7346 =head2 Plugin C<snmp_agent>
7348 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7349 from SNMP master agent and returns the data collected by read plugins.
7350 The I<snmp_agent> plugin handles requests only for OIDs specified in
7351 configuration file. To handle SNMP queries the plugin gets data from collectd
7352 and translates requested values from collectd's internal format to SNMP format.
7353 This plugin is a generic plugin and cannot work without configuration.
7354 For more details on AgentX subagent see
7355 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7360 <Data "memAvailReal">
7362 #PluginInstance "some"
7365 OIDs "1.3.6.1.4.1.2021.4.6.0"
7368 IndexOID "IF-MIB::ifIndex"
7369 SizeOID "IF-MIB::ifNumber"
7373 OIDs "IF-MIB::ifDescr"
7379 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7384 There are two types of blocks that can be contained in the
7385 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7387 =head3 The B<Data> block
7389 The B<Data> block defines a list OIDs that are to be handled. This block can
7390 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7391 block it reperesents table OIDs.
7392 The following options can be set:
7396 =item B<Instance> I<true|false>
7398 When B<Instance> is set to B<true>, the value for requested OID is copied from
7399 plugin instance field of corresponding collectd value. If B<Data> block defines
7400 scalar data type B<Instance> has no effect and can be omitted.
7402 =item B<Plugin> I<String>
7404 Read plugin name whose collected data will be mapped to specified OIDs.
7406 =item B<PluginInstance> I<String>
7408 Read plugin instance whose collected data will be mapped to specified OIDs.
7409 The field is optional and by default there is no plugin instance check.
7410 Allowed only if B<Data> block defines scalar data type.
7412 =item B<Type> I<String>
7414 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7415 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7417 =item B<TypeInstance> I<String>
7419 Collectd's type-instance that is to be used for specified OID.
7421 =item B<OIDs> I<OID> [I<OID> ...]
7423 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7424 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7425 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7426 configured should correspond to number of values in specified B<Type>.
7427 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7428 "rx" and "tx" values of "if_octets" type.
7430 =item B<Scale> I<Value>
7432 The values taken from collectd are multiplied by I<Value>. The field is optional
7433 and the default is B<1.0>.
7435 =item B<Shift> I<Value>
7437 I<Value> is added to values from collectd after they have been multiplied by
7438 B<Scale> value. The field is optional and the default value is B<0.0>.
7442 =head3 The B<Table> block
7444 The B<Table> block defines a collection of B<Data> blocks that belong to one
7445 snmp table. In addition to multiple B<Data> blocks the following options can be
7450 =item B<IndexOID> I<OID>
7452 OID that is handled by the plugin and is mapped to numerical index value that is
7453 generated by the plugin for each table record.
7455 =item B<SizeOID> I<OID>
7457 OID that is handled by the plugin. Returned value is the number of records in
7458 the table. The field is optional.
7462 =head2 Plugin C<statsd>
7464 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7465 protocol and dispatches rates or other aggregates of these numbers
7468 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7469 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7470 C<objects> respectively.
7472 The following configuration options are valid:
7476 =item B<Host> I<Host>
7478 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7479 "any" address, i.e. accept packets sent to any of the hosts addresses.
7481 =item B<Port> I<Port>
7483 UDP port to listen to. This can be either a service name or a port number.
7484 Defaults to C<8125>.
7486 =item B<DeleteCounters> B<false>|B<true>
7488 =item B<DeleteTimers> B<false>|B<true>
7490 =item B<DeleteGauges> B<false>|B<true>
7492 =item B<DeleteSets> B<false>|B<true>
7494 These options control what happens if metrics are not updated in an interval.
7495 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7496 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7497 are unchanged. If set to B<True>, the such metrics are not dispatched and
7498 removed from the internal cache.
7500 =item B<CounterSum> B<false>|B<true>
7502 When enabled, creates a C<count> metric which reports the change since the last
7503 read. This option primarily exists for compatibility with the I<statsd>
7504 implementation by Etsy.
7506 =item B<TimerPercentile> I<Percent>
7508 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7509 that I<Percent> of all reported timers are smaller than or equal to the
7510 computed latency. This is useful for cutting off the long tail latency, as it's
7511 often done in I<Service Level Agreements> (SLAs).
7513 Different percentiles can be calculated by setting this option several times.
7514 If none are specified, no percentiles are calculated / dispatched.
7516 =item B<TimerLower> B<false>|B<true>
7518 =item B<TimerUpper> B<false>|B<true>
7520 =item B<TimerSum> B<false>|B<true>
7522 =item B<TimerCount> B<false>|B<true>
7524 Calculate and dispatch various values out of I<Timer> metrics received during
7525 an interval. If set to B<False>, the default, these values aren't calculated /
7530 =head2 Plugin C<swap>
7532 The I<Swap plugin> collects information about used and available swap space. On
7533 I<Linux> and I<Solaris>, the following options are available:
7537 =item B<ReportByDevice> B<false>|B<true>
7539 Configures how to report physical swap devices. If set to B<false> (the
7540 default), the summary over all swap devices is reported only, i.e. the globally
7541 used and available space over all devices. If B<true> is configured, the used
7542 and available space of each device will be reported separately.
7544 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7545 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7547 =item B<ReportBytes> B<false>|B<true>
7549 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7550 I<swap I/O> is reported in pages. This option is available under Linux only.
7552 =item B<ValuesAbsolute> B<true>|B<false>
7554 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7555 available and used. Defaults to B<true>.
7557 =item B<ValuesPercentage> B<false>|B<true>
7559 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7560 available and free. Defaults to B<false>.
7562 This is useful for deploying I<collectd> in a heterogeneous environment, where
7563 swap sizes differ and you want to specify generic thresholds or similar.
7565 =item B<ReportIO> B<true>|B<false>
7567 Enables or disables reporting swap IO. Defaults to B<true>.
7569 This is useful for the cases when swap IO is not neccessary, is not available,
7574 =head2 Plugin C<syslog>
7578 =item B<LogLevel> B<debug|info|notice|warning|err>
7580 Sets the log-level. If, for example, set to B<notice>, then all events with
7581 severity B<notice>, B<warning>, or B<err> will be submitted to the
7584 Please note that B<debug> is only available if collectd has been compiled with
7587 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7589 Controls which notifications should be sent to syslog. The default behaviour is
7590 not to send any. Less severe notifications always imply logging more severe
7591 notifications: Setting this to B<OKAY> means all notifications will be sent to
7592 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7593 notifications but will dismiss B<OKAY> notifications. Setting this option to
7594 B<FAILURE> will only send failures to syslog.
7598 =head2 Plugin C<table>
7600 The C<table plugin> provides generic means to parse tabular data and dispatch
7601 user specified values. Values are selected based on column numbers. For
7602 example, this plugin may be used to get values from the Linux L<proc(5)>
7603 filesystem or CSV (comma separated values) files.
7606 <Table "/proc/slabinfo">
7612 InstancePrefix "active_objs"
7618 InstancePrefix "objperslab"
7625 The configuration consists of one or more B<Table> blocks, each of which
7626 configures one file to parse. Within each B<Table> block, there are one or
7627 more B<Result> blocks, which configure which data to select and how to
7630 The following options are available inside a B<Table> block:
7634 =item B<Plugin> I<Plugin>
7636 If specified, I<Plugin> is used as the plugin name when submitting values.
7637 Defaults to B<table>.
7639 =item B<Instance> I<instance>
7641 If specified, I<instance> is used as the plugin instance. If omitted, the
7642 filename of the table is used instead, with all special characters replaced
7643 with an underscore (C<_>).
7645 =item B<Separator> I<string>
7647 Any character of I<string> is interpreted as a delimiter between the different
7648 columns of the table. A sequence of two or more contiguous delimiters in the
7649 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7650 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7651 of a table - see its documentation for more details. This option is mandatory.
7653 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7654 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7655 required because of collectd's config parsing.
7659 The following options are available inside a B<Result> block:
7663 =item B<Type> I<type>
7665 Sets the type used to dispatch the values to the daemon. Detailed information
7666 about types and their configuration can be found in L<types.db(5)>. This
7667 option is mandatory.
7669 =item B<InstancePrefix> I<prefix>
7671 If specified, prepend I<prefix> to the type instance. If omitted, only the
7672 B<InstancesFrom> option is considered for the type instance.
7674 =item B<InstancesFrom> I<column0> [I<column1> ...]
7676 If specified, the content of the given columns (identified by the column
7677 number starting at zero) will be used to create the type instance for each
7678 row. Multiple values (and the instance prefix) will be joined together with
7679 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7680 option is considered for the type instance.
7682 The plugin itself does not check whether or not all built instances are
7683 different. It’s your responsibility to assure that each is unique. This is
7684 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7685 sure that the table only contains one row.
7687 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7690 =item B<ValuesFrom> I<column0> [I<column1> ...]
7692 Specifies the columns (identified by the column numbers starting at zero)
7693 whose content is used as the actual data for the data sets that are dispatched
7694 to the daemon. How many such columns you need is determined by the B<Type>
7695 setting above. If you specify too many or not enough columns, the plugin will
7696 complain about that and no data will be submitted to the daemon. The plugin
7697 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7698 respectively, so anything supported by those functions is supported by the
7699 plugin as well. This option is mandatory.
7703 =head2 Plugin C<tail>
7705 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7706 each line and dispatches found values. What is matched can be configured by the
7707 user using (extended) regular expressions, as described in L<regex(7)>.
7710 <File "/var/log/exim4/mainlog">
7714 Regex "S=([1-9][0-9]*)"
7720 Regex "\\<R=local_user\\>"
7721 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7724 Instance "local_user"
7727 Regex "l=([0-9]*\\.[0-9]*)"
7728 <DSType "Distribution">
7731 #BucketType "bucket"
7739 The config consists of one or more B<File> blocks, each of which configures one
7740 logfile to parse. Within each B<File> block, there are one or more B<Match>
7741 blocks, which configure a regular expression to search for.
7743 The B<Instance> option in the B<File> block may be used to set the plugin
7744 instance. So in the above example the plugin name C<tail-foo> would be used.
7745 This plugin instance is for all B<Match> blocks that B<follow> it, until the
7746 next B<Instance> option. This way you can extract several plugin instances from
7747 one logfile, handy when parsing syslog and the like.
7749 The B<Interval> option allows you to define the length of time between reads. If
7750 this is not set, the default Interval will be used.
7752 Each B<Match> block has the following options to describe how the match should
7757 =item B<Regex> I<regex>
7759 Sets the regular expression to use for matching against a line. The first
7760 subexpression has to match something that can be turned into a number by
7761 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7762 below. Because B<extended> regular expressions are used, you do not need to use
7763 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7764 collectd's config parsing you need to escape backslashes, though. So if you
7765 want to match literal parentheses you need to do the following:
7767 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7769 =item B<ExcludeRegex> I<regex>
7771 Sets an optional regular expression to use for excluding lines from the match.
7772 An example which excludes all connections from localhost from the match:
7774 ExcludeRegex "127\\.0\\.0\\.1"
7776 =item B<DSType> I<Type>
7778 Sets how the values are cumulated. I<Type> is one of:
7782 =item B<GaugeAverage>
7784 Calculate the average.
7788 Use the smallest number only.
7792 Use the greatest number only.
7796 Use the last number found.
7798 =item B<GaugePersist>
7800 Use the last number found. The number is not reset at the end of an interval.
7801 It is continously reported until another number is matched. This is intended
7802 for cases in which only state changes are reported, for example a thermometer
7803 that only reports the temperature when it changes.
7809 =item B<AbsoluteSet>
7811 The matched number is a counter. Simply I<sets> the internal counter to this
7812 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
7820 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
7821 matched number may be negative, which will effectively subtract from the
7830 Increase the internal counter by one. These B<DSType> are the only ones that do
7831 not use the matched subexpression, but simply count the number of matched
7832 lines. Thus, you may use a regular expression without submatch in this case.
7834 =item B<Distribution>
7836 Type to do calculations based on the distribution of values, primarily
7837 calculating percentiles. This is primarily geared towards latency, but can be
7838 used for other metrics as well. The range of values tracked with this setting
7839 must be in the range (0–2^34) and can be fractional. Please note that neither
7840 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
7843 This option must be used together with the B<Percentile> and/or B<Bucket>
7848 <DSType "Distribution">
7856 =item B<Percentile> I<Percent>
7858 Calculate and dispatch the configured percentile, i.e. compute the value, so
7859 that I<Percent> of all matched values are smaller than or equal to the computed
7862 Metrics are reported with the I<type> B<Type> (the value of the above option)
7863 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
7865 This option may be repeated to calculate more than one percentile.
7867 =item B<Bucket> I<lower_bound> I<upper_bound>
7869 Export the number of values (a C<DERIVE>) falling within the given range. Both,
7870 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
7871 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
7872 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
7873 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
7876 To export the entire (0–inf) range without overlap, use the upper bound of the
7877 previous range as the lower bound of the following range. In other words, use
7878 the following schema:
7888 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
7889 by default) and the I<type instance>
7890 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
7892 This option may be repeated to calculate more than one rate.
7894 =item B<BucketType> I<Type>
7896 Sets the type used to dispatch B<Bucket> metrics.
7897 Optional, by default C<bucket> will be used.
7903 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
7904 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
7905 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
7906 B<Derive*> types interpret the submatch as a signed integer using
7907 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
7908 and it may be omitted in this case.
7910 =item B<Type> I<Type>
7912 Sets the type used to dispatch this value. Detailed information about types and
7913 their configuration can be found in L<types.db(5)>.
7915 =item B<Instance> I<TypeInstance>
7917 This optional setting sets the type instance to use.
7921 =head2 Plugin C<tail_csv>
7923 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
7924 written by I<Snort>.
7929 <Metric "snort-dropped">
7934 <File "/var/log/snort/snort.stats">
7935 Instance "snort-eth0"
7937 Collect "snort-dropped"
7941 The configuration consists of one or more B<Metric> blocks that define an index
7942 into the line of the CSV file and how this value is mapped to I<collectd's>
7943 internal representation. These are followed by one or more B<Instance> blocks
7944 which configure which file to read, in which interval and which metrics to
7949 =item E<lt>B<Metric> I<Name>E<gt>
7951 The B<Metric> block configures a new metric to be extracted from the statistics
7952 file and how it is mapped on I<collectd's> data model. The string I<Name> is
7953 only used inside the B<Instance> blocks to refer to this block, so you can use
7954 one B<Metric> block for multiple CSV files.
7958 =item B<Type> I<Type>
7960 Configures which I<Type> to use when dispatching this metric. Types are defined
7961 in the L<types.db(5)> file, see the appropriate manual page for more
7962 information on specifying types. Only types with a single I<data source> are
7963 supported by the I<tail_csv plugin>. The information whether the value is an
7964 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
7965 I<Type's> definition.
7967 =item B<Instance> I<TypeInstance>
7969 If set, I<TypeInstance> is used to populate the type instance field of the
7970 created value lists. Otherwise, no type instance is used.
7972 =item B<ValueFrom> I<Index>
7974 Configure to read the value from the field with the zero-based index I<Index>.
7975 If the value is parsed as signed integer, unsigned integer or double depends on
7976 the B<Type> setting, see above.
7980 =item E<lt>B<File> I<Path>E<gt>
7982 Each B<File> block represents one CSV file to read. There must be at least one
7983 I<File> block but there can be multiple if you have multiple CSV files.
7987 =item B<Instance> I<PluginInstance>
7989 Sets the I<plugin instance> used when dispatching the values.
7991 =item B<Collect> I<Metric>
7993 Specifies which I<Metric> to collect. This option must be specified at least
7994 once, and you can use this option multiple times to specify more than one
7995 metric to be extracted from this statistic file.
7997 =item B<Interval> I<Seconds>
7999 Configures the interval in which to read values from this instance / file.
8000 Defaults to the plugin's default interval.
8002 =item B<TimeFrom> I<Index>
8004 Rather than using the local time when dispatching a value, read the timestamp
8005 from the field with the zero-based index I<Index>. The value is interpreted as
8006 seconds since epoch. The value is parsed as a double and may be factional.
8012 =head2 Plugin C<teamspeak2>
8014 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8015 polls interesting global and virtual server data. The plugin can query only one
8016 physical server but unlimited virtual servers. You can use the following
8017 options to configure it:
8021 =item B<Host> I<hostname/ip>
8023 The hostname or ip which identifies the physical server.
8026 =item B<Port> I<port>
8028 The query port of the physical server. This needs to be a string.
8031 =item B<Server> I<port>
8033 This option has to be added once for every virtual server the plugin should
8034 query. If you want to query the virtual server on port 8767 this is what the
8035 option would look like:
8039 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8040 use quotes around it! If no such statement is given only global information
8045 =head2 Plugin C<ted>
8047 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8048 measure power consumption. These devices are usually connected to a serial
8049 (RS232) or USB port. The plugin opens a configured device and tries to read the
8050 current energy readings. For more information on TED, visit
8051 L<http://www.theenergydetective.com/>.
8053 Available configuration options:
8057 =item B<Device> I<Path>
8059 Path to the device on which TED is connected. collectd will need read and write
8060 permissions on that file.
8062 Default: B</dev/ttyUSB0>
8064 =item B<Retries> I<Num>
8066 Apparently reading from TED is not that reliable. You can therefore configure a
8067 number of retries here. You only configure the I<retries> here, to if you
8068 specify zero, one reading will be performed (but no retries if that fails); if
8069 you specify three, a maximum of four readings are performed. Negative values
8076 =head2 Plugin C<tcpconns>
8078 The C<tcpconns plugin> counts the number of currently established TCP
8079 connections based on the local port and/or the remote port. Since there may be
8080 a lot of connections the default if to count all connections with a local port,
8081 for which a listening socket is opened. You can use the following options to
8082 fine-tune the ports you are interested in:
8086 =item B<ListeningPorts> I<true>|I<false>
8088 If this option is set to I<true>, statistics for all local ports for which a
8089 listening socket exists are collected. The default depends on B<LocalPort> and
8090 B<RemotePort> (see below): If no port at all is specifically selected, the
8091 default is to collect listening ports. If specific ports (no matter if local or
8092 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8093 the selected ports will be collected unless this option is set to I<true>
8096 =item B<LocalPort> I<Port>
8098 Count the connections to a specific local port. This can be used to see how
8099 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8100 You have to specify the port in numeric form, so for the mailserver example
8101 you'd need to set B<25>.
8103 =item B<RemotePort> I<Port>
8105 Count the connections to a specific remote port. This is useful to see how
8106 much a remote service is used. This is most useful if you want to know how many
8107 connections a local service has opened to remote services, e.E<nbsp>g. how many
8108 connections a mail server or news server has to other mail or news servers, or
8109 how many connections a web proxy holds to web servers. You have to give the
8110 port in numeric form.
8112 =item B<AllPortsSummary> I<true>|I<false>
8114 If this option is set to I<true> a summary of statistics from all connections
8115 are collected. This option defaults to I<false>.
8119 =head2 Plugin C<thermal>
8123 =item B<ForceUseProcfs> I<true>|I<false>
8125 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8126 C<sysfs> interface. If that is not available, the plugin falls back to the
8127 C<procfs> interface. By setting this option to I<true>, you can force the
8128 plugin to use the latter. This option defaults to I<false>.
8130 =item B<Device> I<Device>
8132 Selects the name of the thermal device that you want to collect or ignore,
8133 depending on the value of the B<IgnoreSelected> option. This option may be
8134 used multiple times to specify a list of devices.
8136 See F</"IGNORELISTS"> for details.
8138 =item B<IgnoreSelected> I<true>|I<false>
8140 Invert the selection: If set to true, all devices B<except> the ones that
8141 match the device names specified by the B<Device> option are collected. By
8142 default only selected devices are collected if a selection is made. If no
8143 selection is configured at all, B<all> devices are selected.
8147 =head2 Plugin C<threshold>
8149 The I<Threshold plugin> checks values collected or received by I<collectd>
8150 against a configurable I<threshold> and issues I<notifications> if values are
8153 Documentation for this plugin is available in the L<collectd-threshold(5)>
8156 =head2 Plugin C<tokyotyrant>
8158 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8159 couple metrics: number of records, and database size on disk.
8163 =item B<Host> I<Hostname/IP>
8165 The hostname or IP which identifies the server.
8166 Default: B<127.0.0.1>
8168 =item B<Port> I<Service/Port>
8170 The query port of the server. This needs to be a string, even if the port is
8171 given in its numeric form.
8176 =head2 Plugin C<turbostat>
8178 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8179 Intel processors by using I<Model Specific Registers>.
8183 =item B<CoreCstates> I<Bitmask(Integer)>
8185 Bit mask of the list of core C-states supported by the processor.
8186 This option should only be used if the automated detection fails.
8187 Default value extracted from the CPU model and family.
8189 Currently supported C-states (by this plugin): 3, 6, 7
8193 All states (3, 6 and 7):
8194 (1<<3) + (1<<6) + (1<<7) = 392
8196 =item B<PackageCstates> I<Bitmask(Integer)>
8198 Bit mask of the list of packages C-states supported by the processor. This
8199 option should only be used if the automated detection fails. Default value
8200 extracted from the CPU model and family.
8202 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8206 States 2, 3, 6 and 7:
8207 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8209 =item B<SystemManagementInterrupt> I<true>|I<false>
8211 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8212 This option should only be used if the automated detection fails or if you want
8213 to disable this feature.
8215 =item B<DigitalTemperatureSensor> I<true>|I<false>
8217 Boolean enabling the collection of the temperature of each core. This option
8218 should only be used if the automated detection fails or if you want to disable
8221 =item B<TCCActivationTemp> I<Temperature>
8223 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8224 temperature is used when collecting the temperature of cores or packages. This
8225 option should only be used if the automated detection fails. Default value
8226 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8228 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8230 Bit mask of the list of elements to be thermally monitored. This option should
8231 only be used if the automated detection fails or if you want to disable some
8232 collections. The different bits of this bit mask accepted by this plugin are:
8236 =item 0 ('1'): Package
8240 =item 2 ('4'): Cores
8242 =item 3 ('8'): Embedded graphic device
8246 =item B<LogicalCoreNames> I<true>|I<false>
8248 Boolean enabling the use of logical core numbering for per core statistics.
8249 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8250 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8251 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8252 more than one, where I<n> is the n-th core of package I<m>.
8256 =head2 Plugin C<unixsock>
8260 =item B<SocketFile> I<Path>
8262 Sets the socket-file which is to be created.
8264 =item B<SocketGroup> I<Group>
8266 If running as root change the group of the UNIX-socket after it has been
8267 created. Defaults to B<collectd>.
8269 =item B<SocketPerms> I<Permissions>
8271 Change the file permissions of the UNIX-socket after it has been created. The
8272 permissions must be given as a numeric, octal value as you would pass to
8273 L<chmod(1)>. Defaults to B<0770>.
8275 =item B<DeleteSocket> B<false>|B<true>
8277 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8278 with the given name already exists. If I<collectd> crashes a socket file may be
8279 left over, preventing the daemon from opening a new socket when restarted.
8280 Since this is potentially dangerous, this defaults to B<false>.
8284 =head2 Plugin C<uuid>
8286 This plugin, if loaded, causes the Hostname to be taken from the machine's
8287 UUID. The UUID is a universally unique designation for the machine, usually
8288 taken from the machine's BIOS. This is most useful if the machine is running in
8289 a virtual environment such as Xen, in which case the UUID is preserved across
8290 shutdowns and migration.
8292 The following methods are used to find the machine's UUID, in order:
8298 Check I</etc/uuid> (or I<UUIDFile>).
8302 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8307 Check for UUID from C<dmidecode> / SMBIOS.
8311 Check for UUID from Xen hypervisor.
8315 If no UUID can be found then the hostname is not modified.
8319 =item B<UUIDFile> I<Path>
8321 Take the UUID from the given file (default I</etc/uuid>).
8325 =head2 Plugin C<varnish>
8327 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8328 It collects a subset of the values displayed by L<varnishstat(1)>, and
8329 organizes them in categories which can be enabled or disabled. Currently only
8330 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8331 meaning of each metric can be found in L<varnish-counters(7)>.
8336 <Instance "example">
8340 CollectConnections true
8341 CollectDirectorDNS false
8345 CollectObjects false
8347 CollectSession false
8357 CollectWorkers false
8359 CollectMempool false
8360 CollectManagement false
8366 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8367 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8368 will collectd statistics from the default "varnishd" instance (this should work
8369 fine in most cases).
8371 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8375 =item B<CollectBackend> B<true>|B<false>
8377 Back-end connection statistics, such as successful, reused,
8378 and closed connections. True by default.
8380 =item B<CollectBan> B<true>|B<false>
8382 Statistics about ban operations, such as number of bans added, retired, and
8383 number of objects tested against ban operations. Only available with Varnish
8384 3.x and above. False by default.
8386 =item B<CollectCache> B<true>|B<false>
8388 Cache hits and misses. True by default.
8390 =item B<CollectConnections> B<true>|B<false>
8392 Number of client connections received, accepted and dropped. True by default.
8394 =item B<CollectDirectorDNS> B<true>|B<false>
8396 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8399 =item B<CollectESI> B<true>|B<false>
8401 Edge Side Includes (ESI) parse statistics. False by default.
8403 =item B<CollectFetch> B<true>|B<false>
8405 Statistics about fetches (HTTP requests sent to the backend). False by default.
8407 =item B<CollectHCB> B<true>|B<false>
8409 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8410 divided into locked and unlocked look-ups. False by default.
8412 =item B<CollectObjects> B<true>|B<false>
8414 Statistics on cached objects: number of objects expired, nuked (prematurely
8415 expired), saved, moved, etc. False by default.
8417 =item B<CollectPurge> B<true>|B<false>
8419 Statistics about purge operations, such as number of purges added, retired, and
8420 number of objects tested against purge operations. Only available with Varnish
8421 2.x. False by default.
8423 =item B<CollectSession> B<true>|B<false>
8425 Client session statistics. Number of past and current sessions, session herd and
8426 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8427 metrics found in the Connections and Threads sections with previous versions of
8428 Varnish have been moved here.
8430 =item B<CollectSHM> B<true>|B<false>
8432 Statistics about the shared memory log, a memory region to store
8433 log messages which is flushed to disk when full. True by default.
8435 =item B<CollectSMA> B<true>|B<false>
8437 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8438 component is Solaris specific.
8439 Note: SMA and SMF share counters, enable only the one used by the Varnish
8441 Only available with Varnish 2.x. False by
8444 =item B<CollectSMS> B<true>|B<false>
8446 synth (synthetic content) storage statistics. This storage
8447 component is used internally only. False by default.
8449 =item B<CollectSM> B<true>|B<false>
8451 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8452 in varnish 4.x. use CollectSMF.
8455 =item B<CollectStruct> B<true>|B<false>
8457 Current varnish internal state statistics. Number of current sessions, objects
8458 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8461 =item B<CollectTotals> B<true>|B<false>
8463 Collects overview counters, such as the number of sessions created,
8464 the number of requests and bytes transferred. False by default.
8466 =item B<CollectUptime> B<true>|B<false>
8468 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8470 =item B<CollectVCL> B<true>|B<false>
8472 Number of total (available + discarded) VCL (config files). False by default.
8474 =item B<CollectVSM> B<true>|B<false>
8476 Collect statistics about Varnish's shared memory usage (used by the logging and
8477 statistics subsystems). Only available with Varnish 4.x. False by default.
8479 =item B<CollectWorkers> B<true>|B<false>
8481 Collect statistics about worker threads. False by default.
8483 =item B<CollectVBE> B<true>|B<false>
8485 Backend counters. Only available with Varnish 4.x. False by default.
8487 =item B<CollectSMF> B<true>|B<false>
8489 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
8490 Note: SMA and SMF share counters, enable only the one used by the Varnish
8492 Used to be called SM in Varnish 2.x. False by default.
8494 =item B<CollectManagement> B<true>|B<false>
8496 Management process counters. Only available with Varnish 4.x. False by default.
8498 =item B<CollectLock> B<true>|B<false>
8500 Lock counters. Only available with Varnish 4.x. False by default.
8502 =item B<CollectMempool> B<true>|B<false>
8504 Memory pool counters. Only available with Varnish 4.x. False by default.
8508 =head2 Plugin C<virt>
8510 This plugin allows CPU, disk, network load and other metrics to be collected for
8511 virtualized guests on the machine. The statistics are collected through libvirt
8512 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8513 installing any additional software on guests, especially I<collectd>, which runs
8514 only on the host system.
8516 Only I<Connection> is required.
8520 =item B<Connection> I<uri>
8522 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8524 Connection "xen:///"
8526 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8528 =item B<RefreshInterval> I<seconds>
8530 Refresh the list of domains and devices every I<seconds>. The default is 60
8531 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8532 the list of domains and devices to be refreshed on every iteration.
8534 Refreshing the devices in particular is quite a costly operation, so if your
8535 virtualization setup is static you might consider increasing this. If this
8536 option is set to 0, refreshing is disabled completely.
8538 =item B<Domain> I<name>
8540 =item B<BlockDevice> I<name:dev>
8542 =item B<InterfaceDevice> I<name:dev>
8544 =item B<IgnoreSelected> B<true>|B<false>
8546 Select which domains and devices are collected.
8548 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8549 disk/network devices are collected.
8551 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8552 domains and disk/network devices are ignored, while the rest are collected.
8554 The domain name and device names may use a regular expression, if the name is
8555 surrounded by I</.../> and collectd was compiled with support for regexps.
8557 The default is to collect statistics for all domains and all their devices.
8561 BlockDevice "/:hdb/"
8562 IgnoreSelected "true"
8564 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8567 =item B<BlockDeviceFormat> B<target>|B<source>
8569 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8570 seen by the guest will be used for reporting metrics.
8571 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8574 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8575 using the path of the source, e.g. an image file.
8576 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8581 If the domain XML have the following device defined:
8583 <disk type='block' device='disk'>
8584 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8585 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8586 <target dev='sda' bus='scsi'/>
8588 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8591 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8593 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8594 to C<var_lib_libvirt_images_image1.qcow2>.
8596 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8598 The B<BlockDeviceFormatBasename> controls whether the full path or the
8599 L<basename(1)> of the source is being used as the I<type instance> when
8600 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8604 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8605 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8606 be set to C<var_lib_libvirt_images_image1.qcow2>.
8607 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8608 set to C<image1.qcow2>.
8610 =item B<HostnameFormat> B<name|uuid|hostname|...>
8612 When the virt plugin logs data, it sets the hostname of the collected data
8613 according to this setting. The default is to use the guest name as provided by
8614 the hypervisor, which is equal to setting B<name>.
8616 B<uuid> means use the guest's UUID. This is useful if you want to track the
8617 same guest across migrations.
8619 B<hostname> means to use the global B<Hostname> setting, which is probably not
8620 useful on its own because all guests will appear to have the same name.
8622 You can also specify combinations of these fields. For example B<name uuid>
8623 means to concatenate the guest name and UUID (with a literal colon character
8624 between, thus I<"foo:1234-1234-1234-1234">).
8626 At the moment of writing (collectd-5.5), hostname string is limited to 62
8627 characters. In case when combination of fields exceeds 62 characters,
8628 hostname will be truncated without a warning.
8630 =item B<InterfaceFormat> B<name>|B<address>
8632 When the virt plugin logs interface data, it sets the name of the collected
8633 data according to this setting. The default is to use the path as provided by
8634 the hypervisor (the "dev" property of the target node), which is equal to
8637 B<address> means use the interface's mac address. This is useful since the
8638 interface path might change between reboots of a guest or across migrations.
8640 =item B<PluginInstanceFormat> B<name|uuid|none>
8642 When the virt plugin logs data, it sets the plugin_instance of the collected
8643 data according to this setting. The default is to not set the plugin_instance.
8645 B<name> means use the guest's name as provided by the hypervisor.
8646 B<uuid> means use the guest's UUID.
8648 You can also specify combinations of the B<name> and B<uuid> fields.
8649 For example B<name uuid> means to concatenate the guest name and UUID
8650 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8652 =item B<Instances> B<integer>
8654 How many read instances you want to use for this plugin. The default is one,
8655 and the sensible setting is a multiple of the B<ReadThreads> value.
8656 If you are not sure, just use the default setting.
8658 =item B<ExtraStats> B<string>
8660 Report additional extra statistics. The default is no extra statistics, preserving
8661 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8662 allows the plugin to reported more detailed statistics about the behaviour of
8663 Virtual Machines. The argument is a space-separated list of selectors.
8665 Currently supported selectors are:
8669 =item B<cpu_util>: report CPU utilization per domain in percentage.
8671 =item B<disk>: report extra statistics like number of flush operations and total
8672 service time for read, write and flush operations. Requires libvirt API version
8675 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8678 =item B<domain_state>: report domain state and reason in human-readable format as
8679 a notification. If libvirt API version I<0.9.2> or later is available, domain
8680 reason will be included in notification.
8682 =item B<fs_info>: report file system information as a notification. Requires
8683 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8684 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8685 version supports retrieving file system information.
8687 =item B<job_stats_background>: report statistics about progress of a background
8688 job on a domain. Only one type of job statistics can be collected at the same time.
8689 Requires libvirt API version I<1.2.9> or later.
8691 =item B<job_stats_completed>: report statistics about a recently completed job on
8692 a domain. Only one type of job statistics can be collected at the same time.
8693 Requires libvirt API version I<1.2.9> or later.
8695 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8696 Requires libvirt API version I<0.9.11> or later.
8698 =item B<perf>: report performance monitoring events. To collect performance
8699 metrics they must be enabled for domain and supported by the platform. Requires
8700 libvirt API version I<1.3.3> or later.
8701 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8703 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8709 =head2 Plugin C<vmem>
8711 The C<vmem> plugin collects information about the usage of virtual memory.
8712 Since the statistics provided by the Linux kernel are very detailed, they are
8713 collected very detailed. However, to get all the details, you have to switch
8714 them on manually. Most people just want an overview over, such as the number of
8715 pages read from swap space.
8719 =item B<Verbose> B<true>|B<false>
8721 Enables verbose collection of information. This will start collecting page
8722 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8723 Part of these statistics are collected on a "per zone" basis.
8727 =head2 Plugin C<vserver>
8729 This plugin doesn't have any options. B<VServer> support is only available for
8730 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8731 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8732 need to apply the patches and compile your own kernel, which will then provide
8733 the F</proc/virtual> filesystem that is required by this plugin.
8735 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8737 B<Note>: The traffic collected by this plugin accounts for the amount of
8738 traffic passing a socket which might be a lot less than the actual on-wire
8739 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8740 collect on-wire traffic you could, for example, use the logging facilities of
8741 iptables to feed data for the guest IPs into the iptables plugin.
8743 =head2 Plugin C<write_graphite>
8745 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8746 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8747 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8748 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8749 of at most 1428 bytes to minimize the number of network packets.
8753 <Plugin write_graphite>
8763 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8764 blocks. Inside the B<Node> blocks, the following options are recognized:
8768 =item B<Host> I<Address>
8770 Hostname or address to connect to. Defaults to C<localhost>.
8772 =item B<Port> I<Service>
8774 Service name or port number to connect to. Defaults to C<2003>.
8776 =item B<Protocol> I<String>
8778 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
8780 =item B<ReconnectInterval> I<Seconds>
8782 When set to non-zero, forces the connection to the Graphite backend to be
8783 closed and re-opend periodically. This behavior is desirable in environments
8784 where the connection to the Graphite backend is done through load balancers,
8785 for example. When set to zero, the default, the connetion is kept open for as
8788 =item B<LogSendErrors> B<false>|B<true>
8790 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
8791 If set to B<false>, it will not log the errors. This is especially useful when
8792 using Protocol UDP since many times we want to use the "fire-and-forget"
8793 approach and logging errors fills syslog with unneeded messages.
8795 =item B<Prefix> I<String>
8797 When set, I<String> is added in front of the host name. Dots and whitespace are
8798 I<not> escaped in this string (see B<EscapeCharacter> below).
8800 =item B<Postfix> I<String>
8802 When set, I<String> is appended to the host name. Dots and whitespace are
8803 I<not> escaped in this string (see B<EscapeCharacter> below).
8805 =item B<EscapeCharacter> I<Char>
8807 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
8808 in the identifier. The B<EscapeCharacter> option determines which character
8809 dots, whitespace and control characters are replaced with. Defaults to
8812 =item B<StoreRates> B<false>|B<true>
8814 If set to B<true> (the default), convert counter values to rates. If set to
8815 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
8818 =item B<SeparateInstances> B<false>|B<true>
8820 If set to B<true>, the plugin instance and type instance will be in their own
8821 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8822 default), the plugin and plugin instance (and likewise the type and type
8823 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8825 =item B<AlwaysAppendDS> B<false>|B<true>
8827 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
8828 identifier. If set to B<false> (the default), this is only done when there is
8831 =item B<PreserveSeparator> B<false>|B<true>
8833 If set to B<false> (the default) the C<.> (dot) character is replaced with
8834 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
8835 is preserved, i.e. passed through.
8837 =item B<DropDuplicateFields> B<false>|B<true>
8839 If set to B<true>, detect and remove duplicate components in Graphite metric
8840 names. For example, the metric name C<host.load.load.shortterm> will
8841 be shortened to C<host.load.shortterm>.
8845 =head2 Plugin C<write_log>
8847 The C<write_log> plugin writes metrics as INFO log messages.
8849 This plugin supports two output formats: I<Graphite> and I<JSON>.
8859 =item B<Format> I<Format>
8861 The output format to use. Can be one of C<Graphite> or C<JSON>.
8865 =head2 Plugin C<write_tsdb>
8867 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
8868 time series database. The plugin connects to a I<TSD>, a masterless, no shared
8869 state daemon that ingests metrics and stores them in HBase. The plugin uses
8870 I<TCP> over the "line based" protocol with a default port 4242. The data will
8871 be sent in blocks of at most 1428 bytes to minimize the number of network
8880 Host "tsd-1.my.domain"
8882 HostTags "status=production"
8886 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8887 blocks and global directives.
8889 Global directives are:
8893 =item B<ResolveInterval> I<seconds>
8895 =item B<ResolveJitter> I<seconds>
8897 When I<collectd> connects to a TSDB node, it will request the hostname from
8898 DNS. This can become a problem if the TSDB node is unavailable or badly
8899 configured because collectd will request DNS in order to reconnect for every
8900 metric, which can flood your DNS. So you can cache the last value for
8901 I<ResolveInterval> seconds.
8902 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8904 You can also define a jitter, a random interval to wait in addition to
8905 I<ResolveInterval>. This prevents all your collectd servers to resolve the
8906 hostname at the same time when the connection fails.
8907 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8909 B<Note:> If the DNS resolution has already been successful when the socket
8910 closes, the plugin will try to reconnect immediately with the cached
8911 information. DNS is queried only when the socket is closed for a longer than
8912 I<ResolveInterval> + I<ResolveJitter> seconds.
8916 Inside the B<Node> blocks, the following options are recognized:
8920 =item B<Host> I<Address>
8922 Hostname or address to connect to. Defaults to C<localhost>.
8924 =item B<Port> I<Service>
8926 Service name or port number to connect to. Defaults to C<4242>.
8929 =item B<HostTags> I<String>
8931 When set, I<HostTags> is added to the end of the metric. It is intended to be
8932 used for name=value pairs that the TSD will tag the metric with. Dots and
8933 whitespace are I<not> escaped in this string.
8935 =item B<StoreRates> B<false>|B<true>
8937 If set to B<true>, convert counter values to rates. If set to B<false>
8938 (the default) counter values are stored as is, as an increasing
8941 =item B<AlwaysAppendDS> B<false>|B<true>
8943 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
8944 identifier. If set to B<false> (the default), this is only done when there is
8949 =head2 Plugin C<write_mongodb>
8951 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
8956 <Plugin "write_mongodb">
8965 The plugin can send values to multiple instances of I<MongoDB> by specifying
8966 one B<Node> block for each instance. Within the B<Node> blocks, the following
8967 options are available:
8971 =item B<Host> I<Address>
8973 Hostname or address to connect to. Defaults to C<localhost>.
8975 =item B<Port> I<Service>
8977 Service name or port number to connect to. Defaults to C<27017>.
8979 =item B<Timeout> I<Milliseconds>
8981 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
8982 Setting this option to zero means no timeout, which is the default.
8984 =item B<StoreRates> B<false>|B<true>
8986 If set to B<true> (the default), convert counter values to rates. If set to
8987 B<false> counter values are stored as is, i.e. as an increasing integer
8990 =item B<Database> I<Database>
8992 =item B<User> I<User>
8994 =item B<Password> I<Password>
8996 Sets the information used when authenticating to a I<MongoDB> database. The
8997 fields are optional (in which case no authentication is attempted), but if you
8998 want to use authentication all three fields must be set.
9002 =head2 Plugin C<write_prometheus>
9004 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9005 using I<Prometheus>.
9011 =item B<Port> I<Port>
9013 Port the embedded webserver should listen on. Defaults to B<9103>.
9015 =item B<StalenessDelta> I<Seconds>
9017 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9018 hasn't seen any update for it. This value must match the setting in Prometheus.
9019 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9023 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9024 which time a metric without updates is considered "stale". This setting
9025 effectively puts an upper limit on the interval in which metrics are reported.
9027 When the I<write_prometheus plugin> encounters a metric with an interval
9028 exceeding this limit, it will inform you, the user, and provide the metric to
9029 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9030 metric "fresh" each time it is scraped, with the time of the scrape being
9031 considered the time of the update. The result is that there appear more
9032 datapoints in I<Prometheus> than were actually created, but at least the metric
9033 doesn't disappear periodically.
9037 =head2 Plugin C<write_http>
9039 This output plugin submits values to an HTTP server using POST requests and
9040 encoding metrics with JSON or using the C<PUTVAL> command described in
9041 L<collectd-unixsock(5)>.
9045 <Plugin "write_http">
9047 URL "http://example.com/post-collectd"
9054 The plugin can send values to multiple HTTP servers by specifying one
9055 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9056 block, the following options are available:
9062 URL to which the values are submitted to. Mandatory.
9064 =item B<User> I<Username>
9066 Optional user name needed for authentication.
9068 =item B<Password> I<Password>
9070 Optional password needed for authentication.
9072 =item B<VerifyPeer> B<true>|B<false>
9074 Enable or disable peer SSL certificate verification. See
9075 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9077 =item B<VerifyHost> B<true|false>
9079 Enable or disable peer host name verification. If enabled, the plugin checks if
9080 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9081 matches the host name provided by the B<URL> option. If this identity check
9082 fails, the connection is aborted. Obviously, only works when connecting to a
9083 SSL enabled server. Enabled by default.
9085 =item B<CACert> I<File>
9087 File that holds one or more SSL certificates. If you want to use HTTPS you will
9088 possibly need this option. What CA certificates come bundled with C<libcurl>
9089 and are checked by default depends on the distribution you use.
9091 =item B<CAPath> I<Directory>
9093 Directory holding one or more CA certificate files. You can use this if for
9094 some reason all the needed CA certificates aren't in the same file and can't be
9095 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9098 =item B<ClientKey> I<File>
9100 File that holds the private key in PEM format to be used for certificate-based
9103 =item B<ClientCert> I<File>
9105 File that holds the SSL certificate to be used for certificate-based
9108 =item B<ClientKeyPass> I<Password>
9110 Password required to load the private key in B<ClientKey>.
9112 =item B<Header> I<Header>
9114 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9116 Header "X-Custom-Header: custom_value"
9118 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9120 Define which SSL protocol version must be used. By default C<libcurl> will
9121 attempt to figure out the remote SSL protocol version. See
9122 L<curl_easy_setopt(3)> for more details.
9124 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9126 Format of the output to generate. If set to B<Command>, will create output that
9127 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9128 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9129 , will create output in the KairosDB format.
9131 Defaults to B<Command>.
9133 =item B<Attribute> I<String> I<String>
9135 Only available for the KAIROSDB output format.
9137 Consider the two given strings to be the key and value of an additional tag for
9138 each metric being sent out.
9140 You can add multiple B<Attribute>.
9144 Only available for the KAIROSDB output format.
9146 Sets the Cassandra ttl for the data points.
9148 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9150 =item B<Metrics> B<true>|B<false>
9152 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9154 =item B<Notifications> B<false>|B<true>
9156 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9158 =item B<StoreRates> B<true|false>
9160 If set to B<true>, convert counter values to rates. If set to B<false> (the
9161 default) counter values are stored as is, i.e. as an increasing integer number.
9163 =item B<BufferSize> I<Bytes>
9165 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9166 requests will be generated, but more metrics will be batched / metrics are
9167 cached for longer before being sent, introducing additional delay until they
9168 are available on the server side. I<Bytes> must be at least 1024 and cannot
9169 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9170 Defaults to C<4096>.
9172 =item B<LowSpeedLimit> I<Bytes per Second>
9174 Sets the minimal transfer rate in I<Bytes per Second> below which the
9175 connection with the HTTP server will be considered too slow and aborted. All
9176 the data submitted over this connection will probably be lost. Defaults to 0,
9177 which means no minimum transfer rate is enforced.
9179 =item B<Timeout> I<Timeout>
9181 Sets the maximum time in milliseconds given for HTTP POST operations to
9182 complete. When this limit is reached, the POST operation will be aborted, and
9183 all the data in the current send buffer will probably be lost. Defaults to 0,
9184 which means the connection never times out.
9186 =item B<LogHttpError> B<false>|B<true>
9188 Enables printing of HTTP error code to log. Turned off by default.
9190 The C<write_http> plugin regularly submits the collected values to the HTTP
9191 server. How frequently this happens depends on how much data you are collecting
9192 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9193 slightly below this interval, which you can estimate by monitoring the network
9194 traffic between collectd and the HTTP server.
9198 =head2 Plugin C<write_kafka>
9200 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9204 <Plugin "write_kafka">
9205 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9211 The following options are understood by the I<write_kafka plugin>:
9215 =item E<lt>B<Topic> I<Name>E<gt>
9217 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9218 is given a unique I<Name> and specifies one kafka producer.
9219 Inside the B<Topic> block, the following per-topic options are
9224 =item B<Property> I<String> I<String>
9226 Configure the named property for the current topic. Properties are
9227 forwarded to the kafka producer library B<librdkafka>.
9229 =item B<Key> I<String>
9231 Use the specified string as a partitioning key for the topic. Kafka breaks
9232 topic into partitions and guarantees that for a given topology, the same
9233 consumer will be used for a specific key. The special (case insensitive)
9234 string B<Random> can be used to specify that an arbitrary partition should
9237 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9239 Selects the format in which messages are sent to the broker. If set to
9240 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9241 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9243 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9244 an easy and straight forward exchange format.
9246 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9247 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9249 =item B<StoreRates> B<true>|B<false>
9251 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9252 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9253 default), no conversion is performed. Otherwise the conversion is performed
9254 using the internal value cache.
9256 Please note that currently this option is only used if the B<Format> option has
9257 been set to B<JSON>.
9259 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9261 A prefix can be added in the metric name when outputting in the I<Graphite>
9262 format. It's added before the I<Host> name.
9264 C<E<lt>prefixE<gt>E<lt>hostE<gt>E<lt>postfixE<gt>E<lt>pluginE<gt>E<lt>typeE<gt>E<lt>nameE<gt>>
9266 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9268 A postfix can be added in the metric name when outputting in the I<Graphite>
9269 format. It's added after the I<Host> name.
9271 C<E<lt>prefixE<gt>E<lt>hostE<gt>E<lt>postfixE<gt>E<lt>pluginE<gt>E<lt>typeE<gt>E<lt>nameE<gt>>
9273 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9275 Specify a character to replace dots (.) in the host part of the metric name.
9276 In I<Graphite> metric name, dots are used as separators between different
9277 metric parts (host, plugin, type).
9278 Default is C<_> (I<Underscore>).
9280 =item B<GraphiteSeparateInstances> B<false>|B<true>
9282 If set to B<true>, the plugin instance and type instance will be in their own
9283 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9284 default), the plugin and plugin instance (and likewise the type and type
9285 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9287 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9289 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9290 identifier. If set to B<false> (the default), this is only done when there is
9293 =item B<GraphitePreserveSeparator> B<false>|B<true>
9295 If set to B<false> (the default) the C<.> (dot) character is replaced with
9296 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9297 is preserved, i.e. passed through.
9299 =item B<StoreRates> B<true>|B<false>
9301 If set to B<true> (the default), convert counter values to rates. If set to
9302 B<false> counter values are stored as is, i.e. as an increasing integer number.
9304 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9305 converted values will have "rate" appended to the data source type, e.g.
9306 C<ds_type:derive:rate>.
9310 =item B<Property> I<String> I<String>
9312 Configure the kafka producer through properties, you almost always will
9313 want to set B<metadata.broker.list> to your Kafka broker list.
9317 =head2 Plugin C<write_redis>
9319 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9323 <Plugin "write_redis">
9336 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9337 the timestamp as the score. Retrieving a date range can then be done using the
9338 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9339 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9340 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9341 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9342 with the B<Database> parameter (default is C<0>). See
9343 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9346 The information shown in the synopsis above is the I<default configuration>
9347 which is used by the plugin if no configuration is present.
9349 The plugin can send values to multiple instances of I<Redis> by specifying
9350 one B<Node> block for each instance. Within the B<Node> blocks, the following
9351 options are available:
9355 =item B<Node> I<Nodename>
9357 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9358 instance running on a specified host and port. The node name is a
9359 canonical identifier which is used as I<plugin instance>. It is limited to
9360 51E<nbsp>characters in length.
9362 =item B<Host> I<Hostname>
9364 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9367 =item B<Port> I<Port>
9369 The B<Port> option is the TCP port on which the Redis instance accepts
9370 connections. Either a service name of a port number may be given. Please note
9371 that numerical port numbers must be given as a string, too.
9373 =item B<Timeout> I<Milliseconds>
9375 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9377 =item B<Prefix> I<Prefix>
9379 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9380 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9381 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9382 is recommended but not required to include a trailing slash in I<Prefix>.
9384 =item B<Database> I<Index>
9386 This index selects the redis database to use for writing operations. Defaults
9389 =item B<MaxSetSize> I<Items>
9391 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9392 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9394 =item B<MaxSetDuration> I<Seconds>
9396 The B<MaxSetDuration> option limits the duration of items that the
9397 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9398 is the default behavior.
9400 =item B<StoreRates> B<true>|B<false>
9402 If set to B<true> (the default), convert counter values to rates. If set to
9403 B<false> counter values are stored as is, i.e. as an increasing integer number.
9407 =head2 Plugin C<write_riemann>
9409 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9410 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9411 I<Riemann> using UDP packets.
9415 <Plugin "write_riemann">
9421 AlwaysAppendDS false
9425 Attribute "foo" "bar"
9428 The following options are understood by the I<write_riemann plugin>:
9432 =item E<lt>B<Node> I<Name>E<gt>
9434 The plugin's configuration consists of one or more B<Node> blocks. Each block
9435 is given a unique I<Name> and specifies one connection to an instance of
9436 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9441 =item B<Host> I<Address>
9443 Hostname or address to connect to. Defaults to C<localhost>.
9445 =item B<Port> I<Service>
9447 Service name or port number to connect to. Defaults to C<5555>.
9449 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9451 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9454 =item B<TLSCertFile> I<Path>
9456 When using the B<TLS> protocol, path to a PEM certificate to present
9459 =item B<TLSCAFile> I<Path>
9461 When using the B<TLS> protocol, path to a PEM CA certificate to
9462 use to validate the remote hosts's identity.
9464 =item B<TLSKeyFile> I<Path>
9466 When using the B<TLS> protocol, path to a PEM private key associated
9467 with the certificate defined by B<TLSCertFile>.
9469 =item B<Batch> B<true>|B<false>
9471 If set to B<true> and B<Protocol> is set to B<TCP>,
9472 events will be batched in memory and flushed at
9473 regular intervals or when B<BatchMaxSize> is exceeded.
9475 Notifications are not batched and sent as soon as possible.
9477 When enabled, it can occur that events get processed by the Riemann server
9478 close to or after their expiration time. Tune the B<TTLFactor> and
9479 B<BatchMaxSize> settings according to the amount of values collected, if this
9484 =item B<BatchMaxSize> I<size>
9486 Maximum payload size for a riemann packet. Defaults to 8192
9488 =item B<BatchFlushTimeout> I<seconds>
9490 Maximum amount of seconds to wait in between to batch flushes.
9491 No timeout by default.
9493 =item B<StoreRates> B<true>|B<false>
9495 If set to B<true> (the default), convert counter values to rates. If set to
9496 B<false> counter values are stored as is, i.e. as an increasing integer number.
9498 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9499 converted values will have "rate" appended to the data source type, e.g.
9500 C<ds_type:derive:rate>.
9502 =item B<AlwaysAppendDS> B<false>|B<true>
9504 If set to B<true>, append the name of the I<Data Source> (DS) to the
9505 "service", i.e. the field that, together with the "host" field, uniquely
9506 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9507 only done when there is more than one DS.
9509 =item B<TTLFactor> I<Factor>
9511 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9512 event is considered active. I<collectd> populates this field based on the
9513 metrics interval setting. This setting controls the factor with which the
9514 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9515 know exactly what you're doing, you should only increase this setting from its
9518 =item B<Notifications> B<false>|B<true>
9520 If set to B<true>, create riemann events for notifications. This is B<true>
9521 by default. When processing thresholds from write_riemann, it might prove
9522 useful to avoid getting notification events.
9524 =item B<CheckThresholds> B<false>|B<true>
9526 If set to B<true>, attach state to events based on thresholds defined
9527 in the B<Threshold> plugin. Defaults to B<false>.
9529 =item B<EventServicePrefix> I<String>
9531 Add the given string as a prefix to the event service name.
9532 If B<EventServicePrefix> not set or set to an empty string (""),
9533 no prefix will be used.
9537 =item B<Tag> I<String>
9539 Add the given string as an additional tag to the metric being sent to
9542 =item B<Attribute> I<String> I<String>
9544 Consider the two given strings to be the key and value of an additional
9545 attribute for each metric being sent out to I<Riemann>.
9549 =head2 Plugin C<write_sensu>
9551 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9552 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9553 a local I<Sensu> client using a TCP socket.
9555 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9556 parameter so it is not possible to use one collectd instance as a gateway for
9557 others. Each collectd host must pair with one I<Sensu> client.
9561 <Plugin "write_sensu">
9566 AlwaysAppendDS false
9567 MetricHandler "influx"
9568 MetricHandler "default"
9569 NotificationHandler "flapjack"
9570 NotificationHandler "howling_monkey"
9574 Attribute "foo" "bar"
9577 The following options are understood by the I<write_sensu plugin>:
9581 =item E<lt>B<Node> I<Name>E<gt>
9583 The plugin's configuration consists of one or more B<Node> blocks. Each block
9584 is given a unique I<Name> and specifies one connection to an instance of
9585 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9590 =item B<Host> I<Address>
9592 Hostname or address to connect to. Defaults to C<localhost>.
9594 =item B<Port> I<Service>
9596 Service name or port number to connect to. Defaults to C<3030>.
9598 =item B<StoreRates> B<true>|B<false>
9600 If set to B<true> (the default), convert counter values to rates. If set to
9601 B<false> counter values are stored as is, i.e. as an increasing integer number.
9603 This will be reflected in the C<collectd_data_source_type> tag: If
9604 B<StoreRates> is enabled, converted values will have "rate" appended to the
9605 data source type, e.g. C<collectd_data_source_type:derive:rate>.
9607 =item B<AlwaysAppendDS> B<false>|B<true>
9609 If set the B<true>, append the name of the I<Data Source> (DS) to the
9610 "service", i.e. the field that, together with the "host" field, uniquely
9611 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9612 only done when there is more than one DS.
9614 =item B<Notifications> B<false>|B<true>
9616 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9617 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9619 =item B<Metrics> B<false>|B<true>
9621 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9622 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9625 =item B<Separator> I<String>
9627 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9629 =item B<MetricHandler> I<String>
9631 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9632 several of them, one per line. Defaults to no handler.
9634 =item B<NotificationHandler> I<String>
9636 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9637 add several of them, one per line. Defaults to no handler.
9639 =item B<EventServicePrefix> I<String>
9641 Add the given string as a prefix to the event service name.
9642 If B<EventServicePrefix> not set or set to an empty string (""),
9643 no prefix will be used.
9647 =item B<Tag> I<String>
9649 Add the given string as an additional tag to the metric being sent to
9652 =item B<Attribute> I<String> I<String>
9654 Consider the two given strings to be the key and value of an additional
9655 attribute for each metric being sent out to I<Sensu>.
9659 =head2 Plugin C<xencpu>
9661 This plugin collects metrics of hardware CPU load for machine running Xen
9662 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9663 Result is reported using the C<percent> type, for each CPU (core).
9665 This plugin doesn't have any options (yet).
9667 =head2 Plugin C<zookeeper>
9669 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9670 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9675 <Plugin "zookeeper">
9682 =item B<Host> I<Address>
9684 Hostname or address to connect to. Defaults to C<localhost>.
9686 =item B<Port> I<Service>
9688 Service name or port number to connect to. Defaults to C<2181>.
9692 =head1 THRESHOLD CONFIGURATION
9694 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9695 we mean that the values are not only stored or sent somewhere, but that they
9696 are judged and, if a problem is recognized, acted upon. The only action
9697 collectd takes itself is to generate and dispatch a "notification". Plugins can
9698 register to receive notifications and perform appropriate further actions.
9700 Since systems and what you expect them to do differ a lot, you can configure
9701 B<thresholds> for your values freely. This gives you a lot of flexibility but
9702 also a lot of responsibility.
9704 Every time a value is out of range a notification is dispatched. This means
9705 that the idle percentage of your CPU needs to be less then the configured
9706 threshold only once for a notification to be generated. There's no such thing
9707 as a moving average or similar - at least not now.
9709 Also, all values that match a threshold are considered to be relevant or
9710 "interesting". As a consequence collectd will issue a notification if they are
9711 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9712 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9713 "2" (the default) and some hosts sends it's CPU statistics to the server every
9714 60 seconds, a notification will be dispatched after about 120 seconds. It may
9715 take a little longer because the timeout is checked only once each B<Interval>
9718 When a value comes within range again or is received after it was missing, an
9719 "OKAY-notification" is dispatched.
9721 Here is a configuration example to get you started. Read below for more
9734 <Plugin "interface">
9751 WarningMin 100000000
9757 There are basically two types of configuration statements: The C<Host>,
9758 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
9759 configured. The C<Plugin> and C<Type> blocks may be specified further using the
9760 C<Instance> option. You can combine the block by nesting the blocks, though
9761 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
9762 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
9763 C<Type> may not contain other blocks. If multiple blocks apply to the same
9764 value the most specific block is used.
9766 The other statements specify the threshold to configure. They B<must> be
9767 included in a C<Type> block. Currently the following statements are recognized:
9771 =item B<FailureMax> I<Value>
9773 =item B<WarningMax> I<Value>
9775 Sets the upper bound of acceptable values. If unset defaults to positive
9776 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
9777 will be created. If the value is greater than B<WarningMax> but less than (or
9778 equal to) B<FailureMax> a B<WARNING> notification will be created.
9780 =item B<FailureMin> I<Value>
9782 =item B<WarningMin> I<Value>
9784 Sets the lower bound of acceptable values. If unset defaults to negative
9785 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
9786 be created. If the value is less than B<WarningMin> but greater than (or equal
9787 to) B<FailureMin> a B<WARNING> notification will be created.
9789 =item B<DataSource> I<DSName>
9791 Some data sets have more than one "data source". Interesting examples are the
9792 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
9793 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
9794 system load data set, C<load>, even has three data sources: C<shortterm>,
9795 C<midterm>, and C<longterm>.
9797 Normally, all data sources are checked against a configured threshold. If this
9798 is undesirable, or if you want to specify different limits for each data
9799 source, you can use the B<DataSource> option to have a threshold apply only to
9802 =item B<Invert> B<true>|B<false>
9804 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
9805 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
9806 B<WarningMax>) are not okay. Defaults to B<false>.
9808 =item B<Persist> B<true>|B<false>
9810 Sets how often notifications are generated. If set to B<true> one notification
9811 will be generated for each value that is out of the acceptable range. If set to
9812 B<false> (the default) then a notification is only generated if a value is out
9813 of range but the previous value was okay.
9815 This applies to missing values, too: If set to B<true> a notification about a
9816 missing value is generated once every B<Interval> seconds. If set to B<false>
9817 only one such notification is generated until the value appears again.
9819 =item B<Percentage> B<true>|B<false>
9821 If set to B<true>, the minimum and maximum values given are interpreted as
9822 percentage value, relative to the other data sources. This is helpful for
9823 example for the "df" type, where you may want to issue a warning when less than
9824 5E<nbsp>% of the total space is available. Defaults to B<false>.
9826 =item B<Hits> I<Number>
9828 Delay creating the notification until the threshold has been passed I<Number>
9829 times. When a notification has been generated, or when a subsequent value is
9830 inside the threshold, the counter is reset. If, for example, a value is
9831 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
9832 will be dispatched at most once every 30E<nbsp>seconds.
9834 This is useful when short bursts are not a problem. If, for example, 100% CPU
9835 usage for up to a minute is normal (and data is collected every
9836 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
9838 =item B<Hysteresis> I<Number>
9840 When set to non-zero, a hysteresis value is applied when checking minimum and
9841 maximum bounds. This is useful for values that increase slowly and fluctuate a
9842 bit while doing so. When these values come close to the threshold, they may
9843 "flap", i.e. switch between failure / warning case and okay case repeatedly.
9845 If, for example, the threshold is configures as
9850 then a I<Warning> notification is created when the value exceeds I<101> and the
9851 corresponding I<Okay> notification is only created once the value falls below
9852 I<99>, thus avoiding the "flapping".
9856 =head1 FILTER CONFIGURATION
9858 Starting with collectd 4.6 there is a powerful filtering infrastructure
9859 implemented in the daemon. The concept has mostly been copied from
9860 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
9861 terminology, so that users that are familiar with iptables feel right at home.
9865 The following are the terms used in the remainder of the filter configuration
9866 documentation. For an ASCII-art schema of the mechanism, see
9867 L<"General structure"> below.
9873 A I<match> is a criteria to select specific values. Examples are, of course, the
9874 name of the value or it's current value.
9876 Matches are implemented in plugins which you have to load prior to using the
9877 match. The name of such plugins starts with the "match_" prefix.
9881 A I<target> is some action that is to be performed with data. Such actions
9882 could, for example, be to change part of the value's identifier or to ignore
9883 the value completely.
9885 Some of these targets are built into the daemon, see L<"Built-in targets">
9886 below. Other targets are implemented in plugins which you have to load prior to
9887 using the target. The name of such plugins starts with the "target_" prefix.
9891 The combination of any number of matches and at least one target is called a
9892 I<rule>. The target actions will be performed for all values for which B<all>
9893 matches apply. If the rule does not have any matches associated with it, the
9894 target action will be performed for all values.
9898 A I<chain> is a list of rules and possibly default targets. The rules are tried
9899 in order and if one matches, the associated target will be called. If a value
9900 is handled by a rule, it depends on the target whether or not any subsequent
9901 rules are considered or if traversal of the chain is aborted, see
9902 L<"Flow control"> below. After all rules have been checked, the default targets
9907 =head2 General structure
9909 The following shows the resulting structure:
9916 +---------+ +---------+ +---------+ +---------+
9917 ! Rule !->! Match !->! Match !->! Target !
9918 +---------+ +---------+ +---------+ +---------+
9921 +---------+ +---------+ +---------+
9922 ! Rule !->! Target !->! Target !
9923 +---------+ +---------+ +---------+
9930 +---------+ +---------+ +---------+
9931 ! Rule !->! Match !->! Target !
9932 +---------+ +---------+ +---------+
9942 There are four ways to control which way a value takes through the filter
9949 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
9950 process the value with another chain. When the called chain finishes, usually
9951 the next target or rule after the jump is executed.
9955 The stop condition, signaled for example by the built-in target B<stop>, causes
9956 all processing of the value to be stopped immediately.
9960 Causes processing in the current chain to be aborted, but processing of the
9961 value generally will continue. This means that if the chain was called via
9962 B<Jump>, the next target or rule after the jump will be executed. If the chain
9963 was not called by another chain, control will be returned to the daemon and it
9964 may pass the value to another chain.
9968 Most targets will signal the B<continue> condition, meaning that processing
9969 should continue normally. There is no special built-in target for this
9976 The configuration reflects this structure directly:
9978 PostCacheChain "PostCache"
9980 <Rule "ignore_mysql_show">
9983 Type "^mysql_command$"
9984 TypeInstance "^show_"
9994 The above configuration example will ignore all values where the plugin field
9995 is "mysql", the type is "mysql_command" and the type instance begins with
9996 "show_". All other values will be sent to the C<rrdtool> write plugin via the
9997 default target of the chain. Since this chain is run after the value has been
9998 added to the cache, the MySQL C<show_*> command statistics will be available
9999 via the C<unixsock> plugin.
10001 =head2 List of configuration options
10005 =item B<PreCacheChain> I<ChainName>
10007 =item B<PostCacheChain> I<ChainName>
10009 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10010 argument is the name of a I<chain> that should be executed before and/or after
10011 the values have been added to the cache.
10013 To understand the implications, it's important you know what is going on inside
10014 I<collectd>. The following diagram shows how values are passed from the
10015 read-plugins to the write-plugins:
10021 + - - - - V - - - - +
10022 : +---------------+ :
10025 : +-------+-------+ :
10028 : +-------+-------+ : +---------------+
10029 : ! Cache !--->! Value Cache !
10030 : ! insert ! : +---+---+-------+
10031 : +-------+-------+ : ! !
10032 : ! ,------------' !
10034 : +-------+---+---+ : +-------+-------+
10035 : ! Post-Cache +--->! Write-Plugins !
10036 : ! Chain ! : +---------------+
10037 : +---------------+ :
10039 : dispatch values :
10040 + - - - - - - - - - +
10042 After the values are passed from the "read" plugins to the dispatch functions,
10043 the pre-cache chain is run first. The values are added to the internal cache
10044 afterwards. The post-cache chain is run after the values have been added to the
10045 cache. So why is it such a huge deal if chains are run before or after the
10046 values have been added to this cache?
10048 Targets that change the identifier of a value list should be executed before
10049 the values are added to the cache, so that the name in the cache matches the
10050 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10051 this cache to receive a list of all available values. If you change the
10052 identifier after the value list has been added to the cache, this may easily
10053 lead to confusion, but it's not forbidden of course.
10055 The cache is also used to convert counter values to rates. These rates are, for
10056 example, used by the C<value> match (see below). If you use the rate stored in
10057 the cache B<before> the new value is added, you will use the old, B<previous>
10058 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10059 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10062 Last but not last, the B<stop> target makes a difference: If the pre-cache
10063 chain returns the stop condition, the value will not be added to the cache and
10064 the post-cache chain will not be run.
10066 =item B<Chain> I<Name>
10068 Adds a new chain with a certain name. This name can be used to refer to a
10069 specific chain, for example to jump to it.
10071 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10073 =item B<Rule> [I<Name>]
10075 Adds a new rule to the current chain. The name of the rule is optional and
10076 currently has no meaning for the daemon.
10078 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10079 must be at least one B<Target> block.
10081 =item B<Match> I<Name>
10083 Adds a match to a B<Rule> block. The name specifies what kind of match should
10084 be performed. Available matches depend on the plugins that have been loaded.
10086 The arguments inside the B<Match> block are passed to the plugin implementing
10087 the match, so which arguments are valid here depends on the plugin being used.
10088 If you do not need any to pass any arguments to a match, you can use the
10093 Which is equivalent to:
10098 =item B<Target> I<Name>
10100 Add a target to a rule or a default target to a chain. The name specifies what
10101 kind of target is to be added. Which targets are available depends on the
10102 plugins being loaded.
10104 The arguments inside the B<Target> block are passed to the plugin implementing
10105 the target, so which arguments are valid here depends on the plugin being used.
10106 If you do not need any to pass any arguments to a target, you can use the
10111 This is the same as writing:
10118 =head2 Built-in targets
10120 The following targets are built into the core daemon and therefore need no
10121 plugins to be loaded:
10127 Signals the "return" condition, see the L<"Flow control"> section above. This
10128 causes the current chain to stop processing the value and returns control to
10129 the calling chain. The calling chain will continue processing targets and rules
10130 just after the B<jump> target (see below). This is very similar to the
10131 B<RETURN> target of iptables, see L<iptables(8)>.
10133 This target does not have any options.
10141 Signals the "stop" condition, see the L<"Flow control"> section above. This
10142 causes processing of the value to be aborted immediately. This is similar to
10143 the B<DROP> target of iptables, see L<iptables(8)>.
10145 This target does not have any options.
10153 Sends the value to "write" plugins.
10159 =item B<Plugin> I<Name>
10161 Name of the write plugin to which the data should be sent. This option may be
10162 given multiple times to send the data to more than one write plugin. If the
10163 plugin supports multiple instances, the plugin's instance(s) must also be
10168 If no plugin is explicitly specified, the values will be sent to all available
10171 Single-instance plugin example:
10177 Multi-instance plugin example:
10179 <Plugin "write_graphite">
10189 Plugin "write_graphite/foo"
10194 Starts processing the rules of another chain, see L<"Flow control"> above. If
10195 the end of that chain is reached, or a stop condition is encountered,
10196 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10197 next target or the next rule. This is similar to the B<-j> command line option
10198 of iptables, see L<iptables(8)>.
10204 =item B<Chain> I<Name>
10206 Jumps to the chain I<Name>. This argument is required and may appear only once.
10218 =head2 Available matches
10224 Matches a value using regular expressions.
10230 =item B<Host> I<Regex>
10232 =item B<Plugin> I<Regex>
10234 =item B<PluginInstance> I<Regex>
10236 =item B<Type> I<Regex>
10238 =item B<TypeInstance> I<Regex>
10240 =item B<MetaData> I<String> I<Regex>
10242 Match values where the given regular expressions match the various fields of
10243 the identifier of a value. If multiple regular expressions are given, B<all>
10244 regexen must match for a value to match.
10246 =item B<Invert> B<false>|B<true>
10248 When set to B<true>, the result of the match is inverted, i.e. all value lists
10249 where all regular expressions apply are not matched, all other value lists are
10250 matched. Defaults to B<false>.
10257 Host "customer[0-9]+"
10263 Matches values that have a time which differs from the time on the server.
10265 This match is mainly intended for servers that receive values over the
10266 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10267 is very sensitive to the timestamp used when updating the RRD files. In
10268 particular, the time must be ever increasing. If a misbehaving client sends one
10269 packet with a timestamp far in the future, all further packets with a correct
10270 time will be ignored because of that one packet. What's worse, such corrupted
10271 RRD files are hard to fix.
10273 This match lets one match all values B<outside> a specified time range
10274 (relative to the server's time), so you can use the B<stop> target (see below)
10275 to ignore the value, for example.
10281 =item B<Future> I<Seconds>
10283 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10284 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10287 =item B<Past> I<Seconds>
10289 Matches all values that are I<behind> of the server's time by I<Seconds> or
10290 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10302 This example matches all values that are five minutes or more ahead of the
10303 server or one hour (or more) lagging behind.
10307 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10308 values. If a data-set consists of more than one data-source, all data-sources
10309 must match the specified ranges for a positive match.
10315 =item B<Min> I<Value>
10317 Sets the smallest value which still results in a match. If unset, behaves like
10320 =item B<Max> I<Value>
10322 Sets the largest value which still results in a match. If unset, behaves like
10325 =item B<Invert> B<true>|B<false>
10327 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10328 no-match is returned and vice versa. Please note that the B<Invert> setting
10329 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10330 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10332 =item B<DataSource> I<DSName> [I<DSName> ...]
10334 Select one or more of the data sources. If no data source is configured, all
10335 data sources will be checked. If the type handled by the match does not have a
10336 data source of the specified name(s), this will always result in no match
10337 (independent of the B<Invert> setting).
10339 =item B<Satisfy> B<Any>|B<All>
10341 Specifies how checking with several data sources is performed. If set to
10342 B<Any>, the match succeeds if one of the data sources is in the configured
10343 range. If set to B<All> the match only succeeds if all data sources are within
10344 the configured range. Default is B<All>.
10346 Usually B<All> is used for positive matches, B<Any> is used for negative
10347 matches. This means that with B<All> you usually check that all values are in a
10348 "good" range, while with B<Any> you check if any value is within a "bad" range
10349 (or outside the "good" range).
10353 Either B<Min> or B<Max>, but not both, may be unset.
10357 # Match all values smaller than or equal to 100. Matches only if all data
10358 # sources are below 100.
10364 # Match if the value of any data source is outside the range of 0 - 100.
10372 =item B<empty_counter>
10374 Matches all values with one or more data sources of type B<COUNTER> and where
10375 all counter values are zero. These counters usually I<never> increased since
10376 they started existing (and are therefore uninteresting), or got reset recently
10377 or overflowed and you had really, I<really> bad luck.
10379 Please keep in mind that ignoring such counters can result in confusing
10380 behavior: Counters which hardly ever increase will be zero for long periods of
10381 time. If the counter is reset for some reason (machine or service restarted,
10382 usually), the graph will be empty (NAN) for a long time. People may not
10387 Calculates a hash value of the host name and matches values according to that
10388 hash value. This makes it possible to divide all hosts into groups and match
10389 only values that are in a specific group. The intended use is in load
10390 balancing, where you want to handle only part of all data and leave the rest
10393 The hashing function used tries to distribute the hosts evenly. First, it
10394 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10397 for (i = 0; host[i] != 0; i++)
10398 hash_value = (hash_value * 251) + host[i];
10400 The constant 251 is a prime number which is supposed to make this hash value
10401 more random. The code then checks the group for this host according to the
10402 I<Total> and I<Match> arguments:
10404 if ((hash_value % Total) == Match)
10409 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10410 groups), then the least significant bit of the hash value will be the XOR of
10411 all least significant bits in the host name. One consequence is that when you
10412 have two hosts, "server0.example.com" and "server1.example.com", where the host
10413 name differs in one digit only and the digits differ by one, those hosts will
10414 never end up in the same group.
10420 =item B<Match> I<Match> I<Total>
10422 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10423 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10424 be smaller than I<Total>. I<Total> must be at least one, although only values
10425 greater than one really do make any sense.
10427 You can repeat this option to match multiple groups, for example:
10432 The above config will divide the data into seven groups and match groups three
10433 and five. One use would be to keep every value on two hosts so that if one
10434 fails the missing data can later be reconstructed from the second host.
10440 # Operate on the pre-cache chain, so that ignored values are not even in the
10445 # Divide all received hosts in seven groups and accept all hosts in
10449 # If matched: Return and continue.
10452 # If not matched: Return and stop.
10458 =head2 Available targets
10462 =item B<notification>
10464 Creates and dispatches a notification.
10470 =item B<Message> I<String>
10472 This required option sets the message of the notification. The following
10473 placeholders will be replaced by an appropriate value:
10481 =item B<%{plugin_instance}>
10485 =item B<%{type_instance}>
10487 These placeholders are replaced by the identifier field of the same name.
10489 =item B<%{ds:>I<name>B<}>
10491 These placeholders are replaced by a (hopefully) human readable representation
10492 of the current rate of this data source. If you changed the instance name
10493 (using the B<set> or B<replace> targets, see below), it may not be possible to
10494 convert counter values to rates.
10498 Please note that these placeholders are B<case sensitive>!
10500 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10502 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10509 <Target "notification">
10510 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10516 Replaces parts of the identifier using regular expressions.
10522 =item B<Host> I<Regex> I<Replacement>
10524 =item B<Plugin> I<Regex> I<Replacement>
10526 =item B<PluginInstance> I<Regex> I<Replacement>
10528 =item B<TypeInstance> I<Regex> I<Replacement>
10530 =item B<MetaData> I<String> I<Regex> I<Replacement>
10532 =item B<DeleteMetaData> I<String> I<Regex>
10534 Match the appropriate field with the given regular expression I<Regex>. If the
10535 regular expression matches, that part that matches is replaced with
10536 I<Replacement>. If multiple places of the input buffer match a given regular
10537 expression, only the first occurrence will be replaced.
10539 You can specify each option multiple times to use multiple regular expressions
10547 # Replace "example.net" with "example.com"
10548 Host "\\<example.net\\>" "example.com"
10550 # Strip "www." from hostnames
10551 Host "\\<www\\." ""
10556 Sets part of the identifier of a value to a given string.
10562 =item B<Host> I<String>
10564 =item B<Plugin> I<String>
10566 =item B<PluginInstance> I<String>
10568 =item B<TypeInstance> I<String>
10570 =item B<MetaData> I<String> I<String>
10572 Set the appropriate field to the given string. The strings for plugin instance,
10573 type instance, and meta data may be empty, the strings for host and plugin may
10574 not be empty. It's currently not possible to set the type of a value this way.
10576 The following placeholders will be replaced by an appropriate value:
10584 =item B<%{plugin_instance}>
10588 =item B<%{type_instance}>
10590 These placeholders are replaced by the identifier field of the same name.
10592 =item B<%{meta:>I<name>B<}>
10594 These placeholders are replaced by the meta data value with the given name.
10598 Please note that these placeholders are B<case sensitive>!
10600 =item B<DeleteMetaData> I<String>
10602 Delete the named meta data field.
10609 PluginInstance "coretemp"
10610 TypeInstance "core3"
10615 =head2 Backwards compatibility
10617 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10618 B<Chain> block, it will behave as it used to. This is equivalent to the
10619 following configuration:
10621 <Chain "PostCache">
10625 If you specify a B<PostCacheChain>, the B<write> target will not be added
10626 anywhere and you will have to make sure that it is called where appropriate. We
10627 suggest to add the above snippet as default target to your "PostCache" chain.
10631 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10646 B<Ignorelists> are a generic framework to either ignore some metrics or report
10647 specific metircs only. Plugins usually provide one or more options to specify
10648 the items (mounts points, devices, ...) and the boolean option
10653 =item B<Select> I<String>
10655 Selects the item I<String>. This option often has a plugin specific name, e.g.
10656 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10657 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10658 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10660 By default, this option is doing a case-sensitive full-string match. The
10661 following config will match C<foo>, but not C<Foo>:
10665 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10666 I<regular expression>. For example, so match all item starting with C<foo>, use
10667 could use the following syntax:
10671 The regular expression is I<not> anchored, i.e. the following config will match
10672 C<foobar>, C<barfoo> and C<AfooZ>:
10676 The B<Select> option may be repeated to select multiple items.
10678 =item B<IgnoreSelected> B<true>|B<false>
10680 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10681 collected. If set to B<false>, matching metrics are I<collected> and all other
10682 metrics are ignored.
10689 L<collectd-exec(5)>,
10690 L<collectd-perl(5)>,
10691 L<collectd-unixsock(5)>,
10704 Florian Forster E<lt>octo@collectd.orgE<gt>