openstack/monasca-api
Code Issues Proposed changes

Update alarm expression documentation

Browse Source 
Change-Id: I9c41569e05ff7d1839af3c904d4e4ae78334ff6a
This commit is contained in:
Deklan Dieterly
2014-10-20 13:48:22 -06:00
parent 0e1cae011b
commit 33066e4107
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/monasca-api-spec.md
View File

@@ -88,7 +88,7 @@ An alarm expression is a boolean equation which if it evaluates to true with the
### Syntax
At the highest level, you have an expression, which is made up of one or more subexpressions, joined by boolean logic. Parenthesis can be used for separators. In a BNF style format:
At the highest level, you have an expression, which is made up of one or more subexpressions, joined by boolean logic. Parenthesis can be used for separators. In a BNF style format where items enclosed in [] are optional:
```
expression
@@ -112,7 +112,7 @@ Each subexpression is made up of several parts with a couple of options:
```
subexpression
: metric relational_operator threshold_value
| function '(' metric ',' period ')' relational_operator threshold_value ('times' periods)?
| function '(' metric [',' period] ')' relational_operator threshold_value ['times' periods]
```
A metric can be a metric name only or a metric name followed by a list of dimensions. The dimensions further qualify the metric name.
@@ -133,6 +133,11 @@ dimension
````
The relational_operators are: `lt` (also `<`), `gt` (also `>`), `lte` (also `<=`), `gte` (also `>=`).
```
relational_operator
: 'min' | 'max' | 'sum' | 'count' | 'avg'
```
Threshold values are always in the same units as the metric that they are being compared to.