collectd-openstack-plugins/doc/source/alarms_guide.rst
rajat29 eef5c8dce0 Inconsistent capitalization on Gnocchi, Aodh, OpenStack in docs
Docs use inconsistent capitalisation of Gnocchi, Aodh, OpenStack, etc.
Ref: https://docs.openstack.org/contributor-guide/writing-style/openstack-components.html

Change-Id: Ia1ea04d4cf45e33f0257226e09e5a4da5275c4ad
Closes-Bug:#1708667
2017-08-29 03:51:49 +00:00

2.8 KiB

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>