openstack
/
aodh
Code Issues Proposed changes

Merge "Add composite alarm usage description"

This commit is contained in:
Jenkins 2016-03-01 15:32:41 +00:00 committed by Gerrit Code Review
parent c57f5877ad 0ed69200a2
commit 27fb5f735c
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/source/webapi/v2.rst
View File

@ -89,3 +89,32 @@ The *filter*, *orderby* and *limit* are all optional fields in a query.
.. autotype:: aodh.api.controllers.v2.query.ComplexQuery
:members:
Composite rule Alarm
====================
The *composite* type alarm allows users to specify a composite rule to define
an alarm with multiple triggering conditions, using a combination of *and* and
*or* relations. A composite rule is composed of multiple threshold rules or
gnocchi rules. A sample composite alarm request form is as follows::
{
"name": "test_composite",
"type": "composite",
"composite_rule": {
"and": [THRESHOLD_RULE1, THRESHOLD_RULE2, {
'or': [THRESHOLD_RULE3, GNOCCHI_RULE1,
GNOCCHI_RULE2, GNOCCHI_RULE3]
}]
}
}
A sub-rule in composite_rule is same as a threshold_rule in threshold alarm
or a gnocchi_rule in gnocchi alarm. Additionally it has a mandatory *type*
field to specify the rule type, like in the following sample::
{
"threshold": 0.8,
"meter_name": "cpu_util",
"type": "threshold"
}