X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd.conf.pod;h=0df5c3b767f9c585f951e9c2e453358363e849e2;hb=fd9c88963b04c9e9050a952ba0f018493e8b7638;hp=40f5027e5be6dcf7daefe094f1f873801f5f39d1;hpb=83b945c4ced534b0bdf94239cf62a1022abbb2cb;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 40f5027e..0df5c3b7 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -420,6 +420,79 @@ expected from them. This is documented in great detail in L. =back +=head2 Plugin C + +The C plugin counts the number of files in a certain directory (and +its subdirectories) and their combined size. The configuration is very straight +forward: + + + + Instance "qmail-message" + + + Instance "qmail-todo" + + + Instance "php5-sessions" + Name "sess_*" + + + +The example above counts the number of files in QMail's queue directories and +the number of PHP5 sessions. Jfiy: The "todo" queue holds the messages that +QMail has not yet looked at, the "message" queue holds the messages that were +classified into "local" and "remote". + +As you can see, the configuration consists of one or more C blocks, +each of which specifies a directory in which to count the files. Within those +blocks, the following options are recognized: + +=over 4 + +=item B I + +Sets the plugin instance to I. That instance name must be unique, but +it's your responsibility, the plugin doesn't check for that. If not given, the +instance is set to the directory name with all slashes replaced by underscores +and all leading underscores removed. + +=item B I + +Only count files that match I, where I is a shell-like +wildcard as understood by L. Only the B is checked +against the pattern, not the entire path. In case this makes it easier for you: +This option has been named after the B<-name> parameter to L. + +=item B I + +Count only files of a specific age: If I is greater than zero, only files +that haven't been touched in the last I seconds are counted. If I is +a negative number, this is inversed. For example, if B<-60> is specified, only +files that have been modified in the last minute will be counted. + +The number can also be followed by a "multiplier" to easily specify a larger +timespan. When given in this notation, the argument must in quoted, i.Ee. +must be passed as string. So the B<-60> could also be written as B<"-1m"> (one +minute). Valid multipliers are C (second), C (minute), C (hour), C +(day), C (week), and C (year). There is no "month" multiplier. You can +also specify fractional numbers, e.Eg. B<"0.5d"> is identical to +B<"12h">. + +=item B I + +Count only files of a specific size. When I is a positive number, only +files that are at least this big are counted. If I is a negative number, +this is inversed, i.Ee. only files smaller than the absolute value of +I are counted. + +As with the B option, a "multiplier" may be added. For a detailed +description see above. Valid multipliers here are C (byte), C (kilobyte), +C (megabyte), C (gigabyte), C (terabyte), and C

(petabyte). Please +note that there are 1000 bytes in a kilobyte, not 1024. + +=back + =head2 Plugin C To get values from B collectd connects to B (127.0.0.1), @@ -472,6 +545,38 @@ other interfaces are collected. =back +=head2 Plugin C + +=over 4 + +=item B I + +Selects sensors to collect or to ignore, depending on B. + +=item B I|I + +If no configuration if given, the B plugin will collect data from all +sensors found of type "temperature", "voltage", "current" and "fanspeed". +This option enables you to do that: By setting B to I +the effect of B is inverted: All selected sensors are ignored and +all other sensors are collected. + +=item B I|I + +If a sensor appears after initialization time of a minute a notification +is sent. + +=item B I|I + +If a sensor disappears a notification is sent. + +=item B I|I + +If you have for example dual power supply and one of them is (un)plugged then +a notification is sent. + +=back + =head2 Plugin C =over 4 @@ -934,9 +1039,18 @@ L. =head2 Plugin C +B See notes below. + The C plugin uses the B library from the B project L to read sensors connected via the onewire bus. +Currently only temperature sensors (sensors with the family code C<10>, +e.Eg. DS1820, DS18S20, DS1920) can be read. If you have other sensors you +would like to have included, please send a sort request to the mailing list. + +Hubs (the DS2409 chips) are working, but read the note, why this plugin is +experimental, below. + =over 4 =item B I @@ -953,6 +1067,8 @@ with that version, the following configuration worked for us: Device "-s localhost:4304" +This directive is B and does not have a default value. + =item B I Selects sensors to collect or to ignore, depending on B, see @@ -972,6 +1088,17 @@ interfaces are collected. =back +B The C plugin is experimental, because it doesn't yet +work with big setups. It works with one sensor being attached to one +controller, but as soon as you throw in a couple more senors and maybe a hub +or two, reading all values will take more than ten seconds (the default +interval). We will probably add some separate thread for reading the sensors +and some cache or something like that, but it's not done yet. We will try to +maintain backwards compatibility in the future, but we can't probmise. So in +short: If it works for you: Great! But kaap in mind that the config I +change, though this is unlikely. Oh, and if you want to help improving this +plugin, just send a short notice to the mailing list. ThanksE:) + =head2 Plugin C This plugin embeds a Perl-interpreter into collectd and provides an interface @@ -1078,6 +1205,9 @@ The username used to connect to the database. =back +Please note that parameters are only supported by PostgreSQL's protocol +version 3 and above which was introduced in version 7.4 of PostgreSQL. + =item B I [I] Specify the I and optional I used to dispatch the value @@ -1085,6 +1215,20 @@ of each result column. Detailed information about types and their configuration can be found in L. The number and order of the B options has to match the columns of the query result. +=item B I + +=item B I + +Specify the minimum or maximum version of PostgreSQL that this query should be +used with. Some statistics might only be available with certain versions of +PostgreSQL. This allows you to specify multiple queries with the same name but +which apply to different versions, thus allowing you to use the same +configuration in a heterogeneous environment. + +The I has to be specified as the concatenation of the major, minor +and patch-level versions, each represented as two-decimal-digit numbers. For +example, version 8.2.3 will become 80203. + =back The following predefined queries are available (the definitions can be found @@ -1121,6 +1265,10 @@ This query collects the numbers of live and dead rows in the user tables. This query collects disk block access counts for user tables. +=item B + +This query collects the on-disk size of the database in bytes. + =back The B block defines one PostgreSQL database for which to collect @@ -1201,7 +1349,8 @@ B for details. Specify a I which should be executed for the database connection. This may be any of the predefined or user-defined queries. If no such option is given, it defaults to "backends", "transactions", "queries", "query_plans", -"table_states", "disk_io". Else, the specified queries are used only. +"table_states", "disk_io" and "disk_usage". Else, the specified queries are +used only. =back @@ -1323,9 +1472,9 @@ In this case please file a bug report with the collectd team. =item B I Configures the path to the UNIX domain socket to be used when connecting to the -daemon. By default C will be used for an -authoritative server and C will be used -for the recursor. +daemon. By default C<${localstatedir}/run/pdns.controlsocket> will be used for +an authoritative server and C<${localstatedir}/run/pdns_recursor.controlsocket> +will be used for the recursor. =back @@ -1409,7 +1558,7 @@ Set the "XFiles Factor". The default is 0.1. If unsure, don't set this option. =item B I -When the C uses a cache (by setting B, see below) +When the C plugin uses a cache (by setting B, see below) it writes all values for a certain RRD-file if the oldest value is older than (or equal to) the number of seconds specified. If some RRD-file is not updated anymore for some reason (the computer was shut down, the network is broken, @@ -1428,6 +1577,30 @@ reduces IO-operations and thus lessens the load produced by updating the files. The trade off is that the graphs kind of "drag behind" and that more memory is used. +=item B B + +When collecting many statistics with collectd and the C plugin, you +will run serious performance problems. The B setting and the +internal update queue assert that collectd continues to work just fine even +under heavy load, but the system may become very unresponsive and slow. This is +a problem especially if you create graphs from the RRD files on the same +machine, for example using the C script included in the +C directory. + +This setting is designed for very large setups. Setting this option to a value +between 25 and 80 updates per second, depending on your hardware, will leave +the server responsive enough to draw graphs even while all the cached values +are written to disk. Flushed values, i.Ee. values that are forced to disk +by the B command, are B effected by this limit. They are still +written as fast as possible, so that web frontends have up to date data when +generating graphs. + +For example: If you have 100,000 RRD files and set B to 30 +updates per second, writing all values to disk will take approximately +56Eminutes. Together with the flushing ability that's integrated into +"collection3" you'll end up with a responsive and fast system, up to date +graphs and basically a "backup" of your values every hour. + =back =head2 Plugin C @@ -1500,7 +1673,7 @@ user using (extended) regular expressions, as described in L. Regex "\\" DSType "CounterInc" - Type "email_count" + Type "counter" Instance "local_user" @@ -1619,6 +1792,8 @@ This option, although numeric, needs to be a string, i.Ee. you B use quotes around it! If no such statement is given only global information will be collected. +=back + =head2 Plugin C The C counts the number of currently established TCP @@ -1629,8 +1804,6 @@ fine-tune the ports you are interested in: =over 4 -=back - =item B I|I If this option is set to I, statistics for all local ports for which a @@ -1799,6 +1972,9 @@ hosts sends it's CPU statistics to the server every 60 seconds, a notification will be dispatched after about 120 seconds. It may take a little longer because the timeout is checked only once each B on the server. +When a value comes within range again or is received after it was missing, an +"OKAY-notification" is dispatched. + Here is a configuration example to get you started. Read below for more information.