Add shell --profile option to trigger osprofiler from CLI

DinaBelova · DinaBelova · commit 16f00833a708 · 2016-02-25T20:13:27.000Z
This will allow to trigger profiling of various services that allow it currently and which APIs support is added to openstackclient. Cinder and Glance have osprofiler support already, Nova and Keystone are in progress. To use this functionality osprofiler (and its storage backend) needs to be installed in the environment. If so, you will be able to trigger profiling via the following command, for example: $ openstack --profile SECRET_KEY user list At the end of output there will be message with <trace_id>, and to plot nice HTML graphs the following command should be used: $ osprofiler trace show <trace_id> --html --out result.html Related Keystone change: https://review.openstack.org/#/c/103368/ Related Nova change: https://review.openstack.org/#/c/254703/ The similar change to the keystoneclient (https://review.openstack.org/#/c/255308/) was abandoned as new CLI extenstions are not more accepted to python-keystoneclient. Change-Id: I3d6ac613e5da70619d0a4781e5d066fde073b407
diff --git a/doc/source/man/openstack.rst b/doc/source/man/openstack.rst
@@ -123,6 +123,12 @@ OPTIONS
 :option:`--os-interface` <interface>
     Interface type. Valid options are `public`, `admin` and `internal`.
 
+:option: `--profile` <hmac-key>
+    HMAC key to use for encrypting context data for performance profiling of
+    requested operation. This key should be the value of one of the HMAC keys
+    defined in the configuration files of OpenStack services, user would like
+    to trace through.
+
 :option:`--log-file` <LOGFILE>
     Specify a file to log output. Disabled by default.
 
diff --git a/openstackclient/shell.py b/openstackclient/shell.py
@@ -25,6 +25,7 @@
 from cliff import command
 from cliff import complete
 from cliff import help
+from oslo_utils import importutils
 from oslo_utils import strutils
 
 import openstackclient
@@ -37,6 +38,8 @@
 
 from os_client_config import config as cloud_config
 
+osprofiler_profiler = importutils.try_import("osprofiler.profiler")
+
 
 DEFAULT_DOMAIN = 'default'
 
@@ -101,6 +104,8 @@ def __init__(self):
         self.client_manager = None
         self.command_options = None
 
+        self.do_profile = False
+
     def configure_logging(self):
         """Configure logging for the app."""
         self.log_configurator = logs.LogConfigurator(self.options)
@@ -125,6 +130,39 @@ def run(self, argv):
         finally:
             self.log.info("END return value: %s", ret_val)
 
+    def init_profile(self):
+        self.do_profile = osprofiler_profiler and self.options.profile
+        if self.do_profile:
+            osprofiler_profiler.init(self.options.profile)
+
+    def close_profile(self):
+        if self.do_profile:
+            trace_id = osprofiler_profiler.get().get_base_id()
+
+            # NOTE(dbelova): let's use warning log level to see these messages
+            # printed. In fact we can define custom log level here with value
+            # bigger than most big default one (CRITICAL) or something like
+            # that (PROFILE = 60 for instance), but not sure we need it here.
+            self.log.warning("Trace ID: %s" % trace_id)
+            self.log.warning("To display trace use next command:\n"
+                             "osprofiler trace show --html %s " % trace_id)
+
+    def run_subcommand(self, argv):
+        self.init_profile()
+        try:
+            ret_value = super(OpenStackShell, self).run_subcommand(argv)
+        finally:
+            self.close_profile()
+        return ret_value
+
+    def interact(self):
+        self.init_profile()
+        try:
+            ret_value = super(OpenStackShell, self).run_subcommand()
+        finally:
+            self.close_profile()
+        return ret_value
+
     def build_option_parser(self, description, version):
         parser = super(OpenStackShell, self).build_option_parser(
             description,
@@ -190,6 +228,19 @@ def build_option_parser(self, description, version):
             help="Print API call timing info",
         )
 
+        # osprofiler HMAC key argument
+        if osprofiler_profiler:
+            parser.add_argument('--profile',
+                                metavar='hmac-key',
+                                help='HMAC key to use for encrypting context '
+                                'data for performance profiling of operation. '
+                                'This key should be the value of one of the '
+                                'HMAC keys configured in osprofiler '
+                                'middleware in the projects user would like '
+                                'to profile. It needs to be specified in '
+                                'configuration files of the required '
+                                'projects.')
+
         return clientmanager.build_plugin_option_parser(parser)
 
     def initialize_app(self, argv):
diff --git a/openstackclient/tests/test_shell.py b/openstackclient/tests/test_shell.py
@@ -109,6 +109,7 @@
     '--os-default-domain': (DEFAULT_DOMAIN_NAME, True, True),
     '--os-cacert': ('/dev/null', True, True),
     '--timing': (True, True, False),
+    '--profile': ('SECRET_KEY', True, False),
     '--os-interface': (DEFAULT_INTERFACE, True, True)
 }
 
diff --git a/releasenotes/notes/add-osprofiler-support-adf5286daf220914.yaml b/releasenotes/notes/add-osprofiler-support-adf5286daf220914.yaml
@@ -0,0 +1,17 @@
+---
+features:
+  - |
+    OSprofiler support was added. To initiate OpenStack request tracing
+    ``--profile <HMAC_KEY>`` option needs to be added to the CLI command. This
+    key needs to present one of the secret keys defined in the OpenStack
+    projects configuration files (if there is a wish to generate cross-project
+    trace, the chosen key needs to be presented in all these configuration
+    files). By default all OpenStack projects, that support OSprofiler,
+    are using ``SECRET_KEY`` HMAC key.
+
+    To use tracing functionality OSprofiler (and its storage backend)
+    needs to be installed in the environment. If so, you will be able to
+    trigger profiling via `openstack --profile SECRET_KEY <operation>` command.
+    At the end of output there will be message with <trace_id>, and to plot
+    human-readable HTML chart the following command should be used -
+    ``osprofiler trace show <trace_id> --html --out result.html``.
diff --git a/test-requirements.txt b/test-requirements.txt
@@ -17,6 +17,7 @@ testrepository>=0.0.18 # Apache-2.0/BSD
 testtools>=1.4.0 # MIT
 WebOb>=1.2.3 # MIT
 tempest-lib>=0.14.0 # Apache-2.0
+osprofiler>=1.1.0 # Apache-2.0
 
 # Install these to generate sphinx autodocs
 python-barbicanclient>=3.3.0 # Apache-2.0

Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,7 @@`
`109`	`109`	`'--os-default-domain': (DEFAULT_DOMAIN_NAME, True, True),`
`110`	`110`	`'--os-cacert': ('/dev/null', True, True),`
`111`	`111`	`'--timing': (True, True, False),`
	`112`	`+ '--profile': ('SECRET_KEY', True, False),`
`112`	`113`	`'--os-interface': (DEFAULT_INTERFACE, True, True)`
`113`	`114`	`}`
`114`	`115`