doc/plugins/OpenStack/aodh_plugin_guide.rst

   1 ..
   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
   6        #
   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
  10        #
  11        #         http://www.apache.org/licenses/LICENSE-2.0
  12        #
  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.
  18        #
  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
  21
  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.
  26
  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.
  29
  30 Supported Alarms
  31 ----------------
  32 Currently the plugin only supports the following alarms for their corresponding
  33 metrics:
  34
  35     +-----------------------------+---------------------------------+
  36     |      Gnocchi Metric         |            Aodh Alarm           |
  37     +-----------------------------+---------------------------------+
  38     | AVERAGE_MEMORY_UTILIZATION  | AVERAGE_MEMORY_UTILIZATION      |
  39     | DISK_READ_OPS               | DISK_READ_OPS                   |
  40     | DISK_WRITE_OPS              | DISK_WRITE_OPS                  |
  41     | DISK_READ_BYTES             | DISK_READ_BYTES                 |
  42     | DISK_WRITE_BYTES            | DISK_WRITE_BYTES                |
  43     | PACKETS_DROPPED             | NET_PACKETS_DROPPED             |
  44     | PACKETS_RECEIVED            | PACKETS_IN_ABOVE_THRESHOLD      |
  45     | PACKETS_SENT                | PACKETS_OUT_ABOVE_THRESHOLD     |
  46     | CPU_UTILIZATION             | CPU_UTILIZATION_ABOVE_THRESHOLD |
  47     +-----------------------------+---------------------------------+
  48
  49 Creating an Alarm
  50 -----------------
  51 To create an alarm for one of the supported metrics a no. of configuration
  52 parameters must be set:
  53
  54 * alarm_name: Defines the name of the alarm and must correspond to the desired
  55   metric.
  56 * metric_name: Defines the name of the metric for which the alarm is to be
  57   created.
  58 * resource_uuid: Defines the resource that the chosen metric will monitor.
  59 * severity: defines the significance of the alarm if it is triggered. Options
  60   for this parameter include:
  61
  62     - WARNING
  63     - MINOR
  64     - MAJOR
  65     - CRITICAL
  66     - INDETERMINATE
  67
  68 * operation: Defines how the metric data is to be evaluated when determining if
  69   the alarm has been triggered. Valid inputs for this parameter include:
  70
  71     - GE (greater than or equal to)
  72     - LE (less that or equal to)
  73     - GT (greater than)
  74     - LT (less than)
  75     - EQ (equal to)
  76
  77 * threshold_value: Defines a threshold that the metric values will be compared
  78   against to determine if the alarm should be triggered.
  79 * statistic: Defines the way in which the metric data should be evaluated.
  80   Valid options for this parameter include:
  81
  82     - AVERAGE
  83     - MINIMUM
  84     - MAXIMUM
  85     - COUNT
  86     - SUM
  87
  88   .. note::
  89
  90       - To create a valid alarm the metric that you request must exist as a
  91         Gnocchi metric and it must exist for the resource requested.
  92       - Multiple alarms can be created for the same metric as you can define
  93         different thresholds, operations, etc. for each alarm.
  94
  95 Deleting an Alarm
  96 -----------------
  97 To delete an alarm just before a delete request with the alarm_id of the alarm
  98 you wish to delete.
  99
 100 Listing Alarms
 101 --------------
 102 A full list of alarms will be generated if a list request is performed and no
 103 configuration parameters are set.
 104
 105 To generate a more specified list you can define one or both of the following
 106 configuration parameters:
 107
 108 * alarm_name
 109 * severity
 110
 111   .. note::
 112
 113     For now resource_uuid must be defined when generating a list of alarms.
 114     This will be removed in a future release.
 115
 116 Updating an alarm
 117 -----------------
 118 Certain parameters of an alarm can be updated after the alarm has been created.
 119 These include:
 120
 121 * threshold_value
 122 * operation
 123 * statistic
 124 * severity