Refactors codebase
[osm/MON.git] / osm_mon / plugins / OpenStack / Aodh / alarming.py
diff --git a/osm_mon/plugins/OpenStack/Aodh/alarming.py b/osm_mon/plugins/OpenStack/Aodh/alarming.py
deleted file mode 100644 (file)
index 453e77c..0000000
+++ /dev/null
@@ -1,404 +0,0 @@
-# Copyright 2017 Intel Research and Development Ireland Limited
-# *************************************************************
-
-# This file is part of OSM Monitoring module
-# All Rights Reserved to Intel Corporation
-
-# 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.
-
-# For those usages not covered by the Apache License, Version 2.0 please
-# contact: helena.mcgough@intel.com or adrian.hoban@intel.com
-##
-"""Carry out alarming requests via Aodh API."""
-
-import json
-import logging
-from json import JSONDecodeError
-
-import six
-import yaml
-
-from osm_mon.core.auth import AuthManager
-from osm_mon.core.database import DatabaseManager
-from osm_mon.core.message_bus.producer import KafkaProducer
-from osm_mon.core.settings import Config
-from osm_mon.plugins.OpenStack.Gnocchi.metrics import METRIC_MAPPINGS
-from osm_mon.plugins.OpenStack.common import Common
-from osm_mon.plugins.OpenStack.response import OpenStack_Response
-
-log = logging.getLogger(__name__)
-
-SEVERITIES = {
-    "warning": "low",
-    "minor": "low",
-    "major": "moderate",
-    "critical": "critical",
-    "indeterminate": "critical"}
-
-STATISTICS = {
-    "average": "mean",
-    "minimum": "min",
-    "maximum": "max",
-    "count": "count",
-    "sum": "sum"}
-
-
-class Alarming(object):
-    """Carries out alarming requests and responses via Aodh API."""
-
-    def __init__(self):
-        """Create the OpenStack alarming instance."""
-        self._database_manager = DatabaseManager()
-        self._auth_manager = AuthManager()
-
-        # Use the Response class to generate valid json response messages
-        self._response = OpenStack_Response()
-
-        # Initializer a producer to send responses back to SO
-        self._producer = KafkaProducer("alarm_response")
-
-    def alarming(self, message, vim_uuid):
-        """
-        Processes alarm request message depending on it's key
-        :param message: Message containing key and value attributes. This last one can be in JSON or YAML format.
-        :param vim_uuid: UUID of the VIM to handle the alarm request.
-        :return:
-        """
-        try:
-            values = json.loads(message.value)
-        except JSONDecodeError:
-            values = yaml.safe_load(message.value)
-
-        log.info("OpenStack alarm action required.")
-
-        verify_ssl = self._auth_manager.is_verify_ssl(vim_uuid)
-
-        auth_token = Common.get_auth_token(vim_uuid, verify_ssl=verify_ssl)
-
-        alarm_endpoint = Common.get_endpoint("alarming", vim_uuid, verify_ssl=verify_ssl)
-        metric_endpoint = Common.get_endpoint("metric", vim_uuid, verify_ssl=verify_ssl)
-
-        vim_account = self._auth_manager.get_credentials(vim_uuid)
-        vim_config = json.loads(vim_account.config)
-
-        if message.key == "create_alarm_request":
-            alarm_details = values['alarm_create_request']
-            alarm_id = None
-            status = False
-            try:
-                metric_name = alarm_details['metric_name'].lower()
-                resource_id = alarm_details['resource_uuid']
-
-                self.check_for_metric(auth_token, metric_endpoint, metric_name, resource_id, verify_ssl)
-
-                alarm_id = self.configure_alarm(
-                    alarm_endpoint, auth_token, alarm_details, vim_config, verify_ssl)
-
-                log.info("Alarm successfully created")
-                self._database_manager.save_alarm(alarm_id,
-                                                  vim_uuid,
-                                                  alarm_details['threshold_value'],
-                                                  alarm_details['operation'].lower(),
-                                                  alarm_details['metric_name'].lower(),
-                                                  alarm_details['vdu_name'].lower(),
-                                                  alarm_details['vnf_member_index'],
-                                                  alarm_details['ns_id'].lower()
-                                                  )
-                status = True
-            except Exception as e:
-                log.exception("Error creating alarm")
-                raise e
-            finally:
-                self._generate_and_send_response('create_alarm_response',
-                                                 alarm_details['correlation_id'],
-                                                 status=status,
-                                                 alarm_id=alarm_id)
-
-        elif message.key == "list_alarm_request":
-            list_details = values['alarm_list_request']
-            alarm_list = None
-            try:
-                alarm_list = self.list_alarms(
-                    alarm_endpoint, auth_token, list_details, verify_ssl)
-            except Exception as e:
-                log.exception("Error listing alarms")
-                raise e
-            finally:
-                self._generate_and_send_response('list_alarm_response',
-                                                 list_details['correlation_id'],
-                                                 alarm_list=alarm_list)
-
-        elif message.key == "delete_alarm_request":
-            request_details = values['alarm_delete_request']
-            alarm_id = request_details['alarm_uuid']
-            status = False
-            try:
-                self.delete_alarm(
-                    alarm_endpoint, auth_token, alarm_id, verify_ssl)
-                status = True
-            except Exception as e:
-                log.exception("Error deleting alarm")
-                raise e
-            finally:
-                self._generate_and_send_response('delete_alarm_response',
-                                                 request_details['correlation_id'],
-                                                 status=status,
-                                                 alarm_id=alarm_id)
-
-        elif message.key == "acknowledge_alarm":
-            try:
-                alarm_id = values['ack_details']['alarm_uuid']
-
-                self.update_alarm_state(
-                    alarm_endpoint, auth_token, alarm_id, verify_ssl)
-
-                log.info("Acknowledged the alarm and cleared it.")
-            except Exception as e:
-                log.exception("Error acknowledging alarm")
-                raise e
-
-        elif message.key == "update_alarm_request":
-            # Update alarm configurations
-            alarm_details = values['alarm_update_request']
-            alarm_id = None
-            status = False
-            try:
-                alarm_id = self.update_alarm(
-                    alarm_endpoint, auth_token, alarm_details, vim_config, verify_ssl)
-                status = True
-            except Exception as e:
-                log.exception("Error updating alarm")
-                raise e
-            finally:
-                self._generate_and_send_response('update_alarm_response',
-                                                 alarm_details['correlation_id'],
-                                                 status=status,
-                                                 alarm_id=alarm_id)
-
-        else:
-            log.debug("Unknown key, no action will be performed")
-
-    def configure_alarm(self, alarm_endpoint, auth_token, values, vim_config, verify_ssl):
-        """Create requested alarm in Aodh."""
-        url = "{}/v2/alarms/".format(alarm_endpoint)
-
-        # Check if the desired alarm is supported
-        alarm_name = values['alarm_name'].lower()
-        metric_name = values['metric_name'].lower()
-        resource_id = values['resource_uuid']
-
-        if metric_name not in METRIC_MAPPINGS.keys():
-            raise KeyError("Metric {} is not supported.".format(metric_name))
-
-        #FIXME
-        if 'granularity' in vim_config and 'granularity' not in values:
-            values['granularity'] = vim_config['granularity']
-        payload = self.check_payload(values, metric_name, resource_id,
-                                     alarm_name)
-        new_alarm = Common.perform_request(
-            url, auth_token, req_type="post", payload=payload, verify_ssl=verify_ssl)
-        return json.loads(new_alarm.text)['alarm_id']
-
-    def delete_alarm(self, endpoint, auth_token, alarm_id, verify_ssl):
-        """Delete alarm function."""
-        url = "{}/v2/alarms/%s".format(endpoint) % alarm_id
-
-        result = Common.perform_request(
-            url, auth_token, req_type="delete", verify_ssl=verify_ssl)
-        if str(result.status_code) == "404":
-            raise ValueError("Alarm {} doesn't exist".format(alarm_id))
-
-    def list_alarms(self, endpoint, auth_token, list_details, verify_ssl):
-        """Generate the requested list of alarms."""
-        url = "{}/v2/alarms/".format(endpoint)
-        a_list, name_list, sev_list, res_list = [], [], [], []
-
-        # TODO(mcgoughh): for now resource_id is a mandatory field
-        # Check for a resource id
-        try:
-            resource = list_details['resource_uuid']
-            name = list_details['alarm_name'].lower()
-            severity = list_details['severity'].lower()
-            sev = SEVERITIES[severity]
-        except KeyError as e:
-            log.warning("Missing parameter for alarm list request: %s", e)
-            raise e
-
-        # Perform the request to get the desired list
-        try:
-            result = Common.perform_request(
-                url, auth_token, req_type="get", verify_ssl=verify_ssl)
-
-            if result is not None:
-                # Get list based on resource id
-                for alarm in json.loads(result.text):
-                    rule = alarm['gnocchi_resources_threshold_rule']
-                    if resource == rule['resource_id']:
-                        res_list.append(alarm['alarm_id'])
-
-                # Generate specified listed if requested
-                if name is not None and sev is not None:
-                    log.info("Return a list of %s alarms with %s severity.",
-                             name, sev)
-                    for alarm in json.loads(result.text):
-                        if name == alarm['name']:
-                            name_list.append(alarm['alarm_id'])
-                    for alarm in json.loads(result.text):
-                        if sev == alarm['severity']:
-                            sev_list.append(alarm['alarm_id'])
-                    name_sev_list = list(set(name_list).intersection(sev_list))
-                    a_list = list(set(name_sev_list).intersection(res_list))
-                elif name is not None:
-                    log.info("Returning a %s list of alarms.", name)
-                    for alarm in json.loads(result.text):
-                        if name == alarm['name']:
-                            name_list.append(alarm['alarm_id'])
-                    a_list = list(set(name_list).intersection(res_list))
-                elif sev is not None:
-                    log.info("Returning %s severity alarm list.", sev)
-                    for alarm in json.loads(result.text):
-                        if sev == alarm['severity']:
-                            sev_list.append(alarm['alarm_id'])
-                    a_list = list(set(sev_list).intersection(res_list))
-                else:
-                    log.info("Returning an entire list of alarms.")
-                    a_list = res_list
-            else:
-                log.info("There are no alarms!")
-            response_list = []
-            for alarm in json.loads(result.text):
-                if alarm['alarm_id'] in a_list:
-                    response_list.append(alarm)
-            return response_list
-
-        except Exception as e:
-            log.exception("Failed to generate alarm list: ")
-            raise e
-
-    def update_alarm_state(self, endpoint, auth_token, alarm_id, verify_ssl):
-        """Set the state of an alarm to ok when ack message is received."""
-        url = "{}/v2/alarms/%s/state".format(endpoint) % alarm_id
-        payload = json.dumps("ok")
-
-        Common.perform_request(
-            url, auth_token, req_type="put", payload=payload, verify_ssl=verify_ssl)
-
-    def update_alarm(self, endpoint, auth_token, values, vim_config, verify_ssl):
-        """Get alarm name for an alarm configuration update."""
-        # Get already existing alarm details
-        url = "{}/v2/alarms/%s".format(endpoint) % values['alarm_uuid']
-
-        # Gets current configurations about the alarm
-        result = Common.perform_request(
-            url, auth_token, req_type="get")
-        alarm_name = json.loads(result.text)['name']
-        rule = json.loads(result.text)['gnocchi_resources_threshold_rule']
-        alarm_state = json.loads(result.text)['state']
-        resource_id = rule['resource_id']
-        metric_name = [key for key, value in six.iteritems(METRIC_MAPPINGS) if value == rule['metric']][0]
-
-        # Generates and check payload configuration for alarm update
-        if 'granularity' in vim_config and 'granularity' not in values:
-            values['granularity'] = vim_config['granularity']
-        payload = self.check_payload(values, metric_name, resource_id,
-                                     alarm_name, alarm_state=alarm_state)
-
-        # Updates the alarm configurations with the valid payload
-        update_alarm = Common.perform_request(
-            url, auth_token, req_type="put", payload=payload, verify_ssl=verify_ssl)
-
-        return json.loads(update_alarm.text)['alarm_id']
-
-    def check_payload(self, values, metric_name, resource_id,
-                      alarm_name, alarm_state=None):
-        """Check that the payload is configuration for update/create alarm."""
-        cfg = Config.instance()
-        # Check state and severity
-
-        severity = 'critical'
-        if 'severity' in values:
-            severity = values['severity'].lower()
-
-        if severity == "indeterminate":
-            alarm_state = "insufficient data"
-        if alarm_state is None:
-            alarm_state = "ok"
-
-        statistic = values['statistic'].lower()
-
-        granularity = cfg.OS_DEFAULT_GRANULARITY
-        if 'granularity' in values:
-            granularity = values['granularity']
-
-        resource_type = 'generic'
-        if 'resource_type' in values:
-            resource_type = values['resource_type'].lower()
-
-        # Try to configure the payload for the update/create request
-        # Can only update: threshold, operation, statistic and
-        # the severity of the alarm
-        rule = {'threshold': values['threshold_value'],
-                'comparison_operator': values['operation'].lower(),
-                'metric': METRIC_MAPPINGS[metric_name],
-                'resource_id': resource_id,
-                'resource_type': resource_type,
-                'aggregation_method': STATISTICS[statistic],
-                'granularity': granularity, }
-        payload = json.dumps({'state': alarm_state,
-                              'name': alarm_name,
-                              'severity': SEVERITIES[severity],
-                              'type': 'gnocchi_resources_threshold',
-                              'gnocchi_resources_threshold_rule': rule,
-                              'alarm_actions': [cfg.OS_NOTIFIER_URI],
-                              'repeat_actions': True}, sort_keys=True)
-        return payload
-
-    def get_alarm_state(self, endpoint, auth_token, alarm_id):
-        """Get the state of the alarm."""
-        url = "{}/v2/alarms/%s/state".format(endpoint) % alarm_id
-
-        alarm_state = Common.perform_request(
-            url, auth_token, req_type="get")
-        return json.loads(alarm_state.text)
-
-    def check_for_metric(self, auth_token, metric_endpoint, metric_name, resource_id, verify_ssl):
-        """
-        Checks if resource has a specific metric. If not, throws exception.
-        :param auth_token: OpenStack auth token
-        :param metric_endpoint: OpenStack metric endpoint
-        :param metric_name: Metric name
-        :param resource_id: Resource UUID
-        :return: Metric details from resource
-        :raise Exception: Could not retrieve metric from resource
-        """
-        try:
-            url = "{}/v1/resource/generic/{}".format(metric_endpoint, resource_id)
-            result = Common.perform_request(
-                url, auth_token, req_type="get", verify_ssl=verify_ssl)
-            resource = json.loads(result.text)
-            metrics_dict = resource['metrics']
-            return metrics_dict[METRIC_MAPPINGS[metric_name]]
-        except Exception as e:
-            log.exception("Desired Gnocchi metric not found:", e)
-            raise e
-
-    def _generate_and_send_response(self, key, correlation_id, **kwargs):
-        try:
-            resp_message = self._response.generate_response(
-                key, cor_id=correlation_id, **kwargs)
-            log.info("Response Message: %s", resp_message)
-            self._producer.publish_alarm_response(
-                key, resp_message)
-        except Exception as e:
-            log.exception("Response creation failed:")
-            raise e