osm_mon/plugins/OpenStack/Gnocchi/metrics.py

   1 # Copyright 2017 Intel Research and Development Ireland Limited
   2 # *************************************************************
   3
   4 # This file is part of OSM Monitoring module
   5 # All Rights Reserved to Intel Corporation
   6
   7 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   8 # not use this file except in compliance with the License. You may obtain
   9 # a copy of the License at
  10
  11 #         http://www.apache.org/licenses/LICENSE-2.0
  12
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  15 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  16 # License for the specific language governing permissions and limitations
  17 # under the License.
  18
  19 # For those usages not covered by the Apache License, Version 2.0 please
  20 # contact: helena.mcgough@intel.com or adrian.hoban@intel.com
  21 ##
  22 """Carry out OpenStack metric requests via Gnocchi API."""
  23
  24 import datetime
  25 import json
  26 import logging
  27
  28 import time
  29
  30 import six
  31
  32 from osm_mon.core.message_bus.producer import KafkaProducer
  33 from osm_mon.plugins.OpenStack.common import Common
  34
  35 from osm_mon.plugins.OpenStack.response import OpenStack_Response
  36 from osm_mon.plugins.OpenStack.settings import Config
  37
  38 log = logging.getLogger(__name__)
  39
  40 METRIC_MAPPINGS = {
  41     "average_memory_utilization": "memory.percent",
  42     "disk_read_ops": "disk.read.requests",
  43     "disk_write_ops": "disk.write.requests",
  44     "disk_read_bytes": "disk.read.bytes",
  45     "disk_write_bytes": "disk.write.bytes",
  46     "packets_dropped": "interface.if_dropped",
  47     "packets_received": "interface.if_packets",
  48     "packets_sent": "interface.if_packets",
  49     "cpu_utilization": "cpu_util",
  50 }
  51
  52 PERIOD_MS = {
  53     "HR": 3600000,
  54     "DAY": 86400000,
  55     "WEEK": 604800000,
  56     "MONTH": 2629746000,
  57     "YEAR": 31556952000
  58 }
  59
  60
  61 class Metrics(object):
  62     """OpenStack metric requests performed via the Gnocchi API."""
  63
  64     def __init__(self):
  65         """Initialize the metric actions."""
  66         # Configure an instance of the OpenStack metric plugin
  67         config = Config.instance()
  68         config.read_environ()
  69
  70         # Initialise authentication for API requests
  71         self._common = Common()
  72
  73         # Use the Response class to generate valid json response messages
  74         self._response = OpenStack_Response()
  75
  76         # Initializer a producer to send responses back to SO
  77         self._producer = KafkaProducer("metric_response")
  78
  79     def metric_calls(self, message):
  80         """Consume info from the message bus to manage metric requests."""
  81         values = json.loads(message.value)
  82         log.info("OpenStack metric action required.")
  83
  84         auth_token = Common.get_auth_token(values['vim_uuid'])
  85
  86         endpoint = Common.get_endpoint("metric", values['vim_uuid'])
  87
  88         if message.key == "create_metric_request":
  89             # Configure metric
  90             metric_details = values['metric_create']
  91             metric_id, resource_id, status = self.configure_metric(
  92                 endpoint, auth_token, metric_details)
  93
  94             # Generate and send a create metric response
  95             try:
  96                 resp_message = self._response.generate_response(
  97                     'create_metric_response', status=status,
  98                     cor_id=values['correlation_id'],
  99                     metric_id=metric_id, r_id=resource_id)
 100                 log.info("Response messages: %s", resp_message)
 101                 self._producer.create_metrics_resp(
 102                     'create_metric_response', resp_message,
 103                     'metric_response')
 104             except Exception as exc:
 105                 log.warn("Failed to create response: %s", exc)
 106
 107         elif message.key == "read_metric_data_request":
 108             # Read all metric data related to a specified metric
 109             timestamps, metric_data = self.read_metric_data(
 110                 endpoint, auth_token, values)
 111
 112             # Generate and send a response message
 113             try:
 114                 resp_message = self._response.generate_response(
 115                     'read_metric_data_response',
 116                     m_id=values['metric_uuid'],
 117                     m_name=values['metric_name'],
 118                     r_id=values['resource_uuid'],
 119                     cor_id=values['correlation_id'],
 120                     times=timestamps, metrics=metric_data)
 121                 log.info("Response message: %s", resp_message)
 122                 self._producer.read_metric_data_response(
 123                     'read_metric_data_response', resp_message,
 124                     'metric_response')
 125             except Exception as exc:
 126                 log.warn("Failed to send read metric response:%s", exc)
 127
 128         elif message.key == "delete_metric_request":
 129             # delete the specified metric in the request
 130             metric_id = values['metric_uuid']
 131             status = self.delete_metric(
 132                 endpoint, auth_token, metric_id)
 133
 134             # Generate and send a response message
 135             try:
 136                 resp_message = self._response.generate_response(
 137                     'delete_metric_response', m_id=metric_id,
 138                     m_name=values['metric_name'],
 139                     status=status, r_id=values['resource_uuid'],
 140                     cor_id=values['correlation_id'])
 141                 log.info("Response message: %s", resp_message)
 142                 self._producer.delete_metric_response(
 143                     'delete_metric_response', resp_message,
 144                     'metric_response')
 145             except Exception as exc:
 146                 log.warn("Failed to send delete response:%s", exc)
 147
 148         elif message.key == "update_metric_request":
 149             # Gnocchi doesn't support configuration updates
 150             # Log and send a response back to this effect
 151             log.warn("Gnocchi doesn't support metric configuration\
 152                       updates.")
 153             req_details = values['metric_create']
 154             metric_name = req_details['metric_name']
 155             resource_id = req_details['resource_uuid']
 156             metric_id = self.get_metric_id(
 157                 endpoint, auth_token, metric_name, resource_id)
 158
 159             # Generate and send a response message
 160             try:
 161                 resp_message = self._response.generate_response(
 162                     'update_metric_response', status=False,
 163                     cor_id=values['correlation_id'],
 164                     r_id=resource_id, m_id=metric_id)
 165                 log.info("Response message: %s", resp_message)
 166                 self._producer.update_metric_response(
 167                     'update_metric_response', resp_message,
 168                     'metric_response')
 169             except Exception as exc:
 170                 log.warn("Failed to send an update response:%s", exc)
 171
 172         elif message.key == "list_metric_request":
 173             list_details = values['metrics_list_request']
 174
 175             metric_list = self.list_metrics(
 176                 endpoint, auth_token, list_details)
 177
 178             # Generate and send a response message
 179             try:
 180                 resp_message = self._response.generate_response(
 181                     'list_metric_response', m_list=metric_list,
 182                     cor_id=list_details['correlation_id'])
 183                 log.info("Response message: %s", resp_message)
 184                 self._producer.list_metric_response(
 185                     'list_metric_response', resp_message,
 186                     'metric_response')
 187             except Exception as exc:
 188                 log.warn("Failed to send a list response:%s", exc)
 189
 190         else:
 191             log.warn("Unknown key, no action will be performed.")
 192
 193         return
 194
 195     def configure_metric(self, endpoint, auth_token, values):
 196         """Create the new metric in Gnocchi."""
 197         try:
 198             resource_id = values['resource_uuid']
 199         except KeyError:
 200             log.warn("Resource is not defined correctly.")
 201             return None, None, False
 202
 203         # Check/Normalize metric name
 204         norm_name, metric_name = self.get_metric_name(values)
 205         if metric_name is None:
 206             log.warn("This metric is not supported by this plugin.")
 207             return None, resource_id, False
 208
 209         # Check for an existing metric for this resource
 210         metric_id = self.get_metric_id(
 211             endpoint, auth_token, metric_name, resource_id)
 212
 213         if metric_id is None:
 214             # Try appending metric to existing resource
 215             try:
 216                 base_url = "{}/v1/resource/generic/%s/metric"
 217                 res_url = base_url.format(endpoint) % resource_id
 218                 payload = {metric_name: {'archive_policy_name': 'high',
 219                                          'unit': values['metric_unit']}}
 220                 result = Common.perform_request(
 221                     res_url, auth_token, req_type="post",
 222                     payload=json.dumps(payload))
 223                 # Get id of newly created metric
 224                 for row in json.loads(result.text):
 225                     if row['name'] == metric_name:
 226                         metric_id = row['id']
 227                 log.info("Appended metric to existing resource.")
 228
 229                 return metric_id, resource_id, True
 230             except Exception as exc:
 231                 # Gnocchi version of resource does not exist creating a new one
 232                 log.info("Failed to append metric to existing resource:%s",
 233                          exc)
 234                 try:
 235                     url = "{}/v1/resource/generic".format(endpoint)
 236                     metric = {'name': metric_name,
 237                               'archive_policy_name': 'high',
 238                               'unit': values['metric_unit'], }
 239
 240                     resource_payload = json.dumps({'id': resource_id,
 241                                                    'metrics': {
 242                                                        metric_name: metric}})
 243
 244                     resource = Common.perform_request(
 245                         url, auth_token, req_type="post",
 246                         payload=resource_payload)
 247
 248                     # Return the newly created resource_id for creating alarms
 249                     new_resource_id = json.loads(resource.text)['id']
 250                     log.info("Created new resource for metric: %s",
 251                              new_resource_id)
 252
 253                     metric_id = self.get_metric_id(
 254                         endpoint, auth_token, metric_name, new_resource_id)
 255
 256                     return metric_id, new_resource_id, True
 257                 except Exception as exc:
 258                     log.warn("Failed to create a new resource:%s", exc)
 259             return None, None, False
 260
 261         else:
 262             log.info("This metric already exists for this resource.")
 263
 264         return metric_id, resource_id, False
 265
 266     def delete_metric(self, endpoint, auth_token, metric_id):
 267         """Delete metric."""
 268         url = "{}/v1/metric/%s".format(endpoint) % metric_id
 269
 270         try:
 271             result = Common.perform_request(
 272                 url, auth_token, req_type="delete")
 273             if str(result.status_code) == "404":
 274                 log.warn("Failed to delete the metric.")
 275                 return False
 276             else:
 277                 return True
 278         except Exception as exc:
 279             log.warn("Failed to carry out delete metric request:%s", exc)
 280         return False
 281
 282     def list_metrics(self, endpoint, auth_token, values):
 283         """List all metrics."""
 284
 285         # Check for a specified list
 286         try:
 287             # Check if the metric_name was specified for the list
 288             metric_name = values['metric_name'].lower()
 289             if metric_name not in METRIC_MAPPINGS.keys():
 290                 log.warn("This metric is not supported, won't be listed.")
 291                 metric_name = None
 292         except KeyError as exc:
 293             log.info("Metric name is not specified: %s", exc)
 294             metric_name = None
 295
 296         try:
 297             resource = values['resource_uuid']
 298         except KeyError as exc:
 299             log.info("Resource is not specified:%s", exc)
 300             resource = None
 301
 302         try:
 303             url = "{}/v1/metric?sort=name:asc".format(endpoint)
 304             result = Common.perform_request(
 305                 url, auth_token, req_type="get")
 306             metrics = []
 307             metrics_partial = json.loads(result.text)
 308             for metric in metrics_partial:
 309                 metrics.append(metric)
 310
 311             while len(json.loads(result.text)) > 0:
 312                 last_metric_id = metrics_partial[-1]['id']
 313                 url = "{}/v1/metric?sort=name:asc&marker={}".format(endpoint, last_metric_id)
 314                 result = Common.perform_request(
 315                     url, auth_token, req_type="get")
 316                 if len(json.loads(result.text)) > 0:
 317                     metrics_partial = json.loads(result.text)
 318                     for metric in metrics_partial:
 319                         metrics.append(metric)
 320
 321             if metrics is not None:
 322                 # Format the list response
 323                 if metric_name is not None and resource is not None:
 324                     metric_list = self.response_list(
 325                         metrics, metric_name=metric_name, resource=resource)
 326                     log.info("Returning an %s resource list for %s metrics",
 327                              metric_name, resource)
 328                 elif metric_name is not None:
 329                     metric_list = self.response_list(
 330                         metrics, metric_name=metric_name)
 331                     log.info("Returning a list of %s metrics", metric_name)
 332                 elif resource is not None:
 333                     metric_list = self.response_list(
 334                         metrics, resource=resource)
 335                     log.info("Return a list of %s resource metrics", resource)
 336                 else:
 337                     metric_list = self.response_list(metrics)
 338                     log.info("Returning a complete list of metrics")
 339
 340                 return metric_list
 341             else:
 342                 log.info("There are no metrics available")
 343                 return []
 344         except Exception as exc:
 345             log.warn("Failed to generate any metric list. %s", exc)
 346         return None
 347
 348     def get_metric_id(self, endpoint, auth_token, metric_name, resource_id):
 349         """Check if the desired metric already exists for the resource."""
 350         url = "{}/v1/resource/generic/%s".format(endpoint) % resource_id
 351
 352         try:
 353             # Try return the metric id if it exists
 354             result = Common.perform_request(
 355                 url, auth_token, req_type="get")
 356             return json.loads(result.text)['metrics'][metric_name]
 357         except Exception:
 358             log.info("Metric doesn't exist. No metric_id available")
 359         return None
 360
 361     def get_metric_name(self, values):
 362         """Check metric name configuration and normalize."""
 363         metric_name = None
 364         try:
 365             # Normalize metric name
 366             metric_name = values['metric_name'].lower()
 367             return metric_name, METRIC_MAPPINGS[metric_name]
 368         except KeyError:
 369             log.info("Metric name %s is invalid.", metric_name)
 370         return metric_name, None
 371
 372     def read_metric_data(self, endpoint, auth_token, values):
 373         """Collect metric measures over a specified time period."""
 374         timestamps = []
 375         data = []
 376         try:
 377             # Try and collect measures
 378             metric_id = values['metric_uuid']
 379             collection_unit = values['collection_unit'].upper()
 380             collection_period = values['collection_period']
 381
 382             # Define the start and end time based on configurations
 383             # FIXME: Local timezone may differ from timezone set in Gnocchi, causing discrepancies in measures
 384             stop_time = time.strftime("%Y-%m-%d") + "T" + time.strftime("%X")
 385             end_time = int(round(time.time() * 1000))
 386             if collection_unit == 'YEAR':
 387                 diff = PERIOD_MS[collection_unit]
 388             else:
 389                 diff = collection_period * PERIOD_MS[collection_unit]
 390             s_time = (end_time - diff) / 1000.0
 391             start_time = datetime.datetime.fromtimestamp(s_time).strftime(
 392                 '%Y-%m-%dT%H:%M:%S.%f')
 393             base_url = "{}/v1/metric/%(0)s/measures?start=%(1)s&stop=%(2)s"
 394             url = base_url.format(endpoint) % {
 395                 "0": metric_id, "1": start_time, "2": stop_time}
 396
 397             # Perform metric data request
 398             metric_data = Common.perform_request(
 399                 url, auth_token, req_type="get")
 400
 401             # Generate a list of the requested timestamps and data
 402             for r in json.loads(metric_data.text):
 403                 timestamp = r[0].replace("T", " ")
 404                 timestamps.append(timestamp)
 405                 data.append(r[2])
 406
 407             return timestamps, data
 408         except Exception as exc:
 409             log.warn("Failed to gather specified measures: %s", exc)
 410         return timestamps, data
 411
 412     def response_list(self, metric_list, metric_name=None, resource=None):
 413         """Create the appropriate lists for a list response."""
 414         resp_list, name_list, res_list = [], [], []
 415
 416         # Create required lists
 417         for row in metric_list:
 418             # Only list OSM metrics
 419             name = None
 420             if row['name'] in METRIC_MAPPINGS.values():
 421                 for k,v in six.iteritems(METRIC_MAPPINGS):
 422                     if row['name'] == v:
 423                         name = k
 424                 metric = {"metric_name": name,
 425                           "metric_uuid": row['id'],
 426                           "metric_unit": row['unit'],
 427                           "resource_uuid": row['resource_id']}
 428                 resp_list.append(metric)
 429             # Generate metric_name specific list
 430             if metric_name is not None and name is not None:
 431                 if metric_name in METRIC_MAPPINGS.keys() and row['name'] == METRIC_MAPPINGS[metric_name]:
 432                     metric = {"metric_name": metric_name,
 433                               "metric_uuid": row['id'],
 434                               "metric_unit": row['unit'],
 435                               "resource_uuid": row['resource_id']}
 436                     name_list.append(metric)
 437             # Generate resource specific list
 438             if resource is not None and name is not None:
 439                 if row['resource_id'] == resource:
 440                     metric = {"metric_name": name,
 441                               "metric_uuid": row['id'],
 442                               "metric_unit": row['unit'],
 443                               "resource_uuid": row['resource_id']}
 444                     res_list.append(metric)
 445
 446         # Join required lists
 447         if metric_name is not None and resource is not None:
 448             # Return intersection of res_list and name_list
 449             return [i for i in res_list for j in name_list if i['metric_uuid'] == j['metric_uuid']]
 450         elif metric_name is not None:
 451             return name_list
 452         elif resource is not None:
 453             return res_list
 454         else:
 455             return resp_list