]> granicus.if.org Git - icinga2/commitdiff
Add documentation for new attributes in `Flapping` API event stream type
authorMichael Friedrich <michael.friedrich@icinga.com>
Wed, 8 Nov 2017 09:17:05 +0000 (10:17 +0100)
committerMichael Friedrich <michael.friedrich@icinga.com>
Wed, 8 Nov 2017 09:17:05 +0000 (10:17 +0100)
doc/12-icinga2-api.md

index b22b2fccb39cdb1677f6b4ef85a577be6ad6b04d..1f0d5b6bffcd1741cb2f7de828f7b1bb700f0db4 100644 (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