X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=plugins%2FvRealiseOps%2Fmon_plugin_vrops.py;h=5831e725a482f2dab14aaf934804b7c7227ec9a8;hb=41bede1f2b0fdd11a2c894ddf59401598e684309;hp=a65d01ca1a892d44055fe76ab9ccc322a2ff9138;hpb=5b0cadb9854d7d699d985e96c51269c721afdb3d;p=osm%2FMON.git diff --git a/plugins/vRealiseOps/mon_plugin_vrops.py b/plugins/vRealiseOps/mon_plugin_vrops.py index a65d01c..5831e72 100644 --- a/plugins/vRealiseOps/mon_plugin_vrops.py +++ b/plugins/vRealiseOps/mon_plugin_vrops.py @@ -1,4 +1,26 @@ # -*- coding: utf-8 -*- + +## +# Copyright 2016-2017 VMware Inc. +# This file is part of ETSI OSM +# All Rights Reserved. +# +# 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: osslegalrouting@vmware.com +## + """ Montoring metrics & creating Alarm definations in vROPs """ @@ -8,37 +30,65 @@ import logging as log from pyvcloud.vcloudair import VCA from xml.etree import ElementTree as XmlElementTree import traceback +import time +import json +from OpenSSL.crypto import load_certificate, FILETYPE_PEM +import os +import datetime OPERATION_MAPPING = {'GE':'GT_EQ', 'LE':'LT_EQ', 'GT':'GT', 'LT':'LT', 'EQ':'EQ'} -SEVERITY_MAPPING = {'WARNING':'WARNING', 'MINOR':'WARNING', 'MAJOR':"IMMEDIATE", 'CRITICAL':'CRITICAL'} +severity_mano2vrops = {'WARNING':'WARNING', 'MINOR':'WARNING', 'MAJOR':"IMMEDIATE",\ + 'CRITICAL':'CRITICAL', 'INDETERMINATE':'UNKNOWN'} +PERIOD_MSEC = {'HR':3600000,'DAY':86400000,'WEEK':604800000,'MONTH':2678400000,'YEAR':31536000000} +#To Do - Add actual webhook url & certificate +#SSL_CERTIFICATE_FILE_NAME = 'vROPs_Webservice/SSL_certificate/www.vrops_webservice.com.cert' +webhook_url = "https://mano-dev-1:8080/notify/" #for testing +SSL_CERTIFICATE_FILE_NAME = 'vROPs_Webservice/SSL_certificate/10.172.137.214.cert' #for testing + +MODULE_DIR = os.path.dirname(__file__) +CONFIG_FILE_NAME = 'vrops_config.xml' +CONFIG_FILE_PATH = os.path.join(MODULE_DIR, CONFIG_FILE_NAME) +SSL_CERTIFICATE_FILE_PATH = os.path.join(MODULE_DIR, SSL_CERTIFICATE_FILE_NAME) class MonPlugin(): """MON Plugin class for vROPs telemetry plugin - """ - def __init__(self, access_config={}): + """ + def __init__(self): """Constructor of MON plugin Params: - 'access_config': dictionary with VIM access information based on VIM type. - This contains a consolidate version of VIM & monitoring tool config at creation and + 'access_config': dictionary with VIM access information based on VIM type. + This contains a consolidate version of VIM & monitoring tool config at creation and particular VIM config at their attachment. - For VIM type: 'vmware', access_config - {'vrops_site':<>, 'vrops_user':<>, 'vrops_password':<>, - 'vcloud-site':<>,'admin_username':<>,'admin_password':<>, - 'nsx_manager':<>,'nsx_user':<>,'nsx_password':<>, - 'vcenter_ip':<>,'vcenter_port':<>,'vcenter_user':<>,'vcenter_password':<>, - 'vim_tenant_name':<>,'orgname':<>} + For VIM type: 'vmware', + access_config - {'vrops_site':<>, 'vrops_user':<>, 'vrops_password':<>, + 'vcloud-site':<>,'admin_username':<>,'admin_password':<>, + 'nsx_manager':<>,'nsx_user':<>,'nsx_password':<>, + 'vcenter_ip':<>,'vcenter_port':<>,'vcenter_user':<>,'vcenter_password':<>, + 'vim_tenant_name':<>,'orgname':<>} #To Do Returns: Raise an exception if some needed parameter is missing, but it must not do any connectivity check against the VIM """ + access_config = self.get_default_Params('Access_Config') self.access_config = access_config - self.vrops_site = access_config['vrops_site'] - self.vrops_user = access_config['vrops_user'] - self.vrops_password = access_config['vrops_password'] - self.vcloud_site = access_config['vcloud_site'] - self.vcloud_username = access_config['vcloud_username'] - self.vcloud_password = access_config['vcloud_password'] + if not bool(access_config): + log.error("Access configuration not provided in vROPs Config file") + raise KeyError("Access configuration not provided in vROPs Config file") + + try: + self.vrops_site = access_config['vrops_site'] + self.vrops_user = access_config['vrops_user'] + self.vrops_password = access_config['vrops_password'] + self.vcloud_site = access_config['vcloud-site'] + self.admin_username = access_config['admin_username'] + self.admin_password = access_config['admin_password'] + self.tenant_id = access_config['tenant_id'] + except KeyError as exp: + log.error("Check Access configuration in vROPs Config file: {}".format(exp)) + raise KeyError("Check Access configuration in vROPs Config file: {}".format(exp)) + def configure_alarm(self, config_dict = {}): """Configures or creates a new alarm using the input parameters in config_dict @@ -48,29 +98,40 @@ class MonPlugin(): "resource_uuid": Resource UUID for which alarm needs to be configured. in string format "Resource type": String resource type: 'VDU' or 'host' "Severity": 'WARNING', 'MINOR', 'MAJOR', 'CRITICAL' - "metric": Metric key in string format + "metric_name": Metric key in string format "operation": One of ('GE', 'LE', 'GT', 'LT', 'EQ') - "threshold_value": Defines the threshold (up to 2 fraction digits) that, if crossed, will trigger the alarm. + "threshold_value": Defines the threshold (up to 2 fraction digits) that, + if crossed, will trigger the alarm. "unit": Unit of measurement in string format "statistic": AVERAGE, MINIMUM, MAXIMUM, COUNT, SUM Default parameters for each alarm are read from the plugin specific config file. Dict of default parameters is as follows: - default_params keys = {'cancel_cycles','wait_cycles','resource_kind','adapter_kind','alarm_type','alarm_subType',impact} + default_params keys = {'cancel_cycles','wait_cycles','resource_kind','adapter_kind', + 'alarm_type','alarm_subType',impact} Returns the UUID of created alarm or None """ - alarm_def_uuid = None + alarm_def = None #1) get alarm & metrics parameters from plugin specific file - def_params = self.get_default_Params(config_dict['alarm_name']) - metric_key_params = self.get_default_Params(config_dict['metric']) + def_a_params = self.get_default_Params(config_dict['alarm_name']) + if not def_a_params: + log.warn("Alarm not supported: {}".format(config_dict['alarm_name'])) + return None + metric_key_params = self.get_default_Params(config_dict['metric_name']) + if not metric_key_params: + log.warn("Metric not supported: {}".format(config_dict['metric_name'])) + return None #2) create symptom definition - #TO DO - 'metric_key':config_dict['metric'] - mapping from file def_params - symptom_params ={'cancel_cycles': (def_params['cancel_period']/300)*def_params['cancel_cycles'], - 'wait_cycles': (def_params['period']/300)*def_params['evaluation'], - 'resource_kind_key': def_params['resource_kind'],'adapter_kind_key': def_params['adapter_kind'], - 'symptom_name':config_dict['alarm_name'],'severity': SEVERITY_MAPPING[config_dict['severity']], - 'metric_key':metric_key_params['metric_key'],'operation':OPERATION_MAPPING[config_dict['operation']], + vrops_alarm_name = def_a_params['vrops_alarm']+ '-' + config_dict['resource_uuid'] + symptom_params ={'cancel_cycles': (def_a_params['cancel_period']/300)*def_a_params['cancel_cycles'], + 'wait_cycles': (def_a_params['period']/300)*def_a_params['evaluation'], + 'resource_kind_key': def_a_params['resource_kind'], + 'adapter_kind_key': def_a_params['adapter_kind'], + 'symptom_name':vrops_alarm_name, + 'severity': severity_mano2vrops[config_dict['severity']], + 'metric_key':metric_key_params['metric_key'], + 'operation':OPERATION_MAPPING[config_dict['operation']], 'threshold_value':config_dict['threshold_value']} symptom_uuid = self.create_symptom(symptom_params) if symptom_uuid is not None: @@ -79,22 +140,24 @@ class MonPlugin(): log.warn("Failed to create Symptom: {}".format(symptom_params['symptom_name'])) return None #3) create alert definition - #To Do - Get type & subtypes for all 5 alarms - alarm_params = {'name':config_dict['alarm_name'], - 'description':config_dict['description'] if config_dict['description'] is not None else config_dict['alarm_name'], - 'adapterKindKey':def_params['adapter_kind'], 'resourceKindKey':def_params['resource_kind'], + #To Do - Get type & subtypes for all 5 alarms + alarm_params = {'name':vrops_alarm_name, + 'description':config_dict['description']\ + if config_dict['description'] is not None else config_dict['alarm_name'], + 'adapterKindKey':def_a_params['adapter_kind'], + 'resourceKindKey':def_a_params['resource_kind'], 'waitCycles':1, 'cancelCycles':1, - 'type':def_params['alarm_type'], 'subType':def_params['alarm_subType'], - 'severity':SEVERITY_MAPPING[config_dict['severity']], + 'type':def_a_params['alarm_type'], 'subType':def_a_params['alarm_subType'], + 'severity':severity_mano2vrops[config_dict['severity']], 'symptomDefinitionId':symptom_uuid, - 'impact':def_params['impact']} + 'impact':def_a_params['impact']} - alarm_def_uuid = self.create_alarm_definition(alarm_params) - if alarm_def_uuid is None: + alarm_def = self.create_alarm_definition(alarm_params) + if alarm_def is None: log.warn("Failed to create Alert: {}".format(alarm_params['name'])) return None - log.info("Alarm defined: {} with ID: {}".format(alarm_params['name'],alarm_def_uuid)) + log.info("Alarm defined: {} with ID: {}".format(alarm_params['name'],alarm_def)) #4) Find vm_moref_id from vApp uuid in vCD vm_moref_id = self.get_vm_moref_id(config_dict['resource_uuid']) @@ -109,12 +172,15 @@ class MonPlugin(): return None #6) Configure alarm notification for a particular VM using it's resource_id - notification_id = self.create_alarm_notification(config_dict['alarm_name'], alarm_def_uuid, resource_id) + notification_id = self.create_alarm_notification_rule(vrops_alarm_name, alarm_def, resource_id) if notification_id is None: return None else: - log.info("Alarm defination created with notification: {} with ID: {}".format(alarm_params['name'],alarm_def_uuid)) - return alarm_def_uuid + alarm_def_uuid = alarm_def.split('-', 1)[1] + log.info("Alarm defination created with notification: {} with ID: {}"\ + .format(alarm_params['name'],alarm_def_uuid)) + #Return alarm defination UUID by removing 'AlertDefinition' from UUID + return (alarm_def_uuid) def get_default_Params(self, metric_alarm_name): """ @@ -122,25 +188,31 @@ class MonPlugin(): Params: metric_alarm_name: Name of the alarm, whose congif params to be read from the config file. """ - tree = XmlElementTree.parse('vROPs_default_config.xml') - alarms = tree.getroot() a_params = {} + try: + source = open(CONFIG_FILE_PATH, 'r') + except IOError as exp: + msg = ("Could not read Config file: {}, \nException: {}"\ + .format(CONFIG_FILE_PATH, exp)) + log.error(msg) + raise IOError(msg) + + tree = XmlElementTree.parse(source) + alarms = tree.getroot() for alarm in alarms: if alarm.tag == metric_alarm_name: for param in alarm: - if param.tag in ("period", "evaluation", "cancel_period", "alarm_type", "cancel_cycles", "alarm_subType"): + if param.tag in ("period", "evaluation", "cancel_period", "alarm_type",\ + "cancel_cycles", "alarm_subType"): a_params[param.tag] = int(param.text) elif param.tag in ("enabled", "repeat"): - if(param.text == "True" or param.text == "true"): + if(param.text.lower() == "true"): a_params[param.tag] = True else: a_params[param.tag] = False else: a_params[param.tag] = param.text - - if not a_params: - log.warn("No such '{}' alarm found!.".format(alarm)) - + source.close() return a_params @@ -165,7 +237,11 @@ class MonPlugin(): api_url = '/suite-api/api/symptomdefinitions' headers = {'Content-Type': 'application/xml'} data = """ - + {4:s} @@ -177,9 +253,12 @@ class MonPlugin(): STATIC - """.format(str(symptom_params['cancel_cycles']),str(symptom_params['wait_cycles']),symptom_params['resource_kind_key'], - symptom_params['adapter_kind_key'],symptom_params['symptom_name'],symptom_params['severity'], - symptom_params['metric_key'],symptom_params['operation'],str(symptom_params['threshold_value'])) + """\ + .format(str(symptom_params['cancel_cycles']),str(symptom_params['wait_cycles']), + symptom_params['resource_kind_key'], symptom_params['adapter_kind_key'], + symptom_params['symptom_name'],symptom_params['severity'], + symptom_params['metric_key'],symptom_params['operation'], + str(symptom_params['threshold_value'])) resp = requests.post(self.vrops_site + api_url, auth=(self.vrops_user, self.vrops_password), @@ -188,7 +267,8 @@ class MonPlugin(): data=data) if resp.status_code != 201: - log.warn("Failed to create Symptom definition: {}, response {}".format(symptom_params['symptom_name'], resp.content)) + log.warn("Failed to create Symptom definition: {}, response {}"\ + .format(symptom_params['symptom_name'], resp.content)) return None symptom_xmlroot = XmlElementTree.fromstring(resp.content) @@ -198,7 +278,8 @@ class MonPlugin(): return symptom_id except Exception as exp: - log.warn("Error creating symptom definition : {}\n{}".format(exp, traceback.format_exc())) + log.warn("Error creating symptom definition : {}\n{}"\ + .format(exp, traceback.format_exc())) def create_alarm_definition(self, alarm_params): @@ -207,12 +288,12 @@ class MonPlugin(): Params: 'name': Alarm Name, 'description':Alarm description, - 'adapterKindKey': Adapter type in vROPs "VMWARE", + 'adapterKindKey': Adapter type in vROPs "VMWARE", 'resourceKindKey':Resource type in vROPs "VirtualMachine", - 'waitCycles': No of wait cycles, + 'waitCycles': No of wait cycles, 'cancelCycles': No of cancel cycles, - 'type': Alarm type: , - 'subType': Alarm subtype: , + 'type': Alarm type, + 'subType': Alarm subtype, 'severity': Severity in vROPs "CRITICAL", 'symptomDefinitionId':symptom Definition uuid, 'impact': impact 'risk' @@ -226,7 +307,9 @@ class MonPlugin(): api_url = '/suite-api/api/alertdefinitions' headers = {'Content-Type': 'application/xml'} data = """ - + {0:s} {1:s} {2:s} @@ -251,9 +334,12 @@ class MonPlugin(): - """.format(alarm_params['name'],alarm_params['description'],alarm_params['adapterKindKey'], - alarm_params['resourceKindKey'],str(alarm_params['type']),str(alarm_params['subType']), - alarm_params['severity'],alarm_params['symptomDefinitionId'],alarm_params['impact']) + """\ + .format(alarm_params['name'],alarm_params['description'], + alarm_params['adapterKindKey'],alarm_params['resourceKindKey'], + str(alarm_params['type']),str(alarm_params['subType']), + alarm_params['severity'],alarm_params['symptomDefinitionId'], + alarm_params['impact']) resp = requests.post(self.vrops_site + api_url, auth=(self.vrops_user, self.vrops_password), @@ -262,7 +348,8 @@ class MonPlugin(): data=data) if resp.status_code != 201: - log.warn("Failed to create Alarm definition: {}, response {}".format(alarm_params['name'], resp.content)) + log.warn("Failed to create Alarm definition: {}, response {}"\ + .format(alarm_params['name'], resp.content)) return None alarm_xmlroot = XmlElementTree.fromstring(resp.content) @@ -276,66 +363,108 @@ class MonPlugin(): log.warn("Error creating alarm definition : {}\n{}".format(exp, traceback.format_exc())) - def configure_rest_plugin(self, plugin_name, webhook_url, certificate): + def configure_rest_plugin(self): """ Creates REST Plug-in for vROPs outbound alerts - Params: - plugin_name: name of REST plugin instance - pluginTypeId - RestPlugin - Optional configValues - "Url">https://dev14136.service-now.com:8080 - reqd - "Username">admin - optional - "Password">VMware1! - optional - "Content-type">application/xml - reqd - "Certificate">abcdefgh123456 - get n set - "ConnectionCount" - 20 - default + Returns Plugin ID """ plugin_id = None + plugin_name = 'MON_module_REST_Plugin' + plugin_id = self.check_if_plugin_configured(plugin_name) + + #If REST plugin not configured, configure it + if plugin_id is not None: + return plugin_id + else: + try: + cert_file_string = open(SSL_CERTIFICATE_FILE_PATH, "rb").read() + except IOError as exp: + msg = ("Could not read SSL certificate file: {}".format(SSL_CERTIFICATE_FILE_PATH)) + log.error(msg) + raise IOError(msg) + cert = load_certificate(FILETYPE_PEM, cert_file_string) + certificate = cert.digest("sha1") + api_url = '/suite-api/api/alertplugins' + headers = {'Content-Type': 'application/xml'} + data = """ + + RestPlugin + {0:s} + + {1:s} + application/xml + {2:s} + 20 + + """.format(plugin_name, webhook_url, certificate) + + resp = requests.post(self.vrops_site + api_url, + auth=(self.vrops_user, self.vrops_password), + headers=headers, + verify = False, + data=data) + + if resp.status_code is not 201: + log.warn("Failed to create REST Plugin: {} for url: {}, \nresponse code: {},"\ + "\nresponse content: {}".format(plugin_name, webhook_url,\ + resp.status_code, resp.content)) + return None + + plugin_xmlroot = XmlElementTree.fromstring(resp.content) + if plugin_xmlroot is not None: + for child in plugin_xmlroot: + if child.tag.split("}")[1] == 'pluginId': + plugin_id = plugin_xmlroot.find('{http://webservice.vmware.com/vRealizeOpsMgr/1.0/}pluginId').text + if plugin_id is None: + log.warn("Failed to get REST Plugin ID for {}, url: {}".format(plugin_name, webhook_url)) + return None + else: + log.info("Created REST Plugin: {} with ID : {} for url: {}".format(plugin_name, plugin_id, webhook_url)) + status = self.enable_rest_plugin(plugin_id, plugin_name) + if status is False: + log.warn("Failed to enable created REST Plugin: {} for url: {}".format(plugin_name, webhook_url)) + return None + else: + log.info("Enabled REST Plugin: {} for url: {}".format(plugin_name, webhook_url)) + return plugin_id + + def check_if_plugin_configured(self, plugin_name): + """Check if the REST plugin is already created + Returns: plugin_id: if already created, None: if needs to be created + """ + plugin_id = None + #Find the REST Plugin id details for - MON_module_REST_Plugin api_url = '/suite-api/api/alertplugins' - headers = {'Content-Type': 'application/xml'} - data = """ - - RestPlugin - {0:s} - - {1:s} - application/xml - {2:s} - 20 - - """.format(plugin_name, webhook_url, certificate) + headers = {'Accept': 'application/xml'} + namespace = {'params':"http://webservice.vmware.com/vRealizeOpsMgr/1.0/"} - resp = requests.post(self.vrops_site + api_url, - auth=(self.vrops_user, self.vrops_password), - headers=headers, - verify = False, - data=data) + resp = requests.get(self.vrops_site + api_url, + auth=(self.vrops_user, self.vrops_password), + verify = False, headers = headers) - if resp.status_code is not 201: - log.warn("Failed to create REST Plugin: {} for url: {}, \nresponse code: {},\nresponse content: {}"\ - .format(plugin_name, webhook_url, resp.status_code, resp.content)) - return None + if resp.status_code is not 200: + log.warn("Failed to REST GET Alarm plugin details \nResponse code: {}\nResponse content: {}"\ + .format(resp.status_code, resp.content)) + return None - plugin_xmlroot = XmlElementTree.fromstring(resp.content) - if plugin_xmlroot is not None: - for child in plugin_xmlroot: - if child.tag.split("}")[1] == 'pluginId': - plugin_id = plugin_xmlroot.find('{http://webservice.vmware.com/vRealizeOpsMgr/1.0/}pluginId').text + # Look for specific plugin & parse pluginId for 'MON_module_REST_Plugin' + xmlroot_resp = XmlElementTree.fromstring(resp.content) + for notify_plugin in xmlroot_resp.findall('params:notification-plugin',namespace): + if notify_plugin.find('params:name',namespace) is not None and\ + notify_plugin.find('params:pluginId',namespace) is not None: + if notify_plugin.find('params:name',namespace).text == plugin_name: + plugin_id = notify_plugin.find('params:pluginId',namespace).text if plugin_id is None: - log.warn("Failed to get REST Plugin ID for {}, url: {}".format(plugin_name, webhook_url)) + log.warn("REST plugin {} not found".format('MON_module_REST_Plugin')) return None else: - log.info("Created REST Plugin: {} with ID : {} for url: {}".format(plugin_name, plugin_id, webhook_url)) - status = self.enable_rest_plugin(plugin_id, plugin_name) - if status is False: - log.warn("Failed to enable created REST Plugin: {} for url: {}".format(plugin_name, webhook_url)) - return None - else: - log.info("Enabled REST Plugin: {} for url: {}".format(plugin_name, webhook_url)) - return plugin_id + log.info("Found REST Plugin: {}".format(plugin_name)) + return plugin_id def enable_rest_plugin(self, plugin_id, plugin_name): @@ -346,28 +475,32 @@ class MonPlugin(): """ if plugin_id is None or plugin_name is None: - log.debug("enable_rest_plugin() : Plugin ID or plugin_name not provided for {} plugin".format(plugin_name)) + log.debug("enable_rest_plugin() : Plugin ID or plugin_name not provided for {} plugin"\ + .format(plugin_name)) return False try: api_url = "/suite-api/api/alertplugins/{}/enable/True".format(plugin_id) - resp = requests.put(self.vrops_site + api_url, auth=(self.vrops_user, self.vrops_password), verify = False) + resp = requests.put(self.vrops_site + api_url, + auth=(self.vrops_user, self.vrops_password), + verify = False) if resp.status_code is not 204: log.warn("Failed to enable REST plugin {}. \nResponse code {}\nResponse Content: {}"\ - .format(plugin_name, resp.status_code, resp.content)) + .format(plugin_name, resp.status_code, resp.content)) return False log.info("Enabled REST plugin {}.".format(plugin_name)) return True except Exception as exp: - log.warn("Error enabling REST plugin for {} plugin: Exception: {}\n{}".format(plugin_name, exp, traceback.format_exc())) + log.warn("Error enabling REST plugin for {} plugin: Exception: {}\n{}"\ + .format(plugin_name, exp, traceback.format_exc())) - def create_alarm_notification(self, alarm_name, alarm_id, resource_id): + def create_alarm_notification_rule(self, alarm_name, alarm_id, resource_id): """ - Create notification for each alarm + Create notification rule for each alarm Params: alarm_name alarm_id @@ -378,28 +511,10 @@ class MonPlugin(): """ notification_name = 'notify_' + alarm_name notification_id = None + plugin_name = 'MON_module_REST_Plugin' #1) Find the REST Plugin id details for - MON_module_REST_Plugin - api_url = '/suite-api/api/alertplugins' - headers = {'Accept': 'application/xml'} - namespace = {'params':"http://webservice.vmware.com/vRealizeOpsMgr/1.0/"} - - resp = requests.get(self.vrops_site + api_url, - auth=(self.vrops_user, self.vrops_password), - verify = False, headers = headers) - - if resp.status_code is not 200: - log.warn("Failed to REST GET Alarm plugin details \nResponse code: {}\nResponse content: {}"\ - .format(resp.status_code, resp.content)) - return None - - # Look for specific plugin & parse pluginId for 'MON_module_REST_Plugin' - xmlroot_resp = XmlElementTree.fromstring(resp.content) - for notify_plugin in xmlroot_resp.findall('params:notification-plugin',namespace): - if notify_plugin.find('params:name',namespace) is not None and notify_plugin.find('params:pluginId',namespace) is not None: - if notify_plugin.find('params:name',namespace).text == 'MON_module_REST_Plugin': - plugin_id = notify_plugin.find('params:pluginId',namespace).text - + plugin_id = self.check_if_plugin_configured(plugin_name) if plugin_id is None: log.warn("Failed to get REST plugin_id for : {}".format('MON_module_REST_Plugin')) return None @@ -408,7 +523,9 @@ class MonPlugin(): api_url = '/suite-api/api/notifications/rules' headers = {'Content-Type': 'application/xml'} data = """ - + {0:s} {1:s} @@ -417,7 +534,8 @@ class MonPlugin(): {3:s} - """.format(notification_name, plugin_id, resource_id, alarm_id) + """\ + .format(notification_name, plugin_id, resource_id, alarm_id) resp = requests.post(self.vrops_site + api_url, auth=(self.vrops_user, self.vrops_password), @@ -426,8 +544,9 @@ class MonPlugin(): data=data) if resp.status_code is not 201: - log.warn("Failed to create Alarm notification {} for {} alarm. \nResponse code: {}\nResponse content: {}"\ - .format(notification_name, alarm_name, resp.status_code, resp.content)) + log.warn("Failed to create Alarm notification rule {} for {} alarm."\ + "\nResponse code: {}\nResponse content: {}"\ + .format(notification_name, alarm_name, resp.status_code, resp.content)) return None #parse notification id from response @@ -452,7 +571,8 @@ class MonPlugin(): return vm_moref_id except Exception as exp: - log.warn("Error occurred while getting VM moref ID for VM : {}\n{}".format(exp, traceback.format_exc())) + log.warn("Error occurred while getting VM moref ID for VM : {}\n{}"\ + .format(exp, traceback.format_exc())) def get_vapp_details_rest(self, vapp_uuid=None): @@ -485,7 +605,8 @@ class MonPlugin(): verify=vca.verify) if response.status_code != 200: - log.warn("REST API call {} failed. Return status code {}".format(get_vapp_restcall, response.content)) + log.warn("REST API call {} failed. Return status code {}"\ + .format(get_vapp_restcall, response.content)) return parsed_respond try: @@ -509,7 +630,8 @@ class MonPlugin(): parsed_respond["vm_vcenter_info"]= vm_vcenter_info except Exception as exp : - log.warn("Error occurred calling rest api for getting vApp details: {}\n{}".format(exp, traceback.format_exc())) + log.warn("Error occurred calling rest api for getting vApp details: {}\n{}"\ + .format(exp, traceback.format_exc())) return parsed_respond @@ -526,17 +648,18 @@ class MonPlugin(): log.info("Logging in to a VCD org as admin.") vca_admin = VCA(host=self.vcloud_site, - username=self.vcloud_username, + username=self.admin_username, service_type='standalone', version='5.9', verify=False, log=False) - result = vca_admin.login(password=self.vcloud_password, org='System') + result = vca_admin.login(password=self.admin_password, org='System') if not result: - log.warn("Can't connect to a vCloud director as: {}".format(self.vcloud_username)) + log.warn("Can't connect to a vCloud director as: {}".format(self.admin_username)) result = vca_admin.login(token=vca_admin.token, org='System', org_url=vca_admin.vcloud_session.org_url) if result is True: - log.info("Successfully logged to a vcloud direct org: {} as user: {}".format('System', self.vcloud_username)) + log.info("Successfully logged to a vcloud direct org: {} as user: {}"\ + .format('System', self.admin_username)) return vca_admin @@ -573,8 +696,501 @@ class MonPlugin(): resourceIdentifiers = child for r_id in resourceIdentifiers: if r_id.find('params:value',namespace).text == vm_moref_id: - log.info("Found Resource ID : {} in vROPs for {}".format(resource.attrib['identifier'], vm_moref_id)) + log.info("Found Resource ID : {} in vROPs for {}"\ + .format(resource.attrib['identifier'], vm_moref_id)) return resource.attrib['identifier'] except Exception as exp: log.warn("Error in parsing {}\n{}".format(exp, traceback.format_exc())) + + def get_metrics_data(self, metric={}): + """Get an individual metric's data of a resource. + Params: + 'metric_name': Normalized name of metric (string) + 'resource_uuid': Resource UUID (string) + 'period': Time period in Period Unit for which metrics data to be collected from + Monitoring tool from now. + 'period_unit': Period measurement unit can be one of 'HR', 'DAY', 'MONTH', 'YEAR' + + Return a dict that contains: + 'metric_name': Normalized name of metric (string) + 'resource_uuid': Resource UUID (string) + 'tenant_id': tenent id name in which the resource is present in string format + 'metrics_data': Dictionary containing time_series & metric_series data. + 'time_series': List of individual time stamp values in msec + 'metric_series': List of individual metrics data values + Raises an exception upon error or when network is not found + """ + return_data = {} + return_data['schema_version'] = 1.0 + return_data['schema_type'] = 'read_metric_data_response' + return_data['metric_name'] = metric['metric_name'] + #To do - No metric_uuid in vROPs, thus returning metric_name + return_data['metric_uuid'] = metric['metric_name'] + return_data['correlation_id'] = metric['correlation_id'] + return_data['resource_uuid'] = metric['resource_uuid'] + return_data['metrics_data'] = {'time_series':[], 'metric_series':[]} + #To do - Need confirmation about uuid & id + return_data['tenant_uuid'] = metric['tenant_uuid'] + return_data['unit'] = None + #return_data['tenant_id'] = self.tenant_id + #log.warn("return_data: {}".format(return_data)) + + #1) Get metric details from plugin specific file & format it into vROPs metrics + metric_key_params = self.get_default_Params(metric['metric_name']) + + if not metric_key_params: + log.warn("Metric not supported: {}".format(metric['metric_name'])) + #To Do: Return message + return return_data + + return_data['unit'] = metric_key_params['unit'] + + #2) Find the resource id in vROPs based on OSM resource_uuid + #2.a) Find vm_moref_id from vApp uuid in vCD + vm_moref_id = self.get_vm_moref_id(metric['resource_uuid']) + if vm_moref_id is None: + log.warn("Failed to find vm morefid for vApp in vCD: {}".format(config_dict['resource_uuid'])) + return return_data + #2.b) Based on vm_moref_id, find VM's corresponding resource_id in vROPs to set notification + resource_id = self.get_vm_resource_id(vm_moref_id) + if resource_id is None: + log.warn("Failed to find resource in vROPs: {}".format(config_dict['resource_uuid'])) + return return_data + + #3) Calculate begin & end time for period & period unit + end_time = int(round(time.time() * 1000)) + if metric['collection_unit'] == 'YR': + time_diff = PERIOD_MSEC[metric['collection_unit']] + else: + time_diff = metric['collection_period']* PERIOD_MSEC[metric['collection_unit']] + begin_time = end_time - time_diff + + #4) Get the metrics data + log.info("metric_key_params['metric_key'] = {}".format(metric_key_params['metric_key'])) + log.info("end_time: {}, begin_time: {}".format(end_time, begin_time)) + + url_list = ['/suite-api/api/resources/', resource_id, '/stats?statKey=',\ + metric_key_params['metric_key'], '&begin=', str(begin_time),'&end=',str(end_time)] + api_url = ''.join(url_list) + headers = {'Accept': 'application/json'} + + resp = requests.get(self.vrops_site + api_url, + auth=(self.vrops_user, self.vrops_password), + verify = False, headers = headers) + + if resp.status_code is not 200: + log.warn("Failed to retrive Metric data from vROPs for {}\nResponse code:{}\nResponse Content: {}"\ + .format(metric['metric_name'], resp.status_code, resp.content)) + return return_data + + #5) Convert to required format + metrics_data = {} + json_data = json.loads(resp.content) + for resp_key,resp_val in json_data.iteritems(): + if resp_key == 'values': + data = json_data['values'][0] + for data_k,data_v in data.iteritems(): + if data_k == 'stat-list': + stat_list = data_v + for stat_list_k,stat_list_v in stat_list.iteritems(): + for stat_keys,stat_vals in stat_list_v[0].iteritems(): + if stat_keys == 'timestamps': + metrics_data['time_series'] = stat_list_v[0]['timestamps'] + if stat_keys == 'data': + metrics_data['metric_series'] = stat_list_v[0]['data'] + + return_data['metrics_data'] = metrics_data + + return return_data + + def update_alarm_configuration(self, new_alarm_config): + """Update alarm configuration (i.e. Symptom & alarm) as per request + """ + #1) Get Alarm details from it's uuid & find the symptom defination + alarm_details_json, alarm_details = self.get_alarm_defination_details(new_alarm_config['alarm_uuid']) + if alarm_details_json is None: + return None + + try: + #2) Update the symptom defination + if alarm_details['alarm_id'] is not None and alarm_details['symptom_definition_id'] is not None: + symptom_defination_id = alarm_details['symptom_definition_id'] + else: + log.info("Symptom Defination ID not found for {}".format(new_alarm_config['alarm_uuid'])) + return None + + symptom_uuid = self.update_symptom_defination(symptom_defination_id, new_alarm_config) + + #3) Update the alarm defination & Return UUID if successful update + if symptom_uuid is None: + return None + else: + alarm_uuid = self.reconfigure_alarm(alarm_details_json, new_alarm_config) + if alarm_uuid is None: + return None + else: + return alarm_uuid + except: + log.error("Exception while updating alarm: {}".format(traceback.format_exc())) + + def get_alarm_defination_details(self, alarm_uuid): + """Get alarm details based on alarm UUID + """ + if alarm_uuid is None: + log.warn("get_alarm_defination_details: Alarm UUID not provided") + return None + + alarm_details = {} + json_data = {} + api_url = '/suite-api/api/alertdefinitions/AlertDefinition-' + headers = {'Accept': 'application/json'} + + resp = requests.get(self.vrops_site + api_url + alarm_uuid, + auth=(self.vrops_user, self.vrops_password), + verify = False, headers = headers) + + if resp.status_code is not 200: + log.warn("Failed to get alarm details from vROPs for {}\nResponse code:{}\nResponse Content: {}"\ + .format(alarm_uuid, resp.status_code, resp.content)) + return None + + try: + json_data = json.loads(resp.content) + if json_data['id'] is not None: + alarm_details['alarm_id'] = json_data['id'] + alarm_details['alarm_name'] = json_data['name'] + alarm_details['adapter_kind'] = json_data['adapterKindKey'] + alarm_details['resource_kind'] = json_data['resourceKindKey'] + alarm_details['type'] = ['type'] + alarm_details['sub_type'] = json_data['subType'] + alarm_details['symptom_definition_id'] = json_data['states'][0]['base-symptom-set']['symptomDefinitionIds'][0] + except exception as exp: + log.warn("Exception while retriving alarm defination details: {}".format(exp)) + + return json_data, alarm_details + + + def update_symptom_defination(self, symptom_uuid, new_alarm_config): + """Update symptom defination based on new alarm input configuration + """ + #1) Get symptom defination details + symptom_details = self.get_symptom_defination_details(symptom_uuid) + #print "\n\nsymptom_details: {}".format(symptom_details) + if symptom_details is None: + return None + + if new_alarm_config.has_key('severity') and new_alarm_config['severity'] is not None: + symptom_details['state']['severity'] = severity_mano2vrops[new_alarm_config['severity']] + if new_alarm_config.has_key('operation') and new_alarm_config['operation'] is not None: + symptom_details['state']['condition']['operator'] = OPERATION_MAPPING[new_alarm_config['operation']] + if new_alarm_config.has_key('threshold_value') and new_alarm_config['threshold_value'] is not None: + symptom_details['state']['condition']['value'] = new_alarm_config['threshold_value'] + #Find vrops metric key from metric_name, if required + """ + if new_alarm_config.has_key('metric_name') and new_alarm_config['metric_name'] is not None: + metric_key_params = self.get_default_Params(new_alarm_config['metric_name']) + if not metric_key_params: + log.warn("Metric not supported: {}".format(config_dict['metric_name'])) + return None + symptom_details['state']['condition']['key'] = metric_key_params['metric_key'] + """ + log.info("Fetched Symptom details : {}".format(symptom_details)) + + api_url = '/suite-api/api/symptomdefinitions' + headers = {'Content-Type': 'application/json', 'Accept':'application/json'} + data = json.dumps(symptom_details) + resp = requests.put(self.vrops_site + api_url, + auth=(self.vrops_user, self.vrops_password), + headers=headers, + verify = False, + data=data) + + if resp.status_code != 200: + log.warn("Failed to update Symptom definition: {}, response {}"\ + .format(symptom_uuid, resp.content)) + return None + + + if symptom_uuid is not None: + log.info("Symptom defination updated {} for alarm: {}"\ + .format(symptom_uuid, new_alarm_config['alarm_uuid'])) + return symptom_uuid + else: + log.warn("Failed to update Symptom Defination {} for : {}"\ + .format(symptom_uuid, new_alarm_config['alarm_uuid'])) + return None + + + def get_symptom_defination_details(self, symptom_uuid): + """Get symptom defination details + """ + symptom_details = {} + if symptom_uuid is None: + log.warn("get_symptom_defination_details: Symptom UUID not provided") + return None + + api_url = '/suite-api/api/symptomdefinitions/' + headers = {'Accept': 'application/json'} + + resp = requests.get(self.vrops_site + api_url + symptom_uuid, + auth=(self.vrops_user, self.vrops_password), + verify = False, headers = headers) + + if resp.status_code is not 200: + log.warn("Failed to get symptom details for {} \nResponse code:{}\nResponse Content: {}"\ + .format(symptom_uuid, resp.status_code, resp.content)) + return None + + symptom_details = json.loads(resp.content) + #print "New symptom Details: {}".format(symptom_details) + return symptom_details + + + def reconfigure_alarm(self, alarm_details_json, new_alarm_config): + """Reconfigure alarm defination as per input + """ + if new_alarm_config.has_key('severity') and new_alarm_config['severity'] is not None: + alarm_details_json['states'][0]['severity'] = new_alarm_config['severity'] + + api_url = '/suite-api/api/alertdefinitions' + headers = {'Content-Type': 'application/json', 'Accept':'application/json'} + data = json.dumps(alarm_details_json) + resp = requests.put(self.vrops_site + api_url, + auth=(self.vrops_user, self.vrops_password), + headers=headers, + verify = False, + data=data) + + if resp.status_code != 200: + log.warn("Failed to create Symptom definition: {}, response code {}, response content: {}"\ + .format(symptom_uuid, resp.status_code, resp.content)) + return None + else: + parsed_alarm_details = json.loads(resp.content) + alarm_def_uuid = parsed_alarm_details['id'].split('-', 1)[1] + log.info("Successfully updated Alarm defination: {}".format(alarm_def_uuid)) + return alarm_def_uuid + + def delete_alarm_configuration(self, delete_alarm_req_dict): + """Delete complete alarm configuration + """ + if delete_alarm_req_dict['alarm_uuid'] is None: + log.info("delete_alarm_configuration: Alarm UUID not provided") + return None + #1)Get alarm & symptom defination details + alarm_details_json, alarm_details = self.get_alarm_defination_details(delete_alarm_req_dict['alarm_uuid']) + if alarm_details is None or alarm_details_json is None: + return None + + #2) Delete alarm notfication + rule_id = self.delete_notification_rule(alarm_details['alarm_name']) + if rule_id is None: + return None + + #3) Delete alarm configuraion + alarm_id = self.delete_alarm_defination(alarm_details['alarm_id']) + if alarm_id is None: + return None + + #4) Delete alarm symptom + symptom_id = self.delete_symptom_definition(alarm_details['symptom_definition_id']) + if symptom_id is None: + return None + else: + log.info("Completed deleting alarm configuration: {}"\ + .format(delete_alarm_req_dict['alarm_uuid'])) + return delete_alarm_req_dict['alarm_uuid'] + + def delete_notification_rule(self, alarm_name): + """Deleted notification rule defined for a particular alarm + """ + rule_id = self.get_notification_rule_id_by_alarm_name(alarm_name) + if rule_id is None: + return None + else: + api_url = '/suite-api/api/notifications/rules/' + headers = {'Accept':'application/json'} + resp = requests.delete(self.vrops_site + api_url + rule_id, + auth=(self.vrops_user, self.vrops_password), + verify = False, headers = headers) + if resp.status_code is not 204: + log.warn("Failed to delete notification rules for {}".format(alarm_name)) + return None + else: + log.info("Deleted notification rules for {}".format(alarm_name)) + return rule_id + + def get_notification_rule_id_by_alarm_name(self, alarm_name): + """Find created Alarm notification rule id by alarm name + """ + alarm_notify_id = 'notify_' + alarm_name + api_url = '/suite-api/api/notifications/rules' + headers = {'Content-Type': 'application/json', 'Accept':'application/json'} + resp = requests.get(self.vrops_site + api_url, + auth=(self.vrops_user, self.vrops_password), + verify = False, headers = headers) + + if resp.status_code is not 200: + log.warn("Failed to get notification rules details for {}"\ + .format(delete_alarm_req_dict['alarm_name'])) + return None + + notifications = json.loads(resp.content) + if notifications is not None and notifications.has_key('notification-rule'): + notifications_list = notifications['notification-rule'] + for dict in notifications_list: + if dict['name'] is not None and dict['name'] == alarm_notify_id: + notification_id = dict['id'] + log.info("Found Notification id to be deleted: {} for {}"\ + .format(notification_id, alarm_name)) + return notification_id + + log.warn("Notification id to be deleted not found for {}"\ + .format(notification_id, alarm_name)) + return None + + def delete_alarm_defination(self, alarm_id): + """Delete created Alarm defination + """ + api_url = '/suite-api/api/alertdefinitions/' + headers = {'Accept':'application/json'} + resp = requests.delete(self.vrops_site + api_url + alarm_id, + auth=(self.vrops_user, self.vrops_password), + verify = False, headers = headers) + if resp.status_code is not 204: + log.warn("Failed to delete alarm definition {}".format(alarm_id)) + return None + else: + log.info("Deleted alarm definition {}".format(alarm_id)) + return alarm_id + + def delete_symptom_definition(self, symptom_id): + """Delete symptom defination + """ + api_url = '/suite-api/api/symptomdefinitions/' + headers = {'Accept':'application/json'} + resp = requests.delete(self.vrops_site + api_url + symptom_id, + auth=(self.vrops_user, self.vrops_password), + verify = False, headers = headers) + if resp.status_code is not 204: + log.warn("Failed to delete symptom definition {}".format(symptom_id)) + return None + else: + log.info("Deleted symptom definition {}".format(symptom_id)) + return symptom_id + + + def verify_metric_support(self, metric_info): + """Verify, if Metric is supported by vROPs plugin, verify metric unit & return status + Returns: + status: True if supported, False if not supported + """ + status = False + metric_key_params = self.get_default_Params(metric_info['metric_name']) + if not metric_key_params: + log.warn("Metric not supported: {}".format(metric_info['metric_name'])) + return status + else: + #If Metric is supported, verify metric unit & return status + if metric_key_params['unit'] == metric_info['metric_unit']: + log.info("Metric is supported: {}".format(metric_info['metric_name'])) + status = True + else: + log.warn("Metric not supported: {}".format(metric_info['metric_name'])) + status = False + return status + + def get_triggered_alarms_list(self, list_alarm_input): + """Get list of triggered alarms on a resource based on alarm input request. + """ + #TO Do - Need to add filtering of alarms based on Severity & alarm name + + triggered_alarms_list = [] + if list_alarm_input['resource_uuid'] is None: + return triggered_alarms_list + + #1)Find vROPs resource ID using RO resource UUID + vrops_resource_id = self.get_vrops_resourceid_from_ro_uuid(list_alarm_input['resource_uuid']) + if vrops_resource_id is None: + return triggered_alarms_list + + #2)Get triggered alarms on particular resource + triggered_alarms_list = self.get_triggered_alarms_on_resource(list_alarm_input['resource_uuid'], vrops_resource_id) + return triggered_alarms_list + + def get_vrops_resourceid_from_ro_uuid(self, ro_resource_uuid): + """Fetch vROPs resource ID using resource UUID from RO/SO + """ + #1) Find vm_moref_id from vApp uuid in vCD + vm_moref_id = self.get_vm_moref_id(ro_resource_uuid) + if vm_moref_id is None: + log.warn("Failed to find vm morefid for vApp in vCD: {}".format(ro_resource_uuid)) + return None + + #2) Based on vm_moref_id, find VM's corresponding resource_id in vROPs to set notification + vrops_resource_id = self.get_vm_resource_id(vm_moref_id) + if vrops_resource_id is None: + log.warn("Failed to find resource in vROPs: {}".format(ro_resource_uuid)) + return None + return vrops_resource_id + + + def get_triggered_alarms_on_resource(self, ro_resource_uuid, vrops_resource_id): + """Get triggered alarms on particular resource & return list of dictionary of alarms + """ + resource_alarms = [] + api_url = '/suite-api/api/alerts?resourceId=' + headers = {'Accept':'application/json'} + resp = requests.get(self.vrops_site + api_url + vrops_resource_id, + auth=(self.vrops_user, self.vrops_password), + verify = False, headers = headers) + + if resp.status_code is not 200: + log.warn("Failed to get notification rules details for {}"\ + .format(delete_alarm_req_dict['alarm_name'])) + return None + + all_alerts = json.loads(resp.content) + if all_alerts.has_key('alerts'): + if not all_alerts['alerts']: + log.info("No alarms present on resource {}".format(ro_resource_uuid)) + return resource_alarms + all_alerts_list = all_alerts['alerts'] + for alarm in all_alerts_list: + #log.info("Triggered Alarm {}".format(alarm)) + if alarm['alertDefinitionName'] is not None and\ + len(alarm['alertDefinitionName'].split('-', 1)) == 2: + if alarm['alertDefinitionName'].split('-', 1)[1] == ro_resource_uuid: + alarm_instance = {} + alarm_instance['alarm_uuid'] = alarm['alertDefinitionId'].split('-', 1)[1] + alarm_instance['resource_uuid'] = ro_resource_uuid + alarm_instance['alarm_instance_uuid'] = alarm['alertId'] + alarm_instance['vim_type'] = 'VMware' + #find severity of alarm + severity = None + for key,value in severity_mano2vrops.iteritems(): + if value == alarm['alertLevel']: + severity = key + if severity is None: + severity = 'INDETERMINATE' + alarm_instance['severity'] = severity + alarm_instance['status'] = alarm['status'] + alarm_instance['start_date'] = self.convert_date_time(alarm['startTimeUTC']) + alarm_instance['update_date'] = self.convert_date_time(alarm['updateTimeUTC']) + alarm_instance['cancel_date'] = self.convert_date_time(alarm['cancelTimeUTC']) + log.info("Triggered Alarm on resource {}".format(alarm_instance)) + resource_alarms.append(alarm_instance) + if not resource_alarms: + log.info("No alarms present on resource {}".format(ro_resource_uuid)) + return resource_alarms + + def convert_date_time(self, date_time): + """Convert the input UTC time in msec to OSM date time format + """ + date_time_formatted = '0000-00-00T00:00:00' + if date_time != 0: + complete_datetime = datetime.datetime.fromtimestamp(date_time/1000.0).isoformat('T') + date_time_formatted = complete_datetime.split('.',1)[0] + return date_time_formatted +