diff --git a/docs/AlertsSpecification.md b/docs/AlertsSpecification.md index 6fdbb2f4196c83bce2b1eac4fe0a777216ad8c07..a2ea4c8f6315cff7da3ef39d5d9ae695649ac668 100644 --- a/docs/AlertsSpecification.md +++ b/docs/AlertsSpecification.md @@ -94,7 +94,7 @@ topology_template: granularity: 60 aggregation_method: last resource_type: - sf_package: storage + sfp: storage sf: storage-users location: watershed comparison_operator: lt @@ -116,8 +116,11 @@ topology_template: threshold: 100 # requests have increased by at least 100 granularity: 120 resource_type: - sf_package: storage + sfc: companyA-VR + sfci: companyA-VR-premium + sfp: storage sf: storage-users + server: watershed location: watershed comparison_operator: gte action: @@ -133,7 +136,7 @@ topology_template: threshold: -100 # requests have decreased by at least 100 granularity: 120 resource_type: - sf_package: storage + sfp: storage sf: storage-users location: watershed comparison_operator: lte @@ -154,7 +157,7 @@ topology_template: threshold: 0 # if requests are less than or equal to 0 (in other words, no measurements are reported) granularity: 60 # check for for missing data for the last 60 seconds resource_type: - sf_package: storage + sfp: storage action: implementation: - http://sfemc.flame.eu/notify @@ -208,18 +211,19 @@ topology_template: ##### Definitions -* **policy_identifier** - policy label which should match with a StateChange policy in the TOSCA resource specification document -submitted to the FLAME Orchestrator for consistency. +* **policy_identifier** - policy label which MUST match with a StateChange policy in the TOSCA resource specification document +submitted to the FLAME Orchestrator. * **event_identifier** - the name of the event that **MUST** match with the *constraint* event name referenced in the TOSCA resource specification document submitted to the FLAME Orchestrator. * **event_type** - the type of TICK Script template to use to create the alert - more information will be provided about -the different options here, but we assume the most common one will be **threshold**. Other supported types are **relative** -and **deadman**. +the different options here, but we assume the most common one will be **threshold**. Currently, the other supported types are +**relative** and **deadman**. * **metric** - the metric to query in InfluxDB, must include measurement name and field name in -format `<measurement>`.`<field>`. The only exception is when a **deadman** event type is used, where the `<field>` +format `<measurement>`.`<field>`. The only exception is when a **deadman** event type is used - then the `<field>`is not used, but +the format is still the same for consistency. Therefore, using `<measurement>.*` will be sufficient. * **threshold** - * for **threshold** event type, this is the critical value the queried metric is compared to. @@ -235,8 +239,9 @@ format `<measurement>`.`<field>`. The only exception is when a **deadman** event the event_type is set to **threshold**. * **resource_type** - provides context for the given event - key-value pairs for the global tags of the CLMC Information Model. -This includes any of the following: `"sfc", "sfci", "sf_package", "sf", "sf_endpoint", "host", "location"`. Keep in mind that +This includes any of the following: `"sfc", "sfci", "sfp", "sf", "sfe", "server", "location"`. Keep in mind that filtering for **sfc** and **sfci** is automatically generated by extracting the metadata values from the alerts specification. +For more information on the global tags, please check the [documentation](monitoring.md). * **comparison_operator** - the logical operator to use for comparison - lt (less than), gt (greater than), lte (less than or equal to), etc. @@ -302,7 +307,7 @@ threshold. If the result of the comparison operation is true, an alert is trigge threshold: -100 granularity: 120 resource_type: - sf_package: storage + sfp: storage sf: storage-users location: watershed comparison_operator: lte @@ -337,21 +342,21 @@ For example: threshold: 0 granularity: 60 resource_type: - sf_package: storage + sfp: storage action: implementation: - http://sfemc.flame.eu/notify ``` This trigger specification will create an alert task in Kapacitor, which monitors the number of points reported in - measurement **storage** and having tag **sf_package** set as **storage**. This value is computed every 60 seconds. + measurement **storage** and having tag **sfp** set as **storage**. This value is computed every 60 seconds. If the number of reported points is less than **0** (no points have been reported for the last 60 seconds), an alert will be triggered. Triggered alerts will be sent through an HTTP POST message to the URLs listed in the **implementation** section. *Notes*: * **metric** only requires the measurement name in this event type and doesn't require a field name - * the trigger specification still needs to be consisten with the parsing rule for **metric**: `<measurement>`.`<field>` + * the trigger specification still needs to be consistent with the parsing rule for **metric**: `<measurement>`.`<field>` * simply putting a `*` for field is sufficient, e.g. `storage.*` * even if you put something else for field value, it will be ignored - only the **measurement** name is used * **aggregation_method** is not required in this event type, any values provided will be ignored