X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=f85c7e799291354756f04ce53c022cfd386fb147;hb=4371ef7f98f6f51ea3df34d5e26e175d6b44a328;hp=0c346ca79a6f8914bb134e372e24f82747a3abf4;hpb=491b8f0185c63c662bb3f395630a6d8b9913b49e;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 0c346ca7..f85c7e79 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -172,9 +172,7 @@ I may be specified to filter which files to include. This may be used in combination with recursively including a directory to easily be able to arbitrarily mix configuration files and other documents (e.g. README files). The given example is similar to the first example above but includes all files -matching C<*.conf> in any subdirectory of C: - - Include "/etc/collectd.d" "*.conf" +matching C<*.conf> in any subdirectory of C. =back @@ -359,13 +357,13 @@ There are a couple of limitations you should be aware of: =over 4 -=item +=item * The I cannot be left unspecified, because it is not reasonable to add apples to oranges. Also, the internal lookup structure won't work if you try to group by type. -=item +=item * There must be at least one unspecified, ungrouped field. Otherwise nothing will be aggregated. @@ -440,19 +438,19 @@ This will create the files: =over 4 -=item +=item * foo.example.com/cpu-even-average/cpu-idle -=item +=item * foo.example.com/cpu-even-average/cpu-system -=item +=item * foo.example.com/cpu-even-average/cpu-user -=item +=item * ... @@ -478,7 +476,7 @@ are disabled by default. =head2 Plugin C -The I can be used to communicate with other instances of +The I can be used to communicate with other instances of I or third party applications using an AMQP message broker. Values are sent to or received from the broker, which handles routing, queueing and possibly filtering or messages. @@ -502,7 +500,7 @@ possibly filtering or messages. # GraphiteSeparateInstances false # GraphiteAlwaysAppendDS false - + # Receive values from an AMQP broker Host "localhost" @@ -1116,7 +1114,7 @@ is set to B, B blocks are optional. =head2 Plugin C The B collects values from JSON data to be parsed by -B (L) retrieved via +B (L) retrieved via either B (L) or read directly from a unix socket. The former can be used, for example, to collect values from CouchDB documents (which are stored JSON notation), and the @@ -1177,11 +1175,17 @@ The following options are valid within B blocks: Sets the plugin instance to I. =item B I + =item B I + =item B B|B + =item B B|B + =item B I + =item B
I
+ =item B I These options behave exactly equivalent to the appropriate options of the @@ -1993,7 +1997,7 @@ a more detailed description see B below. =item B I|I -If no configuration if given, the B-plugin will collect data from +If no configuration if given, the B-plugin will collect data from all interfaces. This may not be practical, especially for loopback- and similar interfaces. Thus, you can use the B-option to pick the interfaces you're interested in. Sometimes, however, it's easier/preferred @@ -2002,6 +2006,23 @@ do that: By setting B to I the effect of B is inverted: All selected interfaces are ignored and all other interfaces are collected. +It is possible to use regular expressions to match interface names, if the +name is surrounded by I and collectd was compiled with support for +regexps. This is useful if there's a need to collect (or ignore) data +for a group of interfaces that are similarly named, without the need to +explicitly list all of them (especially useful if the list is dynamic). +Example: + + Interface "lo" + Interface "/^veth/" + Interface "/^tun[0-9]+/" + IgnoreSelected "true" + +This will ignore the loopback interface, all interfaces with names starting +with I and all interfaces with names starting with I followed by +at least one digit. + + =back =head2 Plugin C @@ -2042,9 +2063,13 @@ a notification is sent. =item B I I [I [I]] -Select the rules to count. If only I
and I are given, this plugin -will collect the counters of all rules which have a comment-match. The comment -is then used as type-instance. +=item B I
I [I [I]] + +Select the iptables/ip6tables filter rules to count packets and bytes from. + +If only I
and I are given, this plugin will collect the counters +of all rules which have a comment-match. The comment is then used as +type-instance. If I or I is given, only the rule with the matching comment or the Ith rule will be collected. Again, the comment (or the number) will be @@ -3730,6 +3755,18 @@ Default: C =head2 Plugin C +The C plugin collects per-peer ntp data such as time offset and time +dispersion. + +For talking to B, it mimics what the B control program does on +the wire - using B specific requests. This mode is deprecated with +newer B releases (4.2.7p230 and later). For the C plugin to work +correctly with them, the ntp daemon must be explicitly configured to +enable B (which is disabled by default). Refer to the I +manual page for details. + +Available configuration options for the C plugin: + =over 4 =item B I @@ -4763,6 +4800,9 @@ collected for these selected processes are size of the resident segment size (RSS), user- and system-time used, number of processes and number of threads, io data (where available) and minor and major pagefaults. +Some platforms have a limit on the length of process names. I must stay +below this limit. + =item B I I Similar to the B option this allows to select more detailed @@ -4940,7 +4980,7 @@ that numerical port numbers must be given as a string, too. Use I to authenticate when connecting to I. -=item B I +=item B I The B option set the socket timeout for node response. Since the Redis read function is blocking, you should keep this value as low as possible. Keep @@ -5918,20 +5958,20 @@ The following methods are used to find the machine's UUID, in order: =over 4 -=item +=item * Check I (or I). -=item +=item * Check for UUID from HAL (L) if present. -=item +=item * Check for UUID from C / SMBIOS. -=item +=item * Check for UUID from Xen hypervisor. @@ -6224,7 +6264,7 @@ Hostname or address to connect to. Defaults to C. Service name or port number to connect to. Defaults to C<27017>. -=item B I +=item B I Set the timeout for each operation on I to I milliseconds. Setting this option to zero means no timeout, which is the default. @@ -6360,7 +6400,7 @@ The B option is the TCP port on which the Redis instance accepts connections. Either a service name of a port number may be given. Please note that numerical port numbers must be given as a string, too. -=item B I +=item B I The B option sets the socket connection timeout, in milliseconds. @@ -6423,7 +6463,7 @@ C. =item B B|B -If set the B, append the name of the I (DS) to the +If set to B, append the name of the I (DS) to the "service", i.e. the field that, together with the "host" field, uniquely identifies a metric in I. If set to B (the default), this is only done when there is more than one DS.