1 # Copyright (C) 2022 Wind River Systems, Inc.
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
15 # client talking to Stx standalone
17 from typing import List # Optional, Set
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
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
31 from o2common.helper import o2logging
32 logger = o2logging.get_logger(__name__)
35 CGTSCLIENT_ENDPOINT_ERROR_MSG = \
36 'Must provide Keystone credentials or user-defined endpoint and token'
39 class StxAlarmClient(BaseClient):
40 def __init__(self, uow: unit_of_work.AbstractUnitOfWork, driver=None):
42 self.driver = driver if driver else StxFaultClientImp()
45 def _get(self, id) -> alarmModel.FaultGenericModel:
46 return self.driver.getAlarmInfo(id)
48 def _list(self, **filters) -> List[alarmModel.FaultGenericModel]:
49 newmodels = self.driver.getAlarmList(**filters)
53 rs = uow.session.execute(
55 SELECT "alarmEventRecordId"
56 FROM "alarmEventRecord"
57 WHERE "perceivedSeverity" != :perceived_severity_enum
59 dict(perceived_severity_enum=alarmModel.PerceivedSeverityEnum.
64 # logger.debug('Exist alarm: ' + id)
65 exist_alarms[id] = False
70 if exist_alarms[m.id]:
72 exist_alarms[m.id] = True
74 logger.debug('alarm new: ' + m.id)
77 for alarm in exist_alarms:
78 logger.debug('exist alarm: ' + alarm)
79 if exist_alarms[alarm]:
80 # exist alarm is active
83 event = self._get(alarm)
85 logger.debug('alarm {} not in this resource pool {}'
86 .format(alarm, self._pool_id))
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))
97 def _set_stx_client(self):
98 self.driver.setFaultClient(self._pool_id)
101 class StxEventClient(BaseClient):
102 def __init__(self, driver=None):
104 self.driver = driver if driver else StxFaultClientImp()
106 def _get(self, id) -> alarmModel.FaultGenericModel:
107 return self.driver.getEventInfo(id)
109 def _list(self, **filters) -> List[alarmModel.FaultGenericModel]:
110 return self.driver.getEventList(**filters)
112 def _set_stx_client(self):
113 self.driver.setFaultClient(self._pool_id)
116 # internal driver which implement client call to Stx Fault Management instance
117 class StxFaultClientImp(object):
118 def __init__(self, fm_client=None, stx_client=None, dc_client=None):
120 self.fmclient = fm_client if fm_client else self.getFmClient()
121 self.stxclient = stx_client if stx_client else self.getStxClient()
122 self.dcclient = dc_client if dc_client else self.getDcmanagerClient()
124 def getStxClient(self):
125 os_client_args = config.get_stx_access_info()
126 config_client = get_stx_client(**os_client_args)
129 def getDcmanagerClient(self):
130 os_client_args = config.get_dc_access_info()
131 config_client = get_dc_client(**os_client_args)
134 def getFmClient(self):
135 os_client_args = config.get_fm_access_info()
136 config_client = get_fm_client(1, **os_client_args)
139 def getSubcloudList(self):
140 self.dcclient = self.getDcmanagerClient()
141 subs = self.dcclient.subcloud_manager.list_subclouds()
142 known_subs = [sub for sub in subs if sub.sync_status != 'unknown']
145 def getSubcloudFaultClient(self, subcloud_id):
146 subcloud = self.dcclient.subcloud_manager.\
147 subcloud_additional_details(subcloud_id)
148 logger.debug('subcloud name: %s, oam_floating_ip: %s' %
149 (subcloud[0].name, subcloud[0].oam_floating_ip))
152 os_client_args = config.get_stx_access_info(
153 region_name=subcloud[0].region_name,
154 subcloud_hostname=subcloud[0].oam_floating_ip)
155 stx_client = get_stx_client(**os_client_args)
156 except EndpointException as e:
157 msg = e.format_message()
158 if CGTSCLIENT_ENDPOINT_ERROR_MSG in msg:
160 os_client_args = config.get_stx_access_info(
161 region_name=subcloud[0].region_name,
162 sub_is_https=sub_is_https,
163 subcloud_hostname=subcloud[0].oam_floating_ip)
164 stx_client = get_stx_client(**os_client_args)
166 raise ValueError('Stx endpoint exception: %s' % msg)
168 raise ValueError('cgtsclient get subcloud client failed')
170 os_client_args = config.get_fm_access_info(
171 sub_is_https=sub_is_https,
172 subcloud_hostname=subcloud[0].oam_floating_ip)
173 fm_client = get_fm_client(1, **os_client_args)
175 return stx_client, fm_client
177 def setFaultClient(self, resource_pool_id):
178 systems = self.stxclient.isystem.list()
179 if resource_pool_id == systems[0].uuid:
180 logger.debug('Fault Client not change: %s' % resource_pool_id)
181 self.fmclient = self.getFmClient()
184 subclouds = self.getSubcloudList()
185 for subcloud in subclouds:
186 substxclient, subfaultclient = self.getSubcloudFaultClient(
187 subcloud.subcloud_id)
188 systems = substxclient.isystem.list()
189 if resource_pool_id == systems[0].uuid:
190 self.fmclient = subfaultclient
192 def getAlarmList(self, **filters) -> List[alarmModel.FaultGenericModel]:
193 alarms = self.fmclient.alarm.list(expand=True)
197 'alarm:' + str(alarm.to_dict())) for alarm in alarms if alarm]
198 return [alarmModel.FaultGenericModel(
199 alarmModel.EventTypeEnum.ALARM, self._alarmconverter(alarm))
200 for alarm in alarms if alarm]
202 def getAlarmInfo(self, id) -> alarmModel.FaultGenericModel:
204 alarm = self.fmclient.alarm.get(id)
206 'get alarm id: ' + id + ', result:' + str(alarm.to_dict()))
208 event = self.fmclient.event_log.get(id)
209 return alarmModel.FaultGenericModel(
210 alarmModel.EventTypeEnum.ALARM, self._eventconverter(event,
212 return alarmModel.FaultGenericModel(
213 alarmModel.EventTypeEnum.ALARM, self._alarmconverter(alarm))
215 def getEventList(self, **filters) -> List[alarmModel.FaultGenericModel]:
216 events = self.fmclient.event_log.list(alarms=True, expand=True)
218 'alarm:' + str(event.to_dict())) for event in events if event]
219 return [alarmModel.FaultGenericModel(
220 alarmModel.EventTypeEnum.EVENT, self._eventconverter(event))
221 for event in events if event]
223 def getEventInfo(self, id) -> alarmModel.FaultGenericModel:
224 event = self.fmclient.event_log.get(id)
225 logger.debug('get event id ' + id + ':' + str(event.to_dict()))
226 return alarmModel.FaultGenericModel(
227 alarmModel.EventTypeEnum.EVENT, self._eventconverter(event))
230 def _alarmconverter(alarm):
232 'alarm_id', 'alarm_state', 'entity_type_id', 'entity_instance_id',
233 'reason_text', 'alarm_type', 'probable_cause',
234 'proposed_repair_action', 'service_affecting', 'suppression',
235 'suppression_status', 'mgmt_affecting', 'degrade_affecting'
237 content = alarm.to_dict()
239 filter(lambda item: item[0] in selected_keys, content.items()))
240 setattr(alarm, 'filtered', filtered)
241 # setattr(alarm, 'alarm_def_id', uuid.uuid3(
242 # uuid.NAMESPACE_URL, alarm.alarm_id))
243 setattr(alarm, 'state', alarm.alarm_state)
245 setattr(alarm, 'alarm_def_id', str(uuid.uuid3(
246 uuid.NAMESPACE_URL, alarm.alarm_id)))
247 setattr(alarm, 'probable_cause_id', str(uuid.uuid3(
248 uuid.NAMESPACE_URL, alarm.probable_cause)))
252 def _eventconverter(event, clear=False):
254 'event_log_id', 'state', 'entity_type_id',
255 'entity_instance_id', 'reason_text', 'event_log_type',
256 'probable_cause', 'proposed_repair_action',
257 'service_affecting', 'suppression', 'suppression_status'
259 content = event.to_dict()
261 filter(lambda item: item[0] in selected_keys, content.items()))
262 setattr(event, 'filtered', filtered)
263 setattr(event, 'alarm_id', event.event_log_id)
264 setattr(event, 'alarm_type', event.event_log_type)
266 logger.debug('alarm is clear')
267 event.state = 'clear'
268 setattr(event, 'alarm_def_id', str(uuid.uuid3(
269 uuid.NAMESPACE_URL, event.alarm_id)))
270 setattr(event, 'probable_cause_id', str(uuid.uuid3(
271 uuid.NAMESPACE_URL, event.probable_cause)))
275 def _alarmeventhasher(event, state=''):
276 # The event model and the alarm model have different parameter name
277 # of the state. alarm model is alarm_state, event model is state.
278 status = event.alarm_state if state == '' else state
279 return str(hash((event.uuid, event.timestamp, status)))