{Core} Add discernable telemetry for --help commands
#32714
Merged
+1
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
microsoft-github-policy-service
bot
added
Auto-Assign
DanielMicrosoft
requested review from
jsntcy,
kairu-ms and
zhoxing-ms
as code owners
DanielMicrosoft
requested review from
bebound,
calvinhzy and
necusjz
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds telemetry tracking for help commands by including --help in the parameters field of telemetry data. Previously, help commands (using --help, -h, or help) were not easily queryable in telemetry.
Changes:
- Modified
format_help()method inparser.pyto includeparameters=['--help']when setting telemetry command details
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
necusjz
approved these changes
Jan 30, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related command
Description
Previously, there was no way in telemetry to query commands from the
--helpfamily. This PR add--helpto the telemetry payload (using theParamsproperty).Tested conditions:
az helpaz --helpaz -h--help-h--help-hIsCmdIdxRebuildTriggeredstill set correctlyKustoTo query in Kusto:
Commands (successful) sent from this branch:
In Kusto, there are many records already with
Paramsset to--help, however they are only for records whereActionResult!=Success. It appears records can make it to Kusto withParamsset to--helpif someone has setextension.use_dynamic_install=yes_promptand cancel out of a prompt to install an extension, initiated by a command appended with--help, i.e.,az monitor scheduled-query --help.You can view these records with this query:
The ResultSummary="show help" records appearing in Kusto are from legacy dev environments running editable installs that report as version 0.1.1b3+dev. These use the old event naming convention (azurecli/commands/vm) which isn't in the suppression list, while modern versions use azurecli/command (which is suppressed). The fix is working correctly for production users.
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.