X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=1d479b5a045ca2c9d224b3fc3ac460f52ad43b7d;hb=7b814553432aec88ec454db4f3b4655b9657d4d2;hp=45e2fac0fe1ee4e013ef8cdcb3df99e2bc744c21;hpb=74525016b183d71f0a5685fa54507078f3f82640;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 45e2fac0..1d479b5a 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -102,6 +102,16 @@ 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. +=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 @@ -112,19 +122,14 @@ a value higher than the number of plugins you've loaded is totally useless. =item B I Sets the hostname that identifies a host. If you omit this setting, the -hostname will be determinded using the L system call. +hostname will be determined using the L system call. =item B B If B is determined automatically this setting controls whether or not the daemon should try to figure out the "fully qualified domain name", FQDN. -This is done using a lookup of the name returned by C. - -Using this feature (i.Ee. setting this option to B) is recommended. -However, to preserve backwards compatibility the default is set to B. -The sample config file that is installed with Cinstall> includes a -line which sets this option, though, so that default installations will have -this setting enabled. +This is done using a lookup of the name returned by C. This option +is enabled by default. =item B I @@ -443,7 +448,7 @@ The curl plugin uses the B (L) to read web pages and the match infrastructure (the same code used by the tail plugin) to use regular expressions with the received data. -The following example will read the current value of AMD stock from google's +The following example will read the current value of AMD stock from Google's finance page and dispatch the value to collectd. @@ -562,9 +567,9 @@ The following example will collect the status values from each database: In the B block, there may be one or more B blocks, each defining a URL to be fetched via HTTP (using libcurl) and one or more B blocks. -The B string argument must be in a path format, of which is used to collect -a value from a JSON map object. If a B path element is that of a I<*> wildcard, -the values for all keys will be collectd. +The B string argument must be in a path format, which is used to collect a +value from a JSON map object. If a path element of B is the +I<*>Ewildcard, the values for all keys will be collectd. The following options are valid within B blocks: @@ -773,7 +778,7 @@ The following is a complete list of options: Query blocks define I statements and how the returned data should be interpreted. They are identified by the name that is given in the opening line of the block. Thus the name needs to be unique. Other than that, the name is -not used in collectd. +not used in collectd. In each B block, there is one or more B blocks. B blocks define which column holds which value or instance information. You can use @@ -831,7 +836,7 @@ options to provide multiple queries with the same name but with a slightly different syntax. The plugin will use only those queries, where the specified minimum and maximum versions fit the version of the database in use. -The database version is determined by C, see the +The database version is determined by C, see the L for details. Basically, each part of the version is assumed to be in the range from B<00> to B<99> and all dots are removed. So version "4.1.2" becomes @@ -1056,7 +1061,7 @@ is set to B, all disks are collected B the ones matched. =item B I -The dns plugin uses B to capture dns traffic and analyses it. This +The dns plugin uses B to capture dns traffic and analyzes it. This option sets the interface that should be used. If this option is not set, or set to "any", the plugin will try to get packets from B interfaces. This may not work on certain platforms, such as MacEOSEX. @@ -1558,6 +1563,16 @@ You can also specify combinations of these fields. For example B means to concatenate the guest name and UUID (with a literal colon character between, thus I<"foo:1234-1234-1234-1234">). +=item B B|B
+ +When the libvirt plugin logs interface data, it sets the name of the collected +data according to this setting. The default is to use the path as provided by +the hypervisor (the "dev" property of the target node), which is equal to +setting B. + +B
means use the interface's mac address. This is useful since the +interface path might change between reboots of a guest or across migrations. + =back =head2 Plugin C @@ -1583,6 +1598,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 +1703,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 @@ -1783,7 +1929,7 @@ or SQL threads are not running. =head2 Plugin C -The netapp plugin can collect various performance and capacity informations +The netapp plugin can collect various performance and capacity information from a NetApp filer using the NetApp API. Please note that NetApp has a wide line of products and a lot of different @@ -2307,7 +2453,7 @@ Here are some examples to help you understand the above text more easily: =item B -The behaviour is the same as with all other similar plugins: If nothing is +The behavior is the same as with all other similar plugins: If nothing is selected at all, everything is collected. If some things are selected using the options described above, only these statistics are collected. If you set B to B, this behavior is inverted, i.Ee. the @@ -2319,7 +2465,7 @@ specified statistics will not be collected. The Network plugin sends data to a remote instance of collectd, receives data from a remote instance, or both at the same time. Data which has been received -from the network is usually not transmitted again, but this can be actived, see +from the network is usually not transmitted again, but this can be activated, see the B option below. The default IPv6 multicast group is C. The default IPv4 @@ -2381,6 +2527,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 +2584,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> @@ -2613,7 +2776,7 @@ UDP-Port to connect to. Defaults to B<123>. =item B B|B -Sets wether or not to perform reverse lookups on peers. Since the name or +Sets whether or not to perform reverse lookups on peers. Since the name or IP-address may be used in a filename it is recommended to disable reverse lookups. The default is to do reverse lookups to preserve backwards compatibility, though. @@ -2771,12 +2934,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 +3028,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