X-Git-Url: https://granicus.if.org/sourcecode?a=blobdiff_plain;f=doc%2F14-features.md;h=0ecafd62cf147daa4b28d72fba64726f8c8b31b9;hb=0ae4d9ec81a1931c25ddf92b4ddebd0fa4c5e576;hp=7c9f661de721e44e7ae35c6a95e13d8320872c9d;hpb=91241e5f46a32b71ee0158fb0bacb7166279bba4;p=icinga2 diff --git a/doc/14-features.md b/doc/14-features.md index 7c9f661de..0ecafd62c 100644 --- 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 + +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 @@ -333,7 +357,7 @@ predominantly affects Windows paths e.g. `C:\` becomes `C:_`. The database is assumed to exist so this object will make no attempt to create it currently. -If [SELinux](22-selinux.md#selinux) is enabled, it will not allow access for Icinga 2 to InfluxDB until the [boolean](22-selinux.md#booleans) +If [SELinux](22-selinux.md#selinux) is enabled, it will not allow access for Icinga 2 to InfluxDB until the [boolean](22-selinux.md#selinux-policy-booleans) `icinga2_can_connect_all` is set to true as InfluxDB is not providing its own policy. More configuration details can be found [here](09-object-types.md#objecttype-influxdbwriter). @@ -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 @@ -737,6 +764,10 @@ A detailed list on the available table attributes can be found in the [Livestatu ## Status Data Files +> **Note** +> +> 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 the `StatusDataWriter` object which dumps all configuration objects and @@ -747,9 +778,12 @@ status updates in a regular interval. If you are not using any web interface or addon which uses these files, you can safely disable this feature. - ## Compat Log Files +> **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. @@ -770,7 +804,8 @@ in `/var/log/icinga2/compat`. Rotated log files are moved into ## Check Result Files > **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.