X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=499634c5d5af888006b4848a63123221f18046c7;hb=99eb08be924850cf76e3dece205d5cbf9c7d74c7;hp=77d7e2c51e98e07e24cb710a5e264f86ccfee0da;hpb=21077b074c468a41dbd60baad691ebc7f2991d43;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 77d7e2c5..499634c5 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -98,7 +98,6 @@ Options inside a B block can override default settings and influence the way plugins are loaded, e.g.: - Globals true Interval 60 @@ -173,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 @@ -479,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. @@ -503,7 +500,7 @@ possibly filtering or messages. # GraphiteSeparateInstances false # GraphiteAlwaysAppendDS false - + # Receive values from an AMQP broker Host "localhost" @@ -1117,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 @@ -1994,7 +1991,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 @@ -2003,6 +2000,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 @@ -2043,9 +2057,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 @@ -2795,12 +2813,12 @@ C function for details. 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. +privileges. See the B documentation above. Defaults to B. =item B I If enabled, the plugin sends a notification if the replication slave I/O and / -or SQL threads are not running. +or SQL threads are not running. Defaults to B. =back @@ -3731,6 +3749,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 @@ -4515,6 +4545,13 @@ activating this option. The draw-back is, that data covering the specified amount of time will be lost, for example, if a single statement within the transaction fails or if the database server crashes. +=item B I + +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. +when running multiple database server versions in parallel). + =item B I Specify the hostname or IP of the PostgreSQL server to connect to. If the @@ -4545,13 +4582,6 @@ Specify the password to be used when connecting to the server. Specify whether to use an SSL connection when contacting the server. The following modes are supported: -=item B I - -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. -when running multiple database server versions in parallel). - =over 4 =item I @@ -4764,6 +4794,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 @@ -4941,7 +4974,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 @@ -5052,6 +5085,14 @@ Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option. I must be in the range C<[0.0-1.0)>, i.e. between zero (inclusive) and one (exclusive). +=item B B|B + +When set to B, various statistics about the I daemon will be +collected, with "rrdcached" as the I. Defaults to B. + +Statistics are read via Is socket using the STATS command. +See L for details. + =back =head2 Plugin C @@ -5332,7 +5373,20 @@ that I of all reported timers are smaller than or equal to the computed latency. This is useful for cutting off the long tail latency, as it's often done in I (SLAs). -If not specified, no percentile is calculated / dispatched. +Different percentiles can be calculated by setting this option several times. +If none are specified, no percentiles are calculated / dispatched. + +=item B B|B + +=item B B|B + +=item B B|B + +=item B B|B + +Calculate and dispatch various values out of I metrics received during +an interval. If set to B, the default, these values aren't calculated / +dispatched. =back @@ -6204,7 +6258,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. @@ -6291,6 +6345,61 @@ number. =back +=head2 Plugin C + +The I submits values to I, a data structure server. + +Synopsis: + + + + Host "localhost" + Port "6379" + Timeout 1000 + + + +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 +I are kept in a I called C and can be +retrieved using the C I command. See +L and L for +details. + +The information shown in the synopsis above is the I +which is used by the plugin if no configuration is present. + +The plugin can send values to multiple instances of I by specifying +one B block for each instance. Within the B blocks, the following +options are available: + +=over 4 + +=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 +canonical identifier which is used as I. It is limited to +64Echaracters in length. + +=item B I + +The B option is the hostname or IP-address where the I instance is +running on. + +=item B I + +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 + +The B option sets the socket connection timeout, in milliseconds. + +=back + =head2 Plugin C The I will send values to I, a powerfull stream @@ -6348,7 +6457,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.