Merge branch 'support/2.10'

[icinga2] / doc / 14-features.md

diff --git a/doc/14-features.md b/doc/14-features.md
index 2ee09a06a7b7a8f82b06a6d210ae60b516d54546..0ecafd62cf147daa4b28d72fba64726f8c8b31b9 100644 (file)
--- a/doc/14-features.md
+++ b/doc/14-features.md
@@ -87,6 +87,30 @@ status_update_time
 
 A detailed list on the available table attributes can be found in the [DB IDO Schema documentation](24-appendix.md#schema-db-ido).
 
+### DB IDO Cleanup <a id="db-ido-cleanup"></a>
+
+Objects get deactivated when they are deleted from the configuration.
+This is visible with the `is_active` column in the `icinga_objects` table.
+Therefore all queries need to join this table and add `WHERE is_active=1` as
+condition. Deleted objects preserve their history table entries for later SLA
+reporting.
+
+Historical data isn't purged by default. You can enable the least
+kept data age inside the `cleanup` configuration attribute for the
+IDO features [IdoMysqlConnection](09-object-types.md#objecttype-idomysqlconnection)
+and [IdoPgsqlConnection](09-object-types.md#objecttype-idopgsqlconnection).
+
+Example if you prefer to keep notification history for 30 days:
+
+```
+  cleanup = {
+     notifications_age = 30d
+     contactnotifications_age = 30d
+  }
+```
+
+The historical tables are populated depending on the data `categories` specified.
+Some tables are empty by default.
 
 ### DB IDO Tuning <a id="db-ido-tuning"></a>
 
@@ -403,7 +427,10 @@ The check results include parsed performance data metrics if enabled.
 
 > **Note**
 >
-> Elasticsearch 5.x is required. This feature has been successfully tested with Elasticsearch 5.6.4.
+> Elasticsearch 5.x or 6.x are required. This feature has been successfully tested with
+> Elasticsearch 5.6.7 and 6.3.1.
+
+
 
 Enable the feature and restart Icinga 2.
 
@@ -433,12 +460,12 @@ Metric values are stored like this:
 
 The following characters are escaped in perfdata labels:
 
-  Character    | Escaped character
-  --------------|--------------------------
-  whitespace   | _
-  \            | _
-  /            | _
-  ::           | .
+  Character   | Escaped character
+  ------------|--------------------------
+  whitespace  | _
+  \           | _
+  /           | _
+  ::          | .
 
 Note that perfdata labels may contain dots (`.`) allowing to
 add more subsequent levels inside the tree.
@@ -641,7 +668,7 @@ A list of available external commands and their parameters can be found [here](2
 and, or, negate
 
   Operator  | Negate   | Description
-  ----------|------------------------
+  ----------|----------|-------------
    =        | !=       | Equality
    ~        | !~       | Regex match
    =~       | !=~      | Equality ignoring case
@@ -738,7 +765,8 @@ A detailed list on the available table attributes can be found in the [Livestatu
 ## Status Data Files <a id="status-data"></a>
 
 > **Note**
-> This feature is deprecated and will be removed with Icinga 2.10.0
+>
+> This feature is DEPRECATED and will be removed in Icinga 2 v2.11.
 
 Icinga 1.x writes object configuration data and status data in a cyclic
 interval to its `objects.cache` and `status.dat` files. Icinga 2 provides
@@ -752,6 +780,10 @@ you can safely disable this feature.
 
 ## Compat Log Files <a id="compat-logging"></a>
 
+> **Note**
+>
+> This feature is DEPRECATED and will be removed in Icinga 2 v2.11.
+
 The Icinga 1.x log format is considered being the `Compat Log`
 in Icinga 2 provided with the `CompatLogger` object.
 
@@ -772,7 +804,8 @@ in `/var/log/icinga2/compat`. Rotated log files are moved into
 ## Check Result Files <a id="check-result-files"></a>
 
 > **Note**
-> This feature is deprecated and will be removed with Icinga 2.10.0
+>
+> This feature is DEPRECATED and will be removed in Icinga 2 v2.11.
 
 Icinga 1.x writes its check result files to a temporary spool directory
 where they are processed in a regular interval.