from collections import defaultdict
from config import config_load
from config import config_loads
+import copy
import credentials
import datetime
from factory import BasicFactory
+from fluentd import FluentLogHandler
import importlib
import json
import log
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
from traffic_client import TrafficGeneratorFactory
import utils
+fluent_logger = None
+
class NFVBench(object):
"""Main class of NFV benchmarking tool."""
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()
"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(),
'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
+ sender = None
+ if self.config.fluentd.result_tag:
+ sender = FluentLogHandler(self.config.fluentd.result_tag,
+ fluentd_ip=self.config.fluentd.ip,
+ fluentd_port=self.config.fluentd.port)
+ sender.runlogdate = fluent_logger.runlogdate
+ summary = NFVBenchSummarizer(result, sender)
+ LOG.info(str(summary))
def save(self, result):
"""Save results in json format file."""
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():
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,
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='<log_file>'),
+
+ 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
}
+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))
+ if not netattrs.segmentation_id:
+ raise Exception("SRIOV requires segmentation_id to be specified for the {n} network"
+ .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
config = config_plugin.get_config()
openstack_spec = config_plugin.get_openstack_spec()
+ # setup the fluent logger as soon as possible right after the config plugin is called
+ if config.fluentd.logging_tag:
+ fluent_logger = FluentLogHandler(config.fluentd.logging_tag,
+ fluentd_ip=config.fluentd.ip,
+ fluentd_port=config.fluentd.port)
+ LOG.addHandler(fluent_logger)
+ else:
+ fluent_logger = None
+
opts, unknown_opts = parse_opts_from_cli()
- log.set_level('nfvbench', debug=opts.debug)
+ log.set_level(debug=opts.debug)
if opts.version:
print pbr.version.VersionInfo('nfvbench').version_string_with_vcs()
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
+ if config.fluentd.result_tag:
+ sender = FluentLogHandler(config.fluentd.result_tag,
+ fluentd_ip=config.fluentd.ip,
+ fluentd_port=config.fluentd.port)
+ sender.runlogdate = fluent_logger.runlogdate
+ print NFVBenchSummarizer(result, sender)
+ else:
+ print NFVBenchSummarizer(result, None)
sys.exit(0)
# show default config in text/yaml format
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):
- print opts.config
- config = config_load(opts.config, config)
+ LOG.info('Loading configuration file: ' + opts.config)
+ config = config_load(opts.config, config, whitelist_keys)
config.name = os.path.basename(opts.config)
else:
- config = config_loads(opts.config, config)
+ LOG.info('Loading configuration string: ' + opts.config)
+ config = config_loads(opts.config, config, whitelist_keys)
# traffic profile override options
override_custom_traffic(config, opts.frame_sizes, opts.unidir)
# copy over cli options that are used in config
config.generator_profile = opts.generator_profile
+ if opts.sriov:
+ config.sriov = True
+ if opts.log_file:
+ config.log_file = opts.log_file
# show running config in json format
if opts.show_config:
print json.dumps(config, sort_keys=True, indent=4)
sys.exit(0)
+ 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:
+ check_physnet("middle", config.internal_networks.middle)
+
+ # 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)
+
+ # add file log if requested
+ if config.log_file:
+ log.add_file_logger(config.log_file)
+
nfvbench = NFVBench(config, openstack_spec, config_plugin, factory)
if opts.server:
if os.path.isdir(opts.server):
- server = WebSocketIoServer(opts.server, nfvbench)
+ server = WebSocketIoServer(opts.server, nfvbench, fluent_logger)
nfvbench.set_notifier(server)
try:
port = int(opts.port)
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.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'])
- except Exception:
+ nfvbench.prepare_summary(result['result'])
+ except Exception as exc:
+ run_summary_required = True
LOG.error({
'status': NFVBench.STATUS_ERROR,
'error_message': traceback.format_exc()
})
- sys.exit(1)
+ print str(exc)
+ 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()
Code Review / nfvbench.git / blobdiff