X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=nfvbench%2Fnfvbench.py;h=6f59e24c59979b945fe1f4bcfcd7c209545a8acb;hb=efc678c9d3843dcfd373b5749a88c51228b0b27c;hp=bf39a44cf36964d71e254ebbf1aae332a7e6937c;hpb=2d66234fe3b8b3e104e63218b5120a35ca400ea5;p=nfvbench.git diff --git a/nfvbench/nfvbench.py b/nfvbench/nfvbench.py index bf39a44..6f59e24 100644 --- a/nfvbench/nfvbench.py +++ b/nfvbench/nfvbench.py @@ -14,32 +14,38 @@ # under the License. # -from __init__ import __version__ import argparse +from collections import defaultdict +import copy +import datetime +import importlib +import json +import os +import sys +import traceback + from attrdict import AttrDict +import pbr.version +from pkg_resources import resource_string + +from __init__ import __version__ from chain_runner import ChainRunner -from collections import defaultdict from config import config_load from config import config_loads -import credentials -import datetime +import credentials as credentials from factory import BasicFactory -import importlib -import json +from fluentd import FluentLogHandler import log from log import LOG from nfvbenchd import WebSocketIoServer -import os -import pbr.version -from pkg_resources import resource_string from specs import ChainType from specs import Specs from summarizer import NFVBenchSummarizer -import sys -import traceback from traffic_client import TrafficGeneratorFactory import utils +fluent_logger = None + class NFVBench(object): """Main class of NFV benchmarking tool.""" @@ -72,10 +78,15 @@ class NFVBench(object): def set_notifier(self, notifier): self.notifier = notifier - def run(self, opts): + def run(self, opts, args): status = NFVBench.STATUS_OK result = None message = '' + if fluent_logger: + # take a snapshot of the current time for this new run + # so that all subsequent logs can relate to this run + fluent_logger.start_new_run() + LOG.info(args) try: self.update_config(opts) self.setup() @@ -87,7 +98,7 @@ class NFVBench(object): "vswitch": self.specs.openstack.vswitch, "encaps": self.specs.openstack.encaps }, - "config": self.config_plugin.prepare_results_config(dict(self.config)), + "config": self.config_plugin.prepare_results_config(copy.deepcopy(self.config)), "benchmarks": { "network": { "service_chain": self.chain_runner.run(), @@ -106,22 +117,22 @@ class NFVBench(object): if self.chain_runner: self.chain_runner.close() - if status == NFVBench.STATUS_OK: - result = utils.dict_to_json_dict(result) - return { - 'status': status, - 'result': result - } - else: - return { - 'status': status, - 'error_message': message - } + if status == NFVBench.STATUS_OK: + result = utils.dict_to_json_dict(result) + return { + 'status': status, + 'result': result + } + return { + 'status': status, + 'error_message': message + } - def print_summary(self, result): - """Print summary of the result""" - print NFVBenchSummarizer(result) - sys.stdout.flush() + def prepare_summary(self, result): + """Prepares summary of the result to print and send it to logger (eg: fluentd)""" + global fluent_logger + summary = NFVBenchSummarizer(result, fluent_logger) + LOG.info(str(summary)) def save(self, result): """Save results in json format file.""" @@ -142,9 +153,9 @@ class NFVBench(object): self.config.flow_count = utils.parse_flow_count(self.config.flow_count) required_flow_count = self.config.service_chain_count * 2 if self.config.flow_count < required_flow_count: - LOG.info("Flow count '{}' has been set to minimum value of '{}' " - "for current configuration".format(self.config.flow_count, - required_flow_count)) + LOG.info("Flow count %d has been set to minimum value of '%d' " + "for current configuration", self.config.flow_count, + required_flow_count) self.config.flow_count = required_flow_count if self.config.flow_count % 2 != 0: @@ -166,7 +177,7 @@ class NFVBench(object): "({tg_profile}) are missing. Please specify them in configuration file." .format(tg_profile=self.config.generator_profile)) - if self.config.traffic is None or len(self.config.traffic) == 0: + if self.config.traffic is None or not self.config.traffic: raise Exception("No traffic profile found in traffic configuration, " "please fill 'traffic' section in configuration file.") @@ -193,7 +204,7 @@ class NFVBench(object): self.config.json_file = self.config.json if self.config.json else None if self.config.json_file: - (path, filename) = os.path.split(self.config.json) + (path, _filename) = os.path.split(self.config.json) if not os.path.exists(path): raise Exception('Please provide existing path for storing results in JSON file. ' 'Path used: {path}'.format(path=path)) @@ -204,7 +215,7 @@ class NFVBench(object): raise Exception('Please provide existing path for storing results in JSON file. ' 'Path used: {path}'.format(path=self.config.std_json_path)) - self.config_plugin.validate_config(self.config) + self.config_plugin.validate_config(self.config, self.specs.openstack) def parse_opts_from_cli(): @@ -273,6 +284,12 @@ def parse_opts_from_cli(): action='store_true', help='Use SRIOV (no vswitch - requires SRIOV support in compute nodes)') + parser.add_argument('--use-sriov-middle-net', dest='use_sriov_middle_net', + default=None, + action='store_true', + help='Use SRIOV to handle the middle network traffic ' + '(PVVP with SRIOV only)') + parser.add_argument('-d', '--debug', dest='debug', action='store_true', default=None, @@ -282,10 +299,6 @@ def parse_opts_from_cli(): action='store', help='Traffic generator profile to use') - parser.add_argument('-i', '--image', dest='image_name', - action='store', - help='VM image name to use') - parser.add_argument('-0', '--no-traffic', dest='no_traffic', default=None, action='store_true', @@ -364,6 +377,15 @@ def parse_opts_from_cli(): default=None, help='Override traffic profile direction (requires -fs)') + parser.add_argument('--log-file', '--logfile', dest='log_file', + action='store', + help='Filename for saving logs', + metavar='') + + parser.add_argument('--user-label', '--userlabel', dest='user_label', + action='store', + help='Custom label for performance records') + opts, unknown_opts = parser.parse_known_args() return opts, unknown_opts @@ -395,17 +417,21 @@ def override_custom_traffic(config, frame_sizes, unidir): "profile": traffic_profile_name } + def check_physnet(name, netattrs): if not netattrs.physical_network: raise Exception("SRIOV requires physical_network to be specified for the {n} network" - .format(n=name)) + .format(n=name)) if not netattrs.segmentation_id: raise Exception("SRIOV requires segmentation_id to be specified for the {n} network" - .format(n=name)) + .format(n=name)) + def main(): + global fluent_logger + run_summary_required = False try: - log.setup('nfvbench') + log.setup() # load default config file config, default_cfg = load_default_config() # create factory for platform specific classes @@ -421,7 +447,15 @@ def main(): openstack_spec = config_plugin.get_openstack_spec() opts, unknown_opts = parse_opts_from_cli() - log.set_level('nfvbench', debug=opts.debug) + log.set_level(debug=opts.debug) + + # setup the fluent logger as soon as possible right after the config plugin is called, + # if there is any logging or result tag is set then initialize the fluent logger + for fluentd in config.fluentd: + if fluentd.logging_tag or fluentd.result_tag: + fluent_logger = FluentLogHandler(config.fluentd) + LOG.addHandler(fluent_logger) + break if opts.version: print pbr.version.VersionInfo('nfvbench').version_string_with_vcs() @@ -429,7 +463,10 @@ def main(): if opts.summary: with open(opts.summary) as json_data: - print NFVBenchSummarizer(json.load(json_data)) + result = json.load(json_data) + if opts.user_label: + result['config']['user_label'] = opts.user_label + print NFVBenchSummarizer(result, fluent_logger) sys.exit(0) # show default config in text/yaml format @@ -439,15 +476,17 @@ def main(): config.name = '' if opts.config: + # do not check extra_specs in flavor as it can contain any key/value pairs + whitelist_keys = ['extra_specs'] # override default config options with start config at path parsed from CLI # check if it is an inline yaml/json config or a file name if os.path.isfile(opts.config): - LOG.info('Loading configuration file: ' + opts.config) - config = config_load(opts.config, config) + LOG.info('Loading configuration file: %s', opts.config) + config = config_load(opts.config, config, whitelist_keys) config.name = os.path.basename(opts.config) else: - LOG.info('Loading configuration string: ' + opts.config) - config = config_loads(opts.config, config) + LOG.info('Loading configuration string: %s', opts.config) + config = config_loads(opts.config, config, whitelist_keys) # traffic profile override options override_custom_traffic(config, opts.frame_sizes, opts.unidir) @@ -456,30 +495,45 @@ def main(): config.generator_profile = opts.generator_profile if opts.sriov: config.sriov = True - - # show running config in json format - if opts.show_config: - print json.dumps(config, sort_keys=True, indent=4) - sys.exit(0) + if opts.log_file: + config.log_file = opts.log_file + if opts.service_chain: + config.service_chain = opts.service_chain + if opts.service_chain_count: + config.service_chain_count = opts.service_chain_count + + if opts.use_sriov_middle_net: + if (not config.sriov) or (not config.service_chain == ChainType.PVVP): + raise Exception("--use-sriov-middle-net is only valid for PVVP with SRIOV") + config.use_sriov_middle_net = True if config.sriov and config.service_chain != ChainType.EXT: # if sriov is requested (does not apply to ext chains) # make sure the physnet names are specified check_physnet("left", config.internal_networks.left) check_physnet("right", config.internal_networks.right) - if config.service_chain == ChainType.PVVP: + if config.service_chain == ChainType.PVVP and config.use_sriov_middle_net: check_physnet("middle", config.internal_networks.middle) + # show running config in json format + if opts.show_config: + print json.dumps(config, sort_keys=True, indent=4) + sys.exit(0) + # update the config in the config plugin as it might have changed # in a copy of the dict (config plugin still holds the original dict) config_plugin.set_config(config) - nfvbench = NFVBench(config, openstack_spec, config_plugin, factory) + # add file log if requested + if config.log_file: + log.add_file_logger(config.log_file) + + nfvbench_instance = NFVBench(config, openstack_spec, config_plugin, factory) if opts.server: if os.path.isdir(opts.server): - server = WebSocketIoServer(opts.server, nfvbench) - nfvbench.set_notifier(server) + server = WebSocketIoServer(opts.server, nfvbench_instance, fluent_logger) + nfvbench_instance.set_notifier(server) try: port = int(opts.port) except ValueError: @@ -491,25 +545,36 @@ def main(): sys.exit(1) else: with utils.RunLock(): + run_summary_required = True if unknown_opts: - LOG.warning('Unknown options: ' + ' '.join(unknown_opts)) + err_msg = 'Unknown options: ' + ' '.join(unknown_opts) + LOG.error(err_msg) + raise Exception(err_msg) # remove unfilled values opts = {k: v for k, v in vars(opts).iteritems() if v is not None} - result = nfvbench.run(opts) + # get CLI args + params = ' '.join(str(e) for e in sys.argv[1:]) + result = nfvbench_instance.run(opts, params) if 'error_message' in result: raise Exception(result['error_message']) if 'result' in result and result['status']: - nfvbench.save(result['result']) - nfvbench.print_summary(result['result']) + nfvbench_instance.save(result['result']) + nfvbench_instance.prepare_summary(result['result']) except Exception as exc: + run_summary_required = True LOG.error({ 'status': NFVBench.STATUS_ERROR, 'error_message': traceback.format_exc() }) print str(exc) - sys.exit(1) + finally: + if fluent_logger: + # only send a summary record if there was an actual nfvbench run or + # if an error/exception was logged. + fluent_logger.send_run_summary(run_summary_required) + if __name__ == '__main__': main()