tyler.durden
/
icinga2
mirror of https://github.com/Icinga/icinga2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add documentation for new attributes in `Flapping` API event stream type

This commit is contained in:
Michael Friedrich 2017-11-08 10:17:05 +01:00
parent 872d4895f0
commit 026f6d6f2e
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/12-icinga2-api.md
View File

@ -1300,15 +1300,18 @@ Example for all downtime events:
#### <a id="icinga2-api-event-streams-type-flapping"></a> Event Stream Type: Flapping
Name | Type | Description
--------------|---------------|--------------------------
type | String | Event type `Flapping`.
timestamp | Timestamp | Unix timestamp when the event happened.
host | String | [Host](09-object-types.md#objecttype-host) name.
service | String | [Service](09-object-types.md#objecttype-service) name. Optional if this is a host flapping event.
state | Number | [Host](09-object-types.md#objecttype-host) or [service](09-object-types.md#objecttype-service) state.
state\_type | Number | [Host](09-object-types.md#objecttype-host) or [service](09-object-types.md#objecttype-service) state type.
is\_flapping | Boolean | Whether this object is flapping.
Name | Type | Description
------------------|---------------|--------------------------
type | String | Event type `Flapping`.
timestamp | Timestamp | Unix timestamp when the event happened.
host | String | [Host](09-object-types.md#objecttype-host) name.
service | String | [Service](09-object-types.md#objecttype-service) name. Optional if this is a host flapping event.
state | Number | [Host](09-object-types.md#objecttype-host) or [service](09-object-types.md#objecttype-service) state.
state\_type | Number | [Host](09-object-types.md#objecttype-host) or [service](09-object-types.md#objecttype-service) state type.
is\_flapping | Boolean | Whether this object is flapping.
current\_flapping | Number | Current flapping value in percent (added in 2.8).
threshold\_low | Number | Low threshold in percent (added in 2.8).
threshold\_high | Number | High threshold in percent (added in 2.8).
#### <a id="icinga2-api-event-streams-type-acknowledgementset"></a> Event Stream Type: AcknowledgementSet