X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=da12f863a0b642627975a67325c0ee6091731cf3;hb=0ae668b99c76e6b6f3b286d09f2a9b6ee2ac8bc3;hp=cd3fc40b3401d06d18e36c0525cedb5751fb00ca;hpb=4b1af5819e5574e49c3f94c88d1c7cb4682ae941;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index cd3fc40b..da12f863 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -24,7 +24,7 @@ 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 +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, @@ -47,11 +47,20 @@ directory for the daemon. Loads the plugin I. There must be at least one such line or B 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 @@ -78,7 +87,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 enclosed 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 @@ -163,7 +172,7 @@ installed and an "cpu governor" (that's a kernel module) is loaded. =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 @@ -214,6 +223,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 @@ -242,9 +255,18 @@ output that is expected from it. =over 4 -=item B I I +=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. -Execute the executable I as user I. +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 @@ -349,6 +371,10 @@ 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 @@ -376,12 +402,30 @@ 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 logs loud complaints in case anything goes wrong. +plugin will complaint loudly in case anything goes wrong. This plugin issues C and evaluates C, C and C which correspond to F, @@ -413,6 +457,83 @@ 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 @@ -470,6 +591,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 @@ -497,24 +651,8 @@ L. =head2 Plugin C -=over 4 - -=item B I - -Loads the Perl plugin I. This does basically the same as B would -do in a Perl program. - -=item B I - -Prepends IB<::> to all plugin names loaded after this option. This is -provided for convenience to keep plugin names short. - -=item B I - -Adds I to the B<@INC> array. This is the same as using the B<-IDir> -command line option or B in the source code. - -=back +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 @@ -547,7 +685,7 @@ 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 safely ignore these settings. @@ -560,15 +698,18 @@ 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 @@ -615,7 +756,7 @@ 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 @@ -651,6 +792,12 @@ 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 @@ -663,6 +810,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 @@ -698,6 +883,7 @@ The B homepage can be found at L. L, L, +L, L, L, L,