X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=e476c48f1127533839d4cccbbc19c15ecf16245b;hb=dd09c9364998ad6ef681b70f45f7a9734808cf96;hp=9ec3a208ca05db8a746b1c39ed70ffb8a897cccd;hpb=24c2f247f6dc5c17b26d715346a380efababb08f;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 9ec3a208..e476c48f 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 @@ -219,6 +232,12 @@ Path to the plugins (shared objects) of collectd. Set one or more files that contain the data-set descriptions. See L for a description of the format of this file. +If this option is not specified, a default file is read. If you need to define +custom types in addition to the types defined in the default file, you need to +explicitly load both. In other words, if the B option is encountered +the default behavior is disabled and if you need the default types you have to +also explicitly load them. + =item B I Configures the interval in which to query the read plugins. Obviously smaller @@ -382,13 +401,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 +482,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 +520,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. @@ -918,7 +937,7 @@ support the SM Bus command subset). The reduction or normalization to mean sea level pressure requires (depending on selected method/approximation) also altitude and reference to temperature -sensor(s). When multiple temperature sensors are configured the minumum of +sensor(s). When multiple temperature sensors are configured the minimum of their values is always used (expecting that the warmer ones are affected by e.g. direct sun light at that moment). @@ -1030,7 +1049,7 @@ The altitude (in meters) of the location where you meassure the pressure. Temperature sensor(s) which should be used as a reference when normalizing the pressure using C method 2. -When specified more sensors a minumum is found and used each time. The +When specified more sensors a minimum is found and used each time. The temperature reading directly from this pressure sensor/plugin is typically not suitable as the pressure sensor will be probably inside while we want outside temperature. The collectd reference name is something like @@ -1345,11 +1364,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. @@ -2020,7 +2039,7 @@ is passed to them, so invalid settings here may go unnoticed. This is not the plugin's fault, it will report errors if it gets them from the libraryE/ the driver. If a driver complains about an option, the plugin will dump a complete list of all options understood by that driver to the log. There is no -way to programatically find out if an option expects a string or a numeric +way to programmatically find out if an option expects a string or a numeric argument, so you will have to refer to the appropriate DBD's documentation to find this out. Sorry. @@ -2267,7 +2286,7 @@ expected from them. This is documented in great detail in L. =head2 Plugin C The C plugin provides statistics about used, unused and total number of -file handles. +file handles on Linux. The I provides the following configuration options: @@ -2489,7 +2508,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 @@ -2498,6 +2517,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 @@ -2538,9 +2574,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 @@ -4271,6 +4311,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 @@ -5157,7 +5209,7 @@ transaction fails or if the database server crashes. Specify the plugin instance name that should be used instead of the database name (which is the default, if this option has not been specified). This -allows to query multiple databases of the same name on the same host (e.g. +allows one to query multiple databases of the same name on the same host (e.g. when running multiple database server versions in parallel). =item B I @@ -5218,7 +5270,7 @@ Use SSL only. Specify the plugin instance name that should be used instead of the database name (which is the default, if this option has not been specified). This -allows to query multiple databases of the same name on the same host (e.g. +allows one to query multiple databases of the same name on the same host (e.g. when running multiple database server versions in parallel). =item B I @@ -5413,13 +5465,16 @@ 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 +Similar to the B option this allows one to select more detailed statistics of processes matching the specified I (see L for details). The statistics of all matching processes are summed up and dispatched to the daemon using the specified I as an identifier. This -allows to "group" several processes together. I must not contain +allows one to "group" several processes together. I must not contain slashes. =back @@ -5630,8 +5685,8 @@ C anymore, it does not need to be flushed when C is to be restarted. This results in much shorter (if any) gaps in graphs, especially under heavy load. Also, the C command line utility is aware of the daemon so that it can flush values to disk automatically when needed. This -allows to integrate automated flushing of values into graphing solutions much -more easily. +allows one to integrate automated flushing of values into graphing solutions +much more easily. There are disadvantages, though: The daemon may reside on a different host, so it may not be possible for C to create the appropriate RRD files @@ -6721,20 +6776,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. @@ -6976,6 +7031,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 @@ -6994,6 +7053,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 @@ -7376,7 +7439,7 @@ forwarded to the kafka producer library B. =item B I -Use the specified string as a partioning key for the topic. Kafka breaks +Use the specified string as a partitioning key for the topic. Kafka breaks topic into partitions and guarantees that for a given topology, the same consumer will be used for a specific key. The special (case insensitive) string B can be used to specify that an arbitrary partition should @@ -7466,7 +7529,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 @@ -7484,9 +7547,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 @@ -7582,7 +7645,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.