1 # Copyright 2018 Whitestack, LLC
2 # *************************************************************
4 # This file is part of OSM Monitoring module
5 # All Rights Reserved to Whitestack, LLC
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
11 # http://www.apache.org/licenses/LICENSE-2.0
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
19 # For those usages not covered by the Apache License, Version 2.0 please
20 # contact: bdiaz@whitestack.com or glavado@whitestack.com
25 from typing
import List
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
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
43 log
= logging
.getLogger(__name__
)
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",
58 METRIC_MULTIPLIERS
= {
62 METRIC_AGGREGATORS
= {
66 INTERFACE_METRICS
= ['packets_in_dropped', 'packets_out_dropped', 'packets_received', 'packets_sent']
69 class MetricType(Enum
):
71 INTERFACE_ALL
= 'interface_all'
72 INTERFACE_ONE
= 'interface_one'
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
)
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
)
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
)
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
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]
100 tags
['project_id'] = ''
104 for vdur
in vnfr
['vdur']:
105 # This avoids errors when vdur records have not been completely filled
106 if 'name' not in vdur
:
109 filter(lambda vdu
: vdu
['id'] == vdur
['vdu-id-ref'], vnfd
['vdu'])
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
)
117 resource_id
= self
._get
_resource
_uuid
(nsr_id
, vnf_member_index
, vdur
['name'])
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
)
126 "Collecting metric type: %s and metric_name: %s and resource_id %s and ",
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
)
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
)
142 def _get_backend(self
, vim_account
: dict):
144 gnocchi
= GnocchiBackend(vim_account
)
145 gnocchi
.client
.metric
.list(limit
=1)
146 log
.info("Using gnocchi backend to collect metric")
148 except (HTTPException
, EndpointNotFound
):
149 ceilometer
= CeilometerBackend(vim_account
)
150 ceilometer
.client
.capabilities
.get()
151 log
.info("Using ceilometer backend to collect metric")
154 def _get_metric_type(self
, metric_name
: str) -> MetricType
:
155 if metric_name
not in INTERFACE_METRICS
:
156 return MetricType
.INSTANCE
158 return MetricType
.INTERFACE_ALL
161 class OpenstackBackend
:
162 def collect_metric(self
, metric_type
: MetricType
, metric_name
: str, resource_id
: str):
166 class GnocchiBackend(OpenstackBackend
):
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
)
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
)
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
)
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
)
184 elif metric_type
== MetricType
.INSTANCE
:
185 return self
._collect
_instance
_metric
(metric_name
, resource_id
)
188 raise Exception('Unknown metric type %s' % metric_type
.value
)
190 def _collect_interface_all_metric(self
, openstack_metric_name
, resource_id
):
192 interfaces
= self
.client
.resource
.search(resource_type
='instance_network_interface',
193 query
={'=': {'instance_id': resource_id
}})
194 for interface
in interfaces
:
196 measures
= self
.client
.metric
.get_measures(openstack_metric_name
,
197 resource_id
=interface
['id'],
200 if not total_measure
:
202 total_measure
+= measures
[-1][2]
204 except (gnocchiclient
.exceptions
.NotFound
, TypeError) as e
:
205 # Gnocchi in some Openstack versions raise TypeError instead of NotFound
206 log
.debug("No metric %s found for interface %s: %s", openstack_metric_name
,
210 def _collect_instance_metric(self
, openstack_metric_name
, resource_id
):
213 aggregation
= METRIC_AGGREGATORS
.get(openstack_metric_name
)
216 measures
= self
.client
.metric
.get_measures(openstack_metric_name
,
217 aggregation
=aggregation
,
218 start
=time
.time() - 1200,
219 resource_id
=resource_id
)
221 value
= measures
[-1][2]
222 except (gnocchiclient
.exceptions
.NotFound
, gnocchiclient
.exceptions
.BadRequest
, TypeError) as e
:
223 # CPU metric in previous Openstack versions do not support rate:mean aggregation method
224 # Gnocchi in some Openstack versions raise TypeError instead of NotFound or BadRequest
225 if openstack_metric_name
== "cpu":
226 log
.debug("No metric %s found for instance %s: %s", openstack_metric_name
, resource_id
, e
)
227 log
.info("Retrying to get metric %s for instance %s without aggregation",
228 openstack_metric_name
, resource_id
)
229 measures
= self
.client
.metric
.get_measures(openstack_metric_name
,
230 resource_id
=resource_id
,
234 # measures[-1] is the last measure
235 # measures[-2] is the previous measure
236 # measures[x][2] is the value of the metric
237 if measures
and len(measures
) >= 2:
238 value
= measures
[-1][2] - measures
[-2][2]
240 # measures[-1][0] is the time of the reporting interval
241 # measures[-1][1] is the duration of the reporting interval
243 # If this is an aggregate, we need to divide the total over the reported time period.
244 # Even if the aggregation method is not supported by Openstack, the code will execute it
245 # because aggregation is specified in METRIC_AGGREGATORS
246 value
= value
/ measures
[-1][1]
247 if openstack_metric_name
in METRIC_MULTIPLIERS
:
248 value
= value
* METRIC_MULTIPLIERS
[openstack_metric_name
]
249 except gnocchiclient
.exceptions
.NotFound
as e
:
250 log
.debug("No metric %s found for instance %s: %s", openstack_metric_name
, resource_id
,
255 class CeilometerBackend(OpenstackBackend
):
256 def __init__(self
, vim_account
: dict):
257 self
.client
= self
._build
_ceilometer
_client
(vim_account
)
259 def _build_ceilometer_client(self
, vim_account
: dict) -> ceilometer_client
.Client
:
260 sess
= OpenstackUtils
.get_session(vim_account
)
261 return ceilometer_client
.Client("2", session
=sess
)
263 def collect_metric(self
, metric_type
: MetricType
, metric_name
: str, resource_id
: str):
264 if metric_type
!= MetricType
.INSTANCE
:
265 raise NotImplementedError('Ceilometer backend only support instance metrics')
266 measures
= self
.client
.samples
.list(meter_name
=metric_name
, limit
=1, q
=[
267 {'field': 'resource_id', 'op': 'eq', 'value': resource_id
}])
268 return measures
[0].counter_volume
if measures
else None