tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-07-26 23:24:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6224 from Icinga/fix/volatile-docs

Browse Source 
Update volatile docs
This commit is contained in:
Michael Friedrich 2018-04-12 19:02:07 +02:00 committed by GitHub
commit 8ebd33537f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/08-advanced-topics.md
View File

@ -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 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. of 25% and therefore the host or service would recover from flapping.
## Volatile Services <a id="volatile-services"></a> ## Volatile Services and Hosts <a id="volatile-services-hosts"></a>
By default all services remain in a non-volatile state. When a problem The `volatile` option, if enabled for a host or service, makes it treat every [state change](03-monitoring-basics.md#hard-soft-states)
occurs, the `SOFT` state applies and once `max_check_attempts` attribute as a `HARD` state change. It is comparable to `max_check_attempts = 1`. With this any `NOT-OK` result will
is reached with the check counter, a `HARD` state transition happens. ignore `max_check_attempts` and trigger notifications etc. It will further cause any additional `NOT-OK`
Notifications are only triggered by `HARD` state changes and are then result to re-send notifications.
re-sent defined by the `interval` attribute.
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.
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.
## Monitoring Icinga 2 <a id="monitoring-icinga"></a> ## Monitoring Icinga 2 <a id="monitoring-icinga"></a>

8
doc/09-object-types.md
View File

@ -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. 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\_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` 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. 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. 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. command\_endpoint | Object name | **Optional.** The endpoint where commands are executed on.
notes | String | **Optional.** Notes for the host. notes | String | **Optional.** Notes for the host.
notes\_url | String | **Optional.** URL for notes for the host (for example, in notification commands). 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` 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`. 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. 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`. 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. 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. 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. command\_endpoint | Object name | **Optional.** The endpoint where commands are executed on.
notes | String | **Optional.** Notes for the service. notes | String | **Optional.** Notes for the service.