X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=62374b625cb204ab9aa3f6dc9c6a8f73fa8c5e37;hb=535d74438fc722d0ac1720103a289feb77ceb3ed;hp=09508f70add086d1360357363132b6f7eedf9203;hpb=ef62964e864cdb06b95c537a7598b89afb6c155b;p=collectd.git
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 09508f70..62374b62 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -57,6 +57,33 @@ directory for the daemon.
Loads the plugin I. There must be at least one such line or B
will be mostly useless.
+Starting with collectd 4.9, this may also be a block in which further options
+affecting the behavior of B may be specified. The following
+options are allowed inside a B block:
+
+
+ Globals true
+
+
+=over 4
+
+=item B B
+
+If enabled, collectd will export all global symbols of the plugin (and of all
+libraries loaded as dependencies of the plugin) and, thus, makes those symbols
+available for resolving unresolved symbols in subsequently loaded plugins if
+that is supported by your system. By default, this is disabled.
+
+This is useful (or possibly even required), e.Eg., when loading a plugin
+that embeds some scripting language into the daemon (e.Eg. the C
+or C plugins). Scripting languages usually provide means to load
+extensions written in C. Those extensions require symbols provided by the
+interpreter, which is loaded as a dependency of the respective collectd
+plugin. See the documentation of those plugins (e.Eg.,
+L or L) for details.
+
+=back
+
=item B I
If I points to a file, includes that file. If I points to a
@@ -102,6 +129,20 @@ Configures the interval in which to query the read plugins. Obviously smaller
values lead to a higher system load produced by collectd, while higher values
lead to more coarse statistics.
+B You should set this once and then never touch it again. If you do,
+I or know some serious RRDtool
+magic! (Assuming you're using the I or I plugin.)
+
+=item B I
+
+Consider a value list "missing" when no update has been read or received for
+I iterations. By default, I considers a value list
+missing when no update has been received for twice the update interval. Since
+this setting uses iterations, the maximum allowed time without update depends
+on the I information contained in each value list. This is used in
+the I configuration to dispatch notifications about missing values,
+see L<"THRESHOLD CONFIGURATION"> below.
+
=item B I
Number of threads to start for reading plugins. The default value is B<5>, but
@@ -644,7 +685,7 @@ The B uses B (L) and B
In the B block, there may be one or more B blocks, each defining a
-URL to be fetched via HTTP (using libcurl). Within each B block there are
+URL to be fetched using libcurl. Within each B block there are
options which specify the connection parameters, for example authentication
information, and one or more B blocks.
@@ -1583,6 +1624,11 @@ running in foreground- or non-daemon-mode.
Prefix all lines printed by the current time. Defaults to B.
+=item B B|B
+
+When enabled, all lines are prefixed by the severity of the log message, for
+example "warning". Defaults to B.
+
=back
B: There is no need to notify the daemon after moving or removing the
@@ -1683,6 +1729,132 @@ TCP-Port to connect to. Defaults to B<11211>.
=back
+=head2 Plugin C
+
+The B connects to a Modbus "slave" via Modbus/TCP and reads
+register values. It supports reading single registers (unsigned 16Ebit
+values), large integer values (unsigned 32Ebit values) and floating point
+values (two registers interpreted as IEEE floats in big endian notation).
+
+Synopsis:
+
+
+ RegisterBase 0
+ RegisterType float
+ Type voltage
+ Instance "input-1"
+
+
+
+ RegisterBase 2
+ RegisterType float
+ Type voltage
+ Instance "input-2"
+
+
+
+ Address "192.168.0.42"
+ Port "502"
+ Interval 60
+
+
+ Instance "power-supply"
+ Collect "voltage-input-1"
+ Collect "voltage-input-2"
+
+
+
+=over 4
+
+=item EB IE blocks
+
+Data blocks define a mapping between register numbers and the "types" used by
+I.
+
+Within EDataE/E blocks, the following options are allowed:
+
+=over 4
+
+=item B I
+
+Configures the base register to read from the device. If the option
+B has been set to B or B, this and the next
+register will be read (the register number is increased by one).
+
+=item B B|B|B
+
+Specifies what kind of data is returned by the device. If the type is B
+or B, two 16Ebit registers will be read and the data is combined
+into one value. Defaults to B.
+
+=item B I
+
+Specifies the "type" (data set) to use when dispatching the value to
+I. Currently, only data sets with exactly one data source are
+supported.
+
+=item B I
+
+Sets the type instance to use when dispatching the value to I. If
+unset, an empty string (no type instance) is used.
+
+=back
+
+=item EB IE blocks
+
+Host blocks are used to specify to which hosts to connect and what data to read
+from their "slaves". The string argument I is used as hostname when
+dispatching the values to I.
+
+Within EHostE/E blocks, the following options are allowed:
+
+=over 4
+
+=item B I
+
+Specifies the node name (the actual network address) used to connect to the
+host. This may be an IP address or a hostname. Please note that the used
+I library only supports IPv4 at the moment.
+
+=item B I
+
+Specifies the port used to connect to the host. The port can either be given as
+a number or as a service name. Please note that the I argument must be
+a string, even if ports are given in their numerical form. Defaults to "502".
+
+=item B I
+
+Sets the interval (in seconds) in which the values will be collected from this
+host. By default the global B setting will be used.
+
+=item EB IE
+
+Over each TCP connection, multiple Modbus devices may be reached. The slave ID
+is used to specify which device should be addressed. For each device you want
+to query, one B block must be given.
+
+Within ESlaveE/E blocks, the following options are allowed:
+
+=over 4
+
+=item B I
+
+Specify the plugin instance to use when dispatching the values to I.
+By default "slave_I" is used.
+
+=item B I
+
+Specifies which data to retrieve from the device. I must be the same
+string as the I argument passed to a B block. You can specify this
+option multiple times to collect more than one value from a slave. At least one
+B option is mandatory.
+
+=back
+
+=back
+
+=back
+
=head2 Plugin C
The C requires B to be installed. It connects to
@@ -1739,8 +1911,10 @@ Hostname of the database server. Defaults to B.
=item B I
Username to use when connecting to the database. The user does not have to be
-granted any privileges (which is synonym to granting the C privilege).
-Any existing MySQL user will do.
+granted any privileges (which is synonym to granting the C privilege),
+unless you want to collectd replication statistics (see B and
+B below). In this case, the user needs the C
+(or C) privileges. Else, any existing MySQL user will do.
=item B I
@@ -1772,7 +1946,9 @@ C function for details.
=item B I
-Enable the collection of master / slave statistics in a replication setup.
+Enable the collection of master / slave statistics in a replication setup. In
+order to be able to get access to these statistics, the user needs special
+privileges. See the B documentation above.
=item B I
@@ -2381,6 +2557,15 @@ B require this setting.
This feature is only available if the I plugin was linked with
I.
+=item B I
+
+Set the outgoing interface for IP packets. This applies at least
+to IPv6 packets and if possible to IPv4. If this option is not applicable,
+undefined or a non-existent interface name is specified, the default
+behavior is to let the kernel choose the appropriate interface. Be warned
+that the manual selection of an interface for unicast traffic is only
+necessary in rare cases.
+
=back
=item BListen> I [I]B>
@@ -2429,6 +2614,14 @@ Each time a packet is received, the modification time of the file is checked
using L. If the file has been changed, the contents is re-read. While
the file is being read, it is locked using L.
+=item B I
+
+Set the incoming interface for IP packets explicitly. This applies at least
+to IPv6 packets and if possible to IPv4. If this option is not applicable,
+undefined or a non-existent interface name is specified, the default
+behavior is, to let the kernel choose the appropriate interface. Thus incoming
+traffic gets only accepted, if it arrives on the given interface.
+
=back
=item B I<1-255>
@@ -2523,7 +2716,8 @@ and are checked by default depends on the distribution you use.
This plugin sends a desktop notification to a notification daemon, as defined
in the Desktop Notification Specification. To actually display the
notifications, B is required and B has to be
-able to access the X server.
+able to access the X server (i.Ee., the C and C
+environment variables have to be set correctly) and the D-Bus message bus.
The Desktop Notification Specification can be found at
L.
@@ -2771,12 +2965,31 @@ Available options:
Specifies the location of the status file.
-=item B B|B
+=item B B|B
+
+When enabled, the filename of the status file will be used as plugin instance
+and the client's "common name" will be used as type instance. This is required
+when reading multiple status files. Enabling this option is recommended, but to
+maintain backwards compatibility this option is disabled by default.
+
+=item B B|B
Sets whether or not statistics about the compression used by OpenVPN should be
collected. This information is only available in I mode. Enabled by
default.
+=item B B|B
+
+Sets whether or not traffic information is collected for each connected client
+individually. If set to false, currently no traffic data is collected at all
+because aggregating this data in a save manner is tricky. Defaults to B.
+
+=item B B|B
+
+When enabled, the number of currently connected clients or users is collected.
+This is especially interesting when B is disabled, but
+can be configured independently from that option. Defaults to B.
+
=back
=head2 Plugin C
@@ -2846,6 +3059,83 @@ refer to them from.
This plugin embeds a Perl-interpreter into collectd and provides an interface
to collectd's plugin system. See L for its documentation.
+=head2 Plugin C
+
+The I receives profiling information from I, an extension
+for the I interpreter. At the end of executing a script, i.e. after a
+PHP-based webpage has been delivered, the extension will send a UDP packet
+containing timing information, peak memory usage and so on. The plugin will
+wait for such packets, parse them and account the provided information, which
+is then dispatched to the daemon once per interval.
+
+Synopsis:
+
+
+ Address "::0"
+ Port "30002"
+ # Overall statistics for the website.
+
+ Server "www.example.com"
+
+ # Statistics for www-a only
+
+ Host "www-a.example.com"
+ Server "www.example.com"
+
+ # Statistics for www-b only
+
+ Host "www-b.example.com"
+ Server "www.example.com"
+
+
+
+The plugin provides the following configuration options:
+
+=over 4
+
+=item B I
+
+Configures the address used to open a listening socket. By default, plugin will
+bind to the I address C<::0>.
+
+=item B I
+
+Configures the port (service) to bind to. By default the default Pinba port
+"30002" will be used. The option accepts service names in addition to port
+numbers and thus requires a I argument.
+
+=item EB IE block
+
+The packets sent by the Pinba extension include the hostname of the server, the
+server name (the name of the virtual host) and the script that was executed.
+Using B blocks it is possible to separate the data into multiple groups
+to get more meaningful statistics. Each packet is added to all matching groups,
+so that a packet may be accounted for more than once.
+
+=over 4
+
+=item B I
+
+Matches the hostname of the system the webserver / script is running on. This
+will contain the result of the L system call. If not
+configured, all hostnames will be accepted.
+
+=item B I
+
+Matches the name of the I, i.e. the contents of the
+C<$_SERVER["SERVER_NAME"]> variable when within PHP. If not configured, all
+server names will be accepted.
+
+=item B