osm_mon/collector/vnf_collectors/openstack.py

   1 # Copyright 2018 Whitestack, LLC
   2 # *************************************************************
   3
   4 # This file is part of OSM Monitoring module
   5 # All Rights Reserved to Whitestack, LLC
   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: bdiaz@whitestack.com or glavado@whitestack.com
  21 ##
  22 import datetime
  23 import json
  24 import logging
  25 from typing import List
  26
  27 import gnocchiclient.exceptions
  28 from gnocchiclient.v1 import client as gnocchi_client
  29 from ceilometerclient.v2 import client as ceilometer_client
  30 from keystoneauth1 import session
  31 from keystoneauth1.exceptions import EndpointNotFound
  32 from keystoneauth1.identity import v3
  33
  34 from osm_mon.collector.metric import Metric
  35 from osm_mon.collector.vnf_collectors.base_vim import BaseVimCollector
  36 from osm_mon.collector.vnf_metric import VnfMetric
  37 from osm_mon.core.auth import AuthManager
  38 from osm_mon.core.common_db import CommonDbClient
  39 from osm_mon.core.config import Config
  40
  41 log = logging.getLogger(__name__)
  42
  43 METRIC_MAPPINGS = {
  44     "average_memory_utilization": "memory.usage",
  45     "disk_read_ops": "disk.read.requests",
  46     "disk_write_ops": "disk.write.requests",
  47     "disk_read_bytes": "disk.read.bytes",
  48     "disk_write_bytes": "disk.write.bytes",
  49     "packets_dropped": "interface.if_dropped",
  50     "packets_received": "interface.if_packets",
  51     "packets_sent": "interface.if_packets",
  52     "cpu_utilization": "cpu_util",
  53 }
  54
  55
  56 class OpenstackCollector(BaseVimCollector):
  57     def __init__(self, config: Config, vim_account_id: str):
  58         super().__init__(config, vim_account_id)
  59         self.conf = config
  60         self.common_db = CommonDbClient(config)
  61         self.auth_manager = AuthManager(config)
  62         self.granularity = self._get_granularity(vim_account_id)
  63         self.backend = self._get_backend(vim_account_id)
  64         self.client = self._build_client(vim_account_id)
  65
  66     def _get_resource_uuid(self, nsr_id, vnf_member_index, vdur_name) -> str:
  67         vdur = self.common_db.get_vdur(nsr_id, vnf_member_index, vdur_name)
  68         return vdur['vim-id']
  69
  70     def _build_gnocchi_client(self, vim_account_id: str) -> gnocchi_client.Client:
  71         creds = self.auth_manager.get_credentials(vim_account_id)
  72         verify_ssl = self.auth_manager.is_verify_ssl(vim_account_id)
  73         auth = v3.Password(auth_url=creds.url,
  74                            username=creds.user,
  75                            password=creds.password,
  76                            project_name=creds.tenant_name,
  77                            project_domain_id='default',
  78                            user_domain_id='default')
  79         sess = session.Session(auth=auth, verify=verify_ssl)
  80         return gnocchi_client.Client(session=sess)
  81
  82     def _build_ceilometer_client(self, vim_account_id: str) -> ceilometer_client.Client:
  83         creds = self.auth_manager.get_credentials(vim_account_id)
  84         verify_ssl = self.auth_manager.is_verify_ssl(vim_account_id)
  85         auth = v3.Password(auth_url=creds.url,
  86                            username=creds.user,
  87                            password=creds.password,
  88                            project_name=creds.tenant_name,
  89                            project_domain_id='default',
  90                            user_domain_id='default')
  91         sess = session.Session(auth=auth, verify=verify_ssl)
  92         return ceilometer_client.Client(session=sess)
  93
  94     def _get_granularity(self, vim_account_id: str):
  95         creds = self.auth_manager.get_credentials(vim_account_id)
  96         vim_config = json.loads(creds.config)
  97         if 'granularity' in vim_config:
  98             return int(vim_config['granularity'])
  99         else:
 100             return int(self.conf.get('openstack', 'default_granularity'))
 101
 102     def collect(self, vnfr: dict) -> List[Metric]:
 103         nsr_id = vnfr['nsr-id-ref']
 104         vnf_member_index = vnfr['member-vnf-index-ref']
 105         vnfd = self.common_db.get_vnfd(vnfr['vnfd-id'])
 106         metrics = []
 107         for vdur in vnfr['vdur']:
 108             # This avoids errors when vdur records have not been completely filled
 109             if 'name' not in vdur:
 110                 continue
 111             vdu = next(
 112                 filter(lambda vdu: vdu['id'] == vdur['vdu-id-ref'], vnfd['vdu'])
 113             )
 114             if 'monitoring-param' in vdu:
 115                 for param in vdu['monitoring-param']:
 116                     metric_name = param['nfvi-metric']
 117                     openstack_metric_name = METRIC_MAPPINGS[metric_name]
 118                     try:
 119                         resource_id = self._get_resource_uuid(nsr_id, vnf_member_index, vdur['name'])
 120                     except ValueError:
 121                         log.warning(
 122                             "Could not find resource_uuid for vdur %s, vnf_member_index %s, nsr_id %s. "
 123                             "Was it recently deleted?".format(
 124                                 vdur['name'], vnf_member_index, nsr_id))
 125                         continue
 126                     if self.backend == 'ceilometer':
 127                         measures = self.client.samples.list(meter_name=openstack_metric_name, limit=1, q=[
 128                             {'field': 'resource_id', 'op': 'eq', 'value': resource_id}])
 129                         if len(measures):
 130                             metric = VnfMetric(nsr_id, vnf_member_index, vdur['name'], metric_name,
 131                                                measures[0].counter_volume)
 132                             metrics.append(metric)
 133                     elif self.backend == 'gnocchi':
 134                         delta = 10 * self.granularity
 135                         start_date = datetime.datetime.now() - datetime.timedelta(seconds=delta)
 136                         try:
 137                             measures = self.client.metric.get_measures(openstack_metric_name,
 138                                                                        start=start_date,
 139                                                                        resource_id=resource_id,
 140                                                                        granularity=self.granularity)
 141                             if len(measures):
 142                                 metric = VnfMetric(nsr_id, vnf_member_index, vdur['name'], metric_name, measures[-1][2])
 143                                 metrics.append(metric)
 144                         except gnocchiclient.exceptions.NotFound as e:
 145                             log.debug("No metric found: %s", e)
 146                             pass
 147                     else:
 148                         raise Exception('Unknown metric backend: %s', self.backend)
 149         return metrics
 150
 151     def _build_client(self, vim_account_id):
 152         if self.backend == 'ceilometer':
 153             return self._build_ceilometer_client(vim_account_id)
 154         elif self.backend == 'gnocchi':
 155             return self._build_gnocchi_client(vim_account_id)
 156         else:
 157             raise Exception('Unknown metric backend: %s', self.backend)
 158
 159     def _get_backend(self, vim_account_id):
 160         try:
 161             gnocchi = self._build_gnocchi_client(vim_account_id)
 162             gnocchi.resource.list(limit=1)
 163             return 'gnocchi'
 164         except EndpointNotFound:
 165             try:
 166                 ceilometer = self._build_ceilometer_client(vim_account_id)
 167                 ceilometer.resources.list(limit=1)
 168                 return 'ceilometer'
 169             except Exception:
 170                 log.exception('Error trying to determine metric backend')
 171                 raise Exception('Could not determine metric backend')