From: Florian Forster Date: Sun, 24 Aug 2008 09:00:17 +0000 (+0200) Subject: collectd.conf(5): Documented the filecount plugin. X-Git-Tag: collectd-4.5.0~43 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=81e65e29f3124332953c5f4641019559e472df8a;p=collectd.git collectd.conf(5): Documented the filecount plugin. --- diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index ea508fbb..f7e14d05 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),