1 # -*- coding: utf-8 -*-
4 # Copyright 2016-2017 VMware Inc.
5 # This file is part of ETSI OSM
8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
9 # not use this file except in compliance with the License. You may obtain
10 # a copy of the License at
12 # http://www.apache.org/licenses/LICENSE-2.0
14 # Unless required by applicable law or agreed to in writing, software
15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 # License for the specific language governing permissions and limitations
20 # For those usages not covered by the Apache License, Version 2.0 please
21 # contact: osslegalrouting@vmware.com
25 Montoring plugin receiver that consumes the request messages &
26 responds using producer for vROPs
30 from mon_plugin_vrops
import MonPlugin
31 from kafka_consumer_vrops
import vROP_KafkaConsumer
33 sys
.path
.append("../../core/message_bus")
34 from producer
import KafkaProducer
35 #from core.message_bus.producer import KafkaProducer
40 from xml
.etree
import ElementTree
as XmlElementTree
42 req_config_params
= ('vrops_site', 'vrops_user', 'vrops_password',
43 'vcloud-site','admin_username','admin_password',
44 'vcenter_ip','vcenter_port','vcenter_user','vcenter_password',
45 'vim_tenant_name','orgname','tenant_id')
46 MODULE_DIR
= os
.path
.dirname(__file__
)
47 CONFIG_FILE_NAME
= 'vrops_config.xml'
48 CONFIG_FILE_PATH
= os
.path
.join(MODULE_DIR
, CONFIG_FILE_NAME
)
53 BASE_DIR
= os
.path
.dirname(os
.path
.dirname(__file__
))
54 logger
= logging
.getLogger()
55 formatter
= logging
.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
56 handler
= logging
.FileHandler(os
.path
.join(BASE_DIR
,"mon_vrops_log.log"))
57 handler
.setFormatter(formatter
)
58 logger
.addHandler(handler
)
61 class PluginReceiver():
62 """MON Plugin receiver receiving request messages & responding using producer for vROPs
66 """Constructor of PluginReceiver
69 topics
= ['alarm_request', 'metric_request', 'access_credentials']
71 self
.logger
= logging
.getLogger('PluginReceiver')
72 self
.logger
.setLevel(logging
.DEBUG
)
74 #To Do - Add broker uri
76 #self.mon_plugin = MonPlugin()
77 self
.consumer
= vROP_KafkaConsumer(topics
, broker_uri
)
79 self
.producer_alarms
= KafkaProducer('alarm_response')
80 self
.producer_metrics
= KafkaProducer('metric_response')
81 self
.producer_access_credentials
= KafkaProducer('vim_access_credentials_response')
85 """Consume the message, act on it & respond
88 for message
in self
.consumer
.vrops_consumer
:
89 message_values
= json
.loads(message
.value
)
90 if message_values
.has_key('vim_type'):
91 vim_type
= message_values
['vim_type'].lower()
92 if vim_type
== 'vmware':
93 self
.logger
.info("Action required for: {}".format(message
.topic
))
94 if message
.topic
== 'alarm_request':
95 if message
.key
== "create_alarm_request":
96 config_alarm_info
= json
.loads(message
.value
)
97 alarm_uuid
= self
.create_alarm(config_alarm_info
['alarm_create_request'])
98 self
.logger
.info("Alarm created with alarm uuid: {}".format(alarm_uuid
))
99 #Publish message using producer
100 self
.publish_create_alarm_status(alarm_uuid
, config_alarm_info
)
101 elif message
.key
== "update_alarm_request":
102 update_alarm_info
= json
.loads(message
.value
)
103 alarm_uuid
= self
.update_alarm(update_alarm_info
['alarm_update_request'])
104 self
.logger
.info("Alarm defination updated : alarm uuid: {}".format(alarm_uuid
))
105 #Publish message using producer
106 self
.publish_update_alarm_status(alarm_uuid
, update_alarm_info
)
107 elif message
.key
== "delete_alarm_request":
108 delete_alarm_info
= json
.loads(message
.value
)
109 alarm_uuid
= self
.delete_alarm(delete_alarm_info
['alarm_delete_request'])
110 self
.logger
.info("Alarm defination deleted : alarm uuid: {}".format(alarm_uuid
))
111 #Publish message using producer
112 self
.publish_delete_alarm_status(alarm_uuid
, delete_alarm_info
)
113 elif message
.key
== "list_alarm_request":
114 request_input
= json
.loads(message
.value
)
115 triggered_alarm_list
= self
.list_alarms(request_input
['alarm_list_request'])
116 #Publish message using producer
117 self
.publish_list_alarm_response(triggered_alarm_list
, request_input
)
118 elif message
.topic
== 'metric_request':
119 if message
.key
== "read_metric_data_request":
120 metric_request_info
= json
.loads(message
.value
)
121 mon_plugin_obj
= MonPlugin()
122 metrics_data
= mon_plugin_obj
.get_metrics_data(metric_request_info
)
123 self
.logger
.info("Collected Metrics Data: {}".format(metrics_data
))
124 #Publish message using producer
125 self
.publish_metrics_data_status(metrics_data
)
126 elif message
.key
== "create_metric_request":
127 metric_info
= json
.loads(message
.value
)
128 metric_status
= self
.verify_metric(metric_info
['metric_create'])
129 #Publish message using producer
130 self
.publish_create_metric_response(metric_info
, metric_status
)
131 elif message
.key
== "update_metric_request":
132 metric_info
= json
.loads(message
.value
)
133 metric_status
= self
.verify_metric(metric_info
['metric_create'])
134 #Publish message using producer
135 self
.publish_update_metric_response(metric_info
, metric_status
)
136 elif message
.key
== "delete_metric_request":
137 metric_info
= json
.loads(message
.value
)
138 #Deleting Metric Data is not allowed. Publish status as False
139 self
.logger
.warn("Deleting Metric is not allowed: {}".format(metric_info
['metric_name']))
140 #Publish message using producer
141 self
.publish_delete_metric_response(metric_info
)
142 elif message
.topic
== 'access_credentials':
143 if message
.key
== "vim_access_credentials":
144 access_info
= json
.loads(message
.value
)
145 access_update_status
= self
.update_access_credentials(access_info
['access_config'])
146 self
.publish_access_update_response(access_update_status
, access_info
)
149 self
.logger
.error("Exception in receiver: {}".format(traceback
.format_exc()))
152 def create_alarm(self
, config_alarm_info
):
153 """Create alarm using vROPs plugin
155 mon_plugin
= MonPlugin()
156 plugin_uuid
= mon_plugin
.configure_rest_plugin()
157 alarm_uuid
= mon_plugin
.configure_alarm(config_alarm_info
)
160 def publish_create_alarm_status(self
, alarm_uuid
, config_alarm_info
):
161 """Publish create alarm status using producer
163 topic
= 'alarm_response'
164 msg_key
= 'create_alarm_response'
165 response_msg
= {"schema_version":1.0,
166 "schema_type":"create_alarm_response",
167 "alarm_create_response":
168 {"correlation_id":config_alarm_info
["alarm_create_request"]["correlation_id"],
169 "alarm_uuid":alarm_uuid
,
170 "status": True if alarm_uuid
else False
174 self
.producer_alarms
.publish(key
=msg_key
, value
=json
.dumps(response_msg
), topic
=topic
)
176 def update_alarm(self
, update_alarm_info
):
177 """Updare already created alarm
179 mon_plugin
= MonPlugin()
180 alarm_uuid
= mon_plugin
.update_alarm_configuration(update_alarm_info
)
183 def publish_update_alarm_status(self
, alarm_uuid
, update_alarm_info
):
184 """Publish update alarm status requests using producer
186 topic
= 'alarm_response'
187 msg_key
= 'update_alarm_response'
188 response_msg
= {"schema_version":1.0,
189 "schema_type":"update_alarm_response",
190 "alarm_update_response":
191 {"correlation_id":update_alarm_info
["alarm_update_request"]["correlation_id"],
192 "alarm_uuid":alarm_uuid
,
193 "status": True if alarm_uuid
else False
197 self
.producer_alarms
.publish(key
=msg_key
, value
=json
.dumps(response_msg
), topic
=topic
)
199 def delete_alarm(self
, delete_alarm_info
):
200 """Delete alarm configuration
202 mon_plugin
= MonPlugin()
203 alarm_uuid
= mon_plugin
.delete_alarm_configuration(delete_alarm_info
)
206 def publish_delete_alarm_status(self
, alarm_uuid
, delete_alarm_info
):
207 """Publish update alarm status requests using producer
209 topic
= 'alarm_response'
210 msg_key
= 'delete_alarm_response'
211 response_msg
= {"schema_version":1.0,
212 "schema_type":"delete_alarm_response",
213 "alarm_deletion_response":
214 {"correlation_id":delete_alarm_info
["alarm_delete_request"]["correlation_id"],
215 "alarm_uuid":alarm_uuid
,
216 "status": True if alarm_uuid
else False
220 self
.producer_alarms
.publish(key
=msg_key
, value
=json
.dumps(response_msg
), topic
=topic
)
223 def publish_metrics_data_status(self
, metrics_data
):
224 """Publish the requested metric data using producer
226 topic
= 'metric_response'
227 msg_key
= 'read_metric_data_response'
229 self
.producer_metrics
.publish(key
=msg_key
, value
=json
.dumps(metrics_data
), topic
=topic
)
232 def verify_metric(self
, metric_info
):
233 """Verify if metric is supported or not
235 mon_plugin
= MonPlugin()
236 metric_key_status
= mon_plugin
.verify_metric_support(metric_info
)
237 return metric_key_status
239 def publish_create_metric_response(self
, metric_info
, metric_status
):
240 """Publish create metric response
242 topic
= 'metric_response'
243 msg_key
= 'create_metric_response'
244 response_msg
= {"schema_version":1.0,
245 "schema_type":"create_metric_response",
246 "correlation_id":metric_info
['correlation_id'],
247 "metric_create_response":
250 "resource_uuid":metric_info
['metric_create']['resource_uuid'],
251 "status":metric_status
255 self
.producer_metrics
.publish(key
=msg_key
, value
=json
.dumps(response_msg
), topic
=topic
)
257 def publish_update_metric_response(self
, metric_info
, metric_status
):
258 """Publish update metric response
260 topic
= 'metric_response'
261 msg_key
= 'update_metric_response'
262 response_msg
= {"schema_version":1.0,
263 "schema_type":"metric_update_response",
264 "correlation_id":metric_info
['correlation_id'],
265 "metric_update_response":
268 "resource_uuid":metric_info
['metric_create']['resource_uuid'],
269 "status":metric_status
273 self
.producer_metrics
.publish(key
=msg_key
, value
=json
.dumps(response_msg
), topic
=topic
)
275 def publish_delete_metric_response(self
, metric_info
):
278 topic
= 'metric_response'
279 msg_key
= 'delete_metric_response'
280 response_msg
= {"schema_version":1.0,
281 "schema_type":"delete_metric_response",
282 "correlation_id":metric_info
['correlation_id'],
283 "metric_name":metric_info
['metric_name'],
285 "resource_uuid":metric_info
['resource_uuid'],
286 "tenant_uuid":metric_info
['tenant_uuid'],
290 self
.producer_metrics
.publish(key
=msg_key
, value
=json
.dumps(response_msg
), topic
=topic
)
292 def list_alarms(self
, list_alarm_input
):
293 """Collect list of triggered alarms based on input
295 mon_plugin
= MonPlugin()
296 triggered_alarms
= mon_plugin
.get_triggered_alarms_list(list_alarm_input
)
297 return triggered_alarms
300 def publish_list_alarm_response(self
, triggered_alarm_list
, list_alarm_input
):
301 """Publish list of triggered alarms
303 topic
= 'alarm_response'
304 msg_key
= 'list_alarm_response'
305 response_msg
= {"schema_version":1.0,
306 "schema_type":"list_alarm_response",
307 "correlation_id":list_alarm_input
['alarm_list_request']['correlation_id'],
308 #"resource_uuid":list_alarm_input['alarm_list_request']['resource_uuid'],
309 "list_alarm_resp":triggered_alarm_list
312 self
.producer_alarms
.publish(key
=msg_key
, value
=json
.dumps(response_msg
), topic
=topic
)
315 def update_access_credentials(self
, access_info
):
316 """Verify if all the required access config params are provided and
317 updates access config in default vrops config file
319 update_status
= False
321 #Check if all the required config params are passed in request
322 if not all (keys
in access_info
for keys
in req_config_params
):
323 self
.logger
.debug("All required Access Config Parameters not provided")
324 self
.logger
.debug("List of required Access Config Parameters: {}".format(req_config_params
))
325 self
.logger
.debug("List of given Access Config Parameters: {}".format(access_info
))
328 wr_status
= self
.write_access_config(access_info
)
329 return wr_status
#True/False
331 def write_access_config(self
, access_info
):
332 """Write access configuration to vROPs config file.
336 tree
= XmlElementTree
.parse(CONFIG_FILE_PATH
)
337 root
= tree
.getroot()
340 if config
.tag
== 'Access_Config':
342 for key
,val
in access_info
.iteritems():
344 #print param.tag, val
347 tree
.write(CONFIG_FILE_PATH
)
349 except Exception as exp
:
350 self
.logger
.warn("Failed to update Access Config Parameters: {}".format(exp
))
355 def publish_access_update_response(self
, access_update_status
, access_info_req
):
356 """Publish access update response
358 topic
= 'access_credentials'
359 msg_key
= 'vim_access_credentials_response'
360 response_msg
= {"schema_version":1.0,
361 "schema_type":"vim_access_credentials_response",
362 "correlation_id":access_info_req
['access_config']['correlation_id'],
363 "status":access_update_status
365 #To Do - Add producer
366 #self.producer.publish(key=msg_key, value=json.dumps(response_msg), topic=topic)
367 self
.producer
.publish(topic
=topic
, messages
=json
.dumps(response_msg
), msg_key
=msg_key
)
370 #log.basicConfig(filename='mon_vrops_log.log',level=log.DEBUG)
372 plugin_rcvr
= PluginReceiver()
373 plugin_rcvr
.consume()
375 if __name__
== "__main__":