From: Florian Forster Date: Fri, 16 Mar 2012 16:44:50 +0000 (+0100) Subject: collectd.conf(5): Document the "Hits" and "Hysteresis" threshold options. X-Git-Tag: collectd-4.10.7~8 X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=0e1a7a85d9eae9ea4a0d85a065c2b201099d4225;p=collectd.git collectd.conf(5): Document the "Hits" and "Hysteresis" threshold options. Fixes GitHub issue #53. --- diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index 74249d7f..274e3887 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -4704,6 +4704,34 @@ percentage value, relative to the other data sources. This is helpful for example for the "df" type, where you may want to issue a warning when less than 5E% of the total space is available. Defaults to B. +=item B I + +Delay creating the notification until the threshold has been passed I +times. When a notification has been generated, or when a subsequent value is +inside the threshold, the counter is reset. If, for example, a value is +collected once every 10Eseconds and B is set to 3, a notification +will be dispatched at most once every 30Eseconds. + +This is useful when short bursts are not a problem. If, for example, 100% CPU +usage for up to a minute is normal (and data is collected every +10Eseconds), you could set B to B<6> to account for this. + +=item B I + +When set to non-zero, a hysteresis value is applied when checking minimum and +maximum bounds. This is useful for values that increase slowly and fluctuate a +bit while doing so. When these values come close to the threshold, they may +"flap", i.e. switch between failure / warning case and okay case repeatedly. + +If, for example, the threshold is configures as + + WarningMax 100.0 + Hysteresis 1.0 + +then a I notification is created when the value exceeds I<101> and the +corresponding I notification is only created once the value falls below +I<99>, thus avoiding the "flapping". + =back =head1 FILTER CONFIGURATION