X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=bd777bf3ce2399a49d0adfb017c119a2f9a82e29;hb=6d43c759c9495118ef3c088fd2d06fd09c4fda8f;hp=939c72a3c7e56a3ddafef90833b59867c402103e;hpb=ebed90b26c7d5eb6ed0e88cb24da342ae7c65b11;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 939c72a3..bd777bf3 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -25,10 +25,10 @@ controls which plugins to load. These plugins ultimately define collectd's behavior. The syntax of this config file is similar to the config file of the famos -B. Each line containes either a key-value-pair or a +B. Each line contains either a key-value-pair or a section-start or -end. Empty lines and everything after the hash-symbol `#' is ignored. Values are either string, enclosed in double-quotes, -(floating-point-)numbers or a boolean extression, i.Ee. either B or +(floating-point-)numbers or a boolean expression, i.Ee. either B or B. String containing of only alphanumeric characters and underscores do not need to be quoted. @@ -78,7 +78,7 @@ a value higher than the number of plugins you've loaded is totally useless. =head1 PLUGIN OPTIONS -Some Plugins may register own options. These options must be inclosed in a +Some Plugins may register own options. These options must be enclosed in a C-Section. Which options exist depends on the plugin used. Some plugins require external configuration, too. The C, for example, required C to be configured in the webserver you're going to @@ -103,7 +103,7 @@ the following snipped to base your Apache config upon: -Since it's C module is very similar to Apache's, B is +Since its C module is very similar to Apache's, B is also supported. It introduces a new field, called C, to count the number of currently connected clients. This field is also supported. @@ -128,7 +128,7 @@ Optional password needed for authentication. =item B I File that holds one or more SSL certificates. If you want to use HTTPS you will -possibly need this option. What CA certificates come bundeled with C +possibly need this option. What CA certificates come bundled with C and are checked by default depends on the distribution you use. =back @@ -188,7 +188,7 @@ Select partitions based on the filesystem type. Invert the selection: If set to true, all partitions B the ones that match any one of the criteria are collected. By default only selected -partitions are collected if a selection is made. If no selection is conifured +partitions are collected if a selection is made. If no selection is configured at all, B partitions are selected. =back @@ -214,6 +214,10 @@ Ignore packets that originate from this address. =over 4 +=item B I + +Sets the socket-file which is to be created. + =item B I If running as root change the group of the UNIX-socket after it has been @@ -237,14 +241,17 @@ at most B<16384> to prevent typos and dumb mistakes. =head2 Plugin C Please make sure to read L before using this plugin. It -contains valueable information on when the executable is executed and the +contains valuable information on when the executable is executed and the output that is expected from it. =over 4 -=item B I I +=item B I[:[I]] I -Execute the executable I as user I. +Execute the executable I as user I. If the user name is +followed by a colon and a group name, the program is executed as the specified +group. If only the colon follows the user name the group defaults to the +user's login group. =back @@ -285,7 +292,7 @@ a more detailed description see B below. 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/prefered +interfaces you're interested in. Sometimes, however, it's easier/preferred to collect all interfaces I a few ones. This option enables you to do that: By setting B to I the effect of B is inversed: All selected interfaces are ignored and all @@ -325,11 +332,11 @@ detailed description see B below. If no configuration if given, the B-plugin will collect data from all irqs. This may not be practical, especially if no interrupts happen. Thus, you -can use the B-option to pick the interupt you're interested in. -Sometimes, however, it's easier/prefered to collect all interupts I a +can use the B-option to pick the interrupt you're interested in. +Sometimes, however, it's easier/preferred to collect all interrupts I a few ones. This option enables you to do that: By setting B to -I the effect of B is inversed: All selected interupts are ignored -and all other interupts are collected. +I the effect of B is inversed: All selected interrupts are ignored +and all other interrupts are collected. =back @@ -408,11 +415,88 @@ Password needed to log into the database. =item B I -Select this database. Defaults to I which is a perfecly reasonable +Select this database. Defaults to I which is a perfectly reasonable option for what this plugin does. =back +=head2 Plugin C + +The C plugin uses a netlink socket to query the Linux kernel about +statistics of various interface and routing aspects. + +=over 4 + +=item B I + +=item B I + +Instruct the plugin to collect interface statistics. This is basically the same +as the statistics provided by the C plugin (see above) but +potentially much more detailed. + +When configuring with B only the basic statistics will be collected, +namely octets, packets, and errors. These statistics are collected by +the C plugin, too, so using both at the same time is no benefit. + +When configured with B all counters B the basic ones, +so that no data needs to be collected twice if you use the C plugin. +This includes dropped packets, received multicast packets, collisions and a +whole zoo of differentiated RX and TX errors. You can try the following command +to get an idea of what awaits you: + + ip -s -s link list + +If I is B, all interfaces will be selected. + +=item B I [I] + +=item B I [I] + +=item B I [I] + +Collect the octets and packets that pass a certain qdisc, class or filter. + +QDiscs and classes are identified by their type and handle (or classid). +Filters don't necessarily have a handle, therefore the parent's handle is used. +The notation used in collectd differs from that used in tc(1) in that it +doesn't skip the major or minor number if it's zero and doesn't print special +ids by their name. So, for example, a qdisc may be identified by +C even though the minor number of B qdiscs is zero and +thus not displayed by tc(1). + +If B, B, or B is given without the second argument, +i.E.e. without an identifier, all qdiscs, classes, or filters that are +associated with that interface will be collected. + +Since a filter itself doesn't necessarily have a handle, the parent's handle is +used. This may lead to problems when more than one filter is attached to a +qdisc or class. This isn't nice, but we don't know how this could be done any +better. If you have a idea, please don't hesitate to tell us. + +As with the B option you can specify B as the interface, +meaning all interfaces. + +Here are some examples to help you understand the above text more easily: + + + VerboseInterface "All" + QDisc "eth0" "pfifo_fast-1:0" + QDisc "ppp0" + Class "ppp0" "htb-1:10" + Filter "ppp0" "u32-1:0" + + +=item B + +The behaviour 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 inversed, i.Ee. the +specified statistics will not be collected. + +=back + =head2 Plugin C =over 4 @@ -433,13 +517,13 @@ the argument is a multicast address the daemon will join that multicast group. If no B statement is found the server tries join both, the default IPv6 multicast group and the default IPv4 multicast group. If no B statement is found the client will try to send data to the IPv6 multicast group first. If -that failes the client will try the IPv4 multicast group. +that fails the client will try the IPv4 multicast group. The default IPv6 multicast group is C. The default IPv4 multicast group is C<239.192.74.66>. The optional I argument sets the port to use. It can either be given -using a numeric port number or a service name. If the argument is omited the +using a numeric port number or a service name. If the argument is omitted the default port B<25826> is assumed. =item B I<1-255> @@ -455,7 +539,7 @@ If set to I, write packets that were received via the network plugin to the sending sockets. This should only be activated when the B- and B-statements differ. Otherwise packets may be send multiple times to the same multicast group. While this results in more network traffic than -neccessary it's not a huge problem since the plugin has a duplicate detection, +necessary it's not a huge problem since the plugin has a duplicate detection, so the values will not loop. =item B I @@ -549,13 +633,13 @@ and minor and major pagefaults. You can use the settings B, B, B, and B to finetune your RRD-files. Please read L if you encounter problems using these settings. If you don't want to dive into the depths of RRDTool, you -can savely ignore these settings. +can safely ignore these settings. =over 4 =item B I -Set the directory to store CSV-files under. Per default CSV-files are generated +Set the directory to store RRD-files under. Per default RRD-files are generated beneath the daemon's working directory, i.Ee. the B. =item B I @@ -587,7 +671,7 @@ default is 1200. =item B I -Adds an RRA-timespan, given in seconds. Use this option mulitple times to have +Adds an RRA-timespan, given in seconds. Use this option multiple times to have more then one RRA. If this option is never used, the built-in default of (3600, 86400, 604800, 2678400, 31622400) is used. @@ -644,7 +728,7 @@ voltage sensor I of the I on the isa bus at the address 0290. If no configuration if given, the B-plugin will collect data from all sensors. This may not be practical, especially for uninteresting sensors. Thus, you can use the B-option to pick the sensors you're interested -in. Sometimes, however, it's easier/prefered to collect all sensors I a +in. Sometimes, however, it's easier/preferred to collect all sensors I a few ones. This option enables you to do that: By setting B to I the effect of B is inversed: All selected sensors are ignored and all other sensors are collected.