1 # Copyright (c) 2016-2017 Intel Corporation
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14 """ Resource collection definitions """
16 from __future__ import absolute_import
17 from __future__ import print_function
23 import multiprocessing
24 from collections import Sequence
26 from oslo_config import cfg
28 from yardstick import ssh
29 from yardstick.network_services.nfvi.collectd import AmqpConsumer
30 from yardstick.network_services.utils import get_nsb_option
32 LOG = logging.getLogger(__name__)
36 ZMQ_POLLING_TIME = 12000
37 LIST_PLUGINS_ENABLED = ["amqp", "cpu", "cpufreq", "intel_rdt", "memory",
38 "hugepages", "dpdkstat", "virt", "ovs_stats", "intel_pmu"]
41 class ResourceProfile(object):
43 This profile adds a resource at the beginning of the test session
46 def __init__(self, mgmt, interfaces=None, cores=None):
48 self.connection = None
49 self.cores = cores if isinstance(cores, Sequence) else []
50 self._queue = multiprocessing.Queue()
51 self.amqp_client = None
52 self.interfaces = interfaces if isinstance(interfaces, Sequence) else []
55 self.vnfip = mgmt.get("host", mgmt["ip"])
56 self.connection = ssh.SSH.from_node(mgmt, overrides={"ip": self.vnfip})
58 self.connection.wait()
60 def check_if_sa_running(self, process):
61 """ verify if system agent is running """
62 err, pid, _ = self.connection.execute("pgrep -f %s" % process)
63 return [err == 0, pid]
65 def run_collectd_amqp(self):
66 """ run amqp consumer to collect the NFVi data """
67 amqp_url = 'amqp://admin:admin@{}:5672/%2F'.format(self.vnfip)
68 amqp = AmqpConsumer(amqp_url, self._queue)
71 except (AttributeError, RuntimeError, KeyboardInterrupt):
75 def parse_simple_resource(cls, key, value):
76 reskey = "/".join(rkey for rkey in key if "nsb_stats" not in rkey)
77 return {reskey: value.split(":")[1]}
80 def get_cpu_data(cls, res_key0, res_key1, value):
81 """ Get cpu topology of the host """
84 if 'cpufreq' in res_key0:
85 metric, source = res_key0, res_key1
87 metric, source = res_key1, res_key0
89 match = re.search(pattern, source, re.MULTILINE)
91 return "error", "Invalid", "", ""
93 time, value = value.split(":")
94 return str(match.group(1)), metric, value, time
97 def parse_hugepages(cls, key, value):
98 return cls.parse_simple_resource(key, value)
101 def parse_dpdkstat(cls, key, value):
102 return cls.parse_simple_resource(key, value)
105 def parse_virt(cls, key, value):
106 return cls.parse_simple_resource(key, value)
109 def parse_ovs_stats(cls, key, value):
110 return cls.parse_simple_resource(key, value)
113 def parse_intel_pmu_stats(cls, key, value):
114 return {''.join(key): value.split(":")[1]}
116 def parse_collectd_result(self, metrics, core_list):
117 """ convert collectd data into json"""
129 for key, value in metrics.items():
130 key_split = key.split("/")
131 res_key_iter = (key for key in key_split if "nsb_stats" not in key)
132 res_key0 = next(res_key_iter)
133 res_key1 = next(res_key_iter)
135 if "cpu" in res_key0 or "intel_rdt" in res_key0:
136 cpu_key, name, metric, testcase = \
137 self.get_cpu_data(res_key0, res_key1, value)
138 if cpu_key in core_list:
139 result["cpu"].setdefault(cpu_key, {}).update({name: metric})
141 elif "memory" in res_key0:
142 result["memory"].update({res_key1: value.split(":")[0]})
144 elif "hugepages" in res_key0:
145 result["hugepages"].update(self.parse_hugepages(key_split, value))
147 elif "dpdkstat" in res_key0:
148 result["dpdkstat"].update(self.parse_dpdkstat(key_split, value))
150 elif "virt" in res_key1:
151 result["virt"].update(self.parse_virt(key_split, value))
153 elif "ovs_stats" in res_key0:
154 result["ovs_stats"].update(self.parse_ovs_stats(key_split, value))
156 elif "intel_pmu-all" in res_key0:
157 result["intel_pmu"].update(self.parse_intel_pmu_stats(res_key1, value))
159 result["timestamp"] = testcase
163 def amqp_process_for_nfvi_kpi(self):
164 """ amqp collect and return nfvi kpis """
165 if self.amqp_client is None and self.enable:
167 multiprocessing.Process(target=self.run_collectd_amqp)
168 self.amqp_client.start()
170 def amqp_collect_nfvi_kpi(self):
171 """ amqp collect and return nfvi kpis """
176 while not self._queue.empty():
177 metric.update(self._queue.get())
178 msg = self.parse_collectd_result(metric, self.cores)
181 def _provide_config_file(self, bin_path, nfvi_cfg, kwargs):
182 with open(os.path.join(bin_path, nfvi_cfg), 'r') as cfg:
183 template = cfg.read()
184 cfg, cfg_content = tempfile.mkstemp()
185 with os.fdopen(cfg, "w+") as cfg:
186 cfg.write(template.format(**kwargs))
187 cfg_file = os.path.join(bin_path, nfvi_cfg)
188 self.connection.put(cfg_content, cfg_file)
190 def _prepare_collectd_conf(self, bin_path):
191 """ Prepare collectd conf """
192 loadplugin = "\n".join("LoadPlugin {0}".format(plugin)
193 for plugin in LIST_PLUGINS_ENABLED)
195 interfaces = "\n".join("PortName '{0[name]}'".format(interface)
196 for interface in self.interfaces)
200 "loadplugin": loadplugin,
201 "dpdk_interface": interfaces,
203 self._provide_config_file(bin_path, 'collectd.conf', kwargs)
205 def _start_collectd(self, connection, bin_path):
206 connection.execute('sudo pkill -9 collectd')
207 bin_path = get_nsb_option("bin_path")
208 collectd_path = os.path.join(bin_path, "collectd", "collectd")
209 exit_status = connection.execute("which %s > /dev/null 2>&1" % collectd_path)[0]
211 LOG.warning("%s is not present disabling", collectd_path)
212 # disable auto-provisioning because it requires Internet access
213 # collectd_installer = os.path.join(bin_path, "collectd.sh")
214 # provision_tool(connection, collectd)
215 # http_proxy = os.environ.get('http_proxy', '')
216 # https_proxy = os.environ.get('https_proxy', '')
217 # connection.execute("sudo %s '%s' '%s'" % (
218 # collectd_installer, http_proxy, https_proxy))
220 LOG.debug("Starting collectd to collect NFVi stats")
221 self._prepare_collectd_conf(bin_path)
224 LOG.debug("reset and setup amqp to collect data from collectd")
225 connection.execute("sudo rm -rf /var/lib/rabbitmq/mnesia/rabbit*")
226 connection.execute("sudo service rabbitmq-server start")
227 connection.execute("sudo rabbitmqctl stop_app")
228 connection.execute("sudo rabbitmqctl reset")
229 connection.execute("sudo rabbitmqctl start_app")
230 connection.execute("sudo service rabbitmq-server restart")
232 LOG.debug("Creating amdin user for rabbitmq in order to collect data from collectd")
233 connection.execute("sudo rabbitmqctl delete_user guest")
234 connection.execute("sudo rabbitmqctl add_user admin admin")
235 connection.execute("sudo rabbitmqctl authenticate_user admin admin")
236 connection.execute("sudo rabbitmqctl set_permissions -p / admin \".*\" \".*\" \".*\"")
238 LOG.debug("Start collectd service.....")
239 connection.execute("sudo %s" % collectd_path)
242 def initiate_systemagent(self, bin_path):
243 """ Start system agent for NFVi collection on host """
245 self._start_collectd(self.connection, bin_path)
248 """ start nfvi collection """
250 LOG.debug("Start NVFi metric collection...")
253 """ stop nfvi collection """
258 LOG.debug("Stop resource monitor...")
260 if self.amqp_client is not None:
261 self.amqp_client.terminate()
263 status, pid = self.check_if_sa_running(agent)
267 self.connection.execute('sudo kill -9 %s' % pid)
268 self.connection.execute('sudo pkill -9 %s' % agent)
269 self.connection.execute('sudo service rabbitmq-server stop')
270 self.connection.execute("sudo rabbitmqctl stop_app")