Extension telemetry (include versions) (#5512)

* Send extension version for extension command usage also.
* Send extension version as well for 'az extension add/remove/update'

Author: derekbekoe

src/azure-cli-core/azure/cli/core/commands/__init__.py

@@ -20,6 +20,7 @@
 from knack.util import CLIError
 
 from azure.cli.core import EXCLUDED_PARAMS
+from azure.cli.core.extension import get_extension
 import azure.cli.core.telemetry as telemetry
 
 logger = get_logger(__name__)
@@ -189,7 +190,7 @@ def get_models(self, *attr_args, **kwargs):
 # pylint: disable=too-few-public-methods
 class AzCliCommandInvoker(CommandInvoker):
 
-    # pylint: disable=too-many-statements
+    # pylint: disable=too-many-statements,too-many-locals
     def execute(self, args):
         import knack.events as events
         from knack.util import CommandResultItem, todict
@@ -283,10 +284,19 @@ def execute(self, args):
             params = self._filter_params(expanded_arg)
 
             command_source = self.commands_loader.command_table[command].command_source
+
+            extension_version = None
+            try:
+                if command_source:
+                    extension_version = get_extension(command_source.extension_name).version
+            except Exception:  # pylint: disable=broad-except
+                pass
+
             telemetry.set_command_details(self.cli_ctx.data['command'], self.data['output'],
                                           [(p.split('=', 1)[0] if p.startswith('--') else p[:2]) for p in args if
                                            (p.startswith('-') and len(p) > 1)],
-                                          extension_name=command_source.extension_name if command_source else None)
+                                          extension_name=command_source.extension_name if command_source else None,
+                                          extension_version=extension_version)
             if command_source:
                 self.data['command_extension_name'] = command_source.extension_name
 

src/azure-cli-core/azure/cli/core/parser.py

@@ -13,7 +13,7 @@
 from knack.util import CLIError
 
 import azure.cli.core.telemetry as telemetry
-
+from azure.cli.core.extension import get_extension
 
 logger = get_logger(__name__)
 
@@ -109,9 +109,17 @@ def error(self, message):
         self.exit(2)
 
     def format_help(self):
+        extension_version = None
+        try:
+            if self.command_source:
+                extension_version = get_extension(self.command_source.extension_name).version
+        except Exception:  # pylint: disable=broad-except
+            pass
+
         telemetry.set_command_details(
             command=self.prog[3:],
-            extension_name=self.command_source.extension_name if self.command_source else None)
+            extension_name=self.command_source.extension_name if self.command_source else None,
+            extension_version=extension_version)
         telemetry.set_success(summary='show help')
         super(AzCliCommandParser, self).format_help()
 

src/azure-cli-core/azure/cli/core/telemetry.py

@@ -38,7 +38,8 @@ class TelemetrySession(object):  # pylint: disable=too-many-instance-attributes
     payload_properties = None
     exceptions = []
     module_correlation = None
-    extension_name = 'None'
+    extension_name = None
+    extension_version = None
     feedback = None
     extension_management_detail = None
 
@@ -124,6 +125,7 @@ def _get_user_task_properties(self):
     def _get_azure_cli_properties(self):
         source = 'az' if self.arg_complete_env_name not in os.environ else 'completer'
         result = {}
+        ext_info = '{}@{}'.format(self.extension_name, self.extension_version) if self.extension_name else None
         self.set_custom_properties(result, 'Source', source)
         self.set_custom_properties(result,
                                    'ClientRequestId',
@@ -145,9 +147,9 @@ def _get_azure_cli_properties(self):
         self.set_custom_properties(result, 'Params', ','.join(self.parameters or []))
         self.set_custom_properties(result, 'PythonVersion', platform.python_version())
         self.set_custom_properties(result, 'ModuleCorrelation', self.module_correlation)
-        self.set_custom_properties(result, 'ExtensionName', self.extension_name)
+        self.set_custom_properties(result, 'ExtensionName', ext_info)
         self.set_custom_properties(result, 'Feedback', self.feedback)
-        self.set_custom_properties(result, 'ExtensionManagement', self.extension_management_detail)
+        self.set_custom_properties(result, 'ExtensionManagementDetail', self.extension_management_detail)
 
         return result
 
@@ -267,16 +269,18 @@ def set_feedback(feedback):
 
 
 @decorators.suppress_all_exceptions(raise_in_diagnostics=True)
-def set_extension_management_detail(content):
+def set_extension_management_detail(ext_name, ext_version):
+    content = '{}@{}'.format(ext_name, ext_version)
     _session.extension_management_detail = content[:512]
 
 
 @decorators.suppress_all_exceptions(raise_in_diagnostics=True)
-def set_command_details(command, output_type=None, parameters=None, extension_name=None):
+def set_command_details(command, output_type=None, parameters=None, extension_name=None, extension_version=None):
     _session.command = command
     _session.output_type = output_type
     _session.parameters = parameters
-    _session.extension_name = extension_name or 'None'
+    _session.extension_name = extension_name
+    _session.extension_version = extension_version
 
 
 @decorators.suppress_all_exceptions(raise_in_diagnostics=True)

src/command_modules/azure-cli-extension/azure/cli/command_modules/extension/custom.py

@@ -168,6 +168,19 @@ def is_valid_sha256sum(a_file, expected_sum):
     return expected_sum == computed_hash, computed_hash
 
 
+def _augment_telemetry_with_ext_info(extension_name):
+    # The extension must be available before calling this otherwise we can't get the version from metadata
+    if not extension_name:
+        return
+    try:
+        ext = get_extension(extension_name)
+        ext_version = ext.version
+        set_extension_management_detail(extension_name, ext_version)
+    except Exception:  # nopa pylint: disable=broad-except
+        # Don't error on telemetry
+        pass
+
+
 def add_extension(source=None, extension_name=None, index_url=None, yes=None,  # pylint: disable=unused-argument
                   pip_extra_index_urls=None, pip_proxy=None):
     ext_sha256 = None
@@ -180,16 +193,16 @@ def add_extension(source=None, extension_name=None, index_url=None, yes=None,  #
             logger.debug(err)
             raise CLIError("No matching extensions for '{}'. Use --debug for more information.".format(extension_name))
     _add_whl_ext(source, ext_sha256=ext_sha256, pip_extra_index_urls=pip_extra_index_urls, pip_proxy=pip_proxy)
-
-    if extension_name:
-        set_extension_management_detail(extension_name)
+    _augment_telemetry_with_ext_info(extension_name)
 
 
 def remove_extension(extension_name):
     try:
+        # Get the extension and it will raise an error if it doesn't exist
         get_extension(extension_name)
+        # We call this just before we remove the extension so we can get the metadata before it is gone
+        _augment_telemetry_with_ext_info(extension_name)
         shutil.rmtree(get_extension_path(extension_name))
-        set_extension_management_detail(extension_name)
     except ExtensionNotInstalledException as e:
         raise CLIError(e)
 
@@ -232,6 +245,8 @@ def update_extension(extension_name, index_url=None, pip_extra_index_urls=None,
                          pip_extra_index_urls=pip_extra_index_urls, pip_proxy=pip_proxy)
             logger.debug('Deleting backup of old extension at %s', backup_dir)
             shutil.rmtree(backup_dir)
+            # This gets the metadata for the extension *after* the update
+            _augment_telemetry_with_ext_info(extension_name)
         except Exception as err:
             logger.error('An error occurred whilst updating.')
             logger.error(err)