o2ims/adapter/clients/fault_client.py

   1 # Copyright (C) 2022-2024 Wind River Systems, Inc.
   2 #
   3 #  Licensed under the Apache License, Version 2.0 (the "License");
   4 #  you may not use this file except in compliance with the License.
   5 #  You may obtain a copy of the License at
   6 #
   7 #      http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 #  Unless required by applicable law or agreed to in writing, software
  10 #  distributed under the License is distributed on an "AS IS" BASIS,
  11 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #  See the License for the specific language governing permissions and
  13 #  limitations under the License.
  14
  15 # client talking to Stx standalone
  16
  17 from typing import List  # Optional,  Set
  18 import uuid as uuid
  19
  20 from cgtsclient.client import get_client as get_stx_client
  21 from cgtsclient.exc import EndpointException
  22 from dcmanagerclient.api.client import client as get_dc_client
  23 from fmclient.client import get_client as get_fm_client
  24 from fmclient.common.exceptions import HTTPNotFound, HttpServerError
  25
  26 from o2app.adapter import unit_of_work
  27 from o2common.config import config
  28 from o2common.service.client.base_client import BaseClient
  29 from o2ims.domain import alarm_obj as alarmModel
  30
  31 from o2common.helper import o2logging
  32 logger = o2logging.get_logger(__name__)
  33
  34
  35 CGTSCLIENT_ENDPOINT_ERROR_MSG = \
  36     'Must provide Keystone credentials or user-defined endpoint and token'
  37
  38
  39 class StxAlarmClient(BaseClient):
  40     def __init__(self, uow: unit_of_work.AbstractUnitOfWork, driver=None):
  41         super().__init__()
  42         self.driver = driver if driver else StxFaultClientImp()
  43         self.uow = uow
  44
  45     def _get(self, id) -> alarmModel.FaultGenericModel:
  46         return self.driver.getAlarmInfo(id)
  47
  48     def _list(self, **filters) -> List[alarmModel.FaultGenericModel]:
  49         newmodels = self.driver.getAlarmList(**filters)
  50         uow = self.uow
  51         exist_alarms = {}
  52         with uow:
  53             rs = uow.session.execute(
  54                 '''
  55                 SELECT "alarmEventRecordId"
  56                 FROM "alarmEventRecord"
  57                 WHERE "perceivedSeverity" != :perceived_severity_enum
  58                 ''',
  59                 dict(perceived_severity_enum=alarmModel.PerceivedSeverityEnum.
  60                      CLEARED)
  61             )
  62             for row in rs:
  63                 id = row[0]
  64                 # logger.debug('Exist alarm: ' + id)
  65                 exist_alarms[id] = False
  66
  67         ret = []
  68         for m in newmodels:
  69             try:
  70                 if exist_alarms[m.id]:
  71                     ret.append(m)
  72                     exist_alarms[m.id] = True
  73             except KeyError:
  74                 logger.debug('alarm new: ' + m.id)
  75                 ret.append(m)
  76
  77         for alarm in exist_alarms:
  78             logger.debug('exist alarm: ' + alarm)
  79             if exist_alarms[alarm]:
  80                 # exist alarm is active
  81                 continue
  82             try:
  83                 event = self._get(alarm)
  84             except HTTPNotFound:
  85                 logger.debug('alarm {} not in this resource pool {}'
  86                              .format(alarm, self._pool_id))
  87                 continue
  88             except HttpServerError:
  89                 # TODO(jon): This exception needs to be removed when the
  90                 # INF-457 related FM client upgrade and issue fix occur.
  91                 logger.debug('alarm {} query failed'.format(alarm))
  92                 continue
  93             ret.append(event)
  94
  95         return ret
  96
  97     def _set_stx_client(self):
  98         self.driver.setFaultClient(self._pool_id)
  99
 100
 101 class StxEventClient(BaseClient):
 102     def __init__(self, uow: unit_of_work.AbstractUnitOfWork, driver=None):
 103         super().__init__()
 104         self.driver = driver if driver else StxFaultClientImp()
 105         self.uow = uow
 106
 107     def _get(self, id) -> alarmModel.FaultGenericModel:
 108         return self.driver.getEventInfo(id)
 109
 110     def _list(self, **filters) -> List[alarmModel.FaultGenericModel]:
 111         return self.driver.getEventList(**filters)
 112
 113     def _set_stx_client(self):
 114         self.driver.setFaultClient(self._pool_id)
 115
 116     def suppression_list(self, alarm_id) -> List[alarmModel.FaultGenericModel]:
 117         return self.driver.getSuppressionList(alarm_id)
 118
 119     def suppress(self, id) -> alarmModel.FaultGenericModel:
 120         return self.driver.suppressEvent(id)
 121
 122
 123 # internal driver which implement client call to Stx Fault Management instance
 124 class StxFaultClientImp(object):
 125     def __init__(self, fm_client=None, stx_client=None, dc_client=None):
 126         super().__init__()
 127         self.fmclient = fm_client if fm_client else self.getFmClient()
 128         self.stxclient = stx_client if stx_client else self.getStxClient()
 129         self.dcclient = dc_client if dc_client else self.getDcmanagerClient()
 130
 131     def getStxClient(self):
 132         os_client_args = config.get_stx_access_info()
 133         config_client = get_stx_client(**os_client_args)
 134         return config_client
 135
 136     def getDcmanagerClient(self):
 137         os_client_args = config.get_dc_access_info()
 138         config_client = get_dc_client(**os_client_args)
 139         return config_client
 140
 141     def getFmClient(self):
 142         os_client_args = config.get_fm_access_info()
 143         config_client = get_fm_client(1, **os_client_args)
 144         return config_client
 145
 146     def getSubcloudList(self):
 147         self.dcclient = self.getDcmanagerClient()
 148         subs = self.dcclient.subcloud_manager.list_subclouds()
 149         known_subs = [sub for sub in subs if sub.sync_status != 'unknown']
 150         return known_subs
 151
 152     def getSubcloudFaultClient(self, subcloud_id):
 153         subcloud = self.dcclient.subcloud_manager.\
 154             subcloud_additional_details(subcloud_id)
 155         logger.debug('subcloud name: %s, oam_floating_ip: %s' %
 156                      (subcloud[0].name, subcloud[0].oam_floating_ip))
 157         try:
 158             sub_is_https = False
 159             os_client_args = config.get_stx_access_info(
 160                 region_name=subcloud[0].name,
 161                 subcloud_hostname=subcloud[0].oam_floating_ip)
 162             stx_client = get_stx_client(**os_client_args)
 163         except EndpointException as e:
 164             msg = e.format_message()
 165             if CGTSCLIENT_ENDPOINT_ERROR_MSG in msg:
 166                 sub_is_https = True
 167                 os_client_args = config.get_stx_access_info(
 168                     region_name=subcloud[0].name, sub_is_https=sub_is_https,
 169                     subcloud_hostname=subcloud[0].oam_floating_ip)
 170                 stx_client = get_stx_client(**os_client_args)
 171             else:
 172                 raise ValueError('Stx endpoint exception: %s' % msg)
 173         except Exception:
 174             raise ValueError('cgtsclient get subcloud client failed')
 175
 176         os_client_args = config.get_fm_access_info(
 177             sub_is_https=sub_is_https,
 178             subcloud_hostname=subcloud[0].oam_floating_ip)
 179         fm_client = get_fm_client(1, **os_client_args)
 180
 181         return stx_client, fm_client
 182
 183     def setFaultClient(self, resource_pool_id):
 184         systems = self.stxclient.isystem.list()
 185         if resource_pool_id == systems[0].uuid:
 186             logger.debug('Fault Client not change: %s' % resource_pool_id)
 187             self.fmclient = self.getFmClient()
 188             return
 189
 190         subclouds = self.getSubcloudList()
 191         for subcloud in subclouds:
 192             substxclient, subfaultclient = self.getSubcloudFaultClient(
 193                 subcloud.subcloud_id)
 194             systems = substxclient.isystem.list()
 195             if resource_pool_id == systems[0].uuid:
 196                 self.fmclient = subfaultclient
 197
 198     def getAlarmList(self, **filters) -> List[alarmModel.FaultGenericModel]:
 199         alarms = self.fmclient.alarm.list(expand=True)
 200         if len(alarms) == 0:
 201             return []
 202         logger.debug('alarm 1:' + str(alarms[0].to_dict()))
 203         # [print('alarm:' + str(alarm.to_dict())) for alarm in alarms if alarm]
 204         return [alarmModel.FaultGenericModel(
 205             alarmModel.EventTypeEnum.ALARM, self._alarmconverter(alarm))
 206             for alarm in alarms if alarm]
 207
 208     def getAlarmInfo(self, id) -> alarmModel.FaultGenericModel:
 209         try:
 210             alarm = self.fmclient.alarm.get(id)
 211             logger.debug('get alarm id ' + id + ':' + str(alarm.to_dict()))
 212         except HTTPNotFound:
 213             event = self.fmclient.event_log.get(id)
 214             return alarmModel.FaultGenericModel(
 215                 alarmModel.EventTypeEnum.ALARM, self._eventconverter(event,
 216                                                                      True))
 217         return alarmModel.FaultGenericModel(
 218             alarmModel.EventTypeEnum.ALARM, self._alarmconverter(alarm))
 219
 220     def getEventList(self, **filters) -> List[alarmModel.FaultGenericModel]:
 221         events = self.fmclient.event_log.list(alarms=True, expand=True)
 222         logger.debug('event 1:' + str(events[0].to_dict()))
 223         # [print('alarm:' + str(event.to_dict())) for event in events if event]
 224         return [alarmModel.FaultGenericModel(
 225             alarmModel.EventTypeEnum.EVENT, self._eventconverter(event))
 226             for event in events if event]
 227
 228     def getEventInfo(self, id) -> alarmModel.FaultGenericModel:
 229         event = self.fmclient.event_log.get(id)
 230         logger.debug('get event id ' + id + ':' + str(event.to_dict()))
 231         return alarmModel.FaultGenericModel(
 232             alarmModel.EventTypeEnum.EVENT, self._eventconverter(event))
 233
 234     def suppressEvent(self, id) -> alarmModel.FaultGenericModel:
 235         patch = [dict(path='/' + 'suppression_status', value='suppressed',
 236                       op='replace')]
 237         event = self.fmclient.event_suppression.update(id, patch)
 238         logger.debug('suppressed event id ' + id + ':' + str(event.to_dict()))
 239         return alarmModel.FaultGenericModel(
 240             alarmModel.EventTypeEnum.EVENT, self._suppression_converter(event))
 241
 242     def getSuppressionList(self, alarm_id) -> alarmModel.FaultGenericModel:
 243         suppression_list = []
 244         queryAsArray = []
 245         events = self.fmclient.event_suppression.list(q=queryAsArray)
 246         for event in events:
 247             if event.alarm_id == alarm_id:
 248                 # logger.debug('suppression event:' + str(event.to_dict()))
 249                 suppression_list.append(
 250                     alarmModel.FaultGenericModel(
 251                         alarmModel.EventTypeEnum.EVENT,
 252                         self._suppression_converter(event)))
 253         return suppression_list
 254
 255     @ staticmethod
 256     def _alarmconverter(alarm):
 257         selected_keys = [
 258             'alarm_id', 'alarm_state', 'entity_type_id', 'entity_instance_id',
 259             'reason_text', 'alarm_type', 'probable_cause',
 260             'proposed_repair_action', 'service_affecting', 'suppression',
 261             'suppression_status', 'mgmt_affecting', 'degrade_affecting'
 262         ]
 263         content = alarm.to_dict()
 264         filtered = dict(
 265             filter(lambda item: item[0] in selected_keys, content.items()))
 266         setattr(alarm, 'filtered', filtered)
 267         # setattr(alarm, 'alarm_def_id', uuid.uuid3(
 268         #         uuid.NAMESPACE_URL, alarm.alarm_id))
 269         setattr(alarm, 'state', alarm.alarm_state)
 270
 271         setattr(alarm, 'alarm_def_id', str(uuid.uuid3(
 272                 uuid.NAMESPACE_URL, alarm.alarm_id)))
 273         setattr(alarm, 'probable_cause_id', str(uuid.uuid3(
 274                 uuid.NAMESPACE_URL, alarm.probable_cause)))
 275         return alarm
 276
 277     @ staticmethod
 278     def _eventconverter(event, clear=False):
 279         selected_keys = [
 280             'event_log_id', 'state', 'entity_type_id',
 281             'entity_instance_id', 'reason_text', 'event_log_type',
 282             'probable_cause', 'proposed_repair_action',
 283             'service_affecting', 'suppression', 'suppression_status'
 284         ]
 285         content = event.to_dict()
 286         filtered = dict(
 287             filter(lambda item: item[0] in selected_keys, content.items()))
 288         setattr(event, 'filtered', filtered)
 289         setattr(event, 'alarm_id', event.event_log_id)
 290         setattr(event, 'alarm_type', event.event_log_type)
 291         if clear:
 292             logger.debug('alarm is clear')
 293             event.state = 'clear'
 294         setattr(event, 'alarm_def_id', str(uuid.uuid3(
 295                 uuid.NAMESPACE_URL, event.alarm_id)))
 296         setattr(event, 'probable_cause_id', str(uuid.uuid3(
 297                 uuid.NAMESPACE_URL, event.probable_cause)))
 298         return event
 299
 300     @ staticmethod
 301     def _suppression_converter(event, clear=False):
 302         selected_keys = [
 303             'alarm_id', 'description', 'suppression_status',
 304             'links'
 305         ]
 306         content = event.to_dict()
 307         filtered = dict(
 308             filter(lambda item: item[0] in selected_keys, content.items()))
 309         setattr(event, 'filtered', filtered)
 310         setattr(event, 'uuid', event.uuid)
 311         setattr(event, 'alarm_id', event.alarm_id)
 312         setattr(event, 'description', event.description)
 313         setattr(event, 'suppression_status', event.suppression_status)
 314         setattr(event, 'alarm_type', None)
 315         setattr(event, 'alarm_def_id', None)
 316         setattr(event, 'probable_cause_id', None)
 317         setattr(event, 'state', None)
 318         setattr(event, 'timestamp', None)
 319         return event
 320
 321     @ staticmethod
 322     def _alarmeventhasher(event, state=''):
 323         # The event model and the alarm model have different parameter name
 324         # of the state. alarm model is alarm_state, event model is state.
 325         status = event.alarm_state if state == '' else state
 326         return str(hash((event.uuid, event.timestamp, status)))