X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=187133cdb90e481392bcd3a9e9f75403f760b25c;hb=e04cfcb9d1f1eed00bf11768db6d0540babe2e4e;hp=2fe82879dcf1f44bd301de2665a3f71b083de4ea;hpb=1a938b180c586f8b6c2c9fec05c9a10d4d15bb3f;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 2fe82879..187133cd 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 @@ -1697,21 +1738,29 @@ values (two registers interpreted as IEEE floats in big endian notation). Synopsis: - - RegisterBase 1234 + + RegisterBase 0 RegisterType float - Type gauge - Instance "..." + Type voltage + Instance "input-1" - - Address "addr" - Port "1234" + + RegisterBase 2 + RegisterType float + Type voltage + Instance "input-2" + + + + Address "192.168.0.42" + Port "502" Interval 60 - + - Instance "foobar" # optional - Collect "data_name" + Instance "power-supply" + Collect "voltage-input-1" + Collect "voltage-input-2" @@ -1862,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 @@ -1895,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 @@ -2504,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> @@ -2552,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> @@ -2646,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. @@ -2916,7 +2987,7 @@ 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 expecially interesting when B is disabled, but +This is especially interesting when B is disabled, but can be configured independently from that option. Defaults to B. =back @@ -2988,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