feature: (WIP) add new telemetry field

Author: DanielMicrosoft

.vscode/launch.json

@@ -3,7 +3,7 @@
     "configurations": [
         {
             "name": "Azure CLI Debug (Integrated Console)",
-            "type": "python",
+            "type": "debugpy",
             "request": "launch",
             "python": "${command:python.interpreterPath}",
             "program": "${workspaceRoot}/src/azure-cli/azure/cli/__main__.py",
@@ -12,46 +12,32 @@
                 "--help"
             ],
             "console": "integratedTerminal",
-            "debugOptions": [
-                "WaitOnAbnormalExit",
-                "WaitOnNormalExit",
-                "RedirectOutput"
-            ],
             "justMyCode": false
         },
         {
             "name": "Azure CLI Debug (External Console)",
-            "type": "python",
+            "type": "debugpy",
             "request": "launch",
             "stopOnEntry": true,
             "python": "${command:python.interpreterPath}",
             "program": "${workspaceRoot}/src/azure-cli/azure/cli/__main__.py",
             "cwd": "${workspaceRoot}",
             "args": [
-                "--help"
+                "VERSION"
             ],
-            "console": "externalTerminal",
-            "debugOptions": [
-                "WaitOnAbnormalExit",
-                "WaitOnNormalExit"
-            ]
+            "console": "externalTerminal"
         },
         {
             "name": "Azdev Scripts",
-            "type": "python",
+            "type": "debugpy",
             "request": "launch",
             "python": "${command:python.interpreterPath}",
             "program": "${workspaceRoot}/tools/automation/__main__.py",
             "cwd": "${workspaceRoot}",
             "args": [
                 "--help"
             ],
-            "console": "integratedTerminal",
-            "debugOptions": [
-                "WaitOnAbnormalExit",
-                "WaitOnNormalExit",
-                "RedirectOutput"
-            ]
+            "console": "integratedTerminal"
         }
     ]
-}
+}

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

@@ -514,7 +514,9 @@ def execute(self, args):
             EVENT_INVOKER_PRE_CMD_TBL_TRUNCATE, EVENT_INVOKER_PRE_LOAD_ARGUMENTS, EVENT_INVOKER_POST_LOAD_ARGUMENTS)
 
         # TODO: Can't simply be invoked as an event because args are transformed
+        # what are args before this call?
         args = _pre_command_table_create(self.cli_ctx, args)
+        raw_args = args.copy()
 
         self.cli_ctx.raise_event(EVENT_INVOKER_PRE_CMD_TBL_CREATE, args=args)
         self.commands_loader.load_command_table(args)
@@ -578,8 +580,10 @@ def execute(self, args):
             self.help.show_welcome(subparser)
 
             # TODO: No event in base with which to target
-            telemetry.set_command_details('az')
+            telemetry.set_command_details('az', raw_args=raw_args)
             telemetry.set_success(summary='welcome')
+            # @TODO: can add custom telemetry calls here?
+            # @ie: set commandAsTyped. trigger table? (where does that come from)
             return CommandResultItem(None, exit_code=0)
 
         if args[0].lower() == 'help':
@@ -631,9 +635,12 @@ def execute(self, args):
                 extension_version = get_extension(command_source.extension_name).version
         except Exception:  # pylint: disable=broad-except
             pass
+        
+        # Raw args added to telemetry payload for command rebuild analysis
         telemetry.set_command_details(self.cli_ctx.data['command'], self.data['output'],
                                       self.cli_ctx.data['safe_params'],
-                                      extension_name=extension_name, extension_version=extension_version)
+                                      extension_name=extension_name, extension_version=extension_version,
+                                      raw_args=raw_args)
         if extension_name:
             self.data['command_extension_name'] = extension_name
             self.cli_ctx.logging.log_cmd_metadata_extension_info(extension_name, extension_version)

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

@@ -51,6 +51,7 @@ def __init__(self, correlation_id=None, application=None):
         self.feedback = None
         self.extension_management_detail = None
         self.raw_command = None
+        self.raw_args = None
         self.show_survey_message = False
         self.region_input = None
         self.region_identified = None
@@ -207,6 +208,7 @@ def _get_azure_cli_properties(self):
         set_custom_properties(result, 'InvokeTimeElapsed', str(self.invoke_time_elapsed))
         set_custom_properties(result, 'OutputType', self.output_type)
         set_custom_properties(result, 'RawCommand', self.raw_command)
+        set_custom_properties(result, 'RawArgs', ','.join(self.raw_args or []))
         set_custom_properties(result, 'Params', ','.join(self.parameters or []))
         set_custom_properties(result, 'PythonVersion', platform.python_version())
         set_custom_properties(result, 'ModuleCorrelation', self.module_correlation)
@@ -437,12 +439,13 @@ def set_extension_management_detail(ext_name, ext_version):
 
 
 @decorators.suppress_all_exceptions()
-def set_command_details(command, output_type=None, parameters=None, extension_name=None, extension_version=None):
+def set_command_details(command, output_type=None, parameters=None, extension_name=None, extension_version=None, raw_args=None):
     _session.command = command
     _session.output_type = output_type
     _session.parameters = parameters
     _session.extension_name = extension_name
     _session.extension_version = extension_version
+    _session.raw_args = raw_args
 
 
 @decorators.suppress_all_exceptions()