X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=6c600f047936baea7ba94957b5280f1c84d55f03;hb=65cbd6ca1da0d802ac39b460dcb8ae0af3762c13;hp=1e0f5a830859ec36a0b4fc7ed9d4d7cbf0a8d804;hpb=bc2d94024d0250211c1e498db1b43bb4525324da;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 1e0f5a83..6c600f04 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -24,14 +24,18 @@ B behaves. The most significant option is B, which 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 +The syntax of this config file is similar to the config file of the famous +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. +Plugins are loaded in the order listed in this config file. It is a good idea +to load any logging plugins first in order to catch messages from plugins +during configuration. + =head1 GLOBAL OPTIONS =over 4 @@ -45,13 +49,30 @@ directory for the daemon. =item B I Loads the plugin I. There must be at least one such line or B -will be mostly useless. The names of the plugins are listed in L. +will be mostly useless. + +=item B I + +Includes the file I as if it was copy and pasted here. To prevent loops +and shooting yourself in the foot in interesting ways the nesting is limited to +a depth of 8Elevels, which should be sufficient for most uses. + +It is no problem to have a block like CPlugin fooE> in more than one +file, but you cannot include files from within blocks. =item B I Sets where to write the PID file to. This file is overwritten when it exists -and deleted when the program ist stopped. Some init-scripts might override this -setting using the B<-P> commandline option. +and deleted when the program is stopped. Some init-scripts might override this +setting using the B<-P> command-line option. + +=item B I + +Path to the plugins (shared objects) of collectd. + +=item B I + +Set the file that contains the data-set descriptions. =item B I @@ -70,8 +91,16 @@ 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 -C-Section. Which options exist depends on the plugin used: +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 +collect data from. These plugins are listed below as well, even if they don't +require any configuration within collectd's configfile. + +A list of all plugins and a short summary for each plugin can be found in the +F file shipped with the sourcecode and hopefully binary packets as +well. =head2 Plugin C @@ -87,7 +116,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. @@ -112,7 +141,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 @@ -133,13 +162,21 @@ TCP-Port to connect to. Defaults to B<3551>. =back +=head2 Plugin C + +This plugin doesn't have any options. It reads +F (for the first CPU +installed) to get the current CPU frequency. If this file does not exist make +sure B (L) or a similar tool is +installed and an "cpu governor" (that's a kernel module) is loaded. + =head2 Plugin C =over 4 =item B I -Set the directory to store RRD-files under. Per default RRD-files are generated +Set the directory to store CSV-files under. Per default CSV-files are generated beneath the daemon's working directory, i.Ee. the B. =back @@ -164,7 +201,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 @@ -190,9 +227,13 @@ 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 +If running as root change the group of the UNIX-socket after it has been created. Defaults to B. =item B I @@ -210,8 +251,40 @@ at most B<16384> to prevent typos and dumb mistakes. =back +=head2 Plugin C + +Please make sure to read L before using this plugin. It +contains valuable information on when the executable is executed and the +output that is expected from it. + +=over 4 + +=item B I[:[I]] I + +Execute the executable I as user I. If the user name is +followed by a colon and a group name, the effective group is set to that group. +The real group and saved-set group will be set to the default group of that +user. If no group is given the effective group ID will be the same as the real +group ID. + +Please note that in order to change the user and/or group the daemon needs +superuser privileges. If the daemon is run as an unprivileged user you must +specify the same user/group here. If the daemon is run with superuser +privileges, you must supply a non-root user here. + +=back + =head2 Plugin C +To get values from B collectd connects to B (127.0.0.1), +port B<7634/tcp>. The B and B options can be used to change these +default values, see below. C has to be running to work correctly. If +C is not running timeouts may appear which may interfere with other +statistics.. + +The B homepage can be found at +L. + =over 4 =item B I @@ -238,7 +311,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 @@ -278,11 +351,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 @@ -302,10 +375,25 @@ B can be used to write to the standard output and standard error channels, respectively. This, of course, only makes much sense when collectd is running in foreground- or non-daemon-mode. +=item B B|B + +Prefix all lines printed by the current time. Defaults to B. + =back =head2 Plugin C +The C uses mbmon to retrieve temperature, voltage, etc. + +Be default collectd connects to B (127.0.0.1), port B<411/tcp>. The +B and B options can be used to change these values, see below. +C has to be running to work correctly. If C is not running +timeouts may appear which may interfere with other statistics.. + +C must be run with the -r option ("print TAG and Value format"); +Debian's F script already does this, other people +will need to ensure that this is the case. + =over 4 =item B I @@ -318,8 +406,40 @@ TCP-Port to connect to. Defaults to B<411>. =back +=head2 Plugin C + +The C connects to a memcached server and queries statistics +about cache utilization, memory and bandwidth used. +L + +=over 4 + +=item B I + +Hostname to connect to. Defaults to B<127.0.0.1>. + +=item B I + +TCP-Port to connect to. Defaults to B<11211>. + +=back + =head2 Plugin C +The C requires B to be installed. It connects to the +database when started and keeps the connection up as long as possible. When the +connection is interrupted for whatever reason it will try to re-connect. The +plugin will complaint loudly in case anything goes wrong. + +This plugin issues C and evaluates C, +C and C which correspond to F, +F and F. Also, the values of +C are put in F and values of C are put +in F. Please refer to the B, +I<5.2.4. Server Status Variables> for an explanation of these values. + +Use the following options to configure the plugin: + =over 4 =item B I @@ -336,11 +456,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 @@ -361,13 +558,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> @@ -383,7 +580,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 @@ -398,6 +595,39 @@ either. =back +=head2 Plugin C + +This plugin collects the number of connections and requests handled by the +C (speak: engineEX), a HTTP and mail server/proxy. It +queries the page provided by the C module, which +isn't compiled by default. Please refer to +L for more information on +how to compile and configure nginx and this module. + +The following options are accepted by the C: + +=over 4 + +=item B I + +Sets the URL of the C output. + +=item B I + +Optional user name needed for authentication. + +=item B I + +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 bundled with C +and are checked by default depends on the distribution you use. + +=back + =head2 Plugin C =over 4 @@ -423,6 +653,11 @@ L. =back +=head2 Plugin C + +This plugin embeds a Perl-interpreter into collectd and provides an interface +to collectd's plugin system. See L for its documentation. + =head2 Plugin C =over 4 @@ -454,28 +689,31 @@ and minor and major pagefaults. =head2 Plugin C You can use the settings B, B, B, and B to -finetune your RRD-files. Please read L if you encounter problems +fine-tune 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 -Sets the stepsize of newly created RRD-files. Ideally (and per default) this -setting is identical to the global B-option and should not be -smaller. If unsure, don't set this option. +B the stepsize of newly created RRD-files. Ideally (and per default) +this setting is unset and the stepsize is set to the interval in which the data +is collected. Do not use this option unless you absolutely have to for some +reason. Setting this option may cause problems with the C, the +C or when the daemon is set up to receive data from other hosts. =item B I -Sets the heartbeat of newly created RRD-files. Ideally this setting is bigger -than the B-setting, by default it's twice the B-setting. If -unsure, don't set this option. +B the heartbeat of newly created RRD-files. This setting should be unset +in which case the heartbeat is set to twice the B which should equal +the interval in which data is collected. Do not set this option unless you have +a very good reason to do so. =item B I @@ -492,6 +730,14 @@ one CDP by calculating: Bottom line is, set this no smaller than the width of you graphs in pixels. The default is 1200. +=item B I + +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. + +For more information on how RRA-sizes are calculated see B above. + =item B I Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option. @@ -514,13 +760,21 @@ normally do much harm either. If this option is set to a value greater than zero, the C will save values in a cache, as described above. Writing multiple values at once reduces IO-operations and thus lessens the load produced by updating the files. -The tradeoff is that the graphs kind of "drag behind" and that more memory is +The trade off is that the graphs kind of "drag behind" and that more memory is used. =back =head2 Plugin C +The C uses B to retrieve sensor-values. This means +that all the needed modules have to be loaded and lm_sensors has to be +configured (most likely by editing F. Read +L for details. + +The B homepage can be found at +L. + =over 4 =item B I @@ -535,13 +789,19 @@ 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. =back +=head2 Plugin C + +Since the configuration of the C is a little more complicated than +other plugins, its documentation has been moved to an own manpage, +L. Please see there for details. + =head2 Plugin C =over 4 @@ -554,6 +814,44 @@ syslog-daemon. =back +=head2 Plugin C + +The C counts the number of currently established TCP +connections based on the local port and/or the remote port. Since there may be +a lot of connections the default if to count all connections with a local port, +for which a listening socket is opened. You can use the following options to +fine-tune the ports you are interested in: + +=over 4 + +=item B I|I + +If this option is set to I, statistics for all local ports for which a +listening socket exists are collected. The default depends on B and +B (see below): If no port at all is specifically selected, the +default is to collect listening ports. If specific ports (no matter if local or +remote ports) are selected, this option defaults to I, i.Ee. only +the selected ports will be collected unless this option is set to I +specifically. + +=item B I + +Count the connections to a specific local port. This can be used to see how +many connections are handled by a specific daemon, e.Eg. the mailserver. +You have to specify the port in numeric form, so for the mailserver example +you'd need to set B<25>. + +=item B I + +Count the connections to a specific remote port. This is useful to see how +much a remote service is used. This is most useful if you want to know how many +connections a local service has opened to remote services, e.Eg. how many +connections a mail server or news server has to other mail or news servers, or +how many connections a web proxy holds to web servers. You have to give the +port in numeric form. + +=back + =head2 Plugin C =over 4 @@ -564,7 +862,7 @@ 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 +If running as root change the group of the UNIX-socket after it has been created. Defaults to B. =item B I @@ -575,9 +873,27 @@ L. Defaults to B<0770>. =back +=head2 Plugin C + +This plugin doesn't have any options. B support is only available for +Linux. It cannot yet be found in a vanilla kernel, though. To make use of this +plugin you need a kernel that has B support built in, i.Ee. you +need to apply the patches and compile your own kernel, which will then provide +the F filesystem that is required by this plugin. + +The B homepage can be found at L. + =head1 SEE ALSO -L +L, +L, +L, +L, +L, +L, +L, +L, +L =head1 AUTHOR