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">
1628 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1634 CACert "/path/to/ca.crt"
1635 Header "X-Custom-Header: foobar"
1638 MeasureResponseTime false
1639 MeasureResponseCode false
1642 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1643 DSType "GaugeAverage"
1644 # Note: `stock_value' is not a standard type.
1651 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1652 a web page and one or more "matches" to be performed on the returned data. The
1653 string argument to the B<Page> block is used as plugin instance.
1655 The following options are valid within B<Page> blocks:
1659 =item B<Plugin> I<Plugin>
1661 Use I<Plugin> as the plugin name when submitting values.
1662 Defaults to C<curl>.
1666 URL of the web site to retrieve. Since a regular expression will be used to
1667 extract information from this data, non-binary data is a big plus here ;)
1669 =item B<User> I<Name>
1671 Username to use if authorization is required to read the page.
1673 =item B<Password> I<Password>
1675 Password to use if authorization is required to read the page.
1677 =item B<Digest> B<true>|B<false>
1679 Enable HTTP digest authentication.
1681 =item B<VerifyPeer> B<true>|B<false>
1683 Enable or disable peer SSL certificate verification. See
1684 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1686 =item B<VerifyHost> B<true>|B<false>
1688 Enable or disable peer host name verification. If enabled, the plugin checks if
1689 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1690 matches the host name provided by the B<URL> option. If this identity check
1691 fails, the connection is aborted. Obviously, only works when connecting to a
1692 SSL enabled server. Enabled by default.
1694 =item B<CACert> I<file>
1696 File that holds one or more SSL certificates. If you want to use HTTPS you will
1697 possibly need this option. What CA certificates come bundled with C<libcurl>
1698 and are checked by default depends on the distribution you use.
1700 =item B<Header> I<Header>
1702 A HTTP header to add to the request. Multiple headers are added if this option
1703 is specified more than once.
1705 =item B<Post> I<Body>
1707 Specifies that the HTTP operation should be a POST instead of a GET. The
1708 complete data to be posted is given as the argument. This option will usually
1709 need to be accompanied by a B<Header> option to set an appropriate
1710 C<Content-Type> for the post body (e.g. to
1711 C<application/x-www-form-urlencoded>).
1713 =item B<MeasureResponseTime> B<true>|B<false>
1715 Measure response time for the request. If this setting is enabled, B<Match>
1716 blocks (see below) are optional. Disabled by default.
1718 Beware that requests will get aborted if they take too long to complete. Adjust
1719 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1722 This option is similar to enabling the B<TotalTime> statistic but it's
1723 measured by collectd instead of cURL.
1725 =item B<MeasureResponseCode> B<true>|B<false>
1727 Measure response code for the request. If this setting is enabled, B<Match>
1728 blocks (see below) are optional. Disabled by default.
1730 =item B<E<lt>StatisticsE<gt>>
1732 One B<Statistics> block can be used to specify cURL statistics to be collected
1733 for each request to the remote web site. See the section "cURL Statistics"
1734 above for details. If this setting is enabled, B<Match> blocks (see below) are
1737 =item B<E<lt>MatchE<gt>>
1739 One or more B<Match> blocks that define how to match information in the data
1740 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
1741 used by the C<tail> plugin, so please see the documentation of the C<tail>
1742 plugin below on how matches are defined. If the B<MeasureResponseTime> or
1743 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
1746 =item B<Timeout> I<Milliseconds>
1748 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1749 milliseconds. By default, the configured B<Interval> is used to set the
1750 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
1751 indefinitely. This legacy behaviour can be achieved by setting the value of
1754 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
1755 network connection will stall one read thread. Adjust the B<ReadThreads> global
1756 setting accordingly to prevent this from blocking other plugins.
1760 =head2 Plugin C<curl_json>
1762 The B<curl_json plugin> collects values from JSON data to be parsed by
1763 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
1764 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
1765 unix socket. The former can be used, for example, to collect values
1766 from CouchDB documents (which are stored JSON notation), and the
1767 latter to collect values from a uWSGI stats socket.
1769 The following example will collect several values from the built-in
1770 C<_stats> runtime statistics module of I<CouchDB>
1771 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
1774 <URL "http://localhost:5984/_stats">
1776 <Key "httpd/requests/count">
1777 Type "http_requests"
1780 <Key "httpd_request_methods/*/count">
1781 Type "http_request_methods"
1784 <Key "httpd_status_codes/*/count">
1785 Type "http_response_codes"
1790 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
1793 <Sock "/var/run/uwsgi.stats.sock">
1795 <Key "workers/*/requests">
1796 Type "http_requests"
1799 <Key "workers/*/apps/*/requests">
1800 Type "http_requests"
1805 In the B<Plugin> block, there may be one or more B<URL> blocks, each
1806 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
1807 blocks defining a unix socket to read JSON from directly. Each of
1808 these blocks may have one or more B<Key> blocks.
1810 The B<Key> string argument must be in a path format. Each component is
1811 used to match the key from a JSON map or the index of an JSON
1812 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
1813 values for all map keys or array indices will be collectd.
1815 The following options are valid within B<URL> blocks:
1819 =item B<Host> I<Name>
1821 Use I<Name> as the host name when submitting values. Defaults to the global
1824 =item B<Plugin> I<Plugin>
1826 Use I<Plugin> as the plugin name when submitting values.
1827 Defaults to C<curl_json>.
1829 =item B<Instance> I<Instance>
1831 Sets the plugin instance to I<Instance>.
1833 =item B<Interval> I<Interval>
1835 Sets the interval (in seconds) in which the values will be collected from this
1836 URL. By default the global B<Interval> setting will be used.
1838 =item B<User> I<Name>
1840 =item B<Password> I<Password>
1842 =item B<Digest> B<true>|B<false>
1844 =item B<VerifyPeer> B<true>|B<false>
1846 =item B<VerifyHost> B<true>|B<false>
1848 =item B<CACert> I<file>
1850 =item B<Header> I<Header>
1852 =item B<Post> I<Body>
1854 =item B<Timeout> I<Milliseconds>
1856 These options behave exactly equivalent to the appropriate options of the
1857 I<cURL> plugin. Please see there for a detailed description.
1859 =item B<E<lt>StatisticsE<gt>>
1861 One B<Statistics> block can be used to specify cURL statistics to be collected
1862 for each request to the remote URL. See the section "cURL Statistics" above
1867 The following options are valid within B<Key> blocks:
1871 =item B<Type> I<Type>
1873 Sets the type used to dispatch the values to the daemon. Detailed information
1874 about types and their configuration can be found in L<types.db(5)>. This
1875 option is mandatory.
1877 =item B<Instance> I<Instance>
1879 Type-instance to use. Defaults to the current map key or current string array element value.
1883 =head2 Plugin C<curl_xml>
1885 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
1886 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
1889 <URL "http://localhost/stats.xml">
1892 Instance "some_instance"
1897 CACert "/path/to/ca.crt"
1898 Header "X-Custom-Header: foobar"
1901 <XPath "table[@id=\"magic_level\"]/tr">
1903 #InstancePrefix "prefix-"
1904 InstanceFrom "td[1]"
1905 ValuesFrom "td[2]/span[@class=\"level\"]"
1910 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
1911 URL to be fetched using libcurl. Within each B<URL> block there are
1912 options which specify the connection parameters, for example authentication
1913 information, and one or more B<XPath> blocks.
1915 Each B<XPath> block specifies how to get one type of information. The
1916 string argument must be a valid XPath expression which returns a list
1917 of "base elements". One value is dispatched for each "base element". The
1918 I<type instance> and values are looked up using further I<XPath> expressions
1919 that should be relative to the base element.
1921 Within the B<URL> block the following options are accepted:
1925 =item B<Host> I<Name>
1927 Use I<Name> as the host name when submitting values. Defaults to the global
1930 =item B<Instance> I<Instance>
1932 Use I<Instance> as the plugin instance when submitting values.
1933 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
1934 Defaults to an empty string (no plugin instance).
1936 =item B<Plugin> I<Plugin>
1938 Use I<Plugin> as the plugin name when submitting values.
1939 Defaults to 'curl_xml'.
1941 =item B<Namespace> I<Prefix> I<URL>
1943 If an XPath expression references namespaces, they must be specified
1944 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
1945 I<URL> is the "namespace name", an URI reference uniquely identifying the
1946 namespace. The option can be repeated to register multiple namespaces.
1950 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
1951 Namespace "m" "http://www.w3.org/1998/Math/MathML"
1953 =item B<User> I<User>
1955 =item B<Password> I<Password>
1957 =item B<Digest> B<true>|B<false>
1959 =item B<VerifyPeer> B<true>|B<false>
1961 =item B<VerifyHost> B<true>|B<false>
1963 =item B<CACert> I<CA Cert File>
1965 =item B<Header> I<Header>
1967 =item B<Post> I<Body>
1969 =item B<Timeout> I<Milliseconds>
1971 These options behave exactly equivalent to the appropriate options of the
1972 I<cURL plugin>. Please see there for a detailed description.
1974 =item B<E<lt>StatisticsE<gt>>
1976 One B<Statistics> block can be used to specify cURL statistics to be collected
1977 for each request to the remote URL. See the section "cURL Statistics" above
1980 =item E<lt>B<XPath> I<XPath-expression>E<gt>
1982 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
1983 B<XPath> block specifies how to get one type of information. The string
1984 argument must be a valid XPath expression which returns a list of "base
1985 elements". One value is dispatched for each "base element".
1987 Within the B<XPath> block the following options are accepted:
1991 =item B<Type> I<Type>
1993 Specifies the I<Type> used for submitting patches. This determines the number
1994 of values that are required / expected and whether the strings are parsed as
1995 signed or unsigned integer or as double values. See L<types.db(5)> for details.
1996 This option is required.
1998 =item B<InstancePrefix> I<InstancePrefix>
2000 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2001 concatenated together without any separator.
2002 This option is optional.
2004 =item B<InstanceFrom> I<InstanceFrom>
2006 Specifies a XPath expression to use for determining the I<type instance>. The
2007 XPath expression must return exactly one element. The element's value is then
2008 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2010 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2012 Specifies a XPath expression to use for determining the I<plugin instance>. The
2013 XPath expression must return exactly one element. The element's value is then
2014 used as I<plugin instance>.
2018 If the "base XPath expression" (the argument to the B<XPath> block) returns
2019 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2020 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2024 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2026 Specifies one or more XPath expression to use for reading the values. The
2027 number of XPath expressions must match the number of data sources in the
2028 I<type> specified with B<Type> (see above). Each XPath expression must return
2029 exactly one element. The element's value is then parsed as a number and used as
2030 value for the appropriate value in the value list dispatched to the daemon.
2036 =head2 Plugin C<dbi>
2038 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2039 connect to various databases, execute I<SQL> statements and read back the
2040 results. I<dbi> is an acronym for "database interface" in case you were
2041 wondering about the name. You can configure how each column is to be
2042 interpreted and the plugin will generate one or more data sets from each row
2043 returned according to these rules.
2045 Because the plugin is very generic, the configuration is a little more complex
2046 than those of other plugins. It usually looks something like this:
2049 <Query "out_of_stock">
2050 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2051 # Use with MySQL 5.0.0 or later
2055 InstancePrefix "out_of_stock"
2056 InstancesFrom "category"
2060 <Database "product_information">
2064 DriverOption "host" "localhost"
2065 DriverOption "username" "collectd"
2066 DriverOption "password" "aZo6daiw"
2067 DriverOption "dbname" "prod_info"
2068 SelectDB "prod_info"
2069 Query "out_of_stock"
2073 The configuration above defines one query with one result and one database. The
2074 query is then linked to the database with the B<Query> option I<within> the
2075 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2076 and you can also use the B<Include> statement to split up the configuration
2077 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2078 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2081 The following is a complete list of options:
2083 =head3 B<Query> blocks
2085 Query blocks define I<SQL> statements and how the returned data should be
2086 interpreted. They are identified by the name that is given in the opening line
2087 of the block. Thus the name needs to be unique. Other than that, the name is
2088 not used in collectd.
2090 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2091 define which column holds which value or instance information. You can use
2092 multiple B<Result> blocks to create multiple values from one returned row. This
2093 is especially useful, when queries take a long time and sending almost the same
2094 query again and again is not desirable.
2098 <Query "environment">
2099 Statement "select station, temperature, humidity from environment"
2102 # InstancePrefix "foo"
2103 InstancesFrom "station"
2104 ValuesFrom "temperature"
2108 InstancesFrom "station"
2109 ValuesFrom "humidity"
2113 The following options are accepted:
2117 =item B<Statement> I<SQL>
2119 Sets the statement that should be executed on the server. This is B<not>
2120 interpreted by collectd, but simply passed to the database server. Therefore,
2121 the SQL dialect that's used depends on the server collectd is connected to.
2123 The query has to return at least two columns, one for the instance and one
2124 value. You cannot omit the instance, even if the statement is guaranteed to
2125 always return exactly one line. In that case, you can usually specify something
2128 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2130 (That works with MySQL but may not be valid SQL according to the spec. If you
2131 use a more strict database server, you may have to select from a dummy table or
2134 Please note that some databases, for example B<Oracle>, will fail if you
2135 include a semicolon at the end of the statement.
2137 =item B<MinVersion> I<Version>
2139 =item B<MaxVersion> I<Value>
2141 Only use this query for the specified database version. You can use these
2142 options to provide multiple queries with the same name but with a slightly
2143 different syntax. The plugin will use only those queries, where the specified
2144 minimum and maximum versions fit the version of the database in use.
2146 The database version is determined by C<dbi_conn_get_engine_version>, see the
2147 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2148 for details. Basically, each part of the version is assumed to be in the range
2149 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2150 "40102", version "5.0.42" becomes "50042".
2152 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2153 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2154 happen. Don't to it! A valid example would be something along these lines:
2165 In the above example, there are three ranges that don't overlap. The last one
2166 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2167 before "4.0.0" are not specified.
2169 =item B<Type> I<Type>
2171 The B<type> that's used for each line returned. See L<types.db(5)> for more
2172 details on how types are defined. In short: A type is a predefined layout of
2173 data and the number of values and type of values has to match the type
2176 If you specify "temperature" here, you need exactly one gauge column. If you
2177 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2180 There must be exactly one B<Type> option inside each B<Result> block.
2182 =item B<InstancePrefix> I<prefix>
2184 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2185 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2186 all strings returned in the appropriate columns are concatenated together,
2187 separated by dashes I<("-")>.
2189 =item B<InstancesFrom> I<column0> [I<column1> ...]
2191 Specifies the columns whose values will be used to create the "type-instance"
2192 for each row. If you specify more than one column, the value of all columns
2193 will be joined together with dashes I<("-")> as separation characters.
2195 The plugin itself does not check whether or not all built instances are
2196 different. It's your responsibility to assure that each is unique. This is
2197 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2198 sure that only one row is returned in this case.
2200 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2203 =item B<ValuesFrom> I<column0> [I<column1> ...]
2205 Names the columns whose content is used as the actual data for the data sets
2206 that are dispatched to the daemon. How many such columns you need is determined
2207 by the B<Type> setting above. If you specify too many or not enough columns,
2208 the plugin will complain about that and no data will be submitted to the
2211 The actual data type in the columns is not that important. The plugin will
2212 automatically cast the values to the right type if it know how to do that. So
2213 it should be able to handle integer an floating point types, as well as strings
2214 (if they include a number at the beginning).
2216 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2218 =item B<MetadataFrom> [I<column0> I<column1> ...]
2220 Names the columns whose content is used as metadata for the data sets
2221 that are dispatched to the daemon.
2223 The actual data type in the columns is not that important. The plugin will
2224 automatically cast the values to the right type if it know how to do that. So
2225 it should be able to handle integer an floating point types, as well as strings
2226 (if they include a number at the beginning).
2230 =head3 B<Database> blocks
2232 Database blocks define a connection to a database and which queries should be
2233 sent to that database. Since the used "dbi" library can handle a wide variety
2234 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2235 documentationE<nbsp>- we stick as close to the terminology used there.
2237 Each database needs a "name" as string argument in the starting tag of the
2238 block. This name will be used as "PluginInstance" in the values submitted to
2239 the daemon. Other than that, that name is not used.
2243 =item B<Plugin> I<Plugin>
2245 Use I<Plugin> as the plugin name when submitting query results from
2246 this B<Database>. Defaults to C<dbi>.
2248 =item B<Interval> I<Interval>
2250 Sets the interval (in seconds) in which the values will be collected from this
2251 database. By default the global B<Interval> setting will be used.
2253 =item B<Driver> I<Driver>
2255 Specifies the driver to use to connect to the database. In many cases those
2256 drivers are named after the database they can connect to, but this is not a
2257 technical necessity. These drivers are sometimes referred to as "DBD",
2258 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2259 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2260 project at L<http://libdbi-drivers.sourceforge.net/>.
2262 You need to give the driver name as expected by the "dbi" library here. You
2263 should be able to find that in the documentation for each driver. If you
2264 mistype the driver name, the plugin will dump a list of all known driver names
2267 =item B<DriverOption> I<Key> I<Value>
2269 Sets driver-specific options. What option a driver supports can be found in the
2270 documentation for each driver, somewhere at
2271 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2272 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2274 DBDs can register two types of options: String options and numeric options. The
2275 plugin will use the C<dbi_conn_set_option> function when the configuration
2276 provides a string and the C<dbi_conn_require_option_numeric> function when the
2277 configuration provides a number. So these two lines will actually result in
2278 different calls being used:
2280 DriverOption "Port" 1234 # numeric
2281 DriverOption "Port" "1234" # string
2283 Unfortunately, drivers are not too keen to report errors when an unknown option
2284 is passed to them, so invalid settings here may go unnoticed. This is not the
2285 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2286 the driver. If a driver complains about an option, the plugin will dump a
2287 complete list of all options understood by that driver to the log. There is no
2288 way to programmatically find out if an option expects a string or a numeric
2289 argument, so you will have to refer to the appropriate DBD's documentation to
2290 find this out. Sorry.
2292 =item B<SelectDB> I<Database>
2294 In some cases, the database name you connect with is not the database name you
2295 want to use for querying data. If this option is set, the plugin will "select"
2296 (switch to) that database after the connection is established.
2298 =item B<Query> I<QueryName>
2300 Associates the query named I<QueryName> with this database connection. The
2301 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2302 blocks you want to refer to must be placed above the database block you want to
2305 =item B<Host> I<Hostname>
2307 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2308 values. Defaults to the global hostname setting.
2316 =item B<Device> I<Device>
2318 Select partitions based on the devicename.
2320 See F</"IGNORELISTS"> for details.
2322 =item B<MountPoint> I<Directory>
2324 Select partitions based on the mountpoint.
2326 See F</"IGNORELISTS"> for details.
2328 =item B<FSType> I<FSType>
2330 Select partitions based on the filesystem type.
2332 See F</"IGNORELISTS"> for details.
2334 =item B<IgnoreSelected> B<true>|B<false>
2336 Invert the selection: If set to true, all partitions B<except> the ones that
2337 match any one of the criteria are collected. By default only selected
2338 partitions are collected if a selection is made. If no selection is configured
2339 at all, B<all> partitions are selected.
2341 =item B<ReportByDevice> B<true>|B<false>
2343 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2344 (the default), it will report a disk as "root", but with it I<true>, it will be
2345 "sda1" (or whichever).
2347 =item B<ReportInodes> B<true>|B<false>
2349 Enables or disables reporting of free, reserved and used inodes. Defaults to
2350 inode collection being disabled.
2352 Enable this option if inodes are a scarce resource for you, usually because
2353 many small files are stored on the disk. This is a usual scenario for mail
2354 transfer agents and web caches.
2356 =item B<ValuesAbsolute> B<true>|B<false>
2358 Enables or disables reporting of free and used disk space in 1K-blocks.
2359 Defaults to B<true>.
2361 =item B<ValuesPercentage> B<false>|B<true>
2363 Enables or disables reporting of free and used disk space in percentage.
2364 Defaults to B<false>.
2366 This is useful for deploying I<collectd> on the cloud, where machines with
2367 different disk size may exist. Then it is more practical to configure
2368 thresholds based on relative disk size.
2372 =head2 Plugin C<disk>
2374 The C<disk> plugin collects information about the usage of physical disks and
2375 logical disks (partitions). Values collected are the number of octets written
2376 to and read from a disk or partition, the number of read/write operations
2377 issued to the disk and a rather complex "time" it took for these commands to be
2380 Using the following two options you can ignore some disks or configure the
2381 collection only of specific disks.
2385 =item B<Disk> I<Name>
2387 Select the disk I<Name>. Whether it is collected or ignored depends on the
2388 B<IgnoreSelected> setting, see below. As with other plugins that use the
2389 daemon's ignorelist functionality, a string that starts and ends with a slash
2390 is interpreted as a regular expression. Examples:
2395 See F</"IGNORELISTS"> for details.
2397 =item B<IgnoreSelected> B<true>|B<false>
2399 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2400 statements, are ignored or if all other disks are ignored. The behavior
2401 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2402 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2403 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2404 is set to B<true>, all disks are collected B<except> the ones matched.
2406 =item B<UseBSDName> B<true>|B<false>
2408 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2409 default major/minor numbers. Requires collectd to be built with Apple's
2412 =item B<UdevNameAttr> I<Attribute>
2414 Attempt to override disk instance name with the value of a specified udev
2415 attribute when built with B<libudev>. If the attribute is not defined for the
2416 given device, the default name is used. Example:
2418 UdevNameAttr "DM_NAME"
2422 =head2 Plugin C<dns>
2426 =item B<Interface> I<Interface>
2428 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2429 option sets the interface that should be used. If this option is not set, or
2430 set to "any", the plugin will try to get packets from B<all> interfaces. This
2431 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2433 =item B<IgnoreSource> I<IP-address>
2435 Ignore packets that originate from this address.
2437 =item B<SelectNumericQueryTypes> B<true>|B<false>
2439 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2443 =head2 Plugin C<dpdkevents>
2445 The I<dpdkevents plugin> collects events from DPDK such as link status of
2446 network ports and Keep Alive status of DPDK logical cores.
2447 In order to get Keep Alive events following requirements must be met:
2449 - support for Keep Alive implemented in DPDK application. More details can
2450 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2454 <Plugin "dpdkevents">
2460 <Event "link_status">
2461 SendEventsOnUpdate true
2462 EnabledPortMask 0xffff
2463 PortName "interface1"
2464 PortName "interface2"
2465 SendNotification false
2467 <Event "keep_alive">
2468 SendEventsOnUpdate true
2470 KeepAliveShmName "/dpdk_keepalive_shm_name"
2471 SendNotification false
2478 =head3 The EAL block
2482 =item B<Coremask> I<Mask>
2484 =item B<Memorychannels> I<Channels>
2486 Number of memory channels per processor socket.
2488 =item B<FilePrefix> I<File>
2490 The prefix text used for hugepage filenames. The filename will be set to
2491 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2495 =head3 The Event block
2497 The B<Event> block defines configuration for specific event. It accepts a
2498 single argument which specifies the name of the event.
2500 =head4 Link Status event
2504 =item B<SendEventOnUpdate> I<true|false>
2506 If set to true link status value will be dispatched only when it is
2507 different from previously read value. This is an optional argument - default
2510 =item B<EnabledPortMask> I<Mask>
2512 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2513 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2514 that all ports will be enabled. This is an optional argument - by default
2515 all ports are enabled.
2517 =item B<PortName> I<Name>
2519 A string containing an optional name for the enabled DPDK ports. Each PortName
2520 option should contain only one port name; specify as many PortName options as
2521 desired. Default naming convention will be used if PortName is blank. If there
2522 are less PortName options than there are enabled ports, the default naming
2523 convention will be used for the additional ports.
2525 =item B<SendNotification> I<true|false>
2527 If set to true, link status notifications are sent, instead of link status
2528 being collected as a statistic. This is an optional argument - default
2533 =head4 Keep Alive event
2537 =item B<SendEventOnUpdate> I<true|false>
2539 If set to true keep alive value will be dispatched only when it is
2540 different from previously read value. This is an optional argument - default
2543 =item B<LCoreMask> I<Mask>
2545 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2547 =item B<KeepAliveShmName> I<Name>
2549 Shared memory name identifier that is used by secondary process to monitor
2550 the keep alive cores state.
2552 =item B<SendNotification> I<true|false>
2554 If set to true, keep alive notifications are sent, instead of keep alive
2555 information being collected as a statistic. This is an optional
2556 argument - default value is false.
2560 =head2 Plugin C<dpdkstat>
2562 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2563 extended NIC stats API in DPDK.
2574 SharedMemObj "dpdk_collectd_stats_0"
2575 EnabledPortMask 0xffff
2576 PortName "interface1"
2577 PortName "interface2"
2582 =head3 The EAL block
2586 =item B<Coremask> I<Mask>
2588 A string containing an hexadecimal bit mask of the cores to run on. Note that
2589 core numbering can change between platforms and should be determined beforehand.
2591 =item B<Memorychannels> I<Channels>
2593 A string containing a number of memory channels per processor socket.
2595 =item B<FilePrefix> I<File>
2597 The prefix text used for hugepage filenames. The filename will be set to
2598 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2600 =item B<SocketMemory> I<MB>
2602 A string containing amount of Memory to allocate from hugepages on specific
2603 sockets in MB. This is an optional value.
2609 =item B<SharedMemObj> I<Mask>
2611 A string containing the name of the shared memory object that should be used to
2612 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2613 Defaults to dpdk_collectd_stats if no other value is configured.
2615 =item B<EnabledPortMask> I<Mask>
2617 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2618 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2619 that all ports will be enabled. This is an optional argument - default
2620 is all ports enabled.
2622 =item B<PortName> I<Name>
2624 A string containing an optional name for the enabled DPDK ports. Each PortName
2625 option should contain only one port name; specify as many PortName options as
2626 desired. Default naming convention will be used if PortName is blank. If there
2627 are less PortName options than there are enabled ports, the default naming
2628 convention will be used for the additional ports.
2632 =head2 Plugin C<email>
2636 =item B<SocketFile> I<Path>
2638 Sets the socket-file which is to be created.
2640 =item B<SocketGroup> I<Group>
2642 If running as root change the group of the UNIX-socket after it has been
2643 created. Defaults to B<collectd>.
2645 =item B<SocketPerms> I<Permissions>
2647 Change the file permissions of the UNIX-socket after it has been created. The
2648 permissions must be given as a numeric, octal value as you would pass to
2649 L<chmod(1)>. Defaults to B<0770>.
2651 =item B<MaxConns> I<Number>
2653 Sets the maximum number of connections that can be handled in parallel. Since
2654 this many threads will be started immediately setting this to a very high
2655 value will waste valuable resources. Defaults to B<5> and will be forced to be
2656 at most B<16384> to prevent typos and dumb mistakes.
2660 =head2 Plugin C<ethstat>
2662 The I<ethstat plugin> collects information about network interface cards (NICs)
2663 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2669 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2670 Map "multicast" "if_multicast"
2677 =item B<Interface> I<Name>
2679 Collect statistical information about interface I<Name>.
2681 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2683 By default, the plugin will submit values as type C<derive> and I<type
2684 instance> set to I<Name>, the name of the metric as reported by the driver. If
2685 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2686 I<TypeInstance> will be used.
2688 =item B<MappedOnly> B<true>|B<false>
2690 When set to B<true>, only metrics that can be mapped to a I<type> will be
2691 collected, all other metrics will be ignored. Defaults to B<false>.
2695 =head2 Plugin C<exec>
2697 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2698 contains valuable information on when the executable is executed and the
2699 output that is expected from it.
2703 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2705 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
2707 Execute the executable I<Executable> as user I<User>. If the user name is
2708 followed by a colon and a group name, the effective group is set to that group.
2709 The real group and saved-set group will be set to the default group of that
2710 user. If no group is given the effective group ID will be the same as the real
2713 Please note that in order to change the user and/or group the daemon needs
2714 superuser privileges. If the daemon is run as an unprivileged user you must
2715 specify the same user/group here. If the daemon is run with superuser
2716 privileges, you must supply a non-root user here.
2718 The executable may be followed by optional arguments that are passed to the
2719 program. Please note that due to the configuration parsing numbers and boolean
2720 values may be changed. If you want to be absolutely sure that something is
2721 passed as-is please enclose it in quotes.
2723 The B<Exec> and B<NotificationExec> statements change the semantics of the
2724 programs executed, i.E<nbsp>e. the data passed to them and the response
2725 expected from them. This is documented in great detail in L<collectd-exec(5)>.
2729 =head2 Plugin C<fhcount>
2731 The C<fhcount> plugin provides statistics about used, unused and total number of
2732 file handles on Linux.
2734 The I<fhcount plugin> provides the following configuration options:
2738 =item B<ValuesAbsolute> B<true>|B<false>
2740 Enables or disables reporting of file handles usage in absolute numbers,
2741 e.g. file handles used. Defaults to B<true>.
2743 =item B<ValuesPercentage> B<false>|B<true>
2745 Enables or disables reporting of file handles usage in percentages, e.g.
2746 percent of file handles used. Defaults to B<false>.
2750 =head2 Plugin C<filecount>
2752 The C<filecount> plugin counts the number of files in a certain directory (and
2753 its subdirectories) and their combined size. The configuration is very straight
2756 <Plugin "filecount">
2757 <Directory "/var/qmail/queue/mess">
2758 Instance "qmail-message"
2760 <Directory "/var/qmail/queue/todo">
2761 Instance "qmail-todo"
2763 <Directory "/var/lib/php5">
2764 Instance "php5-sessions"
2769 The example above counts the number of files in QMail's queue directories and
2770 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
2771 QMail has not yet looked at, the "message" queue holds the messages that were
2772 classified into "local" and "remote".
2774 As you can see, the configuration consists of one or more C<Directory> blocks,
2775 each of which specifies a directory in which to count the files. Within those
2776 blocks, the following options are recognized:
2780 =item B<Plugin> I<Plugin>
2782 Use I<Plugin> as the plugin name when submitting values.
2783 Defaults to B<filecount>.
2785 =item B<Instance> I<Instance>
2787 Sets the plugin instance to I<Instance>. If not given, the instance is set to
2788 the directory name with all slashes replaced by underscores and all leading
2789 underscores removed. Empty value is allowed.
2791 =item B<Name> I<Pattern>
2793 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
2794 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
2795 against the pattern, not the entire path. In case this makes it easier for you:
2796 This option has been named after the B<-name> parameter to L<find(1)>.
2798 =item B<MTime> I<Age>
2800 Count only files of a specific age: If I<Age> is greater than zero, only files
2801 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
2802 a negative number, this is inversed. For example, if B<-60> is specified, only
2803 files that have been modified in the last minute will be counted.
2805 The number can also be followed by a "multiplier" to easily specify a larger
2806 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
2807 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
2808 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
2809 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
2810 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
2813 =item B<Size> I<Size>
2815 Count only files of a specific size. When I<Size> is a positive number, only
2816 files that are at least this big are counted. If I<Size> is a negative number,
2817 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
2818 I<Size> are counted.
2820 As with the B<MTime> option, a "multiplier" may be added. For a detailed
2821 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
2822 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
2823 note that there are 1000 bytes in a kilobyte, not 1024.
2825 =item B<Recursive> I<true>|I<false>
2827 Controls whether or not to recurse into subdirectories. Enabled by default.
2829 =item B<IncludeHidden> I<true>|I<false>
2831 Controls whether or not to include "hidden" files and directories in the count.
2832 "Hidden" files and directories are those, whose name begins with a dot.
2833 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
2835 =item B<FilesSizeType> I<Type>
2837 Sets the type used to dispatch files combined size. Empty value ("") disables
2838 reporting. Defaults to B<bytes>.
2840 =item B<FilesCountType> I<Type>
2842 Sets the type used to dispatch number of files. Empty value ("") disables
2843 reporting. Defaults to B<files>.
2845 =item B<TypeInstance> I<Instance>
2847 Sets the I<type instance> used to dispatch values. Defaults to an empty string
2848 (no plugin instance).
2852 =head2 Plugin C<GenericJMX>
2854 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
2855 L<collectd-java(5)>.
2857 =head2 Plugin C<gmond>
2859 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
2860 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
2861 are built-in, custom mappings may be added via B<Metric> blocks, see below.
2866 MCReceiveFrom "239.2.11.71" "8649"
2867 <Metric "swap_total">
2869 TypeInstance "total"
2872 <Metric "swap_free">
2879 The following metrics are built-in:
2885 load_one, load_five, load_fifteen
2889 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
2893 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
2905 Available configuration options:
2909 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
2911 Sets sets the multicast group and UDP port to which to subscribe.
2913 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
2915 =item E<lt>B<Metric> I<Name>E<gt>
2917 These blocks add a new metric conversion to the internal table. I<Name>, the
2918 string argument to the B<Metric> block, is the metric name as used by Ganglia.
2922 =item B<Type> I<Type>
2924 Type to map this metric to. Required.
2926 =item B<TypeInstance> I<Instance>
2928 Type-instance to use. Optional.
2930 =item B<DataSource> I<Name>
2932 Data source to map this metric to. If the configured type has exactly one data
2933 source, this is optional. Otherwise the option is required.
2939 =head2 Plugin C<gps>
2941 The C<gps plugin> connects to gpsd on the host machine.
2942 The host, port, timeout and pause are configurable.
2944 This is useful if you run an NTP server using a GPS for source and you want to
2947 Mind your GPS must send $--GSA for having the data reported!
2949 The following elements are collected:
2955 Number of satellites used for fix (type instance "used") and in view (type
2956 instance "visible"). 0 means no GPS satellites are visible.
2958 =item B<dilution_of_precision>
2960 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
2961 It should be between 0 and 3.
2962 Look at the documentation of your GPS to know more.
2970 # Connect to localhost on gpsd regular port:
2975 # PauseConnect of 5 sec. between connection attempts.
2979 Available configuration options:
2983 =item B<Host> I<Host>
2985 The host on which gpsd daemon runs. Defaults to B<localhost>.
2987 =item B<Port> I<Port>
2989 Port to connect to gpsd on the host machine. Defaults to B<2947>.
2991 =item B<Timeout> I<Seconds>
2993 Timeout in seconds (default 0.015 sec).
2995 The GPS data stream is fetch by the plugin form the daemon.
2996 It waits for data to be available, if none arrives it times out
2997 and loop for another reading.
2998 Mind to put a low value gpsd expects value in the micro-seconds area
2999 (recommended is 500 us) since the waiting function is blocking.
3000 Value must be between 500 us and 5 sec., if outside that range the
3001 default value is applied.
3003 This only applies from gpsd release-2.95.
3005 =item B<PauseConnect> I<Seconds>
3007 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3011 =head2 Plugin C<grpc>
3013 The I<grpc> plugin provides an RPC interface to submit values to or query
3014 values from collectd based on the open source gRPC framework. It exposes an
3015 end-point for dispatching values to the daemon.
3017 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3021 =item B<Server> I<Host> I<Port>
3023 The B<Server> statement sets the address of a server to which to send metrics
3024 via the C<DispatchValues> function.
3026 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3028 Optionally, B<Server> may be specified as a configuration block which supports
3029 the following options:
3033 =item B<EnableSSL> B<false>|B<true>
3035 Whether to require SSL for outgoing connections. Default: false.
3037 =item B<SSLCACertificateFile> I<Filename>
3039 =item B<SSLCertificateFile> I<Filename>
3041 =item B<SSLCertificateKeyFile> I<Filename>
3043 Filenames specifying SSL certificate and key material to be used with SSL
3048 =item B<Listen> I<Host> I<Port>
3050 The B<Listen> statement sets the network address to bind to. When multiple
3051 statements are specified, the daemon will bind to all of them. If none are
3052 specified, it defaults to B<0.0.0.0:50051>.
3054 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3056 Optionally, B<Listen> may be specified as a configuration block which
3057 supports the following options:
3061 =item B<EnableSSL> I<true>|I<false>
3063 Whether to enable SSL for incoming connections. Default: false.
3065 =item B<SSLCACertificateFile> I<Filename>
3067 =item B<SSLCertificateFile> I<Filename>
3069 =item B<SSLCertificateKeyFile> I<Filename>
3071 Filenames specifying SSL certificate and key material to be used with SSL
3078 =head2 Plugin C<hddtemp>
3080 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3081 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3082 default values, see below. C<hddtemp> has to be running to work correctly. If
3083 C<hddtemp> is not running timeouts may appear which may interfere with other
3086 The B<hddtemp> homepage can be found at
3087 L<http://www.guzu.net/linux/hddtemp.php>.
3091 =item B<Host> I<Hostname>
3093 Hostname to connect to. Defaults to B<127.0.0.1>.
3095 =item B<Port> I<Port>
3097 TCP-Port to connect to. Defaults to B<7634>.
3101 =head2 Plugin C<hugepages>
3103 To collect B<hugepages> information, collectd reads directories
3104 "/sys/devices/system/node/*/hugepages" and
3105 "/sys/kernel/mm/hugepages".
3106 Reading of these directories can be disabled by the following
3107 options (default is enabled).
3111 =item B<ReportPerNodeHP> B<true>|B<false>
3113 If enabled, information will be collected from the hugepage
3114 counters in "/sys/devices/system/node/*/hugepages".
3115 This is used to check the per-node hugepage statistics on
3118 =item B<ReportRootHP> B<true>|B<false>
3120 If enabled, information will be collected from the hugepage
3121 counters in "/sys/kernel/mm/hugepages".
3122 This can be used on both NUMA and non-NUMA systems to check
3123 the overall hugepage statistics.
3125 =item B<ValuesPages> B<true>|B<false>
3127 Whether to report hugepages metrics in number of pages.
3128 Defaults to B<true>.
3130 =item B<ValuesBytes> B<false>|B<true>
3132 Whether to report hugepages metrics in bytes.
3133 Defaults to B<false>.
3135 =item B<ValuesPercentage> B<false>|B<true>
3137 Whether to report hugepages metrics as percentage.
3138 Defaults to B<false>.
3142 =head2 Plugin C<intel_pmu>
3144 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3145 Linux perf interface. All events are reported on a per core basis.
3150 ReportHardwareCacheEvents true
3151 ReportKernelPMUEvents true
3152 ReportSoftwareEvents true
3153 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3154 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3161 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3163 Enable or disable measuring of hardware CPU cache events:
3165 - L1-dcache-load-misses
3167 - L1-dcache-store-misses
3168 - L1-dcache-prefetches
3169 - L1-dcache-prefetch-misses
3171 - L1-icache-load-misses
3172 - L1-icache-prefetches
3173 - L1-icache-prefetch-misses
3179 - LLC-prefetch-misses
3185 - dTLB-prefetch-misses
3189 - branch-load-misses
3191 =item B<ReportKernelPMUEvents> B<false>|B<true>
3193 Enable or disable measuring of the following events:
3202 =item B<ReportSoftwareEvents> B<false>|B<true>
3204 Enable or disable measuring of software events provided by kernel:
3215 =item B<EventList> I<filename>
3217 JSON performance counter event list file name. To be able to monitor all Intel
3218 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3219 event_download.py script to download event list for current CPU.
3221 =item B<HardwareEvents> I<events>
3223 This field is a list of event names or groups of comma separated event names.
3224 This option requires B<EventList> option to be configured.
3228 =head2 Plugin C<intel_rdt>
3230 The I<intel_rdt> plugin collects information provided by monitoring features of
3231 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3232 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3233 information about utilization of shared resources. CMT monitors last level cache
3234 occupancy (LLC). MBM supports two types of events reporting local and remote
3235 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3236 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3237 reports the bandwidth of accessing the remote socket. Also this technology
3238 allows to monitor instructions per clock (IPC).
3239 Monitor events are hardware dependant. Monitoring capabilities are detected on
3240 plugin initialization and only supported events are monitored.
3242 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3243 require an additional capability to be enabled if collectd is run as a service.
3244 Please refer to I<contrib/systemd.collectd.service> file for more details.
3248 <Plugin "intel_rdt">
3249 Cores "0-2" "3,4,6" "8-10,15"
3256 =item B<Interval> I<seconds>
3258 The interval within which to retrieve statistics on monitored events in seconds.
3259 For milliseconds divide the time by 1000 for example if the desired interval
3260 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3261 recommended to set interval higher than 1 sec.
3263 =item B<Cores> I<cores groups>
3265 All events are reported on a per core basis. Monitoring of the events can be
3266 configured for group of cores (aggregated statistics). This field defines groups
3267 of cores on which to monitor supported events. The field is represented as list
3268 of strings with core group values. Each string represents a list of cores in a
3269 group. Allowed formats are:
3274 If an empty string is provided as value for this field default cores
3275 configuration is applied - a separate group is created for each core.
3279 B<Note:> By default global interval is used to retrieve statistics on monitored
3280 events. To configure a plugin specific interval use B<Interval> option of the
3281 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3282 example if the desired interval is 50ms, set interval to 0.05.
3283 Due to limited capacity of counters it is not recommended to set interval higher
3286 =head2 Plugin C<interface>
3290 =item B<Interface> I<Interface>
3292 Select this interface. By default these interfaces will then be collected. For
3293 a more detailed description see B<IgnoreSelected> below.
3295 See F</"IGNORELISTS"> for details.
3297 =item B<IgnoreSelected> I<true>|I<false>
3299 If no configuration is given, the B<interface>-plugin will collect data from
3300 all interfaces. This may not be practical, especially for loopback- and
3301 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3302 interfaces you're interested in. Sometimes, however, it's easier/preferred
3303 to collect all interfaces I<except> a few ones. This option enables you to
3304 do that: By setting B<IgnoreSelected> to I<true> the effect of
3305 B<Interface> is inverted: All selected interfaces are ignored and all
3306 other interfaces are collected.
3308 It is possible to use regular expressions to match interface names, if the
3309 name is surrounded by I</.../> and collectd was compiled with support for
3310 regexps. This is useful if there's a need to collect (or ignore) data
3311 for a group of interfaces that are similarly named, without the need to
3312 explicitly list all of them (especially useful if the list is dynamic).
3317 Interface "/^tun[0-9]+/"
3318 IgnoreSelected "true"
3320 This will ignore the loopback interface, all interfaces with names starting
3321 with I<veth> and all interfaces with names starting with I<tun> followed by
3324 =item B<ReportInactive> I<true>|I<false>
3326 When set to I<false>, only interfaces with non-zero traffic will be
3327 reported. Note that the check is done by looking into whether a
3328 package was sent at any time from boot and the corresponding counter
3329 is non-zero. So, if the interface has been sending data in the past
3330 since boot, but not during the reported time-interval, it will still
3333 The default value is I<true> and results in collection of the data
3334 from all interfaces that are selected by B<Interface> and
3335 B<IgnoreSelected> options.
3337 =item B<UniqueName> I<true>|I<false>
3339 Interface name is not unique on Solaris (KSTAT), interface name is unique
3340 only within a module/instance. Following tuple is considered unique:
3341 (ks_module, ks_instance, ks_name)
3342 If this option is set to true, interface name contains above three fields
3343 separated by an underscore. For more info on KSTAT, visit
3344 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3346 This option is only available on Solaris.
3350 =head2 Plugin C<ipmi>
3354 =item B<Sensor> I<Sensor>
3356 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3358 See F</"IGNORELISTS"> for details.
3360 =item B<IgnoreSelected> I<true>|I<false>
3362 If no configuration if given, the B<ipmi> plugin will collect data from all
3363 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3364 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3365 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3366 all other sensors are collected.
3368 =item B<NotifySensorAdd> I<true>|I<false>
3370 If a sensor appears after initialization time of a minute a notification
3373 =item B<NotifySensorRemove> I<true>|I<false>
3375 If a sensor disappears a notification is sent.
3377 =item B<NotifySensorNotPresent> I<true>|I<false>
3379 If you have for example dual power supply and one of them is (un)plugged then
3380 a notification is sent.
3384 =head2 Plugin C<iptables>
3388 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3390 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3392 Select the iptables/ip6tables filter rules to count packets and bytes from.
3394 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3395 of all rules which have a comment-match. The comment is then used as
3398 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3399 the I<n>th rule will be collected. Again, the comment (or the number) will be
3400 used as the type-instance.
3402 If I<Name> is supplied, it will be used as the type-instance instead of the
3403 comment or the number.
3407 =head2 Plugin C<irq>
3413 Select this irq. By default these irqs will then be collected. For a more
3414 detailed description see B<IgnoreSelected> below.
3416 See F</"IGNORELISTS"> for details.
3418 =item B<IgnoreSelected> I<true>|I<false>
3420 If no configuration if given, the B<irq>-plugin will collect data from all
3421 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3422 can use the B<Irq>-option to pick the interrupt you're interested in.
3423 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3424 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3425 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3426 and all other interrupts are collected.
3430 =head2 Plugin C<java>
3432 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3433 This section only discusses the syntax and semantic of the configuration
3434 options. For more in-depth information on the I<Java> plugin, please read
3435 L<collectd-java(5)>.
3440 JVMArg "-verbose:jni"
3441 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3442 LoadPlugin "org.collectd.java.Foobar"
3443 <Plugin "org.collectd.java.Foobar">
3444 # To be parsed by the plugin
3448 Available configuration options:
3452 =item B<JVMArg> I<Argument>
3454 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3455 exactly the way the arguments to the I<java> binary on the command line work.
3456 Execute C<javaE<nbsp>--help> for details.
3458 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3459 any other options! When another option is found, the JVM will be started and
3460 later options will have to be ignored!
3462 =item B<LoadPlugin> I<JavaClass>
3464 Instantiates a new I<JavaClass> object. The constructor of this object very
3465 likely then registers one or more callback methods with the server.
3467 See L<collectd-java(5)> for details.
3469 When the first such option is found, the virtual machine (JVM) is created. This
3470 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3471 B<LoadPlugin> options!
3473 =item B<Plugin> I<Name>
3475 The entire block is passed to the Java plugin as an
3476 I<org.collectd.api.OConfigItem> object.
3478 For this to work, the plugin has to register a configuration callback first,
3479 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3480 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3481 depends on the (Java) plugin registering the callback and is completely
3482 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3486 =head2 Plugin C<load>
3488 The I<Load plugin> collects the system load. These numbers give a rough overview
3489 over the utilization of a machine. The system load is defined as the number of
3490 runnable tasks in the run-queue and is provided by many operating systems as a
3491 one, five or fifteen minute average.
3493 The following configuration options are available:
3497 =item B<ReportRelative> B<false>|B<true>
3499 When enabled, system load divided by number of available CPU cores is reported
3500 for intervals 1 min, 5 min and 15 min. Defaults to false.
3505 =head2 Plugin C<logfile>
3509 =item B<LogLevel> B<debug|info|notice|warning|err>
3511 Sets the log-level. If, for example, set to B<notice>, then all events with
3512 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3514 Please note that B<debug> is only available if collectd has been compiled with
3517 =item B<File> I<File>
3519 Sets the file to write log messages to. The special strings B<stdout> and
3520 B<stderr> can be used to write to the standard output and standard error
3521 channels, respectively. This, of course, only makes much sense when I<collectd>
3522 is running in foreground- or non-daemon-mode.
3524 =item B<Timestamp> B<true>|B<false>
3526 Prefix all lines printed by the current time. Defaults to B<true>.
3528 =item B<PrintSeverity> B<true>|B<false>
3530 When enabled, all lines are prefixed by the severity of the log message, for
3531 example "warning". Defaults to B<false>.
3535 B<Note>: There is no need to notify the daemon after moving or removing the
3536 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3537 for each line it writes.
3539 =head2 Plugin C<log_logstash>
3541 The I<log logstash plugin> behaves like the logfile plugin but formats
3542 messages as JSON events for logstash to parse and input.
3546 =item B<LogLevel> B<debug|info|notice|warning|err>
3548 Sets the log-level. If, for example, set to B<notice>, then all events with
3549 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3551 Please note that B<debug> is only available if collectd has been compiled with
3554 =item B<File> I<File>
3556 Sets the file to write log messages to. The special strings B<stdout> and
3557 B<stderr> can be used to write to the standard output and standard error
3558 channels, respectively. This, of course, only makes much sense when I<collectd>
3559 is running in foreground- or non-daemon-mode.
3563 B<Note>: There is no need to notify the daemon after moving or removing the
3564 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3565 for each line it writes.
3567 =head2 Plugin C<lpar>
3569 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3570 virtualization technique for IBM POWER processors. It takes into account CPU
3571 time stolen from or donated to a partition, in addition to the usual user,
3572 system, I/O statistics.
3574 The following configuration options are available:
3578 =item B<CpuPoolStats> B<false>|B<true>
3580 When enabled, statistics about the processor pool are read, too. The partition
3581 needs to have pool authority in order to be able to acquire this information.
3584 =item B<ReportBySerial> B<false>|B<true>
3586 If enabled, the serial of the physical machine the partition is currently
3587 running on is reported as I<hostname> and the logical hostname of the machine
3588 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3589 used (just like other plugins) and the I<plugin instance> will be empty.
3594 =head2 Plugin C<lua>
3596 This plugin embeds a Lua interpreter into collectd and provides an interface
3597 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3600 =head2 Plugin C<mbmon>
3602 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
3604 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
3605 B<Host> and B<Port> options can be used to change these values, see below.
3606 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
3607 timeouts may appear which may interfere with other statistics..
3609 C<mbmon> must be run with the -r option ("print TAG and Value format");
3610 Debian's F</etc/init.d/mbmon> script already does this, other people
3611 will need to ensure that this is the case.
3615 =item B<Host> I<Hostname>
3617 Hostname to connect to. Defaults to B<127.0.0.1>.
3619 =item B<Port> I<Port>
3621 TCP-Port to connect to. Defaults to B<411>.
3625 =head2 Plugin C<mcelog>
3627 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
3629 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
3630 mcelog server is running. When the server is running, the plugin will tail the
3631 specified logfile to retrieve machine check exception information and send a
3632 notification with the details from the logfile. The plugin will use the mcelog
3633 client protocol to retrieve memory related machine check exceptions. Note that
3634 for memory exceptions, notifications are only sent when there is a change in
3635 the number of corrected/uncorrected memory errors.
3637 =head3 The Memory block
3639 Note: these options cannot be used in conjunction with the logfile options, they are mutually
3644 =item B<McelogClientSocket> I<Path>
3645 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
3646 Defaults to B<"/var/run/mcelog-client">.
3648 =item B<PersistentNotification> B<true>|B<false>
3649 Override default configuration to only send notifications when sent when there
3650 is a change in the number of corrected/uncorrected memory errors. When set to
3651 true notifications will be sent for every read cycle. Default is false. Does
3652 not affect the stats being dispatched.
3658 =item B<McelogLogfile> I<Path>
3660 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
3661 cannot be used in conjunction with the memory block options, they are mutually
3668 The C<md plugin> collects information from Linux Software-RAID devices (md).
3670 All reported values are of the type C<md_disks>. Reported type instances are
3671 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
3672 I<missing> (physically absent) disks.
3676 =item B<Device> I<Device>
3678 Select md devices based on device name. The I<device name> is the basename of
3679 the device, i.e. the name of the block device without the leading C</dev/>.
3680 See B<IgnoreSelected> for more details.
3682 See F</"IGNORELISTS"> for details.
3684 =item B<IgnoreSelected> B<true>|B<false>
3686 Invert device selection: If set to B<true>, all md devices B<except> those
3687 listed using B<Device> are collected. If B<false> (the default), only those
3688 listed are collected. If no configuration is given, the B<md> plugin will
3689 collect data from all md devices.
3693 =head2 Plugin C<memcachec>
3695 The C<memcachec plugin> connects to a memcached server, queries one or more
3696 given I<pages> and parses the returned data according to user specification.
3697 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
3700 In order to talk to the memcached server, this plugin uses the I<libmemcached>
3701 library. Please note that there is another library with a very similar name,
3702 libmemcache (notice the missing `d'), which is not applicable.
3704 Synopsis of the configuration:
3706 <Plugin "memcachec">
3707 <Page "plugin_instance">
3710 Plugin "plugin_name"
3712 Regex "(\\d+) bytes sent"
3715 Instance "type_instance"
3720 The configuration options are:
3724 =item E<lt>B<Page> I<Name>E<gt>
3726 Each B<Page> block defines one I<page> to be queried from the memcached server.
3727 The block requires one string argument which is used as I<plugin instance>.
3729 =item B<Server> I<Address>
3731 Sets the server address to connect to when querying the page. Must be inside a
3736 When connected to the memcached server, asks for the page I<Key>.
3738 =item B<Plugin> I<Plugin>
3740 Use I<Plugin> as the plugin name when submitting values.
3741 Defaults to C<memcachec>.
3743 =item E<lt>B<Match>E<gt>
3745 Match blocks define which strings to look for and how matches substrings are
3746 interpreted. For a description of match blocks, please see L<"Plugin tail">.
3750 =head2 Plugin C<memcached>
3752 The B<memcached plugin> connects to a memcached server and queries statistics
3753 about cache utilization, memory and bandwidth used.
3754 L<http://memcached.org/>
3756 <Plugin "memcached">
3758 #Host "memcache.example.com"
3764 The plugin configuration consists of one or more B<Instance> blocks which
3765 specify one I<memcached> connection each. Within the B<Instance> blocks, the
3766 following options are allowed:
3770 =item B<Host> I<Hostname>
3772 Sets the B<host> field of dispatched values. Defaults to the global hostname
3774 For backwards compatibility, values are also dispatched with the global
3775 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
3778 =item B<Address> I<Address>
3780 Hostname or IP to connect to. For backwards compatibility, defaults to the
3781 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
3783 =item B<Port> I<Port>
3785 TCP port to connect to. Defaults to B<11211>.
3787 =item B<Socket> I<Path>
3789 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
3790 setting is given, the B<Address> and B<Port> settings are ignored.
3794 =head2 Plugin C<mic>
3796 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
3797 Intel's Many Integrated Core (MIC) systems.
3806 ShowTemperatures true
3809 IgnoreSelectedTemperature true
3814 IgnoreSelectedPower true
3817 The following options are valid inside the B<PluginE<nbsp>mic> block:
3821 =item B<ShowCPU> B<true>|B<false>
3823 If enabled (the default) a sum of the CPU usage across all cores is reported.
3825 =item B<ShowCPUCores> B<true>|B<false>
3827 If enabled (the default) per-core CPU usage is reported.
3829 =item B<ShowMemory> B<true>|B<false>
3831 If enabled (the default) the physical memory usage of the MIC system is
3834 =item B<ShowTemperatures> B<true>|B<false>
3836 If enabled (the default) various temperatures of the MIC system are reported.
3838 =item B<Temperature> I<Name>
3840 This option controls which temperatures are being reported. Whether matching
3841 temperatures are being ignored or I<only> matching temperatures are reported
3842 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
3843 temperatures are reported.
3845 =item B<IgnoreSelectedTemperature> B<false>|B<true>
3847 Controls the behavior of the B<Temperature> setting above. If set to B<false>
3848 (the default) only temperatures matching a B<Temperature> option are reported
3849 or, if no B<Temperature> option is specified, all temperatures are reported. If
3850 set to B<true>, matching temperatures are I<ignored> and all other temperatures
3853 Known temperature names are:
3887 =item B<ShowPower> B<true>|B<false>
3889 If enabled (the default) various temperatures of the MIC system are reported.
3891 =item B<Power> I<Name>
3893 This option controls which power readings are being reported. Whether matching
3894 power readings are being ignored or I<only> matching power readings are reported
3895 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
3896 power readings are reported.
3898 =item B<IgnoreSelectedPower> B<false>|B<true>
3900 Controls the behavior of the B<Power> setting above. If set to B<false>
3901 (the default) only power readings matching a B<Power> option are reported
3902 or, if no B<Power> option is specified, all power readings are reported. If
3903 set to B<true>, matching power readings are I<ignored> and all other power readings
3906 Known power names are:
3912 Total power utilization averaged over Time Window 0 (uWatts).
3916 Total power utilization averaged over Time Window 0 (uWatts).
3920 Instantaneous power (uWatts).
3924 Max instantaneous power (uWatts).
3928 PCI-E connector power (uWatts).
3932 2x3 connector power (uWatts).
3936 2x4 connector power (uWatts).
3944 Uncore rail (uVolts).
3948 Memory subsystem rail (uVolts).
3954 =head2 Plugin C<memory>
3956 The I<memory plugin> provides the following configuration options:
3960 =item B<ValuesAbsolute> B<true>|B<false>
3962 Enables or disables reporting of physical memory usage in absolute numbers,
3963 i.e. bytes. Defaults to B<true>.
3965 =item B<ValuesPercentage> B<false>|B<true>
3967 Enables or disables reporting of physical memory usage in percentages, e.g.
3968 percent of physical memory used. Defaults to B<false>.
3970 This is useful for deploying I<collectd> in a heterogeneous environment in
3971 which the sizes of physical memory vary.
3975 =head2 Plugin C<modbus>
3977 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
3978 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
3979 values), large integer values (unsigned 32E<nbsp>bit values) and floating point
3980 values (two registers interpreted as IEEE floats in big endian notation).
3984 <Data "voltage-input-1">
3987 RegisterCmd ReadHolding
3992 <Data "voltage-input-2">
3995 RegisterCmd ReadHolding
4000 <Data "supply-temperature-1">
4003 RegisterCmd ReadHolding
4008 <Host "modbus.example.com">
4009 Address "192.168.0.42"
4014 Instance "power-supply"
4015 Collect "voltage-input-1"
4016 Collect "voltage-input-2"
4021 Device "/dev/ttyUSB0"
4026 Instance "temperature"
4027 Collect "supply-temperature-1"
4033 =item E<lt>B<Data> I<Name>E<gt> blocks
4035 Data blocks define a mapping between register numbers and the "types" used by
4038 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4042 =item B<RegisterBase> I<Number>
4044 Configures the base register to read from the device. If the option
4045 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4046 register will be read (the register number is increased by one).
4048 =item B<RegisterType> B<Int16>|B<Int32>|B<Uint16>|B<Uint32>|B<Float>
4050 Specifies what kind of data is returned by the device. If the type is B<Int32>,
4051 B<Uint32> or B<Float>, two 16E<nbsp>bit registers will be read and the data is
4052 combined into one value. Defaults to B<Uint16>.
4054 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4056 Specifies register type to be collected from device. Works only with libmodbus
4057 2.9.2 or higher. Defaults to B<ReadHolding>.
4059 =item B<Type> I<Type>
4061 Specifies the "type" (data set) to use when dispatching the value to
4062 I<collectd>. Currently, only data sets with exactly one data source are
4065 =item B<Instance> I<Instance>
4067 Sets the type instance to use when dispatching the value to I<collectd>. If
4068 unset, an empty string (no type instance) is used.
4072 =item E<lt>B<Host> I<Name>E<gt> blocks
4074 Host blocks are used to specify to which hosts to connect and what data to read
4075 from their "slaves". The string argument I<Name> is used as hostname when
4076 dispatching the values to I<collectd>.
4078 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4082 =item B<Address> I<Hostname>
4084 For Modbus/TCP, specifies the node name (the actual network address) used to
4085 connect to the host. This may be an IP address or a hostname. Please note that
4086 the used I<libmodbus> library only supports IPv4 at the moment.
4088 =item B<Port> I<Service>
4090 for Modbus/TCP, specifies the port used to connect to the host. The port can
4091 either be given as a number or as a service name. Please note that the
4092 I<Service> argument must be a string, even if ports are given in their numerical
4093 form. Defaults to "502".
4095 =item B<Device> I<Devicenode>
4097 For Modbus/RTU, specifies the path to the serial device being used.
4099 =item B<Baudrate> I<Baudrate>
4101 For Modbus/RTU, specifies the baud rate of the serial device.
4102 Note, connections currently support only 8/N/1.
4104 =item B<Interval> I<Interval>
4106 Sets the interval (in seconds) in which the values will be collected from this
4107 host. By default the global B<Interval> setting will be used.
4109 =item E<lt>B<Slave> I<ID>E<gt>
4111 Over each connection, multiple Modbus devices may be reached. The slave ID
4112 is used to specify which device should be addressed. For each device you want
4113 to query, one B<Slave> block must be given.
4115 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4119 =item B<Instance> I<Instance>
4121 Specify the plugin instance to use when dispatching the values to I<collectd>.
4122 By default "slave_I<ID>" is used.
4124 =item B<Collect> I<DataName>
4126 Specifies which data to retrieve from the device. I<DataName> must be the same
4127 string as the I<Name> argument passed to a B<Data> block. You can specify this
4128 option multiple times to collect more than one value from a slave. At least one
4129 B<Collect> option is mandatory.
4137 =head2 Plugin C<mqtt>
4139 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4140 values from MQTT (B<Subscribe> blocks).
4146 Host "mqtt.example.com"
4150 Host "mqtt.example.com"
4155 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4156 configuring the sending and receiving direction respectively. The plugin will
4157 register a write callback named C<mqtt/I<name>> where I<name> is the string
4158 argument given to the B<Publish> block. Both types of blocks share many but not
4159 all of the following options. If an option is valid in only one of the blocks,
4160 it will be mentioned explicitly.
4166 =item B<Host> I<Hostname>
4168 Hostname of the MQTT broker to connect to.
4170 =item B<Port> I<Service>
4172 Port number or service name of the MQTT broker to connect to.
4174 =item B<User> I<UserName>
4176 Username used when authenticating to the MQTT broker.
4178 =item B<Password> I<Password>
4180 Password used when authenticating to the MQTT broker.
4182 =item B<ClientId> I<ClientId>
4184 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4186 =item B<QoS> [B<0>-B<2>]
4188 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4206 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4207 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4208 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4209 on a message is larger than the maximum accepted QoS of a subscriber, the
4210 message's QoS will be downgraded.
4212 =item B<Prefix> I<Prefix> (Publish only)
4214 This plugin will use one topic per I<value list> which will looks like a path.
4215 I<Prefix> is used as the first path element and defaults to B<collectd>.
4217 An example topic name would be:
4219 collectd/cpu-0/cpu-user
4221 =item B<Retain> B<false>|B<true> (Publish only)
4223 Controls whether the MQTT broker will retain (keep a copy of) the last message
4224 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4226 =item B<StoreRates> B<true>|B<false> (Publish only)
4228 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4229 before sending. Defaults to B<true>.
4231 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4233 Controls whether the MQTT "cleans" the session up after the subscriber
4234 disconnects or if it maintains the subscriber's subscriptions and all messages
4235 that arrive while the subscriber is disconnected. Defaults to B<true>.
4237 =item B<Topic> I<TopicName> (Subscribe only)
4239 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4240 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4241 the B<collectd> branch.
4243 =item B<CACert> I<file>
4245 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4246 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4247 port of the MQTT broker.
4248 This option enables the use of TLS.
4250 =item B<CertificateFile> I<file>
4252 Path to the PEM-encoded certificate file to use as client certificate when
4253 connecting to the MQTT broker.
4254 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4256 =item B<CertificateKeyFile> I<file>
4258 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4259 Only valid if B<CACert> and B<CertificateFile> are also set.
4261 =item B<TLSProtocol> I<protocol>
4263 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4264 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4265 version is used which depends on the version of OpenSSL the Mosquitto library
4267 Only valid if B<CACert> is set.
4269 =item B<CipherSuite> I<ciphersuite>
4271 A string describing the ciphers available for use. See L<ciphers(1)> and the
4272 C<openssl ciphers> utility for more information. If unset, the default ciphers
4274 Only valid if B<CACert> is set.
4278 =head2 Plugin C<mysql>
4280 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4281 one or more databases when started and keeps the connection up as long as
4282 possible. When the connection is interrupted for whatever reason it will try
4283 to re-connect. The plugin will complain loudly in case anything goes wrong.
4285 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4286 and collects information about MySQL network traffic, executed statements,
4287 requests, the query cache and threads by evaluating the
4288 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4289 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4290 Status Variables> for an explanation of these values.
4292 Optionally, master and slave statistics may be collected in a MySQL
4293 replication setup. In that case, information about the synchronization state
4294 of the nodes are collected by evaluating the C<Position> return value of the
4295 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4296 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4297 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4298 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4299 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4311 SSLKey "/path/to/key.pem"
4312 SSLCert "/path/to/cert.pem"
4313 SSLCA "/path/to/ca.pem"
4314 SSLCAPath "/path/to/cas/"
4315 SSLCipher "DHE-RSA-AES256-SHA"
4321 Socket "/var/run/mysql/mysqld.sock"
4323 SlaveNotifications true
4329 Socket "/var/run/mysql/mysqld.sock"
4334 A B<Database> block defines one connection to a MySQL database. It accepts a
4335 single argument which specifies the name of the database. None of the other
4336 options are required. MySQL will use default values as documented in the
4337 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4338 B<MySQL reference manual>.
4342 =item B<Alias> I<Alias>
4344 Alias to use as sender instead of hostname when reporting. This may be useful
4345 when having cryptic hostnames.
4347 =item B<Host> I<Hostname>
4349 Hostname of the database server. Defaults to B<localhost>.
4351 =item B<User> I<Username>
4353 Username to use when connecting to the database. The user does not have to be
4354 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4355 unless you want to collectd replication statistics (see B<MasterStats> and
4356 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4357 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4359 =item B<Password> I<Password>
4361 Password needed to log into the database.
4363 =item B<Database> I<Database>
4365 Select this database. Defaults to I<no database> which is a perfectly reasonable
4366 option for what this plugin does.
4368 =item B<Port> I<Port>
4370 TCP-port to connect to. The port must be specified in its numeric form, but it
4371 must be passed as a string nonetheless. For example:
4375 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4376 See the documentation for the C<mysql_real_connect> function for details.
4378 =item B<Socket> I<Socket>
4380 Specifies the path to the UNIX domain socket of the MySQL server. This option
4381 only has any effect, if B<Host> is set to B<localhost> (the default).
4382 Otherwise, use the B<Port> option above. See the documentation for the
4383 C<mysql_real_connect> function for details.
4385 =item B<InnodbStats> I<true|false>
4387 If enabled, metrics about the InnoDB storage engine are collected.
4388 Disabled by default.
4390 =item B<MasterStats> I<true|false>
4392 =item B<SlaveStats> I<true|false>
4394 Enable the collection of master / slave statistics in a replication setup. In
4395 order to be able to get access to these statistics, the user needs special
4396 privileges. See the B<User> documentation above. Defaults to B<false>.
4398 =item B<SlaveNotifications> I<true|false>
4400 If enabled, the plugin sends a notification if the replication slave I/O and /
4401 or SQL threads are not running. Defaults to B<false>.
4403 =item B<WsrepStats> I<true|false>
4405 Enable the collection of wsrep plugin statistics, used in Master-Master
4406 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4407 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4409 =item B<ConnectTimeout> I<Seconds>
4411 Sets the connect timeout for the MySQL client.
4413 =item B<SSLKey> I<Path>
4415 If provided, the X509 key in PEM format.
4417 =item B<SSLCert> I<Path>
4419 If provided, the X509 cert in PEM format.
4421 =item B<SSLCA> I<Path>
4423 If provided, the CA file in PEM format (check OpenSSL docs).
4425 =item B<SSLCAPath> I<Path>
4427 If provided, the CA directory (check OpenSSL docs).
4429 =item B<SSLCipher> I<String>
4431 If provided, the SSL cipher to use.
4435 =head2 Plugin C<netapp>
4437 The netapp plugin can collect various performance and capacity information
4438 from a NetApp filer using the NetApp API.
4440 Please note that NetApp has a wide line of products and a lot of different
4441 software versions for each of these products. This plugin was developed for a
4442 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4443 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4444 model and software version but it is very hard to test this.
4445 If you have used this plugin with other models and/or software version, feel
4446 free to send us a mail to tell us about the results, even if it's just a short
4449 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4450 basic authentication.
4452 B<Do not use a regular user for this!> Create a special collectd user with just
4453 the minimum of capabilities needed. The user only needs the "login-http-admin"
4454 capability as well as a few more depending on which data will be collected.
4455 Required capabilities are documented below.
4460 <Host "netapp1.example.com">
4484 IgnoreSelectedIO false
4486 IgnoreSelectedOps false
4487 GetLatency "volume0"
4488 IgnoreSelectedLatency false
4495 IgnoreSelectedCapacity false
4498 IgnoreSelectedSnapshot false
4526 The netapp plugin accepts the following configuration options:
4530 =item B<Host> I<Name>
4532 A host block defines one NetApp filer. It will appear in collectd with the name
4533 you specify here which does not have to be its real name nor its hostname (see
4534 the B<Address> option below).
4536 =item B<VFiler> I<Name>
4538 A B<VFiler> block may only be used inside a host block. It accepts all the
4539 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4540 will execute all NetApp API commands in the context of the specified
4541 VFiler(R). It will appear in collectd with the name you specify here which
4542 does not have to be its real name. The VFiler name may be specified using the
4543 B<VFilerName> option. If this is not specified, it will default to the name
4546 The VFiler block inherits all connection related settings from the surrounding
4547 B<Host> block (which appear before the B<VFiler> block) but they may be
4548 overwritten inside the B<VFiler> block.
4550 This feature is useful, for example, when using a VFiler as SnapVault target
4551 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4552 available in the host filer (vfiler0) but only in the respective VFiler
4555 =item B<Protocol> B<httpd>|B<http>
4557 The protocol collectd will use to query this host.
4565 Valid options: http, https
4567 =item B<Address> I<Address>
4569 The hostname or IP address of the host.
4575 Default: The "host" block's name.
4577 =item B<Port> I<Port>
4579 The TCP port to connect to on the host.
4585 Default: 80 for protocol "http", 443 for protocol "https"
4587 =item B<User> I<User>
4589 =item B<Password> I<Password>
4591 The username and password to use to login to the NetApp.
4597 =item B<VFilerName> I<Name>
4599 The name of the VFiler in which context to execute API commands. If not
4600 specified, the name provided to the B<VFiler> block will be used instead.
4606 Default: name of the B<VFiler> block
4608 B<Note:> This option may only be used inside B<VFiler> blocks.
4610 =item B<Interval> I<Interval>
4616 The following options decide what kind of data will be collected. You can
4617 either use them as a block and fine tune various parameters inside this block,
4618 use them as a single statement to just accept all default values, or omit it to
4619 not collect any data.
4621 The following options are valid inside all blocks:
4625 =item B<Interval> I<Seconds>
4627 Collect the respective statistics every I<Seconds> seconds. Defaults to the
4628 host specific setting.
4632 =head3 The System block
4634 This will collect various performance data about the whole system.
4636 B<Note:> To get this data the collectd user needs the
4637 "api-perf-object-get-instances" capability.
4641 =item B<Interval> I<Seconds>
4643 Collect disk statistics every I<Seconds> seconds.
4645 =item B<GetCPULoad> B<true>|B<false>
4647 If you set this option to true the current CPU usage will be read. This will be
4648 the average usage between all CPUs in your NetApp without any information about
4651 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4652 returns in the "CPU" field.
4660 Result: Two value lists of type "cpu", and type instances "idle" and "system".
4662 =item B<GetInterfaces> B<true>|B<false>
4664 If you set this option to true the current traffic of the network interfaces
4665 will be read. This will be the total traffic over all interfaces of your NetApp
4666 without any information about individual interfaces.
4668 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4669 in the "Net kB/s" field.
4679 Result: One value list of type "if_octects".
4681 =item B<GetDiskIO> B<true>|B<false>
4683 If you set this option to true the current IO throughput will be read. This
4684 will be the total IO of your NetApp without any information about individual
4685 disks, volumes or aggregates.
4687 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4688 in the "DiskE<nbsp>kB/s" field.
4696 Result: One value list of type "disk_octets".
4698 =item B<GetDiskOps> B<true>|B<false>
4700 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
4701 iSCSI, etc. operations will be read. This will be the total number of
4702 operations on your NetApp without any information about individual volumes or
4705 B<Note:> These are the same values that the NetApp CLI command "sysstat"
4706 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
4714 Result: A variable number of value lists of type "disk_ops_complex". Each type
4715 of operation will result in one value list with the name of the operation as
4720 =head3 The WAFL block
4722 This will collect various performance data about the WAFL file system. At the
4723 moment this just means cache performance.
4725 B<Note:> To get this data the collectd user needs the
4726 "api-perf-object-get-instances" capability.
4728 B<Note:> The interface to get these values is classified as "Diagnostics" by
4729 NetApp. This means that it is not guaranteed to be stable even between minor
4734 =item B<Interval> I<Seconds>
4736 Collect disk statistics every I<Seconds> seconds.
4738 =item B<GetNameCache> B<true>|B<false>
4746 Result: One value list of type "cache_ratio" and type instance
4749 =item B<GetDirCache> B<true>|B<false>
4757 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
4759 =item B<GetInodeCache> B<true>|B<false>
4767 Result: One value list of type "cache_ratio" and type instance
4770 =item B<GetBufferCache> B<true>|B<false>
4772 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
4773 in the "Cache hit" field.
4781 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
4785 =head3 The Disks block
4787 This will collect performance data about the individual disks in the NetApp.
4789 B<Note:> To get this data the collectd user needs the
4790 "api-perf-object-get-instances" capability.
4794 =item B<Interval> I<Seconds>
4796 Collect disk statistics every I<Seconds> seconds.
4798 =item B<GetBusy> B<true>|B<false>
4800 If you set this option to true the busy time of all disks will be calculated
4801 and the value of the busiest disk in the system will be written.
4803 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
4804 in the "Disk util" field. Probably.
4812 Result: One value list of type "percent" and type instance "disk_busy".
4816 =head3 The VolumePerf block
4818 This will collect various performance data about the individual volumes.
4820 You can select which data to collect about which volume using the following
4821 options. They follow the standard ignorelist semantic.
4823 B<Note:> To get this data the collectd user needs the
4824 I<api-perf-object-get-instances> capability.
4828 =item B<Interval> I<Seconds>
4830 Collect volume performance data every I<Seconds> seconds.
4832 =item B<GetIO> I<Volume>
4834 =item B<GetOps> I<Volume>
4836 =item B<GetLatency> I<Volume>
4838 Select the given volume for IO, operations or latency statistics collection.
4839 The argument is the name of the volume without the C</vol/> prefix.
4841 Since the standard ignorelist functionality is used here, you can use a string
4842 starting and ending with a slash to specify regular expression matching: To
4843 match the volumes "vol0", "vol2" and "vol7", you can use this regular
4846 GetIO "/^vol[027]$/"
4848 If no regular expression is specified, an exact match is required. Both,
4849 regular and exact matching are case sensitive.
4851 If no volume was specified at all for either of the three options, that data
4852 will be collected for all available volumes.
4854 See F</"IGNORELISTS"> for details.
4856 =item B<IgnoreSelectedIO> B<true>|B<false>
4858 =item B<IgnoreSelectedOps> B<true>|B<false>
4860 =item B<IgnoreSelectedLatency> B<true>|B<false>
4862 When set to B<true>, the volumes selected for IO, operations or latency
4863 statistics collection will be ignored and the data will be collected for all
4866 When set to B<false>, data will only be collected for the specified volumes and
4867 all other volumes will be ignored.
4869 If no volumes have been specified with the above B<Get*> options, all volumes
4870 will be collected regardless of the B<IgnoreSelected*> option.
4872 Defaults to B<false>
4876 =head3 The VolumeUsage block
4878 This will collect capacity data about the individual volumes.
4880 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
4885 =item B<Interval> I<Seconds>
4887 Collect volume usage statistics every I<Seconds> seconds.
4889 =item B<GetCapacity> I<VolumeName>
4891 The current capacity of the volume will be collected. This will result in two
4892 to four value lists, depending on the configuration of the volume. All data
4893 sources are of type "df_complex" with the name of the volume as
4896 There will be type_instances "used" and "free" for the number of used and
4897 available bytes on the volume. If the volume has some space reserved for
4898 snapshots, a type_instance "snap_reserved" will be available. If the volume
4899 has SIS enabled, a type_instance "sis_saved" will be available. This is the
4900 number of bytes saved by the SIS feature.
4902 B<Note:> The current NetApp API has a bug that results in this value being
4903 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
4904 number which works most of the time. If you see strange values here, bug
4905 NetApp support to fix this.
4907 Repeat this option to specify multiple volumes.
4909 =item B<IgnoreSelectedCapacity> B<true>|B<false>
4911 Specify whether to collect only the volumes selected by the B<GetCapacity>
4912 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
4913 B<false>. However, if no B<GetCapacity> option is specified at all, all
4914 capacities will be selected anyway.
4916 =item B<GetSnapshot> I<VolumeName>
4918 Select volumes from which to collect snapshot information.
4920 Usually, the space used for snapshots is included in the space reported as
4921 "used". If snapshot information is collected as well, the space used for
4922 snapshots is subtracted from the used space.
4924 To make things even more interesting, it is possible to reserve space to be
4925 used for snapshots. If the space required for snapshots is less than that
4926 reserved space, there is "reserved free" and "reserved used" space in addition
4927 to "free" and "used". If the space required for snapshots exceeds the reserved
4928 space, that part allocated in the normal space is subtracted from the "used"
4931 Repeat this option to specify multiple volumes.
4933 =item B<IgnoreSelectedSnapshot>
4935 Specify whether to collect only the volumes selected by the B<GetSnapshot>
4936 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
4937 B<false>. However, if no B<GetSnapshot> option is specified at all, all
4938 capacities will be selected anyway.
4942 =head3 The Quota block
4944 This will collect (tree) quota statistics (used disk space and number of used
4945 files). This mechanism is useful to get usage information for single qtrees.
4946 In case the quotas are not used for any other purpose, an entry similar to the
4947 following in C</etc/quotas> would be sufficient:
4949 /vol/volA/some_qtree tree - - - - -
4951 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
4955 =item B<Interval> I<Seconds>
4957 Collect SnapVault(R) statistics every I<Seconds> seconds.
4961 =head3 The SnapVault block
4963 This will collect statistics about the time and traffic of SnapVault(R)
4968 =item B<Interval> I<Seconds>
4970 Collect SnapVault(R) statistics every I<Seconds> seconds.
4974 =head2 Plugin C<netlink>
4976 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
4977 statistics of various interface and routing aspects.
4981 =item B<Interface> I<Interface>
4983 =item B<VerboseInterface> I<Interface>
4985 Instruct the plugin to collect interface statistics. This is basically the same
4986 as the statistics provided by the C<interface> plugin (see above) but
4987 potentially much more detailed.
4989 When configuring with B<Interface> only the basic statistics will be collected,
4990 namely octets, packets, and errors. These statistics are collected by
4991 the C<interface> plugin, too, so using both at the same time is no benefit.
4993 When configured with B<VerboseInterface> all counters B<except> the basic ones,
4994 so that no data needs to be collected twice if you use the C<interface> plugin.
4995 This includes dropped packets, received multicast packets, collisions and a
4996 whole zoo of differentiated RX and TX errors. You can try the following command
4997 to get an idea of what awaits you:
5001 If I<Interface> is B<All>, all interfaces will be selected.
5003 =item B<QDisc> I<Interface> [I<QDisc>]
5005 =item B<Class> I<Interface> [I<Class>]
5007 =item B<Filter> I<Interface> [I<Filter>]
5009 Collect the octets and packets that pass a certain qdisc, class or filter.
5011 QDiscs and classes are identified by their type and handle (or classid).
5012 Filters don't necessarily have a handle, therefore the parent's handle is used.
5013 The notation used in collectd differs from that used in tc(1) in that it
5014 doesn't skip the major or minor number if it's zero and doesn't print special
5015 ids by their name. So, for example, a qdisc may be identified by
5016 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5017 thus not displayed by tc(1).
5019 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5020 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5021 associated with that interface will be collected.
5023 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5024 used. This may lead to problems when more than one filter is attached to a
5025 qdisc or class. This isn't nice, but we don't know how this could be done any
5026 better. If you have a idea, please don't hesitate to tell us.
5028 As with the B<Interface> option you can specify B<All> as the interface,
5029 meaning all interfaces.
5031 Here are some examples to help you understand the above text more easily:
5034 VerboseInterface "All"
5035 QDisc "eth0" "pfifo_fast-1:0"
5037 Class "ppp0" "htb-1:10"
5038 Filter "ppp0" "u32-1:0"
5041 See F</"IGNORELISTS"> for details.
5043 =item B<IgnoreSelected>
5045 The behavior is the same as with all other similar plugins: If nothing is
5046 selected at all, everything is collected. If some things are selected using the
5047 options described above, only these statistics are collected. If you set
5048 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5049 specified statistics will not be collected.
5053 =head2 Plugin C<network>
5055 The Network plugin sends data to a remote instance of collectd, receives data
5056 from a remote instance, or both at the same time. Data which has been received
5057 from the network is usually not transmitted again, but this can be activated, see
5058 the B<Forward> option below.
5060 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5061 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5063 Both, B<Server> and B<Listen> can be used as single option or as block. When
5064 used as block, given options are valid for this socket only. The following
5065 example will export the metrics twice: Once to an "internal" server (without
5066 encryption and signing) and one to an external server (with cryptographic
5070 # Export to an internal server
5071 # (demonstrates usage without additional options)
5072 Server "collectd.internal.tld"
5074 # Export to an external server
5075 # (demonstrates usage with signature options)
5076 <Server "collectd.external.tld">
5077 SecurityLevel "sign"
5078 Username "myhostname"
5085 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5087 The B<Server> statement/block sets the server to send datagrams to. The
5088 statement may occur multiple times to send each datagram to multiple
5091 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5092 optional second argument specifies a port number or a service name. If not
5093 given, the default, B<25826>, is used.
5095 The following options are recognized within B<Server> blocks:
5099 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5101 Set the security you require for network communication. When the security level
5102 has been set to B<Encrypt>, data sent over the network will be encrypted using
5103 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5104 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5105 authentication code. When set to B<None>, data is sent without any security.
5107 This feature is only available if the I<network> plugin was linked with
5110 =item B<Username> I<Username>
5112 Sets the username to transmit. This is used by the server to lookup the
5113 password. See B<AuthFile> below. All security levels except B<None> require
5116 This feature is only available if the I<network> plugin was linked with
5119 =item B<Password> I<Password>
5121 Sets a password (shared secret) for this socket. All security levels except
5122 B<None> require this setting.
5124 This feature is only available if the I<network> plugin was linked with
5127 =item B<Interface> I<Interface name>
5129 Set the outgoing interface for IP packets. This applies at least
5130 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5131 undefined or a non-existent interface name is specified, the default
5132 behavior is to let the kernel choose the appropriate interface. Be warned
5133 that the manual selection of an interface for unicast traffic is only
5134 necessary in rare cases.
5136 =item B<ResolveInterval> I<Seconds>
5138 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5139 useful to force a regular DNS lookup to support a high availability setup. If
5140 not specified, re-resolves are never attempted.
5144 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5146 The B<Listen> statement sets the interfaces to bind to. When multiple
5147 statements are found the daemon will bind to multiple interfaces.
5149 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5150 the argument is a multicast address the daemon will join that multicast group.
5151 The optional second argument specifies a port number or a service name. If not
5152 given, the default, B<25826>, is used.
5154 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5158 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5160 Set the security you require for network communication. When the security level
5161 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5162 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5163 signed and encrypted data is accepted. When set to B<None>, all data will be
5164 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5165 decrypted if possible.
5167 This feature is only available if the I<network> plugin was linked with
5170 =item B<AuthFile> I<Filename>
5172 Sets a file in which usernames are mapped to passwords. These passwords are
5173 used to verify signatures and to decrypt encrypted network packets. If
5174 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5175 verified and encrypted packets are decrypted. Otherwise, signed data is
5176 accepted without checking the signature and encrypted data cannot be decrypted.
5177 For the other security levels this option is mandatory.
5179 The file format is very simple: Each line consists of a username followed by a
5180 colon and any number of spaces followed by the password. To demonstrate, an
5181 example file could look like this:
5186 Each time a packet is received, the modification time of the file is checked
5187 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5188 the file is being read, it is locked using L<fcntl(2)>.
5190 =item B<Interface> I<Interface name>
5192 Set the incoming interface for IP packets explicitly. This applies at least
5193 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5194 undefined or a non-existent interface name is specified, the default
5195 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5196 traffic gets only accepted, if it arrives on the given interface.
5200 =item B<TimeToLive> I<1-255>
5202 Set the time-to-live of sent packets. This applies to all, unicast and
5203 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5204 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5207 =item B<MaxPacketSize> I<1024-65535>
5209 Set the maximum size for datagrams received over the network. Packets larger
5210 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5211 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5214 On the server side, this limit should be set to the largest value used on
5215 I<any> client. Likewise, the value on the client must not be larger than the
5216 value on the server, or data will be lost.
5218 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5219 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5220 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5223 =item B<Forward> I<true|false>
5225 If set to I<true>, write packets that were received via the network plugin to
5226 the sending sockets. This should only be activated when the B<Listen>- and
5227 B<Server>-statements differ. Otherwise packets may be send multiple times to
5228 the same multicast group. While this results in more network traffic than
5229 necessary it's not a huge problem since the plugin has a duplicate detection,
5230 so the values will not loop.
5232 =item B<ReportStats> B<true>|B<false>
5234 The network plugin cannot only receive and send statistics, it can also create
5235 statistics about itself. Collectd data included the number of received and
5236 sent octets and packets, the length of the receive queue and the number of
5237 values handled. When set to B<true>, the I<Network plugin> will make these
5238 statistics available. Defaults to B<false>.
5242 =head2 Plugin C<nfs>
5244 The I<nfs plugin> collects information about the usage of the Network File
5245 System (NFS). It counts the number of procedure calls for each procedure,
5246 grouped by version and whether the system runs as server or client.
5248 It is possibly to omit metrics for a specific NFS version by setting one or
5249 more of the following options to B<false> (all of them default to B<true>).
5253 =item B<ReportV2> B<true>|B<false>
5255 =item B<ReportV3> B<true>|B<false>
5257 =item B<ReportV4> B<true>|B<false>
5261 =head2 Plugin C<nginx>
5263 This plugin collects the number of connections and requests handled by the
5264 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5265 queries the page provided by the C<ngx_http_stub_status_module> module, which
5266 isn't compiled by default. Please refer to
5267 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5268 how to compile and configure nginx and this module.
5270 The following options are accepted by the C<nginx plugin>:
5274 =item B<URL> I<http://host/nginx_status>
5276 Sets the URL of the C<ngx_http_stub_status_module> output.
5278 =item B<User> I<Username>
5280 Optional user name needed for authentication.
5282 =item B<Password> I<Password>
5284 Optional password needed for authentication.
5286 =item B<VerifyPeer> B<true|false>
5288 Enable or disable peer SSL certificate verification. See
5289 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5291 =item B<VerifyHost> B<true|false>
5293 Enable or disable peer host name verification. If enabled, the plugin checks
5294 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5295 certificate matches the host name provided by the B<URL> option. If this
5296 identity check fails, the connection is aborted. Obviously, only works when
5297 connecting to a SSL enabled server. Enabled by default.
5299 =item B<CACert> I<File>
5301 File that holds one or more SSL certificates. If you want to use HTTPS you will
5302 possibly need this option. What CA certificates come bundled with C<libcurl>
5303 and are checked by default depends on the distribution you use.
5305 =item B<Timeout> I<Milliseconds>
5307 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5308 milliseconds. By default, the configured B<Interval> is used to set the
5313 =head2 Plugin C<notify_desktop>
5315 This plugin sends a desktop notification to a notification daemon, as defined
5316 in the Desktop Notification Specification. To actually display the
5317 notifications, B<notification-daemon> is required and B<collectd> has to be
5318 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5319 environment variables have to be set correctly) and the D-Bus message bus.
5321 The Desktop Notification Specification can be found at
5322 L<http://www.galago-project.org/specs/notification/>.
5326 =item B<OkayTimeout> I<timeout>
5328 =item B<WarningTimeout> I<timeout>
5330 =item B<FailureTimeout> I<timeout>
5332 Set the I<timeout>, in milliseconds, after which to expire the notification
5333 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5334 been specified, the displayed notification will not be closed at all - the
5335 user has to do so herself. These options default to 5000. If a negative number
5336 has been specified, the default is used as well.
5340 =head2 Plugin C<notify_email>
5342 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5343 configured email address.
5345 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5347 Available configuration options:
5351 =item B<From> I<Address>
5353 Email address from which the emails should appear to come from.
5355 Default: C<root@localhost>
5357 =item B<Recipient> I<Address>
5359 Configures the email address(es) to which the notifications should be mailed.
5360 May be repeated to send notifications to multiple addresses.
5362 At least one B<Recipient> must be present for the plugin to work correctly.
5364 =item B<SMTPServer> I<Hostname>
5366 Hostname of the SMTP server to connect to.
5368 Default: C<localhost>
5370 =item B<SMTPPort> I<Port>
5372 TCP port to connect to.
5376 =item B<SMTPUser> I<Username>
5378 Username for ASMTP authentication. Optional.
5380 =item B<SMTPPassword> I<Password>
5382 Password for ASMTP authentication. Optional.
5384 =item B<Subject> I<Subject>
5386 Subject-template to use when sending emails. There must be exactly two
5387 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5388 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5391 Default: C<Collectd notify: %s@%s>
5395 =head2 Plugin C<notify_nagios>
5397 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5398 a I<passive service check result>.
5400 Available configuration options:
5404 =item B<CommandFile> I<Path>
5406 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5410 =head2 Plugin C<ntpd>
5412 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5415 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5416 the wire - using B<mode 7> specific requests. This mode is deprecated with
5417 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5418 correctly with them, the ntp daemon must be explicitly configured to
5419 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5420 manual page for details.
5422 Available configuration options for the C<ntpd> plugin:
5426 =item B<Host> I<Hostname>
5428 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5430 =item B<Port> I<Port>
5432 UDP-Port to connect to. Defaults to B<123>.
5434 =item B<ReverseLookups> B<true>|B<false>
5436 Sets whether or not to perform reverse lookups on peers. Since the name or
5437 IP-address may be used in a filename it is recommended to disable reverse
5438 lookups. The default is to do reverse lookups to preserve backwards
5439 compatibility, though.
5441 =item B<IncludeUnitID> B<true>|B<false>
5443 When a peer is a refclock, include the unit ID in the I<type instance>.
5444 Defaults to B<false> for backward compatibility.
5446 If two refclock peers use the same driver and this is B<false>, the plugin will
5447 try to write simultaneous measurements from both to the same type instance.
5448 This will result in error messages in the log and only one set of measurements
5453 =head2 Plugin C<nut>
5457 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5459 Add a UPS to collect data from. The format is identical to the one accepted by
5462 =item B<ForceSSL> B<true>|B<false>
5464 Stops connections from falling back to unsecured if an SSL connection
5465 cannot be established. Defaults to false if undeclared.
5467 =item B<VerifyPeer> I<true>|I<false>
5469 If set to true, requires a CAPath be provided. Will use the CAPath to find
5470 certificates to use as Trusted Certificates to validate a upsd server certificate.
5471 If validation of the upsd server certificate fails, the connection will not be
5472 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5473 will override and set ForceSSL to true.
5475 =item B<CAPath> I/path/to/certs/folder
5477 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5478 The folder pointed at must contain certificate(s) named according to their hash.
5479 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5480 occur because two different certs have the same hash value, Y can be incremented
5481 in order to avoid conflict. To create a symbolic link to a certificate the following
5482 command can be used from within the directory where the cert resides:
5484 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5486 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5487 generate links like the one described above for ALL certs in a given folder.
5489 C<c_rehash /path/to/certs/folder>
5491 =item B<ConnectTimeout> I<Milliseconds>
5493 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5494 By default, the configured B<Interval> is used to set the timeout.
5498 =head2 Plugin C<olsrd>
5500 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5501 the Optimized Link State Routing daemon and reads information about the current
5502 state of the meshed network.
5504 The following configuration options are understood:
5508 =item B<Host> I<Host>
5510 Connect to I<Host>. Defaults to B<"localhost">.
5512 =item B<Port> I<Port>
5514 Specifies the port to connect to. This must be a string, even if you give the
5515 port as a number rather than a service name. Defaults to B<"2006">.
5517 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5519 Specifies what information to collect about links, i.E<nbsp>e. direct
5520 connections of the daemon queried. If set to B<No>, no information is
5521 collected. If set to B<Summary>, the number of links and the average of all
5522 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5523 If set to B<Detail> LQ and NLQ are collected per link.
5525 Defaults to B<Detail>.
5527 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5529 Specifies what information to collect about routes of the daemon queried. If
5530 set to B<No>, no information is collected. If set to B<Summary>, the number of
5531 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5532 metric and ETX are collected per route.
5534 Defaults to B<Summary>.
5536 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5538 Specifies what information to collect about the global topology. If set to
5539 B<No>, no information is collected. If set to B<Summary>, the number of links
5540 in the entire topology and the average I<link quality> (LQ) is calculated.
5541 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5543 Defaults to B<Summary>.
5547 =head2 Plugin C<onewire>
5549 B<EXPERIMENTAL!> See notes below.
5551 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5552 L<http://owfs.org/> to read sensors connected via the onewire bus.
5554 It can be used in two possible modes - standard or advanced.
5556 In the standard mode only temperature sensors (sensors with the family code
5557 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5558 other sensors you would like to have included, please send a sort request to
5559 the mailing list. You can select sensors to be read or to be ignored depending
5560 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5561 walked and all sensors are read.
5563 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5564 experimental, below.
5566 In the advanced mode you can configure any sensor to be read (only numerical
5567 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5568 In this mode you have to list all the sensors. Neither default bus walk nor
5569 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5570 the path automatically and should produce compatible structure with the "standard"
5571 mode (basically the path is expected as for example
5572 "/uncached/10.F10FCA000800/temperature" where it would extract address part
5573 "F10FCA000800" and the rest after the slash is considered the type - here
5575 There are two advantages to this mode - you can access virtually any sensor
5576 (not just temperature), select whether to use cached or directly read values
5577 and it is slighlty faster. The downside is more complex configuration.
5579 The two modes are distinguished automatically by the format of the address.
5580 It is not possible to mix the two modes. Once a full path is detected in any
5581 B<Sensor> then the whole addressing (all sensors) is considered to be this way
5582 (and as standard addresses will fail parsing they will be ignored).
5586 =item B<Device> I<Device>
5588 Sets the device to read the values from. This can either be a "real" hardware
5589 device, such as a serial port or an USB port, or the address of the
5590 L<owserver(1)> socket, usually B<localhost:4304>.
5592 Though the documentation claims to automatically recognize the given address
5593 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
5594 with that version, the following configuration worked for us:
5597 Device "-s localhost:4304"
5600 This directive is B<required> and does not have a default value.
5602 =item B<Sensor> I<Sensor>
5604 In the standard mode selects sensors to collect or to ignore
5605 (depending on B<IgnoreSelected>, see below). Sensors are specified without
5606 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
5607 and B<not> include the leading C<10.> family byte and point.
5608 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
5609 sensors (see above) are read.
5611 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
5612 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
5613 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
5615 As there can be multiple devices on the bus you can list multiple sensor (use
5616 multiple B<Sensor> elements).
5618 See F</"IGNORELISTS"> for details.
5620 =item B<IgnoreSelected> I<true>|I<false>
5622 If no configuration is given, the B<onewire> plugin will collect data from all
5623 sensors found. This may not be practical, especially if sensors are added and
5624 removed regularly. Sometimes, however, it's easier/preferred to collect only
5625 specific sensors or all sensors I<except> a few specified ones. This option
5626 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
5627 B<Sensor> is inverted: All selected interfaces are ignored and all other
5628 interfaces are collected.
5630 Used only in the standard mode - see above.
5632 =item B<Interval> I<Seconds>
5634 Sets the interval in which all sensors should be read. If not specified, the
5635 global B<Interval> setting is used.
5639 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
5640 work with big setups. It works with one sensor being attached to one
5641 controller, but as soon as you throw in a couple more senors and maybe a hub
5642 or two, reading all values will take more than ten seconds (the default
5643 interval). We will probably add some separate thread for reading the sensors
5644 and some cache or something like that, but it's not done yet. We will try to
5645 maintain backwards compatibility in the future, but we can't promise. So in
5646 short: If it works for you: Great! But keep in mind that the config I<might>
5647 change, though this is unlikely. Oh, and if you want to help improving this
5648 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
5650 =head2 Plugin C<openldap>
5652 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
5653 server correctly. The backend database C<monitor> needs to be loaded and
5654 working. See slapd-monitor(5) for the details.
5656 The configuration of the C<openldap> plugin consists of one or more B<Instance>
5657 blocks. Each block requires one string argument as the instance name. For
5662 URL "ldap://localhost/"
5665 URL "ldaps://localhost/"
5669 The instance name will be used as the I<plugin instance>. To emulate the old
5670 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
5671 plugin to work correctly, each instance name must be unique. This is not
5672 enforced by the plugin and it is your responsibility to ensure it is.
5674 The following options are accepted within each B<Instance> block:
5678 =item B<URL> I<ldap://host/binddn>
5680 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
5683 =item B<BindDN> I<BindDN>
5685 Name in the form of an LDAP distinguished name intended to be used for
5686 authentication. Defaults to empty string to establish an anonymous authorization.
5688 =item B<Password> I<Password>
5690 Password for simple bind authentication. If this option is not set,
5691 unauthenticated bind operation is used.
5693 =item B<StartTLS> B<true|false>
5695 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
5696 Disabled by default.
5698 =item B<VerifyHost> B<true|false>
5700 Enables or disables peer host name verification. If enabled, the plugin checks
5701 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5702 certificate matches the host name provided by the B<URL> option. If this
5703 identity check fails, the connection is aborted. Enabled by default.
5705 =item B<CACert> I<File>
5707 File that holds one or more SSL certificates. If you want to use TLS/SSL you
5708 may possibly need this option. What CA certificates are checked by default
5709 depends on the distribution you use and can be changed with the usual ldap
5710 client configuration mechanisms. See ldap.conf(5) for the details.
5712 =item B<Timeout> I<Seconds>
5714 Sets the timeout value for ldap operations, in seconds. By default, the
5715 configured B<Interval> is used to set the timeout. Use B<-1> to disable
5718 =item B<Version> I<Version>
5720 An integer which sets the LDAP protocol version number to use when connecting
5721 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
5725 =head2 Plugin C<openvpn>
5727 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
5728 traffic statistics about connected clients.
5730 To set up OpenVPN to write to the status file periodically, use the
5731 B<--status> option of OpenVPN.
5733 So, in a nutshell you need:
5735 openvpn $OTHER_OPTIONS \
5736 --status "/var/run/openvpn-status" 10
5742 =item B<StatusFile> I<File>
5744 Specifies the location of the status file.
5746 =item B<ImprovedNamingSchema> B<true>|B<false>
5748 When enabled, the filename of the status file will be used as plugin instance
5749 and the client's "common name" will be used as type instance. This is required
5750 when reading multiple status files. Enabling this option is recommended, but to
5751 maintain backwards compatibility this option is disabled by default.
5753 =item B<CollectCompression> B<true>|B<false>
5755 Sets whether or not statistics about the compression used by OpenVPN should be
5756 collected. This information is only available in I<single> mode. Enabled by
5759 =item B<CollectIndividualUsers> B<true>|B<false>
5761 Sets whether or not traffic information is collected for each connected client
5762 individually. If set to false, currently no traffic data is collected at all
5763 because aggregating this data in a save manner is tricky. Defaults to B<true>.
5765 =item B<CollectUserCount> B<true>|B<false>
5767 When enabled, the number of currently connected clients or users is collected.
5768 This is especially interesting when B<CollectIndividualUsers> is disabled, but
5769 can be configured independently from that option. Defaults to B<false>.
5773 =head2 Plugin C<oracle>
5775 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
5776 Oracle® Database and lets you execute SQL statements there. It is very similar
5777 to the "dbi" plugin, because it was written around the same time. See the "dbi"
5778 plugin's documentation above for details.
5781 <Query "out_of_stock">
5782 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
5785 # InstancePrefix "foo"
5786 InstancesFrom "category"
5790 <Database "product_information">
5795 Query "out_of_stock"
5799 =head3 B<Query> blocks
5801 The Query blocks are handled identically to the Query blocks of the "dbi"
5802 plugin. Please see its documentation above for details on how to specify
5805 =head3 B<Database> blocks
5807 Database blocks define a connection to a database and which queries should be
5808 sent to that database. Each database needs a "name" as string argument in the
5809 starting tag of the block. This name will be used as "PluginInstance" in the
5810 values submitted to the daemon. Other than that, that name is not used.
5814 =item B<Plugin> I<Plugin>
5816 Use I<Plugin> as the plugin name when submitting query results from
5817 this B<Database>. Defaults to C<oracle>.
5819 =item B<ConnectID> I<ID>
5821 Defines the "database alias" or "service name" to connect to. Usually, these
5822 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
5824 =item B<Host> I<Host>
5826 Hostname to use when dispatching values for this database. Defaults to using
5827 the global hostname of the I<collectd> instance.
5829 =item B<Username> I<Username>
5831 Username used for authentication.
5833 =item B<Password> I<Password>
5835 Password used for authentication.
5837 =item B<Query> I<QueryName>
5839 Associates the query named I<QueryName> with this database connection. The
5840 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
5841 blocks you want to refer to must be placed above the database block you want to
5846 =head2 Plugin C<ovs_events>
5848 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
5849 connected interfaces, dispatches the values to collectd and sends the
5850 notification whenever the link state change occurs. This plugin uses OVS
5851 database to get a link state change notification.
5855 <Plugin "ovs_events">
5858 Socket "/var/run/openvswitch/db.sock"
5859 Interfaces "br0" "veth0"
5860 SendNotification true
5861 DispatchValues false
5864 The plugin provides the following configuration options:
5868 =item B<Address> I<node>
5870 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5871 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5872 option. See L<ovsdb-server(1)> for more details. The option may be either
5873 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5874 format. Defaults to C<localhost>.
5876 =item B<Port> I<service>
5878 TCP-port to connect to. Either a service name or a port number may be given.
5879 Defaults to B<6640>.
5881 =item B<Socket> I<path>
5883 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5884 plugin. To enable the interface, the OVS DB daemon should be running with
5885 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5886 option is set, B<Address> and B<Port> options are ignored.
5888 =item B<Interfaces> [I<ifname> ...]
5890 List of interface names to be monitored by this plugin. If this option is not
5891 specified or is empty then all OVS connected interfaces on all bridges are
5894 Default: empty (all interfaces on all bridges are monitored)
5896 =item B<SendNotification> I<true|false>
5898 If set to true, OVS link notifications (interface status and OVS DB connection
5899 terminate) are sent to collectd. Default value is true.
5901 =item B<DispatchValues> I<true|false>
5903 Dispatch the OVS DB interface link status value with configured plugin interval.
5904 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
5905 options are false, no OVS information will be provided by the plugin.
5909 B<Note:> By default, the global interval setting is used within which to
5910 retrieve the OVS link status. To configure a plugin-specific interval, please
5911 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
5912 simple divide the time by 1000 for example if the desired interval is 50ms, set
5915 =head2 Plugin C<ovs_stats>
5917 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
5918 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
5919 statistics from OVSDB
5923 <Plugin "ovs_stats">
5926 Socket "/var/run/openvswitch/db.sock"
5927 Bridges "br0" "br_ext"
5930 The plugin provides the following configuration options:
5934 =item B<Address> I<node>
5936 The address of the OVS DB server JSON-RPC interface used by the plugin. To
5937 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
5938 option. See L<ovsdb-server(1)> for more details. The option may be either
5939 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
5940 format. Defaults to C<localhost>.
5942 =item B<Port> I<service>
5944 TCP-port to connect to. Either a service name or a port number may be given.
5945 Defaults to B<6640>.
5947 =item B<Socket> I<path>
5949 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
5950 plugin. To enable the interface, the OVS DB daemon should be running with
5951 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
5952 option is set, B<Address> and B<Port> options are ignored.
5954 =item B<Bridges> [I<brname> ...]
5956 List of OVS bridge names to be monitored by this plugin. If this option is
5957 omitted or is empty then all OVS bridges will be monitored.
5959 Default: empty (monitor all bridges)
5963 =head2 Plugin C<perl>
5965 This plugin embeds a Perl-interpreter into collectd and provides an interface
5966 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
5968 =head2 Plugin C<pinba>
5970 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
5971 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
5972 PHP-based webpage has been delivered, the extension will send a UDP packet
5973 containing timing information, peak memory usage and so on. The plugin will
5974 wait for such packets, parse them and account the provided information, which
5975 is then dispatched to the daemon once per interval.
5982 # Overall statistics for the website.
5984 Server "www.example.com"
5986 # Statistics for www-a only
5988 Host "www-a.example.com"
5989 Server "www.example.com"
5991 # Statistics for www-b only
5993 Host "www-b.example.com"
5994 Server "www.example.com"
5998 The plugin provides the following configuration options:
6002 =item B<Address> I<Node>
6004 Configures the address used to open a listening socket. By default, plugin will
6005 bind to the I<any> address C<::0>.
6007 =item B<Port> I<Service>
6009 Configures the port (service) to bind to. By default the default Pinba port
6010 "30002" will be used. The option accepts service names in addition to port
6011 numbers and thus requires a I<string> argument.
6013 =item E<lt>B<View> I<Name>E<gt> block
6015 The packets sent by the Pinba extension include the hostname of the server, the
6016 server name (the name of the virtual host) and the script that was executed.
6017 Using B<View> blocks it is possible to separate the data into multiple groups
6018 to get more meaningful statistics. Each packet is added to all matching groups,
6019 so that a packet may be accounted for more than once.
6023 =item B<Host> I<Host>
6025 Matches the hostname of the system the webserver / script is running on. This
6026 will contain the result of the L<gethostname(2)> system call. If not
6027 configured, all hostnames will be accepted.
6029 =item B<Server> I<Server>
6031 Matches the name of the I<virtual host>, i.e. the contents of the
6032 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6033 server names will be accepted.
6035 =item B<Script> I<Script>
6037 Matches the name of the I<script name>, i.e. the contents of the
6038 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6039 script names will be accepted.
6045 =head2 Plugin C<ping>
6047 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6048 configured hosts periodically and measures the network latency. Whenever the
6049 C<read> function of the plugin is called, it submits the average latency, the
6050 standard deviation and the drop rate for each host.
6052 Available configuration options:
6056 =item B<Host> I<IP-address>
6058 Host to ping periodically. This option may be repeated several times to ping
6061 =item B<Interval> I<Seconds>
6063 Sets the interval in which to send ICMP echo packets to the configured hosts.
6064 This is B<not> the interval in which metrics are read from the plugin but the
6065 interval in which the hosts are "pinged". Therefore, the setting here should be
6066 smaller than or equal to the global B<Interval> setting. Fractional times, such
6067 as "1.24" are allowed.
6071 =item B<Timeout> I<Seconds>
6073 Time to wait for a response from the host to which an ICMP packet had been
6074 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6075 to be down or the packet to be dropped. This setting must be smaller than the
6076 B<Interval> setting above for the plugin to work correctly. Fractional
6077 arguments are accepted.
6081 =item B<TTL> I<0-255>
6083 Sets the Time-To-Live of generated ICMP packets.
6085 =item B<Size> I<size>
6087 Sets the size of the data payload in ICMP packet to specified I<size> (it
6088 will be filled with regular ASCII pattern). If not set, default 56 byte
6089 long string is used so that the packet size of an ICMPv4 packet is exactly
6090 64 bytes, similar to the behaviour of normal ping(1) command.
6092 =item B<SourceAddress> I<host>
6094 Sets the source address to use. I<host> may either be a numerical network
6095 address or a network hostname.
6097 =item B<Device> I<name>
6099 Sets the outgoing network device to be used. I<name> has to specify an
6100 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6103 =item B<MaxMissed> I<Packets>
6105 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6106 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6108 Default: B<-1> (disabled)
6112 =head2 Plugin C<postgresql>
6114 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6115 keeps a persistent connection to all configured databases and tries to
6116 reconnect if the connection has been interrupted. A database is configured by
6117 specifying a B<Database> block as described below. The default statistics are
6118 collected from PostgreSQL's B<statistics collector> which thus has to be
6119 enabled for this plugin to work correctly. This should usually be the case by
6120 default. See the section "The Statistics Collector" of the B<PostgreSQL
6121 Documentation> for details.
6123 By specifying custom database queries using a B<Query> block as described
6124 below, you may collect any data that is available from some PostgreSQL
6125 database. This way, you are able to access statistics of external daemons
6126 which are available in a PostgreSQL database or use future or special
6127 statistics provided by PostgreSQL without the need to upgrade your collectd
6130 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6131 PostgreSQL databases as well. This has been implemented in a generic way. You
6132 need to specify an SQL statement which will then be executed by collectd in
6133 order to write the data (see below for details). The benefit of that approach
6134 is that there is no fixed database layout. Rather, the layout may be optimized
6135 for the current setup.
6137 The B<PostgreSQL Documentation> manual can be found at
6138 L<http://www.postgresql.org/docs/manuals/>.
6142 Statement "SELECT magic FROM wizard WHERE host = $1;"
6146 InstancePrefix "magic"
6151 <Query rt36_tickets>
6152 Statement "SELECT COUNT(type) AS count, type \
6154 WHEN resolved = 'epoch' THEN 'open' \
6155 ELSE 'resolved' END AS type \
6156 FROM tickets) type \
6160 InstancePrefix "rt36_tickets"
6161 InstancesFrom "type"
6167 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6178 KRBSrvName "kerberos_service_name"
6184 Service "service_name"
6185 Query backend # predefined
6196 The B<Query> block defines one database query which may later be used by a
6197 database definition. It accepts a single mandatory argument which specifies
6198 the name of the query. The names of all queries have to be unique (see the
6199 B<MinVersion> and B<MaxVersion> options below for an exception to this
6202 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6203 B<Result> blocks may be used to extract multiple values from a single query.
6205 The following configuration options are available to define the query:
6209 =item B<Statement> I<sql query statement>
6211 Specify the I<sql query statement> which the plugin should execute. The string
6212 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6213 first, second, etc. parameter. The value of the parameters is specified by the
6214 B<Param> configuration option - see below for details. To include a literal
6215 B<$> character followed by a number, surround it with single quotes (B<'>).
6217 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6218 allowed. Note, however, that only a single command may be used. Semicolons are
6219 allowed as long as a single non-empty command has been specified only.
6221 The returned lines will be handled separately one after another.
6223 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6225 Specify the parameters which should be passed to the SQL query. The parameters
6226 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6227 they appear in the configuration file. The value of the parameter is
6228 determined depending on the value of the B<Param> option as follows:
6234 The configured hostname of the database connection. If a UNIX domain socket is
6235 used, the parameter expands to "localhost".
6239 The name of the database of the current connection.
6243 The name of the database plugin instance. See the B<Instance> option of the
6244 database specification below for details.
6248 The username used to connect to the database.
6252 The interval with which this database is queried (as specified by the database
6253 specific or global B<Interval> options).
6257 Please note that parameters are only supported by PostgreSQL's protocol
6258 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6260 =item B<PluginInstanceFrom> I<column>
6262 Specify how to create the "PluginInstance" for reporting this query results.
6263 Only one column is supported. You may concatenate fields and string values in
6264 the query statement to get the required results.
6266 =item B<MinVersion> I<version>
6268 =item B<MaxVersion> I<version>
6270 Specify the minimum or maximum version of PostgreSQL that this query should be
6271 used with. Some statistics might only be available with certain versions of
6272 PostgreSQL. This allows you to specify multiple queries with the same name but
6273 which apply to different versions, thus allowing you to use the same
6274 configuration in a heterogeneous environment.
6276 The I<version> has to be specified as the concatenation of the major, minor
6277 and patch-level versions, each represented as two-decimal-digit numbers. For
6278 example, version 8.2.3 will become 80203.
6282 The B<Result> block defines how to handle the values returned from the query.
6283 It defines which column holds which value and how to dispatch that value to
6288 =item B<Type> I<type>
6290 The I<type> name to be used when dispatching the values. The type describes
6291 how to handle the data and where to store it. See L<types.db(5)> for more
6292 details on types and their configuration. The number and type of values (as
6293 selected by the B<ValuesFrom> option) has to match the type of the given name.
6295 This option is mandatory.
6297 =item B<InstancePrefix> I<prefix>
6299 =item B<InstancesFrom> I<column0> [I<column1> ...]
6301 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6302 B<InstancePrefix> defines a static prefix that will be prepended to all type
6303 instances. B<InstancesFrom> defines the column names whose values will be used
6304 to create the type instance. Multiple values will be joined together using the
6305 hyphen (C<->) as separation character.
6307 The plugin itself does not check whether or not all built instances are
6308 different. It is your responsibility to assure that each is unique.
6310 Both options are optional. If none is specified, the type instance will be
6313 =item B<ValuesFrom> I<column0> [I<column1> ...]
6315 Names the columns whose content is used as the actual data for the data sets
6316 that are dispatched to the daemon. How many such columns you need is
6317 determined by the B<Type> setting as explained above. If you specify too many
6318 or not enough columns, the plugin will complain about that and no data will be
6319 submitted to the daemon.
6321 The actual data type, as seen by PostgreSQL, is not that important as long as
6322 it represents numbers. The plugin will automatically cast the values to the
6323 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6324 L<strtod(3)> functions, so anything supported by those functions is supported
6325 by the plugin as well.
6327 This option is required inside a B<Result> block and may be specified multiple
6328 times. If multiple B<ValuesFrom> options are specified, the columns are read
6333 The following predefined queries are available (the definitions can be found
6334 in the F<postgresql_default.conf> file which, by default, is available at
6335 C<I<prefix>/share/collectd/>):
6341 This query collects the number of backends, i.E<nbsp>e. the number of
6344 =item B<transactions>
6346 This query collects the numbers of committed and rolled-back transactions of
6351 This query collects the numbers of various table modifications (i.E<nbsp>e.
6352 insertions, updates, deletions) of the user tables.
6354 =item B<query_plans>
6356 This query collects the numbers of various table scans and returned tuples of
6359 =item B<table_states>
6361 This query collects the numbers of live and dead rows in the user tables.
6365 This query collects disk block access counts for user tables.
6369 This query collects the on-disk size of the database in bytes.
6373 In addition, the following detailed queries are available by default. Please
6374 note that each of those queries collects information B<by table>, thus,
6375 potentially producing B<a lot> of data. For details see the description of the
6376 non-by_table queries above.
6380 =item B<queries_by_table>
6382 =item B<query_plans_by_table>
6384 =item B<table_states_by_table>
6386 =item B<disk_io_by_table>
6390 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6391 mandatory argument specifying the name of the writer. This will then be used
6392 in the B<Database> specification in order to activate the writer instance. The
6393 names of all writers have to be unique. The following options may be
6398 =item B<Statement> I<sql statement>
6400 This mandatory option specifies the SQL statement that will be executed for
6401 each submitted value. A single SQL statement is allowed only. Anything after
6402 the first semicolon will be ignored.
6404 Nine parameters will be passed to the statement and should be specified as
6405 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6406 values are made available through those parameters:
6412 The timestamp of the queried value as an RFC 3339-formatted local time.
6416 The hostname of the queried value.
6420 The plugin name of the queried value.
6424 The plugin instance of the queried value. This value may be B<NULL> if there
6425 is no plugin instance.
6429 The type of the queried value (cf. L<types.db(5)>).
6433 The type instance of the queried value. This value may be B<NULL> if there is
6438 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6439 sources of the submitted value-list).
6443 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6444 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6445 B<StoreRates> is enabled (which is the default, see below), all types will be
6450 An array of the submitted values. The dimensions of the value name and value
6455 In general, it is advisable to create and call a custom function in the
6456 PostgreSQL database for this purpose. Any procedural language supported by
6457 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6460 =item B<StoreRates> B<false>|B<true>
6462 If set to B<true> (the default), convert counter values to rates. If set to
6463 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6468 The B<Database> block defines one PostgreSQL database for which to collect
6469 statistics. It accepts a single mandatory argument which specifies the
6470 database name. None of the other options are required. PostgreSQL will use
6471 default values as documented in the section "CONNECTING TO A DATABASE" in the
6472 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6473 the user collectd is run as and special environment variables. See the manpage
6478 =item B<Interval> I<seconds>
6480 Specify the interval with which the database should be queried. The default is
6481 to use the global B<Interval> setting.
6483 =item B<CommitInterval> I<seconds>
6485 This option may be used for database connections which have "writers" assigned
6486 (see above). If specified, it causes a writer to put several updates into a
6487 single transaction. This transaction will last for the specified amount of
6488 time. By default, each update will be executed in a separate transaction. Each
6489 transaction generates a fair amount of overhead which can, thus, be reduced by
6490 activating this option. The draw-back is, that data covering the specified
6491 amount of time will be lost, for example, if a single statement within the
6492 transaction fails or if the database server crashes.
6494 =item B<Plugin> I<Plugin>
6496 Use I<Plugin> as the plugin name when submitting query results from
6497 this B<Database>. Defaults to C<postgresql>.
6499 =item B<Instance> I<name>
6501 Specify the plugin instance name that should be used instead of the database
6502 name (which is the default, if this option has not been specified). This
6503 allows one to query multiple databases of the same name on the same host (e.g.
6504 when running multiple database server versions in parallel).
6505 The plugin instance name can also be set from the query result using
6506 the B<PluginInstanceFrom> option in B<Query> block.
6508 =item B<Host> I<hostname>
6510 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6511 value begins with a slash, it is interpreted as the directory name in which to
6512 look for the UNIX domain socket.
6514 This option is also used to determine the hostname that is associated with a
6515 collected data set. If it has been omitted or either begins with with a slash
6516 or equals B<localhost> it will be replaced with the global hostname definition
6517 of collectd. Any other value will be passed literally to collectd when
6518 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
6520 =item B<Port> I<port>
6522 Specify the TCP port or the local UNIX domain socket file extension of the
6525 =item B<User> I<username>
6527 Specify the username to be used when connecting to the server.
6529 =item B<Password> I<password>
6531 Specify the password to be used when connecting to the server.
6533 =item B<ExpireDelay> I<delay>
6535 Skip expired values in query output.
6537 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
6539 Specify whether to use an SSL connection when contacting the server. The
6540 following modes are supported:
6546 Do not use SSL at all.
6550 First, try to connect without using SSL. If that fails, try using SSL.
6552 =item I<prefer> (default)
6554 First, try to connect using SSL. If that fails, try without using SSL.
6562 =item B<Instance> I<name>
6564 Specify the plugin instance name that should be used instead of the database
6565 name (which is the default, if this option has not been specified). This
6566 allows one to query multiple databases of the same name on the same host (e.g.
6567 when running multiple database server versions in parallel).
6569 =item B<KRBSrvName> I<kerberos_service_name>
6571 Specify the Kerberos service name to use when authenticating with Kerberos 5
6572 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
6573 B<PostgreSQL Documentation> for details.
6575 =item B<Service> I<service_name>
6577 Specify the PostgreSQL service name to use for additional parameters. That
6578 service has to be defined in F<pg_service.conf> and holds additional
6579 connection parameters. See the section "The Connection Service File" in the
6580 B<PostgreSQL Documentation> for details.
6582 =item B<Query> I<query>
6584 Specifies a I<query> which should be executed in the context of the database
6585 connection. This may be any of the predefined or user-defined queries. If no
6586 such option is given, it defaults to "backends", "transactions", "queries",
6587 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
6588 has been specified). Else, the specified queries are used only.
6590 =item B<Writer> I<writer>
6592 Assigns the specified I<writer> backend to the database connection. This
6593 causes all collected data to be send to the database using the settings
6594 defined in the writer configuration (see the section "FILTER CONFIGURATION"
6595 below for details on how to selectively send data to certain plugins).
6597 Each writer will register a flush callback which may be used when having long
6598 transactions enabled (see the B<CommitInterval> option above). When issuing
6599 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
6600 transaction will be committed right away. Two different kinds of flush
6601 callbacks are available with the C<postgresql> plugin:
6607 Flush all writer backends.
6609 =item B<postgresql->I<database>
6611 Flush all writers of the specified I<database> only.
6617 =head2 Plugin C<powerdns>
6619 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
6620 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
6621 values, many of which are probably meaningless to most users, but may be useful
6622 for some. So you may chose which values to collect, but if you don't, some
6623 reasonable defaults will be collected.
6626 <Server "server_name">
6628 Collect "udp-answers" "udp-queries"
6629 Socket "/var/run/pdns.controlsocket"
6631 <Recursor "recursor_name">
6633 Collect "cache-hits" "cache-misses"
6634 Socket "/var/run/pdns_recursor.controlsocket"
6636 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
6641 =item B<Server> and B<Recursor> block
6643 The B<Server> block defines one authoritative server to query, the B<Recursor>
6644 does the same for an recursing server. The possible options in both blocks are
6645 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
6650 =item B<Collect> I<Field>
6652 Using the B<Collect> statement you can select which values to collect. Here,
6653 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
6654 C<dlg-only-drops>, C<answers10-100>.
6656 The method of getting the values differs for B<Server> and B<Recursor> blocks:
6657 When querying the server a C<SHOW *> command is issued in any case, because
6658 that's the only way of getting multiple values out of the server at once.
6659 collectd then picks out the values you have selected. When querying the
6660 recursor, a command is generated to query exactly these values. So if you
6661 specify invalid fields when querying the recursor, a syntax error may be
6662 returned by the daemon and collectd may not collect any values at all.
6664 If no B<Collect> statement is given, the following B<Server> values will be
6671 =item packetcache-hit
6673 =item packetcache-miss
6675 =item packetcache-size
6677 =item query-cache-hit
6679 =item query-cache-miss
6681 =item recursing-answers
6683 =item recursing-questions
6695 The following B<Recursor> values will be collected by default:
6699 =item noerror-answers
6701 =item nxdomain-answers
6703 =item servfail-answers
6721 Please note that up to that point collectd doesn't know what values are
6722 available on the server and values that are added do not need a change of the
6723 mechanism so far. However, the values must be mapped to collectd's naming
6724 scheme, which is done using a lookup table that lists all known values. If
6725 values are added in the future and collectd does not know about them, you will
6726 get an error much like this:
6728 powerdns plugin: submit: Not found in lookup table: foobar = 42
6730 In this case please file a bug report with the collectd team.
6732 =item B<Socket> I<Path>
6734 Configures the path to the UNIX domain socket to be used when connecting to the
6735 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
6736 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
6737 will be used for the recursor.
6741 =item B<LocalSocket> I<Path>
6743 Querying the recursor is done using UDP. When using UDP over UNIX domain
6744 sockets, the client socket needs a name in the file system, too. You can set
6745 this local name to I<Path> using the B<LocalSocket> option. The default is
6746 C<I<prefix>/var/run/collectd-powerdns>.
6750 =head2 Plugin C<processes>
6754 =item B<Process> I<Name>
6756 Select more detailed statistics of processes matching this name. The statistics
6757 collected for these selected processes are:
6758 - size of the resident segment size (RSS)
6759 - user- and system-time used
6760 - number of processes
6762 - number of open files (under Linux)
6763 - number of memory mapped files (under Linux)
6764 - io data (where available)
6765 - context switches (under Linux)
6766 - minor and major pagefaults.
6768 Some platforms have a limit on the length of process names. I<Name> must stay
6771 =item B<ProcessMatch> I<name> I<regex>
6773 Similar to the B<Process> option this allows one to select more detailed
6774 statistics of processes matching the specified I<regex> (see L<regex(7)> for
6775 details). The statistics of all matching processes are summed up and
6776 dispatched to the daemon using the specified I<name> as an identifier. This
6777 allows one to "group" several processes together. I<name> must not contain
6780 =item B<CollectContextSwitch> I<Boolean>
6782 Collect context switch of the process.
6784 =item B<CollectMemoryMaps> I<Boolean>
6786 Collect the number of memory mapped files of the process.
6787 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
6792 =head2 Plugin C<protocols>
6794 Collects a lot of information about various network protocols, such as I<IP>,
6795 I<TCP>, I<UDP>, etc.
6797 Available configuration options:
6801 =item B<Value> I<Selector>
6803 Selects whether or not to select a specific value. The string being matched is
6804 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
6805 plugin instance and I<ValueName> will be used as type instance. An example of
6806 the string being used would be C<Tcp:RetransSegs>.
6808 You can use regular expressions to match a large number of values with just one
6809 configuration option. To select all "extended" I<TCP> values, you could use the
6810 following statement:
6814 Whether only matched values are selected or all matched values are ignored
6815 depends on the B<IgnoreSelected>. By default, only matched values are selected.
6816 If no value is configured at all, all values will be selected.
6818 See F</"IGNORELISTS"> for details.
6820 =item B<IgnoreSelected> B<true>|B<false>
6822 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
6823 matching values will be ignored.
6827 =head2 Plugin C<python>
6829 This plugin embeds a Python-interpreter into collectd and provides an interface
6830 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
6832 =head2 Plugin C<routeros>
6834 The C<routeros> plugin connects to a device running I<RouterOS>, the
6835 Linux-based operating system for routers by I<MikroTik>. The plugin uses
6836 I<librouteros> to connect and reads information about the interfaces and
6837 wireless connections of the device. The configuration supports querying
6842 Host "router0.example.com"
6845 CollectInterface true
6850 Host "router1.example.com"
6853 CollectInterface true
6854 CollectRegistrationTable true
6860 As you can see above, the configuration of the I<routeros> plugin consists of
6861 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
6862 options are understood:
6866 =item B<Host> I<Host>
6868 Hostname or IP-address of the router to connect to.
6870 =item B<Port> I<Port>
6872 Port name or port number used when connecting. If left unspecified, the default
6873 will be chosen by I<librouteros>, currently "8728". This option expects a
6874 string argument, even when a numeric port number is given.
6876 =item B<User> I<User>
6878 Use the user name I<User> to authenticate. Defaults to "admin".
6880 =item B<Password> I<Password>
6882 Set the password used to authenticate.
6884 =item B<CollectInterface> B<true>|B<false>
6886 When set to B<true>, interface statistics will be collected for all interfaces
6887 present on the device. Defaults to B<false>.
6889 =item B<CollectRegistrationTable> B<true>|B<false>
6891 When set to B<true>, information about wireless LAN connections will be
6892 collected. Defaults to B<false>.
6894 =item B<CollectCPULoad> B<true>|B<false>
6896 When set to B<true>, information about the CPU usage will be collected. The
6897 number is a dimensionless value where zero indicates no CPU usage at all.
6898 Defaults to B<false>.
6900 =item B<CollectMemory> B<true>|B<false>
6902 When enabled, the amount of used and free memory will be collected. How used
6903 memory is calculated is unknown, for example whether or not caches are counted
6905 Defaults to B<false>.
6907 =item B<CollectDF> B<true>|B<false>
6909 When enabled, the amount of used and free disk space will be collected.
6910 Defaults to B<false>.
6912 =item B<CollectDisk> B<true>|B<false>
6914 When enabled, the number of sectors written and bad blocks will be collected.
6915 Defaults to B<false>.
6919 =head2 Plugin C<redis>
6921 The I<Redis plugin> connects to one or more Redis servers and gathers
6922 information about each server's state. For each server there is a I<Node> block
6923 which configures the connection parameters for this node.
6930 <Query "LLEN myqueue">
6937 The information shown in the synopsis above is the I<default configuration>
6938 which is used by the plugin if no configuration is present.
6942 =item B<Node> I<Nodename>
6944 The B<Node> block identifies a new Redis node, that is a new Redis instance
6945 running in an specified host and port. The name for node is a canonical
6946 identifier which is used as I<plugin instance>. It is limited to
6947 64E<nbsp>characters in length.
6949 =item B<Host> I<Hostname>
6951 The B<Host> option is the hostname or IP-address where the Redis instance is
6954 =item B<Port> I<Port>
6956 The B<Port> option is the TCP port on which the Redis instance accepts
6957 connections. Either a service name of a port number may be given. Please note
6958 that numerical port numbers must be given as a string, too.
6960 =item B<Password> I<Password>
6962 Use I<Password> to authenticate when connecting to I<Redis>.
6964 =item B<Timeout> I<Milliseconds>
6966 The B<Timeout> option set the socket timeout for node response. Since the Redis
6967 read function is blocking, you should keep this value as low as possible. Keep
6968 in mind that the sum of all B<Timeout> values for all B<Nodes> should be lower
6969 than B<Interval> defined globally.
6971 =item B<Query> I<Querystring>
6973 The B<Query> block identifies a query to execute against the redis server.
6974 There may be an arbitrary number of queries to execute.
6976 =item B<Type> I<Collectd type>
6978 Within a query definition, a valid collectd type to use as when submitting
6979 the result of the query. When not supplied, will default to B<gauge>.
6981 =item B<Instance> I<Type instance>
6983 Within a query definition, an optional type instance to use when submitting
6984 the result of the query. When not supplied will default to the escaped
6985 command, up to 64 chars.
6989 =head2 Plugin C<rrdcached>
6991 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
6992 to store values to RRD files in an efficient manner. The combination of the
6993 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
6994 way the C<rrdtool> plugin works (see below). The added abstraction layer
6995 provides a number of benefits, though: Because the cache is not within
6996 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
6997 restarted. This results in much shorter (if any) gaps in graphs, especially
6998 under heavy load. Also, the C<rrdtool> command line utility is aware of the
6999 daemon so that it can flush values to disk automatically when needed. This
7000 allows one to integrate automated flushing of values into graphing solutions
7003 There are disadvantages, though: The daemon may reside on a different host, so
7004 it may not be possible for C<collectd> to create the appropriate RRD files
7005 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7006 different base directory, so relative paths may do weird stuff if you're not
7009 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7010 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7011 setting should be set to an absolute path, so that a changed base directory
7012 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7016 =item B<DaemonAddress> I<Address>
7018 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7019 library. See L<rrdcached(1)> for details. Example:
7021 <Plugin "rrdcached">
7022 DaemonAddress "unix:/var/run/rrdcached.sock"
7025 =item B<DataDir> I<Directory>
7027 Set the base directory in which the RRD files reside. If this is a relative
7028 path, it is relative to the working base directory of the C<rrdcached> daemon!
7029 Use of an absolute path is recommended.
7031 =item B<CreateFiles> B<true>|B<false>
7033 Enables or disables the creation of RRD files. If the daemon is not running
7034 locally, or B<DataDir> is set to a relative path, this will not work as
7035 expected. Default is B<true>.
7037 =item B<CreateFilesAsync> B<false>|B<true>
7039 When enabled, new RRD files are enabled asynchronously, using a separate thread
7040 that runs in the background. This prevents writes to block, which is a problem
7041 especially when many hundreds of files need to be created at once. However,
7042 since the purpose of creating the files asynchronously is I<not> to block until
7043 the file is available, values before the file is available will be discarded.
7044 When disabled (the default) files are created synchronously, blocking for a
7045 short while, while the file is being written.
7047 =item B<StepSize> I<Seconds>
7049 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7050 this setting is unset and the stepsize is set to the interval in which the data
7051 is collected. Do not use this option unless you absolutely have to for some
7052 reason. Setting this option may cause problems with the C<snmp plugin>, the
7053 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7055 =item B<HeartBeat> I<Seconds>
7057 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7058 in which case the heartbeat is set to twice the B<StepSize> which should equal
7059 the interval in which data is collected. Do not set this option unless you have
7060 a very good reason to do so.
7062 =item B<RRARows> I<NumRows>
7064 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7065 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7066 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7067 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7068 week, one month, and one year.
7070 So for each timespan, it calculates how many PDPs need to be consolidated into
7071 one CDP by calculating:
7072 number of PDPs = timespan / (stepsize * rrarows)
7074 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7077 =item B<RRATimespan> I<Seconds>
7079 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7080 more then one RRA. If this option is never used, the built-in default of (3600,
7081 86400, 604800, 2678400, 31622400) is used.
7083 For more information on how RRA-sizes are calculated see B<RRARows> above.
7085 =item B<XFF> I<Factor>
7087 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7088 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7091 =item B<CollectStatistics> B<false>|B<true>
7093 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7094 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7096 Statistics are read via I<rrdcached>s socket using the STATS command.
7097 See L<rrdcached(1)> for details.
7101 =head2 Plugin C<rrdtool>
7103 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7104 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7105 using these settings. If you don't want to dive into the depths of RRDtool, you
7106 can safely ignore these settings.
7110 =item B<DataDir> I<Directory>
7112 Set the directory to store RRD files under. By default RRD files are generated
7113 beneath the daemon's working directory, i.e. the B<BaseDir>.
7115 =item B<CreateFilesAsync> B<false>|B<true>
7117 When enabled, new RRD files are enabled asynchronously, using a separate thread
7118 that runs in the background. This prevents writes to block, which is a problem
7119 especially when many hundreds of files need to be created at once. However,
7120 since the purpose of creating the files asynchronously is I<not> to block until
7121 the file is available, values before the file is available will be discarded.
7122 When disabled (the default) files are created synchronously, blocking for a
7123 short while, while the file is being written.
7125 =item B<StepSize> I<Seconds>
7127 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7128 this setting is unset and the stepsize is set to the interval in which the data
7129 is collected. Do not use this option unless you absolutely have to for some
7130 reason. Setting this option may cause problems with the C<snmp plugin>, the
7131 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7133 =item B<HeartBeat> I<Seconds>
7135 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7136 in which case the heartbeat is set to twice the B<StepSize> which should equal
7137 the interval in which data is collected. Do not set this option unless you have
7138 a very good reason to do so.
7140 =item B<RRARows> I<NumRows>
7142 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7143 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7144 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7145 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7146 week, one month, and one year.
7148 So for each timespan, it calculates how many PDPs need to be consolidated into
7149 one CDP by calculating:
7150 number of PDPs = timespan / (stepsize * rrarows)
7152 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7155 =item B<RRATimespan> I<Seconds>
7157 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7158 more then one RRA. If this option is never used, the built-in default of (3600,
7159 86400, 604800, 2678400, 31622400) is used.
7161 For more information on how RRA-sizes are calculated see B<RRARows> above.
7163 =item B<XFF> I<Factor>
7165 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7166 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7169 =item B<CacheFlush> I<Seconds>
7171 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7172 it writes all values for a certain RRD-file if the oldest value is older than
7173 (or equal to) the number of seconds specified by B<CacheTimeout>.
7174 That check happens on new values arriwal. If some RRD-file is not updated
7175 anymore for some reason (the computer was shut down, the network is broken,
7176 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7177 every I<Seconds> seconds the entire cache is searched for entries older than
7178 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7179 disk. Since scanning the entire cache is kind of expensive and does nothing
7180 under normal circumstances, this value should not be too small. 900 seconds
7181 might be a good value, though setting this to 7200 seconds doesn't normally
7182 do much harm either.
7184 Defaults to 10x B<CacheTimeout>.
7185 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7186 above default is used.
7188 =item B<CacheTimeout> I<Seconds>
7190 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7191 save values in a cache, as described above. Writing multiple values at once
7192 reduces IO-operations and thus lessens the load produced by updating the files.
7193 The trade off is that the graphs kind of "drag behind" and that more memory is
7196 =item B<WritesPerSecond> I<Updates>
7198 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7199 will run serious performance problems. The B<CacheFlush> setting and the
7200 internal update queue assert that collectd continues to work just fine even
7201 under heavy load, but the system may become very unresponsive and slow. This is
7202 a problem especially if you create graphs from the RRD files on the same
7203 machine, for example using the C<graph.cgi> script included in the
7204 C<contrib/collection3/> directory.
7206 This setting is designed for very large setups. Setting this option to a value
7207 between 25 and 80 updates per second, depending on your hardware, will leave
7208 the server responsive enough to draw graphs even while all the cached values
7209 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7210 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7211 written as fast as possible, so that web frontends have up to date data when
7214 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7215 updates per second, writing all values to disk will take approximately
7216 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7217 "collection3" you'll end up with a responsive and fast system, up to date
7218 graphs and basically a "backup" of your values every hour.
7220 =item B<RandomTimeout> I<Seconds>
7222 When set, the actual timeout for each value is chosen randomly between
7223 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7224 intention is to avoid high load situations that appear when many values timeout
7225 at the same time. This is especially a problem shortly after the daemon starts,
7226 because all values were added to the internal cache at roughly the same time.
7230 =head2 Plugin C<sensors>
7232 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7233 that all the needed modules have to be loaded and lm_sensors has to be
7234 configured (most likely by editing F</etc/sensors.conf>. Read
7235 L<sensors.conf(5)> for details.
7237 The B<lm_sensors> homepage can be found at
7238 L<http://secure.netroedge.com/~lm78/>.
7242 =item B<SensorConfigFile> I<File>
7244 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7245 the library's default will be used.
7247 =item B<Sensor> I<chip-bus-address/type-feature>
7249 Selects the name of the sensor which you want to collect or ignore, depending
7250 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7251 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7252 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7254 See F</"IGNORELISTS"> for details.
7256 =item B<IgnoreSelected> I<true>|I<false>
7258 If no configuration if given, the B<sensors>-plugin will collect data from all
7259 sensors. This may not be practical, especially for uninteresting sensors.
7260 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7261 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7262 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7263 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7264 and all other sensors are collected.
7266 =item B<UseLabels> I<true>|I<false>
7268 Configures how sensor readings are reported. When set to I<true>, sensor
7269 readings are reported using their descriptive label (e.g. "VCore"). When set to
7270 I<false> (the default) the sensor name is used ("in0").
7274 =head2 Plugin C<sigrok>
7276 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7277 supported by the L<sigrok|http://sigrok.org/> project.
7283 <Device "AC Voltage">
7288 <Device "Sound Level">
7289 Driver "cem-dt-885x"
7296 =item B<LogLevel> B<0-5>
7298 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7299 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7300 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7301 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7302 their level, are always submitted to I<collectd> at its INFO log level.
7304 =item E<lt>B<Device> I<Name>E<gt>
7306 A sigrok-supported device, uniquely identified by this section's options. The
7307 I<Name> is passed to I<collectd> as the I<plugin instance>.
7309 =item B<Driver> I<DriverName>
7311 The sigrok driver to use for this device.
7313 =item B<Conn> I<ConnectionSpec>
7315 If the device cannot be auto-discovered, or more than one might be discovered
7316 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7317 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7318 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7319 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7320 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7322 =item B<SerialComm> I<SerialSpec>
7324 For serial devices with non-standard port settings, this option can be used
7325 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7326 This should not be necessary; drivers know how to communicate with devices they
7329 =item B<MinimumInterval> I<Seconds>
7331 Specifies the minimum time between measurement dispatches to I<collectd>, in
7332 seconds. Since some I<sigrok> supported devices can acquire measurements many
7333 times per second, it may be necessary to throttle these. For example, the
7334 I<RRD plugin> cannot process writes more than once per second.
7336 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7337 device are always dispatched to I<collectd>. When throttled, unused
7338 measurements are discarded.
7342 =head2 Plugin C<smart>
7344 The C<smart> plugin collects SMART information from physical
7345 disks. Values collectd include temperature, power cycle count, poweron
7346 time and bad sectors. Also, all SMART attributes are collected along
7347 with the normalized current value, the worst value, the threshold and
7348 a human readable value.
7350 Using the following two options you can ignore some disks or configure the
7351 collection only of specific disks.
7355 =item B<Disk> I<Name>
7357 Select the disk I<Name>. Whether it is collected or ignored depends on the
7358 B<IgnoreSelected> setting, see below. As with other plugins that use the
7359 daemon's ignorelist functionality, a string that starts and ends with a slash
7360 is interpreted as a regular expression. Examples:
7365 See F</"IGNORELISTS"> for details.
7367 =item B<IgnoreSelected> B<true>|B<false>
7369 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7370 statements, are ignored or if all other disks are ignored. The behavior
7371 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7372 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7373 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7374 is set to B<true>, all disks are collected B<except> the ones matched.
7376 =item B<IgnoreSleepMode> B<true>|B<false>
7378 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7379 This option disables the sleep mode check and allows the plugin to collect data
7380 from these disks anyway. This is useful in cases where libatasmart mistakenly
7381 reports disks as asleep because it has not been updated to incorporate support
7382 for newer idle states in the ATA spec.
7384 =item B<UseSerial> B<true>|B<false>
7386 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7387 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7388 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7389 storing data. This ensures that the data for a given disk will be kept together
7390 even if the kernel name changes.
7394 =head2 Plugin C<snmp>
7396 Since the configuration of the C<snmp plugin> is a little more complicated than
7397 other plugins, its documentation has been moved to an own manpage,
7398 L<collectd-snmp(5)>. Please see there for details.
7400 =head2 Plugin C<snmp_agent>
7402 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7403 from SNMP master agent and returns the data collected by read plugins.
7404 The I<snmp_agent> plugin handles requests only for OIDs specified in
7405 configuration file. To handle SNMP queries the plugin gets data from collectd
7406 and translates requested values from collectd's internal format to SNMP format.
7407 This plugin is a generic plugin and cannot work without configuration.
7408 For more details on AgentX subagent see
7409 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7414 <Data "memAvailReal">
7416 #PluginInstance "some"
7419 OIDs "1.3.6.1.4.1.2021.4.6.0"
7422 IndexOID "IF-MIB::ifIndex"
7423 SizeOID "IF-MIB::ifNumber"
7427 OIDs "IF-MIB::ifDescr"
7433 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
7438 There are two types of blocks that can be contained in the
7439 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
7441 =head3 The B<Data> block
7443 The B<Data> block defines a list OIDs that are to be handled. This block can
7444 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
7445 block it reperesents table OIDs.
7446 The following options can be set:
7450 =item B<Instance> I<true|false>
7452 When B<Instance> is set to B<true>, the value for requested OID is copied from
7453 plugin instance field of corresponding collectd value. If B<Data> block defines
7454 scalar data type B<Instance> has no effect and can be omitted.
7456 =item B<Plugin> I<String>
7458 Read plugin name whose collected data will be mapped to specified OIDs.
7460 =item B<PluginInstance> I<String>
7462 Read plugin instance whose collected data will be mapped to specified OIDs.
7463 The field is optional and by default there is no plugin instance check.
7464 Allowed only if B<Data> block defines scalar data type.
7466 =item B<Type> I<String>
7468 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
7469 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
7471 =item B<TypeInstance> I<String>
7473 Collectd's type-instance that is to be used for specified OID.
7475 =item B<OIDs> I<OID> [I<OID> ...]
7477 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
7478 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
7479 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
7480 configured should correspond to number of values in specified B<Type>.
7481 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
7482 "rx" and "tx" values of "if_octets" type.
7484 =item B<Scale> I<Value>
7486 The values taken from collectd are multiplied by I<Value>. The field is optional
7487 and the default is B<1.0>.
7489 =item B<Shift> I<Value>
7491 I<Value> is added to values from collectd after they have been multiplied by
7492 B<Scale> value. The field is optional and the default value is B<0.0>.
7496 =head3 The B<Table> block
7498 The B<Table> block defines a collection of B<Data> blocks that belong to one
7499 snmp table. In addition to multiple B<Data> blocks the following options can be
7504 =item B<IndexOID> I<OID>
7506 OID that is handled by the plugin and is mapped to numerical index value that is
7507 generated by the plugin for each table record.
7509 =item B<SizeOID> I<OID>
7511 OID that is handled by the plugin. Returned value is the number of records in
7512 the table. The field is optional.
7516 =head2 Plugin C<statsd>
7518 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
7519 protocol and dispatches rates or other aggregates of these numbers
7522 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
7523 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
7524 C<objects> respectively.
7526 The following configuration options are valid:
7530 =item B<Host> I<Host>
7532 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
7533 "any" address, i.e. accept packets sent to any of the hosts addresses.
7535 =item B<Port> I<Port>
7537 UDP port to listen to. This can be either a service name or a port number.
7538 Defaults to C<8125>.
7540 =item B<DeleteCounters> B<false>|B<true>
7542 =item B<DeleteTimers> B<false>|B<true>
7544 =item B<DeleteGauges> B<false>|B<true>
7546 =item B<DeleteSets> B<false>|B<true>
7548 These options control what happens if metrics are not updated in an interval.
7549 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
7550 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
7551 are unchanged. If set to B<True>, the such metrics are not dispatched and
7552 removed from the internal cache.
7554 =item B<CounterSum> B<false>|B<true>
7556 When enabled, creates a C<count> metric which reports the change since the last
7557 read. This option primarily exists for compatibility with the I<statsd>
7558 implementation by Etsy.
7560 =item B<TimerPercentile> I<Percent>
7562 Calculate and dispatch the configured percentile, i.e. compute the latency, so
7563 that I<Percent> of all reported timers are smaller than or equal to the
7564 computed latency. This is useful for cutting off the long tail latency, as it's
7565 often done in I<Service Level Agreements> (SLAs).
7567 Different percentiles can be calculated by setting this option several times.
7568 If none are specified, no percentiles are calculated / dispatched.
7570 =item B<TimerLower> B<false>|B<true>
7572 =item B<TimerUpper> B<false>|B<true>
7574 =item B<TimerSum> B<false>|B<true>
7576 =item B<TimerCount> B<false>|B<true>
7578 Calculate and dispatch various values out of I<Timer> metrics received during
7579 an interval. If set to B<False>, the default, these values aren't calculated /
7584 =head2 Plugin C<swap>
7586 The I<Swap plugin> collects information about used and available swap space. On
7587 I<Linux> and I<Solaris>, the following options are available:
7591 =item B<ReportByDevice> B<false>|B<true>
7593 Configures how to report physical swap devices. If set to B<false> (the
7594 default), the summary over all swap devices is reported only, i.e. the globally
7595 used and available space over all devices. If B<true> is configured, the used
7596 and available space of each device will be reported separately.
7598 This option is only available if the I<Swap plugin> can read C</proc/swaps>
7599 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
7601 =item B<ReportBytes> B<false>|B<true>
7603 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
7604 I<swap I/O> is reported in pages. This option is available under Linux only.
7606 =item B<ValuesAbsolute> B<true>|B<false>
7608 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
7609 available and used. Defaults to B<true>.
7611 =item B<ValuesPercentage> B<false>|B<true>
7613 Enables or disables reporting of relative swap metrics, i.e. I<percent>
7614 available and free. Defaults to B<false>.
7616 This is useful for deploying I<collectd> in a heterogeneous environment, where
7617 swap sizes differ and you want to specify generic thresholds or similar.
7619 =item B<ReportIO> B<true>|B<false>
7621 Enables or disables reporting swap IO. Defaults to B<true>.
7623 This is useful for the cases when swap IO is not neccessary, is not available,
7628 =head2 Plugin C<syslog>
7632 =item B<LogLevel> B<debug|info|notice|warning|err>
7634 Sets the log-level. If, for example, set to B<notice>, then all events with
7635 severity B<notice>, B<warning>, or B<err> will be submitted to the
7638 Please note that B<debug> is only available if collectd has been compiled with
7641 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
7643 Controls which notifications should be sent to syslog. The default behaviour is
7644 not to send any. Less severe notifications always imply logging more severe
7645 notifications: Setting this to B<OKAY> means all notifications will be sent to
7646 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
7647 notifications but will dismiss B<OKAY> notifications. Setting this option to
7648 B<FAILURE> will only send failures to syslog.
7652 =head2 Plugin C<table>
7654 The C<table plugin> provides generic means to parse tabular data and dispatch
7655 user specified values. Values are selected based on column numbers. For
7656 example, this plugin may be used to get values from the Linux L<proc(5)>
7657 filesystem or CSV (comma separated values) files.
7660 <Table "/proc/slabinfo">
7666 InstancePrefix "active_objs"
7672 InstancePrefix "objperslab"
7679 The configuration consists of one or more B<Table> blocks, each of which
7680 configures one file to parse. Within each B<Table> block, there are one or
7681 more B<Result> blocks, which configure which data to select and how to
7684 The following options are available inside a B<Table> block:
7688 =item B<Plugin> I<Plugin>
7690 If specified, I<Plugin> is used as the plugin name when submitting values.
7691 Defaults to B<table>.
7693 =item B<Instance> I<instance>
7695 If specified, I<instance> is used as the plugin instance. If omitted, the
7696 filename of the table is used instead, with all special characters replaced
7697 with an underscore (C<_>).
7699 =item B<Separator> I<string>
7701 Any character of I<string> is interpreted as a delimiter between the different
7702 columns of the table. A sequence of two or more contiguous delimiters in the
7703 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
7704 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
7705 of a table - see its documentation for more details. This option is mandatory.
7707 A horizontal tab, newline and carriage return may be specified by C<\\t>,
7708 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
7709 required because of collectd's config parsing.
7713 The following options are available inside a B<Result> block:
7717 =item B<Type> I<type>
7719 Sets the type used to dispatch the values to the daemon. Detailed information
7720 about types and their configuration can be found in L<types.db(5)>. This
7721 option is mandatory.
7723 =item B<InstancePrefix> I<prefix>
7725 If specified, prepend I<prefix> to the type instance. If omitted, only the
7726 B<InstancesFrom> option is considered for the type instance.
7728 =item B<InstancesFrom> I<column0> [I<column1> ...]
7730 If specified, the content of the given columns (identified by the column
7731 number starting at zero) will be used to create the type instance for each
7732 row. Multiple values (and the instance prefix) will be joined together with
7733 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
7734 option is considered for the type instance.
7736 The plugin itself does not check whether or not all built instances are
7737 different. It’s your responsibility to assure that each is unique. This is
7738 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
7739 sure that the table only contains one row.
7741 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
7744 =item B<ValuesFrom> I<column0> [I<column1> ...]
7746 Specifies the columns (identified by the column numbers starting at zero)
7747 whose content is used as the actual data for the data sets that are dispatched
7748 to the daemon. How many such columns you need is determined by the B<Type>
7749 setting above. If you specify too many or not enough columns, the plugin will
7750 complain about that and no data will be submitted to the daemon. The plugin
7751 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
7752 respectively, so anything supported by those functions is supported by the
7753 plugin as well. This option is mandatory.
7757 =head2 Plugin C<tail>
7759 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
7760 each line and dispatches found values. What is matched can be configured by the
7761 user using (extended) regular expressions, as described in L<regex(7)>.
7764 <File "/var/log/exim4/mainlog">
7769 Regex "S=([1-9][0-9]*)"
7775 Regex "\\<R=local_user\\>"
7776 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
7779 Instance "local_user"
7782 Regex "l=([0-9]*\\.[0-9]*)"
7783 <DSType "Distribution">
7786 #BucketType "bucket"
7794 The config consists of one or more B<File> blocks, each of which configures one
7795 logfile to parse. Within each B<File> block, there are one or more B<Match>
7796 blocks, which configure a regular expression to search for.
7798 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
7799 the plugin name and instance respectively. So in the above example the plugin name
7800 C<mail-exim> would be used.
7802 These options are applied for all B<Match> blocks that B<follow> it, until the
7803 next B<Plugin> or B<Instance> option. This way you can extract several plugin
7804 instances from one logfile, handy when parsing syslog and the like.
7806 The B<Interval> option allows you to define the length of time between reads. If
7807 this is not set, the default Interval will be used.
7809 Each B<Match> block has the following options to describe how the match should
7814 =item B<Regex> I<regex>
7816 Sets the regular expression to use for matching against a line. The first
7817 subexpression has to match something that can be turned into a number by
7818 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
7819 below. Because B<extended> regular expressions are used, you do not need to use
7820 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
7821 collectd's config parsing you need to escape backslashes, though. So if you
7822 want to match literal parentheses you need to do the following:
7824 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
7826 =item B<ExcludeRegex> I<regex>
7828 Sets an optional regular expression to use for excluding lines from the match.
7829 An example which excludes all connections from localhost from the match:
7831 ExcludeRegex "127\\.0\\.0\\.1"
7833 =item B<DSType> I<Type>
7835 Sets how the values are cumulated. I<Type> is one of:
7839 =item B<GaugeAverage>
7841 Calculate the average.
7845 Use the smallest number only.
7849 Use the greatest number only.
7853 Use the last number found.
7855 =item B<GaugePersist>
7857 Use the last number found. The number is not reset at the end of an interval.
7858 It is continously reported until another number is matched. This is intended
7859 for cases in which only state changes are reported, for example a thermometer
7860 that only reports the temperature when it changes.
7866 =item B<AbsoluteSet>
7868 The matched number is a counter. Simply I<sets> the internal counter to this
7869 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
7877 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
7878 matched number may be negative, which will effectively subtract from the
7887 Increase the internal counter by one. These B<DSType> are the only ones that do
7888 not use the matched subexpression, but simply count the number of matched
7889 lines. Thus, you may use a regular expression without submatch in this case.
7891 =item B<Distribution>
7893 Type to do calculations based on the distribution of values, primarily
7894 calculating percentiles. This is primarily geared towards latency, but can be
7895 used for other metrics as well. The range of values tracked with this setting
7896 must be in the range (0–2^34) and can be fractional. Please note that neither
7897 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
7900 This option must be used together with the B<Percentile> and/or B<Bucket>
7905 <DSType "Distribution">
7913 =item B<Percentile> I<Percent>
7915 Calculate and dispatch the configured percentile, i.e. compute the value, so
7916 that I<Percent> of all matched values are smaller than or equal to the computed
7919 Metrics are reported with the I<type> B<Type> (the value of the above option)
7920 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
7922 This option may be repeated to calculate more than one percentile.
7924 =item B<Bucket> I<lower_bound> I<upper_bound>
7926 Export the number of values (a C<DERIVE>) falling within the given range. Both,
7927 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
7928 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
7929 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
7930 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
7933 To export the entire (0–inf) range without overlap, use the upper bound of the
7934 previous range as the lower bound of the following range. In other words, use
7935 the following schema:
7945 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
7946 by default) and the I<type instance>
7947 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
7949 This option may be repeated to calculate more than one rate.
7951 =item B<BucketType> I<Type>
7953 Sets the type used to dispatch B<Bucket> metrics.
7954 Optional, by default C<bucket> will be used.
7960 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
7961 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
7962 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
7963 B<Derive*> types interpret the submatch as a signed integer using
7964 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
7965 and it may be omitted in this case.
7967 =item B<Type> I<Type>
7969 Sets the type used to dispatch this value. Detailed information about types and
7970 their configuration can be found in L<types.db(5)>.
7972 =item B<Instance> I<TypeInstance>
7974 This optional setting sets the type instance to use.
7978 =head2 Plugin C<tail_csv>
7980 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
7981 written by I<Snort>.
7986 <Metric "snort-dropped">
7991 <File "/var/log/snort/snort.stats">
7995 Collect "snort-dropped"
7999 The configuration consists of one or more B<Metric> blocks that define an index
8000 into the line of the CSV file and how this value is mapped to I<collectd's>
8001 internal representation. These are followed by one or more B<Instance> blocks
8002 which configure which file to read, in which interval and which metrics to
8007 =item E<lt>B<Metric> I<Name>E<gt>
8009 The B<Metric> block configures a new metric to be extracted from the statistics
8010 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8011 only used inside the B<Instance> blocks to refer to this block, so you can use
8012 one B<Metric> block for multiple CSV files.
8016 =item B<Type> I<Type>
8018 Configures which I<Type> to use when dispatching this metric. Types are defined
8019 in the L<types.db(5)> file, see the appropriate manual page for more
8020 information on specifying types. Only types with a single I<data source> are
8021 supported by the I<tail_csv plugin>. The information whether the value is an
8022 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8023 I<Type's> definition.
8025 =item B<Instance> I<TypeInstance>
8027 If set, I<TypeInstance> is used to populate the type instance field of the
8028 created value lists. Otherwise, no type instance is used.
8030 =item B<ValueFrom> I<Index>
8032 Configure to read the value from the field with the zero-based index I<Index>.
8033 If the value is parsed as signed integer, unsigned integer or double depends on
8034 the B<Type> setting, see above.
8038 =item E<lt>B<File> I<Path>E<gt>
8040 Each B<File> block represents one CSV file to read. There must be at least one
8041 I<File> block but there can be multiple if you have multiple CSV files.
8045 =item B<Plugin> I<Plugin>
8047 Use I<Plugin> as the plugin name when submitting values.
8048 Defaults to C<tail_csv>.
8050 =item B<Instance> I<PluginInstance>
8052 Sets the I<plugin instance> used when dispatching the values.
8054 =item B<Collect> I<Metric>
8056 Specifies which I<Metric> to collect. This option must be specified at least
8057 once, and you can use this option multiple times to specify more than one
8058 metric to be extracted from this statistic file.
8060 =item B<Interval> I<Seconds>
8062 Configures the interval in which to read values from this instance / file.
8063 Defaults to the plugin's default interval.
8065 =item B<TimeFrom> I<Index>
8067 Rather than using the local time when dispatching a value, read the timestamp
8068 from the field with the zero-based index I<Index>. The value is interpreted as
8069 seconds since epoch. The value is parsed as a double and may be factional.
8075 =head2 Plugin C<teamspeak2>
8077 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8078 polls interesting global and virtual server data. The plugin can query only one
8079 physical server but unlimited virtual servers. You can use the following
8080 options to configure it:
8084 =item B<Host> I<hostname/ip>
8086 The hostname or ip which identifies the physical server.
8089 =item B<Port> I<port>
8091 The query port of the physical server. This needs to be a string.
8094 =item B<Server> I<port>
8096 This option has to be added once for every virtual server the plugin should
8097 query. If you want to query the virtual server on port 8767 this is what the
8098 option would look like:
8102 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8103 use quotes around it! If no such statement is given only global information
8108 =head2 Plugin C<ted>
8110 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8111 measure power consumption. These devices are usually connected to a serial
8112 (RS232) or USB port. The plugin opens a configured device and tries to read the
8113 current energy readings. For more information on TED, visit
8114 L<http://www.theenergydetective.com/>.
8116 Available configuration options:
8120 =item B<Device> I<Path>
8122 Path to the device on which TED is connected. collectd will need read and write
8123 permissions on that file.
8125 Default: B</dev/ttyUSB0>
8127 =item B<Retries> I<Num>
8129 Apparently reading from TED is not that reliable. You can therefore configure a
8130 number of retries here. You only configure the I<retries> here, to if you
8131 specify zero, one reading will be performed (but no retries if that fails); if
8132 you specify three, a maximum of four readings are performed. Negative values
8139 =head2 Plugin C<tcpconns>
8141 The C<tcpconns plugin> counts the number of currently established TCP
8142 connections based on the local port and/or the remote port. Since there may be
8143 a lot of connections the default if to count all connections with a local port,
8144 for which a listening socket is opened. You can use the following options to
8145 fine-tune the ports you are interested in:
8149 =item B<ListeningPorts> I<true>|I<false>
8151 If this option is set to I<true>, statistics for all local ports for which a
8152 listening socket exists are collected. The default depends on B<LocalPort> and
8153 B<RemotePort> (see below): If no port at all is specifically selected, the
8154 default is to collect listening ports. If specific ports (no matter if local or
8155 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8156 the selected ports will be collected unless this option is set to I<true>
8159 =item B<LocalPort> I<Port>
8161 Count the connections to a specific local port. This can be used to see how
8162 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8163 You have to specify the port in numeric form, so for the mailserver example
8164 you'd need to set B<25>.
8166 =item B<RemotePort> I<Port>
8168 Count the connections to a specific remote port. This is useful to see how
8169 much a remote service is used. This is most useful if you want to know how many
8170 connections a local service has opened to remote services, e.E<nbsp>g. how many
8171 connections a mail server or news server has to other mail or news servers, or
8172 how many connections a web proxy holds to web servers. You have to give the
8173 port in numeric form.
8175 =item B<AllPortsSummary> I<true>|I<false>
8177 If this option is set to I<true> a summary of statistics from all connections
8178 are collected. This option defaults to I<false>.
8182 =head2 Plugin C<thermal>
8186 =item B<ForceUseProcfs> I<true>|I<false>
8188 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8189 C<sysfs> interface. If that is not available, the plugin falls back to the
8190 C<procfs> interface. By setting this option to I<true>, you can force the
8191 plugin to use the latter. This option defaults to I<false>.
8193 =item B<Device> I<Device>
8195 Selects the name of the thermal device that you want to collect or ignore,
8196 depending on the value of the B<IgnoreSelected> option. This option may be
8197 used multiple times to specify a list of devices.
8199 See F</"IGNORELISTS"> for details.
8201 =item B<IgnoreSelected> I<true>|I<false>
8203 Invert the selection: If set to true, all devices B<except> the ones that
8204 match the device names specified by the B<Device> option are collected. By
8205 default only selected devices are collected if a selection is made. If no
8206 selection is configured at all, B<all> devices are selected.
8210 =head2 Plugin C<threshold>
8212 The I<Threshold plugin> checks values collected or received by I<collectd>
8213 against a configurable I<threshold> and issues I<notifications> if values are
8216 Documentation for this plugin is available in the L<collectd-threshold(5)>
8219 =head2 Plugin C<tokyotyrant>
8221 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8222 couple metrics: number of records, and database size on disk.
8226 =item B<Host> I<Hostname/IP>
8228 The hostname or IP which identifies the server.
8229 Default: B<127.0.0.1>
8231 =item B<Port> I<Service/Port>
8233 The query port of the server. This needs to be a string, even if the port is
8234 given in its numeric form.
8239 =head2 Plugin C<turbostat>
8241 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8242 Intel processors by using I<Model Specific Registers>.
8246 =item B<CoreCstates> I<Bitmask(Integer)>
8248 Bit mask of the list of core C-states supported by the processor.
8249 This option should only be used if the automated detection fails.
8250 Default value extracted from the CPU model and family.
8252 Currently supported C-states (by this plugin): 3, 6, 7
8256 All states (3, 6 and 7):
8257 (1<<3) + (1<<6) + (1<<7) = 392
8259 =item B<PackageCstates> I<Bitmask(Integer)>
8261 Bit mask of the list of packages C-states supported by the processor. This
8262 option should only be used if the automated detection fails. Default value
8263 extracted from the CPU model and family.
8265 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8269 States 2, 3, 6 and 7:
8270 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8272 =item B<SystemManagementInterrupt> I<true>|I<false>
8274 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8275 This option should only be used if the automated detection fails or if you want
8276 to disable this feature.
8278 =item B<DigitalTemperatureSensor> I<true>|I<false>
8280 Boolean enabling the collection of the temperature of each core. This option
8281 should only be used if the automated detection fails or if you want to disable
8284 =item B<TCCActivationTemp> I<Temperature>
8286 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8287 temperature is used when collecting the temperature of cores or packages. This
8288 option should only be used if the automated detection fails. Default value
8289 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8291 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8293 Bit mask of the list of elements to be thermally monitored. This option should
8294 only be used if the automated detection fails or if you want to disable some
8295 collections. The different bits of this bit mask accepted by this plugin are:
8299 =item 0 ('1'): Package
8303 =item 2 ('4'): Cores
8305 =item 3 ('8'): Embedded graphic device
8309 =item B<LogicalCoreNames> I<true>|I<false>
8311 Boolean enabling the use of logical core numbering for per core statistics.
8312 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8313 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8314 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8315 more than one, where I<n> is the n-th core of package I<m>.
8319 =head2 Plugin C<unixsock>
8323 =item B<SocketFile> I<Path>
8325 Sets the socket-file which is to be created.
8327 =item B<SocketGroup> I<Group>
8329 If running as root change the group of the UNIX-socket after it has been
8330 created. Defaults to B<collectd>.
8332 =item B<SocketPerms> I<Permissions>
8334 Change the file permissions of the UNIX-socket after it has been created. The
8335 permissions must be given as a numeric, octal value as you would pass to
8336 L<chmod(1)>. Defaults to B<0770>.
8338 =item B<DeleteSocket> B<false>|B<true>
8340 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8341 with the given name already exists. If I<collectd> crashes a socket file may be
8342 left over, preventing the daemon from opening a new socket when restarted.
8343 Since this is potentially dangerous, this defaults to B<false>.
8347 =head2 Plugin C<uuid>
8349 This plugin, if loaded, causes the Hostname to be taken from the machine's
8350 UUID. The UUID is a universally unique designation for the machine, usually
8351 taken from the machine's BIOS. This is most useful if the machine is running in
8352 a virtual environment such as Xen, in which case the UUID is preserved across
8353 shutdowns and migration.
8355 The following methods are used to find the machine's UUID, in order:
8361 Check I</etc/uuid> (or I<UUIDFile>).
8365 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
8370 Check for UUID from C<dmidecode> / SMBIOS.
8374 Check for UUID from Xen hypervisor.
8378 If no UUID can be found then the hostname is not modified.
8382 =item B<UUIDFile> I<Path>
8384 Take the UUID from the given file (default I</etc/uuid>).
8388 =head2 Plugin C<varnish>
8390 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
8391 It collects a subset of the values displayed by L<varnishstat(1)>, and
8392 organizes them in categories which can be enabled or disabled. Currently only
8393 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
8394 meaning of each metric can be found in L<varnish-counters(7)>.
8399 <Instance "example">
8403 CollectConnections true
8404 CollectDirectorDNS false
8408 CollectObjects false
8410 CollectSession false
8420 CollectWorkers false
8422 CollectMempool false
8423 CollectManagement false
8429 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
8430 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
8431 will collectd statistics from the default "varnishd" instance (this should work
8432 fine in most cases).
8434 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
8438 =item B<CollectBackend> B<true>|B<false>
8440 Back-end connection statistics, such as successful, reused,
8441 and closed connections. True by default.
8443 =item B<CollectBan> B<true>|B<false>
8445 Statistics about ban operations, such as number of bans added, retired, and
8446 number of objects tested against ban operations. Only available with Varnish
8447 3.x and above. False by default.
8449 =item B<CollectCache> B<true>|B<false>
8451 Cache hits and misses. True by default.
8453 =item B<CollectConnections> B<true>|B<false>
8455 Number of client connections received, accepted and dropped. True by default.
8457 =item B<CollectDirectorDNS> B<true>|B<false>
8459 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
8462 =item B<CollectESI> B<true>|B<false>
8464 Edge Side Includes (ESI) parse statistics. False by default.
8466 =item B<CollectFetch> B<true>|B<false>
8468 Statistics about fetches (HTTP requests sent to the backend). False by default.
8470 =item B<CollectHCB> B<true>|B<false>
8472 Inserts and look-ups in the crit bit tree based hash. Look-ups are
8473 divided into locked and unlocked look-ups. False by default.
8475 =item B<CollectObjects> B<true>|B<false>
8477 Statistics on cached objects: number of objects expired, nuked (prematurely
8478 expired), saved, moved, etc. False by default.
8480 =item B<CollectPurge> B<true>|B<false>
8482 Statistics about purge operations, such as number of purges added, retired, and
8483 number of objects tested against purge operations. Only available with Varnish
8484 2.x. False by default.
8486 =item B<CollectSession> B<true>|B<false>
8488 Client session statistics. Number of past and current sessions, session herd and
8489 linger counters, etc. False by default. Note that if using Varnish 4.x, some
8490 metrics found in the Connections and Threads sections with previous versions of
8491 Varnish have been moved here.
8493 =item B<CollectSHM> B<true>|B<false>
8495 Statistics about the shared memory log, a memory region to store
8496 log messages which is flushed to disk when full. True by default.
8498 =item B<CollectSMA> B<true>|B<false>
8500 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
8501 component is Solaris specific.
8502 Note: SMA and SMF share counters, enable only the one used by the Varnish
8504 Only available with Varnish 2.x. False by
8507 =item B<CollectSMS> B<true>|B<false>
8509 synth (synthetic content) storage statistics. This storage
8510 component is used internally only. False by default.
8512 =item B<CollectSM> B<true>|B<false>
8514 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
8515 in varnish 4.x. use CollectSMF.
8518 =item B<CollectStruct> B<true>|B<false>
8520 Current varnish internal state statistics. Number of current sessions, objects
8521 in cache store, open connections to backends (with Varnish 2.x), etc. False by
8524 =item B<CollectTotals> B<true>|B<false>
8526 Collects overview counters, such as the number of sessions created,
8527 the number of requests and bytes transferred. False by default.
8529 =item B<CollectUptime> B<true>|B<false>
8531 Varnish uptime. Only available with Varnish 3.x and above. False by default.
8533 =item B<CollectVCL> B<true>|B<false>
8535 Number of total (available + discarded) VCL (config files). False by default.
8537 =item B<CollectVSM> B<true>|B<false>
8539 Collect statistics about Varnish's shared memory usage (used by the logging and
8540 statistics subsystems). Only available with Varnish 4.x. False by default.
8542 =item B<CollectWorkers> B<true>|B<false>
8544 Collect statistics about worker threads. False by default.
8546 =item B<CollectVBE> B<true>|B<false>
8548 Backend counters. Only available with Varnish 4.x. False by default.
8550 =item B<CollectSMF> B<true>|B<false>
8552 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
8553 Note: SMA and SMF share counters, enable only the one used by the Varnish
8555 Used to be called SM in Varnish 2.x. False by default.
8557 =item B<CollectManagement> B<true>|B<false>
8559 Management process counters. Only available with Varnish 4.x. False by default.
8561 =item B<CollectLock> B<true>|B<false>
8563 Lock counters. Only available with Varnish 4.x. False by default.
8565 =item B<CollectMempool> B<true>|B<false>
8567 Memory pool counters. Only available with Varnish 4.x. False by default.
8571 =head2 Plugin C<virt>
8573 This plugin allows CPU, disk, network load and other metrics to be collected for
8574 virtualized guests on the machine. The statistics are collected through libvirt
8575 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
8576 installing any additional software on guests, especially I<collectd>, which runs
8577 only on the host system.
8579 Only I<Connection> is required.
8583 =item B<Connection> I<uri>
8585 Connect to the hypervisor given by I<uri>. For example if using Xen use:
8587 Connection "xen:///"
8589 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
8591 =item B<RefreshInterval> I<seconds>
8593 Refresh the list of domains and devices every I<seconds>. The default is 60
8594 seconds. Setting this to be the same or smaller than the I<Interval> will cause
8595 the list of domains and devices to be refreshed on every iteration.
8597 Refreshing the devices in particular is quite a costly operation, so if your
8598 virtualization setup is static you might consider increasing this. If this
8599 option is set to 0, refreshing is disabled completely.
8601 =item B<Domain> I<name>
8603 =item B<BlockDevice> I<name:dev>
8605 =item B<InterfaceDevice> I<name:dev>
8607 =item B<IgnoreSelected> B<true>|B<false>
8609 Select which domains and devices are collected.
8611 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
8612 disk/network devices are collected.
8614 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
8615 domains and disk/network devices are ignored, while the rest are collected.
8617 The domain name and device names may use a regular expression, if the name is
8618 surrounded by I</.../> and collectd was compiled with support for regexps.
8620 The default is to collect statistics for all domains and all their devices.
8624 BlockDevice "/:hdb/"
8625 IgnoreSelected "true"
8627 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
8630 =item B<BlockDeviceFormat> B<target>|B<source>
8632 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
8633 seen by the guest will be used for reporting metrics.
8634 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
8637 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
8638 using the path of the source, e.g. an image file.
8639 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
8644 If the domain XML have the following device defined:
8646 <disk type='block' device='disk'>
8647 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
8648 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
8649 <target dev='sda' bus='scsi'/>
8651 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
8654 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
8656 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
8657 to C<var_lib_libvirt_images_image1.qcow2>.
8659 =item B<BlockDeviceFormatBasename> B<false>|B<true>
8661 The B<BlockDeviceFormatBasename> controls whether the full path or the
8662 L<basename(1)> of the source is being used as the I<type instance> when
8663 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
8667 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
8668 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
8669 be set to C<var_lib_libvirt_images_image1.qcow2>.
8670 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
8671 set to C<image1.qcow2>.
8673 =item B<HostnameFormat> B<name|uuid|hostname|...>
8675 When the virt plugin logs data, it sets the hostname of the collected data
8676 according to this setting. The default is to use the guest name as provided by
8677 the hypervisor, which is equal to setting B<name>.
8679 B<uuid> means use the guest's UUID. This is useful if you want to track the
8680 same guest across migrations.
8682 B<hostname> means to use the global B<Hostname> setting, which is probably not
8683 useful on its own because all guests will appear to have the same name.
8685 You can also specify combinations of these fields. For example B<name uuid>
8686 means to concatenate the guest name and UUID (with a literal colon character
8687 between, thus I<"foo:1234-1234-1234-1234">).
8689 At the moment of writing (collectd-5.5), hostname string is limited to 62
8690 characters. In case when combination of fields exceeds 62 characters,
8691 hostname will be truncated without a warning.
8693 =item B<InterfaceFormat> B<name>|B<address>
8695 When the virt plugin logs interface data, it sets the name of the collected
8696 data according to this setting. The default is to use the path as provided by
8697 the hypervisor (the "dev" property of the target node), which is equal to
8700 B<address> means use the interface's mac address. This is useful since the
8701 interface path might change between reboots of a guest or across migrations.
8703 =item B<PluginInstanceFormat> B<name|uuid|none>
8705 When the virt plugin logs data, it sets the plugin_instance of the collected
8706 data according to this setting. The default is to not set the plugin_instance.
8708 B<name> means use the guest's name as provided by the hypervisor.
8709 B<uuid> means use the guest's UUID.
8711 You can also specify combinations of the B<name> and B<uuid> fields.
8712 For example B<name uuid> means to concatenate the guest name and UUID
8713 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
8715 =item B<Instances> B<integer>
8717 How many read instances you want to use for this plugin. The default is one,
8718 and the sensible setting is a multiple of the B<ReadThreads> value.
8719 If you are not sure, just use the default setting.
8721 =item B<ExtraStats> B<string>
8723 Report additional extra statistics. The default is no extra statistics, preserving
8724 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
8725 allows the plugin to reported more detailed statistics about the behaviour of
8726 Virtual Machines. The argument is a space-separated list of selectors.
8728 Currently supported selectors are:
8732 =item B<cpu_util>: report CPU utilization per domain in percentage.
8734 =item B<disk>: report extra statistics like number of flush operations and total
8735 service time for read, write and flush operations. Requires libvirt API version
8738 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
8741 =item B<domain_state>: report domain state and reason in human-readable format as
8742 a notification. If libvirt API version I<0.9.2> or later is available, domain
8743 reason will be included in notification.
8745 =item B<fs_info>: report file system information as a notification. Requires
8746 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
8747 is installed and configured inside VM. Make sure that installed I<Guest Agent>
8748 version supports retrieving file system information.
8750 =item B<job_stats_background>: report statistics about progress of a background
8751 job on a domain. Only one type of job statistics can be collected at the same time.
8752 Requires libvirt API version I<1.2.9> or later.
8754 =item B<job_stats_completed>: report statistics about a recently completed job on
8755 a domain. Only one type of job statistics can be collected at the same time.
8756 Requires libvirt API version I<1.2.9> or later.
8758 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
8759 Requires libvirt API version I<0.9.11> or later.
8761 =item B<perf>: report performance monitoring events. To collect performance
8762 metrics they must be enabled for domain and supported by the platform. Requires
8763 libvirt API version I<1.3.3> or later.
8764 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
8766 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
8772 =head2 Plugin C<vmem>
8774 The C<vmem> plugin collects information about the usage of virtual memory.
8775 Since the statistics provided by the Linux kernel are very detailed, they are
8776 collected very detailed. However, to get all the details, you have to switch
8777 them on manually. Most people just want an overview over, such as the number of
8778 pages read from swap space.
8782 =item B<Verbose> B<true>|B<false>
8784 Enables verbose collection of information. This will start collecting page
8785 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
8786 Part of these statistics are collected on a "per zone" basis.
8790 =head2 Plugin C<vserver>
8792 This plugin doesn't have any options. B<VServer> support is only available for
8793 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
8794 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
8795 need to apply the patches and compile your own kernel, which will then provide
8796 the F</proc/virtual> filesystem that is required by this plugin.
8798 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
8800 B<Note>: The traffic collected by this plugin accounts for the amount of
8801 traffic passing a socket which might be a lot less than the actual on-wire
8802 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
8803 collect on-wire traffic you could, for example, use the logging facilities of
8804 iptables to feed data for the guest IPs into the iptables plugin.
8806 =head2 Plugin C<write_graphite>
8808 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
8809 storage and graphing project. The plugin connects to I<Carbon>, the data layer
8810 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
8811 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
8812 of at most 1428 bytes to minimize the number of network packets.
8816 <Plugin write_graphite>
8826 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8827 blocks. Inside the B<Node> blocks, the following options are recognized:
8831 =item B<Host> I<Address>
8833 Hostname or address to connect to. Defaults to C<localhost>.
8835 =item B<Port> I<Service>
8837 Service name or port number to connect to. Defaults to C<2003>.
8839 =item B<Protocol> I<String>
8841 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
8843 =item B<ReconnectInterval> I<Seconds>
8845 When set to non-zero, forces the connection to the Graphite backend to be
8846 closed and re-opend periodically. This behavior is desirable in environments
8847 where the connection to the Graphite backend is done through load balancers,
8848 for example. When set to zero, the default, the connetion is kept open for as
8851 =item B<LogSendErrors> B<false>|B<true>
8853 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
8854 If set to B<false>, it will not log the errors. This is especially useful when
8855 using Protocol UDP since many times we want to use the "fire-and-forget"
8856 approach and logging errors fills syslog with unneeded messages.
8858 =item B<Prefix> I<String>
8860 When set, I<String> is added in front of the host name. Dots and whitespace are
8861 I<not> escaped in this string (see B<EscapeCharacter> below).
8863 =item B<Postfix> I<String>
8865 When set, I<String> is appended to the host name. Dots and whitespace are
8866 I<not> escaped in this string (see B<EscapeCharacter> below).
8868 =item B<EscapeCharacter> I<Char>
8870 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
8871 in the identifier. The B<EscapeCharacter> option determines which character
8872 dots, whitespace and control characters are replaced with. Defaults to
8875 =item B<StoreRates> B<false>|B<true>
8877 If set to B<true> (the default), convert counter values to rates. If set to
8878 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
8881 =item B<SeparateInstances> B<false>|B<true>
8883 If set to B<true>, the plugin instance and type instance will be in their own
8884 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
8885 default), the plugin and plugin instance (and likewise the type and type
8886 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
8888 =item B<AlwaysAppendDS> B<false>|B<true>
8890 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
8891 identifier. If set to B<false> (the default), this is only done when there is
8894 =item B<PreserveSeparator> B<false>|B<true>
8896 If set to B<false> (the default) the C<.> (dot) character is replaced with
8897 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
8898 is preserved, i.e. passed through.
8900 =item B<DropDuplicateFields> B<false>|B<true>
8902 If set to B<true>, detect and remove duplicate components in Graphite metric
8903 names. For example, the metric name C<host.load.load.shortterm> will
8904 be shortened to C<host.load.shortterm>.
8908 =head2 Plugin C<write_log>
8910 The C<write_log> plugin writes metrics as INFO log messages.
8912 This plugin supports two output formats: I<Graphite> and I<JSON>.
8922 =item B<Format> I<Format>
8924 The output format to use. Can be one of C<Graphite> or C<JSON>.
8928 =head2 Plugin C<write_tsdb>
8930 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
8931 time series database. The plugin connects to a I<TSD>, a masterless, no shared
8932 state daemon that ingests metrics and stores them in HBase. The plugin uses
8933 I<TCP> over the "line based" protocol with a default port 4242. The data will
8934 be sent in blocks of at most 1428 bytes to minimize the number of network
8943 Host "tsd-1.my.domain"
8945 HostTags "status=production"
8949 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
8950 blocks and global directives.
8952 Global directives are:
8956 =item B<ResolveInterval> I<seconds>
8958 =item B<ResolveJitter> I<seconds>
8960 When I<collectd> connects to a TSDB node, it will request the hostname from
8961 DNS. This can become a problem if the TSDB node is unavailable or badly
8962 configured because collectd will request DNS in order to reconnect for every
8963 metric, which can flood your DNS. So you can cache the last value for
8964 I<ResolveInterval> seconds.
8965 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8967 You can also define a jitter, a random interval to wait in addition to
8968 I<ResolveInterval>. This prevents all your collectd servers to resolve the
8969 hostname at the same time when the connection fails.
8970 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
8972 B<Note:> If the DNS resolution has already been successful when the socket
8973 closes, the plugin will try to reconnect immediately with the cached
8974 information. DNS is queried only when the socket is closed for a longer than
8975 I<ResolveInterval> + I<ResolveJitter> seconds.
8979 Inside the B<Node> blocks, the following options are recognized:
8983 =item B<Host> I<Address>
8985 Hostname or address to connect to. Defaults to C<localhost>.
8987 =item B<Port> I<Service>
8989 Service name or port number to connect to. Defaults to C<4242>.
8992 =item B<HostTags> I<String>
8994 When set, I<HostTags> is added to the end of the metric. It is intended to be
8995 used for name=value pairs that the TSD will tag the metric with. Dots and
8996 whitespace are I<not> escaped in this string.
8998 =item B<StoreRates> B<false>|B<true>
9000 If set to B<true>, convert counter values to rates. If set to B<false>
9001 (the default) counter values are stored as is, as an increasing
9004 =item B<AlwaysAppendDS> B<false>|B<true>
9006 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9007 identifier. If set to B<false> (the default), this is only done when there is
9012 =head2 Plugin C<write_mongodb>
9014 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9019 <Plugin "write_mongodb">
9028 The plugin can send values to multiple instances of I<MongoDB> by specifying
9029 one B<Node> block for each instance. Within the B<Node> blocks, the following
9030 options are available:
9034 =item B<Host> I<Address>
9036 Hostname or address to connect to. Defaults to C<localhost>.
9038 =item B<Port> I<Service>
9040 Service name or port number to connect to. Defaults to C<27017>.
9042 =item B<Timeout> I<Milliseconds>
9044 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9045 Setting this option to zero means no timeout, which is the default.
9047 =item B<StoreRates> B<false>|B<true>
9049 If set to B<true> (the default), convert counter values to rates. If set to
9050 B<false> counter values are stored as is, i.e. as an increasing integer
9053 =item B<Database> I<Database>
9055 =item B<User> I<User>
9057 =item B<Password> I<Password>
9059 Sets the information used when authenticating to a I<MongoDB> database. The
9060 fields are optional (in which case no authentication is attempted), but if you
9061 want to use authentication all three fields must be set.
9065 =head2 Plugin C<write_prometheus>
9067 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9068 using I<Prometheus>.
9074 =item B<Port> I<Port>
9076 Port the embedded webserver should listen on. Defaults to B<9103>.
9078 =item B<StalenessDelta> I<Seconds>
9080 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9081 hasn't seen any update for it. This value must match the setting in Prometheus.
9082 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9086 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9087 which time a metric without updates is considered "stale". This setting
9088 effectively puts an upper limit on the interval in which metrics are reported.
9090 When the I<write_prometheus plugin> encounters a metric with an interval
9091 exceeding this limit, it will inform you, the user, and provide the metric to
9092 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9093 metric "fresh" each time it is scraped, with the time of the scrape being
9094 considered the time of the update. The result is that there appear more
9095 datapoints in I<Prometheus> than were actually created, but at least the metric
9096 doesn't disappear periodically.
9100 =head2 Plugin C<write_http>
9102 This output plugin submits values to an HTTP server using POST requests and
9103 encoding metrics with JSON or using the C<PUTVAL> command described in
9104 L<collectd-unixsock(5)>.
9108 <Plugin "write_http">
9110 URL "http://example.com/post-collectd"
9117 The plugin can send values to multiple HTTP servers by specifying one
9118 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9119 block, the following options are available:
9125 URL to which the values are submitted to. Mandatory.
9127 =item B<User> I<Username>
9129 Optional user name needed for authentication.
9131 =item B<Password> I<Password>
9133 Optional password needed for authentication.
9135 =item B<VerifyPeer> B<true>|B<false>
9137 Enable or disable peer SSL certificate verification. See
9138 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9140 =item B<VerifyHost> B<true|false>
9142 Enable or disable peer host name verification. If enabled, the plugin checks if
9143 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9144 matches the host name provided by the B<URL> option. If this identity check
9145 fails, the connection is aborted. Obviously, only works when connecting to a
9146 SSL enabled server. Enabled by default.
9148 =item B<CACert> I<File>
9150 File that holds one or more SSL certificates. If you want to use HTTPS you will
9151 possibly need this option. What CA certificates come bundled with C<libcurl>
9152 and are checked by default depends on the distribution you use.
9154 =item B<CAPath> I<Directory>
9156 Directory holding one or more CA certificate files. You can use this if for
9157 some reason all the needed CA certificates aren't in the same file and can't be
9158 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9161 =item B<ClientKey> I<File>
9163 File that holds the private key in PEM format to be used for certificate-based
9166 =item B<ClientCert> I<File>
9168 File that holds the SSL certificate to be used for certificate-based
9171 =item B<ClientKeyPass> I<Password>
9173 Password required to load the private key in B<ClientKey>.
9175 =item B<Header> I<Header>
9177 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9179 Header "X-Custom-Header: custom_value"
9181 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9183 Define which SSL protocol version must be used. By default C<libcurl> will
9184 attempt to figure out the remote SSL protocol version. See
9185 L<curl_easy_setopt(3)> for more details.
9187 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9189 Format of the output to generate. If set to B<Command>, will create output that
9190 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9191 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9192 , will create output in the KairosDB format.
9194 Defaults to B<Command>.
9196 =item B<Attribute> I<String> I<String>
9198 Only available for the KAIROSDB output format.
9200 Consider the two given strings to be the key and value of an additional tag for
9201 each metric being sent out.
9203 You can add multiple B<Attribute>.
9207 Only available for the KAIROSDB output format.
9209 Sets the Cassandra ttl for the data points.
9211 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9213 =item B<Metrics> B<true>|B<false>
9215 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9217 =item B<Notifications> B<false>|B<true>
9219 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9221 =item B<StoreRates> B<true|false>
9223 If set to B<true>, convert counter values to rates. If set to B<false> (the
9224 default) counter values are stored as is, i.e. as an increasing integer number.
9226 =item B<BufferSize> I<Bytes>
9228 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9229 requests will be generated, but more metrics will be batched / metrics are
9230 cached for longer before being sent, introducing additional delay until they
9231 are available on the server side. I<Bytes> must be at least 1024 and cannot
9232 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9233 Defaults to C<4096>.
9235 =item B<LowSpeedLimit> I<Bytes per Second>
9237 Sets the minimal transfer rate in I<Bytes per Second> below which the
9238 connection with the HTTP server will be considered too slow and aborted. All
9239 the data submitted over this connection will probably be lost. Defaults to 0,
9240 which means no minimum transfer rate is enforced.
9242 =item B<Timeout> I<Timeout>
9244 Sets the maximum time in milliseconds given for HTTP POST operations to
9245 complete. When this limit is reached, the POST operation will be aborted, and
9246 all the data in the current send buffer will probably be lost. Defaults to 0,
9247 which means the connection never times out.
9249 =item B<LogHttpError> B<false>|B<true>
9251 Enables printing of HTTP error code to log. Turned off by default.
9253 The C<write_http> plugin regularly submits the collected values to the HTTP
9254 server. How frequently this happens depends on how much data you are collecting
9255 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9256 slightly below this interval, which you can estimate by monitoring the network
9257 traffic between collectd and the HTTP server.
9261 =head2 Plugin C<write_kafka>
9263 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9267 <Plugin "write_kafka">
9268 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9274 The following options are understood by the I<write_kafka plugin>:
9278 =item E<lt>B<Topic> I<Name>E<gt>
9280 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9281 is given a unique I<Name> and specifies one kafka producer.
9282 Inside the B<Topic> block, the following per-topic options are
9287 =item B<Property> I<String> I<String>
9289 Configure the named property for the current topic. Properties are
9290 forwarded to the kafka producer library B<librdkafka>.
9292 =item B<Key> I<String>
9294 Use the specified string as a partitioning key for the topic. Kafka breaks
9295 topic into partitions and guarantees that for a given topology, the same
9296 consumer will be used for a specific key. The special (case insensitive)
9297 string B<Random> can be used to specify that an arbitrary partition should
9300 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9302 Selects the format in which messages are sent to the broker. If set to
9303 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9304 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9306 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9307 an easy and straight forward exchange format.
9309 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9310 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9312 =item B<StoreRates> B<true>|B<false>
9314 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9315 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9316 default), no conversion is performed. Otherwise the conversion is performed
9317 using the internal value cache.
9319 Please note that currently this option is only used if the B<Format> option has
9320 been set to B<JSON>.
9322 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
9324 A prefix can be added in the metric name when outputting in the I<Graphite>
9325 format. It's added before the I<Host> name.
9327 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>>
9329 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
9331 A postfix can be added in the metric name when outputting in the I<Graphite>
9332 format. It's added after the I<Host> name.
9334 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>>
9336 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
9338 Specify a character to replace dots (.) in the host part of the metric name.
9339 In I<Graphite> metric name, dots are used as separators between different
9340 metric parts (host, plugin, type).
9341 Default is C<_> (I<Underscore>).
9343 =item B<GraphiteSeparateInstances> B<false>|B<true>
9345 If set to B<true>, the plugin instance and type instance will be in their own
9346 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9347 default), the plugin and plugin instance (and likewise the type and type
9348 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9350 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
9352 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9353 identifier. If set to B<false> (the default), this is only done when there is
9356 =item B<GraphitePreserveSeparator> B<false>|B<true>
9358 If set to B<false> (the default) the C<.> (dot) character is replaced with
9359 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
9360 is preserved, i.e. passed through.
9362 =item B<StoreRates> B<true>|B<false>
9364 If set to B<true> (the default), convert counter values to rates. If set to
9365 B<false> counter values are stored as is, i.e. as an increasing integer number.
9367 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9368 converted values will have "rate" appended to the data source type, e.g.
9369 C<ds_type:derive:rate>.
9373 =item B<Property> I<String> I<String>
9375 Configure the kafka producer through properties, you almost always will
9376 want to set B<metadata.broker.list> to your Kafka broker list.
9380 =head2 Plugin C<write_redis>
9382 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
9386 <Plugin "write_redis">
9399 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
9400 the timestamp as the score. Retrieving a date range can then be done using the
9401 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
9402 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
9403 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
9404 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
9405 with the B<Database> parameter (default is C<0>). See
9406 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
9409 The information shown in the synopsis above is the I<default configuration>
9410 which is used by the plugin if no configuration is present.
9412 The plugin can send values to multiple instances of I<Redis> by specifying
9413 one B<Node> block for each instance. Within the B<Node> blocks, the following
9414 options are available:
9418 =item B<Node> I<Nodename>
9420 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
9421 instance running on a specified host and port. The node name is a
9422 canonical identifier which is used as I<plugin instance>. It is limited to
9423 51E<nbsp>characters in length.
9425 =item B<Host> I<Hostname>
9427 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
9430 =item B<Port> I<Port>
9432 The B<Port> option is the TCP port on which the Redis instance accepts
9433 connections. Either a service name of a port number may be given. Please note
9434 that numerical port numbers must be given as a string, too.
9436 =item B<Timeout> I<Milliseconds>
9438 The B<Timeout> option sets the socket connection timeout, in milliseconds.
9440 =item B<Prefix> I<Prefix>
9442 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
9443 containing all metrics. Defaults to C<collectd/>, so metrics will have names
9444 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
9445 is recommended but not required to include a trailing slash in I<Prefix>.
9447 =item B<Database> I<Index>
9449 This index selects the redis database to use for writing operations. Defaults
9452 =item B<MaxSetSize> I<Items>
9454 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
9455 hold. Negative values for I<Items> sets no limit, which is the default behavior.
9457 =item B<MaxSetDuration> I<Seconds>
9459 The B<MaxSetDuration> option limits the duration of items that the
9460 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
9461 is the default behavior.
9463 =item B<StoreRates> B<true>|B<false>
9465 If set to B<true> (the default), convert counter values to rates. If set to
9466 B<false> counter values are stored as is, i.e. as an increasing integer number.
9470 =head2 Plugin C<write_riemann>
9472 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
9473 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
9474 I<Riemann> using UDP packets.
9478 <Plugin "write_riemann">
9484 AlwaysAppendDS false
9488 Attribute "foo" "bar"
9491 The following options are understood by the I<write_riemann plugin>:
9495 =item E<lt>B<Node> I<Name>E<gt>
9497 The plugin's configuration consists of one or more B<Node> blocks. Each block
9498 is given a unique I<Name> and specifies one connection to an instance of
9499 I<Riemann>. Indise the B<Node> block, the following per-connection options are
9504 =item B<Host> I<Address>
9506 Hostname or address to connect to. Defaults to C<localhost>.
9508 =item B<Port> I<Service>
9510 Service name or port number to connect to. Defaults to C<5555>.
9512 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
9514 Specify the protocol to use when communicating with I<Riemann>. Defaults to
9517 =item B<TLSCertFile> I<Path>
9519 When using the B<TLS> protocol, path to a PEM certificate to present
9522 =item B<TLSCAFile> I<Path>
9524 When using the B<TLS> protocol, path to a PEM CA certificate to
9525 use to validate the remote hosts's identity.
9527 =item B<TLSKeyFile> I<Path>
9529 When using the B<TLS> protocol, path to a PEM private key associated
9530 with the certificate defined by B<TLSCertFile>.
9532 =item B<Batch> B<true>|B<false>
9534 If set to B<true> and B<Protocol> is set to B<TCP>,
9535 events will be batched in memory and flushed at
9536 regular intervals or when B<BatchMaxSize> is exceeded.
9538 Notifications are not batched and sent as soon as possible.
9540 When enabled, it can occur that events get processed by the Riemann server
9541 close to or after their expiration time. Tune the B<TTLFactor> and
9542 B<BatchMaxSize> settings according to the amount of values collected, if this
9547 =item B<BatchMaxSize> I<size>
9549 Maximum payload size for a riemann packet. Defaults to 8192
9551 =item B<BatchFlushTimeout> I<seconds>
9553 Maximum amount of seconds to wait in between to batch flushes.
9554 No timeout by default.
9556 =item B<StoreRates> B<true>|B<false>
9558 If set to B<true> (the default), convert counter values to rates. If set to
9559 B<false> counter values are stored as is, i.e. as an increasing integer number.
9561 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
9562 converted values will have "rate" appended to the data source type, e.g.
9563 C<ds_type:derive:rate>.
9565 =item B<AlwaysAppendDS> B<false>|B<true>
9567 If set to B<true>, append the name of the I<Data Source> (DS) to the
9568 "service", i.e. the field that, together with the "host" field, uniquely
9569 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
9570 only done when there is more than one DS.
9572 =item B<TTLFactor> I<Factor>
9574 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
9575 event is considered active. I<collectd> populates this field based on the
9576 metrics interval setting. This setting controls the factor with which the
9577 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
9578 know exactly what you're doing, you should only increase this setting from its
9581 =item B<Notifications> B<false>|B<true>
9583 If set to B<true>, create riemann events for notifications. This is B<true>
9584 by default. When processing thresholds from write_riemann, it might prove
9585 useful to avoid getting notification events.
9587 =item B<CheckThresholds> B<false>|B<true>
9589 If set to B<true>, attach state to events based on thresholds defined
9590 in the B<Threshold> plugin. Defaults to B<false>.
9592 =item B<EventServicePrefix> I<String>
9594 Add the given string as a prefix to the event service name.
9595 If B<EventServicePrefix> not set or set to an empty string (""),
9596 no prefix will be used.
9600 =item B<Tag> I<String>
9602 Add the given string as an additional tag to the metric being sent to
9605 =item B<Attribute> I<String> I<String>
9607 Consider the two given strings to be the key and value of an additional
9608 attribute for each metric being sent out to I<Riemann>.
9612 =head2 Plugin C<write_sensu>
9614 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
9615 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
9616 a local I<Sensu> client using a TCP socket.
9618 At the moment, the I<write_sensu plugin> does not send over a collectd_host
9619 parameter so it is not possible to use one collectd instance as a gateway for
9620 others. Each collectd host must pair with one I<Sensu> client.
9624 <Plugin "write_sensu">
9629 AlwaysAppendDS false
9630 MetricHandler "influx"
9631 MetricHandler "default"
9632 NotificationHandler "flapjack"
9633 NotificationHandler "howling_monkey"
9637 Attribute "foo" "bar"
9640 The following options are understood by the I<write_sensu plugin>:
9644 =item E<lt>B<Node> I<Name>E<gt>
9646 The plugin's configuration consists of one or more B<Node> blocks. Each block
9647 is given a unique I<Name> and specifies one connection to an instance of
9648 I<Sensu>. Inside the B<Node> block, the following per-connection options are
9653 =item B<Host> I<Address>
9655 Hostname or address to connect to. Defaults to C<localhost>.
9657 =item B<Port> I<Service>
9659 Service name or port number to connect to. Defaults to C<3030>.
9661 =item B<StoreRates> B<true>|B<false>
9663 If set to B<true> (the default), convert counter values to rates. If set to
9664 B<false> counter values are stored as is, i.e. as an increasing integer number.
9666 This will be reflected in the C<collectd_data_source_type> tag: If
9667 B<StoreRates> is enabled, converted values will have "rate" appended to the
9668 data source type, e.g. C<collectd_data_source_type:derive:rate>.
9670 =item B<AlwaysAppendDS> B<false>|B<true>
9672 If set the B<true>, append the name of the I<Data Source> (DS) to the
9673 "service", i.e. the field that, together with the "host" field, uniquely
9674 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
9675 only done when there is more than one DS.
9677 =item B<Notifications> B<false>|B<true>
9679 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
9680 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9682 =item B<Metrics> B<false>|B<true>
9684 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
9685 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
9688 =item B<Separator> I<String>
9690 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
9692 =item B<MetricHandler> I<String>
9694 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
9695 several of them, one per line. Defaults to no handler.
9697 =item B<NotificationHandler> I<String>
9699 Add a handler that will be set when notifications are sent to I<Sensu>. You can
9700 add several of them, one per line. Defaults to no handler.
9702 =item B<EventServicePrefix> I<String>
9704 Add the given string as a prefix to the event service name.
9705 If B<EventServicePrefix> not set or set to an empty string (""),
9706 no prefix will be used.
9710 =item B<Tag> I<String>
9712 Add the given string as an additional tag to the metric being sent to
9715 =item B<Attribute> I<String> I<String>
9717 Consider the two given strings to be the key and value of an additional
9718 attribute for each metric being sent out to I<Sensu>.
9722 =head2 Plugin C<xencpu>
9724 This plugin collects metrics of hardware CPU load for machine running Xen
9725 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
9726 Result is reported using the C<percent> type, for each CPU (core).
9728 This plugin doesn't have any options (yet).
9730 =head2 Plugin C<zookeeper>
9732 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
9733 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
9738 <Plugin "zookeeper">
9745 =item B<Host> I<Address>
9747 Hostname or address to connect to. Defaults to C<localhost>.
9749 =item B<Port> I<Service>
9751 Service name or port number to connect to. Defaults to C<2181>.
9755 =head1 THRESHOLD CONFIGURATION
9757 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
9758 we mean that the values are not only stored or sent somewhere, but that they
9759 are judged and, if a problem is recognized, acted upon. The only action
9760 collectd takes itself is to generate and dispatch a "notification". Plugins can
9761 register to receive notifications and perform appropriate further actions.
9763 Since systems and what you expect them to do differ a lot, you can configure
9764 B<thresholds> for your values freely. This gives you a lot of flexibility but
9765 also a lot of responsibility.
9767 Every time a value is out of range a notification is dispatched. This means
9768 that the idle percentage of your CPU needs to be less then the configured
9769 threshold only once for a notification to be generated. There's no such thing
9770 as a moving average or similar - at least not now.
9772 Also, all values that match a threshold are considered to be relevant or
9773 "interesting". As a consequence collectd will issue a notification if they are
9774 not received for B<Timeout> iterations. The B<Timeout> configuration option is
9775 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
9776 "2" (the default) and some hosts sends it's CPU statistics to the server every
9777 60 seconds, a notification will be dispatched after about 120 seconds. It may
9778 take a little longer because the timeout is checked only once each B<Interval>
9781 When a value comes within range again or is received after it was missing, an
9782 "OKAY-notification" is dispatched.
9784 Here is a configuration example to get you started. Read below for more
9797 <Plugin "interface">
9814 WarningMin 100000000
9820 There are basically two types of configuration statements: The C<Host>,
9821 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
9822 configured. The C<Plugin> and C<Type> blocks may be specified further using the
9823 C<Instance> option. You can combine the block by nesting the blocks, though
9824 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
9825 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
9826 C<Type> may not contain other blocks. If multiple blocks apply to the same
9827 value the most specific block is used.
9829 The other statements specify the threshold to configure. They B<must> be
9830 included in a C<Type> block. Currently the following statements are recognized:
9834 =item B<FailureMax> I<Value>
9836 =item B<WarningMax> I<Value>
9838 Sets the upper bound of acceptable values. If unset defaults to positive
9839 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
9840 will be created. If the value is greater than B<WarningMax> but less than (or
9841 equal to) B<FailureMax> a B<WARNING> notification will be created.
9843 =item B<FailureMin> I<Value>
9845 =item B<WarningMin> I<Value>
9847 Sets the lower bound of acceptable values. If unset defaults to negative
9848 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
9849 be created. If the value is less than B<WarningMin> but greater than (or equal
9850 to) B<FailureMin> a B<WARNING> notification will be created.
9852 =item B<DataSource> I<DSName>
9854 Some data sets have more than one "data source". Interesting examples are the
9855 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
9856 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
9857 system load data set, C<load>, even has three data sources: C<shortterm>,
9858 C<midterm>, and C<longterm>.
9860 Normally, all data sources are checked against a configured threshold. If this
9861 is undesirable, or if you want to specify different limits for each data
9862 source, you can use the B<DataSource> option to have a threshold apply only to
9865 =item B<Invert> B<true>|B<false>
9867 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
9868 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
9869 B<WarningMax>) are not okay. Defaults to B<false>.
9871 =item B<Persist> B<true>|B<false>
9873 Sets how often notifications are generated. If set to B<true> one notification
9874 will be generated for each value that is out of the acceptable range. If set to
9875 B<false> (the default) then a notification is only generated if a value is out
9876 of range but the previous value was okay.
9878 This applies to missing values, too: If set to B<true> a notification about a
9879 missing value is generated once every B<Interval> seconds. If set to B<false>
9880 only one such notification is generated until the value appears again.
9882 =item B<Percentage> B<true>|B<false>
9884 If set to B<true>, the minimum and maximum values given are interpreted as
9885 percentage value, relative to the other data sources. This is helpful for
9886 example for the "df" type, where you may want to issue a warning when less than
9887 5E<nbsp>% of the total space is available. Defaults to B<false>.
9889 =item B<Hits> I<Number>
9891 Delay creating the notification until the threshold has been passed I<Number>
9892 times. When a notification has been generated, or when a subsequent value is
9893 inside the threshold, the counter is reset. If, for example, a value is
9894 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
9895 will be dispatched at most once every 30E<nbsp>seconds.
9897 This is useful when short bursts are not a problem. If, for example, 100% CPU
9898 usage for up to a minute is normal (and data is collected every
9899 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
9901 =item B<Hysteresis> I<Number>
9903 When set to non-zero, a hysteresis value is applied when checking minimum and
9904 maximum bounds. This is useful for values that increase slowly and fluctuate a
9905 bit while doing so. When these values come close to the threshold, they may
9906 "flap", i.e. switch between failure / warning case and okay case repeatedly.
9908 If, for example, the threshold is configures as
9913 then a I<Warning> notification is created when the value exceeds I<101> and the
9914 corresponding I<Okay> notification is only created once the value falls below
9915 I<99>, thus avoiding the "flapping".
9919 =head1 FILTER CONFIGURATION
9921 Starting with collectd 4.6 there is a powerful filtering infrastructure
9922 implemented in the daemon. The concept has mostly been copied from
9923 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
9924 terminology, so that users that are familiar with iptables feel right at home.
9928 The following are the terms used in the remainder of the filter configuration
9929 documentation. For an ASCII-art schema of the mechanism, see
9930 L<"General structure"> below.
9936 A I<match> is a criteria to select specific values. Examples are, of course, the
9937 name of the value or it's current value.
9939 Matches are implemented in plugins which you have to load prior to using the
9940 match. The name of such plugins starts with the "match_" prefix.
9944 A I<target> is some action that is to be performed with data. Such actions
9945 could, for example, be to change part of the value's identifier or to ignore
9946 the value completely.
9948 Some of these targets are built into the daemon, see L<"Built-in targets">
9949 below. Other targets are implemented in plugins which you have to load prior to
9950 using the target. The name of such plugins starts with the "target_" prefix.
9954 The combination of any number of matches and at least one target is called a
9955 I<rule>. The target actions will be performed for all values for which B<all>
9956 matches apply. If the rule does not have any matches associated with it, the
9957 target action will be performed for all values.
9961 A I<chain> is a list of rules and possibly default targets. The rules are tried
9962 in order and if one matches, the associated target will be called. If a value
9963 is handled by a rule, it depends on the target whether or not any subsequent
9964 rules are considered or if traversal of the chain is aborted, see
9965 L<"Flow control"> below. After all rules have been checked, the default targets
9970 =head2 General structure
9972 The following shows the resulting structure:
9979 +---------+ +---------+ +---------+ +---------+
9980 ! Rule !->! Match !->! Match !->! Target !
9981 +---------+ +---------+ +---------+ +---------+
9984 +---------+ +---------+ +---------+
9985 ! Rule !->! Target !->! Target !
9986 +---------+ +---------+ +---------+
9993 +---------+ +---------+ +---------+
9994 ! Rule !->! Match !->! Target !
9995 +---------+ +---------+ +---------+
10003 =head2 Flow control
10005 There are four ways to control which way a value takes through the filter
10012 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10013 process the value with another chain. When the called chain finishes, usually
10014 the next target or rule after the jump is executed.
10018 The stop condition, signaled for example by the built-in target B<stop>, causes
10019 all processing of the value to be stopped immediately.
10023 Causes processing in the current chain to be aborted, but processing of the
10024 value generally will continue. This means that if the chain was called via
10025 B<Jump>, the next target or rule after the jump will be executed. If the chain
10026 was not called by another chain, control will be returned to the daemon and it
10027 may pass the value to another chain.
10031 Most targets will signal the B<continue> condition, meaning that processing
10032 should continue normally. There is no special built-in target for this
10039 The configuration reflects this structure directly:
10041 PostCacheChain "PostCache"
10042 <Chain "PostCache">
10043 <Rule "ignore_mysql_show">
10046 Type "^mysql_command$"
10047 TypeInstance "^show_"
10057 The above configuration example will ignore all values where the plugin field
10058 is "mysql", the type is "mysql_command" and the type instance begins with
10059 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10060 default target of the chain. Since this chain is run after the value has been
10061 added to the cache, the MySQL C<show_*> command statistics will be available
10062 via the C<unixsock> plugin.
10064 =head2 List of configuration options
10068 =item B<PreCacheChain> I<ChainName>
10070 =item B<PostCacheChain> I<ChainName>
10072 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10073 argument is the name of a I<chain> that should be executed before and/or after
10074 the values have been added to the cache.
10076 To understand the implications, it's important you know what is going on inside
10077 I<collectd>. The following diagram shows how values are passed from the
10078 read-plugins to the write-plugins:
10084 + - - - - V - - - - +
10085 : +---------------+ :
10088 : +-------+-------+ :
10091 : +-------+-------+ : +---------------+
10092 : ! Cache !--->! Value Cache !
10093 : ! insert ! : +---+---+-------+
10094 : +-------+-------+ : ! !
10095 : ! ,------------' !
10097 : +-------+---+---+ : +-------+-------+
10098 : ! Post-Cache +--->! Write-Plugins !
10099 : ! Chain ! : +---------------+
10100 : +---------------+ :
10102 : dispatch values :
10103 + - - - - - - - - - +
10105 After the values are passed from the "read" plugins to the dispatch functions,
10106 the pre-cache chain is run first. The values are added to the internal cache
10107 afterwards. The post-cache chain is run after the values have been added to the
10108 cache. So why is it such a huge deal if chains are run before or after the
10109 values have been added to this cache?
10111 Targets that change the identifier of a value list should be executed before
10112 the values are added to the cache, so that the name in the cache matches the
10113 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10114 this cache to receive a list of all available values. If you change the
10115 identifier after the value list has been added to the cache, this may easily
10116 lead to confusion, but it's not forbidden of course.
10118 The cache is also used to convert counter values to rates. These rates are, for
10119 example, used by the C<value> match (see below). If you use the rate stored in
10120 the cache B<before> the new value is added, you will use the old, B<previous>
10121 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10122 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10125 Last but not last, the B<stop> target makes a difference: If the pre-cache
10126 chain returns the stop condition, the value will not be added to the cache and
10127 the post-cache chain will not be run.
10129 =item B<Chain> I<Name>
10131 Adds a new chain with a certain name. This name can be used to refer to a
10132 specific chain, for example to jump to it.
10134 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10136 =item B<Rule> [I<Name>]
10138 Adds a new rule to the current chain. The name of the rule is optional and
10139 currently has no meaning for the daemon.
10141 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10142 must be at least one B<Target> block.
10144 =item B<Match> I<Name>
10146 Adds a match to a B<Rule> block. The name specifies what kind of match should
10147 be performed. Available matches depend on the plugins that have been loaded.
10149 The arguments inside the B<Match> block are passed to the plugin implementing
10150 the match, so which arguments are valid here depends on the plugin being used.
10151 If you do not need any to pass any arguments to a match, you can use the
10156 Which is equivalent to:
10161 =item B<Target> I<Name>
10163 Add a target to a rule or a default target to a chain. The name specifies what
10164 kind of target is to be added. Which targets are available depends on the
10165 plugins being loaded.
10167 The arguments inside the B<Target> block are passed to the plugin implementing
10168 the target, so which arguments are valid here depends on the plugin being used.
10169 If you do not need any to pass any arguments to a target, you can use the
10174 This is the same as writing:
10181 =head2 Built-in targets
10183 The following targets are built into the core daemon and therefore need no
10184 plugins to be loaded:
10190 Signals the "return" condition, see the L<"Flow control"> section above. This
10191 causes the current chain to stop processing the value and returns control to
10192 the calling chain. The calling chain will continue processing targets and rules
10193 just after the B<jump> target (see below). This is very similar to the
10194 B<RETURN> target of iptables, see L<iptables(8)>.
10196 This target does not have any options.
10204 Signals the "stop" condition, see the L<"Flow control"> section above. This
10205 causes processing of the value to be aborted immediately. This is similar to
10206 the B<DROP> target of iptables, see L<iptables(8)>.
10208 This target does not have any options.
10216 Sends the value to "write" plugins.
10222 =item B<Plugin> I<Name>
10224 Name of the write plugin to which the data should be sent. This option may be
10225 given multiple times to send the data to more than one write plugin. If the
10226 plugin supports multiple instances, the plugin's instance(s) must also be
10231 If no plugin is explicitly specified, the values will be sent to all available
10234 Single-instance plugin example:
10240 Multi-instance plugin example:
10242 <Plugin "write_graphite">
10252 Plugin "write_graphite/foo"
10257 Starts processing the rules of another chain, see L<"Flow control"> above. If
10258 the end of that chain is reached, or a stop condition is encountered,
10259 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
10260 next target or the next rule. This is similar to the B<-j> command line option
10261 of iptables, see L<iptables(8)>.
10267 =item B<Chain> I<Name>
10269 Jumps to the chain I<Name>. This argument is required and may appear only once.
10281 =head2 Available matches
10287 Matches a value using regular expressions.
10293 =item B<Host> I<Regex>
10295 =item B<Plugin> I<Regex>
10297 =item B<PluginInstance> I<Regex>
10299 =item B<Type> I<Regex>
10301 =item B<TypeInstance> I<Regex>
10303 =item B<MetaData> I<String> I<Regex>
10305 Match values where the given regular expressions match the various fields of
10306 the identifier of a value. If multiple regular expressions are given, B<all>
10307 regexen must match for a value to match.
10309 =item B<Invert> B<false>|B<true>
10311 When set to B<true>, the result of the match is inverted, i.e. all value lists
10312 where all regular expressions apply are not matched, all other value lists are
10313 matched. Defaults to B<false>.
10320 Host "customer[0-9]+"
10326 Matches values that have a time which differs from the time on the server.
10328 This match is mainly intended for servers that receive values over the
10329 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
10330 is very sensitive to the timestamp used when updating the RRD files. In
10331 particular, the time must be ever increasing. If a misbehaving client sends one
10332 packet with a timestamp far in the future, all further packets with a correct
10333 time will be ignored because of that one packet. What's worse, such corrupted
10334 RRD files are hard to fix.
10336 This match lets one match all values B<outside> a specified time range
10337 (relative to the server's time), so you can use the B<stop> target (see below)
10338 to ignore the value, for example.
10344 =item B<Future> I<Seconds>
10346 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
10347 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10350 =item B<Past> I<Seconds>
10352 Matches all values that are I<behind> of the server's time by I<Seconds> or
10353 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
10365 This example matches all values that are five minutes or more ahead of the
10366 server or one hour (or more) lagging behind.
10370 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
10371 values. If a data-set consists of more than one data-source, all data-sources
10372 must match the specified ranges for a positive match.
10378 =item B<Min> I<Value>
10380 Sets the smallest value which still results in a match. If unset, behaves like
10383 =item B<Max> I<Value>
10385 Sets the largest value which still results in a match. If unset, behaves like
10388 =item B<Invert> B<true>|B<false>
10390 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
10391 no-match is returned and vice versa. Please note that the B<Invert> setting
10392 only effects how B<Min> and B<Max> are applied to a specific value. Especially
10393 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
10395 =item B<DataSource> I<DSName> [I<DSName> ...]
10397 Select one or more of the data sources. If no data source is configured, all
10398 data sources will be checked. If the type handled by the match does not have a
10399 data source of the specified name(s), this will always result in no match
10400 (independent of the B<Invert> setting).
10402 =item B<Satisfy> B<Any>|B<All>
10404 Specifies how checking with several data sources is performed. If set to
10405 B<Any>, the match succeeds if one of the data sources is in the configured
10406 range. If set to B<All> the match only succeeds if all data sources are within
10407 the configured range. Default is B<All>.
10409 Usually B<All> is used for positive matches, B<Any> is used for negative
10410 matches. This means that with B<All> you usually check that all values are in a
10411 "good" range, while with B<Any> you check if any value is within a "bad" range
10412 (or outside the "good" range).
10416 Either B<Min> or B<Max>, but not both, may be unset.
10420 # Match all values smaller than or equal to 100. Matches only if all data
10421 # sources are below 100.
10427 # Match if the value of any data source is outside the range of 0 - 100.
10435 =item B<empty_counter>
10437 Matches all values with one or more data sources of type B<COUNTER> and where
10438 all counter values are zero. These counters usually I<never> increased since
10439 they started existing (and are therefore uninteresting), or got reset recently
10440 or overflowed and you had really, I<really> bad luck.
10442 Please keep in mind that ignoring such counters can result in confusing
10443 behavior: Counters which hardly ever increase will be zero for long periods of
10444 time. If the counter is reset for some reason (machine or service restarted,
10445 usually), the graph will be empty (NAN) for a long time. People may not
10450 Calculates a hash value of the host name and matches values according to that
10451 hash value. This makes it possible to divide all hosts into groups and match
10452 only values that are in a specific group. The intended use is in load
10453 balancing, where you want to handle only part of all data and leave the rest
10456 The hashing function used tries to distribute the hosts evenly. First, it
10457 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
10460 for (i = 0; host[i] != 0; i++)
10461 hash_value = (hash_value * 251) + host[i];
10463 The constant 251 is a prime number which is supposed to make this hash value
10464 more random. The code then checks the group for this host according to the
10465 I<Total> and I<Match> arguments:
10467 if ((hash_value % Total) == Match)
10472 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
10473 groups), then the least significant bit of the hash value will be the XOR of
10474 all least significant bits in the host name. One consequence is that when you
10475 have two hosts, "server0.example.com" and "server1.example.com", where the host
10476 name differs in one digit only and the digits differ by one, those hosts will
10477 never end up in the same group.
10483 =item B<Match> I<Match> I<Total>
10485 Divide the data into I<Total> groups and match all hosts in group I<Match> as
10486 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
10487 be smaller than I<Total>. I<Total> must be at least one, although only values
10488 greater than one really do make any sense.
10490 You can repeat this option to match multiple groups, for example:
10495 The above config will divide the data into seven groups and match groups three
10496 and five. One use would be to keep every value on two hosts so that if one
10497 fails the missing data can later be reconstructed from the second host.
10503 # Operate on the pre-cache chain, so that ignored values are not even in the
10508 # Divide all received hosts in seven groups and accept all hosts in
10512 # If matched: Return and continue.
10515 # If not matched: Return and stop.
10521 =head2 Available targets
10525 =item B<notification>
10527 Creates and dispatches a notification.
10533 =item B<Message> I<String>
10535 This required option sets the message of the notification. The following
10536 placeholders will be replaced by an appropriate value:
10544 =item B<%{plugin_instance}>
10548 =item B<%{type_instance}>
10550 These placeholders are replaced by the identifier field of the same name.
10552 =item B<%{ds:>I<name>B<}>
10554 These placeholders are replaced by a (hopefully) human readable representation
10555 of the current rate of this data source. If you changed the instance name
10556 (using the B<set> or B<replace> targets, see below), it may not be possible to
10557 convert counter values to rates.
10561 Please note that these placeholders are B<case sensitive>!
10563 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
10565 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
10572 <Target "notification">
10573 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
10579 Replaces parts of the identifier using regular expressions.
10585 =item B<Host> I<Regex> I<Replacement>
10587 =item B<Plugin> I<Regex> I<Replacement>
10589 =item B<PluginInstance> I<Regex> I<Replacement>
10591 =item B<TypeInstance> I<Regex> I<Replacement>
10593 =item B<MetaData> I<String> I<Regex> I<Replacement>
10595 =item B<DeleteMetaData> I<String> I<Regex>
10597 Match the appropriate field with the given regular expression I<Regex>. If the
10598 regular expression matches, that part that matches is replaced with
10599 I<Replacement>. If multiple places of the input buffer match a given regular
10600 expression, only the first occurrence will be replaced.
10602 You can specify each option multiple times to use multiple regular expressions
10610 # Replace "example.net" with "example.com"
10611 Host "\\<example.net\\>" "example.com"
10613 # Strip "www." from hostnames
10614 Host "\\<www\\." ""
10619 Sets part of the identifier of a value to a given string.
10625 =item B<Host> I<String>
10627 =item B<Plugin> I<String>
10629 =item B<PluginInstance> I<String>
10631 =item B<TypeInstance> I<String>
10633 =item B<MetaData> I<String> I<String>
10635 Set the appropriate field to the given string. The strings for plugin instance,
10636 type instance, and meta data may be empty, the strings for host and plugin may
10637 not be empty. It's currently not possible to set the type of a value this way.
10639 The following placeholders will be replaced by an appropriate value:
10647 =item B<%{plugin_instance}>
10651 =item B<%{type_instance}>
10653 These placeholders are replaced by the identifier field of the same name.
10655 =item B<%{meta:>I<name>B<}>
10657 These placeholders are replaced by the meta data value with the given name.
10661 Please note that these placeholders are B<case sensitive>!
10663 =item B<DeleteMetaData> I<String>
10665 Delete the named meta data field.
10672 PluginInstance "coretemp"
10673 TypeInstance "core3"
10678 =head2 Backwards compatibility
10680 If you use collectd with an old configuration, i.E<nbsp>e. one without a
10681 B<Chain> block, it will behave as it used to. This is equivalent to the
10682 following configuration:
10684 <Chain "PostCache">
10688 If you specify a B<PostCacheChain>, the B<write> target will not be added
10689 anywhere and you will have to make sure that it is called where appropriate. We
10690 suggest to add the above snippet as default target to your "PostCache" chain.
10694 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
10709 B<Ignorelists> are a generic framework to either ignore some metrics or report
10710 specific metircs only. Plugins usually provide one or more options to specify
10711 the items (mounts points, devices, ...) and the boolean option
10716 =item B<Select> I<String>
10718 Selects the item I<String>. This option often has a plugin specific name, e.g.
10719 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
10720 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
10721 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
10723 By default, this option is doing a case-sensitive full-string match. The
10724 following config will match C<foo>, but not C<Foo>:
10728 If I<String> starts and ends with C</> (a slash), the string is compiled as a
10729 I<regular expression>. For example, so match all item starting with C<foo>, use
10730 could use the following syntax:
10734 The regular expression is I<not> anchored, i.e. the following config will match
10735 C<foobar>, C<barfoo> and C<AfooZ>:
10739 The B<Select> option may be repeated to select multiple items.
10741 =item B<IgnoreSelected> B<true>|B<false>
10743 If set to B<true>, matching metrics are I<ignored> and all other metrics are
10744 collected. If set to B<false>, matching metrics are I<collected> and all other
10745 metrics are ignored.
10752 L<collectd-exec(5)>,
10753 L<collectd-perl(5)>,
10754 L<collectd-unixsock(5)>,
10767 Florian Forster E<lt>octo@collectd.orgE<gt>