X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=e5a5c754327b84c507bf7531ed31eebf6c67a9e3;hb=e2b289ea039269b60edd459d2d514d3f82820e3a;hp=a7a5816753a0bc1b3fb69fafdb447ad38ad43121;hpb=1b6906d2288a984af21f43aabc3d71d3d1024b1b;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index a7a58167..e5a5c754 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -150,12 +150,27 @@ plugins that don't provide any configuration, e.g. the I. When set to B, various statistics about the I daemon will be collected, with "collectd" as the I. Defaults to B. -The "write_queue" I reports the number of elements currently -queued and the number of elements dropped off the queue by the -B/B mechanism. +The following metrics are reported: -The "cache" I reports the number of elements in the value list -cache (the cache you can interact with using L). +=over 4 + +=item C + +The number of metrics currently in the write queue. You can limit the queue +length with the B and B options. + +=item C + +The number of metrics dropped due to a queue length limitation. +If this value is non-zero, your system can't handle all incoming metrics and +protects itself against overload by dropping metrics. + +=item C + +The number of elements in the metric cache (the cache you can interact with +using L). + +=back =item B I [I] @@ -184,9 +199,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 @@ -382,13 +395,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. @@ -463,19 +476,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 * ... @@ -501,7 +514,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. @@ -1345,11 +1358,11 @@ as Jiffies, using the C type. Two aggregations are available: =over 4 -=item +=item * Sum, per-state, over all CPUs installed in the system; and -=item +=item * Sum, per-CPU, over all non-idle states of a CPU, creating an "active" state. @@ -1546,7 +1559,7 @@ setting accordingly to prevent this from blocking other plugins. =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 @@ -2264,6 +2277,27 @@ expected from them. This is documented in great detail in L. =back +=head2 Plugin C + +The C plugin provides statistics about used, unused and total number of +file handles on Linux. + +The I provides the following configuration options: + +=over 4 + +=item B B|B + +Enables or disables reporting of file handles usage in absolute numbers, +e.g. file handles used. Defaults to B. + +=item B B|B + +Enables or disables reporting of file handles usage in percentages, e.g. +percent of file handles used. Defaults to B. + +=back + =head2 Plugin C The C plugin counts the number of files in a certain directory (and @@ -2468,7 +2502,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 @@ -2477,6 +2511,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 @@ -2517,9 +2568,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 @@ -4250,6 +4305,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 @@ -5392,6 +5459,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 @@ -6587,6 +6657,79 @@ Default: B<1978> =back +=head2 Plugin C + +The I reads CPU frequency and C-state residency on modern +Intel processors by using the new Model Specific Registers. + +=over 4 + +=item B I + +Bitmask of the list of core C states supported by the processor. +This option should only be used if the automated detection fails. +Default value extracted from the cpu model and family. + +Currently supported C-states (by this plugin): 3, 6, 7 + +Example: (1<<3)+(1<<6)+(1<<7) = 392 for all states + +=item B I + +Bitmask of the list of pacages C states supported by the processor. +This option should only be used if the automated detection fails. +Default value extracted from the cpu model and family. + +Currently supported C-states (by this plugin): 2, 3, 6, 7, 8, 9, 10 + +Example: (1<<2)+(1<<3)+(1<<6)+(1<<7) = 396 for states 2, 3, 6 and 7 + +=item B I|I + +Boolean enabling the collection of the I/O System-Management Interrupt +counter'. This option should only be used if the automated detection +fails or if you want to disable this feature. + +=item B I|I + +Boolean enabling the collection of the temperature of each core. +This option should only be used if the automated detectionfails or +if you want to disable this feature. + +=item B I|I + +Boolean enabling the collection of the temperature of each package. +This option should only be used if the automated detectionfails or +if you want to disable this feature. + +=item B I + +Thermal Control Circuit Activation Temperature of the installed +CPU. This temperature is used when collecting the temperature of +cores or packages. This option should only be used if the automated +detection fails. Default value extracted from B + +=item B I + +Bitmask of the list of elements to be thermally monitored. This option +should only be used if the automated detection fails or if you want to +disable some collections. The different bits of this bitmask accepted +by this plugin are: + +=over 4 + +=item 0 ('1'): Package + +=item 1 ('2'): DRAM + +=item 2 ('4'): Cores + +=item 3 ('8'): Embedded graphic device + +=back + +=back + =head2 Plugin C =over 4 @@ -6627,20 +6770,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. @@ -6882,6 +7025,10 @@ 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">). +At the moment of writing (collectd-5.5), hostname string is limited to 62 +characters. In case when combination of fields exceeds 62 characters, +hostname will be truncated without a warning. + =item B B|B
When the virt plugin logs interface data, it sets the name of the collected @@ -6900,6 +7047,10 @@ by the hypervisor, which is equal to setting B. B means use the guest's UUID. +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">). + =back =head2 Plugin C @@ -7372,7 +7523,7 @@ Synopsis: Values are submitted to I, using the metric name as the key, and the timestamp as the score. Retrieving a date range can then be done using the -C I command. Additionnally, all the identifiers of these +C I command. Additionally, all the identifiers of these I are kept in a I called C and can be retrieved using the C I command. See L and L for @@ -7390,9 +7541,9 @@ options are available: =item B I The B block identifies a new I node, that is a new I -instance running in an specified host and port. The name for node is a +instance running on a specified host and port. The node name is a canonical identifier which is used as I. It is limited to -64Echaracters in length. +51Echaracters in length. =item B I @@ -7488,7 +7639,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.