2 # Copyright 2017 Intel Research and Development Ireland Limited
3 # *************************************************************
4 # This file is part of OSM Monitoring module
5 # All Rights Reserved to Intel Corporation
7 # Licensed under the Apache License, Version 2.0 (the "License"); you
8 # may not use this file except in compliance with the License. You may
9 # obtain a copy of the License at
11 # http://www.apache.org/licenses/LICENSE-2.0
13 # Unless required by applicable law or agreed to in writing, software
14 # distributed under the License is distributed on an "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
16 # implied. See the License for the specific language governing
17 # permissions and limitations under the License.
19 # For those usages not covered by the Apache License, Version 2.0 please
20 # contact: helena.mcgough@intel.com or adrian.hoban@intel.com
22 Aodh Plugin Guide for OSM MON
23 *****************************
24 The Aodh plugin for the MON module allows an OSM user to utilise the OpenStack
25 alarming functionality.
27 This plugin allows you to create, list, delete and update alarms. These alarms
28 are based on metrics generated by the OpenStack Gnocchi plugin.
32 Currently the plugin only supports the following alarms for their corresponding
35 +-----------------------------+---------------------------------+
36 | Gnocchi Metric | Aodh Alarm |
37 +-----------------------------+---------------------------------+
38 | AVERAGE_MEMORY_UTILIZATION | AVERAGE_MEMORY_UTILIZATION |
40 | DISK_READ_OPS | DISK_READ_OPS |
42 | DISK_WRITE_OPS | DISK_WRITE_OPS |
44 | DISK_READ_BYTES | DISK_READ_BYTES |
46 | DISK_WRITE_BYTES | DISK_WRITE_BYTES |
48 | PACKETS_DROPPED | NET_PACKETS_DROPPED |
50 | PACKETS_RECEIVED | PACKETS_IN_ABOVE_THRESHOLD |
52 | PACKETS_SENT | PACKETS_OUT_ABOVE_THRESHOLD |
54 | CPU_UTILIZATION | CPU_UTILIZATION_ABOVE_THRESHOLD |
55 +-----------------------------+---------------------------------+
59 To create an alarm for one of the supported metrics a no. of configuration
60 parameters must be set:
62 * alarm_name: Defines the name of the alarm and must correspond to the desired
64 * metric_name: Defines the name of the metric for which the alarm is to be
66 * resource_uuid: Defines the resource that the chosen metric will monitor.
67 * severity: defines the significance of the alarm if it is triggered. Options
68 for this parameter include:
76 * operation: Defines how the metric data is to be evaluated when determining if
77 the alarm has been triggered. Valid inputs for this parameter include:
79 - GE (greater than or equal to)
80 - LE (less that or equal to)
85 * threshold_value: Defines a threshold that the metric values will be compared
86 against to determine if the alarm should be triggered.
87 * statistic: Defines the way in which the metric data should be evaluated.
88 Valid options for this parameter include:
98 - To create a valid alarm the metric that you request must exist as a
99 Gnocchi metric and it must exist for the resource requested.
100 - Multiple alarms can be created for the same metric as you can define
101 different thresholds, operations, etc. for each alarm.
105 To delete an alarm just before a delete request with the alarm_id of the alarm
110 A full list of alarms will be generated if a list request is performed and no
111 configuration parameters are set.
113 To generate a more specified list you can define one or both of the following
114 configuration parameters:
121 For now resource_uuid must be defined when generating a list of alarms.
122 This will be removed in a future release.
126 Certain parameters of an alarm can be updated after the alarm has been created.