From b15203e87818e3ccbc40b2cf2f054d8365863363 Mon Sep 17 00:00:00 2001 From: Jean Flach Date: Thu, 12 Apr 2018 17:29:36 +0200 Subject: [PATCH] Update volatile docs --- doc/08-advanced-topics.md | 27 +++++++++++++++------------ doc/09-object-types.md | 8 ++++---- 2 files changed, 19 insertions(+), 16 deletions(-) diff --git a/doc/08-advanced-topics.md b/doc/08-advanced-topics.md index cd1f68119..0cbf93362 100644 --- a/doc/08-advanced-topics.md +++ b/doc/08-advanced-topics.md @@ -455,18 +455,21 @@ considered flapping. If the next seven check results then would not be state changes, the flapping percentage would fall below the lower threshold of 25% and therefore the host or service would recover from flapping. -## Volatile Services - -By default all services remain in a non-volatile state. When a problem -occurs, the `SOFT` state applies and once `max_check_attempts` attribute -is reached with the check counter, a `HARD` state transition happens. -Notifications are only triggered by `HARD` state changes and are then -re-sent defined by the `interval` attribute. - -It may be reasonable to have a volatile service which stays in a `HARD` -state type if the service stays in a `NOT-OK` state. That way each -service recheck will automatically trigger a notification unless the -service is acknowledged or in a scheduled downtime. +## Volatile Services and Hosts + +The `volatile` option, if enabled for a host or service, makes it treat every [state change](03-monitoring-basics.md#hard-soft-states) +as a `HARD` state change. It is comparable to `max_check_attempts = 1`. With this any `NOT-OK` result will +ignore `max_check_attempts` and trigger notifications etc. It will further cause any additional `NOT-OK` +result to re-send notifications. + +It may be reasonable to have a volatile service which stays in a `HARD` state if the service stays in a `NOT-OK` +state. That way each service recheck will automatically trigger a notification unless the service is acknowledged or +in a scheduled downtime. + +A common example are security checks where each `NOT-OK` check result should immediately trigger a notification. + +The default for this option is `false` and should only be enabled when required. + ## Monitoring Icinga 2 diff --git a/doc/09-object-types.md b/doc/09-object-types.md index 698c5c51a..a0e0739ed 100644 --- a/doc/09-object-types.md +++ b/doc/09-object-types.md @@ -729,8 +729,8 @@ Configuration Attributes: event\_command | Object name | **Optional.** The name of an event command that should be executed every time the host's state changes or the host is in a `SOFT` state. flapping\_threshold\_high | Number | **Optional.** Flapping upper bound in percent for a host to be considered flapping. Default `30.0` flapping\_threshold\_low | Number | **Optional.** Flapping lower bound in percent for a host to be considered not flapping. Default `25.0` - volatile | Boolean | **Optional.** The volatile setting enables always `HARD` state types if `NOT-OK` state changes occur. Defaults to false. - zone | Object name | **Optional.** The zone this object is a member of. Please read the [distributed monitoring](06-distributed-monitoring.md#distributed-monitoring) chapter for details. + volatile | Boolean | **Optional.** Treat all state changes as HARD changes. See [here](08-advanced-topics.md#volatile-services-hosts) for details. Defaults to `false`. + zone | Object name | **Optional.** The zone this object is a member of. Please read the [distributed monitoring](06-distributed-monitoring.md#distributed-monitoring) chapter for details. command\_endpoint | Object name | **Optional.** The endpoint where commands are executed on. notes | String | **Optional.** Notes for the host. notes\_url | String | **Optional.** URL for notes for the host (for example, in notification commands). @@ -1454,8 +1454,8 @@ Configuration Attributes: flapping\_threshold\_low | Number | **Optional.** Flapping lower bound in percent for a service to be considered not flapping. `25.0` enable\_perfdata | Boolean | **Optional.** Whether performance data processing is enabled. Defaults to `true`. event\_command | Object name | **Optional.** The name of an event command that should be executed every time the service's state changes or the service is in a `SOFT` state. - volatile | Boolean | **Optional.** The volatile setting enables always `HARD` state types if `NOT-OK` state changes occur. Defaults to `false`. - zone | Object name | **Optional.** The zone this object is a member of. Please read the [distributed monitoring](06-distributed-monitoring.md#distributed-monitoring) chapter for details. + volatile | Boolean | **Optional.** Treat all state changes as HARD changes. See [here](08-advanced-topics.md#volatile-services-hosts) for details. Defaults to `false`. + zone | Object name | **Optional.** The zone this object is a member of. Please read the [distributed monitoring](06-distributed-monitoring.md#distributed-monitoring) chapter for details. name | String | **Required.** The service name. Must be unique on a per-host basis. For advanced usage in [apply rules](03-monitoring-basics.md#using-apply) only. command\_endpoint | Object name | **Optional.** The endpoint where commands are executed on. notes | String | **Optional.** Notes for the service. -- 2.40.0