Open
Conversation
Auth errors (login_required, not_logged_in, azidentity AuthenticationFailedError)
were classified as 'unknown' in telemetry because they did not set
fields.ServiceName.String("aad"). This affected ~610K errors per 28 days.
Changes:
- Add ServiceName("aad") to ReLoginRequiredError branch in MapError()
- Move ErrNoCurrentUser handling from classifySentinel() into MapError()
so it can set errDetails with ServiceName("aad")
- Add handling for azidentity.AuthenticationFailedError with new result
code "auth.identity_failed" and ServiceName("aad")
- Update classifySuggestionType() to match MapError's handling
- Add test cases for ReLoginRequiredError and azidentity errors
- Update existing ErrNoCurrentUser tests to expect ServiceName("aad")
Fixes #7233
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
spboyer
requested review from
JeffreyCA,
hemarina,
rajeshkamal5050,
tg-msft,
vhvb1989,
wbreza and
weikanglim
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Improves telemetry classification for auth-related failures by ensuring these errors set service.name = "aad" so downstream category bucketing no longer falls back to "unknown".
Changes:
- Add
service.name="aad"details forauth.ReLoginRequiredError(auth.login_required). - Move
auth.ErrNoCurrentUserclassification intoMapErrorand setservice.name="aad"(auth.not_logged_in). - Add explicit handling for
azidentity.AuthenticationFailedErrorwith new codeauth.identity_failedandservice.name="aad", and keepclassifySuggestionTypealigned.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| cli/azd/internal/cmd/errors.go | Updates error-to-telemetry mapping to tag key auth errors with service.name="aad" and adds a dedicated azidentity auth-failure code. |
| cli/azd/internal/cmd/errors_test.go | Adds/updates test cases to validate new auth mappings and ensure classifySuggestionType stays in sync with MapError. |
Collaborator
Azure Dev CLI Install InstructionsInstall scriptsMacOS/Linux
bash: pwsh: WindowsPowerShell install MSI install Standalone Binary
MSI
Documentationlearn.microsoft.com documentationtitle: Azure Developer CLI reference
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes #7233
Auth errors (
login_required,not_logged_in,azidentity.AuthenticationFailedError) were classified as"unknown"in telemetry because they did not setfields.ServiceName.String("aad"). This affected ~610K errors per 28 days and made the"unknown"error category bucket unreliable for analysis.Changes
ReLoginRequiredError→auth.login_requiredaadErrNoCurrentUser→auth.not_logged_inclassifySentinel)aad(moved toMapErrorif-else chain)azidentity.AuthenticationFailedErrorinternal.*catch-allauth.identity_failedwith ServiceNameaadCode
errors.go: AddedServiceName("aad")toReLoginRequiredErrorbranch, movedErrNoCurrentUserout ofclassifySentinel()intoMapError(), addedazidentity.AuthenticationFailedErrorhandler, updatedclassifySuggestionType()to stay in sync.errors_test.go: Added test cases forReLoginRequiredErrorandazidentity.AuthenticationFailedError, updatedErrNoCurrentUsertests to expectServiceName("aad"), added entries toClassifySuggestionType_MatchesMapError.Expected Telemetry Impact
After this fix, the Kusto
AzdErrorCategorycolumn will show:auth.login_requiredunknown❌aad✅auth.not_logged_inunknown❌aad✅auth.identity_failed(wasinternal.azidentity_*)unknown❌aad✅service.aad.failedaad✅aad✅ (unchanged)This removes ~610K errors/28d from the
"unknown"bucket.