From 2a27d9d07babefdf62caa02e8237079975b9a63a Mon Sep 17 00:00:00 2001 From: Nikolay Stanchev <ns17@it-innovation.soton.ac.uk> Date: Fri, 5 Oct 2018 13:09:40 +0100 Subject: [PATCH] Updates documentation on alerts specification --- docs/AlertsSpecification.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/AlertsSpecification.md b/docs/AlertsSpecification.md index a5391d8..e072f33 100644 --- a/docs/AlertsSpecification.md +++ b/docs/AlertsSpecification.md @@ -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 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 -document will look like: +is given in the following sections. An example of a valid alert specification document will look like: ```yaml tosca_definitions_version: tosca_simple_profile_for_nfv_1_0_0 @@ -77,7 +76,7 @@ topology_template: comparison_operator: gt action: implementation: - - http://sfemc.flame.eu/notify + - flame_sfemc - http://companyA.alert-handler.flame.eu/high-latency - low_requests_policy: @@ -100,7 +99,7 @@ topology_template: comparison_operator: lt action: implementation: - - http://sfemc.flame.eu/notify + - flame_sfemc - http://companyA.alert-handler.flame.eu/low-requests - requests_diff_policy: @@ -123,7 +122,7 @@ topology_template: comparison_operator: gte action: implementation: - - http://sfemc.flame.eu/notify + - flame_sfemc decrease_in_requests: description: | This event triggers when the number of requests has decreased relative to the number of requests received @@ -140,7 +139,7 @@ topology_template: comparison_operator: lte action: implementation: - - http://sfemc.flame.eu/notify + - flame_sfemc - missing_measurement_policy: type: eu.ict-flame.policies.StateChange @@ -158,7 +157,7 @@ topology_template: flame_sfp: storage action: implementation: - - http://sfemc.flame.eu/notify + - http://companyA.alert-handler.flame.eu/missing-measurements ``` @@ -200,8 +199,8 @@ topology_template: comparison_operator: <logical operator to use for comparison, e.g. 'gt', 'lt', 'gte', etc. action: implementation: - - <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> + - <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 * **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 @@ -268,7 +269,7 @@ result of the comparison operation is true, an alert is triggered. For example: comparison_operator: gt action: implementation: - - http://sfemc.flame.eu/notify + - flame_sfemc - 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 comparison_operator: lte action: 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 @@ -345,7 +346,7 @@ For example: flame_sfp: storage action: 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 -- GitLab