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 # Metrics which have new names in Rocky and higher releases
59 METRIC_MAPPINGS_FOR_ROCKY_AND_NEWER_RELEASES
= {
60 "disk_read_ops": "disk.device.read.requests",
61 "disk_write_ops": "disk.device.write.requests",
62 "disk_read_bytes": "disk.device.read.bytes",
63 "disk_write_bytes": "disk.device.write.bytes",
64 "packets_received": "network.incoming.packets",
65 "packets_sent": "network.outgoing.packets"
68 METRIC_MULTIPLIERS
= {"cpu": 0.0000001}
70 METRIC_AGGREGATORS
= {"cpu": "rate:mean"}
74 "packets_out_dropped",
87 class MetricType(Enum
):
89 INTERFACE_ALL
= "interface_all"
90 INTERFACE_ONE
= "interface_one"
91 INSTANCEDISK
= 'instancedisk'
94 class OpenstackCollector(BaseVimCollector
):
95 def __init__(self
, config
: Config
, vim_account_id
: str):
96 super().__init
__(config
, vim_account_id
)
97 self
.common_db
= CommonDbClient(config
)
98 vim_account
= self
.common_db
.get_vim_account(vim_account_id
)
99 self
.backend
= self
._get
_backend
(vim_account
)
101 def _build_keystone_client(self
, vim_account
: dict) -> keystone_client
.Client
:
102 sess
= OpenstackUtils
.get_session(vim_account
)
103 return keystone_client
.Client(session
=sess
)
105 def _get_resource_uuid(
106 self
, nsr_id
: str, vnf_member_index
: str, vdur_name
: str
108 vdur
= self
.common_db
.get_vdur(nsr_id
, vnf_member_index
, vdur_name
)
109 return vdur
["vim-id"]
111 def collect(self
, vnfr
: dict) -> List
[Metric
]:
112 nsr_id
= vnfr
["nsr-id-ref"]
113 vnf_member_index
= vnfr
["member-vnf-index-ref"]
114 vnfd
= self
.common_db
.get_vnfd(vnfr
["vnfd-id"])
115 # Populate extra tags for metrics
117 tags
["ns_name"] = self
.common_db
.get_nsr(nsr_id
)["name"]
118 if vnfr
["_admin"]["projects_read"]:
119 tags
["project_id"] = vnfr
["_admin"]["projects_read"][0]
121 tags
["project_id"] = ""
125 for vdur
in vnfr
["vdur"]:
126 # This avoids errors when vdur records have not been completely filled
127 if "name" not in vdur
:
129 vdu
= next(filter(lambda vdu
: vdu
["id"] == vdur
["vdu-id-ref"], vnfd
["vdu"]))
130 if "monitoring-parameter" in vdu
:
131 for param
in vdu
["monitoring-parameter"]:
132 metric_name
= param
["performance-metric"]
133 openstack_metric_name
= METRIC_MAPPINGS
[metric_name
]
134 metric_type
= self
._get
_metric
_type
(metric_name
)
136 resource_id
= self
._get
_resource
_uuid
(
137 nsr_id
, vnf_member_index
, vdur
["name"]
141 "Could not find resource_uuid for vdur %s, vnf_member_index %s, nsr_id %s. "
142 "Was it recently deleted?",
150 "Collecting metric type: %s and metric_name: %s and resource_id %s and ",
155 value
= self
.backend
.collect_metric(
156 metric_type
, openstack_metric_name
, resource_id
159 if value
is None and metric_name
in METRIC_MAPPINGS_FOR_ROCKY_AND_NEWER_RELEASES
:
160 # Reattempting metric collection with new metric names.
161 # Some metric names have changed in newer Openstack releases
163 "Reattempting metric collection for type: %s and name: %s and resource_id %s",
168 openstack_metric_name
= METRIC_MAPPINGS_FOR_ROCKY_AND_NEWER_RELEASES
[metric_name
]
169 value
= self
.backend
.collect_metric(
170 metric_type
, openstack_metric_name
, resource_id
172 if value
is not None:
173 log
.info("value: %s", value
)
182 metrics
.append(metric
)
184 log
.info("metric value is empty")
185 except Exception as e
:
187 "Error collecting metric %s for vdu %s"
188 % (metric_name
, vdur
["name"])
190 log
.info("Error in metric collection: %s" % e
)
193 def _get_backend(self
, vim_account
: dict):
195 gnocchi
= GnocchiBackend(vim_account
)
196 gnocchi
.client
.metric
.list(limit
=1)
197 log
.info("Using gnocchi backend to collect metric")
199 except (HTTPException
, EndpointNotFound
):
200 ceilometer
= CeilometerBackend(vim_account
)
201 ceilometer
.client
.capabilities
.get()
202 log
.info("Using ceilometer backend to collect metric")
205 def _get_metric_type(self
, metric_name
: str) -> MetricType
:
206 if metric_name
not in INTERFACE_METRICS
:
207 if metric_name
not in INSTANCE_DISK
:
208 return MetricType
.INSTANCE
210 return MetricType
.INSTANCEDISK
212 return MetricType
.INTERFACE_ALL
215 class OpenstackBackend
:
217 self
, metric_type
: MetricType
, metric_name
: str, resource_id
: str
222 class GnocchiBackend(OpenstackBackend
):
223 def __init__(self
, vim_account
: dict):
224 self
.client
= self
._build
_gnocchi
_client
(vim_account
)
225 self
.neutron
= self
._build
_neutron
_client
(vim_account
)
227 def _build_gnocchi_client(self
, vim_account
: dict) -> gnocchi_client
.Client
:
228 sess
= OpenstackUtils
.get_session(vim_account
)
229 return gnocchi_client
.Client(session
=sess
)
231 def _build_neutron_client(self
, vim_account
: dict) -> neutron_client
.Client
:
232 sess
= OpenstackUtils
.get_session(vim_account
)
233 return neutron_client
.Client(session
=sess
)
236 self
, metric_type
: MetricType
, metric_name
: str, resource_id
: str
238 if metric_type
== MetricType
.INTERFACE_ALL
:
239 return self
._collect
_interface
_all
_metric
(metric_name
, resource_id
)
241 elif metric_type
== MetricType
.INSTANCE
:
242 return self
._collect
_instance
_metric
(metric_name
, resource_id
)
244 elif metric_type
== MetricType
.INSTANCEDISK
:
245 return self
._collect
_instance
_disk
_metric
(metric_name
, resource_id
)
248 raise Exception("Unknown metric type %s" % metric_type
.value
)
250 def _collect_interface_all_metric(self
, openstack_metric_name
, resource_id
):
252 interfaces
= self
.client
.resource
.search(
253 resource_type
="instance_network_interface",
254 query
={"=": {"instance_id": resource_id
}},
256 for interface
in interfaces
:
258 measures
= self
.client
.metric
.get_measures(
259 openstack_metric_name
, resource_id
=interface
["id"], limit
=1
262 if not total_measure
:
264 total_measure
+= measures
[-1][2]
265 except (gnocchiclient
.exceptions
.NotFound
, TypeError) as e
:
266 # Gnocchi in some Openstack versions raise TypeError instead of NotFound
268 "No metric %s found for interface %s: %s",
269 openstack_metric_name
,
275 def _collect_instance_disk_metric(self
, openstack_metric_name
, resource_id
):
277 instances
= self
.client
.resource
.search(
278 resource_type
='instance_disk',
279 query
={'=': {'instance_id': resource_id
}},
281 for instance
in instances
:
283 measures
= self
.client
.metric
.get_measures(
284 openstack_metric_name
, resource_id
=instance
['id'], limit
=1
287 value
= measures
[-1][2]
289 except gnocchiclient
.exceptions
.NotFound
as e
:
290 log
.debug("No metric %s found for instance disk %s: %s", openstack_metric_name
,
294 def _collect_instance_metric(self
, openstack_metric_name
, resource_id
):
297 aggregation
= METRIC_AGGREGATORS
.get(openstack_metric_name
)
300 measures
= self
.client
.metric
.get_measures(
301 openstack_metric_name
,
302 aggregation
=aggregation
,
303 start
=time
.time() - 1200,
304 resource_id
=resource_id
,
307 value
= measures
[-1][2]
309 gnocchiclient
.exceptions
.NotFound
,
310 gnocchiclient
.exceptions
.BadRequest
,
313 # CPU metric in previous Openstack versions do not support rate:mean aggregation method
314 # Gnocchi in some Openstack versions raise TypeError instead of NotFound or BadRequest
315 if openstack_metric_name
== "cpu":
317 "No metric %s found for instance %s: %s",
318 openstack_metric_name
,
323 "Retrying to get metric %s for instance %s without aggregation",
324 openstack_metric_name
,
327 measures
= self
.client
.metric
.get_measures(
328 openstack_metric_name
, resource_id
=resource_id
, limit
=1
332 # measures[-1] is the last measure
333 # measures[-2] is the previous measure
334 # measures[x][2] is the value of the metric
335 if measures
and len(measures
) >= 2:
336 value
= measures
[-1][2] - measures
[-2][2]
338 # measures[-1][0] is the time of the reporting interval
339 # measures[-1][1] is the duration of the reporting interval
341 # If this is an aggregate, we need to divide the total over the reported time period.
342 # Even if the aggregation method is not supported by Openstack, the code will execute it
343 # because aggregation is specified in METRIC_AGGREGATORS
344 value
= value
/ measures
[-1][1]
345 if openstack_metric_name
in METRIC_MULTIPLIERS
:
346 value
= value
* METRIC_MULTIPLIERS
[openstack_metric_name
]
347 except gnocchiclient
.exceptions
.NotFound
as e
:
349 "No metric %s found for instance %s: %s",
350 openstack_metric_name
,
357 class CeilometerBackend(OpenstackBackend
):
358 def __init__(self
, vim_account
: dict):
359 self
.client
= self
._build
_ceilometer
_client
(vim_account
)
361 def _build_ceilometer_client(self
, vim_account
: dict) -> ceilometer_client
.Client
:
362 sess
= OpenstackUtils
.get_session(vim_account
)
363 return ceilometer_client
.Client("2", session
=sess
)
366 self
, metric_type
: MetricType
, metric_name
: str, resource_id
: str
368 if metric_type
!= MetricType
.INSTANCE
:
369 raise NotImplementedError(
370 "Ceilometer backend only support instance metrics"
372 measures
= self
.client
.samples
.list(
373 meter_name
=metric_name
,
375 q
=[{"field": "resource_id", "op": "eq", "value": resource_id
}],
377 return measures
[0].counter_volume
if measures
else None