Skip to content
Snippets Groups Projects
Commit 2a27d9d0 authored by Nikolay Stanchev's avatar Nikolay Stanchev
Browse files

Updates documentation on alerts specification

parent 6e280452
No related branches found
No related tags found
No related merge requests found
...@@ -43,8 +43,7 @@ https://github.com/openstack/tosca-parser/blob/master/toscaparser/tests/data/pol ...@@ -43,8 +43,7 @@ https://github.com/openstack/tosca-parser/blob/master/toscaparser/tests/data/pol
The TOSCA Alerts Specification Document consists of two main sections - **metadata** and **policies**. Each **policy** contains a number The TOSCA Alerts Specification Document consists of two main sections - **metadata** and **policies**. Each **policy** contains a number
of triggers. A **trigger** is a fully qualified specification for an alert. Full definitions and clarification of the structure of the document of triggers. A **trigger** is a fully qualified specification for an alert. Full definitions and clarification of the structure of the document
is given in the following sections. An example of a valid alert specification is given in the following sections. An example of a valid alert specification document will look like:
document will look like:
```yaml ```yaml
tosca_definitions_version: tosca_simple_profile_for_nfv_1_0_0 tosca_definitions_version: tosca_simple_profile_for_nfv_1_0_0
...@@ -77,7 +76,7 @@ topology_template: ...@@ -77,7 +76,7 @@ topology_template:
comparison_operator: gt comparison_operator: gt
action: action:
implementation: implementation:
- http://sfemc.flame.eu/notify - flame_sfemc
- http://companyA.alert-handler.flame.eu/high-latency - http://companyA.alert-handler.flame.eu/high-latency
- low_requests_policy: - low_requests_policy:
...@@ -100,7 +99,7 @@ topology_template: ...@@ -100,7 +99,7 @@ topology_template:
comparison_operator: lt comparison_operator: lt
action: action:
implementation: implementation:
- http://sfemc.flame.eu/notify - flame_sfemc
- http://companyA.alert-handler.flame.eu/low-requests - http://companyA.alert-handler.flame.eu/low-requests
- requests_diff_policy: - requests_diff_policy:
...@@ -123,7 +122,7 @@ topology_template: ...@@ -123,7 +122,7 @@ topology_template:
comparison_operator: gte comparison_operator: gte
action: action:
implementation: implementation:
- http://sfemc.flame.eu/notify - flame_sfemc
decrease_in_requests: decrease_in_requests:
description: | description: |
This event triggers when the number of requests has decreased relative to the number of requests received This event triggers when the number of requests has decreased relative to the number of requests received
...@@ -140,7 +139,7 @@ topology_template: ...@@ -140,7 +139,7 @@ topology_template:
comparison_operator: lte comparison_operator: lte
action: action:
implementation: implementation:
- http://sfemc.flame.eu/notify - flame_sfemc
- missing_measurement_policy: - missing_measurement_policy:
type: eu.ict-flame.policies.StateChange type: eu.ict-flame.policies.StateChange
...@@ -158,7 +157,7 @@ topology_template: ...@@ -158,7 +157,7 @@ topology_template:
flame_sfp: storage flame_sfp: storage
action: action:
implementation: implementation:
- http://sfemc.flame.eu/notify - http://companyA.alert-handler.flame.eu/missing-measurements
``` ```
...@@ -200,8 +199,8 @@ topology_template: ...@@ -200,8 +199,8 @@ topology_template:
comparison_operator: <logical operator to use for comparison, e.g. 'gt', 'lt', 'gte', etc. comparison_operator: <logical operator to use for comparison, e.g. 'gt', 'lt', 'gte', etc.
action: action:
implementation: implementation:
- <HTTP Alert Handler URL - receives POST messages from Kapacitor when alerts trigger> - <flame_sfemc or HTTP Alert Handler URL - receives POST messages from Kapacitor when alerts trigger>
- <HTTP Alert Handler URL - receives POST messages from Kapacitor when alerts trigger> - <flame_sfemc or HTTP Alert Handler URL - receives POST messages from Kapacitor when alerts trigger>
... ...
... ...
``` ```
...@@ -245,7 +244,9 @@ For more information on the global tags, please check the [documentation](monito ...@@ -245,7 +244,9 @@ For more information on the global tags, please check the [documentation](monito
* **comparison_operator** - the logical operator to use for comparison - lt (less than), gt (greater than), lte (less than or equal to), etc. * **comparison_operator** - the logical operator to use for comparison - lt (less than), gt (greater than), lte (less than or equal to), etc.
* **implementation** - a list of the URLs of alert handlers to which alert data is sent when the event condition is true. * **implementation** - a list of the URL entries for alert handlers to which alert data is sent when the event condition is true.
If the alert is supposed to be sent to SFEMC, then instead of typing a URL, use **flame_sfemc** - the configurator will generate the correct
SFEMC URL.
##### Event types ##### Event types
...@@ -268,7 +269,7 @@ result of the comparison operation is true, an alert is triggered. For example: ...@@ -268,7 +269,7 @@ result of the comparison operation is true, an alert is triggered. For example:
comparison_operator: gt comparison_operator: gt
action: action:
implementation: implementation:
- http://sfemc.flame.eu/notify - flame_sfemc
- http://companyA.alert-handler.flame.eu/high-latency - http://companyA.alert-handler.flame.eu/high-latency
``` ```
...@@ -313,7 +314,7 @@ threshold. If the result of the comparison operation is true, an alert is trigge ...@@ -313,7 +314,7 @@ threshold. If the result of the comparison operation is true, an alert is trigge
comparison_operator: lte comparison_operator: lte
action: action:
implementation: implementation:
- http://sfemc.flame.eu/notify - flame_sfemc
``` ```
This trigger specification will create an alert task in Kapacitor, which compares every **requests** value reported in This trigger specification will create an alert task in Kapacitor, which compares every **requests** value reported in
...@@ -345,7 +346,7 @@ For example: ...@@ -345,7 +346,7 @@ For example:
flame_sfp: storage flame_sfp: storage
action: action:
implementation: implementation:
- http://sfemc.flame.eu/notify - flame_sfemc
``` ```
This trigger specification will create an alert task in Kapacitor, which monitors the number of points reported in This trigger specification will create an alert task in Kapacitor, which monitors the number of points reported in
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment