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 0.9.1 message broker.
534 Values are sent to or received from the broker, which handles routing,
535 queueing and 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<amqp1>
743 The I<AMQP1 plugin> can be used to communicate with other instances of
744 I<collectd> or third party applications using an AMQP 1.0 message
745 intermediary. Metric values or notifications are sent to the
746 messaging intermediary which may handle direct messaging or
747 queue based transfer.
752 # Send values to an AMQP 1.0 intermediary
760 <Instance "some_name">
765 # GraphitePrefix "collectd."
766 # GraphiteEscapeChar "_"
767 # GraphiteSeparateInstances false
768 # GraphiteAlwaysAppendDS false
769 # GraphitePreserveSeparator false
774 The plugin's configuration consists of a I<Transport> that configures
775 communications to the AMQP 1.0 messaging bus and one or more I<Instance>
776 corresponding to metric or event publishers to the messaging system.
778 The address in the I<Transport> block concatenated with the name given in the
779 I<Instance> block starting tag will be used as the send-to address for
780 communications over the messaging link.
782 The following options are accepted within each I<Transport> block:
786 =item B<Host> I<Host>
788 Hostname or IP-address of the AMQP 1.0 intermediary. Defaults to the
789 default behavior of the underlying communications library,
790 I<libqpid-proton>, which is "localhost".
792 =item B<Port> I<Port>
794 Service name or port number on which the AMQP 1.0 intermediary accepts
795 connections. This argument must be a string, even if the numeric form
796 is used. Defaults to "5672".
798 =item B<User> I<User>
800 =item B<Password> I<Password>
802 Credentials used to authenticate to the AMQP 1.0 intermediary. By
803 default "guest"/"guest" is used.
805 =item B<Address> I<Address>
807 This option specifies the prefix for the send-to value in the message.
808 By default, "collectd" will be used.
810 =item B<RetryDelay> I<RetryDelay>
812 When the AMQP1 connection is lost, defines the time in seconds to wait
813 before attempting to reconnect. Defaults to 1, which implies attempt
814 to reconnect at 1 second intervals.
818 The following options are accepted within each I<Instance> block:
822 =item B<Format> B<Command>|B<JSON>|B<Graphite>
824 Selects the format in which messages are sent to the intermediary. If set to
825 B<Command> (the default), values are sent as C<PUTVAL> commands which are
826 identical to the syntax used by the I<Exec> and I<UnixSock plugins>. In this
827 case, the C<Content-Type> header field will be set to C<text/collectd>.
829 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
830 an easy and straight forward exchange format. The C<Content-Type> header field
831 will be set to C<application/json>.
833 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
834 "<metric> <value> <timestamp>\n". The C<Content-Type> header field will be set to
837 A subscribing client I<should> use the C<Content-Type> header field to
838 determine how to decode the values.
840 =item B<PreSettle> B<true>|B<false>
842 If set to B<false> (the default), the plugin will wait for a message
843 acknowledgement from the messaging bus before sending the next
844 message. This indicates transfer of ownership to the messaging
845 system. If set to B<true>, the plugin will not wait for a message
846 acknowledgement and the message may be dropped prior to transfer of
849 =item B<Notify> B<true>|B<false>
851 If set to B<false> (the default), the plugin will service the
852 instance write call back as a value list. If set to B<true> the
853 plugin will service the instance as a write notification callback
854 for alert formatting.
856 =item B<StoreRates> B<true>|B<false>
858 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
859 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
860 default), no conversion is performed. Otherwise the conversion is performed
861 using the internal value cache.
863 Please note that currently this option is only used if the B<Format> option has
866 =item B<GraphitePrefix>
868 A prefix can be added in the metric name when outputting in the I<Graphite> format.
869 It's added before the I<Host> name.
870 Metric name will be "<prefix><host><postfix><plugin><type><name>"
872 =item B<GraphitePostfix>
874 A postfix can be added in the metric name when outputting in the I<Graphite> format.
875 It's added after the I<Host> name.
876 Metric name will be "<prefix><host><postfix><plugin><type><name>"
878 =item B<GraphiteEscapeChar>
880 Specify a character to replace dots (.) in the host part of the metric name.
881 In I<Graphite> metric name, dots are used as separators between different
882 metric parts (host, plugin, type).
883 Default is "_" (I<Underscore>).
885 =item B<GraphiteSeparateInstances> B<true>|B<false>
887 If set to B<true>, the plugin instance and type instance will be in their own
888 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
889 default), the plugin and plugin instance (and likewise the type and type
890 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
892 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
894 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
895 identifier. If set to B<false> (the default), this is only done when there is
898 =item B<GraphitePreserveSeparator> B<false>|B<true>
900 If set to B<false> (the default) the C<.> (dot) character is replaced with
901 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
902 is preserved, i.e. passed through.
906 =head2 Plugin C<apache>
908 To configure the C<apache>-plugin you first need to configure the Apache
909 webserver correctly. The Apache-plugin C<mod_status> needs to be loaded and
910 working and the C<ExtendedStatus> directive needs to be B<enabled>. You can use
911 the following snipped to base your Apache config upon:
914 <IfModule mod_status.c>
915 <Location /mod_status>
916 SetHandler server-status
920 Since its C<mod_status> module is very similar to Apache's, B<lighttpd> is
921 also supported. It introduces a new field, called C<BusyServers>, to count the
922 number of currently connected clients. This field is also supported.
924 The configuration of the I<Apache> plugin consists of one or more
925 C<E<lt>InstanceE<nbsp>/E<gt>> blocks. Each block requires one string argument
926 as the instance name. For example:
930 URL "http://www1.example.com/mod_status?auto"
933 URL "http://www2.example.com/mod_status?auto"
937 The instance name will be used as the I<plugin instance>. To emulate the old
938 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
939 plugin to work correctly, each instance name must be unique. This is not
940 enforced by the plugin and it is your responsibility to ensure it.
942 The following options are accepted within each I<Instance> block:
946 =item B<URL> I<http://host/mod_status?auto>
948 Sets the URL of the C<mod_status> output. This needs to be the output generated
949 by C<ExtendedStatus on> and it needs to be the machine readable output
950 generated by appending the C<?auto> argument. This option is I<mandatory>.
952 =item B<User> I<Username>
954 Optional user name needed for authentication.
956 =item B<Password> I<Password>
958 Optional password needed for authentication.
960 =item B<VerifyPeer> B<true|false>
962 Enable or disable peer SSL certificate verification. See
963 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
965 =item B<VerifyHost> B<true|false>
967 Enable or disable peer host name verification. If enabled, the plugin checks
968 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
969 certificate matches the host name provided by the B<URL> option. If this
970 identity check fails, the connection is aborted. Obviously, only works when
971 connecting to a SSL enabled server. Enabled by default.
973 =item B<CACert> I<File>
975 File that holds one or more SSL certificates. If you want to use HTTPS you will
976 possibly need this option. What CA certificates come bundled with C<libcurl>
977 and are checked by default depends on the distribution you use.
979 =item B<SSLCiphers> I<list of ciphers>
981 Specifies which ciphers to use in the connection. The list of ciphers
982 must specify valid ciphers. See
983 L<http://www.openssl.org/docs/apps/ciphers.html> for details.
985 =item B<Timeout> I<Milliseconds>
987 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
988 milliseconds. By default, the configured B<Interval> is used to set the
993 =head2 Plugin C<apcups>
997 =item B<Host> I<Hostname>
999 Hostname of the host running B<apcupsd>. Defaults to B<localhost>. Please note
1000 that IPv6 support has been disabled unless someone can confirm or decline that
1001 B<apcupsd> can handle it.
1003 =item B<Port> I<Port>
1005 TCP-Port to connect to. Defaults to B<3551>.
1007 =item B<ReportSeconds> B<true>|B<false>
1009 If set to B<true>, the time reported in the C<timeleft> metric will be
1010 converted to seconds. This is the recommended setting. If set to B<false>, the
1011 default for backwards compatibility, the time will be reported in minutes.
1013 =item B<PersistentConnection> B<true>|B<false>
1015 The plugin is designed to keep the connection to I<apcupsd> open between reads.
1016 If plugin poll interval is greater than 15 seconds (hardcoded socket close
1017 timeout in I<apcupsd> NIS), then this option is B<false> by default.
1019 You can instruct the plugin to close the connection after each read by setting
1020 this option to B<false> or force keeping the connection by setting it to B<true>.
1022 If I<apcupsd> appears to close the connection due to inactivity quite quickly,
1023 the plugin will try to detect this problem and switch to an open-read-close mode.
1027 =head2 Plugin C<aquaero>
1029 This plugin collects the value of the available sensors in an
1030 I<AquaeroE<nbsp>5> board. AquaeroE<nbsp>5 is a water-cooling controller board,
1031 manufactured by Aqua Computer GmbH L<http://www.aquacomputer.de/>, with a USB2
1032 connection for monitoring and configuration. The board can handle multiple
1033 temperature sensors, fans, water pumps and water level sensors and adjust the
1034 output settings such as fan voltage or power used by the water pump based on
1035 the available inputs using a configurable controller included in the board.
1036 This plugin collects all the available inputs as well as some of the output
1037 values chosen by this controller. The plugin is based on the I<libaquaero5>
1038 library provided by I<aquatools-ng>.
1042 =item B<Device> I<DevicePath>
1044 Device path of the AquaeroE<nbsp>5's USB HID (human interface device), usually
1045 in the form C</dev/usb/hiddevX>. If this option is no set the plugin will try
1046 to auto-detect the Aquaero 5 USB device based on vendor-ID and product-ID.
1050 =head2 Plugin C<ascent>
1052 This plugin collects information about an Ascent server, a free server for the
1053 "World of Warcraft" game. This plugin gathers the information by fetching the
1054 XML status page using C<libcurl> and parses it using C<libxml2>.
1056 The configuration options are the same as for the C<apache> plugin above:
1060 =item B<URL> I<http://localhost/ascent/status/>
1062 Sets the URL of the XML status output.
1064 =item B<User> I<Username>
1066 Optional user name needed for authentication.
1068 =item B<Password> I<Password>
1070 Optional password needed for authentication.
1072 =item B<VerifyPeer> B<true|false>
1074 Enable or disable peer SSL certificate verification. See
1075 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1077 =item B<VerifyHost> B<true|false>
1079 Enable or disable peer host name verification. If enabled, the plugin checks
1080 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
1081 certificate matches the host name provided by the B<URL> option. If this
1082 identity check fails, the connection is aborted. Obviously, only works when
1083 connecting to a SSL enabled server. Enabled by default.
1085 =item B<CACert> I<File>
1087 File that holds one or more SSL certificates. If you want to use HTTPS you will
1088 possibly need this option. What CA certificates come bundled with C<libcurl>
1089 and are checked by default depends on the distribution you use.
1091 =item B<Timeout> I<Milliseconds>
1093 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1094 milliseconds. By default, the configured B<Interval> is used to set the
1099 =head2 Plugin C<barometer>
1101 This plugin reads absolute air pressure using digital barometer sensor on a I2C
1102 bus. Supported sensors are:
1106 =item I<MPL115A2> from Freescale,
1107 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL115A>.
1110 =item I<MPL3115> from Freescale
1111 see L<http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MPL3115A2>.
1114 =item I<BMP085> from Bosch Sensortec
1118 The sensor type - one of the above - is detected automatically by the plugin
1119 and indicated in the plugin_instance (you will see subdirectory
1120 "barometer-mpl115" or "barometer-mpl3115", or "barometer-bmp085"). The order of
1121 detection is BMP085 -> MPL3115 -> MPL115A2, the first one found will be used
1122 (only one sensor can be used by the plugin).
1124 The plugin provides absolute barometric pressure, air pressure reduced to sea
1125 level (several possible approximations) and as an auxiliary value also internal
1126 sensor temperature. It uses (expects/provides) typical metric units - pressure
1127 in [hPa], temperature in [C], altitude in [m].
1129 It was developed and tested under Linux only. The only platform dependency is
1130 the standard Linux i2c-dev interface (the particular bus driver has to
1131 support the SM Bus command subset).
1133 The reduction or normalization to mean sea level pressure requires (depending
1134 on selected method/approximation) also altitude and reference to temperature
1135 sensor(s). When multiple temperature sensors are configured the minimum of
1136 their values is always used (expecting that the warmer ones are affected by
1137 e.g. direct sun light at that moment).
1141 <Plugin "barometer">
1142 Device "/dev/i2c-0";
1145 TemperatureOffset 0.0
1148 TemperatureSensor "myserver/onewire-F10FCA000800/temperature"
1153 =item B<Device> I<device>
1155 The only mandatory configuration parameter.
1157 Device name of the I2C bus to which the sensor is connected. Note that
1158 typically you need to have loaded the i2c-dev module.
1159 Using i2c-tools you can check/list i2c buses available on your system by:
1163 Then you can scan for devices on given bus. E.g. to scan the whole bus 0 use:
1167 This way you should be able to verify that the pressure sensor (either type) is
1168 connected and detected on address 0x60.
1170 =item B<Oversampling> I<value>
1172 Optional parameter controlling the oversampling/accuracy. Default value
1173 is 1 providing fastest and least accurate reading.
1175 For I<MPL115> this is the size of the averaging window. To filter out sensor
1176 noise a simple averaging using floating window of this configurable size is
1177 used. The plugin will use average of the last C<value> measurements (value of 1
1178 means no averaging). Minimal size is 1, maximal 1024.
1180 For I<MPL3115> this is the oversampling value. The actual oversampling is
1181 performed by the sensor and the higher value the higher accuracy and longer
1182 conversion time (although nothing to worry about in the collectd context).
1183 Supported values are: 1, 2, 4, 8, 16, 32, 64 and 128. Any other value is
1184 adjusted by the plugin to the closest supported one.
1186 For I<BMP085> this is the oversampling value. The actual oversampling is
1187 performed by the sensor and the higher value the higher accuracy and longer
1188 conversion time (although nothing to worry about in the collectd context).
1189 Supported values are: 1, 2, 4, 8. Any other value is adjusted by the plugin to
1190 the closest supported one.
1192 =item B<PressureOffset> I<offset>
1194 Optional parameter for MPL3115 only.
1196 You can further calibrate the sensor by supplying pressure and/or temperature
1197 offsets. This is added to the measured/caclulated value (i.e. if the measured
1198 value is too high then use negative offset).
1199 In hPa, default is 0.0.
1201 =item B<TemperatureOffset> I<offset>
1203 Optional parameter for MPL3115 only.
1205 You can further calibrate the sensor by supplying pressure and/or temperature
1206 offsets. This is added to the measured/caclulated value (i.e. if the measured
1207 value is too high then use negative offset).
1208 In C, default is 0.0.
1210 =item B<Normalization> I<method>
1212 Optional parameter, default value is 0.
1214 Normalization method - what approximation/model is used to compute the mean sea
1215 level pressure from the air absolute pressure.
1217 Supported values of the C<method> (integer between from 0 to 2) are:
1221 =item B<0> - no conversion, absolute pressure is simply copied over. For this method you
1222 do not need to configure C<Altitude> or C<TemperatureSensor>.
1224 =item B<1> - international formula for conversion ,
1226 L<http://en.wikipedia.org/wiki/Atmospheric_pressure#Altitude_atmospheric_pressure_variation>.
1227 For this method you have to configure C<Altitude> but do not need
1228 C<TemperatureSensor> (uses fixed global temperature average instead).
1230 =item B<2> - formula as recommended by the Deutsche Wetterdienst (German
1231 Meteorological Service).
1232 See L<http://de.wikipedia.org/wiki/Barometrische_H%C3%B6henformel#Theorie>
1233 For this method you have to configure both C<Altitude> and
1234 C<TemperatureSensor>.
1239 =item B<Altitude> I<altitude>
1241 The altitude (in meters) of the location where you meassure the pressure.
1243 =item B<TemperatureSensor> I<reference>
1245 Temperature sensor(s) which should be used as a reference when normalizing the
1246 pressure using C<Normalization> method 2.
1247 When specified more sensors a minimum is found and used each time. The
1248 temperature reading directly from this pressure sensor/plugin is typically not
1249 suitable as the pressure sensor will be probably inside while we want outside
1250 temperature. The collectd reference name is something like
1251 <hostname>/<plugin_name>-<plugin_instance>/<type>-<type_instance>
1252 (<type_instance> is usually omitted when there is just single value type). Or
1253 you can figure it out from the path of the output data files.
1257 =head2 Plugin C<battery>
1259 The I<battery plugin> reports the remaining capacity, power and voltage of
1264 =item B<ValuesPercentage> B<false>|B<true>
1266 When enabled, remaining capacity is reported as a percentage, e.g. "42%
1267 capacity remaining". Otherwise the capacity is stored as reported by the
1268 battery, most likely in "Wh". This option does not work with all input methods,
1269 in particular when only C</proc/pmu> is available on an old Linux system.
1270 Defaults to B<false>.
1272 =item B<ReportDegraded> B<false>|B<true>
1274 Typical laptop batteries degrade over time, meaning the capacity decreases with
1275 recharge cycles. The maximum charge of the previous charge cycle is tracked as
1276 "last full capacity" and used to determine that a battery is "fully charged".
1278 When this option is set to B<false>, the default, the I<battery plugin> will
1279 only report the remaining capacity. If the B<ValuesPercentage> option is
1280 enabled, the relative remaining capacity is calculated as the ratio of the
1281 "remaining capacity" and the "last full capacity". This is what most tools,
1282 such as the status bar of desktop environments, also do.
1284 When set to B<true>, the battery plugin will report three values: B<charged>
1285 (remaining capacity), B<discharged> (difference between "last full capacity"
1286 and "remaining capacity") and B<degraded> (difference between "design capacity"
1287 and "last full capacity").
1289 =item B<QueryStateFS> B<false>|B<true>
1291 When set to B<true>, the battery plugin will only read statistics
1292 related to battery performance as exposed by StateFS at
1293 /run/state. StateFS is used in Mer-based Sailfish OS, for
1298 =head2 Plugin C<bind>
1300 Starting with BIND 9.5.0, the most widely used DNS server software provides
1301 extensive statistics about queries, responses and lots of other information.
1302 The bind plugin retrieves this information that's encoded in XML and provided
1303 via HTTP and submits the values to collectd.
1305 To use this plugin, you first need to tell BIND to make this information
1306 available. This is done with the C<statistics-channels> configuration option:
1308 statistics-channels {
1309 inet localhost port 8053;
1312 The configuration follows the grouping that can be seen when looking at the
1313 data with an XSLT compatible viewer, such as a modern web browser. It's
1314 probably a good idea to make yourself familiar with the provided values, so you
1315 can understand what the collected statistics actually mean.
1320 URL "http://localhost:8053/"
1335 Zone "127.in-addr.arpa/IN"
1339 The bind plugin accepts the following configuration options:
1345 URL from which to retrieve the XML data. If not specified,
1346 C<http://localhost:8053/> will be used.
1348 =item B<ParseTime> B<true>|B<false>
1350 When set to B<true>, the time provided by BIND will be parsed and used to
1351 dispatch the values. When set to B<false>, the local time source is queried.
1353 This setting is set to B<true> by default for backwards compatibility; setting
1354 this to B<false> is I<recommended> to avoid problems with timezones and
1357 =item B<OpCodes> B<true>|B<false>
1359 When enabled, statistics about the I<"OpCodes">, for example the number of
1360 C<QUERY> packets, are collected.
1364 =item B<QTypes> B<true>|B<false>
1366 When enabled, the number of I<incoming> queries by query types (for example
1367 C<A>, C<MX>, C<AAAA>) is collected.
1371 =item B<ServerStats> B<true>|B<false>
1373 Collect global server statistics, such as requests received over IPv4 and IPv6,
1374 successful queries, and failed updates.
1378 =item B<ZoneMaintStats> B<true>|B<false>
1380 Collect zone maintenance statistics, mostly information about notifications
1381 (zone updates) and zone transfers.
1385 =item B<ResolverStats> B<true>|B<false>
1387 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1388 (e.E<nbsp>g. queries over IPv4, lame servers). Since the global resolver
1389 counters apparently were removed in BIND 9.5.1 and 9.6.0, this is disabled by
1390 default. Use the B<ResolverStats> option within a B<View "_default"> block
1391 instead for the same functionality.
1395 =item B<MemoryStats>
1397 Collect global memory statistics.
1401 =item B<Timeout> I<Milliseconds>
1403 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
1404 milliseconds. By default, the configured B<Interval> is used to set the
1407 =item B<View> I<Name>
1409 Collect statistics about a specific I<"view">. BIND can behave different,
1410 mostly depending on the source IP-address of the request. These different
1411 configurations are called "views". If you don't use this feature, you most
1412 likely are only interested in the C<_default> view.
1414 Within a E<lt>B<View>E<nbsp>I<name>E<gt> block, you can specify which
1415 information you want to collect about a view. If no B<View> block is
1416 configured, no detailed view statistics will be collected.
1420 =item B<QTypes> B<true>|B<false>
1422 If enabled, the number of I<outgoing> queries by query type (e.E<nbsp>g. C<A>,
1423 C<MX>) is collected.
1427 =item B<ResolverStats> B<true>|B<false>
1429 Collect resolver statistics, i.E<nbsp>e. statistics about outgoing requests
1430 (e.E<nbsp>g. queries over IPv4, lame servers).
1434 =item B<CacheRRSets> B<true>|B<false>
1436 If enabled, the number of entries (I<"RR sets">) in the view's cache by query
1437 type is collected. Negative entries (queries which resulted in an error, for
1438 example names that do not exist) are reported with a leading exclamation mark,
1443 =item B<Zone> I<Name>
1445 When given, collect detailed information about the given zone in the view. The
1446 information collected if very similar to the global B<ServerStats> information
1449 You can repeat this option to collect detailed information about multiple
1452 By default no detailed zone information is collected.
1458 =head2 Plugin C<ceph>
1460 The ceph plugin collects values from JSON data to be parsed by B<libyajl>
1461 (L<https://lloyd.github.io/yajl/>) retrieved from ceph daemon admin sockets.
1463 A separate B<Daemon> block must be configured for each ceph daemon to be
1464 monitored. The following example will read daemon statistics from four
1465 separate ceph daemons running on the same device (two OSDs, one MON, one MDS) :
1468 LongRunAvgLatency false
1469 ConvertSpecialMetricTypes true
1471 SocketPath "/var/run/ceph/ceph-osd.0.asok"
1474 SocketPath "/var/run/ceph/ceph-osd.1.asok"
1477 SocketPath "/var/run/ceph/ceph-mon.ceph1.asok"
1480 SocketPath "/var/run/ceph/ceph-mds.ceph1.asok"
1484 The ceph plugin accepts the following configuration options:
1488 =item B<LongRunAvgLatency> B<true>|B<false>
1490 If enabled, latency values(sum,count pairs) are calculated as the long run
1491 average - average since the ceph daemon was started = (sum / count).
1492 When disabled, latency values are calculated as the average since the last
1493 collection = (sum_now - sum_last) / (count_now - count_last).
1497 =item B<ConvertSpecialMetricTypes> B<true>|B<false>
1499 If enabled, special metrics (metrics that differ in type from similar counters)
1500 are converted to the type of those similar counters. This currently only
1501 applies to filestore.journal_wr_bytes which is a counter for OSD daemons. The
1502 ceph schema reports this metric type as a sum,count pair while similar counters
1503 are treated as derive types. When converted, the sum is used as the counter
1504 value and is treated as a derive type.
1505 When disabled, all metrics are treated as the types received from the ceph schema.
1511 Each B<Daemon> block must have a string argument for the plugin instance name.
1512 A B<SocketPath> is also required for each B<Daemon> block:
1516 =item B<Daemon> I<DaemonName>
1518 Name to be used as the instance name for this daemon.
1520 =item B<SocketPath> I<SocketPath>
1522 Specifies the path to the UNIX admin socket of the ceph daemon.
1526 =head2 Plugin C<cgroups>
1528 This plugin collects the CPU user/system time for each I<cgroup> by reading the
1529 F<cpuacct.stat> files in the first cpuacct-mountpoint (typically
1530 F</sys/fs/cgroup/cpu.cpuacct> on machines using systemd).
1534 =item B<CGroup> I<Directory>
1536 Select I<cgroup> based on the name. Whether only matching I<cgroups> are
1537 collected or if they are ignored is controlled by the B<IgnoreSelected> option;
1540 See F</"IGNORELISTS"> for details.
1542 =item B<IgnoreSelected> B<true>|B<false>
1544 Invert the selection: If set to true, all cgroups I<except> the ones that
1545 match any one of the criteria are collected. By default only selected
1546 cgroups are collected if a selection is made. If no selection is configured
1547 at all, B<all> cgroups are selected.
1551 =head2 Plugin C<chrony>
1553 The C<chrony> plugin collects ntp data from a B<chronyd> server, such as clock
1554 skew and per-peer stratum.
1556 For talking to B<chronyd>, it mimics what the B<chronyc> control program does
1559 Available configuration options for the C<chrony> plugin:
1563 =item B<Host> I<Hostname>
1565 Hostname of the host running B<chronyd>. Defaults to B<localhost>.
1567 =item B<Port> I<Port>
1569 UDP-Port to connect to. Defaults to B<323>.
1571 =item B<Timeout> I<Timeout>
1573 Connection timeout in seconds. Defaults to B<2>.
1577 =head2 Plugin C<cloud_pubsub>
1579 The B<cloud_pubsub> plugin sends metrics to I<Google Cloud Pub/Sub>, a highly
1580 available message queueing service. The data is encoded in I<collectd's> JSON
1585 <Plugin "cloud_pubsub">
1586 <Publish "topic_name">
1587 CredentialFile "/path/to/credentials.json"
1588 Project "project_name"
1589 Email "0123456789012-abcdefghijklmnopqrstuvwxyzabcdef@developer.gserviceaccount.com
1594 <Subscribe "subscription_name">
1595 CredentialFile "/path/to/credentials.json"
1596 Project "project_name"
1597 Email "0123456789012-abcdefghijklmnopqrstuvwxyzabcdef@developer.gserviceaccount.com
1601 The configuration consists of one or more C<Publish> blocks, each configuring
1602 one topic to post metrics to. Inside each C<Publish> block, the following
1603 configuration options are available:
1607 =item B<CredentialFile> I<file>
1609 Path to a JSON credentials file holding the credentials for a GCP service
1612 If B<CredentialFile> is not specified, the plugin uses I<Application Default
1613 Credentials>. That means which credentials are used depends on the environment:
1619 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
1620 variable is specified it should point to a JSON file that defines the
1625 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
1626 checked. This is where credentials used by the I<gcloud> command line utility
1627 are stored. You can use C<gcloud auth application-default login> to create
1630 Please note that these credentials are often of your personal account, not a
1631 service account, and are therefore unfit to be used in a production
1636 When running on GCE, the built-in service account associated with the virtual
1637 machine instance is used.
1638 See also the B<Email> option below.
1642 For B<Publish> blocks, the service account / user requires the
1643 C<roles/pubsub.publisher> role.
1645 =item B<Project> I<Name>
1647 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
1648 I<Project ID> is a string identifying the GCP project, which you can chose
1649 freely when creating a new project. The I<Project Number> is a 12-digit decimal
1650 number. You can look up both on the I<Developer Console>.
1652 This setting is optional. If not set, the project ID is read from the
1653 credentials file or determined from the GCE's metadata service.
1655 =item B<Email> I<Email> (GCE only)
1657 Choses the GCE I<Service Account> used for authentication.
1659 Each GCE instance has a C<default> I<Service Account> but may also be
1660 associated with additional I<Service Accounts>. This is often used to restrict
1661 the permissions of services running on the GCE instance to the required
1662 minimum. The I<cloud_pubsub plugin> requires the
1663 C<https://www.googleapis.com/auth/pubsub> scope. When multiple I<Service
1664 Accounts> are available, this option selects which one is used by
1665 I<cloud_pubsub plugin>.
1667 =item B<StoreRates> B<false>|B<true> (Publish only)
1669 If set to true, counters are converted to a rate before submitting.
1670 Defaults to B<false> because this plugin itself cannot consume non-gauge
1671 metrics that have been converted to rates.
1673 =item B<BufferSize> I<Bytes> (Publish only)
1675 Sets the size of the buffer used to build requests to I<Cloud Pub/Sub>, in
1676 bytes. Must be at least 1024E<nbsp>bytes. Defaults to 65536 (64E<nbsp>kiByte).
1678 =item B<MaxMessages> I<Number> (Subscribe only)
1680 Sets the maximum number of messages to receive from Cloud Pub/Sub at once.
1685 =head2 Plugin C<conntrack>
1687 This plugin collects IP conntrack statistics.
1693 Assume the B<conntrack_count> and B<conntrack_max> files to be found in
1694 F</proc/sys/net/ipv4/netfilter> instead of F</proc/sys/net/netfilter/>.
1698 =head2 Plugin C<cpu>
1700 The I<CPU plugin> collects CPU usage metrics. By default, CPU usage is reported
1701 as Jiffies, using the C<cpu> type. Two aggregations are available:
1707 Sum, per-state, over all CPUs installed in the system; and
1711 Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state.
1715 The two aggregations can be combined, leading to I<collectd> only emitting a
1716 single "active" metric for the entire system. As soon as one of these
1717 aggregations (or both) is enabled, the I<cpu plugin> will report a percentage,
1718 rather than Jiffies. In addition, you can request individual, per-state,
1719 per-CPU metrics to be reported as percentage.
1721 The following configuration options are available:
1725 =item B<ReportByState> B<true>|B<false>
1727 When set to B<true>, the default, reports per-state metrics, e.g. "system",
1729 When set to B<false>, aggregates (sums) all I<non-idle> states into one
1732 =item B<ReportByCpu> B<true>|B<false>
1734 When set to B<true>, the default, reports per-CPU (per-core) metrics.
1735 When set to B<false>, instead of reporting metrics for individual CPUs, only a
1736 global sum of CPU states is emitted.
1738 =item B<ValuesPercentage> B<false>|B<true>
1740 This option is only considered when both, B<ReportByCpu> and B<ReportByState>
1741 are set to B<true>. In this case, by default, metrics will be reported as
1742 Jiffies. By setting this option to B<true>, you can request percentage values
1743 in the un-aggregated (per-CPU, per-state) mode as well.
1745 =item B<ReportNumCpu> B<false>|B<true>
1747 When set to B<true>, reports the number of available CPUs.
1748 Defaults to B<false>.
1750 =item B<ReportGuestState> B<false>|B<true>
1752 When set to B<true>, reports the "guest" and "guest_nice" CPU states.
1753 Defaults to B<false>.
1755 =item B<SubtractGuestState> B<false>|B<true>
1757 This option is only considered when B<ReportGuestState> is set to B<true>.
1758 "guest" and "guest_nice" are included in respectively "user" and "nice".
1759 If set to B<true>, "guest" will be subtracted from "user" and "guest_nice"
1760 will be subtracted from "nice".
1761 Defaults to B<true>.
1765 =head2 Plugin C<cpufreq>
1767 This plugin doesn't have any options. It reads
1768 F</sys/devices/system/cpu/cpu0/cpufreq/scaling_cur_freq> (for the first CPU
1769 installed) to get the current CPU frequency. If this file does not exist make
1770 sure B<cpufreqd> (L<http://cpufreqd.sourceforge.net/>) or a similar tool is
1771 installed and an "cpu governor" (that's a kernel module) is loaded.
1773 =head2 Plugin C<cpusleep>
1775 This plugin doesn't have any options. It reads CLOCK_BOOTTIME and
1776 CLOCK_MONOTONIC and reports the difference between these clocks. Since
1777 BOOTTIME clock increments while device is suspended and MONOTONIC
1778 clock does not, the derivative of the difference between these clocks
1779 gives the relative amount of time the device has spent in suspend
1780 state. The recorded value is in milliseconds of sleep per seconds of
1783 =head2 Plugin C<csv>
1787 =item B<DataDir> I<Directory>
1789 Set the directory to store CSV-files under. Per default CSV-files are generated
1790 beneath the daemon's working directory, i.E<nbsp>e. the B<BaseDir>.
1791 The special strings B<stdout> and B<stderr> can be used to write to the standard
1792 output and standard error channels, respectively. This, of course, only makes
1793 much sense when collectd is running in foreground- or non-daemon-mode.
1795 =item B<StoreRates> B<true|false>
1797 If set to B<true>, convert counter values to rates. If set to B<false> (the
1798 default) counter values are stored as is, i.E<nbsp>e. as an increasing integer
1803 =head2 cURL Statistics
1805 All cURL-based plugins support collection of generic, request-based
1806 statistics. These are disabled by default and can be enabled selectively for
1807 each page or URL queried from the curl, curl_json, or curl_xml plugins. See
1808 the documentation of those plugins for specific information. This section
1809 describes the available metrics that can be configured for each plugin. All
1810 options are disabled by default.
1812 See L<http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html> for more details.
1816 =item B<TotalTime> B<true|false>
1818 Total time of the transfer, including name resolving, TCP connect, etc.
1820 =item B<NamelookupTime> B<true|false>
1822 Time it took from the start until name resolving was completed.
1824 =item B<ConnectTime> B<true|false>
1826 Time it took from the start until the connect to the remote host (or proxy)
1829 =item B<AppconnectTime> B<true|false>
1831 Time it took from the start until the SSL/SSH connect/handshake to the remote
1834 =item B<PretransferTime> B<true|false>
1836 Time it took from the start until just before the transfer begins.
1838 =item B<StarttransferTime> B<true|false>
1840 Time it took from the start until the first byte was received.
1842 =item B<RedirectTime> B<true|false>
1844 Time it took for all redirection steps include name lookup, connect,
1845 pre-transfer and transfer before final transaction was started.
1847 =item B<RedirectCount> B<true|false>
1849 The total number of redirections that were actually followed.
1851 =item B<SizeUpload> B<true|false>
1853 The total amount of bytes that were uploaded.
1855 =item B<SizeDownload> B<true|false>
1857 The total amount of bytes that were downloaded.
1859 =item B<SpeedDownload> B<true|false>
1861 The average download speed that curl measured for the complete download.
1863 =item B<SpeedUpload> B<true|false>
1865 The average upload speed that curl measured for the complete upload.
1867 =item B<HeaderSize> B<true|false>
1869 The total size of all the headers received.
1871 =item B<RequestSize> B<true|false>
1873 The total size of the issued requests.
1875 =item B<ContentLengthDownload> B<true|false>
1877 The content-length of the download.
1879 =item B<ContentLengthUpload> B<true|false>
1881 The specified size of the upload.
1883 =item B<NumConnects> B<true|false>
1885 The number of new connections that were created to achieve the transfer.
1889 =head2 Plugin C<curl>
1891 The curl plugin uses the B<libcurl> (L<http://curl.haxx.se/>) to read web pages
1892 and the match infrastructure (the same code used by the tail plugin) to use
1893 regular expressions with the received data.
1895 The following example will read the current value of AMD stock from Google's
1896 finance page and dispatch the value to collectd.
1899 <Page "stock_quotes">
1901 URL "http://finance.google.com/finance?q=NYSE%3AAMD"
1907 CACert "/path/to/ca.crt"
1908 Header "X-Custom-Header: foobar"
1911 MeasureResponseTime false
1912 MeasureResponseCode false
1915 Regex "<span +class=\"pr\"[^>]*> *([0-9]*\\.[0-9]+) *</span>"
1916 DSType "GaugeAverage"
1917 # Note: `stock_value' is not a standard type.
1924 In the B<Plugin> block, there may be one or more B<Page> blocks, each defining
1925 a web page and one or more "matches" to be performed on the returned data. The
1926 string argument to the B<Page> block is used as plugin instance.
1928 The following options are valid within B<Page> blocks:
1932 =item B<Plugin> I<Plugin>
1934 Use I<Plugin> as the plugin name when submitting values.
1935 Defaults to C<curl>.
1939 URL of the web site to retrieve. Since a regular expression will be used to
1940 extract information from this data, non-binary data is a big plus here ;)
1942 =item B<User> I<Name>
1944 Username to use if authorization is required to read the page.
1946 =item B<Password> I<Password>
1948 Password to use if authorization is required to read the page.
1950 =item B<Digest> B<true>|B<false>
1952 Enable HTTP digest authentication.
1954 =item B<VerifyPeer> B<true>|B<false>
1956 Enable or disable peer SSL certificate verification. See
1957 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
1959 =item B<VerifyHost> B<true>|B<false>
1961 Enable or disable peer host name verification. If enabled, the plugin checks if
1962 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
1963 matches the host name provided by the B<URL> option. If this identity check
1964 fails, the connection is aborted. Obviously, only works when connecting to a
1965 SSL enabled server. Enabled by default.
1967 =item B<CACert> I<file>
1969 File that holds one or more SSL certificates. If you want to use HTTPS you will
1970 possibly need this option. What CA certificates come bundled with C<libcurl>
1971 and are checked by default depends on the distribution you use.
1973 =item B<Header> I<Header>
1975 A HTTP header to add to the request. Multiple headers are added if this option
1976 is specified more than once.
1978 =item B<Post> I<Body>
1980 Specifies that the HTTP operation should be a POST instead of a GET. The
1981 complete data to be posted is given as the argument. This option will usually
1982 need to be accompanied by a B<Header> option to set an appropriate
1983 C<Content-Type> for the post body (e.g. to
1984 C<application/x-www-form-urlencoded>).
1986 =item B<MeasureResponseTime> B<true>|B<false>
1988 Measure response time for the request. If this setting is enabled, B<Match>
1989 blocks (see below) are optional. Disabled by default.
1991 Beware that requests will get aborted if they take too long to complete. Adjust
1992 B<Timeout> accordingly if you expect B<MeasureResponseTime> to report such slow
1995 This option is similar to enabling the B<TotalTime> statistic but it's
1996 measured by collectd instead of cURL.
1998 =item B<MeasureResponseCode> B<true>|B<false>
2000 Measure response code for the request. If this setting is enabled, B<Match>
2001 blocks (see below) are optional. Disabled by default.
2003 =item B<E<lt>StatisticsE<gt>>
2005 One B<Statistics> block can be used to specify cURL statistics to be collected
2006 for each request to the remote web site. See the section "cURL Statistics"
2007 above for details. If this setting is enabled, B<Match> blocks (see below) are
2010 =item B<E<lt>MatchE<gt>>
2012 One or more B<Match> blocks that define how to match information in the data
2013 returned by C<libcurl>. The C<curl> plugin uses the same infrastructure that's
2014 used by the C<tail> plugin, so please see the documentation of the C<tail>
2015 plugin below on how matches are defined. If the B<MeasureResponseTime> or
2016 B<MeasureResponseCode> options are set to B<true>, B<Match> blocks are
2019 =item B<Interval> I<Interval>
2021 Sets the interval (in seconds) in which the values will be collected from this
2022 URL. By default the global B<Interval> setting will be used.
2024 =item B<Timeout> I<Milliseconds>
2026 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
2027 milliseconds. By default, the configured B<Interval> is used to set the
2028 timeout. Prior to version 5.5.0, there was no timeout and requests could hang
2029 indefinitely. This legacy behaviour can be achieved by setting the value of
2032 If B<Timeout> is 0 or bigger than the B<Interval>, keep in mind that each slow
2033 network connection will stall one read thread. Adjust the B<ReadThreads> global
2034 setting accordingly to prevent this from blocking other plugins.
2038 =head2 Plugin C<curl_json>
2040 The B<curl_json plugin> collects values from JSON data to be parsed by
2041 B<libyajl> (L<https://lloyd.github.io/yajl/>) retrieved via
2042 either B<libcurl> (L<http://curl.haxx.se/>) or read directly from a
2043 unix socket. The former can be used, for example, to collect values
2044 from CouchDB documents (which are stored JSON notation), and the
2045 latter to collect values from a uWSGI stats socket.
2047 The following example will collect several values from the built-in
2048 C<_stats> runtime statistics module of I<CouchDB>
2049 (L<http://wiki.apache.org/couchdb/Runtime_Statistics>).
2052 <URL "http://localhost:5984/_stats">
2054 <Key "httpd/requests/count">
2055 Type "http_requests"
2058 <Key "httpd_request_methods/*/count">
2059 Type "http_request_methods"
2062 <Key "httpd_status_codes/*/count">
2063 Type "http_response_codes"
2068 This example will collect data directly from a I<uWSGI> "Stats Server" socket.
2071 <Sock "/var/run/uwsgi.stats.sock">
2073 <Key "workers/*/requests">
2074 Type "http_requests"
2077 <Key "workers/*/apps/*/requests">
2078 Type "http_requests"
2083 In the B<Plugin> block, there may be one or more B<URL> blocks, each
2084 defining a URL to be fetched via HTTP (using libcurl) or B<Sock>
2085 blocks defining a unix socket to read JSON from directly. Each of
2086 these blocks may have one or more B<Key> blocks.
2088 The B<Key> string argument must be in a path format. Each component is
2089 used to match the key from a JSON map or the index of an JSON
2090 array. If a path component of a B<Key> is a I<*>E<nbsp>wildcard, the
2091 values for all map keys or array indices will be collectd.
2093 The following options are valid within B<URL> blocks:
2097 =item B<Host> I<Name>
2099 Use I<Name> as the host name when submitting values. Defaults to the global
2102 =item B<Plugin> I<Plugin>
2104 Use I<Plugin> as the plugin name when submitting values.
2105 Defaults to C<curl_json>.
2107 =item B<Instance> I<Instance>
2109 Sets the plugin instance to I<Instance>.
2111 =item B<Interval> I<Interval>
2113 Sets the interval (in seconds) in which the values will be collected from this
2114 URL. By default the global B<Interval> setting will be used.
2116 =item B<User> I<Name>
2118 =item B<Password> I<Password>
2120 =item B<Digest> B<true>|B<false>
2122 =item B<VerifyPeer> B<true>|B<false>
2124 =item B<VerifyHost> B<true>|B<false>
2126 =item B<CACert> I<file>
2128 =item B<Header> I<Header>
2130 =item B<Post> I<Body>
2132 =item B<Timeout> I<Milliseconds>
2134 These options behave exactly equivalent to the appropriate options of the
2135 I<cURL> plugin. Please see there for a detailed description.
2137 =item B<E<lt>StatisticsE<gt>>
2139 One B<Statistics> block can be used to specify cURL statistics to be collected
2140 for each request to the remote URL. See the section "cURL Statistics" above
2145 The following options are valid within B<Key> blocks:
2149 =item B<Type> I<Type>
2151 Sets the type used to dispatch the values to the daemon. Detailed information
2152 about types and their configuration can be found in L<types.db(5)>. This
2153 option is mandatory.
2155 =item B<Instance> I<Instance>
2157 Type-instance to use. Defaults to the current map key or current string array element value.
2161 =head2 Plugin C<curl_xml>
2163 The B<curl_xml plugin> uses B<libcurl> (L<http://curl.haxx.se/>) and B<libxml2>
2164 (L<http://xmlsoft.org/>) to retrieve XML data via cURL.
2167 <URL "http://localhost/stats.xml">
2170 Instance "some_instance"
2175 CACert "/path/to/ca.crt"
2176 Header "X-Custom-Header: foobar"
2179 <XPath "table[@id=\"magic_level\"]/tr">
2181 #InstancePrefix "prefix-"
2182 InstanceFrom "td[1]"
2183 #PluginInstanceFrom "td[1]"
2184 ValuesFrom "td[2]/span[@class=\"level\"]"
2189 In the B<Plugin> block, there may be one or more B<URL> blocks, each defining a
2190 URL to be fetched using libcurl. Within each B<URL> block there are
2191 options which specify the connection parameters, for example authentication
2192 information, and one or more B<XPath> blocks.
2194 Each B<XPath> block specifies how to get one type of information. The
2195 string argument must be a valid XPath expression which returns a list
2196 of "base elements". One value is dispatched for each "base element". The
2197 I<type instance> and values are looked up using further I<XPath> expressions
2198 that should be relative to the base element.
2200 Within the B<URL> block the following options are accepted:
2204 =item B<Host> I<Name>
2206 Use I<Name> as the host name when submitting values. Defaults to the global
2209 =item B<Plugin> I<Plugin>
2211 Use I<Plugin> as the plugin name when submitting values.
2212 Defaults to 'curl_xml'.
2214 =item B<Instance> I<Instance>
2216 Use I<Instance> as the plugin instance when submitting values.
2217 May be overridden by B<PluginInstanceFrom> option inside B<XPath> blocks.
2218 Defaults to an empty string (no plugin instance).
2220 =item B<Interval> I<Interval>
2222 Sets the interval (in seconds) in which the values will be collected from this
2223 URL. By default the global B<Interval> setting will be used.
2225 =item B<Namespace> I<Prefix> I<URL>
2227 If an XPath expression references namespaces, they must be specified
2228 with this option. I<Prefix> is the "namespace prefix" used in the XML document.
2229 I<URL> is the "namespace name", an URI reference uniquely identifying the
2230 namespace. The option can be repeated to register multiple namespaces.
2234 Namespace "s" "http://schemas.xmlsoap.org/soap/envelope/"
2235 Namespace "m" "http://www.w3.org/1998/Math/MathML"
2237 =item B<User> I<User>
2239 =item B<Password> I<Password>
2241 =item B<Digest> B<true>|B<false>
2243 =item B<VerifyPeer> B<true>|B<false>
2245 =item B<VerifyHost> B<true>|B<false>
2247 =item B<CACert> I<CA Cert File>
2249 =item B<Header> I<Header>
2251 =item B<Post> I<Body>
2253 =item B<Timeout> I<Milliseconds>
2255 These options behave exactly equivalent to the appropriate options of the
2256 I<cURL plugin>. Please see there for a detailed description.
2258 =item B<E<lt>StatisticsE<gt>>
2260 One B<Statistics> block can be used to specify cURL statistics to be collected
2261 for each request to the remote URL. See the section "cURL Statistics" above
2264 =item E<lt>B<XPath> I<XPath-expression>E<gt>
2266 Within each B<URL> block, there must be one or more B<XPath> blocks. Each
2267 B<XPath> block specifies how to get one type of information. The string
2268 argument must be a valid XPath expression which returns a list of "base
2269 elements". One value is dispatched for each "base element".
2271 Within the B<XPath> block the following options are accepted:
2275 =item B<Type> I<Type>
2277 Specifies the I<Type> used for submitting patches. This determines the number
2278 of values that are required / expected and whether the strings are parsed as
2279 signed or unsigned integer or as double values. See L<types.db(5)> for details.
2280 This option is required.
2282 =item B<InstancePrefix> I<InstancePrefix>
2284 Prefix the I<type instance> with I<InstancePrefix>. The values are simply
2285 concatenated together without any separator.
2286 This option is optional.
2288 =item B<InstanceFrom> I<InstanceFrom>
2290 Specifies a XPath expression to use for determining the I<type instance>. The
2291 XPath expression must return exactly one element. The element's value is then
2292 used as I<type instance>, possibly prefixed with I<InstancePrefix> (see above).
2294 =item B<PluginInstanceFrom> I<PluginInstanceFrom>
2296 Specifies a XPath expression to use for determining the I<plugin instance>. The
2297 XPath expression must return exactly one element. The element's value is then
2298 used as I<plugin instance>.
2302 If the "base XPath expression" (the argument to the B<XPath> block) returns
2303 exactly one argument, then I<InstanceFrom> and I<PluginInstanceFrom> may be omitted.
2304 Otherwise, at least one of I<InstanceFrom> or I<PluginInstanceFrom> is required.
2308 =item B<ValuesFrom> I<ValuesFrom> [I<ValuesFrom> ...]
2310 Specifies one or more XPath expression to use for reading the values. The
2311 number of XPath expressions must match the number of data sources in the
2312 I<type> specified with B<Type> (see above). Each XPath expression must return
2313 exactly one element. The element's value is then parsed as a number and used as
2314 value for the appropriate value in the value list dispatched to the daemon.
2315 This option is required.
2321 =head2 Plugin C<dbi>
2323 This plugin uses the B<dbi> library (L<http://libdbi.sourceforge.net/>) to
2324 connect to various databases, execute I<SQL> statements and read back the
2325 results. I<dbi> is an acronym for "database interface" in case you were
2326 wondering about the name. You can configure how each column is to be
2327 interpreted and the plugin will generate one or more data sets from each row
2328 returned according to these rules.
2330 Because the plugin is very generic, the configuration is a little more complex
2331 than those of other plugins. It usually looks something like this:
2334 <Query "out_of_stock">
2335 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
2336 # Use with MySQL 5.0.0 or later
2340 InstancePrefix "out_of_stock"
2341 InstancesFrom "category"
2345 <Database "product_information">
2349 DriverOption "host" "localhost"
2350 DriverOption "username" "collectd"
2351 DriverOption "password" "aZo6daiw"
2352 DriverOption "dbname" "prod_info"
2353 SelectDB "prod_info"
2354 Query "out_of_stock"
2358 The configuration above defines one query with one result and one database. The
2359 query is then linked to the database with the B<Query> option I<within> the
2360 B<E<lt>DatabaseE<gt>> block. You can have any number of queries and databases
2361 and you can also use the B<Include> statement to split up the configuration
2362 file in multiple, smaller files. However, the B<E<lt>QueryE<gt>> block I<must>
2363 precede the B<E<lt>DatabaseE<gt>> blocks, because the file is interpreted from
2366 The following is a complete list of options:
2368 =head3 B<Query> blocks
2370 Query blocks define I<SQL> statements and how the returned data should be
2371 interpreted. They are identified by the name that is given in the opening line
2372 of the block. Thus the name needs to be unique. Other than that, the name is
2373 not used in collectd.
2375 In each B<Query> block, there is one or more B<Result> blocks. B<Result> blocks
2376 define which column holds which value or instance information. You can use
2377 multiple B<Result> blocks to create multiple values from one returned row. This
2378 is especially useful, when queries take a long time and sending almost the same
2379 query again and again is not desirable.
2383 <Query "environment">
2384 Statement "select station, temperature, humidity from environment"
2387 # InstancePrefix "foo"
2388 InstancesFrom "station"
2389 ValuesFrom "temperature"
2393 InstancesFrom "station"
2394 ValuesFrom "humidity"
2398 The following options are accepted:
2402 =item B<Statement> I<SQL>
2404 Sets the statement that should be executed on the server. This is B<not>
2405 interpreted by collectd, but simply passed to the database server. Therefore,
2406 the SQL dialect that's used depends on the server collectd is connected to.
2408 The query has to return at least two columns, one for the instance and one
2409 value. You cannot omit the instance, even if the statement is guaranteed to
2410 always return exactly one line. In that case, you can usually specify something
2413 Statement "SELECT \"instance\", COUNT(*) AS value FROM table"
2415 (That works with MySQL but may not be valid SQL according to the spec. If you
2416 use a more strict database server, you may have to select from a dummy table or
2419 Please note that some databases, for example B<Oracle>, will fail if you
2420 include a semicolon at the end of the statement.
2422 =item B<MinVersion> I<Version>
2424 =item B<MaxVersion> I<Value>
2426 Only use this query for the specified database version. You can use these
2427 options to provide multiple queries with the same name but with a slightly
2428 different syntax. The plugin will use only those queries, where the specified
2429 minimum and maximum versions fit the version of the database in use.
2431 The database version is determined by C<dbi_conn_get_engine_version>, see the
2432 L<libdbi documentation|http://libdbi.sourceforge.net/docs/programmers-guide/reference-conn.html#DBI-CONN-GET-ENGINE-VERSION>
2433 for details. Basically, each part of the version is assumed to be in the range
2434 from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes
2435 "40102", version "5.0.42" becomes "50042".
2437 B<Warning:> The plugin will use B<all> matching queries, so if you specify
2438 multiple queries with the same name and B<overlapping> ranges, weird stuff will
2439 happen. Don't to it! A valid example would be something along these lines:
2450 In the above example, there are three ranges that don't overlap. The last one
2451 goes from version "5.1.0" to infinity, meaning "all later versions". Versions
2452 before "4.0.0" are not specified.
2454 =item B<Type> I<Type>
2456 The B<type> that's used for each line returned. See L<types.db(5)> for more
2457 details on how types are defined. In short: A type is a predefined layout of
2458 data and the number of values and type of values has to match the type
2461 If you specify "temperature" here, you need exactly one gauge column. If you
2462 specify "if_octets", you will need two counter columns. See the B<ValuesFrom>
2465 There must be exactly one B<Type> option inside each B<Result> block.
2467 =item B<InstancePrefix> I<prefix>
2469 Prepends I<prefix> to the type instance. If B<InstancesFrom> (see below) is not
2470 given, the string is simply copied. If B<InstancesFrom> is given, I<prefix> and
2471 all strings returned in the appropriate columns are concatenated together,
2472 separated by dashes I<("-")>.
2474 =item B<InstancesFrom> I<column0> [I<column1> ...]
2476 Specifies the columns whose values will be used to create the "type-instance"
2477 for each row. If you specify more than one column, the value of all columns
2478 will be joined together with dashes I<("-")> as separation characters.
2480 The plugin itself does not check whether or not all built instances are
2481 different. It's your responsibility to assure that each is unique. This is
2482 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
2483 sure that only one row is returned in this case.
2485 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type-instance
2488 =item B<ValuesFrom> I<column0> [I<column1> ...]
2490 Names the columns whose content is used as the actual data for the data sets
2491 that are dispatched to the daemon. How many such columns you need is determined
2492 by the B<Type> setting above. If you specify too many or not enough columns,
2493 the plugin will complain about that and no data will be submitted to the
2496 The actual data type in the columns is not that important. The plugin will
2497 automatically cast the values to the right type if it know how to do that. So
2498 it should be able to handle integer an floating point types, as well as strings
2499 (if they include a number at the beginning).
2501 There must be at least one B<ValuesFrom> option inside each B<Result> block.
2503 =item B<MetadataFrom> [I<column0> I<column1> ...]
2505 Names the columns whose content is used as metadata for the data sets
2506 that are dispatched to the daemon.
2508 The actual data type in the columns is not that important. The plugin will
2509 automatically cast the values to the right type if it know how to do that. So
2510 it should be able to handle integer an floating point types, as well as strings
2511 (if they include a number at the beginning).
2515 =head3 B<Database> blocks
2517 Database blocks define a connection to a database and which queries should be
2518 sent to that database. Since the used "dbi" library can handle a wide variety
2519 of databases, the configuration is very generic. If in doubt, refer to libdbi's
2520 documentationE<nbsp>- we stick as close to the terminology used there.
2522 Each database needs a "name" as string argument in the starting tag of the
2523 block. This name will be used as "PluginInstance" in the values submitted to
2524 the daemon. Other than that, that name is not used.
2528 =item B<Plugin> I<Plugin>
2530 Use I<Plugin> as the plugin name when submitting query results from
2531 this B<Database>. Defaults to C<dbi>.
2533 =item B<Interval> I<Interval>
2535 Sets the interval (in seconds) in which the values will be collected from this
2536 database. By default the global B<Interval> setting will be used.
2538 =item B<Driver> I<Driver>
2540 Specifies the driver to use to connect to the database. In many cases those
2541 drivers are named after the database they can connect to, but this is not a
2542 technical necessity. These drivers are sometimes referred to as "DBD",
2543 B<D>ataB<B>ase B<D>river, and some distributions ship them in separate
2544 packages. Drivers for the "dbi" library are developed by the B<libdbi-drivers>
2545 project at L<http://libdbi-drivers.sourceforge.net/>.
2547 You need to give the driver name as expected by the "dbi" library here. You
2548 should be able to find that in the documentation for each driver. If you
2549 mistype the driver name, the plugin will dump a list of all known driver names
2552 =item B<DriverOption> I<Key> I<Value>
2554 Sets driver-specific options. What option a driver supports can be found in the
2555 documentation for each driver, somewhere at
2556 L<http://libdbi-drivers.sourceforge.net/>. However, the options "host",
2557 "username", "password", and "dbname" seem to be deE<nbsp>facto standards.
2559 DBDs can register two types of options: String options and numeric options. The
2560 plugin will use the C<dbi_conn_set_option> function when the configuration
2561 provides a string and the C<dbi_conn_require_option_numeric> function when the
2562 configuration provides a number. So these two lines will actually result in
2563 different calls being used:
2565 DriverOption "Port" 1234 # numeric
2566 DriverOption "Port" "1234" # string
2568 Unfortunately, drivers are not too keen to report errors when an unknown option
2569 is passed to them, so invalid settings here may go unnoticed. This is not the
2570 plugin's fault, it will report errors if it gets them from the libraryE<nbsp>/
2571 the driver. If a driver complains about an option, the plugin will dump a
2572 complete list of all options understood by that driver to the log. There is no
2573 way to programmatically find out if an option expects a string or a numeric
2574 argument, so you will have to refer to the appropriate DBD's documentation to
2575 find this out. Sorry.
2577 =item B<SelectDB> I<Database>
2579 In some cases, the database name you connect with is not the database name you
2580 want to use for querying data. If this option is set, the plugin will "select"
2581 (switch to) that database after the connection is established.
2583 =item B<Query> I<QueryName>
2585 Associates the query named I<QueryName> with this database connection. The
2586 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
2587 blocks you want to refer to must be placed above the database block you want to
2590 =item B<Host> I<Hostname>
2592 Sets the B<host> field of I<value lists> to I<Hostname> when dispatching
2593 values. Defaults to the global hostname setting.
2601 =item B<Device> I<Device>
2603 Select partitions based on the devicename.
2605 See F</"IGNORELISTS"> for details.
2607 =item B<MountPoint> I<Directory>
2609 Select partitions based on the mountpoint.
2611 See F</"IGNORELISTS"> for details.
2613 =item B<FSType> I<FSType>
2615 Select partitions based on the filesystem type.
2617 See F</"IGNORELISTS"> for details.
2619 =item B<IgnoreSelected> B<true>|B<false>
2621 Invert the selection: If set to true, all partitions B<except> the ones that
2622 match any one of the criteria are collected. By default only selected
2623 partitions are collected if a selection is made. If no selection is configured
2624 at all, B<all> partitions are selected.
2626 =item B<ReportByDevice> B<true>|B<false>
2628 Report using the device name rather than the mountpoint. i.e. with this I<false>,
2629 (the default), it will report a disk as "root", but with it I<true>, it will be
2630 "sda1" (or whichever).
2632 =item B<ReportInodes> B<true>|B<false>
2634 Enables or disables reporting of free, reserved and used inodes. Defaults to
2635 inode collection being disabled.
2637 Enable this option if inodes are a scarce resource for you, usually because
2638 many small files are stored on the disk. This is a usual scenario for mail
2639 transfer agents and web caches.
2641 =item B<ValuesAbsolute> B<true>|B<false>
2643 Enables or disables reporting of free and used disk space in 1K-blocks.
2644 Defaults to B<true>.
2646 =item B<ValuesPercentage> B<false>|B<true>
2648 Enables or disables reporting of free and used disk space in percentage.
2649 Defaults to B<false>.
2651 This is useful for deploying I<collectd> on the cloud, where machines with
2652 different disk size may exist. Then it is more practical to configure
2653 thresholds based on relative disk size.
2657 =head2 Plugin C<disk>
2659 The C<disk> plugin collects information about the usage of physical disks and
2660 logical disks (partitions). Values collected are the number of octets written
2661 to and read from a disk or partition, the number of read/write operations
2662 issued to the disk and a rather complex "time" it took for these commands to be
2665 Using the following two options you can ignore some disks or configure the
2666 collection only of specific disks.
2670 =item B<Disk> I<Name>
2672 Select the disk I<Name>. Whether it is collected or ignored depends on the
2673 B<IgnoreSelected> setting, see below. As with other plugins that use the
2674 daemon's ignorelist functionality, a string that starts and ends with a slash
2675 is interpreted as a regular expression. Examples:
2680 See F</"IGNORELISTS"> for details.
2682 =item B<IgnoreSelected> B<true>|B<false>
2684 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
2685 statements, are ignored or if all other disks are ignored. The behavior
2686 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
2687 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
2688 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
2689 is set to B<true>, all disks are collected B<except> the ones matched.
2691 =item B<UseBSDName> B<true>|B<false>
2693 Whether to use the device's "BSD Name", on MacE<nbsp>OSE<nbsp>X, instead of the
2694 default major/minor numbers. Requires collectd to be built with Apple's
2697 =item B<UdevNameAttr> I<Attribute>
2699 Attempt to override disk instance name with the value of a specified udev
2700 attribute when built with B<libudev>. If the attribute is not defined for the
2701 given device, the default name is used. Example:
2703 UdevNameAttr "DM_NAME"
2707 =head2 Plugin C<dns>
2711 =item B<Interface> I<Interface>
2713 The dns plugin uses B<libpcap> to capture dns traffic and analyzes it. This
2714 option sets the interface that should be used. If this option is not set, or
2715 set to "any", the plugin will try to get packets from B<all> interfaces. This
2716 may not work on certain platforms, such as MacE<nbsp>OSE<nbsp>X.
2718 =item B<IgnoreSource> I<IP-address>
2720 Ignore packets that originate from this address.
2722 =item B<SelectNumericQueryTypes> B<true>|B<false>
2724 Enabled by default, collects unknown (and thus presented as numeric only) query types.
2728 =head2 Plugin C<dpdkevents>
2730 The I<dpdkevents plugin> collects events from DPDK such as link status of
2731 network ports and Keep Alive status of DPDK logical cores.
2732 In order to get Keep Alive events following requirements must be met:
2734 - support for Keep Alive implemented in DPDK application. More details can
2735 be found here: http://dpdk.org/doc/guides/sample_app_ug/keep_alive.html
2739 <Plugin "dpdkevents">
2745 <Event "link_status">
2746 SendEventsOnUpdate true
2747 EnabledPortMask 0xffff
2748 PortName "interface1"
2749 PortName "interface2"
2750 SendNotification false
2752 <Event "keep_alive">
2753 SendEventsOnUpdate true
2755 KeepAliveShmName "/dpdk_keepalive_shm_name"
2756 SendNotification false
2763 =head3 The EAL block
2767 =item B<Coremask> I<Mask>
2769 =item B<Memorychannels> I<Channels>
2771 Number of memory channels per processor socket.
2773 =item B<FilePrefix> I<File>
2775 The prefix text used for hugepage filenames. The filename will be set to
2776 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2780 =head3 The Event block
2782 The B<Event> block defines configuration for specific event. It accepts a
2783 single argument which specifies the name of the event.
2785 =head4 Link Status event
2789 =item B<SendEventOnUpdate> I<true|false>
2791 If set to true link status value will be dispatched only when it is
2792 different from previously read value. This is an optional argument - default
2795 =item B<EnabledPortMask> I<Mask>
2797 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2798 of 0x0 means that all ports will be disabled. A bitmask of all F's means
2799 that all ports will be enabled. This is an optional argument - by default
2800 all ports are enabled.
2802 =item B<PortName> I<Name>
2804 A string containing an optional name for the enabled DPDK ports. Each PortName
2805 option should contain only one port name; specify as many PortName options as
2806 desired. Default naming convention will be used if PortName is blank. If there
2807 are less PortName options than there are enabled ports, the default naming
2808 convention will be used for the additional ports.
2810 =item B<SendNotification> I<true|false>
2812 If set to true, link status notifications are sent, instead of link status
2813 being collected as a statistic. This is an optional argument - default
2818 =head4 Keep Alive event
2822 =item B<SendEventOnUpdate> I<true|false>
2824 If set to true keep alive value will be dispatched only when it is
2825 different from previously read value. This is an optional argument - default
2828 =item B<LCoreMask> I<Mask>
2830 An hexadecimal bit mask of the logical cores to monitor keep alive state.
2832 =item B<KeepAliveShmName> I<Name>
2834 Shared memory name identifier that is used by secondary process to monitor
2835 the keep alive cores state.
2837 =item B<SendNotification> I<true|false>
2839 If set to true, keep alive notifications are sent, instead of keep alive
2840 information being collected as a statistic. This is an optional
2841 argument - default value is false.
2845 =head2 Plugin C<dpdkstat>
2847 The I<dpdkstat plugin> collects information about DPDK interfaces using the
2848 extended NIC stats API in DPDK.
2859 RteDriverLibPath "/usr/lib/dpdk-pmd"
2861 SharedMemObj "dpdk_collectd_stats_0"
2862 EnabledPortMask 0xffff
2863 PortName "interface1"
2864 PortName "interface2"
2869 =head3 The EAL block
2873 =item B<Coremask> I<Mask>
2875 A string containing an hexadecimal bit mask of the cores to run on. Note that
2876 core numbering can change between platforms and should be determined beforehand.
2878 =item B<Memorychannels> I<Channels>
2880 A string containing a number of memory channels per processor socket.
2882 =item B<FilePrefix> I<File>
2884 The prefix text used for hugepage filenames. The filename will be set to
2885 /var/run/.<prefix>_config where prefix is what is passed in by the user.
2887 =item B<SocketMemory> I<MB>
2889 A string containing amount of Memory to allocate from hugepages on specific
2890 sockets in MB. This is an optional value.
2892 =item B<LogLevel> I<LogLevel_number>
2894 A string containing log level number. This parameter is optional.
2895 If parameter is not present then default value "7" - (INFO) is used.
2896 Value "8" - (DEBUG) can be set to enable debug traces.
2898 =item B<RteDriverLibPath> I<Path>
2900 A string containing path to shared pmd driver lib or path to directory,
2901 where shared pmd driver libs are available. This parameter is optional.
2902 This parameter enable loading of shared pmd driver libs from defined path.
2903 E.g.: "/usr/lib/dpdk-pmd/librte_pmd_i40e.so"
2904 or "/usr/lib/dpdk-pmd"
2910 =item B<SharedMemObj> I<Mask>
2912 A string containing the name of the shared memory object that should be used to
2913 share stats from the DPDK secondary process to the collectd dpdkstat plugin.
2914 Defaults to dpdk_collectd_stats if no other value is configured.
2916 =item B<EnabledPortMask> I<Mask>
2918 A hexidecimal bit mask of the DPDK ports which should be enabled. A mask
2919 of 0x0 means that all ports will be disabled. A bitmask of all Fs means
2920 that all ports will be enabled. This is an optional argument - default
2921 is all ports enabled.
2923 =item B<PortName> I<Name>
2925 A string containing an optional name for the enabled DPDK ports. Each PortName
2926 option should contain only one port name; specify as many PortName options as
2927 desired. Default naming convention will be used if PortName is blank. If there
2928 are less PortName options than there are enabled ports, the default naming
2929 convention will be used for the additional ports.
2933 =head2 Plugin C<email>
2937 =item B<SocketFile> I<Path>
2939 Sets the socket-file which is to be created.
2941 =item B<SocketGroup> I<Group>
2943 If running as root change the group of the UNIX-socket after it has been
2944 created. Defaults to B<collectd>.
2946 =item B<SocketPerms> I<Permissions>
2948 Change the file permissions of the UNIX-socket after it has been created. The
2949 permissions must be given as a numeric, octal value as you would pass to
2950 L<chmod(1)>. Defaults to B<0770>.
2952 =item B<MaxConns> I<Number>
2954 Sets the maximum number of connections that can be handled in parallel. Since
2955 this many threads will be started immediately setting this to a very high
2956 value will waste valuable resources. Defaults to B<5> and will be forced to be
2957 at most B<16384> to prevent typos and dumb mistakes.
2961 =head2 Plugin C<ethstat>
2963 The I<ethstat plugin> collects information about network interface cards (NICs)
2964 by talking directly with the underlying kernel driver using L<ioctl(2)>.
2970 Map "rx_csum_offload_errors" "if_rx_errors" "checksum_offload"
2971 Map "multicast" "if_multicast"
2978 =item B<Interface> I<Name>
2980 Collect statistical information about interface I<Name>.
2982 =item B<Map> I<Name> I<Type> [I<TypeInstance>]
2984 By default, the plugin will submit values as type C<derive> and I<type
2985 instance> set to I<Name>, the name of the metric as reported by the driver. If
2986 an appropriate B<Map> option exists, the given I<Type> and, optionally,
2987 I<TypeInstance> will be used.
2989 =item B<MappedOnly> B<true>|B<false>
2991 When set to B<true>, only metrics that can be mapped to a I<type> will be
2992 collected, all other metrics will be ignored. Defaults to B<false>.
2996 =head2 Plugin C<exec>
2998 Please make sure to read L<collectd-exec(5)> before using this plugin. It
2999 contains valuable information on when the executable is executed and the
3000 output that is expected from it.
3004 =item B<Exec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
3006 =item B<NotificationExec> I<User>[:[I<Group>]] I<Executable> [I<E<lt>argE<gt>> [I<E<lt>argE<gt>> ...]]
3008 Execute the executable I<Executable> as user I<User>. If the user name is
3009 followed by a colon and a group name, the effective group is set to that group.
3010 The real group and saved-set group will be set to the default group of that
3011 user. If no group is given the effective group ID will be the same as the real
3014 Please note that in order to change the user and/or group the daemon needs
3015 superuser privileges. If the daemon is run as an unprivileged user you must
3016 specify the same user/group here. If the daemon is run with superuser
3017 privileges, you must supply a non-root user here.
3019 The executable may be followed by optional arguments that are passed to the
3020 program. Please note that due to the configuration parsing numbers and boolean
3021 values may be changed. If you want to be absolutely sure that something is
3022 passed as-is please enclose it in quotes.
3024 The B<Exec> and B<NotificationExec> statements change the semantics of the
3025 programs executed, i.E<nbsp>e. the data passed to them and the response
3026 expected from them. This is documented in great detail in L<collectd-exec(5)>.
3030 =head2 Plugin C<fhcount>
3032 The C<fhcount> plugin provides statistics about used, unused and total number of
3033 file handles on Linux.
3035 The I<fhcount plugin> provides the following configuration options:
3039 =item B<ValuesAbsolute> B<true>|B<false>
3041 Enables or disables reporting of file handles usage in absolute numbers,
3042 e.g. file handles used. Defaults to B<true>.
3044 =item B<ValuesPercentage> B<false>|B<true>
3046 Enables or disables reporting of file handles usage in percentages, e.g.
3047 percent of file handles used. Defaults to B<false>.
3051 =head2 Plugin C<filecount>
3053 The C<filecount> plugin counts the number of files in a certain directory (and
3054 its subdirectories) and their combined size. The configuration is very straight
3057 <Plugin "filecount">
3058 <Directory "/var/qmail/queue/mess">
3059 Instance "qmail-message"
3061 <Directory "/var/qmail/queue/todo">
3062 Instance "qmail-todo"
3064 <Directory "/var/lib/php5">
3065 Instance "php5-sessions"
3070 The example above counts the number of files in QMail's queue directories and
3071 the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that
3072 QMail has not yet looked at, the "message" queue holds the messages that were
3073 classified into "local" and "remote".
3075 As you can see, the configuration consists of one or more C<Directory> blocks,
3076 each of which specifies a directory in which to count the files. Within those
3077 blocks, the following options are recognized:
3081 =item B<Plugin> I<Plugin>
3083 Use I<Plugin> as the plugin name when submitting values.
3084 Defaults to B<filecount>.
3086 =item B<Instance> I<Instance>
3088 Sets the plugin instance to I<Instance>. If not given, the instance is set to
3089 the directory name with all slashes replaced by underscores and all leading
3090 underscores removed. Empty value is allowed.
3092 =item B<Name> I<Pattern>
3094 Only count files that match I<Pattern>, where I<Pattern> is a shell-like
3095 wildcard as understood by L<fnmatch(3)>. Only the B<filename> is checked
3096 against the pattern, not the entire path. In case this makes it easier for you:
3097 This option has been named after the B<-name> parameter to L<find(1)>.
3099 =item B<MTime> I<Age>
3101 Count only files of a specific age: If I<Age> is greater than zero, only files
3102 that haven't been touched in the last I<Age> seconds are counted. If I<Age> is
3103 a negative number, this is inversed. For example, if B<-60> is specified, only
3104 files that have been modified in the last minute will be counted.
3106 The number can also be followed by a "multiplier" to easily specify a larger
3107 timespan. When given in this notation, the argument must in quoted, i.E<nbsp>e.
3108 must be passed as string. So the B<-60> could also be written as B<"-1m"> (one
3109 minute). Valid multipliers are C<s> (second), C<m> (minute), C<h> (hour), C<d>
3110 (day), C<w> (week), and C<y> (year). There is no "month" multiplier. You can
3111 also specify fractional numbers, e.E<nbsp>g. B<"0.5d"> is identical to
3114 =item B<Size> I<Size>
3116 Count only files of a specific size. When I<Size> is a positive number, only
3117 files that are at least this big are counted. If I<Size> is a negative number,
3118 this is inversed, i.E<nbsp>e. only files smaller than the absolute value of
3119 I<Size> are counted.
3121 As with the B<MTime> option, a "multiplier" may be added. For a detailed
3122 description see above. Valid multipliers here are C<b> (byte), C<k> (kilobyte),
3123 C<m> (megabyte), C<g> (gigabyte), C<t> (terabyte), and C<p> (petabyte). Please
3124 note that there are 1000 bytes in a kilobyte, not 1024.
3126 =item B<Recursive> I<true>|I<false>
3128 Controls whether or not to recurse into subdirectories. Enabled by default.
3130 =item B<IncludeHidden> I<true>|I<false>
3132 Controls whether or not to include "hidden" files and directories in the count.
3133 "Hidden" files and directories are those, whose name begins with a dot.
3134 Defaults to I<false>, i.e. by default hidden files and directories are ignored.
3136 =item B<RegularOnly> I<true>|I<false>
3138 Controls whether or not to include only regular files in the count.
3139 Defaults to I<true>, i.e. by default non regular files are ignored.
3141 =item B<FilesSizeType> I<Type>
3143 Sets the type used to dispatch files combined size. Empty value ("") disables
3144 reporting. Defaults to B<bytes>.
3146 =item B<FilesCountType> I<Type>
3148 Sets the type used to dispatch number of files. Empty value ("") disables
3149 reporting. Defaults to B<files>.
3151 =item B<TypeInstance> I<Instance>
3153 Sets the I<type instance> used to dispatch values. Defaults to an empty string
3154 (no plugin instance).
3158 =head2 Plugin C<GenericJMX>
3160 The I<GenericJMX plugin> is written in I<Java> and therefore documented in
3161 L<collectd-java(5)>.
3163 =head2 Plugin C<gmond>
3165 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the
3166 statistics collection daemon of Ganglia. Mappings for the standard "metrics"
3167 are built-in, custom mappings may be added via B<Metric> blocks, see below.
3172 MCReceiveFrom "239.2.11.71" "8649"
3173 <Metric "swap_total">
3175 TypeInstance "total"
3178 <Metric "swap_free">
3185 The following metrics are built-in:
3191 load_one, load_five, load_fifteen
3195 cpu_user, cpu_system, cpu_idle, cpu_nice, cpu_wio
3199 mem_free, mem_shared, mem_buffers, mem_cached, mem_total
3211 Available configuration options:
3215 =item B<MCReceiveFrom> I<MCGroup> [I<Port>]
3217 Sets sets the multicast group and UDP port to which to subscribe.
3219 Default: B<239.2.11.71>E<nbsp>/E<nbsp>B<8649>
3221 =item E<lt>B<Metric> I<Name>E<gt>
3223 These blocks add a new metric conversion to the internal table. I<Name>, the
3224 string argument to the B<Metric> block, is the metric name as used by Ganglia.
3228 =item B<Type> I<Type>
3230 Type to map this metric to. Required.
3232 =item B<TypeInstance> I<Instance>
3234 Type-instance to use. Optional.
3236 =item B<DataSource> I<Name>
3238 Data source to map this metric to. If the configured type has exactly one data
3239 source, this is optional. Otherwise the option is required.
3245 =head2 Plugin C<gps>
3247 The C<gps plugin> connects to gpsd on the host machine.
3248 The host, port, timeout and pause are configurable.
3250 This is useful if you run an NTP server using a GPS for source and you want to
3253 Mind your GPS must send $--GSA for having the data reported!
3255 The following elements are collected:
3261 Number of satellites used for fix (type instance "used") and in view (type
3262 instance "visible"). 0 means no GPS satellites are visible.
3264 =item B<dilution_of_precision>
3266 Vertical and horizontal dilution (type instance "horizontal" or "vertical").
3267 It should be between 0 and 3.
3268 Look at the documentation of your GPS to know more.
3276 # Connect to localhost on gpsd regular port:
3281 # PauseConnect of 5 sec. between connection attempts.
3285 Available configuration options:
3289 =item B<Host> I<Host>
3291 The host on which gpsd daemon runs. Defaults to B<localhost>.
3293 =item B<Port> I<Port>
3295 Port to connect to gpsd on the host machine. Defaults to B<2947>.
3297 =item B<Timeout> I<Seconds>
3299 Timeout in seconds (default 0.015 sec).
3301 The GPS data stream is fetch by the plugin form the daemon.
3302 It waits for data to be available, if none arrives it times out
3303 and loop for another reading.
3304 Mind to put a low value gpsd expects value in the micro-seconds area
3305 (recommended is 500 us) since the waiting function is blocking.
3306 Value must be between 500 us and 5 sec., if outside that range the
3307 default value is applied.
3309 This only applies from gpsd release-2.95.
3311 =item B<PauseConnect> I<Seconds>
3313 Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).
3317 =head2 Plugin C<grpc>
3319 The I<grpc> plugin provides an RPC interface to submit values to or query
3320 values from collectd based on the open source gRPC framework. It exposes an
3321 end-point for dispatching values to the daemon.
3323 The B<gRPC> homepage can be found at L<https://grpc.io/>.
3327 =item B<Server> I<Host> I<Port>
3329 The B<Server> statement sets the address of a server to which to send metrics
3330 via the C<DispatchValues> function.
3332 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3334 Optionally, B<Server> may be specified as a configuration block which supports
3335 the following options:
3339 =item B<EnableSSL> B<false>|B<true>
3341 Whether to require SSL for outgoing connections. Default: false.
3343 =item B<SSLCACertificateFile> I<Filename>
3345 =item B<SSLCertificateFile> I<Filename>
3347 =item B<SSLCertificateKeyFile> I<Filename>
3349 Filenames specifying SSL certificate and key material to be used with SSL
3354 =item B<Listen> I<Host> I<Port>
3356 The B<Listen> statement sets the network address to bind to. When multiple
3357 statements are specified, the daemon will bind to all of them. If none are
3358 specified, it defaults to B<0.0.0.0:50051>.
3360 The argument I<Host> may be a hostname, an IPv4 address, or an IPv6 address.
3362 Optionally, B<Listen> may be specified as a configuration block which
3363 supports the following options:
3367 =item B<EnableSSL> I<true>|I<false>
3369 Whether to enable SSL for incoming connections. Default: false.
3371 =item B<SSLCACertificateFile> I<Filename>
3373 =item B<SSLCertificateFile> I<Filename>
3375 =item B<SSLCertificateKeyFile> I<Filename>
3377 Filenames specifying SSL certificate and key material to be used with SSL
3380 =item B<VerifyPeer> B<true>|B<false>
3382 When enabled, a valid client certificate is required to connect to the server.
3383 When disabled, a client certifiacte is not requested and any unsolicited client
3384 certificate is accepted.
3391 =head2 Plugin C<hddtemp>
3393 To get values from B<hddtemp> collectd connects to B<localhost> (127.0.0.1),
3394 port B<7634/tcp>. The B<Host> and B<Port> options can be used to change these
3395 default values, see below. C<hddtemp> has to be running to work correctly. If
3396 C<hddtemp> is not running timeouts may appear which may interfere with other
3399 The B<hddtemp> homepage can be found at
3400 L<http://www.guzu.net/linux/hddtemp.php>.
3404 =item B<Host> I<Hostname>
3406 Hostname to connect to. Defaults to B<127.0.0.1>.
3408 =item B<Port> I<Port>
3410 TCP-Port to connect to. Defaults to B<7634>.
3414 =head2 Plugin C<hugepages>
3416 To collect B<hugepages> information, collectd reads directories
3417 "/sys/devices/system/node/*/hugepages" and
3418 "/sys/kernel/mm/hugepages".
3419 Reading of these directories can be disabled by the following
3420 options (default is enabled).
3424 =item B<ReportPerNodeHP> B<true>|B<false>
3426 If enabled, information will be collected from the hugepage
3427 counters in "/sys/devices/system/node/*/hugepages".
3428 This is used to check the per-node hugepage statistics on
3431 =item B<ReportRootHP> B<true>|B<false>
3433 If enabled, information will be collected from the hugepage
3434 counters in "/sys/kernel/mm/hugepages".
3435 This can be used on both NUMA and non-NUMA systems to check
3436 the overall hugepage statistics.
3438 =item B<ValuesPages> B<true>|B<false>
3440 Whether to report hugepages metrics in number of pages.
3441 Defaults to B<true>.
3443 =item B<ValuesBytes> B<false>|B<true>
3445 Whether to report hugepages metrics in bytes.
3446 Defaults to B<false>.
3448 =item B<ValuesPercentage> B<false>|B<true>
3450 Whether to report hugepages metrics as percentage.
3451 Defaults to B<false>.
3455 =head2 Plugin C<intel_pmu>
3457 The I<intel_pmu> plugin collects performance counters data on Intel CPUs using
3458 Linux perf interface. All events are reported on a per core basis.
3463 ReportHardwareCacheEvents true
3464 ReportKernelPMUEvents true
3465 ReportSoftwareEvents true
3466 EventList "/var/cache/pmu/GenuineIntel-6-2D-core.json"
3467 HardwareEvents "L2_RQSTS.CODE_RD_HIT,L2_RQSTS.CODE_RD_MISS" "L2_RQSTS.ALL_CODE_RD"
3468 Cores "0-3" "4,6" "[12-15]"
3475 =item B<ReportHardwareCacheEvents> B<false>|B<true>
3477 Enable or disable measuring of hardware CPU cache events:
3479 - L1-dcache-load-misses
3481 - L1-dcache-store-misses
3482 - L1-dcache-prefetches
3483 - L1-dcache-prefetch-misses
3485 - L1-icache-load-misses
3486 - L1-icache-prefetches
3487 - L1-icache-prefetch-misses
3493 - LLC-prefetch-misses
3499 - dTLB-prefetch-misses
3503 - branch-load-misses
3505 =item B<ReportKernelPMUEvents> B<false>|B<true>
3507 Enable or disable measuring of the following events:
3516 =item B<ReportSoftwareEvents> B<false>|B<true>
3518 Enable or disable measuring of software events provided by kernel:
3529 =item B<EventList> I<filename>
3531 JSON performance counter event list file name. To be able to monitor all Intel
3532 CPU specific events JSON event list file should be downloaded. Use the pmu-tools
3533 event_download.py script to download event list for current CPU.
3535 =item B<HardwareEvents> I<events>
3537 This field is a list of event names or groups of comma separated event names.
3538 This option requires B<EventList> option to be configured.
3540 =item B<Cores> I<cores groups>
3542 All events are reported on a per core basis. Monitoring of the events can be
3543 configured for a group of cores (aggregated statistics). This field defines
3544 groups of cores on which to monitor supported events. The field is represented
3545 as list of strings with core group values. Each string represents a list of
3546 cores in a group. If a group is enclosed in square brackets each core is added
3547 individually to a separate group (that is statistics are not aggregated).
3548 Allowed formats are:
3554 If an empty string is provided as value for this field default cores
3555 configuration is applied - that is separate group is created for each core.
3559 =head2 Plugin C<intel_rdt>
3561 The I<intel_rdt> plugin collects information provided by monitoring features of
3562 Intel Resource Director Technology (Intel(R) RDT) like Cache Monitoring
3563 Technology (CMT), Memory Bandwidth Monitoring (MBM). These features provide
3564 information about utilization of shared resources. CMT monitors last level cache
3565 occupancy (LLC). MBM supports two types of events reporting local and remote
3566 memory bandwidth. Local memory bandwidth (MBL) reports the bandwidth of
3567 accessing memory associated with the local socket. Remote memory bandwidth (MBR)
3568 reports the bandwidth of accessing the remote socket. Also this technology
3569 allows to monitor instructions per clock (IPC).
3570 Monitor events are hardware dependant. Monitoring capabilities are detected on
3571 plugin initialization and only supported events are monitored.
3573 B<Note:> I<intel_rdt> plugin is using model-specific registers (MSRs), which
3574 require an additional capability to be enabled if collectd is run as a service.
3575 Please refer to I<contrib/systemd.collectd.service> file for more details.
3579 <Plugin "intel_rdt">
3580 Cores "0-2" "3,4,6" "8-10,15"
3587 =item B<Interval> I<seconds>
3589 The interval within which to retrieve statistics on monitored events in seconds.
3590 For milliseconds divide the time by 1000 for example if the desired interval
3591 is 50ms, set interval to 0.05. Due to limited capacity of counters it is not
3592 recommended to set interval higher than 1 sec.
3594 =item B<Cores> I<cores groups>
3596 All events are reported on a per core basis. Monitoring of the events can be
3597 configured for group of cores (aggregated statistics). This field defines groups
3598 of cores on which to monitor supported events. The field is represented as list
3599 of strings with core group values. Each string represents a list of cores in a
3600 group. Allowed formats are:
3605 If an empty string is provided as value for this field default cores
3606 configuration is applied - a separate group is created for each core.
3610 B<Note:> By default global interval is used to retrieve statistics on monitored
3611 events. To configure a plugin specific interval use B<Interval> option of the
3612 intel_rdt <LoadPlugin> block. For milliseconds divide the time by 1000 for
3613 example if the desired interval is 50ms, set interval to 0.05.
3614 Due to limited capacity of counters it is not recommended to set interval higher
3617 =head2 Plugin C<interface>
3621 =item B<Interface> I<Interface>
3623 Select this interface. By default these interfaces will then be collected. For
3624 a more detailed description see B<IgnoreSelected> below.
3626 See F</"IGNORELISTS"> for details.
3628 =item B<IgnoreSelected> I<true>|I<false>
3630 If no configuration is given, the B<interface>-plugin will collect data from
3631 all interfaces. This may not be practical, especially for loopback- and
3632 similar interfaces. Thus, you can use the B<Interface>-option to pick the
3633 interfaces you're interested in. Sometimes, however, it's easier/preferred
3634 to collect all interfaces I<except> a few ones. This option enables you to
3635 do that: By setting B<IgnoreSelected> to I<true> the effect of
3636 B<Interface> is inverted: All selected interfaces are ignored and all
3637 other interfaces are collected.
3639 It is possible to use regular expressions to match interface names, if the
3640 name is surrounded by I</.../> and collectd was compiled with support for
3641 regexps. This is useful if there's a need to collect (or ignore) data
3642 for a group of interfaces that are similarly named, without the need to
3643 explicitly list all of them (especially useful if the list is dynamic).
3648 Interface "/^tun[0-9]+/"
3649 IgnoreSelected "true"
3651 This will ignore the loopback interface, all interfaces with names starting
3652 with I<veth> and all interfaces with names starting with I<tun> followed by
3655 =item B<ReportInactive> I<true>|I<false>
3657 When set to I<false>, only interfaces with non-zero traffic will be
3658 reported. Note that the check is done by looking into whether a
3659 package was sent at any time from boot and the corresponding counter
3660 is non-zero. So, if the interface has been sending data in the past
3661 since boot, but not during the reported time-interval, it will still
3664 The default value is I<true> and results in collection of the data
3665 from all interfaces that are selected by B<Interface> and
3666 B<IgnoreSelected> options.
3668 =item B<UniqueName> I<true>|I<false>
3670 Interface name is not unique on Solaris (KSTAT), interface name is unique
3671 only within a module/instance. Following tuple is considered unique:
3672 (ks_module, ks_instance, ks_name)
3673 If this option is set to true, interface name contains above three fields
3674 separated by an underscore. For more info on KSTAT, visit
3675 L<http://docs.oracle.com/cd/E23824_01/html/821-1468/kstat-3kstat.html#REFMAN3Ekstat-3kstat>
3677 This option is only available on Solaris.
3681 =head2 Plugin C<ipmi>
3683 The B<ipmi plugin> allows to monitor server platform status using the Intelligent
3684 Platform Management Interface (IPMI). Local and remote interfaces are supported.
3686 The plugin configuration consists of one or more B<Instance> blocks which
3687 specify one I<ipmi> connection each. Each block requires one unique string
3688 argument as the instance name. If instances are not configured, an instance with
3689 the default option values will be created.
3691 For backwards compatibility, any option other than B<Instance> block will trigger
3692 legacy config handling and it will be treated as an option within B<Instance>
3693 block. This support will go away in the next major version of Collectd.
3695 Within the B<Instance> blocks, the following options are allowed:
3699 =item B<Address> I<Address>
3701 Hostname or IP to connect to. If not specified, plugin will try to connect to
3702 local management controller (BMC).
3704 =item B<Username> I<Username>
3706 =item B<Password> I<Password>
3708 The username and the password to use for the connection to remote BMC.
3710 =item B<AuthType> I<MD5>|I<rmcp+>
3712 Forces the authentication type to use for the connection to remote BMC.
3713 By default most secure type is seleted.
3715 =item B<Host> I<Hostname>
3717 Sets the B<host> field of dispatched values. Defaults to the global hostname
3720 =item B<Sensor> I<Sensor>
3722 Selects sensors to collect or to ignore, depending on B<IgnoreSelected>.
3724 See F</"IGNORELISTS"> for details.
3726 =item B<IgnoreSelected> I<true>|I<false>
3728 If no configuration if given, the B<ipmi> plugin will collect data from all
3729 sensors found of type "temperature", "voltage", "current" and "fanspeed".
3730 This option enables you to do that: By setting B<IgnoreSelected> to I<true>
3731 the effect of B<Sensor> is inverted: All selected sensors are ignored and
3732 all other sensors are collected.
3734 =item B<NotifySensorAdd> I<true>|I<false>
3736 If a sensor appears after initialization time of a minute a notification
3739 =item B<NotifySensorRemove> I<true>|I<false>
3741 If a sensor disappears a notification is sent.
3743 =item B<NotifySensorNotPresent> I<true>|I<false>
3745 If you have for example dual power supply and one of them is (un)plugged then
3746 a notification is sent.
3748 =item B<NotifyIPMIConnectionState> I<true>|I<false>
3750 If a IPMI connection state changes after initialization time of a minute
3751 a notification is sent. Defaults to B<false>.
3753 =item B<SELEnabled> I<true>|I<false>
3755 If system event log (SEL) is enabled, plugin will listen for sensor threshold
3756 and discrete events. When event is received the notification is sent.
3757 SEL event filtering can be configured using B<SELSensor> and B<SELIgnoreSelected>
3759 Defaults to B<false>.
3761 =item B<SELSensor> I<SELSensor>
3763 Selects sensors to get events from or to ignore, depending on B<SELIgnoreSelected>.
3765 See F</"IGNORELISTS"> for details.
3767 =item B<SELIgnoreSelected> I<true>|I<false>
3769 If no configuration is given, the B<ipmi> plugin will pass events from all
3770 sensors. This option enables you to do that: By setting B<SELIgnoreSelected>
3771 to I<true> the effect of B<SELSensor> is inverted: All events from selected
3772 sensors are ignored and all events from other sensors are passed.
3774 =item B<SELClearEvent> I<true>|I<false>
3776 If SEL clear event is enabled, plugin will delete event from SEL list after
3777 it is received and successfully handled. In this case other tools that are
3778 subscribed for SEL events will receive an empty event.
3779 Defaults to B<false>.
3783 =head2 Plugin C<iptables>
3787 =item B<Chain> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3789 =item B<Chain6> I<Table> I<Chain> [I<Comment|Number> [I<Name>]]
3791 Select the iptables/ip6tables filter rules to count packets and bytes from.
3793 If only I<Table> and I<Chain> are given, this plugin will collect the counters
3794 of all rules which have a comment-match. The comment is then used as
3797 If I<Comment> or I<Number> is given, only the rule with the matching comment or
3798 the I<n>th rule will be collected. Again, the comment (or the number) will be
3799 used as the type-instance.
3801 If I<Name> is supplied, it will be used as the type-instance instead of the
3802 comment or the number.
3806 =head2 Plugin C<irq>
3812 Select this irq. By default these irqs will then be collected. For a more
3813 detailed description see B<IgnoreSelected> below.
3815 See F</"IGNORELISTS"> for details.
3817 =item B<IgnoreSelected> I<true>|I<false>
3819 If no configuration if given, the B<irq>-plugin will collect data from all
3820 irqs. This may not be practical, especially if no interrupts happen. Thus, you
3821 can use the B<Irq>-option to pick the interrupt you're interested in.
3822 Sometimes, however, it's easier/preferred to collect all interrupts I<except> a
3823 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
3824 I<true> the effect of B<Irq> is inverted: All selected interrupts are ignored
3825 and all other interrupts are collected.
3829 =head2 Plugin C<java>
3831 The I<Java> plugin makes it possible to write extensions for collectd in Java.
3832 This section only discusses the syntax and semantic of the configuration
3833 options. For more in-depth information on the I<Java> plugin, please read
3834 L<collectd-java(5)>.
3839 JVMArg "-verbose:jni"
3840 JVMArg "-Djava.class.path=/opt/collectd/lib/collectd/bindings/java"
3841 LoadPlugin "org.collectd.java.Foobar"
3842 <Plugin "org.collectd.java.Foobar">
3843 # To be parsed by the plugin
3847 Available configuration options:
3851 =item B<JVMArg> I<Argument>
3853 Argument that is to be passed to the I<Java Virtual Machine> (JVM). This works
3854 exactly the way the arguments to the I<java> binary on the command line work.
3855 Execute C<javaE<nbsp>--help> for details.
3857 Please note that B<all> these options must appear B<before> (i.E<nbsp>e. above)
3858 any other options! When another option is found, the JVM will be started and
3859 later options will have to be ignored!
3861 =item B<LoadPlugin> I<JavaClass>
3863 Instantiates a new I<JavaClass> object. The constructor of this object very
3864 likely then registers one or more callback methods with the server.
3866 See L<collectd-java(5)> for details.
3868 When the first such option is found, the virtual machine (JVM) is created. This
3869 means that all B<JVMArg> options must appear before (i.E<nbsp>e. above) all
3870 B<LoadPlugin> options!
3872 =item B<Plugin> I<Name>
3874 The entire block is passed to the Java plugin as an
3875 I<org.collectd.api.OConfigItem> object.
3877 For this to work, the plugin has to register a configuration callback first,
3878 see L<collectd-java(5)/"config callback">. This means, that the B<Plugin> block
3879 must appear after the appropriate B<LoadPlugin> block. Also note, that I<Name>
3880 depends on the (Java) plugin registering the callback and is completely
3881 independent from the I<JavaClass> argument passed to B<LoadPlugin>.
3885 =head2 Plugin C<load>
3887 The I<Load plugin> collects the system load. These numbers give a rough overview
3888 over the utilization of a machine. The system load is defined as the number of
3889 runnable tasks in the run-queue and is provided by many operating systems as a
3890 one, five or fifteen minute average.
3892 The following configuration options are available:
3896 =item B<ReportRelative> B<false>|B<true>
3898 When enabled, system load divided by number of available CPU cores is reported
3899 for intervals 1 min, 5 min and 15 min. Defaults to false.
3904 =head2 Plugin C<logfile>
3908 =item B<LogLevel> B<debug|info|notice|warning|err>
3910 Sets the log-level. If, for example, set to B<notice>, then all events with
3911 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3913 Please note that B<debug> is only available if collectd has been compiled with
3916 =item B<File> I<File>
3918 Sets the file to write log messages to. The special strings B<stdout> and
3919 B<stderr> can be used to write to the standard output and standard error
3920 channels, respectively. This, of course, only makes much sense when I<collectd>
3921 is running in foreground- or non-daemon-mode.
3923 =item B<Timestamp> B<true>|B<false>
3925 Prefix all lines printed by the current time. Defaults to B<true>.
3927 =item B<PrintSeverity> B<true>|B<false>
3929 When enabled, all lines are prefixed by the severity of the log message, for
3930 example "warning". Defaults to B<false>.
3934 B<Note>: There is no need to notify the daemon after moving or removing the
3935 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3936 for each line it writes.
3938 =head2 Plugin C<log_logstash>
3940 The I<log logstash plugin> behaves like the logfile plugin but formats
3941 messages as JSON events for logstash to parse and input.
3945 =item B<LogLevel> B<debug|info|notice|warning|err>
3947 Sets the log-level. If, for example, set to B<notice>, then all events with
3948 severity B<notice>, B<warning>, or B<err> will be written to the logfile.
3950 Please note that B<debug> is only available if collectd has been compiled with
3953 =item B<File> I<File>
3955 Sets the file to write log messages to. The special strings B<stdout> and
3956 B<stderr> can be used to write to the standard output and standard error
3957 channels, respectively. This, of course, only makes much sense when I<collectd>
3958 is running in foreground- or non-daemon-mode.
3962 B<Note>: There is no need to notify the daemon after moving or removing the
3963 log file (e.E<nbsp>g. when rotating the logs). The plugin reopens the file
3964 for each line it writes.
3966 =head2 Plugin C<lpar>
3968 The I<LPAR plugin> reads CPU statistics of I<Logical Partitions>, a
3969 virtualization technique for IBM POWER processors. It takes into account CPU
3970 time stolen from or donated to a partition, in addition to the usual user,
3971 system, I/O statistics.
3973 The following configuration options are available:
3977 =item B<CpuPoolStats> B<false>|B<true>
3979 When enabled, statistics about the processor pool are read, too. The partition
3980 needs to have pool authority in order to be able to acquire this information.
3983 =item B<ReportBySerial> B<false>|B<true>
3985 If enabled, the serial of the physical machine the partition is currently
3986 running on is reported as I<hostname> and the logical hostname of the machine
3987 is reported in the I<plugin instance>. Otherwise, the logical hostname will be
3988 used (just like other plugins) and the I<plugin instance> will be empty.
3993 =head2 Plugin C<lua>
3995 This plugin embeds a Lua interpreter into collectd and provides an interface
3996 to collectd's plugin system. See L<collectd-lua(5)> for its documentation.
3999 =head2 Plugin C<mbmon>
4001 The C<mbmon plugin> uses mbmon to retrieve temperature, voltage, etc.
4003 Be default collectd connects to B<localhost> (127.0.0.1), port B<411/tcp>. The
4004 B<Host> and B<Port> options can be used to change these values, see below.
4005 C<mbmon> has to be running to work correctly. If C<mbmon> is not running
4006 timeouts may appear which may interfere with other statistics..
4008 C<mbmon> must be run with the -r option ("print TAG and Value format");
4009 Debian's F</etc/init.d/mbmon> script already does this, other people
4010 will need to ensure that this is the case.
4014 =item B<Host> I<Hostname>
4016 Hostname to connect to. Defaults to B<127.0.0.1>.
4018 =item B<Port> I<Port>
4020 TCP-Port to connect to. Defaults to B<411>.
4024 =head2 Plugin C<mcelog>
4026 The C<mcelog plugin> uses mcelog to retrieve machine check exceptions.
4028 By default the plugin connects to B<"/var/run/mcelog-client"> to check if the
4029 mcelog server is running. When the server is running, the plugin will tail the
4030 specified logfile to retrieve machine check exception information and send a
4031 notification with the details from the logfile. The plugin will use the mcelog
4032 client protocol to retrieve memory related machine check exceptions. Note that
4033 for memory exceptions, notifications are only sent when there is a change in
4034 the number of corrected/uncorrected memory errors.
4036 =head3 The Memory block
4038 Note: these options cannot be used in conjunction with the logfile options, they are mutually
4043 =item B<McelogClientSocket> I<Path>
4044 Connect to the mcelog client socket using the UNIX domain socket at I<Path>.
4045 Defaults to B<"/var/run/mcelog-client">.
4047 =item B<PersistentNotification> B<true>|B<false>
4048 Override default configuration to only send notifications when sent when there
4049 is a change in the number of corrected/uncorrected memory errors. When set to
4050 true notifications will be sent for every read cycle. Default is false. Does
4051 not affect the stats being dispatched.
4057 =item B<McelogLogfile> I<Path>
4059 The mcelog file to parse. Defaults to B<"/var/log/mcelog">. Note: this option
4060 cannot be used in conjunction with the memory block options, they are mutually
4067 The C<md plugin> collects information from Linux Software-RAID devices (md).
4069 All reported values are of the type C<md_disks>. Reported type instances are
4070 I<active>, I<failed> (present but not operational), I<spare> (hot stand-by) and
4071 I<missing> (physically absent) disks.
4075 =item B<Device> I<Device>
4077 Select md devices based on device name. The I<device name> is the basename of
4078 the device, i.e. the name of the block device without the leading C</dev/>.
4079 See B<IgnoreSelected> for more details.
4081 See F</"IGNORELISTS"> for details.
4083 =item B<IgnoreSelected> B<true>|B<false>
4085 Invert device selection: If set to B<true>, all md devices B<except> those
4086 listed using B<Device> are collected. If B<false> (the default), only those
4087 listed are collected. If no configuration is given, the B<md> plugin will
4088 collect data from all md devices.
4092 =head2 Plugin C<memcachec>
4094 The C<memcachec plugin> connects to a memcached server, queries one or more
4095 given I<pages> and parses the returned data according to user specification.
4096 The I<matches> used are the same as the matches used in the C<curl> and C<tail>
4099 In order to talk to the memcached server, this plugin uses the I<libmemcached>
4100 library. Please note that there is another library with a very similar name,
4101 libmemcache (notice the missing `d'), which is not applicable.
4103 Synopsis of the configuration:
4105 <Plugin "memcachec">
4106 <Page "plugin_instance">
4109 Plugin "plugin_name"
4111 Regex "(\\d+) bytes sent"
4114 Instance "type_instance"
4119 The configuration options are:
4123 =item E<lt>B<Page> I<Name>E<gt>
4125 Each B<Page> block defines one I<page> to be queried from the memcached server.
4126 The block requires one string argument which is used as I<plugin instance>.
4128 =item B<Server> I<Address>
4130 Sets the server address to connect to when querying the page. Must be inside a
4135 When connected to the memcached server, asks for the page I<Key>.
4137 =item B<Plugin> I<Plugin>
4139 Use I<Plugin> as the plugin name when submitting values.
4140 Defaults to C<memcachec>.
4142 =item E<lt>B<Match>E<gt>
4144 Match blocks define which strings to look for and how matches substrings are
4145 interpreted. For a description of match blocks, please see L<"Plugin tail">.
4149 =head2 Plugin C<memcached>
4151 The B<memcached plugin> connects to a memcached server and queries statistics
4152 about cache utilization, memory and bandwidth used.
4153 L<http://memcached.org/>
4155 <Plugin "memcached">
4157 #Host "memcache.example.com"
4163 The plugin configuration consists of one or more B<Instance> blocks which
4164 specify one I<memcached> connection each. Within the B<Instance> blocks, the
4165 following options are allowed:
4169 =item B<Host> I<Hostname>
4171 Sets the B<host> field of dispatched values. Defaults to the global hostname
4173 For backwards compatibility, values are also dispatched with the global
4174 hostname when B<Host> is set to B<127.0.0.1> or B<localhost> and B<Address> is
4177 =item B<Address> I<Address>
4179 Hostname or IP to connect to. For backwards compatibility, defaults to the
4180 value of B<Host> or B<127.0.0.1> if B<Host> is unset.
4182 =item B<Port> I<Port>
4184 TCP port to connect to. Defaults to B<11211>.
4186 =item B<Socket> I<Path>
4188 Connect to I<memcached> using the UNIX domain socket at I<Path>. If this
4189 setting is given, the B<Address> and B<Port> settings are ignored.
4193 =head2 Plugin C<mic>
4195 The B<mic plugin> gathers CPU statistics, memory usage and temperatures from
4196 Intel's Many Integrated Core (MIC) systems.
4205 ShowTemperatures true
4208 IgnoreSelectedTemperature true
4213 IgnoreSelectedPower true
4216 The following options are valid inside the B<PluginE<nbsp>mic> block:
4220 =item B<ShowCPU> B<true>|B<false>
4222 If enabled (the default) a sum of the CPU usage across all cores is reported.
4224 =item B<ShowCPUCores> B<true>|B<false>
4226 If enabled (the default) per-core CPU usage is reported.
4228 =item B<ShowMemory> B<true>|B<false>
4230 If enabled (the default) the physical memory usage of the MIC system is
4233 =item B<ShowTemperatures> B<true>|B<false>
4235 If enabled (the default) various temperatures of the MIC system are reported.
4237 =item B<Temperature> I<Name>
4239 This option controls which temperatures are being reported. Whether matching
4240 temperatures are being ignored or I<only> matching temperatures are reported
4241 depends on the B<IgnoreSelectedTemperature> setting below. By default I<all>
4242 temperatures are reported.
4244 =item B<IgnoreSelectedTemperature> B<false>|B<true>
4246 Controls the behavior of the B<Temperature> setting above. If set to B<false>
4247 (the default) only temperatures matching a B<Temperature> option are reported
4248 or, if no B<Temperature> option is specified, all temperatures are reported. If
4249 set to B<true>, matching temperatures are I<ignored> and all other temperatures
4252 Known temperature names are:
4286 =item B<ShowPower> B<true>|B<false>
4288 If enabled (the default) various temperatures of the MIC system are reported.
4290 =item B<Power> I<Name>
4292 This option controls which power readings are being reported. Whether matching
4293 power readings are being ignored or I<only> matching power readings are reported
4294 depends on the B<IgnoreSelectedPower> setting below. By default I<all>
4295 power readings are reported.
4297 =item B<IgnoreSelectedPower> B<false>|B<true>
4299 Controls the behavior of the B<Power> setting above. If set to B<false>
4300 (the default) only power readings matching a B<Power> option are reported
4301 or, if no B<Power> option is specified, all power readings are reported. If
4302 set to B<true>, matching power readings are I<ignored> and all other power readings
4305 Known power names are:
4311 Total power utilization averaged over Time Window 0 (uWatts).
4315 Total power utilization averaged over Time Window 0 (uWatts).
4319 Instantaneous power (uWatts).
4323 Max instantaneous power (uWatts).
4327 PCI-E connector power (uWatts).
4331 2x3 connector power (uWatts).
4335 2x4 connector power (uWatts).
4343 Uncore rail (uVolts).
4347 Memory subsystem rail (uVolts).
4353 =head2 Plugin C<memory>
4355 The I<memory plugin> provides the following configuration options:
4359 =item B<ValuesAbsolute> B<true>|B<false>
4361 Enables or disables reporting of physical memory usage in absolute numbers,
4362 i.e. bytes. Defaults to B<true>.
4364 =item B<ValuesPercentage> B<false>|B<true>
4366 Enables or disables reporting of physical memory usage in percentages, e.g.
4367 percent of physical memory used. Defaults to B<false>.
4369 This is useful for deploying I<collectd> in a heterogeneous environment in
4370 which the sizes of physical memory vary.
4374 =head2 Plugin C<modbus>
4376 The B<modbus plugin> connects to a Modbus "slave" via Modbus/TCP or Modbus/RTU and
4377 reads register values. It supports reading single registers (unsigned 16E<nbsp>bit
4378 values), large integer values (unsigned 32E<nbsp>bit and 64E<nbsp>bit values) and
4379 floating point values (two registers interpreted as IEEE floats in big endian
4384 <Data "voltage-input-1">
4387 RegisterCmd ReadHolding
4394 <Data "voltage-input-2">
4397 RegisterCmd ReadHolding
4402 <Data "supply-temperature-1">
4405 RegisterCmd ReadHolding
4410 <Host "modbus.example.com">
4411 Address "192.168.0.42"
4416 Instance "power-supply"
4417 Collect "voltage-input-1"
4418 Collect "voltage-input-2"
4423 Device "/dev/ttyUSB0"
4428 Instance "temperature"
4429 Collect "supply-temperature-1"
4435 =item E<lt>B<Data> I<Name>E<gt> blocks
4437 Data blocks define a mapping between register numbers and the "types" used by
4440 Within E<lt>DataE<nbsp>/E<gt> blocks, the following options are allowed:
4444 =item B<RegisterBase> I<Number>
4446 Configures the base register to read from the device. If the option
4447 B<RegisterType> has been set to B<Uint32> or B<Float>, this and the next
4448 register will be read (the register number is increased by one).
4450 =item B<RegisterType> B<Int16>|B<Int32>|B<Int64>|B<Uint16>|B<Uint32>|B<UInt64>|B<Float>|B<Int32LE>|B<Uint32LE>|B<FloatLE>
4452 Specifies what kind of data is returned by the device. This defaults to
4453 B<Uint16>. If the type is B<Int32>, B<Int32LE>, B<Uint32>, B<Uint32LE>,
4454 B<Float> or B<FloatLE>, two 16E<nbsp>bit registers at B<RegisterBase>
4455 and B<RegisterBase+1> will be read and the data is combined into one
4456 32E<nbsp>value. For B<Int32>, B<Uint32> and B<Float> the most significant
4457 16E<nbsp>bits are in the register at B<RegisterBase> and the least
4458 significant 16E<nbsp>bits are in the register at B<RegisterBase+1>.
4459 For B<Int32LE>, B<Uint32LE>, or B<Float32LE>, the high and low order
4460 registers are swapped with the most significant 16E<nbsp>bits in
4461 the B<RegisterBase+1> and the least significant 16E<nbsp>bits in
4462 B<RegisterBase>. If the type is B<Int64> or B<UInt64>, four 16E<nbsp>bit
4463 registers at B<RegisterBase>, B<RegisterBase+1>, B<RegisterBase+2> and
4464 B<RegisterBase+3> will be read and the data combined into one
4467 =item B<RegisterCmd> B<ReadHolding>|B<ReadInput>
4469 Specifies register type to be collected from device. Works only with libmodbus
4470 2.9.2 or higher. Defaults to B<ReadHolding>.
4472 =item B<Type> I<Type>
4474 Specifies the "type" (data set) to use when dispatching the value to
4475 I<collectd>. Currently, only data sets with exactly one data source are
4478 =item B<Instance> I<Instance>
4480 Sets the type instance to use when dispatching the value to I<Instance>. If
4481 unset, an empty string (no type instance) is used.
4483 =item B<Scale> I<Value>
4485 The values taken from device are multiplied by I<Value>. The field is optional
4486 and the default is B<1.0>.
4488 =item B<Shift> I<Value>
4490 I<Value> is added to values from device after they have been multiplied by
4491 B<Scale> value. The field is optional and the default value is B<0.0>.
4495 =item E<lt>B<Host> I<Name>E<gt> blocks
4497 Host blocks are used to specify to which hosts to connect and what data to read
4498 from their "slaves". The string argument I<Name> is used as hostname when
4499 dispatching the values to I<collectd>.
4501 Within E<lt>HostE<nbsp>/E<gt> blocks, the following options are allowed:
4505 =item B<Address> I<Hostname>
4507 For Modbus/TCP, specifies the node name (the actual network address) used to
4508 connect to the host. This may be an IP address or a hostname. Please note that
4509 the used I<libmodbus> library only supports IPv4 at the moment.
4511 =item B<Port> I<Service>
4513 for Modbus/TCP, specifies the port used to connect to the host. The port can
4514 either be given as a number or as a service name. Please note that the
4515 I<Service> argument must be a string, even if ports are given in their numerical
4516 form. Defaults to "502".
4518 =item B<Device> I<Devicenode>
4520 For Modbus/RTU, specifies the path to the serial device being used.
4522 =item B<Baudrate> I<Baudrate>
4524 For Modbus/RTU, specifies the baud rate of the serial device.
4525 Note, connections currently support only 8/N/1.
4527 =item B<Interval> I<Interval>
4529 Sets the interval (in seconds) in which the values will be collected from this
4530 host. By default the global B<Interval> setting will be used.
4532 =item E<lt>B<Slave> I<ID>E<gt>
4534 Over each connection, multiple Modbus devices may be reached. The slave ID
4535 is used to specify which device should be addressed. For each device you want
4536 to query, one B<Slave> block must be given.
4538 Within E<lt>SlaveE<nbsp>/E<gt> blocks, the following options are allowed:
4542 =item B<Instance> I<Instance>
4544 Specify the plugin instance to use when dispatching the values to I<collectd>.
4545 By default "slave_I<ID>" is used.
4547 =item B<Collect> I<DataName>
4549 Specifies which data to retrieve from the device. I<DataName> must be the same
4550 string as the I<Name> argument passed to a B<Data> block. You can specify this
4551 option multiple times to collect more than one value from a slave. At least one
4552 B<Collect> option is mandatory.
4560 =head2 Plugin C<mqtt>
4562 The I<MQTT plugin> can send metrics to MQTT (B<Publish> blocks) and receive
4563 values from MQTT (B<Subscribe> blocks).
4569 Host "mqtt.example.com"
4573 Host "mqtt.example.com"
4578 The plugin's configuration is in B<Publish> and/or B<Subscribe> blocks,
4579 configuring the sending and receiving direction respectively. The plugin will
4580 register a write callback named C<mqtt/I<name>> where I<name> is the string
4581 argument given to the B<Publish> block. Both types of blocks share many but not
4582 all of the following options. If an option is valid in only one of the blocks,
4583 it will be mentioned explicitly.
4589 =item B<Host> I<Hostname>
4591 Hostname of the MQTT broker to connect to.
4593 =item B<Port> I<Service>
4595 Port number or service name of the MQTT broker to connect to.
4597 =item B<User> I<UserName>
4599 Username used when authenticating to the MQTT broker.
4601 =item B<Password> I<Password>
4603 Password used when authenticating to the MQTT broker.
4605 =item B<ClientId> I<ClientId>
4607 MQTT client ID to use. Defaults to the hostname used by I<collectd>.
4609 =item B<QoS> [B<0>-B<2>]
4611 Sets the I<Quality of Service>, with the values C<0>, C<1> and C<2> meaning:
4629 In B<Publish> blocks, this option determines the QoS flag set on outgoing
4630 messages and defaults to B<0>. In B<Subscribe> blocks, determines the maximum
4631 QoS setting the client is going to accept and defaults to B<2>. If the QoS flag
4632 on a message is larger than the maximum accepted QoS of a subscriber, the
4633 message's QoS will be downgraded.
4635 =item B<Prefix> I<Prefix> (Publish only)
4637 This plugin will use one topic per I<value list> which will looks like a path.
4638 I<Prefix> is used as the first path element and defaults to B<collectd>.
4640 An example topic name would be:
4642 collectd/cpu-0/cpu-user
4644 =item B<Retain> B<false>|B<true> (Publish only)
4646 Controls whether the MQTT broker will retain (keep a copy of) the last message
4647 sent to each topic and deliver it to new subscribers. Defaults to B<false>.
4649 =item B<StoreRates> B<true>|B<false> (Publish only)
4651 Controls whether C<DERIVE> and C<COUNTER> metrics are converted to a I<rate>
4652 before sending. Defaults to B<true>.
4654 =item B<CleanSession> B<true>|B<false> (Subscribe only)
4656 Controls whether the MQTT "cleans" the session up after the subscriber
4657 disconnects or if it maintains the subscriber's subscriptions and all messages
4658 that arrive while the subscriber is disconnected. Defaults to B<true>.
4660 =item B<Topic> I<TopicName> (Subscribe only)
4662 Configures the topic(s) to subscribe to. You can use the single level C<+> and
4663 multi level C<#> wildcards. Defaults to B<collectd/#>, i.e. all topics beneath
4664 the B<collectd> branch.
4666 =item B<CACert> I<file>
4668 Path to the PEM-encoded CA certificate file. Setting this option enables TLS
4669 communication with the MQTT broker, and as such, B<Port> should be the TLS-enabled
4670 port of the MQTT broker.
4671 This option enables the use of TLS.
4673 =item B<CertificateFile> I<file>
4675 Path to the PEM-encoded certificate file to use as client certificate when
4676 connecting to the MQTT broker.
4677 Only valid if B<CACert> and B<CertificateKeyFile> are also set.
4679 =item B<CertificateKeyFile> I<file>
4681 Path to the unencrypted PEM-encoded key file corresponding to B<CertificateFile>.
4682 Only valid if B<CACert> and B<CertificateFile> are also set.
4684 =item B<TLSProtocol> I<protocol>
4686 If configured, this specifies the string protocol version (e.g. C<tlsv1>,
4687 C<tlsv1.2>) to use for the TLS connection to the broker. If not set a default
4688 version is used which depends on the version of OpenSSL the Mosquitto library
4690 Only valid if B<CACert> is set.
4692 =item B<CipherSuite> I<ciphersuite>
4694 A string describing the ciphers available for use. See L<ciphers(1)> and the
4695 C<openssl ciphers> utility for more information. If unset, the default ciphers
4697 Only valid if B<CACert> is set.
4701 =head2 Plugin C<mysql>
4703 The C<mysql plugin> requires B<mysqlclient> to be installed. It connects to
4704 one or more databases when started and keeps the connection up as long as
4705 possible. When the connection is interrupted for whatever reason it will try
4706 to re-connect. The plugin will complain loudly in case anything goes wrong.
4708 This plugin issues the MySQL C<SHOW STATUS> / C<SHOW GLOBAL STATUS> command
4709 and collects information about MySQL network traffic, executed statements,
4710 requests, the query cache and threads by evaluating the
4711 C<Bytes_{received,sent}>, C<Com_*>, C<Handler_*>, C<Qcache_*> and C<Threads_*>
4712 return values. Please refer to the B<MySQL reference manual>, I<5.1.6. Server
4713 Status Variables> for an explanation of these values.
4715 Optionally, master and slave statistics may be collected in a MySQL
4716 replication setup. In that case, information about the synchronization state
4717 of the nodes are collected by evaluating the C<Position> return value of the
4718 C<SHOW MASTER STATUS> command and the C<Seconds_Behind_Master>,
4719 C<Read_Master_Log_Pos> and C<Exec_Master_Log_Pos> return values of the
4720 C<SHOW SLAVE STATUS> command. See the B<MySQL reference manual>,
4721 I<12.5.5.21 SHOW MASTER STATUS Syntax> and
4722 I<12.5.5.31 SHOW SLAVE STATUS Syntax> for details.
4734 SSLKey "/path/to/key.pem"
4735 SSLCert "/path/to/cert.pem"
4736 SSLCA "/path/to/ca.pem"
4737 SSLCAPath "/path/to/cas/"
4738 SSLCipher "DHE-RSA-AES256-SHA"
4744 Socket "/var/run/mysql/mysqld.sock"
4746 SlaveNotifications true
4752 Socket "/var/run/mysql/mysqld.sock"
4757 A B<Database> block defines one connection to a MySQL database. It accepts a
4758 single argument which specifies the name of the database. None of the other
4759 options are required. MySQL will use default values as documented in the
4760 "mysql_real_connect()" and "mysql_ssl_set()" sections in the
4761 B<MySQL reference manual>.
4765 =item B<Alias> I<Alias>
4767 Alias to use as sender instead of hostname when reporting. This may be useful
4768 when having cryptic hostnames.
4770 =item B<Host> I<Hostname>
4772 Hostname of the database server. Defaults to B<localhost>.
4774 =item B<User> I<Username>
4776 Username to use when connecting to the database. The user does not have to be
4777 granted any privileges (which is synonym to granting the C<USAGE> privilege),
4778 unless you want to collectd replication statistics (see B<MasterStats> and
4779 B<SlaveStats> below). In this case, the user needs the C<REPLICATION CLIENT>
4780 (or C<SUPER>) privileges. Else, any existing MySQL user will do.
4782 =item B<Password> I<Password>
4784 Password needed to log into the database.
4786 =item B<Database> I<Database>
4788 Select this database. Defaults to I<no database> which is a perfectly reasonable
4789 option for what this plugin does.
4791 =item B<Port> I<Port>
4793 TCP-port to connect to. The port must be specified in its numeric form, but it
4794 must be passed as a string nonetheless. For example:
4798 If B<Host> is set to B<localhost> (the default), this setting has no effect.
4799 See the documentation for the C<mysql_real_connect> function for details.
4801 =item B<Socket> I<Socket>
4803 Specifies the path to the UNIX domain socket of the MySQL server. This option
4804 only has any effect, if B<Host> is set to B<localhost> (the default).
4805 Otherwise, use the B<Port> option above. See the documentation for the
4806 C<mysql_real_connect> function for details.
4808 =item B<InnodbStats> I<true|false>
4810 If enabled, metrics about the InnoDB storage engine are collected.
4811 Disabled by default.
4813 =item B<MasterStats> I<true|false>
4815 =item B<SlaveStats> I<true|false>
4817 Enable the collection of master / slave statistics in a replication setup. In
4818 order to be able to get access to these statistics, the user needs special
4819 privileges. See the B<User> documentation above. Defaults to B<false>.
4821 =item B<SlaveNotifications> I<true|false>
4823 If enabled, the plugin sends a notification if the replication slave I/O and /
4824 or SQL threads are not running. Defaults to B<false>.
4826 =item B<WsrepStats> I<true|false>
4828 Enable the collection of wsrep plugin statistics, used in Master-Master
4829 replication setups like in MySQL Galera/Percona XtraDB Cluster.
4830 User needs only privileges to execute 'SHOW GLOBAL STATUS'
4832 =item B<ConnectTimeout> I<Seconds>
4834 Sets the connect timeout for the MySQL client.
4836 =item B<SSLKey> I<Path>
4838 If provided, the X509 key in PEM format.
4840 =item B<SSLCert> I<Path>
4842 If provided, the X509 cert in PEM format.
4844 =item B<SSLCA> I<Path>
4846 If provided, the CA file in PEM format (check OpenSSL docs).
4848 =item B<SSLCAPath> I<Path>
4850 If provided, the CA directory (check OpenSSL docs).
4852 =item B<SSLCipher> I<String>
4854 If provided, the SSL cipher to use.
4858 =head2 Plugin C<netapp>
4860 The netapp plugin can collect various performance and capacity information
4861 from a NetApp filer using the NetApp API.
4863 Please note that NetApp has a wide line of products and a lot of different
4864 software versions for each of these products. This plugin was developed for a
4865 NetApp FAS3040 running OnTap 7.2.3P8 and tested on FAS2050 7.3.1.1L1,
4866 FAS3140 7.2.5.1 and FAS3020 7.2.4P9. It I<should> work for most combinations of
4867 model and software version but it is very hard to test this.
4868 If you have used this plugin with other models and/or software version, feel
4869 free to send us a mail to tell us about the results, even if it's just a short
4872 To collect these data collectd will log in to the NetApp via HTTP(S) and HTTP
4873 basic authentication.
4875 B<Do not use a regular user for this!> Create a special collectd user with just
4876 the minimum of capabilities needed. The user only needs the "login-http-admin"
4877 capability as well as a few more depending on which data will be collected.
4878 Required capabilities are documented below.
4883 <Host "netapp1.example.com">
4907 IgnoreSelectedIO false
4909 IgnoreSelectedOps false
4910 GetLatency "volume0"
4911 IgnoreSelectedLatency false
4918 IgnoreSelectedCapacity false
4921 IgnoreSelectedSnapshot false
4949 The netapp plugin accepts the following configuration options:
4953 =item B<Host> I<Name>
4955 A host block defines one NetApp filer. It will appear in collectd with the name
4956 you specify here which does not have to be its real name nor its hostname (see
4957 the B<Address> option below).
4959 =item B<VFiler> I<Name>
4961 A B<VFiler> block may only be used inside a host block. It accepts all the
4962 same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
4963 will execute all NetApp API commands in the context of the specified
4964 VFiler(R). It will appear in collectd with the name you specify here which
4965 does not have to be its real name. The VFiler name may be specified using the
4966 B<VFilerName> option. If this is not specified, it will default to the name
4969 The VFiler block inherits all connection related settings from the surrounding
4970 B<Host> block (which appear before the B<VFiler> block) but they may be
4971 overwritten inside the B<VFiler> block.
4973 This feature is useful, for example, when using a VFiler as SnapVault target
4974 (supported since OnTap 8.1). In that case, the SnapVault statistics are not
4975 available in the host filer (vfiler0) but only in the respective VFiler
4978 =item B<Protocol> B<httpd>|B<http>
4980 The protocol collectd will use to query this host.
4988 Valid options: http, https
4990 =item B<Address> I<Address>
4992 The hostname or IP address of the host.
4998 Default: The "host" block's name.
5000 =item B<Port> I<Port>
5002 The TCP port to connect to on the host.
5008 Default: 80 for protocol "http", 443 for protocol "https"
5010 =item B<User> I<User>
5012 =item B<Password> I<Password>
5014 The username and password to use to login to the NetApp.
5020 =item B<VFilerName> I<Name>
5022 The name of the VFiler in which context to execute API commands. If not
5023 specified, the name provided to the B<VFiler> block will be used instead.
5029 Default: name of the B<VFiler> block
5031 B<Note:> This option may only be used inside B<VFiler> blocks.
5033 =item B<Interval> I<Interval>
5039 The following options decide what kind of data will be collected. You can
5040 either use them as a block and fine tune various parameters inside this block,
5041 use them as a single statement to just accept all default values, or omit it to
5042 not collect any data.
5044 The following options are valid inside all blocks:
5048 =item B<Interval> I<Seconds>
5050 Collect the respective statistics every I<Seconds> seconds. Defaults to the
5051 host specific setting.
5055 =head3 The System block
5057 This will collect various performance data about the whole system.
5059 B<Note:> To get this data the collectd user needs the
5060 "api-perf-object-get-instances" capability.
5064 =item B<Interval> I<Seconds>
5066 Collect disk statistics every I<Seconds> seconds.
5068 =item B<GetCPULoad> B<true>|B<false>
5070 If you set this option to true the current CPU usage will be read. This will be
5071 the average usage between all CPUs in your NetApp without any information about
5074 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5075 returns in the "CPU" field.
5083 Result: Two value lists of type "cpu", and type instances "idle" and "system".
5085 =item B<GetInterfaces> B<true>|B<false>
5087 If you set this option to true the current traffic of the network interfaces
5088 will be read. This will be the total traffic over all interfaces of your NetApp
5089 without any information about individual interfaces.
5091 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5092 in the "Net kB/s" field.
5102 Result: One value list of type "if_octects".
5104 =item B<GetDiskIO> B<true>|B<false>
5106 If you set this option to true the current IO throughput will be read. This
5107 will be the total IO of your NetApp without any information about individual
5108 disks, volumes or aggregates.
5110 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5111 in the "DiskE<nbsp>kB/s" field.
5119 Result: One value list of type "disk_octets".
5121 =item B<GetDiskOps> B<true>|B<false>
5123 If you set this option to true the current number of HTTP, NFS, CIFS, FCP,
5124 iSCSI, etc. operations will be read. This will be the total number of
5125 operations on your NetApp without any information about individual volumes or
5128 B<Note:> These are the same values that the NetApp CLI command "sysstat"
5129 returns in the "NFS", "CIFS", "HTTP", "FCP" and "iSCSI" fields.
5137 Result: A variable number of value lists of type "disk_ops_complex". Each type
5138 of operation will result in one value list with the name of the operation as
5143 =head3 The WAFL block
5145 This will collect various performance data about the WAFL file system. At the
5146 moment this just means cache performance.
5148 B<Note:> To get this data the collectd user needs the
5149 "api-perf-object-get-instances" capability.
5151 B<Note:> The interface to get these values is classified as "Diagnostics" by
5152 NetApp. This means that it is not guaranteed to be stable even between minor
5157 =item B<Interval> I<Seconds>
5159 Collect disk statistics every I<Seconds> seconds.
5161 =item B<GetNameCache> B<true>|B<false>
5169 Result: One value list of type "cache_ratio" and type instance
5172 =item B<GetDirCache> B<true>|B<false>
5180 Result: One value list of type "cache_ratio" and type instance "find_dir_hit".
5182 =item B<GetInodeCache> B<true>|B<false>
5190 Result: One value list of type "cache_ratio" and type instance
5193 =item B<GetBufferCache> B<true>|B<false>
5195 B<Note:> This is the same value that the NetApp CLI command "sysstat" returns
5196 in the "Cache hit" field.
5204 Result: One value list of type "cache_ratio" and type instance "buf_hash_hit".
5208 =head3 The Disks block
5210 This will collect performance data about the individual disks in the NetApp.
5212 B<Note:> To get this data the collectd user needs the
5213 "api-perf-object-get-instances" capability.
5217 =item B<Interval> I<Seconds>
5219 Collect disk statistics every I<Seconds> seconds.
5221 =item B<GetBusy> B<true>|B<false>
5223 If you set this option to true the busy time of all disks will be calculated
5224 and the value of the busiest disk in the system will be written.
5226 B<Note:> This is the same values that the NetApp CLI command "sysstat" returns
5227 in the "Disk util" field. Probably.
5235 Result: One value list of type "percent" and type instance "disk_busy".
5239 =head3 The VolumePerf block
5241 This will collect various performance data about the individual volumes.
5243 You can select which data to collect about which volume using the following
5244 options. They follow the standard ignorelist semantic.
5246 B<Note:> To get this data the collectd user needs the
5247 I<api-perf-object-get-instances> capability.
5251 =item B<Interval> I<Seconds>
5253 Collect volume performance data every I<Seconds> seconds.
5255 =item B<GetIO> I<Volume>
5257 =item B<GetOps> I<Volume>
5259 =item B<GetLatency> I<Volume>
5261 Select the given volume for IO, operations or latency statistics collection.
5262 The argument is the name of the volume without the C</vol/> prefix.
5264 Since the standard ignorelist functionality is used here, you can use a string
5265 starting and ending with a slash to specify regular expression matching: To
5266 match the volumes "vol0", "vol2" and "vol7", you can use this regular
5269 GetIO "/^vol[027]$/"
5271 If no regular expression is specified, an exact match is required. Both,
5272 regular and exact matching are case sensitive.
5274 If no volume was specified at all for either of the three options, that data
5275 will be collected for all available volumes.
5277 See F</"IGNORELISTS"> for details.
5279 =item B<IgnoreSelectedIO> B<true>|B<false>
5281 =item B<IgnoreSelectedOps> B<true>|B<false>
5283 =item B<IgnoreSelectedLatency> B<true>|B<false>
5285 When set to B<true>, the volumes selected for IO, operations or latency
5286 statistics collection will be ignored and the data will be collected for all
5289 When set to B<false>, data will only be collected for the specified volumes and
5290 all other volumes will be ignored.
5292 If no volumes have been specified with the above B<Get*> options, all volumes
5293 will be collected regardless of the B<IgnoreSelected*> option.
5295 Defaults to B<false>
5299 =head3 The VolumeUsage block
5301 This will collect capacity data about the individual volumes.
5303 B<Note:> To get this data the collectd user needs the I<api-volume-list-info>
5308 =item B<Interval> I<Seconds>
5310 Collect volume usage statistics every I<Seconds> seconds.
5312 =item B<GetCapacity> I<VolumeName>
5314 The current capacity of the volume will be collected. This will result in two
5315 to four value lists, depending on the configuration of the volume. All data
5316 sources are of type "df_complex" with the name of the volume as
5319 There will be type_instances "used" and "free" for the number of used and
5320 available bytes on the volume. If the volume has some space reserved for
5321 snapshots, a type_instance "snap_reserved" will be available. If the volume
5322 has SIS enabled, a type_instance "sis_saved" will be available. This is the
5323 number of bytes saved by the SIS feature.
5325 B<Note:> The current NetApp API has a bug that results in this value being
5326 reported as a 32E<nbsp>bit number. This plugin tries to guess the correct
5327 number which works most of the time. If you see strange values here, bug
5328 NetApp support to fix this.
5330 Repeat this option to specify multiple volumes.
5332 =item B<IgnoreSelectedCapacity> B<true>|B<false>
5334 Specify whether to collect only the volumes selected by the B<GetCapacity>
5335 option or to ignore those volumes. B<IgnoreSelectedCapacity> defaults to
5336 B<false>. However, if no B<GetCapacity> option is specified at all, all
5337 capacities will be selected anyway.
5339 =item B<GetSnapshot> I<VolumeName>
5341 Select volumes from which to collect snapshot information.
5343 Usually, the space used for snapshots is included in the space reported as
5344 "used". If snapshot information is collected as well, the space used for
5345 snapshots is subtracted from the used space.
5347 To make things even more interesting, it is possible to reserve space to be
5348 used for snapshots. If the space required for snapshots is less than that
5349 reserved space, there is "reserved free" and "reserved used" space in addition
5350 to "free" and "used". If the space required for snapshots exceeds the reserved
5351 space, that part allocated in the normal space is subtracted from the "used"
5354 Repeat this option to specify multiple volumes.
5356 =item B<IgnoreSelectedSnapshot>
5358 Specify whether to collect only the volumes selected by the B<GetSnapshot>
5359 option or to ignore those volumes. B<IgnoreSelectedSnapshot> defaults to
5360 B<false>. However, if no B<GetSnapshot> option is specified at all, all
5361 capacities will be selected anyway.
5365 =head3 The Quota block
5367 This will collect (tree) quota statistics (used disk space and number of used
5368 files). This mechanism is useful to get usage information for single qtrees.
5369 In case the quotas are not used for any other purpose, an entry similar to the
5370 following in C</etc/quotas> would be sufficient:
5372 /vol/volA/some_qtree tree - - - - -
5374 After adding the entry, issue C<quota on -w volA> on the NetApp filer.
5378 =item B<Interval> I<Seconds>
5380 Collect SnapVault(R) statistics every I<Seconds> seconds.
5384 =head3 The SnapVault block
5386 This will collect statistics about the time and traffic of SnapVault(R)
5391 =item B<Interval> I<Seconds>
5393 Collect SnapVault(R) statistics every I<Seconds> seconds.
5397 =head2 Plugin C<netlink>
5399 The C<netlink> plugin uses a netlink socket to query the Linux kernel about
5400 statistics of various interface and routing aspects.
5404 =item B<Interface> I<Interface>
5406 =item B<VerboseInterface> I<Interface>
5408 Instruct the plugin to collect interface statistics. This is basically the same
5409 as the statistics provided by the C<interface> plugin (see above) but
5410 potentially much more detailed.
5412 When configuring with B<Interface> only the basic statistics will be collected,
5413 namely octets, packets, and errors. These statistics are collected by
5414 the C<interface> plugin, too, so using both at the same time is no benefit.
5416 When configured with B<VerboseInterface> all counters B<except> the basic ones,
5417 so that no data needs to be collected twice if you use the C<interface> plugin.
5418 This includes dropped packets, received multicast packets, collisions and a
5419 whole zoo of differentiated RX and TX errors. You can try the following command
5420 to get an idea of what awaits you:
5424 If I<Interface> is B<All>, all interfaces will be selected.
5426 =item B<QDisc> I<Interface> [I<QDisc>]
5428 =item B<Class> I<Interface> [I<Class>]
5430 =item B<Filter> I<Interface> [I<Filter>]
5432 Collect the octets and packets that pass a certain qdisc, class or filter.
5434 QDiscs and classes are identified by their type and handle (or classid).
5435 Filters don't necessarily have a handle, therefore the parent's handle is used.
5436 The notation used in collectd differs from that used in tc(1) in that it
5437 doesn't skip the major or minor number if it's zero and doesn't print special
5438 ids by their name. So, for example, a qdisc may be identified by
5439 C<pfifo_fast-1:0> even though the minor number of B<all> qdiscs is zero and
5440 thus not displayed by tc(1).
5442 If B<QDisc>, B<Class>, or B<Filter> is given without the second argument,
5443 i.E<nbsp>.e. without an identifier, all qdiscs, classes, or filters that are
5444 associated with that interface will be collected.
5446 Since a filter itself doesn't necessarily have a handle, the parent's handle is
5447 used. This may lead to problems when more than one filter is attached to a
5448 qdisc or class. This isn't nice, but we don't know how this could be done any
5449 better. If you have a idea, please don't hesitate to tell us.
5451 As with the B<Interface> option you can specify B<All> as the interface,
5452 meaning all interfaces.
5454 Here are some examples to help you understand the above text more easily:
5457 VerboseInterface "All"
5458 QDisc "eth0" "pfifo_fast-1:0"
5460 Class "ppp0" "htb-1:10"
5461 Filter "ppp0" "u32-1:0"
5464 See F</"IGNORELISTS"> for details.
5466 =item B<IgnoreSelected>
5468 The behavior is the same as with all other similar plugins: If nothing is
5469 selected at all, everything is collected. If some things are selected using the
5470 options described above, only these statistics are collected. If you set
5471 B<IgnoreSelected> to B<true>, this behavior is inverted, i.E<nbsp>e. the
5472 specified statistics will not be collected.
5476 =head2 Plugin C<network>
5478 The Network plugin sends data to a remote instance of collectd, receives data
5479 from a remote instance, or both at the same time. Data which has been received
5480 from the network is usually not transmitted again, but this can be activated, see
5481 the B<Forward> option below.
5483 The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
5484 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
5486 Both, B<Server> and B<Listen> can be used as single option or as block. When
5487 used as block, given options are valid for this socket only. The following
5488 example will export the metrics twice: Once to an "internal" server (without
5489 encryption and signing) and one to an external server (with cryptographic
5493 # Export to an internal server
5494 # (demonstrates usage without additional options)
5495 Server "collectd.internal.tld"
5497 # Export to an external server
5498 # (demonstrates usage with signature options)
5499 <Server "collectd.external.tld">
5500 SecurityLevel "sign"
5501 Username "myhostname"
5508 =item B<E<lt>Server> I<Host> [I<Port>]B<E<gt>>
5510 The B<Server> statement/block sets the server to send datagrams to. The
5511 statement may occur multiple times to send each datagram to multiple
5514 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. The
5515 optional second argument specifies a port number or a service name. If not
5516 given, the default, B<25826>, is used.
5518 The following options are recognized within B<Server> blocks:
5522 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5524 Set the security you require for network communication. When the security level
5525 has been set to B<Encrypt>, data sent over the network will be encrypted using
5526 I<AES-256>. The integrity of encrypted packets is ensured using I<SHA-1>. When
5527 set to B<Sign>, transmitted data is signed using the I<HMAC-SHA-256> message
5528 authentication code. When set to B<None>, data is sent without any security.
5530 This feature is only available if the I<network> plugin was linked with
5533 =item B<Username> I<Username>
5535 Sets the username to transmit. This is used by the server to lookup the
5536 password. See B<AuthFile> below. All security levels except B<None> require
5539 This feature is only available if the I<network> plugin was linked with
5542 =item B<Password> I<Password>
5544 Sets a password (shared secret) for this socket. All security levels except
5545 B<None> require this setting.
5547 This feature is only available if the I<network> plugin was linked with
5550 =item B<Interface> I<Interface name>
5552 Set the outgoing interface for IP packets. This applies at least
5553 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5554 undefined or a non-existent interface name is specified, the default
5555 behavior is to let the kernel choose the appropriate interface. Be warned
5556 that the manual selection of an interface for unicast traffic is only
5557 necessary in rare cases.
5559 =item B<BindAddress> I<IP Address>
5561 Set the outgoing IP address for IP packets. This option can be used instead of
5562 the I<Interface> option to explicitly define the IP address which will be used
5563 to send Packets to the remote server.
5565 =item B<ResolveInterval> I<Seconds>
5567 Sets the interval at which to re-resolve the DNS for the I<Host>. This is
5568 useful to force a regular DNS lookup to support a high availability setup. If
5569 not specified, re-resolves are never attempted.
5573 =item B<E<lt>Listen> I<Host> [I<Port>]B<E<gt>>
5575 The B<Listen> statement sets the interfaces to bind to. When multiple
5576 statements are found the daemon will bind to multiple interfaces.
5578 The argument I<Host> may be a hostname, an IPv4 address or an IPv6 address. If
5579 the argument is a multicast address the daemon will join that multicast group.
5580 The optional second argument specifies a port number or a service name. If not
5581 given, the default, B<25826>, is used.
5583 The following options are recognized within C<E<lt>ListenE<gt>> blocks:
5587 =item B<SecurityLevel> B<Encrypt>|B<Sign>|B<None>
5589 Set the security you require for network communication. When the security level
5590 has been set to B<Encrypt>, only encrypted data will be accepted. The integrity
5591 of encrypted packets is ensured using I<SHA-1>. When set to B<Sign>, only
5592 signed and encrypted data is accepted. When set to B<None>, all data will be
5593 accepted. If an B<AuthFile> option was given (see below), encrypted data is
5594 decrypted if possible.
5596 This feature is only available if the I<network> plugin was linked with
5599 =item B<AuthFile> I<Filename>
5601 Sets a file in which usernames are mapped to passwords. These passwords are
5602 used to verify signatures and to decrypt encrypted network packets. If
5603 B<SecurityLevel> is set to B<None>, this is optional. If given, signed data is
5604 verified and encrypted packets are decrypted. Otherwise, signed data is
5605 accepted without checking the signature and encrypted data cannot be decrypted.
5606 For the other security levels this option is mandatory.
5608 The file format is very simple: Each line consists of a username followed by a
5609 colon and any number of spaces followed by the password. To demonstrate, an
5610 example file could look like this:
5615 Each time a packet is received, the modification time of the file is checked
5616 using L<stat(2)>. If the file has been changed, the contents is re-read. While
5617 the file is being read, it is locked using L<fcntl(2)>.
5619 =item B<Interface> I<Interface name>
5621 Set the incoming interface for IP packets explicitly. This applies at least
5622 to IPv6 packets and if possible to IPv4. If this option is not applicable,
5623 undefined or a non-existent interface name is specified, the default
5624 behavior is, to let the kernel choose the appropriate interface. Thus incoming
5625 traffic gets only accepted, if it arrives on the given interface.
5629 =item B<TimeToLive> I<1-255>
5631 Set the time-to-live of sent packets. This applies to all, unicast and
5632 multicast, and IPv4 and IPv6 packets. The default is to not change this value.
5633 That means that multicast packets will be sent with a TTL of C<1> (one) on most
5636 =item B<MaxPacketSize> I<1024-65535>
5638 Set the maximum size for datagrams received over the network. Packets larger
5639 than this will be truncated. Defaults to 1452E<nbsp>bytes, which is the maximum
5640 payload size that can be transmitted in one Ethernet frame using IPv6E<nbsp>/
5643 On the server side, this limit should be set to the largest value used on
5644 I<any> client. Likewise, the value on the client must not be larger than the
5645 value on the server, or data will be lost.
5647 B<Compatibility:> Versions prior to I<versionE<nbsp>4.8> used a fixed sized
5648 buffer of 1024E<nbsp>bytes. Versions I<4.8>, I<4.9> and I<4.10> used a default
5649 value of 1024E<nbsp>bytes to avoid problems when sending data to an older
5652 =item B<Forward> I<true|false>
5654 If set to I<true>, write packets that were received via the network plugin to
5655 the sending sockets. This should only be activated when the B<Listen>- and
5656 B<Server>-statements differ. Otherwise packets may be send multiple times to
5657 the same multicast group. While this results in more network traffic than
5658 necessary it's not a huge problem since the plugin has a duplicate detection,
5659 so the values will not loop.
5661 =item B<ReportStats> B<true>|B<false>
5663 The network plugin cannot only receive and send statistics, it can also create
5664 statistics about itself. Collectd data included the number of received and
5665 sent octets and packets, the length of the receive queue and the number of
5666 values handled. When set to B<true>, the I<Network plugin> will make these
5667 statistics available. Defaults to B<false>.
5671 =head2 Plugin C<nfs>
5673 The I<nfs plugin> collects information about the usage of the Network File
5674 System (NFS). It counts the number of procedure calls for each procedure,
5675 grouped by version and whether the system runs as server or client.
5677 It is possibly to omit metrics for a specific NFS version by setting one or
5678 more of the following options to B<false> (all of them default to B<true>).
5682 =item B<ReportV2> B<true>|B<false>
5684 =item B<ReportV3> B<true>|B<false>
5686 =item B<ReportV4> B<true>|B<false>
5690 =head2 Plugin C<nginx>
5692 This plugin collects the number of connections and requests handled by the
5693 C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
5694 queries the page provided by the C<ngx_http_stub_status_module> module, which
5695 isn't compiled by default. Please refer to
5696 L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
5697 how to compile and configure nginx and this module.
5699 The following options are accepted by the C<nginx plugin>:
5703 =item B<URL> I<http://host/nginx_status>
5705 Sets the URL of the C<ngx_http_stub_status_module> output.
5707 =item B<User> I<Username>
5709 Optional user name needed for authentication.
5711 =item B<Password> I<Password>
5713 Optional password needed for authentication.
5715 =item B<VerifyPeer> B<true|false>
5717 Enable or disable peer SSL certificate verification. See
5718 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
5720 =item B<VerifyHost> B<true|false>
5722 Enable or disable peer host name verification. If enabled, the plugin checks
5723 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
5724 certificate matches the host name provided by the B<URL> option. If this
5725 identity check fails, the connection is aborted. Obviously, only works when
5726 connecting to a SSL enabled server. Enabled by default.
5728 =item B<CACert> I<File>
5730 File that holds one or more SSL certificates. If you want to use HTTPS you will
5731 possibly need this option. What CA certificates come bundled with C<libcurl>
5732 and are checked by default depends on the distribution you use.
5734 =item B<Timeout> I<Milliseconds>
5736 The B<Timeout> option sets the overall timeout for HTTP requests to B<URL>, in
5737 milliseconds. By default, the configured B<Interval> is used to set the
5742 =head2 Plugin C<notify_desktop>
5744 This plugin sends a desktop notification to a notification daemon, as defined
5745 in the Desktop Notification Specification. To actually display the
5746 notifications, B<notification-daemon> is required and B<collectd> has to be
5747 able to access the X server (i.E<nbsp>e., the C<DISPLAY> and C<XAUTHORITY>
5748 environment variables have to be set correctly) and the D-Bus message bus.
5750 The Desktop Notification Specification can be found at
5751 L<http://www.galago-project.org/specs/notification/>.
5755 =item B<OkayTimeout> I<timeout>
5757 =item B<WarningTimeout> I<timeout>
5759 =item B<FailureTimeout> I<timeout>
5761 Set the I<timeout>, in milliseconds, after which to expire the notification
5762 for C<OKAY>, C<WARNING> and C<FAILURE> severities respectively. If zero has
5763 been specified, the displayed notification will not be closed at all - the
5764 user has to do so herself. These options default to 5000. If a negative number
5765 has been specified, the default is used as well.
5769 =head2 Plugin C<notify_email>
5771 The I<notify_email> plugin uses the I<ESMTP> library to send notifications to a
5772 configured email address.
5774 I<libESMTP> is available from L<http://www.stafford.uklinux.net/libesmtp/>.
5776 Available configuration options:
5780 =item B<From> I<Address>
5782 Email address from which the emails should appear to come from.
5784 Default: C<root@localhost>
5786 =item B<Recipient> I<Address>
5788 Configures the email address(es) to which the notifications should be mailed.
5789 May be repeated to send notifications to multiple addresses.
5791 At least one B<Recipient> must be present for the plugin to work correctly.
5793 =item B<SMTPServer> I<Hostname>
5795 Hostname of the SMTP server to connect to.
5797 Default: C<localhost>
5799 =item B<SMTPPort> I<Port>
5801 TCP port to connect to.
5805 =item B<SMTPUser> I<Username>
5807 Username for ASMTP authentication. Optional.
5809 =item B<SMTPPassword> I<Password>
5811 Password for ASMTP authentication. Optional.
5813 =item B<Subject> I<Subject>
5815 Subject-template to use when sending emails. There must be exactly two
5816 string-placeholders in the subject, given in the standard I<printf(3)> syntax,
5817 i.E<nbsp>e. C<%s>. The first will be replaced with the severity, the second
5820 Default: C<Collectd notify: %s@%s>
5824 =head2 Plugin C<notify_nagios>
5826 The I<notify_nagios> plugin writes notifications to Nagios' I<command file> as
5827 a I<passive service check result>.
5829 Available configuration options:
5833 =item B<CommandFile> I<Path>
5835 Sets the I<command file> to write to. Defaults to F</usr/local/nagios/var/rw/nagios.cmd>.
5839 =head2 Plugin C<ntpd>
5841 The C<ntpd> plugin collects per-peer ntp data such as time offset and time
5844 For talking to B<ntpd>, it mimics what the B<ntpdc> control program does on
5845 the wire - using B<mode 7> specific requests. This mode is deprecated with
5846 newer B<ntpd> releases (4.2.7p230 and later). For the C<ntpd> plugin to work
5847 correctly with them, the ntp daemon must be explicitly configured to
5848 enable B<mode 7> (which is disabled by default). Refer to the I<ntp.conf(5)>
5849 manual page for details.
5851 Available configuration options for the C<ntpd> plugin:
5855 =item B<Host> I<Hostname>
5857 Hostname of the host running B<ntpd>. Defaults to B<localhost>.
5859 =item B<Port> I<Port>
5861 UDP-Port to connect to. Defaults to B<123>.
5863 =item B<ReverseLookups> B<true>|B<false>
5865 Sets whether or not to perform reverse lookups on peers. Since the name or
5866 IP-address may be used in a filename it is recommended to disable reverse
5867 lookups. The default is to do reverse lookups to preserve backwards
5868 compatibility, though.
5870 =item B<IncludeUnitID> B<true>|B<false>
5872 When a peer is a refclock, include the unit ID in the I<type instance>.
5873 Defaults to B<false> for backward compatibility.
5875 If two refclock peers use the same driver and this is B<false>, the plugin will
5876 try to write simultaneous measurements from both to the same type instance.
5877 This will result in error messages in the log and only one set of measurements
5882 =head2 Plugin C<nut>
5886 =item B<UPS> I<upsname>B<@>I<hostname>[B<:>I<port>]
5888 Add a UPS to collect data from. The format is identical to the one accepted by
5891 =item B<ForceSSL> B<true>|B<false>
5893 Stops connections from falling back to unsecured if an SSL connection
5894 cannot be established. Defaults to false if undeclared.
5896 =item B<VerifyPeer> I<true>|I<false>
5898 If set to true, requires a CAPath be provided. Will use the CAPath to find
5899 certificates to use as Trusted Certificates to validate a upsd server certificate.
5900 If validation of the upsd server certificate fails, the connection will not be
5901 established. If ForceSSL is undeclared or set to false, setting VerifyPeer to true
5902 will override and set ForceSSL to true.
5904 =item B<CAPath> I/path/to/certs/folder
5906 If VerifyPeer is set to true, this is required. Otherwise this is ignored.
5907 The folder pointed at must contain certificate(s) named according to their hash.
5908 Ex: XXXXXXXX.Y where X is the hash value of a cert and Y is 0. If name collisions
5909 occur because two different certs have the same hash value, Y can be incremented
5910 in order to avoid conflict. To create a symbolic link to a certificate the following
5911 command can be used from within the directory where the cert resides:
5913 C<ln -s some.crt ./$(openssl x509 -hash -noout -in some.crt).0>
5915 Alternatively, the package openssl-perl provides a command C<c_rehash> that will
5916 generate links like the one described above for ALL certs in a given folder.
5918 C<c_rehash /path/to/certs/folder>
5920 =item B<ConnectTimeout> I<Milliseconds>
5922 The B<ConnectTimeout> option sets the connect timeout, in milliseconds.
5923 By default, the configured B<Interval> is used to set the timeout.
5927 =head2 Plugin C<olsrd>
5929 The I<olsrd> plugin connects to the TCP port opened by the I<txtinfo> plugin of
5930 the Optimized Link State Routing daemon and reads information about the current
5931 state of the meshed network.
5933 The following configuration options are understood:
5937 =item B<Host> I<Host>
5939 Connect to I<Host>. Defaults to B<"localhost">.
5941 =item B<Port> I<Port>
5943 Specifies the port to connect to. This must be a string, even if you give the
5944 port as a number rather than a service name. Defaults to B<"2006">.
5946 =item B<CollectLinks> B<No>|B<Summary>|B<Detail>
5948 Specifies what information to collect about links, i.E<nbsp>e. direct
5949 connections of the daemon queried. If set to B<No>, no information is
5950 collected. If set to B<Summary>, the number of links and the average of all
5951 I<link quality> (LQ) and I<neighbor link quality> (NLQ) values is calculated.
5952 If set to B<Detail> LQ and NLQ are collected per link.
5954 Defaults to B<Detail>.
5956 =item B<CollectRoutes> B<No>|B<Summary>|B<Detail>
5958 Specifies what information to collect about routes of the daemon queried. If
5959 set to B<No>, no information is collected. If set to B<Summary>, the number of
5960 routes and the average I<metric> and I<ETX> is calculated. If set to B<Detail>
5961 metric and ETX are collected per route.
5963 Defaults to B<Summary>.
5965 =item B<CollectTopology> B<No>|B<Summary>|B<Detail>
5967 Specifies what information to collect about the global topology. If set to
5968 B<No>, no information is collected. If set to B<Summary>, the number of links
5969 in the entire topology and the average I<link quality> (LQ) is calculated.
5970 If set to B<Detail> LQ and NLQ are collected for each link in the entire topology.
5972 Defaults to B<Summary>.
5976 =head2 Plugin C<onewire>
5978 B<EXPERIMENTAL!> See notes below.
5980 The C<onewire> plugin uses the B<owcapi> library from the B<owfs> project
5981 L<http://owfs.org/> to read sensors connected via the onewire bus.
5983 It can be used in two possible modes - standard or advanced.
5985 In the standard mode only temperature sensors (sensors with the family code
5986 C<10>, C<22> and C<28> - e.g. DS1820, DS18S20, DS1920) can be read. If you have
5987 other sensors you would like to have included, please send a sort request to
5988 the mailing list. You can select sensors to be read or to be ignored depending
5989 on the option B<IgnoreSelected>). When no list is provided the whole bus is
5990 walked and all sensors are read.
5992 Hubs (the DS2409 chips) are working, but read the note, why this plugin is
5993 experimental, below.
5995 In the advanced mode you can configure any sensor to be read (only numerical
5996 value) using full OWFS path (e.g. "/uncached/10.F10FCA000800/temperature").
5997 In this mode you have to list all the sensors. Neither default bus walk nor
5998 B<IgnoreSelected> are used here. Address and type (file) is extracted from
5999 the path automatically and should produce compatible structure with the "standard"
6000 mode (basically the path is expected as for example
6001 "/uncached/10.F10FCA000800/temperature" where it would extract address part
6002 "F10FCA000800" and the rest after the slash is considered the type - here
6004 There are two advantages to this mode - you can access virtually any sensor
6005 (not just temperature), select whether to use cached or directly read values
6006 and it is slighlty faster. The downside is more complex configuration.
6008 The two modes are distinguished automatically by the format of the address.
6009 It is not possible to mix the two modes. Once a full path is detected in any
6010 B<Sensor> then the whole addressing (all sensors) is considered to be this way
6011 (and as standard addresses will fail parsing they will be ignored).
6015 =item B<Device> I<Device>
6017 Sets the device to read the values from. This can either be a "real" hardware
6018 device, such as a serial port or an USB port, or the address of the
6019 L<owserver(1)> socket, usually B<localhost:4304>.
6021 Though the documentation claims to automatically recognize the given address
6022 format, with versionE<nbsp>2.7p4 we had to specify the type explicitly. So
6023 with that version, the following configuration worked for us:
6026 Device "-s localhost:4304"
6029 This directive is B<required> and does not have a default value.
6031 =item B<Sensor> I<Sensor>
6033 In the standard mode selects sensors to collect or to ignore
6034 (depending on B<IgnoreSelected>, see below). Sensors are specified without
6035 the family byte at the beginning, so you have to use for example C<F10FCA000800>,
6036 and B<not> include the leading C<10.> family byte and point.
6037 When no B<Sensor> is configured the whole Onewire bus is walked and all supported
6038 sensors (see above) are read.
6040 In the advanced mode the B<Sensor> specifies full OWFS path - e.g.
6041 C</uncached/10.F10FCA000800/temperature> (or when cached values are OK
6042 C</10.F10FCA000800/temperature>). B<IgnoreSelected> is not used.
6044 As there can be multiple devices on the bus you can list multiple sensor (use
6045 multiple B<Sensor> elements).
6047 See F</"IGNORELISTS"> for details.
6049 =item B<IgnoreSelected> I<true>|I<false>
6051 If no configuration is given, the B<onewire> plugin will collect data from all
6052 sensors found. This may not be practical, especially if sensors are added and
6053 removed regularly. Sometimes, however, it's easier/preferred to collect only
6054 specific sensors or all sensors I<except> a few specified ones. This option
6055 enables you to do that: By setting B<IgnoreSelected> to I<true> the effect of
6056 B<Sensor> is inverted: All selected interfaces are ignored and all other
6057 interfaces are collected.
6059 Used only in the standard mode - see above.
6061 =item B<Interval> I<Seconds>
6063 Sets the interval in which all sensors should be read. If not specified, the
6064 global B<Interval> setting is used.
6068 B<EXPERIMENTAL!> The C<onewire> plugin is experimental, because it doesn't yet
6069 work with big setups. It works with one sensor being attached to one
6070 controller, but as soon as you throw in a couple more senors and maybe a hub
6071 or two, reading all values will take more than ten seconds (the default
6072 interval). We will probably add some separate thread for reading the sensors
6073 and some cache or something like that, but it's not done yet. We will try to
6074 maintain backwards compatibility in the future, but we can't promise. So in
6075 short: If it works for you: Great! But keep in mind that the config I<might>
6076 change, though this is unlikely. Oh, and if you want to help improving this
6077 plugin, just send a short notice to the mailing list. ThanksE<nbsp>:)
6079 =head2 Plugin C<openldap>
6081 To use the C<openldap> plugin you first need to configure the I<OpenLDAP>
6082 server correctly. The backend database C<monitor> needs to be loaded and
6083 working. See slapd-monitor(5) for the details.
6085 The configuration of the C<openldap> plugin consists of one or more B<Instance>
6086 blocks. Each block requires one string argument as the instance name. For
6091 URL "ldap://localhost/"
6094 URL "ldaps://localhost/"
6098 The instance name will be used as the I<plugin instance>. To emulate the old
6099 (versionE<nbsp>4) behavior, you can use an empty string (""). In order for the
6100 plugin to work correctly, each instance name must be unique. This is not
6101 enforced by the plugin and it is your responsibility to ensure it is.
6103 The following options are accepted within each B<Instance> block:
6107 =item B<URL> I<ldap://host/binddn>
6109 Sets the URL to use to connect to the I<OpenLDAP> server. This option is
6112 =item B<BindDN> I<BindDN>
6114 Name in the form of an LDAP distinguished name intended to be used for
6115 authentication. Defaults to empty string to establish an anonymous authorization.
6117 =item B<Password> I<Password>
6119 Password for simple bind authentication. If this option is not set,
6120 unauthenticated bind operation is used.
6122 =item B<StartTLS> B<true|false>
6124 Defines whether TLS must be used when connecting to the I<OpenLDAP> server.
6125 Disabled by default.
6127 =item B<VerifyHost> B<true|false>
6129 Enables or disables peer host name verification. If enabled, the plugin checks
6130 if the C<Common Name> or a C<Subject Alternate Name> field of the SSL
6131 certificate matches the host name provided by the B<URL> option. If this
6132 identity check fails, the connection is aborted. Enabled by default.
6134 =item B<CACert> I<File>
6136 File that holds one or more SSL certificates. If you want to use TLS/SSL you
6137 may possibly need this option. What CA certificates are checked by default
6138 depends on the distribution you use and can be changed with the usual ldap
6139 client configuration mechanisms. See ldap.conf(5) for the details.
6141 =item B<Timeout> I<Seconds>
6143 Sets the timeout value for ldap operations, in seconds. By default, the
6144 configured B<Interval> is used to set the timeout. Use B<-1> to disable
6147 =item B<Version> I<Version>
6149 An integer which sets the LDAP protocol version number to use when connecting
6150 to the I<OpenLDAP> server. Defaults to B<3> for using I<LDAPv3>.
6154 =head2 Plugin C<openvpn>
6156 The OpenVPN plugin reads a status file maintained by OpenVPN and gathers
6157 traffic statistics about connected clients.
6159 To set up OpenVPN to write to the status file periodically, use the
6160 B<--status> option of OpenVPN.
6162 So, in a nutshell you need:
6164 openvpn $OTHER_OPTIONS \
6165 --status "/var/run/openvpn-status" 10
6171 =item B<StatusFile> I<File>
6173 Specifies the location of the status file.
6175 =item B<ImprovedNamingSchema> B<true>|B<false>
6177 When enabled, the filename of the status file will be used as plugin instance
6178 and the client's "common name" will be used as type instance. This is required
6179 when reading multiple status files. Enabling this option is recommended, but to
6180 maintain backwards compatibility this option is disabled by default.
6182 =item B<CollectCompression> B<true>|B<false>
6184 Sets whether or not statistics about the compression used by OpenVPN should be
6185 collected. This information is only available in I<single> mode. Enabled by
6188 =item B<CollectIndividualUsers> B<true>|B<false>
6190 Sets whether or not traffic information is collected for each connected client
6191 individually. If set to false, currently no traffic data is collected at all
6192 because aggregating this data in a save manner is tricky. Defaults to B<true>.
6194 =item B<CollectUserCount> B<true>|B<false>
6196 When enabled, the number of currently connected clients or users is collected.
6197 This is especially interesting when B<CollectIndividualUsers> is disabled, but
6198 can be configured independently from that option. Defaults to B<false>.
6202 =head2 Plugin C<oracle>
6204 The "oracle" plugin uses the Oracle® Call Interface I<(OCI)> to connect to an
6205 Oracle® Database and lets you execute SQL statements there. It is very similar
6206 to the "dbi" plugin, because it was written around the same time. See the "dbi"
6207 plugin's documentation above for details.
6210 <Query "out_of_stock">
6211 Statement "SELECT category, COUNT(*) AS value FROM products WHERE in_stock = 0 GROUP BY category"
6214 # InstancePrefix "foo"
6215 InstancesFrom "category"
6219 <Database "product_information">
6224 Query "out_of_stock"
6228 =head3 B<Query> blocks
6230 The Query blocks are handled identically to the Query blocks of the "dbi"
6231 plugin. Please see its documentation above for details on how to specify
6234 =head3 B<Database> blocks
6236 Database blocks define a connection to a database and which queries should be
6237 sent to that database. Each database needs a "name" as string argument in the
6238 starting tag of the block. This name will be used as "PluginInstance" in the
6239 values submitted to the daemon. Other than that, that name is not used.
6243 =item B<Plugin> I<Plugin>
6245 Use I<Plugin> as the plugin name when submitting query results from
6246 this B<Database>. Defaults to C<oracle>.
6248 =item B<ConnectID> I<ID>
6250 Defines the "database alias" or "service name" to connect to. Usually, these
6251 names are defined in the file named C<$ORACLE_HOME/network/admin/tnsnames.ora>.
6253 =item B<Host> I<Host>
6255 Hostname to use when dispatching values for this database. Defaults to using
6256 the global hostname of the I<collectd> instance.
6258 =item B<Username> I<Username>
6260 Username used for authentication.
6262 =item B<Password> I<Password>
6264 Password used for authentication.
6266 =item B<Query> I<QueryName>
6268 Associates the query named I<QueryName> with this database connection. The
6269 query needs to be defined I<before> this statement, i.E<nbsp>e. all query
6270 blocks you want to refer to must be placed above the database block you want to
6275 =head2 Plugin C<ovs_events>
6277 The I<ovs_events> plugin monitors the link status of I<Open vSwitch> (OVS)
6278 connected interfaces, dispatches the values to collectd and sends the
6279 notification whenever the link state change occurs. This plugin uses OVS
6280 database to get a link state change notification.
6284 <Plugin "ovs_events">
6287 Socket "/var/run/openvswitch/db.sock"
6288 Interfaces "br0" "veth0"
6289 SendNotification true
6290 DispatchValues false
6293 The plugin provides the following configuration options:
6297 =item B<Address> I<node>
6299 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6300 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6301 option. See L<ovsdb-server(1)> for more details. The option may be either
6302 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6303 format. Defaults to C<localhost>.
6305 =item B<Port> I<service>
6307 TCP-port to connect to. Either a service name or a port number may be given.
6308 Defaults to B<6640>.
6310 =item B<Socket> I<path>
6312 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6313 plugin. To enable the interface, the OVS DB daemon should be running with
6314 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6315 option is set, B<Address> and B<Port> options are ignored.
6317 =item B<Interfaces> [I<ifname> ...]
6319 List of interface names to be monitored by this plugin. If this option is not
6320 specified or is empty then all OVS connected interfaces on all bridges are
6323 Default: empty (all interfaces on all bridges are monitored)
6325 =item B<SendNotification> I<true|false>
6327 If set to true, OVS link notifications (interface status and OVS DB connection
6328 terminate) are sent to collectd. Default value is true.
6330 =item B<DispatchValues> I<true|false>
6332 Dispatch the OVS DB interface link status value with configured plugin interval.
6333 Defaults to false. Please note, if B<SendNotification> and B<DispatchValues>
6334 options are false, no OVS information will be provided by the plugin.
6338 B<Note:> By default, the global interval setting is used within which to
6339 retrieve the OVS link status. To configure a plugin-specific interval, please
6340 use B<Interval> option of the OVS B<LoadPlugin> block settings. For milliseconds
6341 simple divide the time by 1000 for example if the desired interval is 50ms, set
6344 =head2 Plugin C<ovs_stats>
6346 The I<ovs_stats> plugin collects statistics of OVS connected interfaces.
6347 This plugin uses OVSDB management protocol (RFC7047) monitor mechanism to get
6348 statistics from OVSDB
6352 <Plugin "ovs_stats">
6355 Socket "/var/run/openvswitch/db.sock"
6356 Bridges "br0" "br_ext"
6359 The plugin provides the following configuration options:
6363 =item B<Address> I<node>
6365 The address of the OVS DB server JSON-RPC interface used by the plugin. To
6366 enable the interface, OVS DB daemon should be running with C<--remote=ptcp:>
6367 option. See L<ovsdb-server(1)> for more details. The option may be either
6368 network hostname, IPv4 numbers-and-dots notation or IPv6 hexadecimal string
6369 format. Defaults to C<localhost>.
6371 =item B<Port> I<service>
6373 TCP-port to connect to. Either a service name or a port number may be given.
6374 Defaults to B<6640>.
6376 =item B<Socket> I<path>
6378 The UNIX domain socket path of OVS DB server JSON-RPC interface used by the
6379 plugin. To enable the interface, the OVS DB daemon should be running with
6380 C<--remote=punix:> option. See L<ovsdb-server(1)> for more details. If this
6381 option is set, B<Address> and B<Port> options are ignored.
6383 =item B<Bridges> [I<brname> ...]
6385 List of OVS bridge names to be monitored by this plugin. If this option is
6386 omitted or is empty then all OVS bridges will be monitored.
6388 Default: empty (monitor all bridges)
6392 =head2 Plugin C<pcie_errors>
6394 The I<pcie_errors> plugin collects PCI Express errors from Device Status in Capability
6395 structure and from Advanced Error Reporting Extended Capability where available.
6396 At every read it polls config space of PCI Express devices and dispatches
6397 notification for every error that is set. It checks for new errors at every read.
6398 The device is indicated in plugin_instance according to format "domain:bus:dev.fn".
6399 Errors are divided into categories indicated by type_instance: "correctable", and
6400 for uncorrectable errors "non_fatal" or "fatal".
6401 Fatal errors are reported as I<NOTIF_FAILURE> and all others as I<NOTIF_WARNING>.
6405 <Plugin "pcie_errors">
6407 AccessDir "/sys/bus/pci"
6409 PersistentNotifications false
6416 =item B<Source> B<sysfs>|B<proc>
6418 Use B<sysfs> or B<proc> to read data from /sysfs or /proc.
6419 The default value is B<sysfs>.
6421 =item B<AccessDir> I<dir>
6423 Directory used to access device config space. It is optional and defaults to
6424 /sys/bus/pci for B<sysfs> and to /proc/bus/pci for B<proc>.
6426 =item B<ReportMasked> B<false>|B<true>
6428 If true plugin will notify about errors that are set to masked in Error Mask register.
6429 Such errors are not reported to the PCI Express Root Complex. Defaults to B<false>.
6431 =item B<PersistentNotifications> B<false>|B<true>
6433 If false plugin will dispatch notification only on set/clear of error.
6434 The ones already reported will be ignored. Defaults to B<false>.
6438 =head2 Plugin C<perl>
6440 This plugin embeds a Perl-interpreter into collectd and provides an interface
6441 to collectd's plugin system. See L<collectd-perl(5)> for its documentation.
6443 =head2 Plugin C<pinba>
6445 The I<Pinba plugin> receives profiling information from I<Pinba>, an extension
6446 for the I<PHP> interpreter. At the end of executing a script, i.e. after a
6447 PHP-based webpage has been delivered, the extension will send a UDP packet
6448 containing timing information, peak memory usage and so on. The plugin will
6449 wait for such packets, parse them and account the provided information, which
6450 is then dispatched to the daemon once per interval.
6457 # Overall statistics for the website.
6459 Server "www.example.com"
6461 # Statistics for www-a only
6463 Host "www-a.example.com"
6464 Server "www.example.com"
6466 # Statistics for www-b only
6468 Host "www-b.example.com"
6469 Server "www.example.com"
6473 The plugin provides the following configuration options:
6477 =item B<Address> I<Node>
6479 Configures the address used to open a listening socket. By default, plugin will
6480 bind to the I<any> address C<::0>.
6482 =item B<Port> I<Service>
6484 Configures the port (service) to bind to. By default the default Pinba port
6485 "30002" will be used. The option accepts service names in addition to port
6486 numbers and thus requires a I<string> argument.
6488 =item E<lt>B<View> I<Name>E<gt> block
6490 The packets sent by the Pinba extension include the hostname of the server, the
6491 server name (the name of the virtual host) and the script that was executed.
6492 Using B<View> blocks it is possible to separate the data into multiple groups
6493 to get more meaningful statistics. Each packet is added to all matching groups,
6494 so that a packet may be accounted for more than once.
6498 =item B<Host> I<Host>
6500 Matches the hostname of the system the webserver / script is running on. This
6501 will contain the result of the L<gethostname(2)> system call. If not
6502 configured, all hostnames will be accepted.
6504 =item B<Server> I<Server>
6506 Matches the name of the I<virtual host>, i.e. the contents of the
6507 C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
6508 server names will be accepted.
6510 =item B<Script> I<Script>
6512 Matches the name of the I<script name>, i.e. the contents of the
6513 C<$_SERVER["SCRIPT_NAME"]> variable when within PHP. If not configured, all
6514 script names will be accepted.
6520 =head2 Plugin C<ping>
6522 The I<Ping> plugin starts a new thread which sends ICMP "ping" packets to the
6523 configured hosts periodically and measures the network latency. Whenever the
6524 C<read> function of the plugin is called, it submits the average latency, the
6525 standard deviation and the drop rate for each host.
6527 Available configuration options:
6531 =item B<Host> I<IP-address>
6533 Host to ping periodically. This option may be repeated several times to ping
6536 =item B<Interval> I<Seconds>
6538 Sets the interval in which to send ICMP echo packets to the configured hosts.
6539 This is B<not> the interval in which metrics are read from the plugin but the
6540 interval in which the hosts are "pinged". Therefore, the setting here should be
6541 smaller than or equal to the global B<Interval> setting. Fractional times, such
6542 as "1.24" are allowed.
6546 =item B<Timeout> I<Seconds>
6548 Time to wait for a response from the host to which an ICMP packet had been
6549 sent. If a reply was not received after I<Seconds> seconds, the host is assumed
6550 to be down or the packet to be dropped. This setting must be smaller than the
6551 B<Interval> setting above for the plugin to work correctly. Fractional
6552 arguments are accepted.
6556 =item B<TTL> I<0-255>
6558 Sets the Time-To-Live of generated ICMP packets.
6560 =item B<Size> I<size>
6562 Sets the size of the data payload in ICMP packet to specified I<size> (it
6563 will be filled with regular ASCII pattern). If not set, default 56 byte
6564 long string is used so that the packet size of an ICMPv4 packet is exactly
6565 64 bytes, similar to the behaviour of normal ping(1) command.
6567 =item B<SourceAddress> I<host>
6569 Sets the source address to use. I<host> may either be a numerical network
6570 address or a network hostname.
6572 =item B<AddressFamily> I<af>
6574 Sets the address family to use. I<af> may be "any", "ipv4" or "ipv6". This
6575 option will be ignored if you set a B<SourceAddress>.
6577 =item B<Device> I<name>
6579 Sets the outgoing network device to be used. I<name> has to specify an
6580 interface name (e.E<nbsp>g. C<eth0>). This might not be supported by all
6583 =item B<MaxMissed> I<Packets>
6585 Trigger a DNS resolve after the host has not replied to I<Packets> packets. This
6586 enables the use of dynamic DNS services (like dyndns.org) with the ping plugin.
6588 Default: B<-1> (disabled)
6592 =head2 Plugin C<postgresql>
6594 The C<postgresql> plugin queries statistics from PostgreSQL databases. It
6595 keeps a persistent connection to all configured databases and tries to
6596 reconnect if the connection has been interrupted. A database is configured by
6597 specifying a B<Database> block as described below. The default statistics are
6598 collected from PostgreSQL's B<statistics collector> which thus has to be
6599 enabled for this plugin to work correctly. This should usually be the case by
6600 default. See the section "The Statistics Collector" of the B<PostgreSQL
6601 Documentation> for details.
6603 By specifying custom database queries using a B<Query> block as described
6604 below, you may collect any data that is available from some PostgreSQL
6605 database. This way, you are able to access statistics of external daemons
6606 which are available in a PostgreSQL database or use future or special
6607 statistics provided by PostgreSQL without the need to upgrade your collectd
6610 Starting with version 5.2, the C<postgresql> plugin supports writing data to
6611 PostgreSQL databases as well. This has been implemented in a generic way. You
6612 need to specify an SQL statement which will then be executed by collectd in
6613 order to write the data (see below for details). The benefit of that approach
6614 is that there is no fixed database layout. Rather, the layout may be optimized
6615 for the current setup.
6617 The B<PostgreSQL Documentation> manual can be found at
6618 L<http://www.postgresql.org/docs/manuals/>.
6622 Statement "SELECT magic FROM wizard WHERE host = $1;"
6626 InstancePrefix "magic"
6631 <Query rt36_tickets>
6632 Statement "SELECT COUNT(type) AS count, type \
6634 WHEN resolved = 'epoch' THEN 'open' \
6635 ELSE 'resolved' END AS type \
6636 FROM tickets) type \
6640 InstancePrefix "rt36_tickets"
6641 InstancesFrom "type"
6647 Statement "SELECT collectd_insert($1, $2, $3, $4, $5, $6, $7, $8, $9);"
6658 KRBSrvName "kerberos_service_name"
6664 Service "service_name"
6665 Query backends # predefined
6676 The B<Query> block defines one database query which may later be used by a
6677 database definition. It accepts a single mandatory argument which specifies
6678 the name of the query. The names of all queries have to be unique (see the
6679 B<MinVersion> and B<MaxVersion> options below for an exception to this
6682 In each B<Query> block, there is one or more B<Result> blocks. Multiple
6683 B<Result> blocks may be used to extract multiple values from a single query.
6685 The following configuration options are available to define the query:
6689 =item B<Statement> I<sql query statement>
6691 Specify the I<sql query statement> which the plugin should execute. The string
6692 may contain the tokens B<$1>, B<$2>, etc. which are used to reference the
6693 first, second, etc. parameter. The value of the parameters is specified by the
6694 B<Param> configuration option - see below for details. To include a literal
6695 B<$> character followed by a number, surround it with single quotes (B<'>).
6697 Any SQL command which may return data (such as C<SELECT> or C<SHOW>) is
6698 allowed. Note, however, that only a single command may be used. Semicolons are
6699 allowed as long as a single non-empty command has been specified only.
6701 The returned lines will be handled separately one after another.
6703 =item B<Param> I<hostname>|I<database>|I<instance>|I<username>|I<interval>
6705 Specify the parameters which should be passed to the SQL query. The parameters
6706 are referred to in the SQL query as B<$1>, B<$2>, etc. in the same order as
6707 they appear in the configuration file. The value of the parameter is
6708 determined depending on the value of the B<Param> option as follows:
6714 The configured hostname of the database connection. If a UNIX domain socket is
6715 used, the parameter expands to "localhost".
6719 The name of the database of the current connection.
6723 The name of the database plugin instance. See the B<Instance> option of the
6724 database specification below for details.
6728 The username used to connect to the database.
6732 The interval with which this database is queried (as specified by the database
6733 specific or global B<Interval> options).
6737 Please note that parameters are only supported by PostgreSQL's protocol
6738 version 3 and above which was introduced in version 7.4 of PostgreSQL.
6740 =item B<PluginInstanceFrom> I<column>
6742 Specify how to create the "PluginInstance" for reporting this query results.
6743 Only one column is supported. You may concatenate fields and string values in
6744 the query statement to get the required results.
6746 =item B<MinVersion> I<version>
6748 =item B<MaxVersion> I<version>
6750 Specify the minimum or maximum version of PostgreSQL that this query should be
6751 used with. Some statistics might only be available with certain versions of
6752 PostgreSQL. This allows you to specify multiple queries with the same name but
6753 which apply to different versions, thus allowing you to use the same
6754 configuration in a heterogeneous environment.
6756 The I<version> has to be specified as the concatenation of the major, minor
6757 and patch-level versions, each represented as two-decimal-digit numbers. For
6758 example, version 8.2.3 will become 80203.
6762 The B<Result> block defines how to handle the values returned from the query.
6763 It defines which column holds which value and how to dispatch that value to
6768 =item B<Type> I<type>
6770 The I<type> name to be used when dispatching the values. The type describes
6771 how to handle the data and where to store it. See L<types.db(5)> for more
6772 details on types and their configuration. The number and type of values (as
6773 selected by the B<ValuesFrom> option) has to match the type of the given name.
6775 This option is mandatory.
6777 =item B<InstancePrefix> I<prefix>
6779 =item B<InstancesFrom> I<column0> [I<column1> ...]
6781 Specify how to create the "TypeInstance" for each data set (i.E<nbsp>e. line).
6782 B<InstancePrefix> defines a static prefix that will be prepended to all type
6783 instances. B<InstancesFrom> defines the column names whose values will be used
6784 to create the type instance. Multiple values will be joined together using the
6785 hyphen (C<->) as separation character.
6787 The plugin itself does not check whether or not all built instances are
6788 different. It is your responsibility to assure that each is unique.
6790 Both options are optional. If none is specified, the type instance will be
6793 =item B<ValuesFrom> I<column0> [I<column1> ...]
6795 Names the columns whose content is used as the actual data for the data sets
6796 that are dispatched to the daemon. How many such columns you need is
6797 determined by the B<Type> setting as explained above. If you specify too many
6798 or not enough columns, the plugin will complain about that and no data will be
6799 submitted to the daemon.
6801 The actual data type, as seen by PostgreSQL, is not that important as long as
6802 it represents numbers. The plugin will automatically cast the values to the
6803 right type if it know how to do that. For that, it uses the L<strtoll(3)> and
6804 L<strtod(3)> functions, so anything supported by those functions is supported
6805 by the plugin as well.
6807 This option is required inside a B<Result> block and may be specified multiple
6808 times. If multiple B<ValuesFrom> options are specified, the columns are read
6813 The following predefined queries are available (the definitions can be found
6814 in the F<postgresql_default.conf> file which, by default, is available at
6815 C<I<prefix>/share/collectd/>):
6821 This query collects the number of backends, i.E<nbsp>e. the number of
6824 =item B<transactions>
6826 This query collects the numbers of committed and rolled-back transactions of
6831 This query collects the numbers of various table modifications (i.E<nbsp>e.
6832 insertions, updates, deletions) of the user tables.
6834 =item B<query_plans>
6836 This query collects the numbers of various table scans and returned tuples of
6839 =item B<table_states>
6841 This query collects the numbers of live and dead rows in the user tables.
6845 This query collects disk block access counts for user tables.
6849 This query collects the on-disk size of the database in bytes.
6853 In addition, the following detailed queries are available by default. Please
6854 note that each of those queries collects information B<by table>, thus,
6855 potentially producing B<a lot> of data. For details see the description of the
6856 non-by_table queries above.
6860 =item B<queries_by_table>
6862 =item B<query_plans_by_table>
6864 =item B<table_states_by_table>
6866 =item B<disk_io_by_table>
6870 The B<Writer> block defines a PostgreSQL writer backend. It accepts a single
6871 mandatory argument specifying the name of the writer. This will then be used
6872 in the B<Database> specification in order to activate the writer instance. The
6873 names of all writers have to be unique. The following options may be
6878 =item B<Statement> I<sql statement>
6880 This mandatory option specifies the SQL statement that will be executed for
6881 each submitted value. A single SQL statement is allowed only. Anything after
6882 the first semicolon will be ignored.
6884 Nine parameters will be passed to the statement and should be specified as
6885 tokens B<$1>, B<$2>, through B<$9> in the statement string. The following
6886 values are made available through those parameters:
6892 The timestamp of the queried value as an RFC 3339-formatted local time.
6896 The hostname of the queried value.
6900 The plugin name of the queried value.
6904 The plugin instance of the queried value. This value may be B<NULL> if there
6905 is no plugin instance.
6909 The type of the queried value (cf. L<types.db(5)>).
6913 The type instance of the queried value. This value may be B<NULL> if there is
6918 An array of names for the submitted values (i.E<nbsp>e., the name of the data
6919 sources of the submitted value-list).
6923 An array of types for the submitted values (i.E<nbsp>e., the type of the data
6924 sources of the submitted value-list; C<counter>, C<gauge>, ...). Note, that if
6925 B<StoreRates> is enabled (which is the default, see below), all types will be
6930 An array of the submitted values. The dimensions of the value name and value
6935 In general, it is advisable to create and call a custom function in the
6936 PostgreSQL database for this purpose. Any procedural language supported by
6937 PostgreSQL will do (see chapter "Server Programming" in the PostgreSQL manual
6940 =item B<StoreRates> B<false>|B<true>
6942 If set to B<true> (the default), convert counter values to rates. If set to
6943 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
6948 The B<Database> block defines one PostgreSQL database for which to collect
6949 statistics. It accepts a single mandatory argument which specifies the
6950 database name. None of the other options are required. PostgreSQL will use
6951 default values as documented in the section "CONNECTING TO A DATABASE" in the
6952 L<psql(1)> manpage. However, be aware that those defaults may be influenced by
6953 the user collectd is run as and special environment variables. See the manpage
6958 =item B<Interval> I<seconds>
6960 Specify the interval with which the database should be queried. The default is
6961 to use the global B<Interval> setting.
6963 =item B<CommitInterval> I<seconds>
6965 This option may be used for database connections which have "writers" assigned
6966 (see above). If specified, it causes a writer to put several updates into a
6967 single transaction. This transaction will last for the specified amount of
6968 time. By default, each update will be executed in a separate transaction. Each
6969 transaction generates a fair amount of overhead which can, thus, be reduced by
6970 activating this option. The draw-back is, that data covering the specified
6971 amount of time will be lost, for example, if a single statement within the
6972 transaction fails or if the database server crashes.
6974 =item B<Plugin> I<Plugin>
6976 Use I<Plugin> as the plugin name when submitting query results from
6977 this B<Database>. Defaults to C<postgresql>.
6979 =item B<Instance> I<name>
6981 Specify the plugin instance name that should be used instead of the database
6982 name (which is the default, if this option has not been specified). This
6983 allows one to query multiple databases of the same name on the same host (e.g.
6984 when running multiple database server versions in parallel).
6985 The plugin instance name can also be set from the query result using
6986 the B<PluginInstanceFrom> option in B<Query> block.
6988 =item B<Host> I<hostname>
6990 Specify the hostname or IP of the PostgreSQL server to connect to. If the
6991 value begins with a slash, it is interpreted as the directory name in which to
6992 look for the UNIX domain socket.
6994 This option is also used to determine the hostname that is associated with a
6995 collected data set. If it has been omitted or either begins with with a slash
6996 or equals B<localhost> it will be replaced with the global hostname definition
6997 of collectd. Any other value will be passed literally to collectd when
6998 dispatching values. Also see the global B<Hostname> and B<FQDNLookup> options.
7000 =item B<Port> I<port>
7002 Specify the TCP port or the local UNIX domain socket file extension of the
7005 =item B<User> I<username>
7007 Specify the username to be used when connecting to the server.
7009 =item B<Password> I<password>
7011 Specify the password to be used when connecting to the server.
7013 =item B<ExpireDelay> I<delay>
7015 Skip expired values in query output.
7017 =item B<SSLMode> I<disable>|I<allow>|I<prefer>|I<require>
7019 Specify whether to use an SSL connection when contacting the server. The
7020 following modes are supported:
7026 Do not use SSL at all.
7030 First, try to connect without using SSL. If that fails, try using SSL.
7032 =item I<prefer> (default)
7034 First, try to connect using SSL. If that fails, try without using SSL.
7042 =item B<Instance> I<name>
7044 Specify the plugin instance name that should be used instead of the database
7045 name (which is the default, if this option has not been specified). This
7046 allows one to query multiple databases of the same name on the same host (e.g.
7047 when running multiple database server versions in parallel).
7049 =item B<KRBSrvName> I<kerberos_service_name>
7051 Specify the Kerberos service name to use when authenticating with Kerberos 5
7052 or GSSAPI. See the sections "Kerberos authentication" and "GSSAPI" of the
7053 B<PostgreSQL Documentation> for details.
7055 =item B<Service> I<service_name>
7057 Specify the PostgreSQL service name to use for additional parameters. That
7058 service has to be defined in F<pg_service.conf> and holds additional
7059 connection parameters. See the section "The Connection Service File" in the
7060 B<PostgreSQL Documentation> for details.
7062 =item B<Query> I<query>
7064 Specifies a I<query> which should be executed in the context of the database
7065 connection. This may be any of the predefined or user-defined queries. If no
7066 such option is given, it defaults to "backends", "transactions", "queries",
7067 "query_plans", "table_states", "disk_io" and "disk_usage" (unless a B<Writer>
7068 has been specified). Else, the specified queries are used only.
7070 =item B<Writer> I<writer>
7072 Assigns the specified I<writer> backend to the database connection. This
7073 causes all collected data to be send to the database using the settings
7074 defined in the writer configuration (see the section "FILTER CONFIGURATION"
7075 below for details on how to selectively send data to certain plugins).
7077 Each writer will register a flush callback which may be used when having long
7078 transactions enabled (see the B<CommitInterval> option above). When issuing
7079 the B<FLUSH> command (see L<collectd-unixsock(5)> for details) the current
7080 transaction will be committed right away. Two different kinds of flush
7081 callbacks are available with the C<postgresql> plugin:
7087 Flush all writer backends.
7089 =item B<postgresql->I<database>
7091 Flush all writers of the specified I<database> only.
7097 =head2 Plugin C<powerdns>
7099 The C<powerdns> plugin queries statistics from an authoritative PowerDNS
7100 nameserver and/or a PowerDNS recursor. Since both offer a wide variety of
7101 values, many of which are probably meaningless to most users, but may be useful
7102 for some. So you may chose which values to collect, but if you don't, some
7103 reasonable defaults will be collected.
7106 <Server "server_name">
7108 Collect "udp-answers" "udp-queries"
7109 Socket "/var/run/pdns.controlsocket"
7111 <Recursor "recursor_name">
7113 Collect "cache-hits" "cache-misses"
7114 Socket "/var/run/pdns_recursor.controlsocket"
7116 LocalSocket "/opt/collectd/var/run/collectd-powerdns"
7121 =item B<Server> and B<Recursor> block
7123 The B<Server> block defines one authoritative server to query, the B<Recursor>
7124 does the same for an recursing server. The possible options in both blocks are
7125 the same, though. The argument defines a name for the serverE<nbsp>/ recursor
7130 =item B<Collect> I<Field>
7132 Using the B<Collect> statement you can select which values to collect. Here,
7133 you specify the name of the values as used by the PowerDNS servers, e.E<nbsp>g.
7134 C<dlg-only-drops>, C<answers10-100>.
7136 The method of getting the values differs for B<Server> and B<Recursor> blocks:
7137 When querying the server a C<SHOW *> command is issued in any case, because
7138 that's the only way of getting multiple values out of the server at once.
7139 collectd then picks out the values you have selected. When querying the
7140 recursor, a command is generated to query exactly these values. So if you
7141 specify invalid fields when querying the recursor, a syntax error may be
7142 returned by the daemon and collectd may not collect any values at all.
7144 If no B<Collect> statement is given, the following B<Server> values will be
7151 =item packetcache-hit
7153 =item packetcache-miss
7155 =item packetcache-size
7157 =item query-cache-hit
7159 =item query-cache-miss
7161 =item recursing-answers
7163 =item recursing-questions
7175 The following B<Recursor> values will be collected by default:
7179 =item noerror-answers
7181 =item nxdomain-answers
7183 =item servfail-answers
7201 Please note that up to that point collectd doesn't know what values are
7202 available on the server and values that are added do not need a change of the
7203 mechanism so far. However, the values must be mapped to collectd's naming
7204 scheme, which is done using a lookup table that lists all known values. If
7205 values are added in the future and collectd does not know about them, you will
7206 get an error much like this:
7208 powerdns plugin: submit: Not found in lookup table: foobar = 42
7210 In this case please file a bug report with the collectd team.
7212 =item B<Socket> I<Path>
7214 Configures the path to the UNIX domain socket to be used when connecting to the
7215 daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for
7216 an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket>
7217 will be used for the recursor.
7221 =item B<LocalSocket> I<Path>
7223 Querying the recursor is done using UDP. When using UDP over UNIX domain
7224 sockets, the client socket needs a name in the file system, too. You can set
7225 this local name to I<Path> using the B<LocalSocket> option. The default is
7226 C<I<prefix>/var/run/collectd-powerdns>.
7230 =head2 Plugin C<processes>
7232 Collects information about processes of local system.
7234 By default, with no process matches configured, only general statistics is
7235 collected: the number of processes in each state and fork rate.
7237 Process matches can be configured by B<Process> and B<ProcessMatch> options.
7238 These may also be a block in which further options may be specified.
7240 The statistics collected for matched processes are:
7241 - size of the resident segment size (RSS)
7242 - user- and system-time used
7243 - number of processes
7245 - number of open files (under Linux)
7246 - number of memory mapped files (under Linux)
7247 - io data (where available)
7248 - context switches (under Linux)
7249 - minor and major pagefaults
7250 - Delay Accounting information (Linux only, requires libmnl)
7255 CollectFileDescriptor true
7256 CollectContextSwitch true
7257 CollectDelayAccounting false
7259 ProcessMatch "name" "regex"
7260 <Process "collectd">
7261 CollectFileDescriptor false
7262 CollectContextSwitch false
7263 CollectDelayAccounting true
7265 <ProcessMatch "name" "regex">
7266 CollectFileDescriptor false
7267 CollectContextSwitch true
7273 =item B<Process> I<Name>
7275 Select more detailed statistics of processes matching this name.
7277 Some platforms have a limit on the length of process names.
7278 I<Name> must stay below this limit.
7280 =item B<ProcessMatch> I<name> I<regex>
7282 Select more detailed statistics of processes matching the specified I<regex>
7283 (see L<regex(7)> for details). The statistics of all matching processes are
7284 summed up and dispatched to the daemon using the specified I<name> as an
7285 identifier. This allows one to "group" several processes together.
7286 I<name> must not contain slashes.
7288 =item B<CollectContextSwitch> I<Boolean>
7290 Collect the number of context switches for matched processes.
7291 Disabled by default.
7293 =item B<CollectDelayAccounting> I<Boolean>
7295 If enabled, collect Linux Delay Accounding information for matching processes.
7296 Delay Accounting provides the time processes wait for the CPU to become
7297 available, for I/O operations to finish, for pages to be swapped in and for
7298 freed pages to be reclaimed. The metrics are reported as "seconds per second"
7299 using the C<delay_rate> type, e.g. C<delay_rate-delay-cpu>.
7300 Disabled by default.
7302 This option is only available on Linux, requires the C<libmnl> library and
7303 requires the C<CAP_NET_ADMIN> capability at runtime.
7305 =item B<CollectFileDescriptor> I<Boolean>
7307 Collect number of file descriptors of matched processes.
7308 Disabled by default.
7310 =item B<CollectMemoryMaps> I<Boolean>
7312 Collect the number of memory mapped files of the process.
7313 The limit for this number is configured via F</proc/sys/vm/max_map_count> in
7318 The B<CollectContextSwitch>, B<CollectDelayAccounting>,
7319 B<CollectFileDescriptor> and B<CollectMemoryMaps> options may be used inside
7320 B<Process> and B<ProcessMatch> blocks. When used there, these options affect
7321 reporting the corresponding processes only. Outside of B<Process> and
7322 B<ProcessMatch> blocks these options set the default value for subsequent
7325 =head2 Plugin C<protocols>
7327 Collects a lot of information about various network protocols, such as I<IP>,
7328 I<TCP>, I<UDP>, etc.
7330 Available configuration options:
7334 =item B<Value> I<Selector>
7336 Selects whether or not to select a specific value. The string being matched is
7337 of the form "I<Protocol>:I<ValueName>", where I<Protocol> will be used as the
7338 plugin instance and I<ValueName> will be used as type instance. An example of
7339 the string being used would be C<Tcp:RetransSegs>.
7341 You can use regular expressions to match a large number of values with just one
7342 configuration option. To select all "extended" I<TCP> values, you could use the
7343 following statement:
7347 Whether only matched values are selected or all matched values are ignored
7348 depends on the B<IgnoreSelected>. By default, only matched values are selected.
7349 If no value is configured at all, all values will be selected.
7351 See F</"IGNORELISTS"> for details.
7353 =item B<IgnoreSelected> B<true>|B<false>
7355 If set to B<true>, inverts the selection made by B<Value>, i.E<nbsp>e. all
7356 matching values will be ignored.
7360 =head2 Plugin C<python>
7362 This plugin embeds a Python-interpreter into collectd and provides an interface
7363 to collectd's plugin system. See L<collectd-python(5)> for its documentation.
7365 =head2 Plugin C<routeros>
7367 The C<routeros> plugin connects to a device running I<RouterOS>, the
7368 Linux-based operating system for routers by I<MikroTik>. The plugin uses
7369 I<librouteros> to connect and reads information about the interfaces and
7370 wireless connections of the device. The configuration supports querying
7375 Host "router0.example.com"
7378 CollectInterface true
7383 Host "router1.example.com"
7386 CollectInterface true
7387 CollectRegistrationTable true
7394 As you can see above, the configuration of the I<routeros> plugin consists of
7395 one or more B<E<lt>RouterE<gt>> blocks. Within each block, the following
7396 options are understood:
7400 =item B<Host> I<Host>
7402 Hostname or IP-address of the router to connect to.
7404 =item B<Port> I<Port>
7406 Port name or port number used when connecting. If left unspecified, the default
7407 will be chosen by I<librouteros>, currently "8728". This option expects a
7408 string argument, even when a numeric port number is given.
7410 =item B<User> I<User>
7412 Use the user name I<User> to authenticate. Defaults to "admin".
7414 =item B<Password> I<Password>
7416 Set the password used to authenticate.
7418 =item B<CollectInterface> B<true>|B<false>
7420 When set to B<true>, interface statistics will be collected for all interfaces
7421 present on the device. Defaults to B<false>.
7423 =item B<CollectRegistrationTable> B<true>|B<false>
7425 When set to B<true>, information about wireless LAN connections will be
7426 collected. Defaults to B<false>.
7428 =item B<CollectCPULoad> B<true>|B<false>
7430 When set to B<true>, information about the CPU usage will be collected. The
7431 number is a dimensionless value where zero indicates no CPU usage at all.
7432 Defaults to B<false>.
7434 =item B<CollectMemory> B<true>|B<false>
7436 When enabled, the amount of used and free memory will be collected. How used
7437 memory is calculated is unknown, for example whether or not caches are counted
7439 Defaults to B<false>.
7441 =item B<CollectDF> B<true>|B<false>
7443 When enabled, the amount of used and free disk space will be collected.
7444 Defaults to B<false>.
7446 =item B<CollectDisk> B<true>|B<false>
7448 When enabled, the number of sectors written and bad blocks will be collected.
7449 Defaults to B<false>.
7451 =item B<CollectHealth> B<true>|B<false>
7453 When enabled, the health statistics will be collected. This includes the
7454 voltage and temperature on supported hardware.
7455 Defaults to B<false>.
7459 =head2 Plugin C<redis>
7461 The I<Redis plugin> connects to one or more Redis servers, gathers
7462 information about each server's state and executes user-defined queries.
7463 For each server there is a I<Node> block which configures the connection
7464 parameters and set of user-defined queries for this node.
7470 #Socket "/var/run/redis/redis.sock"
7472 ReportCommandStats false
7474 <Query "LLEN myqueue">
7484 =item B<Node> I<Nodename>
7486 The B<Node> block identifies a new Redis node, that is a new Redis instance
7487 running in an specified host and port. The name for node is a canonical
7488 identifier which is used as I<plugin instance>. It is limited to
7489 128E<nbsp>characters in length.
7491 When no B<Node> is configured explicitly, plugin connects to "localhost:6379".
7493 =item B<Host> I<Hostname>
7495 The B<Host> option is the hostname or IP-address where the Redis instance is
7498 =item B<Port> I<Port>
7500 The B<Port> option is the TCP port on which the Redis instance accepts
7501 connections. Either a service name of a port number may be given. Please note
7502 that numerical port numbers must be given as a string, too.
7504 =item B<Socket> I<Path>
7506 Connect to Redis using the UNIX domain socket at I<Path>. If this
7507 setting is given, the B<Hostname> and B<Port> settings are ignored.
7509 =item B<Password> I<Password>
7511 Use I<Password> to authenticate when connecting to I<Redis>.
7513 =item B<Timeout> I<Milliseconds>
7515 The B<Timeout> option set the socket timeout for node response. Since the Redis
7516 read function is blocking, you should keep this value as low as possible.
7517 It is expected what B<Timeout> values should be lower than B<Interval> defined
7520 Defaults to 2000 (2 seconds).
7522 =item B<ReportCommandStats> B<false>|B<true>
7524 Enables or disables reporting of statistics based on the command type, including
7525 rate of command calls and average CPU time consumed by command processing.
7526 Defaults to B<false>.
7528 =item B<ReportCpuUsage> B<true>|B<false>
7530 Enables or disables reporting of CPU consumption statistics.
7531 Defaults to B<true>.
7533 =item B<Query> I<Querystring>
7535 The B<Query> block identifies a query to execute against the redis server.
7536 There may be an arbitrary number of queries to execute. Each query should
7537 return single string or integer.
7539 =item B<Type> I<Collectd type>
7541 Within a query definition, a valid I<collectd type> to use as when submitting
7542 the result of the query. When not supplied, will default to B<gauge>.
7544 Currently only types with one datasource are supported.
7545 See L<types.db(5)> for more details on types and their configuration.
7547 =item B<Instance> I<Type instance>
7549 Within a query definition, an optional type instance to use when submitting
7550 the result of the query. When not supplied will default to the escaped
7551 command, up to 128 chars.
7553 =item B<Database> I<Index>
7555 This index selects the Redis logical database to use for query. Defaults
7560 =head2 Plugin C<rrdcached>
7562 The C<rrdcached> plugin uses the RRDtool accelerator daemon, L<rrdcached(1)>,
7563 to store values to RRD files in an efficient manner. The combination of the
7564 C<rrdcached> B<plugin> and the C<rrdcached> B<daemon> is very similar to the
7565 way the C<rrdtool> plugin works (see below). The added abstraction layer
7566 provides a number of benefits, though: Because the cache is not within
7567 C<collectd> anymore, it does not need to be flushed when C<collectd> is to be
7568 restarted. This results in much shorter (if any) gaps in graphs, especially
7569 under heavy load. Also, the C<rrdtool> command line utility is aware of the
7570 daemon so that it can flush values to disk automatically when needed. This
7571 allows one to integrate automated flushing of values into graphing solutions
7574 There are disadvantages, though: The daemon may reside on a different host, so
7575 it may not be possible for C<collectd> to create the appropriate RRD files
7576 anymore. And even if C<rrdcached> runs on the same host, it may run in a
7577 different base directory, so relative paths may do weird stuff if you're not
7580 So the B<recommended configuration> is to let C<collectd> and C<rrdcached> run
7581 on the same host, communicating via a UNIX domain socket. The B<DataDir>
7582 setting should be set to an absolute path, so that a changed base directory
7583 does not result in RRD files being createdE<nbsp>/ expected in the wrong place.
7587 =item B<DaemonAddress> I<Address>
7589 Address of the daemon as understood by the C<rrdc_connect> function of the RRD
7590 library. See L<rrdcached(1)> for details. Example:
7592 <Plugin "rrdcached">
7593 DaemonAddress "unix:/var/run/rrdcached.sock"
7596 =item B<DataDir> I<Directory>
7598 Set the base directory in which the RRD files reside. If this is a relative
7599 path, it is relative to the working base directory of the C<rrdcached> daemon!
7600 Use of an absolute path is recommended.
7602 =item B<CreateFiles> B<true>|B<false>
7604 Enables or disables the creation of RRD files. If the daemon is not running
7605 locally, or B<DataDir> is set to a relative path, this will not work as
7606 expected. Default is B<true>.
7608 =item B<CreateFilesAsync> B<false>|B<true>
7610 When enabled, new RRD files are enabled asynchronously, using a separate thread
7611 that runs in the background. This prevents writes to block, which is a problem
7612 especially when many hundreds of files need to be created at once. However,
7613 since the purpose of creating the files asynchronously is I<not> to block until
7614 the file is available, values before the file is available will be discarded.
7615 When disabled (the default) files are created synchronously, blocking for a
7616 short while, while the file is being written.
7618 =item B<StepSize> I<Seconds>
7620 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7621 this setting is unset and the stepsize is set to the interval in which the data
7622 is collected. Do not use this option unless you absolutely have to for some
7623 reason. Setting this option may cause problems with the C<snmp plugin>, the
7624 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7626 =item B<HeartBeat> I<Seconds>
7628 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7629 in which case the heartbeat is set to twice the B<StepSize> which should equal
7630 the interval in which data is collected. Do not set this option unless you have
7631 a very good reason to do so.
7633 =item B<RRARows> I<NumRows>
7635 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7636 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7637 three times five RRAs, i. e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7638 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7639 week, one month, and one year.
7641 So for each timespan, it calculates how many PDPs need to be consolidated into
7642 one CDP by calculating:
7643 number of PDPs = timespan / (stepsize * rrarows)
7645 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7648 =item B<RRATimespan> I<Seconds>
7650 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7651 more then one RRA. If this option is never used, the built-in default of (3600,
7652 86400, 604800, 2678400, 31622400) is used.
7654 For more information on how RRA-sizes are calculated see B<RRARows> above.
7656 =item B<XFF> I<Factor>
7658 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7659 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7662 =item B<CollectStatistics> B<false>|B<true>
7664 When set to B<true>, various statistics about the I<rrdcached> daemon will be
7665 collected, with "rrdcached" as the I<plugin name>. Defaults to B<false>.
7667 Statistics are read via I<rrdcached>s socket using the STATS command.
7668 See L<rrdcached(1)> for details.
7672 =head2 Plugin C<rrdtool>
7674 You can use the settings B<StepSize>, B<HeartBeat>, B<RRARows>, and B<XFF> to
7675 fine-tune your RRD-files. Please read L<rrdcreate(1)> if you encounter problems
7676 using these settings. If you don't want to dive into the depths of RRDtool, you
7677 can safely ignore these settings.
7681 =item B<DataDir> I<Directory>
7683 Set the directory to store RRD files under. By default RRD files are generated
7684 beneath the daemon's working directory, i.e. the B<BaseDir>.
7686 =item B<CreateFilesAsync> B<false>|B<true>
7688 When enabled, new RRD files are enabled asynchronously, using a separate thread
7689 that runs in the background. This prevents writes to block, which is a problem
7690 especially when many hundreds of files need to be created at once. However,
7691 since the purpose of creating the files asynchronously is I<not> to block until
7692 the file is available, values before the file is available will be discarded.
7693 When disabled (the default) files are created synchronously, blocking for a
7694 short while, while the file is being written.
7696 =item B<StepSize> I<Seconds>
7698 B<Force> the stepsize of newly created RRD-files. Ideally (and per default)
7699 this setting is unset and the stepsize is set to the interval in which the data
7700 is collected. Do not use this option unless you absolutely have to for some
7701 reason. Setting this option may cause problems with the C<snmp plugin>, the
7702 C<exec plugin> or when the daemon is set up to receive data from other hosts.
7704 =item B<HeartBeat> I<Seconds>
7706 B<Force> the heartbeat of newly created RRD-files. This setting should be unset
7707 in which case the heartbeat is set to twice the B<StepSize> which should equal
7708 the interval in which data is collected. Do not set this option unless you have
7709 a very good reason to do so.
7711 =item B<RRARows> I<NumRows>
7713 The C<rrdtool plugin> calculates the number of PDPs per CDP based on the
7714 B<StepSize>, this setting and a timespan. This plugin creates RRD-files with
7715 three times five RRAs, i.e. five RRAs with the CFs B<MIN>, B<AVERAGE>, and
7716 B<MAX>. The five RRAs are optimized for graphs covering one hour, one day, one
7717 week, one month, and one year.
7719 So for each timespan, it calculates how many PDPs need to be consolidated into
7720 one CDP by calculating:
7721 number of PDPs = timespan / (stepsize * rrarows)
7723 Bottom line is, set this no smaller than the width of you graphs in pixels. The
7726 =item B<RRATimespan> I<Seconds>
7728 Adds an RRA-timespan, given in seconds. Use this option multiple times to have
7729 more then one RRA. If this option is never used, the built-in default of (3600,
7730 86400, 604800, 2678400, 31622400) is used.
7732 For more information on how RRA-sizes are calculated see B<RRARows> above.
7734 =item B<XFF> I<Factor>
7736 Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option.
7737 I<Factor> must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and
7740 =item B<CacheFlush> I<Seconds>
7742 When the C<rrdtool> plugin uses a cache (by setting B<CacheTimeout>, see below)
7743 it writes all values for a certain RRD-file if the oldest value is older than
7744 (or equal to) the number of seconds specified by B<CacheTimeout>.
7745 That check happens on new values arriwal. If some RRD-file is not updated
7746 anymore for some reason (the computer was shut down, the network is broken,
7747 etc.) some values may still be in the cache. If B<CacheFlush> is set, then
7748 every I<Seconds> seconds the entire cache is searched for entries older than
7749 B<CacheTimeout> + B<RandomTimeout> seconds. The entries found are written to
7750 disk. Since scanning the entire cache is kind of expensive and does nothing
7751 under normal circumstances, this value should not be too small. 900 seconds
7752 might be a good value, though setting this to 7200 seconds doesn't normally
7753 do much harm either.
7755 Defaults to 10x B<CacheTimeout>.
7756 B<CacheFlush> must be larger than or equal to B<CacheTimeout>, otherwise the
7757 above default is used.
7759 =item B<CacheTimeout> I<Seconds>
7761 If this option is set to a value greater than zero, the C<rrdtool plugin> will
7762 save values in a cache, as described above. Writing multiple values at once
7763 reduces IO-operations and thus lessens the load produced by updating the files.
7764 The trade off is that the graphs kind of "drag behind" and that more memory is
7767 =item B<WritesPerSecond> I<Updates>
7769 When collecting many statistics with collectd and the C<rrdtool> plugin, you
7770 will run serious performance problems. The B<CacheFlush> setting and the
7771 internal update queue assert that collectd continues to work just fine even
7772 under heavy load, but the system may become very unresponsive and slow. This is
7773 a problem especially if you create graphs from the RRD files on the same
7774 machine, for example using the C<graph.cgi> script included in the
7775 C<contrib/collection3/> directory.
7777 This setting is designed for very large setups. Setting this option to a value
7778 between 25 and 80 updates per second, depending on your hardware, will leave
7779 the server responsive enough to draw graphs even while all the cached values
7780 are written to disk. Flushed values, i.E<nbsp>e. values that are forced to disk
7781 by the B<FLUSH> command, are B<not> effected by this limit. They are still
7782 written as fast as possible, so that web frontends have up to date data when
7785 For example: If you have 100,000 RRD files and set B<WritesPerSecond> to 30
7786 updates per second, writing all values to disk will take approximately
7787 56E<nbsp>minutes. Together with the flushing ability that's integrated into
7788 "collection3" you'll end up with a responsive and fast system, up to date
7789 graphs and basically a "backup" of your values every hour.
7791 =item B<RandomTimeout> I<Seconds>
7793 When set, the actual timeout for each value is chosen randomly between
7794 I<CacheTimeout>-I<RandomTimeout> and I<CacheTimeout>+I<RandomTimeout>. The
7795 intention is to avoid high load situations that appear when many values timeout
7796 at the same time. This is especially a problem shortly after the daemon starts,
7797 because all values were added to the internal cache at roughly the same time.
7801 =head2 Plugin C<sensors>
7803 The I<Sensors plugin> uses B<lm_sensors> to retrieve sensor-values. This means
7804 that all the needed modules have to be loaded and lm_sensors has to be
7805 configured (most likely by editing F</etc/sensors.conf>. Read
7806 L<sensors.conf(5)> for details.
7808 The B<lm_sensors> homepage can be found at
7809 L<http://secure.netroedge.com/~lm78/>.
7813 =item B<SensorConfigFile> I<File>
7815 Read the I<lm_sensors> configuration from I<File>. When unset (recommended),
7816 the library's default will be used.
7818 =item B<Sensor> I<chip-bus-address/type-feature>
7820 Selects the name of the sensor which you want to collect or ignore, depending
7821 on the B<IgnoreSelected> below. For example, the option "B<Sensor>
7822 I<it8712-isa-0290/voltage-in1>" will cause collectd to gather data for the
7823 voltage sensor I<in1> of the I<it8712> on the isa bus at the address 0290.
7825 See F</"IGNORELISTS"> for details.
7827 =item B<IgnoreSelected> I<true>|I<false>
7829 If no configuration if given, the B<sensors>-plugin will collect data from all
7830 sensors. This may not be practical, especially for uninteresting sensors.
7831 Thus, you can use the B<Sensor>-option to pick the sensors you're interested
7832 in. Sometimes, however, it's easier/preferred to collect all sensors I<except> a
7833 few ones. This option enables you to do that: By setting B<IgnoreSelected> to
7834 I<true> the effect of B<Sensor> is inverted: All selected sensors are ignored
7835 and all other sensors are collected.
7837 =item B<UseLabels> I<true>|I<false>
7839 Configures how sensor readings are reported. When set to I<true>, sensor
7840 readings are reported using their descriptive label (e.g. "VCore"). When set to
7841 I<false> (the default) the sensor name is used ("in0").
7845 =head2 Plugin C<sigrok>
7847 The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
7848 supported by the L<sigrok|http://sigrok.org/> project.
7854 <Device "AC Voltage">
7859 <Device "Sound Level">
7860 Driver "cem-dt-885x"
7867 =item B<LogLevel> B<0-5>
7869 The I<sigrok> logging level to pass on to the I<collectd> log, as a number
7870 between B<0> and B<5> (inclusive). These levels correspond to C<None>,
7871 C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
7872 The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
7873 their level, are always submitted to I<collectd> at its INFO log level.
7875 =item E<lt>B<Device> I<Name>E<gt>
7877 A sigrok-supported device, uniquely identified by this section's options. The
7878 I<Name> is passed to I<collectd> as the I<plugin instance>.
7880 =item B<Driver> I<DriverName>
7882 The sigrok driver to use for this device.
7884 =item B<Conn> I<ConnectionSpec>
7886 If the device cannot be auto-discovered, or more than one might be discovered
7887 by the driver, I<ConnectionSpec> specifies the connection string to the device.
7888 It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
7889 case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
7890 separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
7891 specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
7893 =item B<SerialComm> I<SerialSpec>
7895 For serial devices with non-standard port settings, this option can be used
7896 to specify them in a form understood by I<sigrok>, e.g.E<nbsp>C<9600/8n1>.
7897 This should not be necessary; drivers know how to communicate with devices they
7900 =item B<MinimumInterval> I<Seconds>
7902 Specifies the minimum time between measurement dispatches to I<collectd>, in
7903 seconds. Since some I<sigrok> supported devices can acquire measurements many
7904 times per second, it may be necessary to throttle these. For example, the
7905 I<RRD plugin> cannot process writes more than once per second.
7907 The default B<MinimumInterval> is B<0>, meaning measurements received from the
7908 device are always dispatched to I<collectd>. When throttled, unused
7909 measurements are discarded.
7913 =head2 Plugin C<smart>
7915 The C<smart> plugin collects SMART information from physical
7916 disks. Values collectd include temperature, power cycle count, poweron
7917 time and bad sectors. Also, all SMART attributes are collected along
7918 with the normalized current value, the worst value, the threshold and
7919 a human readable value.
7921 Using the following two options you can ignore some disks or configure the
7922 collection only of specific disks.
7926 =item B<Disk> I<Name>
7928 Select the disk I<Name>. Whether it is collected or ignored depends on the
7929 B<IgnoreSelected> setting, see below. As with other plugins that use the
7930 daemon's ignorelist functionality, a string that starts and ends with a slash
7931 is interpreted as a regular expression. Examples:
7936 See F</"IGNORELISTS"> for details.
7938 =item B<IgnoreSelected> B<true>|B<false>
7940 Sets whether selected disks, i.E<nbsp>e. the ones matches by any of the B<Disk>
7941 statements, are ignored or if all other disks are ignored. The behavior
7942 (hopefully) is intuitive: If no B<Disk> option is configured, all disks are
7943 collected. If at least one B<Disk> option is given and no B<IgnoreSelected> or
7944 set to B<false>, B<only> matching disks will be collected. If B<IgnoreSelected>
7945 is set to B<true>, all disks are collected B<except> the ones matched.
7947 =item B<IgnoreSleepMode> B<true>|B<false>
7949 Normally, the C<smart> plugin will ignore disks that are reported to be asleep.
7950 This option disables the sleep mode check and allows the plugin to collect data
7951 from these disks anyway. This is useful in cases where libatasmart mistakenly
7952 reports disks as asleep because it has not been updated to incorporate support
7953 for newer idle states in the ATA spec.
7955 =item B<UseSerial> B<true>|B<false>
7957 A disk's kernel name (e.g., sda) can change from one boot to the next. If this
7958 option is enabled, the C<smart> plugin will use the disk's serial number (e.g.,
7959 HGST_HUH728080ALE600_2EJ8VH8X) instead of the kernel name as the key for
7960 storing data. This ensures that the data for a given disk will be kept together
7961 even if the kernel name changes.
7965 =head2 Plugin C<snmp>
7967 Since the configuration of the C<snmp plugin> is a little more complicated than
7968 other plugins, its documentation has been moved to an own manpage,
7969 L<collectd-snmp(5)>. Please see there for details.
7971 =head2 Plugin C<snmp_agent>
7973 The I<snmp_agent> plugin is an AgentX subagent that receives and handles queries
7974 from SNMP master agent and returns the data collected by read plugins.
7975 The I<snmp_agent> plugin handles requests only for OIDs specified in
7976 configuration file. To handle SNMP queries the plugin gets data from collectd
7977 and translates requested values from collectd's internal format to SNMP format.
7978 This plugin is a generic plugin and cannot work without configuration.
7979 For more details on AgentX subagent see
7980 <http://www.net-snmp.org/tutorial/tutorial-5/toolkit/demon/>
7985 <Data "memAvailReal">
7987 #PluginInstance "some"
7990 OIDs "1.3.6.1.4.1.2021.4.6.0"
7993 IndexOID "IF-MIB::ifIndex"
7994 SizeOID "IF-MIB::ifNumber"
7997 Source "PluginInstance"
8000 OIDs "IF-MIB::ifDescr"
8006 OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets"
8009 <Table "CPUAffinityTable">
8012 Source "PluginInstance"
8015 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhAffinityDomainName"
8020 Source "TypeInstance"
8021 Regex "^vcpu_([0-9]{1,3})-cpu_[0-9]{1,3}$"
8024 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhVCPUIndex"
8029 Source "TypeInstance"
8030 Regex "^vcpu_[0-9]{1,3}-cpu_([0-9]{1,3})$"
8033 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUIndex"
8035 <Data "CPUAffinity">
8038 OIDs "LIBVIRT-HYPERVISOR-MIB::lvhCPUAffinity"
8043 There are two types of blocks that can be contained in the
8044 C<E<lt>PluginE<nbsp> snmp_agentE<gt>> block: B<Data> and B<Table>:
8046 =head3 B<Data> block
8048 The B<Data> block defines a list OIDs that are to be handled. This block can
8049 define scalar or table OIDs. If B<Data> block is defined inside of B<Table>
8050 block it reperesents table OIDs.
8051 The following options can be set:
8055 =item B<IndexKey> block
8057 B<IndexKey> block contains all data needed for proper index build of snmp table.
8059 one table B<Data> block has B<IndexKey> block present then multiple key index is
8060 built. If B<Data> block defines scalar data type B<IndexKey> has no effect and can
8065 =item B<Source> I<String>
8067 B<Source> can be set to one of the following values: "Hostname", "Plugin",
8068 "PluginInstance", "Type", "TypeInstance". This value indicates which field of
8069 corresponding collectd metric is taken as a SNMP table index.
8071 =item B<Regex> I<String>
8073 B<Regex> option can also be used to parse strings or numbers out of
8074 specific field. For example: type-instance field which is "vcpu1-cpu2" can be
8075 parsed into two numeric fields CPU = 2 and VCPU = 1 and can be later used
8078 =item B<Group> I<Number>
8080 B<Group> number can be specified in case groups are used in regex.
8084 =item B<Plugin> I<String>
8086 Read plugin name whose collected data will be mapped to specified OIDs.
8088 =item B<PluginInstance> I<String>
8090 Read plugin instance whose collected data will be mapped to specified OIDs.
8091 The field is optional and by default there is no plugin instance check.
8092 Allowed only if B<Data> block defines scalar data type.
8094 =item B<Type> I<String>
8096 Collectd's type that is to be used for specified OID, e.E<nbsp>g. "if_octets"
8097 for example. The types are read from the B<TypesDB> (see L<collectd.conf(5)>).
8099 =item B<TypeInstance> I<String>
8101 Collectd's type-instance that is to be used for specified OID.
8103 =item B<OIDs> I<OID> [I<OID> ...]
8105 Configures the OIDs to be handled by I<snmp_agent> plugin. Values for these OIDs
8106 are taken from collectd data type specified by B<Plugin>, B<PluginInstance>,
8107 B<Type>, B<TypeInstance> fields of this B<Data> block. Number of the OIDs
8108 configured should correspond to number of values in specified B<Type>.
8109 For example two OIDs "IF-MIB::ifInOctets" "IF-MIB::ifOutOctets" can be mapped to
8110 "rx" and "tx" values of "if_octets" type.
8112 =item B<Scale> I<Value>
8114 The values taken from collectd are multiplied by I<Value>. The field is optional
8115 and the default is B<1.0>.
8117 =item B<Shift> I<Value>
8119 I<Value> is added to values from collectd after they have been multiplied by
8120 B<Scale> value. The field is optional and the default value is B<0.0>.
8124 =head3 The B<Table> block
8126 The B<Table> block defines a collection of B<Data> blocks that belong to one
8127 snmp table. In addition to multiple B<Data> blocks the following options can be
8132 =item B<IndexOID> I<OID>
8134 OID that is handled by the plugin and is mapped to numerical index value that is
8135 generated by the plugin for each table record.
8137 =item B<SizeOID> I<OID>
8139 OID that is handled by the plugin. Returned value is the number of records in
8140 the table. The field is optional.
8144 =head2 Plugin C<statsd>
8146 The I<statsd plugin> listens to a UDP socket, reads "events" in the statsd
8147 protocol and dispatches rates or other aggregates of these numbers
8150 The plugin implements the I<Counter>, I<Timer>, I<Gauge> and I<Set> types which
8151 are dispatched as the I<collectd> types C<derive>, C<latency>, C<gauge> and
8152 C<objects> respectively.
8154 The following configuration options are valid:
8158 =item B<Host> I<Host>
8160 Bind to the hostname / address I<Host>. By default, the plugin will bind to the
8161 "any" address, i.e. accept packets sent to any of the hosts addresses.
8163 =item B<Port> I<Port>
8165 UDP port to listen to. This can be either a service name or a port number.
8166 Defaults to C<8125>.
8168 =item B<DeleteCounters> B<false>|B<true>
8170 =item B<DeleteTimers> B<false>|B<true>
8172 =item B<DeleteGauges> B<false>|B<true>
8174 =item B<DeleteSets> B<false>|B<true>
8176 These options control what happens if metrics are not updated in an interval.
8177 If set to B<False>, the default, metrics are dispatched unchanged, i.e. the
8178 rate of counters and size of sets will be zero, timers report C<NaN> and gauges
8179 are unchanged. If set to B<True>, the such metrics are not dispatched and
8180 removed from the internal cache.
8182 =item B<CounterSum> B<false>|B<true>
8184 When enabled, creates a C<count> metric which reports the change since the last
8185 read. This option primarily exists for compatibility with the I<statsd>
8186 implementation by Etsy.
8188 =item B<TimerPercentile> I<Percent>
8190 Calculate and dispatch the configured percentile, i.e. compute the latency, so
8191 that I<Percent> of all reported timers are smaller than or equal to the
8192 computed latency. This is useful for cutting off the long tail latency, as it's
8193 often done in I<Service Level Agreements> (SLAs).
8195 Different percentiles can be calculated by setting this option several times.
8196 If none are specified, no percentiles are calculated / dispatched.
8198 =item B<TimerLower> B<false>|B<true>
8200 =item B<TimerUpper> B<false>|B<true>
8202 =item B<TimerSum> B<false>|B<true>
8204 =item B<TimerCount> B<false>|B<true>
8206 Calculate and dispatch various values out of I<Timer> metrics received during
8207 an interval. If set to B<False>, the default, these values aren't calculated /
8210 Please note what reported timer values less than 0.001 are ignored in all B<Timer*> reports.
8214 =head2 Plugin C<swap>
8216 The I<Swap plugin> collects information about used and available swap space. On
8217 I<Linux> and I<Solaris>, the following options are available:
8221 =item B<ReportByDevice> B<false>|B<true>
8223 Configures how to report physical swap devices. If set to B<false> (the
8224 default), the summary over all swap devices is reported only, i.e. the globally
8225 used and available space over all devices. If B<true> is configured, the used
8226 and available space of each device will be reported separately.
8228 This option is only available if the I<Swap plugin> can read C</proc/swaps>
8229 (under Linux) or use the L<swapctl(2)> mechanism (under I<Solaris>).
8231 =item B<ReportBytes> B<false>|B<true>
8233 When enabled, the I<swap I/O> is reported in bytes. When disabled, the default,
8234 I<swap I/O> is reported in pages. This option is available under Linux only.
8236 =item B<ValuesAbsolute> B<true>|B<false>
8238 Enables or disables reporting of absolute swap metrics, i.e. number of I<bytes>
8239 available and used. Defaults to B<true>.
8241 =item B<ValuesPercentage> B<false>|B<true>
8243 Enables or disables reporting of relative swap metrics, i.e. I<percent>
8244 available and free. Defaults to B<false>.
8246 This is useful for deploying I<collectd> in a heterogeneous environment, where
8247 swap sizes differ and you want to specify generic thresholds or similar.
8249 =item B<ReportIO> B<true>|B<false>
8251 Enables or disables reporting swap IO. Defaults to B<true>.
8253 This is useful for the cases when swap IO is not neccessary, is not available,
8258 =head2 Plugin C<syslog>
8262 =item B<LogLevel> B<debug|info|notice|warning|err>
8264 Sets the log-level. If, for example, set to B<notice>, then all events with
8265 severity B<notice>, B<warning>, or B<err> will be submitted to the
8268 Please note that B<debug> is only available if collectd has been compiled with
8271 =item B<NotifyLevel> B<OKAY>|B<WARNING>|B<FAILURE>
8273 Controls which notifications should be sent to syslog. The default behaviour is
8274 not to send any. Less severe notifications always imply logging more severe
8275 notifications: Setting this to B<OKAY> means all notifications will be sent to
8276 syslog, setting this to B<WARNING> will send B<WARNING> and B<FAILURE>
8277 notifications but will dismiss B<OKAY> notifications. Setting this option to
8278 B<FAILURE> will only send failures to syslog.
8282 =head2 Plugin C<table>
8284 The C<table plugin> provides generic means to parse tabular data and dispatch
8285 user specified values. Values are selected based on column numbers. For
8286 example, this plugin may be used to get values from the Linux L<proc(5)>
8287 filesystem or CSV (comma separated values) files.
8290 <Table "/proc/slabinfo">
8296 InstancePrefix "active_objs"
8302 InstancePrefix "objperslab"
8309 The configuration consists of one or more B<Table> blocks, each of which
8310 configures one file to parse. Within each B<Table> block, there are one or
8311 more B<Result> blocks, which configure which data to select and how to
8314 The following options are available inside a B<Table> block:
8318 =item B<Plugin> I<Plugin>
8320 If specified, I<Plugin> is used as the plugin name when submitting values.
8321 Defaults to B<table>.
8323 =item B<Instance> I<instance>
8325 If specified, I<instance> is used as the plugin instance. If omitted, the
8326 filename of the table is used instead, with all special characters replaced
8327 with an underscore (C<_>).
8329 =item B<Separator> I<string>
8331 Any character of I<string> is interpreted as a delimiter between the different
8332 columns of the table. A sequence of two or more contiguous delimiters in the
8333 table is considered to be a single delimiter, i.E<nbsp>e. there cannot be any
8334 empty columns. The plugin uses the L<strtok_r(3)> function to parse the lines
8335 of a table - see its documentation for more details. This option is mandatory.
8337 A horizontal tab, newline and carriage return may be specified by C<\\t>,
8338 C<\\n> and C<\\r> respectively. Please note that the double backslashes are
8339 required because of collectd's config parsing.
8343 The following options are available inside a B<Result> block:
8347 =item B<Type> I<type>
8349 Sets the type used to dispatch the values to the daemon. Detailed information
8350 about types and their configuration can be found in L<types.db(5)>. This
8351 option is mandatory.
8353 =item B<InstancePrefix> I<prefix>
8355 If specified, prepend I<prefix> to the type instance. If omitted, only the
8356 B<InstancesFrom> option is considered for the type instance.
8358 =item B<InstancesFrom> I<column0> [I<column1> ...]
8360 If specified, the content of the given columns (identified by the column
8361 number starting at zero) will be used to create the type instance for each
8362 row. Multiple values (and the instance prefix) will be joined together with
8363 dashes (I<->) as separation character. If omitted, only the B<InstancePrefix>
8364 option is considered for the type instance.
8366 The plugin itself does not check whether or not all built instances are
8367 different. It’s your responsibility to assure that each is unique. This is
8368 especially true, if you do not specify B<InstancesFrom>: B<You> have to make
8369 sure that the table only contains one row.
8371 If neither B<InstancePrefix> nor B<InstancesFrom> is given, the type instance
8374 =item B<ValuesFrom> I<column0> [I<column1> ...]
8376 Specifies the columns (identified by the column numbers starting at zero)
8377 whose content is used as the actual data for the data sets that are dispatched
8378 to the daemon. How many such columns you need is determined by the B<Type>
8379 setting above. If you specify too many or not enough columns, the plugin will
8380 complain about that and no data will be submitted to the daemon. The plugin
8381 uses L<strtoll(3)> and L<strtod(3)> to parse counter and gauge values
8382 respectively, so anything supported by those functions is supported by the
8383 plugin as well. This option is mandatory.
8387 =head2 Plugin C<tail>
8389 The C<tail plugin> follows logfiles, just like L<tail(1)> does, parses
8390 each line and dispatches found values. What is matched can be configured by the
8391 user using (extended) regular expressions, as described in L<regex(7)>.
8394 <File "/var/log/exim4/mainlog">
8399 Regex "S=([1-9][0-9]*)"
8405 Regex "\\<R=local_user\\>"
8406 ExcludeRegex "\\<R=local_user\\>.*mail_spool defer"
8409 Instance "local_user"
8412 Regex "l=([0-9]*\\.[0-9]*)"
8413 <DSType "Distribution">
8416 #BucketType "bucket"
8424 The config consists of one or more B<File> blocks, each of which configures one
8425 logfile to parse. Within each B<File> block, there are one or more B<Match>
8426 blocks, which configure a regular expression to search for.
8428 The B<Plugin> and B<Instance> options in the B<File> block may be used to set
8429 the plugin name and instance respectively. So in the above example the plugin name
8430 C<mail-exim> would be used.
8432 These options are applied for all B<Match> blocks that B<follow> it, until the
8433 next B<Plugin> or B<Instance> option. This way you can extract several plugin
8434 instances from one logfile, handy when parsing syslog and the like.
8436 The B<Interval> option allows you to define the length of time between reads. If
8437 this is not set, the default Interval will be used.
8439 Each B<Match> block has the following options to describe how the match should
8444 =item B<Regex> I<regex>
8446 Sets the regular expression to use for matching against a line. The first
8447 subexpression has to match something that can be turned into a number by
8448 L<strtoll(3)> or L<strtod(3)>, depending on the value of C<CounterAdd>, see
8449 below. Because B<extended> regular expressions are used, you do not need to use
8450 backslashes for subexpressions! If in doubt, please consult L<regex(7)>. Due to
8451 collectd's config parsing you need to escape backslashes, though. So if you
8452 want to match literal parentheses you need to do the following:
8454 Regex "SPAM \\(Score: (-?[0-9]+\\.[0-9]+)\\)"
8456 =item B<ExcludeRegex> I<regex>
8458 Sets an optional regular expression to use for excluding lines from the match.
8459 An example which excludes all connections from localhost from the match:
8461 ExcludeRegex "127\\.0\\.0\\.1"
8463 =item B<DSType> I<Type>
8465 Sets how the values are cumulated. I<Type> is one of:
8469 =item B<GaugeAverage>
8471 Calculate the average.
8475 Use the smallest number only.
8479 Use the greatest number only.
8483 Use the last number found.
8485 =item B<GaugePersist>
8487 Use the last number found. The number is not reset at the end of an interval.
8488 It is continously reported until another number is matched. This is intended
8489 for cases in which only state changes are reported, for example a thermometer
8490 that only reports the temperature when it changes.
8496 =item B<AbsoluteSet>
8498 The matched number is a counter. Simply I<sets> the internal counter to this
8499 value. Variants exist for C<COUNTER>, C<DERIVE>, and C<ABSOLUTE> data sources.
8507 Add the matched value to the internal counter. In case of B<DeriveAdd>, the
8508 matched number may be negative, which will effectively subtract from the
8517 Increase the internal counter by one. These B<DSType> are the only ones that do
8518 not use the matched subexpression, but simply count the number of matched
8519 lines. Thus, you may use a regular expression without submatch in this case.
8521 =item B<Distribution>
8523 Type to do calculations based on the distribution of values, primarily
8524 calculating percentiles. This is primarily geared towards latency, but can be
8525 used for other metrics as well. The range of values tracked with this setting
8526 must be in the range (0–2^34) and can be fractional. Please note that neither
8527 zero nor 2^34 are inclusive bounds, i.e. zero I<cannot> be handled by a
8530 This option must be used together with the B<Percentile> and/or B<Bucket>
8535 <DSType "Distribution">
8543 =item B<Percentile> I<Percent>
8545 Calculate and dispatch the configured percentile, i.e. compute the value, so
8546 that I<Percent> of all matched values are smaller than or equal to the computed
8549 Metrics are reported with the I<type> B<Type> (the value of the above option)
8550 and the I<type instance> C<[E<lt>InstanceE<gt>-]E<lt>PercentE<gt>>.
8552 This option may be repeated to calculate more than one percentile.
8554 =item B<Bucket> I<lower_bound> I<upper_bound>
8556 Export the number of values (a C<DERIVE>) falling within the given range. Both,
8557 I<lower_bound> and I<upper_bound> may be a fractional number, such as B<0.5>.
8558 Each B<Bucket> option specifies an interval C<(I<lower_bound>,
8559 I<upper_bound>]>, i.e. the range I<excludes> the lower bound and I<includes>
8560 the upper bound. I<lower_bound> and I<upper_bound> may be zero, meaning no
8563 To export the entire (0–inf) range without overlap, use the upper bound of the
8564 previous range as the lower bound of the following range. In other words, use
8565 the following schema:
8575 Metrics are reported with the I<type> set by B<BucketType> option (C<bucket>
8576 by default) and the I<type instance>
8577 C<E<lt>TypeE<gt>[-E<lt>InstanceE<gt>]-E<lt>lower_boundE<gt>_E<lt>upper_boundE<gt>>.
8579 This option may be repeated to calculate more than one rate.
8581 =item B<BucketType> I<Type>
8583 Sets the type used to dispatch B<Bucket> metrics.
8584 Optional, by default C<bucket> will be used.
8590 The B<Gauge*> and B<Distribution> types interpret the submatch as a floating
8591 point number, using L<strtod(3)>. The B<Counter*> and B<AbsoluteSet> types
8592 interpret the submatch as an unsigned integer using L<strtoull(3)>. The
8593 B<Derive*> types interpret the submatch as a signed integer using
8594 L<strtoll(3)>. B<CounterInc> and B<DeriveInc> do not use the submatch at all
8595 and it may be omitted in this case.
8597 =item B<Type> I<Type>
8599 Sets the type used to dispatch this value. Detailed information about types and
8600 their configuration can be found in L<types.db(5)>.
8602 =item B<Instance> I<TypeInstance>
8604 This optional setting sets the type instance to use.
8608 =head2 Plugin C<tail_csv>
8610 The I<tail_csv plugin> reads files in the CSV format, e.g. the statistics file
8611 written by I<Snort>.
8616 <Metric "snort-dropped">
8621 <File "/var/log/snort/snort.stats">
8625 Collect "snort-dropped"
8630 The configuration consists of one or more B<Metric> blocks that define an index
8631 into the line of the CSV file and how this value is mapped to I<collectd's>
8632 internal representation. These are followed by one or more B<Instance> blocks
8633 which configure which file to read, in which interval and which metrics to
8638 =item E<lt>B<Metric> I<Name>E<gt>
8640 The B<Metric> block configures a new metric to be extracted from the statistics
8641 file and how it is mapped on I<collectd's> data model. The string I<Name> is
8642 only used inside the B<Instance> blocks to refer to this block, so you can use
8643 one B<Metric> block for multiple CSV files.
8647 =item B<Type> I<Type>
8649 Configures which I<Type> to use when dispatching this metric. Types are defined
8650 in the L<types.db(5)> file, see the appropriate manual page for more
8651 information on specifying types. Only types with a single I<data source> are
8652 supported by the I<tail_csv plugin>. The information whether the value is an
8653 absolute value (i.e. a C<GAUGE>) or a rate (i.e. a C<DERIVE>) is taken from the
8654 I<Type's> definition.
8656 =item B<Instance> I<TypeInstance>
8658 If set, I<TypeInstance> is used to populate the type instance field of the
8659 created value lists. Otherwise, no type instance is used.
8661 =item B<ValueFrom> I<Index>
8663 Configure to read the value from the field with the zero-based index I<Index>.
8664 If the value is parsed as signed integer, unsigned integer or double depends on
8665 the B<Type> setting, see above.
8669 =item E<lt>B<File> I<Path>E<gt>
8671 Each B<File> block represents one CSV file to read. There must be at least one
8672 I<File> block but there can be multiple if you have multiple CSV files.
8676 =item B<Plugin> I<Plugin>
8678 Use I<Plugin> as the plugin name when submitting values.
8679 Defaults to C<tail_csv>.
8681 =item B<Instance> I<PluginInstance>
8683 Sets the I<plugin instance> used when dispatching the values.
8685 =item B<Collect> I<Metric>
8687 Specifies which I<Metric> to collect. This option must be specified at least
8688 once, and you can use this option multiple times to specify more than one
8689 metric to be extracted from this statistic file.
8691 =item B<Interval> I<Seconds>
8693 Configures the interval in which to read values from this instance / file.
8694 Defaults to the plugin's default interval.
8696 =item B<TimeFrom> I<Index>
8698 Rather than using the local time when dispatching a value, read the timestamp
8699 from the field with the zero-based index I<Index>. The value is interpreted as
8700 seconds since epoch. The value is parsed as a double and may be factional.
8706 =head2 Plugin C<teamspeak2>
8708 The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
8709 polls interesting global and virtual server data. The plugin can query only one
8710 physical server but unlimited virtual servers. You can use the following
8711 options to configure it:
8715 =item B<Host> I<hostname/ip>
8717 The hostname or ip which identifies the physical server.
8720 =item B<Port> I<port>
8722 The query port of the physical server. This needs to be a string.
8725 =item B<Server> I<port>
8727 This option has to be added once for every virtual server the plugin should
8728 query. If you want to query the virtual server on port 8767 this is what the
8729 option would look like:
8733 This option, although numeric, needs to be a string, i.E<nbsp>e. you B<must>
8734 use quotes around it! If no such statement is given only global information
8739 =head2 Plugin C<ted>
8741 The I<TED> plugin connects to a device of "The Energy Detective", a device to
8742 measure power consumption. These devices are usually connected to a serial
8743 (RS232) or USB port. The plugin opens a configured device and tries to read the
8744 current energy readings. For more information on TED, visit
8745 L<http://www.theenergydetective.com/>.
8747 Available configuration options:
8751 =item B<Device> I<Path>
8753 Path to the device on which TED is connected. collectd will need read and write
8754 permissions on that file.
8756 Default: B</dev/ttyUSB0>
8758 =item B<Retries> I<Num>
8760 Apparently reading from TED is not that reliable. You can therefore configure a
8761 number of retries here. You only configure the I<retries> here, to if you
8762 specify zero, one reading will be performed (but no retries if that fails); if
8763 you specify three, a maximum of four readings are performed. Negative values
8770 =head2 Plugin C<tcpconns>
8772 The C<tcpconns plugin> counts the number of currently established TCP
8773 connections based on the local port and/or the remote port. Since there may be
8774 a lot of connections the default if to count all connections with a local port,
8775 for which a listening socket is opened. You can use the following options to
8776 fine-tune the ports you are interested in:
8780 =item B<ListeningPorts> I<true>|I<false>
8782 If this option is set to I<true>, statistics for all local ports for which a
8783 listening socket exists are collected. The default depends on B<LocalPort> and
8784 B<RemotePort> (see below): If no port at all is specifically selected, the
8785 default is to collect listening ports. If specific ports (no matter if local or
8786 remote ports) are selected, this option defaults to I<false>, i.E<nbsp>e. only
8787 the selected ports will be collected unless this option is set to I<true>
8790 =item B<LocalPort> I<Port>
8792 Count the connections to a specific local port. This can be used to see how
8793 many connections are handled by a specific daemon, e.E<nbsp>g. the mailserver.
8794 You have to specify the port in numeric form, so for the mailserver example
8795 you'd need to set B<25>.
8797 =item B<RemotePort> I<Port>
8799 Count the connections to a specific remote port. This is useful to see how
8800 much a remote service is used. This is most useful if you want to know how many
8801 connections a local service has opened to remote services, e.E<nbsp>g. how many
8802 connections a mail server or news server has to other mail or news servers, or
8803 how many connections a web proxy holds to web servers. You have to give the
8804 port in numeric form.
8806 =item B<AllPortsSummary> I<true>|I<false>
8808 If this option is set to I<true> a summary of statistics from all connections
8809 are collected. This option defaults to I<false>.
8813 =head2 Plugin C<thermal>
8817 =item B<ForceUseProcfs> I<true>|I<false>
8819 By default, the I<Thermal plugin> tries to read the statistics from the Linux
8820 C<sysfs> interface. If that is not available, the plugin falls back to the
8821 C<procfs> interface. By setting this option to I<true>, you can force the
8822 plugin to use the latter. This option defaults to I<false>.
8824 =item B<Device> I<Device>
8826 Selects the name of the thermal device that you want to collect or ignore,
8827 depending on the value of the B<IgnoreSelected> option. This option may be
8828 used multiple times to specify a list of devices.
8830 See F</"IGNORELISTS"> for details.
8832 =item B<IgnoreSelected> I<true>|I<false>
8834 Invert the selection: If set to true, all devices B<except> the ones that
8835 match the device names specified by the B<Device> option are collected. By
8836 default only selected devices are collected if a selection is made. If no
8837 selection is configured at all, B<all> devices are selected.
8841 =head2 Plugin C<threshold>
8843 The I<Threshold plugin> checks values collected or received by I<collectd>
8844 against a configurable I<threshold> and issues I<notifications> if values are
8847 Documentation for this plugin is available in the L<collectd-threshold(5)>
8850 =head2 Plugin C<tokyotyrant>
8852 The I<TokyoTyrant plugin> connects to a TokyoTyrant server and collects a
8853 couple metrics: number of records, and database size on disk.
8857 =item B<Host> I<Hostname/IP>
8859 The hostname or IP which identifies the server.
8860 Default: B<127.0.0.1>
8862 =item B<Port> I<Service/Port>
8864 The query port of the server. This needs to be a string, even if the port is
8865 given in its numeric form.
8870 =head2 Plugin C<turbostat>
8872 The I<Turbostat plugin> reads CPU frequency and C-state residency on modern
8873 Intel processors by using I<Model Specific Registers>.
8877 =item B<CoreCstates> I<Bitmask(Integer)>
8879 Bit mask of the list of core C-states supported by the processor.
8880 This option should only be used if the automated detection fails.
8881 Default value extracted from the CPU model and family.
8883 Currently supported C-states (by this plugin): 3, 6, 7
8887 All states (3, 6 and 7):
8888 (1<<3) + (1<<6) + (1<<7) = 392
8890 =item B<PackageCstates> I<Bitmask(Integer)>
8892 Bit mask of the list of packages C-states supported by the processor. This
8893 option should only be used if the automated detection fails. Default value
8894 extracted from the CPU model and family.
8896 Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10
8900 States 2, 3, 6 and 7:
8901 (1<<2) + (1<<3) + (1<<6) + (1<<7) = 396
8903 =item B<SystemManagementInterrupt> I<true>|I<false>
8905 Boolean enabling the collection of the I/O System-Management Interrupt counter.
8906 This option should only be used if the automated detection fails or if you want
8907 to disable this feature.
8909 =item B<DigitalTemperatureSensor> I<true>|I<false>
8911 Boolean enabling the collection of the temperature of each core. This option
8912 should only be used if the automated detection fails or if you want to disable
8915 =item B<TCCActivationTemp> I<Temperature>
8917 I<Thermal Control Circuit Activation Temperature> of the installed CPU. This
8918 temperature is used when collecting the temperature of cores or packages. This
8919 option should only be used if the automated detection fails. Default value
8920 extracted from B<MSR_IA32_TEMPERATURE_TARGET>.
8922 =item B<RunningAveragePowerLimit> I<Bitmask(Integer)>
8924 Bit mask of the list of elements to be thermally monitored. This option should
8925 only be used if the automated detection fails or if you want to disable some
8926 collections. The different bits of this bit mask accepted by this plugin are:
8930 =item 0 ('1'): Package
8934 =item 2 ('4'): Cores
8936 =item 3 ('8'): Embedded graphic device
8940 =item B<LogicalCoreNames> I<true>|I<false>
8942 Boolean enabling the use of logical core numbering for per core statistics.
8943 When enabled, C<cpuE<lt>nE<gt>> is used as plugin instance, where I<n> is a
8944 dynamic number assigned by the kernel. Otherwise, C<coreE<lt>nE<gt>> is used
8945 if there is only one package and C<pkgE<lt>nE<gt>-coreE<lt>mE<gt>> if there is
8946 more than one, where I<n> is the n-th core of package I<m>.
8950 =head2 Plugin C<unixsock>
8954 =item B<SocketFile> I<Path>
8956 Sets the socket-file which is to be created.
8958 =item B<SocketGroup> I<Group>
8960 If running as root change the group of the UNIX-socket after it has been
8961 created. Defaults to B<collectd>.
8963 =item B<SocketPerms> I<Permissions>
8965 Change the file permissions of the UNIX-socket after it has been created. The
8966 permissions must be given as a numeric, octal value as you would pass to
8967 L<chmod(1)>. Defaults to B<0770>.
8969 =item B<DeleteSocket> B<false>|B<true>
8971 If set to B<true>, delete the socket file before calling L<bind(2)>, if a file
8972 with the given name already exists. If I<collectd> crashes a socket file may be
8973 left over, preventing the daemon from opening a new socket when restarted.
8974 Since this is potentially dangerous, this defaults to B<false>.
8978 =head2 Plugin C<uuid>
8980 This plugin, if loaded, causes the Hostname to be taken from the machine's
8981 UUID. The UUID is a universally unique designation for the machine, usually
8982 taken from the machine's BIOS. This is most useful if the machine is running in
8983 a virtual environment such as Xen, in which case the UUID is preserved across
8984 shutdowns and migration.
8986 The following methods are used to find the machine's UUID, in order:
8992 Check I</etc/uuid> (or I<UUIDFile>).
8996 Check for UUID from HAL (L<http://www.freedesktop.org/wiki/Software/hal>) if
9001 Check for UUID from C<dmidecode> / SMBIOS.
9005 Check for UUID from Xen hypervisor.
9009 If no UUID can be found then the hostname is not modified.
9013 =item B<UUIDFile> I<Path>
9015 Take the UUID from the given file (default I</etc/uuid>).
9019 =head2 Plugin C<varnish>
9021 The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
9022 It collects a subset of the values displayed by L<varnishstat(1)>, and
9023 organizes them in categories which can be enabled or disabled. Currently only
9024 metrics shown in L<varnishstat(1)>'s I<MAIN> section are collected. The exact
9025 meaning of each metric can be found in L<varnish-counters(7)>.
9030 <Instance "example">
9034 CollectConnections true
9035 CollectDirectorDNS false
9039 CollectObjects false
9041 CollectSession false
9051 CollectWorkers false
9053 CollectMempool false
9054 CollectManagement false
9061 The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
9062 blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
9063 will collectd statistics from the default "varnishd" instance (this should work
9064 fine in most cases).
9066 Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
9070 =item B<CollectBackend> B<true>|B<false>
9072 Back-end connection statistics, such as successful, reused,
9073 and closed connections. True by default.
9075 =item B<CollectBan> B<true>|B<false>
9077 Statistics about ban operations, such as number of bans added, retired, and
9078 number of objects tested against ban operations. Only available with Varnish
9079 3.x and above. False by default.
9081 =item B<CollectCache> B<true>|B<false>
9083 Cache hits and misses. True by default.
9085 =item B<CollectConnections> B<true>|B<false>
9087 Number of client connections received, accepted and dropped. True by default.
9089 =item B<CollectDirectorDNS> B<true>|B<false>
9091 DNS director lookup cache statistics. Only available with Varnish 3.x. False by
9094 =item B<CollectESI> B<true>|B<false>
9096 Edge Side Includes (ESI) parse statistics. False by default.
9098 =item B<CollectFetch> B<true>|B<false>
9100 Statistics about fetches (HTTP requests sent to the backend). False by default.
9102 =item B<CollectHCB> B<true>|B<false>
9104 Inserts and look-ups in the crit bit tree based hash. Look-ups are
9105 divided into locked and unlocked look-ups. False by default.
9107 =item B<CollectObjects> B<true>|B<false>
9109 Statistics on cached objects: number of objects expired, nuked (prematurely
9110 expired), saved, moved, etc. False by default.
9112 =item B<CollectPurge> B<true>|B<false>
9114 Statistics about purge operations, such as number of purges added, retired, and
9115 number of objects tested against purge operations. Only available with Varnish
9116 2.x. False by default.
9118 =item B<CollectSession> B<true>|B<false>
9120 Client session statistics. Number of past and current sessions, session herd and
9121 linger counters, etc. False by default. Note that if using Varnish 4.x, some
9122 metrics found in the Connections and Threads sections with previous versions of
9123 Varnish have been moved here.
9125 =item B<CollectSHM> B<true>|B<false>
9127 Statistics about the shared memory log, a memory region to store
9128 log messages which is flushed to disk when full. True by default.
9130 =item B<CollectSMA> B<true>|B<false>
9132 malloc or umem (umem_alloc(3MALLOC) based) storage statistics. The umem storage
9133 component is Solaris specific. Note: SMA, SMF and MSE share counters, enable
9134 only the one used by the Varnish instance. Only available with Varnish 2.x.
9137 =item B<CollectSMS> B<true>|B<false>
9139 synth (synthetic content) storage statistics. This storage
9140 component is used internally only. False by default.
9142 =item B<CollectSM> B<true>|B<false>
9144 file (memory mapped file) storage statistics. Only available with Varnish 2.x.,
9145 in varnish 4.x. use CollectSMF.
9148 =item B<CollectStruct> B<true>|B<false>
9150 Current varnish internal state statistics. Number of current sessions, objects
9151 in cache store, open connections to backends (with Varnish 2.x), etc. False by
9154 =item B<CollectTotals> B<true>|B<false>
9156 Collects overview counters, such as the number of sessions created,
9157 the number of requests and bytes transferred. False by default.
9159 =item B<CollectUptime> B<true>|B<false>
9161 Varnish uptime. Only available with Varnish 3.x and above. False by default.
9163 =item B<CollectVCL> B<true>|B<false>
9165 Number of total (available + discarded) VCL (config files). False by default.
9167 =item B<CollectVSM> B<true>|B<false>
9169 Collect statistics about Varnish's shared memory usage (used by the logging and
9170 statistics subsystems). Only available with Varnish 4.x. False by default.
9172 =item B<CollectWorkers> B<true>|B<false>
9174 Collect statistics about worker threads. False by default.
9176 =item B<CollectVBE> B<true>|B<false>
9178 Backend counters. Only available with Varnish 4.x. False by default.
9180 =item B<CollectSMF> B<true>|B<false>
9182 file (memory mapped file) storage statistics. Only available with Varnish 4.x.
9183 Note: SMA, SMF and MSE share counters, enable only the one used by the Varnish
9184 instance. Used to be called SM in Varnish 2.x. False by default.
9186 =item B<CollectManagement> B<true>|B<false>
9188 Management process counters. Only available with Varnish 4.x. False by default.
9190 =item B<CollectLock> B<true>|B<false>
9192 Lock counters. Only available with Varnish 4.x. False by default.
9194 =item B<CollectMempool> B<true>|B<false>
9196 Memory pool counters. Only available with Varnish 4.x. False by default.
9198 =item B<CollectMSE> B<true>|B<false>
9200 Varnish Massive Storage Engine 2.0 (MSE2) is an improved storage backend for
9201 Varnish, replacing the traditional malloc and file storages. Only available
9202 with Varnish-Plus 4.x. Note: SMA, SMF and MSE share counters, enable only the
9203 one used by the Varnish instance. False by default.
9207 =head2 Plugin C<virt>
9209 This plugin allows CPU, disk, network load and other metrics to be collected for
9210 virtualized guests on the machine. The statistics are collected through libvirt
9211 API (L<http://libvirt.org/>). Majority of metrics can be gathered without
9212 installing any additional software on guests, especially I<collectd>, which runs
9213 only on the host system.
9215 Only I<Connection> is required.
9219 =item B<Connection> I<uri>
9221 Connect to the hypervisor given by I<uri>. For example if using Xen use:
9223 Connection "xen:///"
9225 Details which URIs allowed are given at L<http://libvirt.org/uri.html>.
9227 =item B<RefreshInterval> I<seconds>
9229 Refresh the list of domains and devices every I<seconds>. The default is 60
9230 seconds. Setting this to be the same or smaller than the I<Interval> will cause
9231 the list of domains and devices to be refreshed on every iteration.
9233 Refreshing the devices in particular is quite a costly operation, so if your
9234 virtualization setup is static you might consider increasing this. If this
9235 option is set to 0, refreshing is disabled completely.
9237 =item B<Domain> I<name>
9239 =item B<BlockDevice> I<name:dev>
9241 =item B<InterfaceDevice> I<name:dev>
9243 =item B<IgnoreSelected> B<true>|B<false>
9245 Select which domains and devices are collected.
9247 If I<IgnoreSelected> is not given or B<false> then only the listed domains and
9248 disk/network devices are collected.
9250 If I<IgnoreSelected> is B<true> then the test is reversed and the listed
9251 domains and disk/network devices are ignored, while the rest are collected.
9253 The domain name and device names may use a regular expression, if the name is
9254 surrounded by I</.../> and collectd was compiled with support for regexps.
9256 The default is to collect statistics for all domains and all their devices.
9260 BlockDevice "/:hdb/"
9261 IgnoreSelected "true"
9263 Ignore all I<hdb> devices on any domain, but other block devices (eg. I<hda>)
9266 =item B<BlockDeviceFormat> B<target>|B<source>
9268 If I<BlockDeviceFormat> is set to B<target>, the default, then the device name
9269 seen by the guest will be used for reporting metrics.
9270 This corresponds to the C<E<lt>targetE<gt>> node in the XML definition of the
9273 If I<BlockDeviceFormat> is set to B<source>, then metrics will be reported
9274 using the path of the source, e.g. an image file.
9275 This corresponds to the C<E<lt>sourceE<gt>> node in the XML definition of the
9280 If the domain XML have the following device defined:
9282 <disk type='block' device='disk'>
9283 <driver name='qemu' type='raw' cache='none' io='native' discard='unmap'/>
9284 <source dev='/var/lib/libvirt/images/image1.qcow2'/>
9285 <target dev='sda' bus='scsi'/>
9287 <address type='drive' controller='0' bus='0' target='0' unit='0'/>
9290 Setting C<BlockDeviceFormat target> will cause the I<type instance> to be set
9292 Setting C<BlockDeviceFormat source> will cause the I<type instance> to be set
9293 to C<var_lib_libvirt_images_image1.qcow2>.
9295 =item B<BlockDeviceFormatBasename> B<false>|B<true>
9297 The B<BlockDeviceFormatBasename> controls whether the full path or the
9298 L<basename(1)> of the source is being used as the I<type instance> when
9299 B<BlockDeviceFormat> is set to B<source>. Defaults to B<false>.
9303 Assume the device path (source tag) is C</var/lib/libvirt/images/image1.qcow2>.
9304 Setting C<BlockDeviceFormatBasename false> will cause the I<type instance> to
9305 be set to C<var_lib_libvirt_images_image1.qcow2>.
9306 Setting C<BlockDeviceFormatBasename true> will cause the I<type instance> to be
9307 set to C<image1.qcow2>.
9309 =item B<HostnameFormat> B<name|uuid|hostname|...>
9311 When the virt plugin logs data, it sets the hostname of the collected data
9312 according to this setting. The default is to use the guest name as provided by
9313 the hypervisor, which is equal to setting B<name>.
9315 B<uuid> means use the guest's UUID. This is useful if you want to track the
9316 same guest across migrations.
9318 B<hostname> means to use the global B<Hostname> setting, which is probably not
9319 useful on its own because all guests will appear to have the same name.
9321 You can also specify combinations of these fields. For example B<name uuid>
9322 means to concatenate the guest name and UUID (with a literal colon character
9323 between, thus I<"foo:1234-1234-1234-1234">).
9325 At the moment of writing (collectd-5.5), hostname string is limited to 62
9326 characters. In case when combination of fields exceeds 62 characters,
9327 hostname will be truncated without a warning.
9329 =item B<InterfaceFormat> B<name>|B<address>
9331 When the virt plugin logs interface data, it sets the name of the collected
9332 data according to this setting. The default is to use the path as provided by
9333 the hypervisor (the "dev" property of the target node), which is equal to
9336 B<address> means use the interface's mac address. This is useful since the
9337 interface path might change between reboots of a guest or across migrations.
9339 =item B<PluginInstanceFormat> B<name|uuid|none>
9341 When the virt plugin logs data, it sets the plugin_instance of the collected
9342 data according to this setting. The default is to not set the plugin_instance.
9344 B<name> means use the guest's name as provided by the hypervisor.
9345 B<uuid> means use the guest's UUID.
9347 You can also specify combinations of the B<name> and B<uuid> fields.
9348 For example B<name uuid> means to concatenate the guest name and UUID
9349 (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">).
9351 =item B<Instances> B<integer>
9353 How many read instances you want to use for this plugin. The default is one,
9354 and the sensible setting is a multiple of the B<ReadThreads> value.
9355 If you are not sure, just use the default setting.
9357 =item B<ExtraStats> B<string>
9359 Report additional extra statistics. The default is no extra statistics, preserving
9360 the previous behaviour of the plugin. If unsure, leave the default. If enabled,
9361 allows the plugin to reported more detailed statistics about the behaviour of
9362 Virtual Machines. The argument is a space-separated list of selectors.
9364 Currently supported selectors are:
9368 =item B<cpu_util>: report CPU utilization per domain in percentage.
9370 =item B<disk>: report extra statistics like number of flush operations and total
9371 service time for read, write and flush operations. Requires libvirt API version
9374 =item B<disk_err>: report disk errors if any occured. Requires libvirt API version
9377 =item B<domain_state>: report domain state and reason in human-readable format as
9378 a notification. If libvirt API version I<0.9.2> or later is available, domain
9379 reason will be included in notification.
9381 =item B<fs_info>: report file system information as a notification. Requires
9382 libvirt API version I<1.2.11> or later. Can be collected only if I<Guest Agent>
9383 is installed and configured inside VM. Make sure that installed I<Guest Agent>
9384 version supports retrieving file system information.
9386 =item B<job_stats_background>: report statistics about progress of a background
9387 job on a domain. Only one type of job statistics can be collected at the same time.
9388 Requires libvirt API version I<1.2.9> or later.
9390 =item B<job_stats_completed>: report statistics about a recently completed job on
9391 a domain. Only one type of job statistics can be collected at the same time.
9392 Requires libvirt API version I<1.2.9> or later.
9394 =item B<pcpu>: report the physical user/system cpu time consumed by the hypervisor, per-vm.
9395 Requires libvirt API version I<0.9.11> or later.
9397 =item B<perf>: report performance monitoring events. To collect performance
9398 metrics they must be enabled for domain and supported by the platform. Requires
9399 libvirt API version I<1.3.3> or later.
9400 B<Note>: I<perf> metrics can't be collected if I<intel_rdt> plugin is enabled.
9402 =item B<vcpupin>: report pinning of domain VCPUs to host physical CPUs.
9406 =item B<PersistentNotification> B<true>|B<false>
9407 Override default configuration to only send notifications when there is a change
9408 in the lifecycle state of a domain. When set to true notifications will be sent
9409 for every read cycle. Default is false. Does not affect the stats being
9414 =head2 Plugin C<vmem>
9416 The C<vmem> plugin collects information about the usage of virtual memory.
9417 Since the statistics provided by the Linux kernel are very detailed, they are
9418 collected very detailed. However, to get all the details, you have to switch
9419 them on manually. Most people just want an overview over, such as the number of
9420 pages read from swap space.
9424 =item B<Verbose> B<true>|B<false>
9426 Enables verbose collection of information. This will start collecting page
9427 "actions", e.E<nbsp>g. page allocations, (de)activations, steals and so on.
9428 Part of these statistics are collected on a "per zone" basis.
9432 =head2 Plugin C<vserver>
9434 This plugin doesn't have any options. B<VServer> support is only available for
9435 Linux. It cannot yet be found in a vanilla kernel, though. To make use of this
9436 plugin you need a kernel that has B<VServer> support built in, i.E<nbsp>e. you
9437 need to apply the patches and compile your own kernel, which will then provide
9438 the F</proc/virtual> filesystem that is required by this plugin.
9440 The B<VServer> homepage can be found at L<http://linux-vserver.org/>.
9442 B<Note>: The traffic collected by this plugin accounts for the amount of
9443 traffic passing a socket which might be a lot less than the actual on-wire
9444 traffic (e.E<nbsp>g. due to headers and retransmission). If you want to
9445 collect on-wire traffic you could, for example, use the logging facilities of
9446 iptables to feed data for the guest IPs into the iptables plugin.
9448 =head2 Plugin C<write_graphite>
9450 The C<write_graphite> plugin writes data to I<Graphite>, an open-source metrics
9451 storage and graphing project. The plugin connects to I<Carbon>, the data layer
9452 of I<Graphite>, via I<TCP> or I<UDP> and sends data via the "line based"
9453 protocol (per default using portE<nbsp>2003). The data will be sent in blocks
9454 of at most 1428 bytes to minimize the number of network packets.
9458 <Plugin write_graphite>
9469 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9470 blocks. Inside the B<Node> blocks, the following options are recognized:
9474 =item B<Host> I<Address>
9476 Hostname or address to connect to. Defaults to C<localhost>.
9478 =item B<Port> I<Service>
9480 Service name or port number to connect to. Defaults to C<2003>.
9482 =item B<Protocol> I<String>
9484 Protocol to use when connecting to I<Graphite>. Defaults to C<tcp>.
9486 =item B<ReconnectInterval> I<Seconds>
9488 When set to non-zero, forces the connection to the Graphite backend to be
9489 closed and re-opend periodically. This behavior is desirable in environments
9490 where the connection to the Graphite backend is done through load balancers,
9491 for example. When set to zero, the default, the connetion is kept open for as
9494 =item B<LogSendErrors> B<false>|B<true>
9496 If set to B<true> (the default), logs errors when sending data to I<Graphite>.
9497 If set to B<false>, it will not log the errors. This is especially useful when
9498 using Protocol UDP since many times we want to use the "fire-and-forget"
9499 approach and logging errors fills syslog with unneeded messages.
9501 =item B<Prefix> I<String>
9503 When B<UseTags> is I<false>, B<Prefix> value is added in front of the host name.
9504 When B<UseTags> is I<true>, B<Prefix> value is added in front of series name.
9506 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9509 =item B<Postfix> I<String>
9511 When B<UseTags> is I<false>, B<Postfix> value appended to the host name.
9512 When B<UseTags> is I<true>, B<Postgix> value appended to the end of series name
9513 (before the first ; that separates the name from the tags).
9515 Dots and whitespace are I<not> escaped in this string (see B<EscapeCharacter>
9518 =item B<EscapeCharacter> I<Char>
9520 I<Carbon> uses the dot (C<.>) as escape character and doesn't allow whitespace
9521 in the identifier. The B<EscapeCharacter> option determines which character
9522 dots, whitespace and control characters are replaced with. Defaults to
9525 =item B<StoreRates> B<false>|B<true>
9527 If set to B<true> (the default), convert counter values to rates. If set to
9528 B<false> counter values are stored as is, i.E<nbsp>e. as an increasing integer
9531 =item B<SeparateInstances> B<false>|B<true>
9533 If set to B<true>, the plugin instance and type instance will be in their own
9534 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
9535 default), the plugin and plugin instance (and likewise the type and type
9536 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
9538 Option value is not used when B<UseTags> is I<true>.
9540 =item B<AlwaysAppendDS> B<false>|B<true>
9542 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
9543 identifier. If set to B<false> (the default), this is only done when there is
9546 =item B<PreserveSeparator> B<false>|B<true>
9548 If set to B<false> (the default) the C<.> (dot) character is replaced with
9549 I<EscapeCharacter>. Otherwise, if set to B<true>, the C<.> (dot) character
9550 is preserved, i.e. passed through.
9552 Option value is not used when B<UseTags> is I<true>.
9554 =item B<DropDuplicateFields> B<false>|B<true>
9556 If set to B<true>, detect and remove duplicate components in Graphite metric
9557 names. For example, the metric name C<host.load.load.shortterm> will
9558 be shortened to C<host.load.shortterm>.
9560 =item B<UseTags> B<false>|B<true>
9562 If set to B<true>, Graphite metric names will be generated as tagged series.
9563 This allows for much more flexibility than the traditional hierarchical layout.
9566 C<test.single;host=example.com;plugin=test;plugin_instance=foo;type=single;type_instance=bar>
9568 You can use B<Postfix> option to add more tags by specifying it like
9569 C<;tag1=value1;tag2=value2>. Note what tagging support was added since Graphite
9572 If set to B<true>, the B<SeparateInstances> and B<PreserveSeparator> settings
9575 Default value: B<false>.
9579 =head2 Plugin C<write_log>
9581 The C<write_log> plugin writes metrics as INFO log messages.
9583 This plugin supports two output formats: I<Graphite> and I<JSON>.
9593 =item B<Format> I<Format>
9595 The output format to use. Can be one of C<Graphite> or C<JSON>.
9599 =head2 Plugin C<write_tsdb>
9601 The C<write_tsdb> plugin writes data to I<OpenTSDB>, a scalable open-source
9602 time series database. The plugin connects to a I<TSD>, a masterless, no shared
9603 state daemon that ingests metrics and stores them in HBase. The plugin uses
9604 I<TCP> over the "line based" protocol with a default port 4242. The data will
9605 be sent in blocks of at most 1428 bytes to minimize the number of network
9614 Host "tsd-1.my.domain"
9616 HostTags "status=production"
9620 The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
9621 blocks and global directives.
9623 Global directives are:
9627 =item B<ResolveInterval> I<seconds>
9629 =item B<ResolveJitter> I<seconds>
9631 When I<collectd> connects to a TSDB node, it will request the hostname from
9632 DNS. This can become a problem if the TSDB node is unavailable or badly
9633 configured because collectd will request DNS in order to reconnect for every
9634 metric, which can flood your DNS. So you can cache the last value for
9635 I<ResolveInterval> seconds.
9636 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9638 You can also define a jitter, a random interval to wait in addition to
9639 I<ResolveInterval>. This prevents all your collectd servers to resolve the
9640 hostname at the same time when the connection fails.
9641 Defaults to the I<Interval> of the I<write_tsdb plugin>, e.g. 10E<nbsp>seconds.
9643 B<Note:> If the DNS resolution has already been successful when the socket
9644 closes, the plugin will try to reconnect immediately with the cached
9645 information. DNS is queried only when the socket is closed for a longer than
9646 I<ResolveInterval> + I<ResolveJitter> seconds.
9650 Inside the B<Node> blocks, the following options are recognized:
9654 =item B<Host> I<Address>
9656 Hostname or address to connect to. Defaults to C<localhost>.
9658 =item B<Port> I<Service>
9660 Service name or port number to connect to. Defaults to C<4242>.
9663 =item B<HostTags> I<String>
9665 When set, I<HostTags> is added to the end of the metric. It is intended to be
9666 used for name=value pairs that the TSD will tag the metric with. Dots and
9667 whitespace are I<not> escaped in this string.
9669 =item B<StoreRates> B<false>|B<true>
9671 If set to B<true>, convert counter values to rates. If set to B<false>
9672 (the default) counter values are stored as is, as an increasing
9675 =item B<AlwaysAppendDS> B<false>|B<true>
9677 If set the B<true>, append the name of the I<Data Source> (DS) to the "metric"
9678 identifier. If set to B<false> (the default), this is only done when there is
9683 =head2 Plugin C<write_mongodb>
9685 The I<write_mongodb plugin> will send values to I<MongoDB>, a schema-less
9690 <Plugin "write_mongodb">
9699 The plugin can send values to multiple instances of I<MongoDB> by specifying
9700 one B<Node> block for each instance. Within the B<Node> blocks, the following
9701 options are available:
9705 =item B<Host> I<Address>
9707 Hostname or address to connect to. Defaults to C<localhost>.
9709 =item B<Port> I<Service>
9711 Service name or port number to connect to. Defaults to C<27017>.
9713 =item B<Timeout> I<Milliseconds>
9715 Set the timeout for each operation on I<MongoDB> to I<Timeout> milliseconds.
9716 Setting this option to zero means no timeout, which is the default.
9718 =item B<StoreRates> B<false>|B<true>
9720 If set to B<true> (the default), convert counter values to rates. If set to
9721 B<false> counter values are stored as is, i.e. as an increasing integer
9724 =item B<Database> I<Database>
9726 =item B<User> I<User>
9728 =item B<Password> I<Password>
9730 Sets the information used when authenticating to a I<MongoDB> database. The
9731 fields are optional (in which case no authentication is attempted), but if you
9732 want to use authentication all three fields must be set.
9736 =head2 Plugin C<write_prometheus>
9738 The I<write_prometheus plugin> implements a tiny webserver that can be scraped
9739 using I<Prometheus>.
9745 =item B<Port> I<Port>
9747 Port the embedded webserver should listen on. Defaults to B<9103>.
9749 =item B<StalenessDelta> I<Seconds>
9751 Time in seconds after which I<Prometheus> considers a metric "stale" if it
9752 hasn't seen any update for it. This value must match the setting in Prometheus.
9753 It defaults to B<300> seconds (5 minutes), same as Prometheus.
9757 I<Prometheus> has a global setting, C<StalenessDelta>, which controls after
9758 which time a metric without updates is considered "stale". This setting
9759 effectively puts an upper limit on the interval in which metrics are reported.
9761 When the I<write_prometheus plugin> encounters a metric with an interval
9762 exceeding this limit, it will inform you, the user, and provide the metric to
9763 I<Prometheus> B<without> a timestamp. That causes I<Prometheus> to consider the
9764 metric "fresh" each time it is scraped, with the time of the scrape being
9765 considered the time of the update. The result is that there appear more
9766 datapoints in I<Prometheus> than were actually created, but at least the metric
9767 doesn't disappear periodically.
9771 =head2 Plugin C<write_http>
9773 This output plugin submits values to an HTTP server using POST requests and
9774 encoding metrics with JSON or using the C<PUTVAL> command described in
9775 L<collectd-unixsock(5)>.
9779 <Plugin "write_http">
9781 URL "http://example.com/post-collectd"
9788 The plugin can send values to multiple HTTP servers by specifying one
9789 E<lt>B<Node>E<nbsp>I<Name>E<gt> block for each server. Within each B<Node>
9790 block, the following options are available:
9796 URL to which the values are submitted to. Mandatory.
9798 =item B<User> I<Username>
9800 Optional user name needed for authentication.
9802 =item B<Password> I<Password>
9804 Optional password needed for authentication.
9806 =item B<VerifyPeer> B<true>|B<false>
9808 Enable or disable peer SSL certificate verification. See
9809 L<http://curl.haxx.se/docs/sslcerts.html> for details. Enabled by default.
9811 =item B<VerifyHost> B<true|false>
9813 Enable or disable peer host name verification. If enabled, the plugin checks if
9814 the C<Common Name> or a C<Subject Alternate Name> field of the SSL certificate
9815 matches the host name provided by the B<URL> option. If this identity check
9816 fails, the connection is aborted. Obviously, only works when connecting to a
9817 SSL enabled server. Enabled by default.
9819 =item B<CACert> I<File>
9821 File that holds one or more SSL certificates. If you want to use HTTPS you will
9822 possibly need this option. What CA certificates come bundled with C<libcurl>
9823 and are checked by default depends on the distribution you use.
9825 =item B<CAPath> I<Directory>
9827 Directory holding one or more CA certificate files. You can use this if for
9828 some reason all the needed CA certificates aren't in the same file and can't be
9829 pointed to using the B<CACert> option. Requires C<libcurl> to be built against
9832 =item B<ClientKey> I<File>
9834 File that holds the private key in PEM format to be used for certificate-based
9837 =item B<ClientCert> I<File>
9839 File that holds the SSL certificate to be used for certificate-based
9842 =item B<ClientKeyPass> I<Password>
9844 Password required to load the private key in B<ClientKey>.
9846 =item B<Header> I<Header>
9848 A HTTP header to add to the request. Multiple headers are added if this option is specified more than once. Example:
9850 Header "X-Custom-Header: custom_value"
9852 =item B<SSLVersion> B<SSLv2>|B<SSLv3>|B<TLSv1>|B<TLSv1_0>|B<TLSv1_1>|B<TLSv1_2>
9854 Define which SSL protocol version must be used. By default C<libcurl> will
9855 attempt to figure out the remote SSL protocol version. See
9856 L<curl_easy_setopt(3)> for more details.
9858 =item B<Format> B<Command>|B<JSON>|B<KAIROSDB>
9860 Format of the output to generate. If set to B<Command>, will create output that
9861 is understood by the I<Exec> and I<UnixSock> plugins. When set to B<JSON>, will
9862 create output in the I<JavaScript Object Notation> (JSON). When set to KAIROSDB
9863 , will create output in the KairosDB format.
9865 Defaults to B<Command>.
9867 =item B<Attribute> I<String> I<String>
9869 Only available for the KAIROSDB output format.
9871 Consider the two given strings to be the key and value of an additional tag for
9872 each metric being sent out.
9874 You can add multiple B<Attribute>.
9878 Only available for the KAIROSDB output format.
9880 Sets the Cassandra ttl for the data points.
9882 Please refer to L<http://kairosdb.github.io/docs/build/html/restapi/AddDataPoints.html?highlight=ttl>
9884 =item B<Prefix> I<String>
9886 Only available for the KAIROSDB output format.
9888 Sets the metrics prefix I<string>. Defaults to I<collectd>.
9890 =item B<Metrics> B<true>|B<false>
9892 Controls whether I<metrics> are POSTed to this location. Defaults to B<true>.
9894 =item B<Notifications> B<false>|B<true>
9896 Controls whether I<notifications> are POSTed to this location. Defaults to B<false>.
9898 =item B<StoreRates> B<true|false>
9900 If set to B<true>, convert counter values to rates. If set to B<false> (the
9901 default) counter values are stored as is, i.e. as an increasing integer number.
9903 =item B<BufferSize> I<Bytes>
9905 Sets the send buffer size to I<Bytes>. By increasing this buffer, less HTTP
9906 requests will be generated, but more metrics will be batched / metrics are
9907 cached for longer before being sent, introducing additional delay until they
9908 are available on the server side. I<Bytes> must be at least 1024 and cannot
9909 exceed the size of an C<int>, i.e. 2E<nbsp>GByte.
9910 Defaults to C<4096>.
9912 =item B<LowSpeedLimit> I<Bytes per Second>
9914 Sets the minimal transfer rate in I<Bytes per Second> below which the
9915 connection with the HTTP server will be considered too slow and aborted. All
9916 the data submitted over this connection will probably be lost. Defaults to 0,
9917 which means no minimum transfer rate is enforced.
9919 =item B<Timeout> I<Timeout>
9921 Sets the maximum time in milliseconds given for HTTP POST operations to
9922 complete. When this limit is reached, the POST operation will be aborted, and
9923 all the data in the current send buffer will probably be lost. Defaults to 0,
9924 which means the connection never times out.
9926 =item B<LogHttpError> B<false>|B<true>
9928 Enables printing of HTTP error code to log. Turned off by default.
9930 The C<write_http> plugin regularly submits the collected values to the HTTP
9931 server. How frequently this happens depends on how much data you are collecting
9932 and the size of B<BufferSize>. The optimal value to set B<Timeout> to is
9933 slightly below this interval, which you can estimate by monitoring the network
9934 traffic between collectd and the HTTP server.
9938 =head2 Plugin C<write_kafka>
9940 The I<write_kafka plugin> will send values to a I<Kafka> topic, a distributed
9944 <Plugin "write_kafka">
9945 Property "metadata.broker.list" "broker1:9092,broker2:9092"
9951 The following options are understood by the I<write_kafka plugin>:
9955 =item E<lt>B<Topic> I<Name>E<gt>
9957 The plugin's configuration consists of one or more B<Topic> blocks. Each block
9958 is given a unique I<Name> and specifies one kafka producer.
9959 Inside the B<Topic> block, the following per-topic options are
9964 =item B<Property> I<String> I<String>
9966 Configure the named property for the current topic. Properties are
9967 forwarded to the kafka producer library B<librdkafka>.
9969 =item B<Key> I<String>
9971 Use the specified string as a partitioning key for the topic. Kafka breaks
9972 topic into partitions and guarantees that for a given topology, the same
9973 consumer will be used for a specific key. The special (case insensitive)
9974 string B<Random> can be used to specify that an arbitrary partition should
9977 =item B<Format> B<Command>|B<JSON>|B<Graphite>
9979 Selects the format in which messages are sent to the broker. If set to
9980 B<Command> (the default), values are sent as C<PUTVAL> commands which are
9981 identical to the syntax used by the I<Exec> and I<UnixSock plugins>.
9983 If set to B<JSON>, the values are encoded in the I<JavaScript Object Notation>,
9984 an easy and straight forward exchange format.
9986 If set to B<Graphite>, values are encoded in the I<Graphite> format, which is
9987 C<E<lt>metricE<gt> E<lt>valueE<gt> E<lt>timestampE<gt>\n>.
9989 =item B<StoreRates> B<true>|B<false>
9991 Determines whether or not C<COUNTER>, C<DERIVE> and C<ABSOLUTE> data sources
9992 are converted to a I<rate> (i.e. a C<GAUGE> value). If set to B<false> (the
9993 default), no conversion is performed. Otherwise the conversion is performed
9994 using the internal value cache.
9996 Please note that currently this option is only used if the B<Format> option has
9997 been set to B<JSON>.
9999 =item B<GraphitePrefix> (B<Format>=I<Graphite> only)
10001 A prefix can be added in the metric name when outputting in the I<Graphite>
10004 When B<GraphiteUseTags> is I<false>, prefix is added before the I<Host> name.
10005 Metric name will be
10006 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>>
10008 When B<GraphiteUseTags> is I<true>, prefix is added in front of series name.
10010 =item B<GraphitePostfix> (B<Format>=I<Graphite> only)
10012 A postfix can be added in the metric name when outputting in the I<Graphite>
10015 When B<GraphiteUseTags> is I<false>, postfix is added after the I<Host> name.
10016 Metric name will be
10017 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>>
10019 When B<GraphiteUseTags> is I<true>, prefix value appended to the end of series
10020 name (before the first ; that separates the name from the tags).
10022 =item B<GraphiteEscapeChar> (B<Format>=I<Graphite> only)
10024 Specify a character to replace dots (.) in the host part of the metric name.
10025 In I<Graphite> metric name, dots are used as separators between different
10026 metric parts (host, plugin, type).
10027 Default is C<_> (I<Underscore>).
10029 =item B<GraphiteSeparateInstances> B<false>|B<true>
10031 If set to B<true>, the plugin instance and type instance will be in their own
10032 path component, for example C<host.cpu.0.cpu.idle>. If set to B<false> (the
10033 default), the plugin and plugin instance (and likewise the type and type
10034 instance) are put into one component, for example C<host.cpu-0.cpu-idle>.
10036 Option value is not used when B<GraphiteUseTags> is I<true>.
10038 =item B<GraphiteAlwaysAppendDS> B<true>|B<false>
10040 If set to B<true>, append the name of the I<Data Source> (DS) to the "metric"
10041 identifier. If set to B<false> (the default), this is only done when there is
10044 =item B<GraphitePreserveSeparator> B<false>|B<true>
10046 If set to B<false> (the default) the C<.> (dot) character is replaced with
10047 I<GraphiteEscapeChar>. Otherwise, if set to B<true>, the C<.> (dot) character
10048 is preserved, i.e. passed through.
10050 Option value is not used when B<GraphiteUseTags> is I<true>.
10052 =item B<GraphiteUseTags> B<false>|B<true>
10054 If set to B<true> Graphite metric names will be generated as tagged series.
10056 Default value: B<false>.
10058 =item B<StoreRates> B<true>|B<false>
10060 If set to B<true> (the default), convert counter values to rates. If set to
10061 B<false> counter values are stored as is, i.e. as an increasing integer number.
10063 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10064 converted values will have "rate" appended to the data source type, e.g.
10065 C<ds_type:derive:rate>.
10069 =item B<Property> I<String> I<String>
10071 Configure the kafka producer through properties, you almost always will
10072 want to set B<metadata.broker.list> to your Kafka broker list.
10076 =head2 Plugin C<write_redis>
10078 The I<write_redis plugin> submits values to I<Redis>, a data structure server.
10082 <Plugin "write_redis">
10095 Values are submitted to I<Sorted Sets>, using the metric name as the key, and
10096 the timestamp as the score. Retrieving a date range can then be done using the
10097 C<ZRANGEBYSCORE> I<Redis> command. Additionally, all the identifiers of these
10098 I<Sorted Sets> are kept in a I<Set> called C<collectd/values> (or
10099 C<${prefix}/values> if the B<Prefix> option was specified) and can be retrieved
10100 using the C<SMEMBERS> I<Redis> command. You can specify the database to use
10101 with the B<Database> parameter (default is C<0>). See
10102 L<http://redis.io/commands#sorted_set> and L<http://redis.io/commands#set> for
10105 The information shown in the synopsis above is the I<default configuration>
10106 which is used by the plugin if no configuration is present.
10108 The plugin can send values to multiple instances of I<Redis> by specifying
10109 one B<Node> block for each instance. Within the B<Node> blocks, the following
10110 options are available:
10114 =item B<Node> I<Nodename>
10116 The B<Node> block identifies a new I<Redis> node, that is a new I<Redis>
10117 instance running on a specified host and port. The node name is a
10118 canonical identifier which is used as I<plugin instance>. It is limited to
10119 51E<nbsp>characters in length.
10121 =item B<Host> I<Hostname>
10123 The B<Host> option is the hostname or IP-address where the I<Redis> instance is
10126 =item B<Port> I<Port>
10128 The B<Port> option is the TCP port on which the Redis instance accepts
10129 connections. Either a service name of a port number may be given. Please note
10130 that numerical port numbers must be given as a string, too.
10132 =item B<Timeout> I<Milliseconds>
10134 The B<Timeout> option sets the socket connection timeout, in milliseconds.
10136 =item B<Prefix> I<Prefix>
10138 Prefix used when constructing the name of the I<Sorted Sets> and the I<Set>
10139 containing all metrics. Defaults to C<collectd/>, so metrics will have names
10140 like C<collectd/cpu-0/cpu-user>. When setting this to something different, it
10141 is recommended but not required to include a trailing slash in I<Prefix>.
10143 =item B<Database> I<Index>
10145 This index selects the redis database to use for writing operations. Defaults
10148 =item B<MaxSetSize> I<Items>
10150 The B<MaxSetSize> option limits the number of items that the I<Sorted Sets> can
10151 hold. Negative values for I<Items> sets no limit, which is the default behavior.
10153 =item B<MaxSetDuration> I<Seconds>
10155 The B<MaxSetDuration> option limits the duration of items that the
10156 I<Sorted Sets> can hold. Negative values for I<Items> sets no duration, which
10157 is the default behavior.
10159 =item B<StoreRates> B<true>|B<false>
10161 If set to B<true> (the default), convert counter values to rates. If set to
10162 B<false> counter values are stored as is, i.e. as an increasing integer number.
10166 =head2 Plugin C<write_riemann>
10168 The I<write_riemann plugin> will send values to I<Riemann>, a powerful stream
10169 aggregation and monitoring system. The plugin sends I<Protobuf> encoded data to
10170 I<Riemann> using UDP packets.
10174 <Plugin "write_riemann">
10180 AlwaysAppendDS false
10184 Attribute "foo" "bar"
10187 The following options are understood by the I<write_riemann plugin>:
10191 =item E<lt>B<Node> I<Name>E<gt>
10193 The plugin's configuration consists of one or more B<Node> blocks. Each block
10194 is given a unique I<Name> and specifies one connection to an instance of
10195 I<Riemann>. Indise the B<Node> block, the following per-connection options are
10200 =item B<Host> I<Address>
10202 Hostname or address to connect to. Defaults to C<localhost>.
10204 =item B<Port> I<Service>
10206 Service name or port number to connect to. Defaults to C<5555>.
10208 =item B<Protocol> B<UDP>|B<TCP>|B<TLS>
10210 Specify the protocol to use when communicating with I<Riemann>. Defaults to
10213 =item B<TLSCertFile> I<Path>
10215 When using the B<TLS> protocol, path to a PEM certificate to present
10218 =item B<TLSCAFile> I<Path>
10220 When using the B<TLS> protocol, path to a PEM CA certificate to
10221 use to validate the remote hosts's identity.
10223 =item B<TLSKeyFile> I<Path>
10225 When using the B<TLS> protocol, path to a PEM private key associated
10226 with the certificate defined by B<TLSCertFile>.
10228 =item B<Batch> B<true>|B<false>
10230 If set to B<true> and B<Protocol> is set to B<TCP>,
10231 events will be batched in memory and flushed at
10232 regular intervals or when B<BatchMaxSize> is exceeded.
10234 Notifications are not batched and sent as soon as possible.
10236 When enabled, it can occur that events get processed by the Riemann server
10237 close to or after their expiration time. Tune the B<TTLFactor> and
10238 B<BatchMaxSize> settings according to the amount of values collected, if this
10243 =item B<BatchMaxSize> I<size>
10245 Maximum payload size for a riemann packet. Defaults to 8192
10247 =item B<BatchFlushTimeout> I<seconds>
10249 Maximum amount of seconds to wait in between to batch flushes.
10250 No timeout by default.
10252 =item B<StoreRates> B<true>|B<false>
10254 If set to B<true> (the default), convert counter values to rates. If set to
10255 B<false> counter values are stored as is, i.e. as an increasing integer number.
10257 This will be reflected in the C<ds_type> tag: If B<StoreRates> is enabled,
10258 converted values will have "rate" appended to the data source type, e.g.
10259 C<ds_type:derive:rate>.
10261 =item B<AlwaysAppendDS> B<false>|B<true>
10263 If set to B<true>, append the name of the I<Data Source> (DS) to the
10264 "service", i.e. the field that, together with the "host" field, uniquely
10265 identifies a metric in I<Riemann>. If set to B<false> (the default), this is
10266 only done when there is more than one DS.
10268 =item B<TTLFactor> I<Factor>
10270 I<Riemann> events have a I<Time to Live> (TTL) which specifies how long each
10271 event is considered active. I<collectd> populates this field based on the
10272 metrics interval setting. This setting controls the factor with which the
10273 interval is multiplied to set the TTL. The default value is B<2.0>. Unless you
10274 know exactly what you're doing, you should only increase this setting from its
10277 =item B<Notifications> B<false>|B<true>
10279 If set to B<true>, create riemann events for notifications. This is B<true>
10280 by default. When processing thresholds from write_riemann, it might prove
10281 useful to avoid getting notification events.
10283 =item B<CheckThresholds> B<false>|B<true>
10285 If set to B<true>, attach state to events based on thresholds defined
10286 in the B<Threshold> plugin. Defaults to B<false>.
10288 =item B<EventServicePrefix> I<String>
10290 Add the given string as a prefix to the event service name.
10291 If B<EventServicePrefix> not set or set to an empty string (""),
10292 no prefix will be used.
10296 =item B<Tag> I<String>
10298 Add the given string as an additional tag to the metric being sent to
10301 =item B<Attribute> I<String> I<String>
10303 Consider the two given strings to be the key and value of an additional
10304 attribute for each metric being sent out to I<Riemann>.
10308 =head2 Plugin C<write_sensu>
10310 The I<write_sensu plugin> will send values to I<Sensu>, a powerful stream
10311 aggregation and monitoring system. The plugin sends I<JSON> encoded data to
10312 a local I<Sensu> client using a TCP socket.
10314 At the moment, the I<write_sensu plugin> does not send over a collectd_host
10315 parameter so it is not possible to use one collectd instance as a gateway for
10316 others. Each collectd host must pair with one I<Sensu> client.
10320 <Plugin "write_sensu">
10325 AlwaysAppendDS false
10326 MetricHandler "influx"
10327 MetricHandler "default"
10328 NotificationHandler "flapjack"
10329 NotificationHandler "howling_monkey"
10333 Attribute "foo" "bar"
10336 The following options are understood by the I<write_sensu plugin>:
10340 =item E<lt>B<Node> I<Name>E<gt>
10342 The plugin's configuration consists of one or more B<Node> blocks. Each block
10343 is given a unique I<Name> and specifies one connection to an instance of
10344 I<Sensu>. Inside the B<Node> block, the following per-connection options are
10349 =item B<Host> I<Address>
10351 Hostname or address to connect to. Defaults to C<localhost>.
10353 =item B<Port> I<Service>
10355 Service name or port number to connect to. Defaults to C<3030>.
10357 =item B<StoreRates> B<true>|B<false>
10359 If set to B<true> (the default), convert counter values to rates. If set to
10360 B<false> counter values are stored as is, i.e. as an increasing integer number.
10362 This will be reflected in the C<collectd_data_source_type> tag: If
10363 B<StoreRates> is enabled, converted values will have "rate" appended to the
10364 data source type, e.g. C<collectd_data_source_type:derive:rate>.
10366 =item B<AlwaysAppendDS> B<false>|B<true>
10368 If set the B<true>, append the name of the I<Data Source> (DS) to the
10369 "service", i.e. the field that, together with the "host" field, uniquely
10370 identifies a metric in I<Sensu>. If set to B<false> (the default), this is
10371 only done when there is more than one DS.
10373 =item B<Notifications> B<false>|B<true>
10375 If set to B<true>, create I<Sensu> events for notifications. This is B<false>
10376 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10378 =item B<Metrics> B<false>|B<true>
10380 If set to B<true>, create I<Sensu> events for metrics. This is B<false>
10381 by default. At least one of B<Notifications> or B<Metrics> should be enabled.
10384 =item B<Separator> I<String>
10386 Sets the separator for I<Sensu> metrics name or checks. Defaults to "/".
10388 =item B<MetricHandler> I<String>
10390 Add a handler that will be set when metrics are sent to I<Sensu>. You can add
10391 several of them, one per line. Defaults to no handler.
10393 =item B<NotificationHandler> I<String>
10395 Add a handler that will be set when notifications are sent to I<Sensu>. You can
10396 add several of them, one per line. Defaults to no handler.
10398 =item B<EventServicePrefix> I<String>
10400 Add the given string as a prefix to the event service name.
10401 If B<EventServicePrefix> not set or set to an empty string (""),
10402 no prefix will be used.
10406 =item B<Tag> I<String>
10408 Add the given string as an additional tag to the metric being sent to
10411 =item B<Attribute> I<String> I<String>
10413 Consider the two given strings to be the key and value of an additional
10414 attribute for each metric being sent out to I<Sensu>.
10418 =head2 Plugin C<write_stackdriver>
10420 The C<write_stackdriver> plugin writes metrics to the
10421 I<Google Stackdriver Monitoring> service.
10423 This plugin supports two authentication methods: When configured, credentials
10424 are read from the JSON credentials file specified with B<CredentialFile>.
10425 Alternatively, when running on
10426 I<Google Compute Engine> (GCE), an I<OAuth> token is retrieved from the
10427 I<metadata server> and used to authenticate to GCM.
10431 <Plugin write_stackdriver>
10432 CredentialFile "/path/to/service_account.json"
10433 <Resource "global">
10434 Label "project_id" "monitored_project"
10440 =item B<CredentialFile> I<file>
10442 Path to a JSON credentials file holding the credentials for a GCP service
10445 If B<CredentialFile> is not specified, the plugin uses I<Application Default
10446 Credentials>. That means which credentials are used depends on the environment:
10452 The environment variable C<GOOGLE_APPLICATION_CREDENTIALS> is checked. If this
10453 variable is specified it should point to a JSON file that defines the
10458 The path C<${HOME}/.config/gcloud/application_default_credentials.json> is
10459 checked. This where credentials used by the I<gcloud> command line utility are
10460 stored. You can use C<gcloud auth application-default login> to create these
10463 Please note that these credentials are often of your personal account, not a
10464 service account, and are therefore unfit to be used in a production
10469 When running on GCE, the built-in service account associated with the virtual
10470 machine instance is used.
10471 See also the B<Email> option below.
10475 =item B<Project> I<Project>
10477 The I<Project ID> or the I<Project Number> of the I<Stackdriver Account>. The
10478 I<Project ID> is a string identifying the GCP project, which you can chose
10479 freely when creating a new project. The I<Project Number> is a 12-digit decimal
10480 number. You can look up both on the I<Developer Console>.
10482 This setting is optional. If not set, the project ID is read from the
10483 credentials file or determined from the GCE's metadata service.
10485 =item B<Email> I<Email> (GCE only)
10487 Choses the GCE I<Service Account> used for authentication.
10489 Each GCE instance has a C<default> I<Service Account> but may also be
10490 associated with additional I<Service Accounts>. This is often used to restrict
10491 the permissions of services running on the GCE instance to the required
10492 minimum. The I<write_stackdriver plugin> requires the
10493 C<https://www.googleapis.com/auth/monitoring> scope. When multiple I<Service
10494 Accounts> are available, this option selects which one is used by
10495 I<write_stackdriver plugin>.
10497 =item B<Resource> I<ResourceType>
10499 Configures the I<Monitored Resource> to use when storing metrics.
10500 More information on I<Monitored Resources> and I<Monitored Resource Types> are
10501 available at L<https://cloud.google.com/monitoring/api/resources>.
10503 This block takes one string argument, the I<ResourceType>. Inside the block are
10504 one or more B<Label> options which configure the resource labels.
10506 This block is optional. The default value depends on the runtime environment:
10507 on GCE, the C<gce_instance> resource type is used, otherwise the C<global>
10508 resource type ist used:
10514 B<On GCE>, defaults to the equivalent of this config:
10516 <Resource "gce_instance">
10517 Label "project_id" "<project_id>"
10518 Label "instance_id" "<instance_id>"
10519 Label "zone" "<zone>"
10522 The values for I<project_id>, I<instance_id> and I<zone> are read from the GCE
10527 B<Elsewhere>, i.e. not on GCE, defaults to the equivalent of this config:
10529 <Resource "global">
10530 Label "project_id" "<Project>"
10533 Where I<Project> refers to the value of the B<Project> option or the project ID
10534 inferred from the B<CredentialFile>.
10538 =item B<Url> I<Url>
10540 URL of the I<Stackdriver Monitoring> API. Defaults to
10541 C<https://monitoring.googleapis.com/v3>.
10545 =head2 Plugin C<xencpu>
10547 This plugin collects metrics of hardware CPU load for machine running Xen
10548 hypervisor. Load is calculated from 'idle time' value, provided by Xen.
10549 Result is reported using the C<percent> type, for each CPU (core).
10551 This plugin doesn't have any options (yet).
10553 =head2 Plugin C<zookeeper>
10555 The I<zookeeper plugin> will collect statistics from a I<Zookeeper> server
10556 using the mntr command. It requires Zookeeper 3.4.0+ and access to the
10561 <Plugin "zookeeper">
10568 =item B<Host> I<Address>
10570 Hostname or address to connect to. Defaults to C<localhost>.
10572 =item B<Port> I<Service>
10574 Service name or port number to connect to. Defaults to C<2181>.
10578 =head1 THRESHOLD CONFIGURATION
10580 Starting with version C<4.3.0> collectd has support for B<monitoring>. By that
10581 we mean that the values are not only stored or sent somewhere, but that they
10582 are judged and, if a problem is recognized, acted upon. The only action
10583 collectd takes itself is to generate and dispatch a "notification". Plugins can
10584 register to receive notifications and perform appropriate further actions.
10586 Since systems and what you expect them to do differ a lot, you can configure
10587 B<thresholds> for your values freely. This gives you a lot of flexibility but
10588 also a lot of responsibility.
10590 Every time a value is out of range a notification is dispatched. This means
10591 that the idle percentage of your CPU needs to be less then the configured
10592 threshold only once for a notification to be generated. There's no such thing
10593 as a moving average or similar - at least not now.
10595 Also, all values that match a threshold are considered to be relevant or
10596 "interesting". As a consequence collectd will issue a notification if they are
10597 not received for B<Timeout> iterations. The B<Timeout> configuration option is
10598 explained in section L<"GLOBAL OPTIONS">. If, for example, B<Timeout> is set to
10599 "2" (the default) and some hosts sends it's CPU statistics to the server every
10600 60 seconds, a notification will be dispatched after about 120 seconds. It may
10601 take a little longer because the timeout is checked only once each B<Interval>
10604 When a value comes within range again or is received after it was missing, an
10605 "OKAY-notification" is dispatched.
10607 Here is a configuration example to get you started. Read below for more
10620 <Plugin "interface">
10623 FailureMax 10000000
10637 WarningMin 100000000
10643 There are basically two types of configuration statements: The C<Host>,
10644 C<Plugin>, and C<Type> blocks select the value for which a threshold should be
10645 configured. The C<Plugin> and C<Type> blocks may be specified further using the
10646 C<Instance> option. You can combine the block by nesting the blocks, though
10647 they must be nested in the above order, i.E<nbsp>e. C<Host> may contain either
10648 C<Plugin> and C<Type> blocks, C<Plugin> may only contain C<Type> blocks and
10649 C<Type> may not contain other blocks. If multiple blocks apply to the same
10650 value the most specific block is used.
10652 The other statements specify the threshold to configure. They B<must> be
10653 included in a C<Type> block. Currently the following statements are recognized:
10657 =item B<FailureMax> I<Value>
10659 =item B<WarningMax> I<Value>
10661 Sets the upper bound of acceptable values. If unset defaults to positive
10662 infinity. If a value is greater than B<FailureMax> a B<FAILURE> notification
10663 will be created. If the value is greater than B<WarningMax> but less than (or
10664 equal to) B<FailureMax> a B<WARNING> notification will be created.
10666 =item B<FailureMin> I<Value>
10668 =item B<WarningMin> I<Value>
10670 Sets the lower bound of acceptable values. If unset defaults to negative
10671 infinity. If a value is less than B<FailureMin> a B<FAILURE> notification will
10672 be created. If the value is less than B<WarningMin> but greater than (or equal
10673 to) B<FailureMin> a B<WARNING> notification will be created.
10675 =item B<DataSource> I<DSName>
10677 Some data sets have more than one "data source". Interesting examples are the
10678 C<if_octets> data set, which has received (C<rx>) and sent (C<tx>) bytes and
10679 the C<disk_ops> data set, which holds C<read> and C<write> operations. The
10680 system load data set, C<load>, even has three data sources: C<shortterm>,
10681 C<midterm>, and C<longterm>.
10683 Normally, all data sources are checked against a configured threshold. If this
10684 is undesirable, or if you want to specify different limits for each data
10685 source, you can use the B<DataSource> option to have a threshold apply only to
10688 =item B<Invert> B<true>|B<false>
10690 If set to B<true> the range of acceptable values is inverted, i.E<nbsp>e.
10691 values between B<FailureMin> and B<FailureMax> (B<WarningMin> and
10692 B<WarningMax>) are not okay. Defaults to B<false>.
10694 =item B<Persist> B<true>|B<false>
10696 Sets how often notifications are generated. If set to B<true> one notification
10697 will be generated for each value that is out of the acceptable range. If set to
10698 B<false> (the default) then a notification is only generated if a value is out
10699 of range but the previous value was okay.
10701 This applies to missing values, too: If set to B<true> a notification about a
10702 missing value is generated once every B<Interval> seconds. If set to B<false>
10703 only one such notification is generated until the value appears again.
10705 =item B<Percentage> B<true>|B<false>
10707 If set to B<true>, the minimum and maximum values given are interpreted as
10708 percentage value, relative to the other data sources. This is helpful for
10709 example for the "df" type, where you may want to issue a warning when less than
10710 5E<nbsp>% of the total space is available. Defaults to B<false>.
10712 =item B<Hits> I<Number>
10714 Delay creating the notification until the threshold has been passed I<Number>
10715 times. When a notification has been generated, or when a subsequent value is
10716 inside the threshold, the counter is reset. If, for example, a value is
10717 collected once every 10E<nbsp>seconds and B<Hits> is set to 3, a notification
10718 will be dispatched at most once every 30E<nbsp>seconds.
10720 This is useful when short bursts are not a problem. If, for example, 100% CPU
10721 usage for up to a minute is normal (and data is collected every
10722 10E<nbsp>seconds), you could set B<Hits> to B<6> to account for this.
10724 =item B<Hysteresis> I<Number>
10726 When set to non-zero, a hysteresis value is applied when checking minimum and
10727 maximum bounds. This is useful for values that increase slowly and fluctuate a
10728 bit while doing so. When these values come close to the threshold, they may
10729 "flap", i.e. switch between failure / warning case and okay case repeatedly.
10731 If, for example, the threshold is configures as
10736 then a I<Warning> notification is created when the value exceeds I<101> and the
10737 corresponding I<Okay> notification is only created once the value falls below
10738 I<99>, thus avoiding the "flapping".
10742 =head1 FILTER CONFIGURATION
10744 Starting with collectd 4.6 there is a powerful filtering infrastructure
10745 implemented in the daemon. The concept has mostly been copied from
10746 I<ip_tables>, the packet filter infrastructure for Linux. We'll use a similar
10747 terminology, so that users that are familiar with iptables feel right at home.
10751 The following are the terms used in the remainder of the filter configuration
10752 documentation. For an ASCII-art schema of the mechanism, see
10753 L<"General structure"> below.
10759 A I<match> is a criteria to select specific values. Examples are, of course, the
10760 name of the value or it's current value.
10762 Matches are implemented in plugins which you have to load prior to using the
10763 match. The name of such plugins starts with the "match_" prefix.
10767 A I<target> is some action that is to be performed with data. Such actions
10768 could, for example, be to change part of the value's identifier or to ignore
10769 the value completely.
10771 Some of these targets are built into the daemon, see L<"Built-in targets">
10772 below. Other targets are implemented in plugins which you have to load prior to
10773 using the target. The name of such plugins starts with the "target_" prefix.
10777 The combination of any number of matches and at least one target is called a
10778 I<rule>. The target actions will be performed for all values for which B<all>
10779 matches apply. If the rule does not have any matches associated with it, the
10780 target action will be performed for all values.
10784 A I<chain> is a list of rules and possibly default targets. The rules are tried
10785 in order and if one matches, the associated target will be called. If a value
10786 is handled by a rule, it depends on the target whether or not any subsequent
10787 rules are considered or if traversal of the chain is aborted, see
10788 L<"Flow control"> below. After all rules have been checked, the default targets
10793 =head2 General structure
10795 The following shows the resulting structure:
10802 +---------+ +---------+ +---------+ +---------+
10803 ! Rule !->! Match !->! Match !->! Target !
10804 +---------+ +---------+ +---------+ +---------+
10807 +---------+ +---------+ +---------+
10808 ! Rule !->! Target !->! Target !
10809 +---------+ +---------+ +---------+
10816 +---------+ +---------+ +---------+
10817 ! Rule !->! Match !->! Target !
10818 +---------+ +---------+ +---------+
10826 =head2 Flow control
10828 There are four ways to control which way a value takes through the filter
10835 The built-in B<jump> target can be used to "call" another chain, i.E<nbsp>e.
10836 process the value with another chain. When the called chain finishes, usually
10837 the next target or rule after the jump is executed.
10841 The stop condition, signaled for example by the built-in target B<stop>, causes
10842 all processing of the value to be stopped immediately.
10846 Causes processing in the current chain to be aborted, but processing of the
10847 value generally will continue. This means that if the chain was called via
10848 B<Jump>, the next target or rule after the jump will be executed. If the chain
10849 was not called by another chain, control will be returned to the daemon and it
10850 may pass the value to another chain.
10854 Most targets will signal the B<continue> condition, meaning that processing
10855 should continue normally. There is no special built-in target for this
10862 The configuration reflects this structure directly:
10864 PostCacheChain "PostCache"
10865 <Chain "PostCache">
10866 <Rule "ignore_mysql_show">
10869 Type "^mysql_command$"
10870 TypeInstance "^show_"
10880 The above configuration example will ignore all values where the plugin field
10881 is "mysql", the type is "mysql_command" and the type instance begins with
10882 "show_". All other values will be sent to the C<rrdtool> write plugin via the
10883 default target of the chain. Since this chain is run after the value has been
10884 added to the cache, the MySQL C<show_*> command statistics will be available
10885 via the C<unixsock> plugin.
10887 =head2 List of configuration options
10891 =item B<PreCacheChain> I<ChainName>
10893 =item B<PostCacheChain> I<ChainName>
10895 Configure the name of the "pre-cache chain" and the "post-cache chain". The
10896 argument is the name of a I<chain> that should be executed before and/or after
10897 the values have been added to the cache.
10899 To understand the implications, it's important you know what is going on inside
10900 I<collectd>. The following diagram shows how values are passed from the
10901 read-plugins to the write-plugins:
10907 + - - - - V - - - - +
10908 : +---------------+ :
10911 : +-------+-------+ :
10914 : +-------+-------+ : +---------------+
10915 : ! Cache !--->! Value Cache !
10916 : ! insert ! : +---+---+-------+
10917 : +-------+-------+ : ! !
10918 : ! ,------------' !
10920 : +-------+---+---+ : +-------+-------+
10921 : ! Post-Cache +--->! Write-Plugins !
10922 : ! Chain ! : +---------------+
10923 : +---------------+ :
10925 : dispatch values :
10926 + - - - - - - - - - +
10928 After the values are passed from the "read" plugins to the dispatch functions,
10929 the pre-cache chain is run first. The values are added to the internal cache
10930 afterwards. The post-cache chain is run after the values have been added to the
10931 cache. So why is it such a huge deal if chains are run before or after the
10932 values have been added to this cache?
10934 Targets that change the identifier of a value list should be executed before
10935 the values are added to the cache, so that the name in the cache matches the
10936 name that is used in the "write" plugins. The C<unixsock> plugin, too, uses
10937 this cache to receive a list of all available values. If you change the
10938 identifier after the value list has been added to the cache, this may easily
10939 lead to confusion, but it's not forbidden of course.
10941 The cache is also used to convert counter values to rates. These rates are, for
10942 example, used by the C<value> match (see below). If you use the rate stored in
10943 the cache B<before> the new value is added, you will use the old, B<previous>
10944 rate. Write plugins may use this rate, too, see the C<csv> plugin, for example.
10945 The C<unixsock> plugin uses these rates too, to implement the C<GETVAL>
10948 Last but not last, the B<stop> target makes a difference: If the pre-cache
10949 chain returns the stop condition, the value will not be added to the cache and
10950 the post-cache chain will not be run.
10952 =item B<Chain> I<Name>
10954 Adds a new chain with a certain name. This name can be used to refer to a
10955 specific chain, for example to jump to it.
10957 Within the B<Chain> block, there can be B<Rule> blocks and B<Target> blocks.
10959 =item B<Rule> [I<Name>]
10961 Adds a new rule to the current chain. The name of the rule is optional and
10962 currently has no meaning for the daemon.
10964 Within the B<Rule> block, there may be any number of B<Match> blocks and there
10965 must be at least one B<Target> block.
10967 =item B<Match> I<Name>
10969 Adds a match to a B<Rule> block. The name specifies what kind of match should
10970 be performed. Available matches depend on the plugins that have been loaded.
10972 The arguments inside the B<Match> block are passed to the plugin implementing
10973 the match, so which arguments are valid here depends on the plugin being used.
10974 If you do not need any to pass any arguments to a match, you can use the
10979 Which is equivalent to:
10984 =item B<Target> I<Name>
10986 Add a target to a rule or a default target to a chain. The name specifies what
10987 kind of target is to be added. Which targets are available depends on the
10988 plugins being loaded.
10990 The arguments inside the B<Target> block are passed to the plugin implementing
10991 the target, so which arguments are valid here depends on the plugin being used.
10992 If you do not need any to pass any arguments to a target, you can use the
10997 This is the same as writing:
11004 =head2 Built-in targets
11006 The following targets are built into the core daemon and therefore need no
11007 plugins to be loaded:
11013 Signals the "return" condition, see the L<"Flow control"> section above. This
11014 causes the current chain to stop processing the value and returns control to
11015 the calling chain. The calling chain will continue processing targets and rules
11016 just after the B<jump> target (see below). This is very similar to the
11017 B<RETURN> target of iptables, see L<iptables(8)>.
11019 This target does not have any options.
11027 Signals the "stop" condition, see the L<"Flow control"> section above. This
11028 causes processing of the value to be aborted immediately. This is similar to
11029 the B<DROP> target of iptables, see L<iptables(8)>.
11031 This target does not have any options.
11039 Sends the value to "write" plugins.
11045 =item B<Plugin> I<Name>
11047 Name of the write plugin to which the data should be sent. This option may be
11048 given multiple times to send the data to more than one write plugin. If the
11049 plugin supports multiple instances, the plugin's instance(s) must also be
11054 If no plugin is explicitly specified, the values will be sent to all available
11057 Single-instance plugin example:
11063 Multi-instance plugin example:
11065 <Plugin "write_graphite">
11075 Plugin "write_graphite/foo"
11080 Starts processing the rules of another chain, see L<"Flow control"> above. If
11081 the end of that chain is reached, or a stop condition is encountered,
11082 processing will continue right after the B<jump> target, i.E<nbsp>e. with the
11083 next target or the next rule. This is similar to the B<-j> command line option
11084 of iptables, see L<iptables(8)>.
11090 =item B<Chain> I<Name>
11092 Jumps to the chain I<Name>. This argument is required and may appear only once.
11104 =head2 Available matches
11110 Matches a value using regular expressions.
11116 =item B<Host> I<Regex>
11118 =item B<Plugin> I<Regex>
11120 =item B<PluginInstance> I<Regex>
11122 =item B<Type> I<Regex>
11124 =item B<TypeInstance> I<Regex>
11126 =item B<MetaData> I<String> I<Regex>
11128 Match values where the given regular expressions match the various fields of
11129 the identifier of a value. If multiple regular expressions are given, B<all>
11130 regexen must match for a value to match.
11132 =item B<Invert> B<false>|B<true>
11134 When set to B<true>, the result of the match is inverted, i.e. all value lists
11135 where all regular expressions apply are not matched, all other value lists are
11136 matched. Defaults to B<false>.
11143 Host "customer[0-9]+"
11149 Matches values that have a time which differs from the time on the server.
11151 This match is mainly intended for servers that receive values over the
11152 C<network> plugin and write them to disk using the C<rrdtool> plugin. RRDtool
11153 is very sensitive to the timestamp used when updating the RRD files. In
11154 particular, the time must be ever increasing. If a misbehaving client sends one
11155 packet with a timestamp far in the future, all further packets with a correct
11156 time will be ignored because of that one packet. What's worse, such corrupted
11157 RRD files are hard to fix.
11159 This match lets one match all values B<outside> a specified time range
11160 (relative to the server's time), so you can use the B<stop> target (see below)
11161 to ignore the value, for example.
11167 =item B<Future> I<Seconds>
11169 Matches all values that are I<ahead> of the server's time by I<Seconds> or more
11170 seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11173 =item B<Past> I<Seconds>
11175 Matches all values that are I<behind> of the server's time by I<Seconds> or
11176 more seconds. Set to zero for no limit. Either B<Future> or B<Past> must be
11188 This example matches all values that are five minutes or more ahead of the
11189 server or one hour (or more) lagging behind.
11193 Matches the actual value of data sources against given minimumE<nbsp>/ maximum
11194 values. If a data-set consists of more than one data-source, all data-sources
11195 must match the specified ranges for a positive match.
11201 =item B<Min> I<Value>
11203 Sets the smallest value which still results in a match. If unset, behaves like
11206 =item B<Max> I<Value>
11208 Sets the largest value which still results in a match. If unset, behaves like
11211 =item B<Invert> B<true>|B<false>
11213 Inverts the selection. If the B<Min> and B<Max> settings result in a match,
11214 no-match is returned and vice versa. Please note that the B<Invert> setting
11215 only effects how B<Min> and B<Max> are applied to a specific value. Especially
11216 the B<DataSource> and B<Satisfy> settings (see below) are not inverted.
11218 =item B<DataSource> I<DSName> [I<DSName> ...]
11220 Select one or more of the data sources. If no data source is configured, all
11221 data sources will be checked. If the type handled by the match does not have a
11222 data source of the specified name(s), this will always result in no match
11223 (independent of the B<Invert> setting).
11225 =item B<Satisfy> B<Any>|B<All>
11227 Specifies how checking with several data sources is performed. If set to
11228 B<Any>, the match succeeds if one of the data sources is in the configured
11229 range. If set to B<All> the match only succeeds if all data sources are within
11230 the configured range. Default is B<All>.
11232 Usually B<All> is used for positive matches, B<Any> is used for negative
11233 matches. This means that with B<All> you usually check that all values are in a
11234 "good" range, while with B<Any> you check if any value is within a "bad" range
11235 (or outside the "good" range).
11239 Either B<Min> or B<Max>, but not both, may be unset.
11243 # Match all values smaller than or equal to 100. Matches only if all data
11244 # sources are below 100.
11250 # Match if the value of any data source is outside the range of 0 - 100.
11258 =item B<empty_counter>
11260 Matches all values with one or more data sources of type B<COUNTER> and where
11261 all counter values are zero. These counters usually I<never> increased since
11262 they started existing (and are therefore uninteresting), or got reset recently
11263 or overflowed and you had really, I<really> bad luck.
11265 Please keep in mind that ignoring such counters can result in confusing
11266 behavior: Counters which hardly ever increase will be zero for long periods of
11267 time. If the counter is reset for some reason (machine or service restarted,
11268 usually), the graph will be empty (NAN) for a long time. People may not
11273 Calculates a hash value of the host name and matches values according to that
11274 hash value. This makes it possible to divide all hosts into groups and match
11275 only values that are in a specific group. The intended use is in load
11276 balancing, where you want to handle only part of all data and leave the rest
11279 The hashing function used tries to distribute the hosts evenly. First, it
11280 calculates a 32E<nbsp>bit hash value using the characters of the hostname:
11283 for (i = 0; host[i] != 0; i++)
11284 hash_value = (hash_value * 251) + host[i];
11286 The constant 251 is a prime number which is supposed to make this hash value
11287 more random. The code then checks the group for this host according to the
11288 I<Total> and I<Match> arguments:
11290 if ((hash_value % Total) == Match)
11295 Please note that when you set I<Total> to two (i.E<nbsp>e. you have only two
11296 groups), then the least significant bit of the hash value will be the XOR of
11297 all least significant bits in the host name. One consequence is that when you
11298 have two hosts, "server0.example.com" and "server1.example.com", where the host
11299 name differs in one digit only and the digits differ by one, those hosts will
11300 never end up in the same group.
11306 =item B<Match> I<Match> I<Total>
11308 Divide the data into I<Total> groups and match all hosts in group I<Match> as
11309 described above. The groups are numbered from zero, i.E<nbsp>e. I<Match> must
11310 be smaller than I<Total>. I<Total> must be at least one, although only values
11311 greater than one really do make any sense.
11313 You can repeat this option to match multiple groups, for example:
11318 The above config will divide the data into seven groups and match groups three
11319 and five. One use would be to keep every value on two hosts so that if one
11320 fails the missing data can later be reconstructed from the second host.
11326 # Operate on the pre-cache chain, so that ignored values are not even in the
11331 # Divide all received hosts in seven groups and accept all hosts in
11335 # If matched: Return and continue.
11338 # If not matched: Return and stop.
11344 =head2 Available targets
11348 =item B<notification>
11350 Creates and dispatches a notification.
11356 =item B<Message> I<String>
11358 This required option sets the message of the notification. The following
11359 placeholders will be replaced by an appropriate value:
11367 =item B<%{plugin_instance}>
11371 =item B<%{type_instance}>
11373 These placeholders are replaced by the identifier field of the same name.
11375 =item B<%{ds:>I<name>B<}>
11377 These placeholders are replaced by a (hopefully) human readable representation
11378 of the current rate of this data source. If you changed the instance name
11379 (using the B<set> or B<replace> targets, see below), it may not be possible to
11380 convert counter values to rates.
11384 Please note that these placeholders are B<case sensitive>!
11386 =item B<Severity> B<"FAILURE">|B<"WARNING">|B<"OKAY">
11388 Sets the severity of the message. If omitted, the severity B<"WARNING"> is
11395 <Target "notification">
11396 Message "Oops, the %{type_instance} temperature is currently %{ds:value}!"
11402 Replaces parts of the identifier using regular expressions.
11408 =item B<Host> I<Regex> I<Replacement>
11410 =item B<Plugin> I<Regex> I<Replacement>
11412 =item B<PluginInstance> I<Regex> I<Replacement>
11414 =item B<TypeInstance> I<Regex> I<Replacement>
11416 =item B<MetaData> I<String> I<Regex> I<Replacement>
11418 =item B<DeleteMetaData> I<String> I<Regex>
11420 Match the appropriate field with the given regular expression I<Regex>. If the
11421 regular expression matches, that part that matches is replaced with
11422 I<Replacement>. If multiple places of the input buffer match a given regular
11423 expression, only the first occurrence will be replaced.
11425 You can specify each option multiple times to use multiple regular expressions
11433 # Replace "example.net" with "example.com"
11434 Host "\\<example.net\\>" "example.com"
11436 # Strip "www." from hostnames
11437 Host "\\<www\\." ""
11442 Sets part of the identifier of a value to a given string.
11448 =item B<Host> I<String>
11450 =item B<Plugin> I<String>
11452 =item B<PluginInstance> I<String>
11454 =item B<TypeInstance> I<String>
11456 =item B<MetaData> I<String> I<String>
11458 Set the appropriate field to the given string. The strings for plugin instance,
11459 type instance, and meta data may be empty, the strings for host and plugin may
11460 not be empty. It's currently not possible to set the type of a value this way.
11462 The following placeholders will be replaced by an appropriate value:
11470 =item B<%{plugin_instance}>
11474 =item B<%{type_instance}>
11476 These placeholders are replaced by the identifier field of the same name.
11478 =item B<%{meta:>I<name>B<}>
11480 These placeholders are replaced by the meta data value with the given name.
11484 Please note that these placeholders are B<case sensitive>!
11486 =item B<DeleteMetaData> I<String>
11488 Delete the named meta data field.
11495 PluginInstance "coretemp"
11496 TypeInstance "core3"
11501 =head2 Backwards compatibility
11503 If you use collectd with an old configuration, i.E<nbsp>e. one without a
11504 B<Chain> block, it will behave as it used to. This is equivalent to the
11505 following configuration:
11507 <Chain "PostCache">
11511 If you specify a B<PostCacheChain>, the B<write> target will not be added
11512 anywhere and you will have to make sure that it is called where appropriate. We
11513 suggest to add the above snippet as default target to your "PostCache" chain.
11517 Ignore all values, where the hostname does not contain a dot, i.E<nbsp>e. can't
11532 B<Ignorelists> are a generic framework to either ignore some metrics or report
11533 specific metircs only. Plugins usually provide one or more options to specify
11534 the items (mounts points, devices, ...) and the boolean option
11539 =item B<Select> I<String>
11541 Selects the item I<String>. This option often has a plugin specific name, e.g.
11542 B<Sensor> in the C<sensors> plugin. It is also plugin specific what this string
11543 is compared to. For example, the C<df> plugin's B<MountPoint> compares it to a
11544 mount point and the C<sensors> plugin's B<Sensor> compares it to a sensor name.
11546 By default, this option is doing a case-sensitive full-string match. The
11547 following config will match C<foo>, but not C<Foo>:
11551 If I<String> starts and ends with C</> (a slash), the string is compiled as a
11552 I<regular expression>. For example, so match all item starting with C<foo>, use
11553 could use the following syntax:
11557 The regular expression is I<not> anchored, i.e. the following config will match
11558 C<foobar>, C<barfoo> and C<AfooZ>:
11562 The B<Select> option may be repeated to select multiple items.
11564 =item B<IgnoreSelected> B<true>|B<false>
11566 If set to B<true>, matching metrics are I<ignored> and all other metrics are
11567 collected. If set to B<false>, matching metrics are I<collected> and all other
11568 metrics are ignored.
11575 L<collectd-exec(5)>,
11576 L<collectd-perl(5)>,
11577 L<collectd-unixsock(5)>,
11590 Florian Forster E<lt>octo@collectd.orgE<gt>