X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcollectd.conf.pod;h=383dda6397c5e4e6c1b90d9c683e32137b179e4a;hb=89783745dc59079eab34e0c52de6e5e972f50eb2;hp=f642c96125bf38e5756b1e7dd7df74e9956a612c;hpb=6cb2f62a2c988bd034513620466d440119079fb8;p=collectd.git diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index f642c961..383dda63 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -32,6 +32,12 @@ ignored. Values are either string, enclosed in double-quotes, B. String containing of only alphanumeric characters and underscores do not need to be quoted. +The configuration is read and processed in order, i.Ee. from top to +bottom. So the 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. Also, the C option B occur +B the CPlugin ...E> block. + =head1 GLOBAL OPTIONS =over 4 @@ -47,11 +53,21 @@ 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 +=item B I + +If I points to a file, includes that file. If I points to a +directory, recursively includes all files within that directory and its +subdirectories. If the C function is available on your system, +shell-like wildcards are expanded before files are included. This means you can +use statements like the following: -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. + Include "/etc/collectd.d/*.conf" + +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. Since symlinks are followed it is still possible to crash the daemon +by looping symlinks. In our opinion significant stupidity should result in an +appropriate amount of pain. It is no problem to have a block like CPlugin fooE> in more than one file, but you cannot include files from within blocks. @@ -66,9 +82,10 @@ setting using the B<-P> command-line option. Path to the plugins (shared objects) of collectd. -=item B I +=item B I [I ...] -Set the file that contains the data-set descriptions. +Set one or more files that contain the data-set descriptions. See +L for a description of the format of this file. =item B I @@ -252,7 +269,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 @@ -278,7 +295,9 @@ output that is expected from it. =over 4 -=item B I[:[I]] I +=item B I[:[I]] I [IargE> [IargE> ...]] + +=item B I[:[I]] I [IargE> [IargE> ...]] 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. @@ -291,6 +310,15 @@ 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. +The executable may be followed by optional arguments that are passed to the +program. Please note that due to the configuration parsing numbers and boolean +values may be changed. If you want to be absolutely sure that something is +passed as-is please enclose it in quotes. + +The B and B statements change the semantics of the +programs executed, i.Ee. the data passed to them and the response +expected from them. This is documented in great detail in L. + =back =head2 Plugin C @@ -314,6 +342,13 @@ Hostname to connect to. Defaults to B<127.0.0.1>. TCP-Port to connect to. Defaults to B<7634>. +=item B I|I + +If enabled, translate the disk names to major/minor device numbers +(e.Eg. "8-0" for /dev/sda). For backwards compatibility this defaults to +I but it's recommended to disable it as it will probably be removed in +the next major version. + =back =head2 Plugin C @@ -405,7 +440,8 @@ seconds. Setting this to be the same or smaller than the I will cause the list of domains and devices to be refreshed on every iteration. Refreshing the devices in particular is quite a costly operation, so if your -virtualization setup is static you might consider increasing this. +virtualization setup is static you might consider increasing this. If this +option is set to 0, refreshing is disabled completely. =item B I @@ -463,6 +499,9 @@ between, thus I<"foo:1234-1234-1234-1234">). Sets the log-level. If, for example, set to B, then all events with severity B, B, or B will be written to the logfile. +Please note that B is only available if collectd has been compiled with +debugging support. + =item B I Sets the file to write log messages to. The special strings B and @@ -914,6 +953,9 @@ Sets the log-level. If, for example, set to B, then all events with severity B, B, or B will be submitted to the syslog-daemon. +Please note that B is only available if collectd has been compiled with +debugging support. + =back =head2 Plugin C @@ -964,7 +1006,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 @@ -1026,12 +1068,123 @@ the F filesystem that is required by this plugin. The B homepage can be found at L. +=head1 THRESHOLD CONFIGURATION + +Starting with version C<4.3.0> collectd has support for B. By that +we mean that the values are not only stored or sent somewhere, but that they +are judged and, if a problem is recognized, acted upon. The only action +collectd takes itself is to generate and dispatch a "notification". Plugins can +register to receive notifications and perform appropriate further actions. + +Since systems and what you expect them to do differ a lot, you can configure +B for your values freely. This gives you a lot of flexibility but +also a lot of responsibility. + +Every time a value is out of range a notification is dispatched. This means +that the idle percentage of your CPU needs to be less then the configured +threshold only once for a notification to be generated. There's no such thing +as a moving average or similar - at least not now. + +Also, all values that match a threshold are considered to be relevant or +"interesting". As a consequence collectd will issue a notification if they are +not received for twice the last timeout of the values. If, for example, some +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. + +Here is a configuration example to get you started. Read below for more +information. + + + + WarningMin 0.00 + WarningMax 1000.00 + FailureMin 0.00 + FailureMax 1200.00 + Invert false + Instance "bar" + + + + Instance "eth0" + + FailureMax 10000000 + + + + + + Instance "idle" + FailureMin 10 + + + + + Instance "cached" + WarningMin 100000000 + + + + + +There are basically two types of configuration statements: The C, +C, and C blocks select the value for which a threshold should be +configured. The C and C blocks may be specified further using the +C option. You can combine the block by nesting the blocks, though +they must be nested in the above order, i.Ee. C may contain either +C and C blocks, C may only contain C blocks and +C may not contain other blocks. If multiple blocks apply to the same +value the most specific block is used. + +The other statements specify the threshold to configure. They B be +included in a C block. Currently the following statements are recognized: + +=over 4 + +=item B I + +=item B I + +Sets the upper bound of acceptable values. If unset defaults to positive +infinity. If a value is greater than B a B notification +will be created. If the value is greater than B but less than (or +equal to) B a B notification will be created. + +=item B I + +=item B I + +Sets the lower bound of acceptable values. If unset defaults to negative +infinity. If a value is less than B a B notification will +be created. If the value is less than B but greater than (or equal +to) B a B notification will be created. + +=item B B|B + +If set to B the range of acceptable values is inverted, i.Ee. +values between B and B (B and +B) are not okay. Defaults to B. + +=item B B|B + +Sets how often notifications are generated. If set to B one notification +will be generated for each value that is out of the acceptable range. If set to +B (the default) then a notification is only generated if a value is out +of range but the previous value was okay. + +This applies to missing values, too: If set to B a notification about a +missing value is generated once every B seconds. If set to B +only one such notification is generated until the value appears again. + +=back + =head1 SEE ALSO L, L, L, L, +L, L, L, L,