Skip to content

ASP.NET Core identity user metrics API #62132

Open
@JamesNK

Description

@JamesNK

Background and Motivation

API review of user manager metrics for #62078.

Proposed API

Microsoft.AspNetCore.Identity

aspnetcore.identity.user.create

Name Instrument Type Unit Description
aspnetcore.identity.user.create Counter count The number of users created.
Attribute Type Description Examples Presence
aspnetcore.identity.user_type string The identity user type. ContosoUser Always
aspnetcore.identity.result string The result of the identity operation. success; failure If no exception was thrown.
aspnetcore.identity.result_error_code string The result of the identity operation. DefaultError; PasswordMismatch If an error was set on a failed identity result.
error.type string The full name of exception type. System.InvalidOperationException If an exception was thrown.

aspnetcore.identity.user.update

Name Instrument Type Unit Description
aspnetcore.identity.user.update Counter count The number of user updates.
Attribute Type Description Examples Presence
aspnetcore.identity.user_type string The identity user type. ContosoUser Always
aspnetcore.identity.user.update_type string The user update type. update; user_name; reset_password Always
aspnetcore.identity.result string The result of the identity operation. success; failure If no exception was thrown.
aspnetcore.identity.result_error_code string The result of the identity operation. DefaultError; PasswordMismatch If an error was set on a failed identity result.
error.type string The full name of exception type. System.InvalidOperationException If an exception was thrown.

aspnetcore.identity.user.delete

Name Instrument Type Unit Description
aspnetcore.identity.user.delete Counter count The number of users deleted.
Attribute Type Description Examples Presence
aspnetcore.identity.user_type string The identity user type. ContosoUser Always
aspnetcore.identity.result string The result of the identity operation. success; failure If no exception was thrown.
aspnetcore.identity.result_error_code string The result of the identity operation. DefaultError; PasswordMismatch If an error was set on a failed identity result.
error.type string The full name of exception type. System.InvalidOperationException If an exception was thrown.

aspnetcore.identity.user.check_password

Name Instrument Type Unit Description
aspnetcore.identity.user.check_password Counter count The number of check password attempts.
Attribute Type Description Examples Presence
aspnetcore.identity.user_type string The identity user type. ContosoUser Always
aspnetcore.identity.user.password_result string The result from checking the password. success; failure If no exception was thrown.
error.type string The full name of exception type. System.InvalidOperationException If an exception was thrown.

aspnetcore.identity.user.verify_password

Name Instrument Type Unit Description
aspnetcore.identity.user.verify_password Counter count The number of password verification attempts.
Attribute Type Description Examples Presence
aspnetcore.identity.user_type string The identity user type. ContosoUser Always
aspnetcore.identity.user.password_result string The result from checking the password. success; failure If no exception was thrown.
error.type string The full name of exception type. System.InvalidOperationException If an exception was thrown.

aspnetcore.identity.user.verify_token

Name Instrument Type Unit Description
aspnetcore.identity.user.verify_token Counter count The number of token verification attempts.
Attribute Type Description Examples Presence
aspnetcore.identity.user_type string The identity user type. ContosoUser Always
aspnetcore.identity.token_purpose string What the token is used for. reset_password; two_factor Always
aspnetcore.identity.token_verified string Result of verifing the token. success; failure If no exception was thrown.
error.type string The full name of exception type. System.InvalidOperationException If an exception was thrown.

aspnetcore.identity.user.generate_token

Name Instrument Type Unit Description
aspnetcore.identity.user.generate_token Counter count The number of token generation attempts.
Attribute Type Description Examples Presence
aspnetcore.identity.user_type string The identity user type. ContosoUser Always
aspnetcore.identity.token_purpose string What the token is used for. reset_password; two_factor Always

Usage Examples

Alternative Designs

Risks

Metadata

Metadata

Assignees

No one assigned

    Labels

    api-suggestionEarly API idea and discussion, it is NOT ready for implementationarea-identityIncludes: Identity and providers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions