{Core} Add distinct telemetry events for --version#32455
{Core} Add distinct telemetry events for --version#32455DanielMicrosoft merged 3 commits intoAzure:devfrom
--version#32455Conversation
️✔️AzureCLI-FullTest
|
|
Hi @DanielMicrosoft, |
️✔️AzureCLI-BreakingChangeTest
|
|
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>
|
There was a problem hiding this comment.
Pull request overview
This PR adds distinct telemetry markers for the az --version command to enable filtering and querying of these events in Kusto. Previously, version check telemetry events lacked distinguishing characteristics, making them difficult to identify in telemetry data.
- Added telemetry tracking calls in the
show_versionmethod to set raw command name and command details - Updated VS Code debug configurations (debugger type and configurations)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/azure-cli-core/azure/cli/core/init.py | Added telemetry calls to track --version command execution with distinct markers |
| .vscode/launch.json | Updated VS Code debugger configurations (changed type from "python" to "debugpy", removed deprecated debugOptions, modified one debug configuration's args to "--version") |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| { | ||
| "name": "Azure CLI Debug (External Console)", | ||
| "type": "python", | ||
| "type": "debugpy", |
There was a problem hiding this comment.
updating this property as recommended by linter
| "--help" | ||
| ], | ||
| "console": "integratedTerminal", | ||
| "debugOptions": [ |
There was a problem hiding this comment.
removing values as deprecated
Related command
Description
ADO Task: https://msazure.visualstudio.com/One/_workitems/edit/35972904
Previously,
az --versiontelemetry events would have no distinct markers to allow for deliberate searching/queries of telemetry records. This PR adds those so thataz --versiontelemetry events can be filtered and queried from Kusto.Testing Guide
Please run
az --versionfrom this branch and capture theCorrelationidand use it to query the kusto instance to observe the telemetry.Note: an example event initiated from this branch can be found in Kusto using this condition:
For comparison purposes, here is an example of a call to
az --versionwithout the changes in this PR: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.