..
      Licensed under the Apache License, Version 2.0 (the "License"); you may
      not use this file except in compliance with the License. You may obtain
      a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
      License for the specific language governing permissions and limitations
      under the License.
      Convention for heading levels in collectd-ceilometer-plugin documentation:

      =======  Heading 0 (reserved for the title in a document)
      -------  Heading 1
      ~~~~~~~  Heading 2
      +++++++  Heading 3
      '''''''  Heading 4

      Avoid deeper levels because they do not render well.

=========================================
Enabling Alarms for plugin metrics/meters
=========================================

This guide provides a description of what aodh features are available when the
collectd-gnocchi plugin is enabled. It provides a list of the alarms that can be
created and how to create them.

Gnocchi Based Alarms
--------------------

There are three types of gnocchi based alarms that can be created using aodh:

- gnocchi_resources_threshold
- gnocchi_aggregation_by_metrics_threshold
- gnocchi_aggregation_by_resources_threshold

 .. note::

       Currently, the metrics created by the collectd-gnocchi-plugin don't
       support the creation of gnocchi_resources_threshold alarms or
       gnocchi_aggregation_by_resources_threshold alarms.

To create a simple gnocchi_aggregation_by_metrics_threshold alarm:

- Type the following;

::

  aodh alarm create

- In the same command specify the name, type, metrics, threshold and
  aggregation method of your desired alarm. This alarm can be defined for one
  or a list of metrics.

::

  --name <ALARM_NAME>
  -t gnocchi_aggregation_by_metrics_threshold
  --threshold <THRESHOLD>
  --metrics <LIST_OF_METRICS>
  --aggregation-method <AGGREGATION_METHOD>



Event Alarms
------------

Event alarms can be created for any gnocchi metric. They would be triggered based
on the status of the event defined for the alarm.

- To create event alarms enter the following command;

::

  aodh alarm create
  --name <ALARM_NAME>
  -t event
  --event-type <EVENT_TYPE>


Composite Alarms
----------------

Like event alarms, composite alarms can be created for the gnocchi plugin.
A composite alarm is created by combining more than one type of alarm.
Hence you can combine alarms based on Gnocchi metrics with alarms from other
sources.

- Composite alarms are generated by the following command;

::

  aodh alarm create
  --name <ALARM_NAME>
  -t composite
  --composite-rule <COMPOSITE_RULE>