Skip to content

Fix auth error telemetry classification #7235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spboyer merged 1 commit into from
Mar 25, 2026
Merged

Fix auth error telemetry classification #7235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions cli/azd/internal/cmd/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (

"github.com/AlecAivazis/survey/v2/terminal"
"github.com/Azure/azure-sdk-for-go/sdk/azcore"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/azure/azure-dev/cli/azd/internal"
"github.com/azure/azure-dev/cli/azd/internal/agent/consent"
"github.com/azure/azure-dev/cli/azd/internal/tracing"
Expand Down Expand Up @@ -48,6 +49,7 @@ func MapError(err error, span tracing.Span) {
errCode = updateErr.Code
} else if _, ok := errors.AsType[*auth.ReLoginRequiredError](err); ok {
errCode = "auth.login_required"
errDetails = append(errDetails, fields.ErrCategory.String("auth"))
} else if errWithSuggestion, ok := errors.AsType[*internal.ErrorWithSuggestion](err); ok {
errCode = "error.suggestion"
span.SetAttributes(fields.ErrType.String(classifySuggestionType(errWithSuggestion.Unwrap())))
Expand Down Expand Up @@ -184,6 +186,12 @@ func MapError(err error, span tracing.Span) {
fields.ServiceCorrelationId.String(authFailedErr.Parsed.CorrelationId))
}
errCode = "service.aad.failed"
} else if errors.Is(err, auth.ErrNoCurrentUser) {
errCode = "auth.not_logged_in"
errDetails = append(errDetails, fields.ErrCategory.String("auth"))
} else if _, ok := errors.AsType[*azidentity.AuthenticationFailedError](err); ok {
errCode = "auth.identity_failed"
errDetails = append(errDetails, fields.ErrCategory.String("auth"))
} else if code := classifySentinel(err); code != "" {
errCode = code
} else if isNetworkError(err) {
Expand Down Expand Up @@ -268,8 +276,6 @@ func classifySentinel(err error) string {
return "user.canceled"
case errors.Is(err, context.DeadlineExceeded):
return "internal.timeout"
case errors.Is(err, auth.ErrNoCurrentUser):
return "auth.not_logged_in"
case errors.Is(err, consent.ErrToolExecutionDenied):
return "user.tool_denied"
case errors.Is(err, git.ErrNotRepository):
Expand Down Expand Up @@ -374,6 +380,14 @@ func classifySuggestionType(err error) string {
return "service.aad.failed"
}

if errors.Is(err, auth.ErrNoCurrentUser) {
return "auth.not_logged_in"
}

if _, ok := errors.AsType[*azidentity.AuthenticationFailedError](err); ok {
return "auth.identity_failed"
}

if code := classifySentinel(err); code != "" {
return code
}
Expand Down
45 changes: 37 additions & 8 deletions cli/azd/internal/cmd/errors_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"testing"

"github.com/Azure/azure-sdk-for-go/sdk/azcore"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/azure/azure-dev/cli/azd/internal"
"github.com/azure/azure-dev/cli/azd/internal/agent/consent"
"github.com/azure/azure-dev/cli/azd/internal/tracing/fields"
Expand Down Expand Up @@ -201,6 +202,22 @@ func Test_MapError(t *testing.T) {
fields.ErrorKey(fields.ServiceCorrelationId.Key).String("12345"),
},
},
{
name: "WithReLoginRequiredError",
err: &auth.ReLoginRequiredError{},
wantErrReason: "auth.login_required",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ErrCategory.Key).String("auth"),
},
},
{
name: "WithAzidentityAuthenticationFailedError",
err: &azidentity.AuthenticationFailedError{},
wantErrReason: "auth.identity_failed",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ErrCategory.Key).String("auth"),
},
},
{
name: "WithExtServiceError",
err: &azdext.ServiceError{
Expand Down Expand Up @@ -274,16 +291,20 @@ func Test_MapError(t *testing.T) {
wantErrDetails: nil,
},
{
name: "WithErrNoCurrentUser",
err: auth.ErrNoCurrentUser,
wantErrReason: "auth.not_logged_in",
wantErrDetails: nil,
name: "WithErrNoCurrentUser",
err: auth.ErrNoCurrentUser,
wantErrReason: "auth.not_logged_in",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ErrCategory.Key).String("auth"),
},
},
{
name: "WithWrappedErrNoCurrentUser",
err: fmt.Errorf("failed to create credential: %w: %w", errors.New("inner"), auth.ErrNoCurrentUser),
wantErrReason: "auth.not_logged_in",
wantErrDetails: nil,
name: "WithWrappedErrNoCurrentUser",
err: fmt.Errorf("failed to create credential: %w: %w", errors.New("inner"), auth.ErrNoCurrentUser),
wantErrReason: "auth.not_logged_in",
wantErrDetails: []attribute.KeyValue{
fields.ErrorKey(fields.ErrCategory.Key).String("auth"),
},
},
{
name: "WithErrToolExecutionDenied",
Expand Down Expand Up @@ -974,6 +995,14 @@ func Test_ClassifySuggestionType_MatchesMapError(t *testing.T) {
Parsed: &auth.AadErrorResponse{Error: "invalid_grant"},
},
},
{
name: "ReLoginRequiredError",
err: &auth.ReLoginRequiredError{},
},
{
name: "AzidentityAuthenticationFailedError",
err: &azidentity.AuthenticationFailedError{},
},
// Sentinels
{name: "context.Canceled", err: context.Canceled},
{name: "context.DeadlineExceeded", err: context.DeadlineExceeded},
Expand Down
Loading