Skip to content

Identity metrics clean up #62671

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+45 −43
Open

Identity metrics clean up #62671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b2fe2cb
Replace _UNKNOWN with _OTHER in identity metrics
JamesNK Jul 11, 2025
58719a0
More
JamesNK Jul 11, 2025
fc6ad96
Feedback from review
JamesNK Jul 15, 2025
1725d26
PR feedback
JamesNK Jul 15, 2025
5d2d90e
Comment
JamesNK Jul 15, 2025
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
32 changes: 16 additions & 16 deletions src/Identity/Core/src/SignInManagerMetrics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ internal sealed class SignInManagerMetrics : IDisposable
public const string RememberTwoFactorCounterName = "aspnetcore.identity.sign_in.remember_two_factor";
public const string ForgetTwoFactorCounterName = "aspnetcore.identity.sign_in.forget_two_factor";
public const string CheckPasswordCounterName = "aspnetcore.identity.sign_in.check_password";
public const string SignInUserPrincipalCounterName = "aspnetcore.identity.sign_in.sign_in_principal";
public const string SignOutUserPrincipalCounterName = "aspnetcore.identity.sign_in.sign_out_principal";
public const string SignInUserPrincipalCounterName = "aspnetcore.identity.sign_in.sign_in";
public const string SignOutUserPrincipalCounterName = "aspnetcore.identity.sign_in.sign_out";

private readonly Meter _meter;
private readonly Counter<long> _authenticateCounter;
Expand All @@ -29,12 +29,12 @@ public SignInManagerMetrics(IMeterFactory meterFactory)
{
_meter = meterFactory.Create(MeterName);

_authenticateCounter = _meter.CreateCounter<long>(AuthenticateCounterName, "count", "The number of authenticate attempts. The authenticate counter is incremented by sign in methods such as PasswordSignInAsync and TwoFactorSignInAsync.");
_rememberTwoFactorClientCounter = _meter.CreateCounter<long>(RememberTwoFactorCounterName, "count", "The number of two factor clients remembered.");
_forgetTwoFactorCounter = _meter.CreateCounter<long>(ForgetTwoFactorCounterName, "count", "The number of two factor clients forgotten.");
_checkPasswordCounter = _meter.CreateCounter<long>(CheckPasswordCounterName, "count", "The number of check password attempts. Checks that the account is in a state that can log in and that the password is valid using the UserManager.CheckPasswordAsync method.");
_signInUserPrincipalCounter = _meter.CreateCounter<long>(SignInUserPrincipalCounterName, "count", "The number of calls to sign in user principals.");
_signOutUserPrincipalCounter = _meter.CreateCounter<long>(SignOutUserPrincipalCounterName, "count", "The number of calls to sign out user principals.");
_authenticateCounter = _meter.CreateCounter<long>(AuthenticateCounterName, "{count}", "The number of authenticate attempts. The authenticate counter is incremented by sign in methods such as PasswordSignInAsync and TwoFactorSignInAsync.");
_rememberTwoFactorClientCounter = _meter.CreateCounter<long>(RememberTwoFactorCounterName, "{count}", "The number of two factor clients remembered.");
_forgetTwoFactorCounter = _meter.CreateCounter<long>(ForgetTwoFactorCounterName, "{count}", "The number of two factor clients forgotten.");
_checkPasswordCounter = _meter.CreateCounter<long>(CheckPasswordCounterName, "{check}", "The number of check password attempts. Checks that the account is in a state that can log in and that the password is valid using the UserManager.CheckPasswordAsync method.");
_signInUserPrincipalCounter = _meter.CreateCounter<long>(SignInUserPrincipalCounterName, "{sign_in}", "The number of calls to sign in user principals.");
_signOutUserPrincipalCounter = _meter.CreateCounter<long>(SignOutUserPrincipalCounterName, "{sign_out}", "The number of calls to sign out user principals.");
}

internal void CheckPasswordSignIn(string userType, SignInResult? result, Exception? exception = null)
Expand All @@ -49,7 +49,7 @@ internal void CheckPasswordSignIn(string userType, SignInResult? result, Excepti
{ "aspnetcore.identity.user_type", userType },
};
AddSignInResult(ref tags, result);
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception);

_checkPasswordCounter.Add(1, tags);
}
Expand All @@ -69,7 +69,7 @@ internal void AuthenticateSignIn(string userType, string authenticationScheme, S
};
AddIsPersistent(ref tags, isPersistent);
AddSignInResult(ref tags, result);
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception);

_authenticateCounter.Add(1, tags);
}
Expand All @@ -87,7 +87,7 @@ internal void SignInUserPrincipal(string userType, string authenticationScheme,
{ "aspnetcore.identity.authentication_scheme", authenticationScheme },
};
AddIsPersistent(ref tags, isPersistent);
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception);

_signInUserPrincipalCounter.Add(1, tags);
}
Expand All @@ -104,7 +104,7 @@ internal void SignOutUserPrincipal(string userType, string authenticationScheme,
{ "aspnetcore.identity.user_type", userType },
{ "aspnetcore.identity.authentication_scheme", authenticationScheme },
};
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception);

_signOutUserPrincipalCounter.Add(1, tags);
}
Expand All @@ -121,7 +121,7 @@ internal void RememberTwoFactorClient(string userType, string authenticationSche
{ "aspnetcore.identity.user_type", userType },
{ "aspnetcore.identity.authentication_scheme", authenticationScheme }
};
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception);

_rememberTwoFactorClientCounter.Add(1, tags);
}
Expand All @@ -138,7 +138,7 @@ internal void ForgetTwoFactorClient(string userType, string authenticationScheme
{ "aspnetcore.identity.user_type", userType },
{ "aspnetcore.identity.authentication_scheme", authenticationScheme }
};
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception);

_forgetTwoFactorCounter.Add(1, tags);
}
Expand All @@ -164,7 +164,7 @@ private static void AddSignInResult(ref TagList tags, SignInResult? result)
}
}

private static void AddExceptionTags(ref TagList tags, Exception? exception)
private static void AddErrorTag(ref TagList tags, Exception? exception)
{
if (exception != null)
{
Expand All @@ -182,7 +182,7 @@ private static string GetSignInType(SignInType signInType)
SignInType.TwoFactor => "two_factor",
SignInType.External => "external",
SignInType.Passkey => "passkey",
_ => "_UNKNOWN"
_ => "_OTHER"
};
}

Expand Down
46 changes: 24 additions & 22 deletions src/Identity/Extensions.Core/src/UserManagerMetrics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ internal sealed class UserManagerMetrics : IDisposable
public UserManagerMetrics(IMeterFactory meterFactory)
{
_meter = meterFactory.Create(MeterName);
_createCounter = _meter.CreateCounter<long>(CreateCounterName, "count", "The number of users created.");
_updateCounter = _meter.CreateCounter<long>(UpdateCounterName, "count", "The number of user updates.");
_deleteCounter = _meter.CreateCounter<long>(DeleteCounterName, "count", "The number of users deleted.");
_checkPasswordCounter = _meter.CreateCounter<long>(CheckPasswordCounterName, "count", "The number of check password attempts. Only checks whether the password is valid and not whether the user account is in a state that can log in.");
_verifyTokenCounter = _meter.CreateCounter<long>(VerifyTokenCounterName, "count", "The number of token verification attempts.");
_generateTokenCounter = _meter.CreateCounter<long>(GenerateTokenCounterName, "count", "The number of token generation attempts.");
_createCounter = _meter.CreateCounter<long>(CreateCounterName, "{user}", "The number of users created.");
_updateCounter = _meter.CreateCounter<long>(UpdateCounterName, "{user}", "The number of users updated.");
_deleteCounter = _meter.CreateCounter<long>(DeleteCounterName, "{user}", "The number of users deleted.");
_checkPasswordCounter = _meter.CreateCounter<long>(CheckPasswordCounterName, "{check}", "The number of check password attempts. Only checks whether the password is valid and not whether the user account is in a state that can log in.");
_verifyTokenCounter = _meter.CreateCounter<long>(VerifyTokenCounterName, "{count}", "The number of token verification attempts.");
_generateTokenCounter = _meter.CreateCounter<long>(GenerateTokenCounterName, "{count}", "The number of token generation attempts.");
}

internal void CreateUser(string userType, IdentityResult? result, Exception? exception = null)
Expand All @@ -52,7 +52,7 @@ internal void CreateUser(string userType, IdentityResult? result, Exception? exc
{ "aspnetcore.identity.user_type", userType }
};
AddIdentityResultTags(ref tags, result);
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception, result: result);

_createCounter.Add(1, tags);
}
Expand All @@ -70,7 +70,7 @@ internal void UpdateUser(string userType, IdentityResult? result, UserUpdateType
{ "aspnetcore.identity.user.update_type", GetUpdateType(updateType) },
};
AddIdentityResultTags(ref tags, result);
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception, result: result);

_updateCounter.Add(1, tags);
}
Expand All @@ -87,7 +87,7 @@ internal void DeleteUser(string userType, IdentityResult? result, Exception? exc
{ "aspnetcore.identity.user_type", userType }
};
AddIdentityResultTags(ref tags, result);
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception, result: result);

_deleteCounter.Add(1, tags);
}
Expand All @@ -105,9 +105,9 @@ internal void CheckPassword(string userType, bool? userMissing, PasswordVerifica
};
if (userMissing != null || result != null)
{
tags.Add("aspnetcore.identity.user.password_result", GetPasswordResult(result, passwordMissing: null, userMissing));
tags.Add("aspnetcore.identity.password_check_result", GetPasswordResult(result, passwordMissing: null, userMissing));
}
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception);

_checkPasswordCounter.Add(1, tags);
}
Expand All @@ -128,7 +128,7 @@ internal void VerifyToken(string userType, bool? result, string purpose, Excepti
{
tags.Add("aspnetcore.identity.token_verified", result == true ? "success" : "failure");
}
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception);

_verifyTokenCounter.Add(1, tags);
}
Expand All @@ -145,14 +145,14 @@ internal void GenerateToken(string userType, string purpose, Exception? exceptio
{ "aspnetcore.identity.user_type", userType },
{ "aspnetcore.identity.token_purpose", GetTokenPurpose(purpose) },
};
AddExceptionTags(ref tags, exception);
AddErrorTag(ref tags, exception);

_generateTokenCounter.Add(1, tags);
}

private static string GetTokenPurpose(string purpose)
{
// Purpose could be any value and can't be used as a tag value. However, there are known purposes
// Purpose could be any value and can't be used directly as a tag value. However, there are known purposes
// on UserManager that we can detect and use as a tag value. Some could have a ':' in them followed by user data.
// We need to trim them to content before ':' and then match to known values.
ReadOnlySpan<char> trimmedPurpose = purpose;
Expand All @@ -161,15 +161,16 @@ private static string GetTokenPurpose(string purpose)
{
trimmedPurpose = purpose.AsSpan(0, colonIndex);
}


// These are known purposes that are specified in ASP.NET Core Identity.
return trimmedPurpose switch
{
"ResetPassword" => "reset_password",
"ChangePhoneNumber" => "change_phone_number",
"EmailConfirmation" => "email_confirmation",
"ChangeEmail" => "change_email",
"TwoFactor" => "two_factor",
_ => "_UNKNOWN"
_ => "_OTHER"
};
}

Expand All @@ -183,15 +184,16 @@ private static void AddIdentityResultTags(ref TagList tags, IdentityResult? resu
tags.Add("aspnetcore.identity.result", result.Succeeded ? "success" : "failure");
if (!result.Succeeded && result.Errors.FirstOrDefault()?.Code is { Length: > 0 } code)
{
tags.Add("aspnetcore.identity.result_error_code", code);
tags.Add("aspnetcore.identity.error_code", code);
}
}

private static void AddExceptionTags(ref TagList tags, Exception? exception)
private static void AddErrorTag(ref TagList tags, Exception? exception, IdentityResult? result = null)
{
if (exception != null)
var value = exception?.GetType().FullName ?? result?.Errors.FirstOrDefault()?.Code;
if (value != null)
{
tags.Add("error.type", exception.GetType().FullName!);
tags.Add("error.type", value);
}
}

Expand All @@ -204,7 +206,7 @@ private static string GetPasswordResult(PasswordVerificationResult? result, bool
(PasswordVerificationResult.Failed, false, false) => "failure",
(null, true, false) => "password_missing",
(null, false, true) => "user_missing",
_ => "_UNKNOWN"
_ => "_OTHER"
};
}

Expand Down Expand Up @@ -244,7 +246,7 @@ private static string GetUpdateType(UserUpdateType updateType)
UserUpdateType.RedeemTwoFactorRecoveryCode => "redeem_two_factor_recovery_code",
UserUpdateType.SetPasskey => "set_passkey",
UserUpdateType.RemovePasskey => "remove_passkey",
_ => "_UNKNOWN"
_ => "_OTHER"
};
}

Expand Down
10 changes: 5 additions & 5 deletions src/Identity/test/Identity.Test/UserManagerTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ public async Task DeleteCallsStore_Failure()
[
KeyValuePair.Create<string, object>("aspnetcore.identity.user_type", "Microsoft.AspNetCore.Identity.Test.PocoUser"),
KeyValuePair.Create<string, object>("aspnetcore.identity.result", "failure"),
KeyValuePair.Create<string, object>("aspnetcore.identity.result_error_code", "ConcurrencyFailure")
KeyValuePair.Create<string, object>("aspnetcore.identity.error_code", "ConcurrencyFailure")
]));
}

Expand Down Expand Up @@ -664,7 +664,7 @@ public async Task CheckPasswordWillRehashPasswordWhenNeeded()
Assert.Collection(checkPassword.GetMeasurementSnapshot(),
m => MetricsHelpers.AssertContainsTags(m.Tags,
[
KeyValuePair.Create<string, object>("aspnetcore.identity.user.password_result", "success_rehash_needed")
KeyValuePair.Create<string, object>("aspnetcore.identity.password_check_result", "success_rehash_needed")
]));
}

Expand Down Expand Up @@ -871,7 +871,7 @@ public async Task CheckPasswordWithNullUserReturnsFalse()
Assert.Collection(checkPassword.GetMeasurementSnapshot(),
m => MetricsHelpers.AssertContainsTags(m.Tags,
[
KeyValuePair.Create<string, object>("aspnetcore.identity.user.password_result", "user_missing")
KeyValuePair.Create<string, object>("aspnetcore.identity.password_check_result", "user_missing")
]));
}

Expand Down Expand Up @@ -952,13 +952,13 @@ await Assert.ThrowsAsync<NotSupportedException>(
Assert.Collection(generateToken.GetMeasurementSnapshot(),
m => MetricsHelpers.AssertContainsTags(m.Tags,
[
KeyValuePair.Create<string, object>("aspnetcore.identity.token_purpose", "_UNKNOWN"),
KeyValuePair.Create<string, object>("aspnetcore.identity.token_purpose", "_OTHER"),
KeyValuePair.Create<string, object>("error.type", "System.NotSupportedException"),
]));
Assert.Collection(verifyToken.GetMeasurementSnapshot(),
m => MetricsHelpers.AssertContainsTags(m.Tags,
[
KeyValuePair.Create<string, object>("aspnetcore.identity.token_purpose", "_UNKNOWN"),
KeyValuePair.Create<string, object>("aspnetcore.identity.token_purpose", "_OTHER"),
KeyValuePair.Create<string, object>("error.type", "System.NotSupportedException"),
]));
}
Expand Down
Loading