policy_module/osm_policy_module/core/agent.py

   1 # -*- coding: utf-8 -*-
   2
   3 # Copyright 2018 Whitestack, LLC
   4 # *************************************************************
   5
   6 # This file is part of OSM Monitoring module
   7 # All Rights Reserved to Whitestack, LLC
   8
   9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
  10 # not use this file except in compliance with the License. You may obtain
  11 # a copy of the License at
  12
  13 #         http://www.apache.org/licenses/LICENSE-2.0
  14
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  18 # License for the specific language governing permissions and limitations
  19 # under the License.
  20
  21 # For those usages not covered by the Apache License, Version 2.0 please
  22 # contact: bdiaz@whitestack.com or glavado@whitestack.com
  23 ##
  24 import json
  25 import logging
  26 from typing import Dict, List
  27
  28 import yaml
  29 from kafka import KafkaConsumer
  30 from osm_policy_module.common.alarm_config import AlarmConfig
  31 from osm_policy_module.common.lcm_client import LcmClient
  32 from osm_policy_module.common.mon_client import MonClient
  33 from osm_policy_module.core.config import Config
  34 from osm_policy_module.core.database import ScalingRecord, ScalingAlarm
  35
  36 log = logging.getLogger(__name__)
  37
  38
  39 class PolicyModuleAgent:
  40     def run(self):
  41         cfg = Config.instance()
  42         # Initialize servers
  43         kafka_server = '{}:{}'.format(cfg.get('policy_module', 'kafka_server_host'),
  44                                       cfg.get('policy_module', 'kafka_server_port'))
  45
  46         # Initialize Kafka consumer
  47         log.info("Connecting to Kafka server at %s", kafka_server)
  48         # TODO: Add logic to handle deduplication of messages when using group_id.
  49         # See: https://stackoverflow.com/a/29836412
  50         consumer = KafkaConsumer(bootstrap_servers=kafka_server,
  51                                  key_deserializer=bytes.decode,
  52                                  value_deserializer=bytes.decode)
  53         consumer.subscribe(['lcm_pm', 'alarm_response'])
  54
  55         for message in consumer:
  56             log.info("Message arrived: %s", message)
  57             try:
  58                 if message.key == 'configure_scaling':
  59                     try:
  60                         content = json.loads(message.value)
  61                     except:
  62                         content = yaml.safe_load(message.value)
  63                     log.info("Creating scaling record in DB")
  64                     # TODO: Use transactions: http://docs.peewee-orm.com/en/latest/peewee/transactions.html
  65                     scaling_record = ScalingRecord.create(
  66                         nsr_id=content['ns_id'],
  67                         name=content['scaling_group_descriptor']['name'],
  68                         content=json.dumps(content)
  69                     )
  70                     log.info("Created scaling record in DB : nsr_id=%s, name=%s, content=%s",
  71                              scaling_record.nsr_id,
  72                              scaling_record.name,
  73                              scaling_record.content)
  74                     alarm_configs = self._get_alarm_configs(content)
  75                     for config in alarm_configs:
  76                         mon_client = MonClient()
  77                         log.info("Creating alarm record in DB")
  78                         alarm_uuid = mon_client.create_alarm(
  79                             metric_name=config.metric_name,
  80                             ns_id=scaling_record.nsr_id,
  81                             vdu_name=config.vdu_name,
  82                             vnf_member_index=config.vnf_member_index,
  83                             threshold=config.threshold,
  84                             operation=config.operation,
  85                             statistic=config.statistic
  86                         )
  87                         ScalingAlarm.create(
  88                             alarm_id=alarm_uuid,
  89                             action=config.action,
  90                             scaling_record=scaling_record
  91                         )
  92                 if message.key == 'notify_alarm':
  93                     content = json.loads(message.value)
  94                     alarm_id = content['notify_details']['alarm_uuid']
  95                     metric_name = content['notify_details']['metric_name']
  96                     operation = content['notify_details']['operation']
  97                     threshold = content['notify_details']['threshold_value']
  98                     vdu_name = content['notify_details']['vdu_name']
  99                     vnf_member_index = content['notify_details']['vnf_member_index']
 100                     ns_id = content['notify_details']['ns_id']
 101                     log.info(
 102                         "Received alarm notification for alarm %s, \
 103                         metric %s, \
 104                         operation %s, \
 105                         threshold %s, \
 106                         vdu_name %s, \
 107                         vnf_member_index %s, \
 108                         ns_id %s ",
 109                         alarm_id, metric_name, operation, threshold, vdu_name, vnf_member_index, ns_id)
 110                     try:
 111                         alarm = ScalingAlarm.select().where(ScalingAlarm.alarm_id == alarm_id).get()
 112                         lcm_client = LcmClient()
 113                         log.info("Sending scaling action message for ns: %s", alarm_id)
 114                         lcm_client.scale(alarm.scaling_record.nsr_id, alarm.scaling_record.name, alarm.action)
 115                     except ScalingAlarm.DoesNotExist:
 116                         log.info("There is no action configured for alarm %s.", alarm_id)
 117             except Exception:
 118                 log.exception("Error consuming message: ")
 119
 120     def _get_alarm_configs(self, message_content: Dict) -> List[AlarmConfig]:
 121         scaling_criterias = message_content['scaling_group_descriptor']['scaling_policy']['scaling_criteria']
 122         alarm_configs = []
 123         for criteria in scaling_criterias:
 124             metric_name = ''
 125             scale_out_threshold = criteria['scale_out_threshold']
 126             scale_in_threshold = criteria['scale_in_threshold']
 127             scale_out_operation = criteria['scale_out_relational_operation']
 128             scale_in_operation = criteria['scale_in_relational_operation']
 129             statistic = criteria['monitoring_param']['aggregation_type']
 130             vdu_name = ''
 131             vnf_member_index = ''
 132             if 'vdu_monitoring_param' in criteria['monitoring_param']:
 133                 vdu_name = criteria['monitoring_param']['vdu_monitoring_param']['vdu_name']
 134                 vnf_member_index = criteria['monitoring_param']['vdu_monitoring_param']['vnf_member_index']
 135                 metric_name = criteria['monitoring_param']['vdu_monitoring_param']['name']
 136             if 'vnf_metric' in criteria['monitoring_param']:
 137                 # TODO vnf_metric
 138                 continue
 139             if 'vdu_metric' in criteria['monitoring_param']:
 140                 # TODO vdu_metric
 141                 continue
 142             scale_out_alarm_config = AlarmConfig(metric_name,
 143                                                  vdu_name,
 144                                                  vnf_member_index,
 145                                                  scale_out_threshold,
 146                                                  scale_out_operation,
 147                                                  statistic,
 148                                                  'scale_out')
 149             scale_in_alarm_config = AlarmConfig(metric_name,
 150                                                 vdu_name,
 151                                                 vnf_member_index,
 152                                                 scale_in_threshold,
 153                                                 scale_in_operation,
 154                                                 statistic,
 155                                                 'scale_in')
 156             alarm_configs.append(scale_in_alarm_config)
 157             alarm_configs.append(scale_out_alarm_config)
 158         return alarm_configs