From: Michael Friedrich <michael.friedrich@netways.de>
Date: Fri, 11 Oct 2013 11:25:56 +0000 (+0200)
Subject: Documentation: Add freshness check changes.
X-Git-Tag: v0.0.3~164
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3326b0190aa7c674286559e3bf75d9a6852ab842;p=icinga2

Documentation: Add freshness check changes.

fixes #4759
---

diff --git a/doc/6-advanced-topics.md b/doc/6-advanced-topics.md
index 32f112465..f47acee27 100644
--- a/doc/6-advanced-topics.md
+++ b/doc/6-advanced-topics.md
@@ -20,9 +20,19 @@ TODO
 
 TODO
 
-## Check Freshness
+## Check Result Freshness
 
-TODO
+In Icinga 2 active check freshness is enabled by default. It is determined by the
+`check_interval` attribute and no incoming check results in that period of time.
+
+    threshold = last check execution time + check interval
+
+Passive check freshness is calculated from the `check_interval` attribute if set.
+
+    threshold = last check result time + check interval
+
+If the freshness checks are invalid, a new check is executed defined by the
+`check_command` attribute.
 
 ## Check Flapping
 
diff --git a/doc/8-differences-between-icinga-1x-and-2.md b/doc/8-differences-between-icinga-1x-and-2.md
index 012c9b663..ab4348ff6 100644
--- a/doc/8-differences-between-icinga-1x-and-2.md
+++ b/doc/8-differences-between-icinga-1x-and-2.md
@@ -495,6 +495,19 @@ The algorithm used in Icinga 2 does not store the past states but calculcates th
 threshold from a single value based on counters and half-life values. Icinga 2 compares
 the value with a single flapping threshold configuration attribute.
 
+## Check Result Freshness
+
+Freshness of check results must be explicitely enabled in Icinga 1.x. The attribute
+`freshness_treshold` defines the threshold in seconds. Once the threshold is triggered, an
+active freshness check is executed defined by the `check_command` attribute. Both check
+methods (active and passive) use the same freshness check method.
+
+In Icinga 2 active check freshness is determined by the `check_interval` attribute and no
+incoming check results in that period of time (last check + check interval). Passive check
+freshness is calculated from the `check_interval` attribute if set. There is no extra
+`freshness_threshold` attribute in Icinga 2. If the freshness checks are invalid, a new
+service check is forced.
+
 ## State Retention
 
 Icinga 1.x uses the `retention.dat` file to save its state in order to be able