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 from enum import Enum
  23 import logging
  24 import time
  25 from typing import List
  26
  27 from ceilometerclient import client as ceilometer_client
  28 from ceilometerclient.exc import HTTPException
  29 import gnocchiclient.exceptions
  30 from gnocchiclient.v1 import client as gnocchi_client
  31 from keystoneauth1.exceptions.catalog import EndpointNotFound
  32 from keystoneclient.v3 import client as keystone_client
  33 from neutronclient.v2_0 import client as neutron_client
  34
  35 from osm_mon.collector.metric import Metric
  36 from osm_mon.collector.utils.openstack import OpenstackUtils
  37 from osm_mon.collector.vnf_collectors.base_vim import BaseVimCollector
  38 from osm_mon.collector.vnf_metric import VnfMetric
  39 from osm_mon.core.common_db import CommonDbClient
  40 from osm_mon.core.config import Config
  41
  42
  43 log = logging.getLogger(__name__)
  44
  45 METRIC_MAPPINGS = {
  46     "average_memory_utilization": "memory.usage",
  47     "disk_read_ops": "disk.read.requests.rate",
  48     "disk_write_ops": "disk.write.requests.rate",
  49     "disk_read_bytes": "disk.read.bytes.rate",
  50     "disk_write_bytes": "disk.write.bytes.rate",
  51     "packets_in_dropped": "network.outgoing.packets.drop",
  52     "packets_out_dropped": "network.incoming.packets.drop",
  53     "packets_received": "network.incoming.packets.rate",
  54     "packets_sent": "network.outgoing.packets.rate",
  55     "cpu_utilization": "cpu",
  56 }
  57
  58 METRIC_MULTIPLIERS = {
  59     "cpu": 0.0000001
  60 }
  61
  62 METRIC_AGGREGATORS = {
  63     "cpu": "rate:mean"
  64 }
  65
  66 INTERFACE_METRICS = ['packets_in_dropped', 'packets_out_dropped', 'packets_received', 'packets_sent']
  67
  68
  69 class MetricType(Enum):
  70     INSTANCE = 'instance'
  71     INTERFACE_ALL = 'interface_all'
  72     INTERFACE_ONE = 'interface_one'
  73
  74
  75 class OpenstackCollector(BaseVimCollector):
  76     def __init__(self, config: Config, vim_account_id: str):
  77         super().__init__(config, vim_account_id)
  78         self.common_db = CommonDbClient(config)
  79         vim_account = self.common_db.get_vim_account(vim_account_id)
  80         self.backend = self._get_backend(vim_account)
  81
  82     def _build_keystone_client(self, vim_account: dict) -> keystone_client.Client:
  83         sess = OpenstackUtils.get_session(vim_account)
  84         return keystone_client.Client(session=sess)
  85
  86     def _get_resource_uuid(self, nsr_id: str, vnf_member_index: str, vdur_name: str) -> str:
  87         vdur = self.common_db.get_vdur(nsr_id, vnf_member_index, vdur_name)
  88         return vdur['vim-id']
  89
  90     def collect(self, vnfr: dict) -> List[Metric]:
  91         nsr_id = vnfr['nsr-id-ref']
  92         vnf_member_index = vnfr['member-vnf-index-ref']
  93         vnfd = self.common_db.get_vnfd(vnfr['vnfd-id'])
  94         # Populate extra tags for metrics
  95         tags = {}
  96         tags['ns_name'] = self.common_db.get_nsr(nsr_id)['name']
  97         if vnfr['_admin']['projects_read']:
  98             tags['project_id'] = vnfr['_admin']['projects_read'][0]
  99         else:
 100             tags['project_id'] = ''
 101
 102         metrics = []
 103
 104         for vdur in vnfr['vdur']:
 105             # This avoids errors when vdur records have not been completely filled
 106             if 'name' not in vdur:
 107                 continue
 108             vdu = next(
 109                 filter(lambda vdu: vdu['id'] == vdur['vdu-id-ref'], vnfd['vdu'])
 110             )
 111             if 'monitoring-parameter' in vdu:
 112                 for param in vdu['monitoring-parameter']:
 113                     metric_name = param['performance-metric']
 114                     openstack_metric_name = METRIC_MAPPINGS[metric_name]
 115                     metric_type = self._get_metric_type(metric_name)
 116                     try:
 117                         resource_id = self._get_resource_uuid(nsr_id, vnf_member_index, vdur['name'])
 118                     except ValueError:
 119                         log.warning(
 120                             "Could not find resource_uuid for vdur %s, vnf_member_index %s, nsr_id %s. "
 121                             "Was it recently deleted?",
 122                             vdur['name'], vnf_member_index, nsr_id)
 123                         continue
 124                     try:
 125                         log.info(
 126                             "Collecting metric type: %s and metric_name: %s and resource_id %s and ",
 127                             metric_type,
 128                             metric_name,
 129                             resource_id)
 130                         value = self.backend.collect_metric(metric_type, openstack_metric_name, resource_id)
 131                         if value is not None:
 132                             log.info("value: %s", value)
 133                             metric = VnfMetric(nsr_id, vnf_member_index, vdur['name'], metric_name, value, tags)
 134                             metrics.append(metric)
 135                         else:
 136                             log.info("metric value is empty")
 137                     except Exception as e:
 138                         log.exception("Error collecting metric %s for vdu %s" % (metric_name, vdur['name']))
 139                         log.info("Error in metric collection: %s" % e)
 140         return metrics
 141
 142     def _get_backend(self, vim_account: dict):
 143         try:
 144             gnocchi = GnocchiBackend(vim_account)
 145             gnocchi.client.metric.list(limit=1)
 146             log.info("Using gnocchi backend to collect metric")
 147             return gnocchi
 148         except (HTTPException, EndpointNotFound):
 149             ceilometer = CeilometerBackend(vim_account)
 150             ceilometer.client.capabilities.get()
 151             log.info("Using ceilometer backend to collect metric")
 152             return ceilometer
 153
 154     def _get_metric_type(self, metric_name: str) -> MetricType:
 155         if metric_name not in INTERFACE_METRICS:
 156             return MetricType.INSTANCE
 157         else:
 158             return MetricType.INTERFACE_ALL
 159
 160
 161 class OpenstackBackend:
 162     def collect_metric(self, metric_type: MetricType, metric_name: str, resource_id: str):
 163         pass
 164
 165
 166 class GnocchiBackend(OpenstackBackend):
 167
 168     def __init__(self, vim_account: dict):
 169         self.client = self._build_gnocchi_client(vim_account)
 170         self.neutron = self._build_neutron_client(vim_account)
 171
 172     def _build_gnocchi_client(self, vim_account: dict) -> gnocchi_client.Client:
 173         sess = OpenstackUtils.get_session(vim_account)
 174         return gnocchi_client.Client(session=sess)
 175
 176     def _build_neutron_client(self, vim_account: dict) -> neutron_client.Client:
 177         sess = OpenstackUtils.get_session(vim_account)
 178         return neutron_client.Client(session=sess)
 179
 180     def collect_metric(self, metric_type: MetricType, metric_name: str, resource_id: str):
 181         if metric_type == MetricType.INTERFACE_ALL:
 182             return self._collect_interface_all_metric(metric_name, resource_id)
 183
 184         elif metric_type == MetricType.INSTANCE:
 185             return self._collect_instance_metric(metric_name, resource_id)
 186
 187         else:
 188             raise Exception('Unknown metric type %s' % metric_type.value)
 189
 190     def _collect_interface_all_metric(self, openstack_metric_name, resource_id):
 191         total_measure = None
 192         interfaces = self.client.resource.search(resource_type='instance_network_interface',
 193                                                  query={'=': {'instance_id': resource_id}})
 194         for interface in interfaces:
 195             try:
 196                 measures = self.client.metric.get_measures(openstack_metric_name,
 197                                                            resource_id=interface['id'],
 198                                                            limit=1)
 199                 if measures:
 200                     if not total_measure:
 201                         total_measure = 0.0
 202                     total_measure += measures[-1][2]
 203
 204             except gnocchiclient.exceptions.NotFound as e:
 205                 log.debug("No metric %s found for interface %s: %s", openstack_metric_name,
 206                           interface['id'], e)
 207         return total_measure
 208
 209     def _collect_instance_metric(self, openstack_metric_name, resource_id):
 210         value = None
 211         try:
 212             aggregation = METRIC_AGGREGATORS.get(openstack_metric_name)
 213
 214             try:
 215                 measures = self.client.metric.get_measures(openstack_metric_name,
 216                                                            aggregation=aggregation,
 217                                                            start=time.time() - 1200,
 218                                                            resource_id=resource_id)
 219                 if measures:
 220                     value = measures[-1][2]
 221             except gnocchiclient.exceptions.NotFound as e:
 222                 # CPU metric in previous Openstack versions do not support rate:mean aggregation method
 223                 if openstack_metric_name == "cpu":
 224                     log.debug("No metric %s found for instance %s: %s", openstack_metric_name, resource_id, e)
 225                     log.debug("Retrying to get metric %s for instance %s without aggregation",
 226                               openstack_metric_name, resource_id)
 227                     measures = self.client.metric.get_measures(openstack_metric_name,
 228                                                                resource_id=resource_id,
 229                                                                limit=1)
 230                 else:
 231                     raise e
 232                 # measures[-1] is the last measure
 233                 # measures[-2] is the previous measure
 234                 # measures[x][2] is the value of the metric
 235                 if measures and len(measures) >= 2:
 236                     value = measures[-1][2] - measures[-2][2]
 237             if value:
 238                 # measures[-1][0] is the time of the reporting interval
 239                 # measures[-1][1] is the duration of the reporting interval
 240                 if aggregation:
 241                     # If this is an aggregate, we need to divide the total over the reported time period.
 242                     # Even if the aggregation method is not supported by Openstack, the code will execute it
 243                     # because aggregation is specified in METRIC_AGGREGATORS
 244                     value = value / measures[-1][1]
 245                 if openstack_metric_name in METRIC_MULTIPLIERS:
 246                     value = value * METRIC_MULTIPLIERS[openstack_metric_name]
 247         except gnocchiclient.exceptions.NotFound as e:
 248             log.debug("No metric %s found for instance %s: %s", openstack_metric_name, resource_id,
 249                       e)
 250         return value
 251
 252
 253 class CeilometerBackend(OpenstackBackend):
 254     def __init__(self, vim_account: dict):
 255         self.client = self._build_ceilometer_client(vim_account)
 256
 257     def _build_ceilometer_client(self, vim_account: dict) -> ceilometer_client.Client:
 258         sess = OpenstackUtils.get_session(vim_account)
 259         return ceilometer_client.Client("2", session=sess)
 260
 261     def collect_metric(self, metric_type: MetricType, metric_name: str, resource_id: str):
 262         if metric_type != MetricType.INSTANCE:
 263             raise NotImplementedError('Ceilometer backend only support instance metrics')
 264         measures = self.client.samples.list(meter_name=metric_name, limit=1, q=[
 265             {'field': 'resource_id', 'op': 'eq', 'value': resource_id}])
 266         return measures[0].counter_volume if measures else None