NFVBENCH-37 Read fluentd result tag from configuration file

[nfvbench.git] / nfvbench / nfvbench.py

diff --git a/nfvbench/nfvbench.py b/nfvbench/nfvbench.py
index e9594d5..52fb57b 100644 (file)
--- a/nfvbench/nfvbench.py
+++ b/nfvbench/nfvbench.py
@@ -44,6 +44,7 @@ import utils
 
 fluent_logger = None
 
+
 class NFVBench(object):
     """Main class of NFV benchmarking tool."""
     STATUS_OK = 'OK'
@@ -75,7 +76,7 @@ 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 = ''
@@ -83,6 +84,7 @@ class NFVBench(object):
             # 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()
@@ -125,9 +127,16 @@ class NFVBench(object):
                     'error_message': message
                 }
 
-    def print_summary(self, result):
-        """Print summary of the result"""
-        summary = NFVBenchSummarizer(result)
+    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):
@@ -289,9 +298,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,
@@ -374,7 +380,11 @@ def parse_opts_from_cli():
     parser.add_argument('--log-file', '--logfile', dest='log_file',
                         action='store',
                         help='Filename for saving logs',
-                        metavar='<log_file>')
+                        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
@@ -407,6 +417,7 @@ 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"
@@ -415,8 +426,10 @@ def check_physnet(name, netattrs):
         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()
         # load default config file
@@ -451,7 +464,17 @@ 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
+                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
@@ -461,15 +484,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)
+                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)
+                config = config_loads(opts.config, config, whitelist_keys)
 
         # traffic profile override options
         override_custom_traffic(config, opts.frame_sizes, opts.unidir)
@@ -506,7 +531,7 @@ def main():
 
         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)
@@ -519,6 +544,7 @@ def main():
                 sys.exit(1)
         else:
             with utils.RunLock():
+                run_summary_required = True
                 if unknown_opts:
                     err_msg = 'Unknown options: ' + ' '.join(unknown_opts)
                     LOG.error(err_msg)
@@ -526,20 +552,28 @@ def main():
 
                 # 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'])
+                    nfvbench.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()