[API Proposal]: AuthN/AuthZ metrics

[MackinnonBuck]

Background and Motivation

This is a collection of metrics for ASP.NET Core Authentication and Authorization.

Implemented in #59557.

Proposed API

Microsoft.AspNetCore.Authentication

aspnetcore.authentication.request.duration

Name	Instrument Type	Unit	Description
aspnetcore.authentication.request.duration	Histogram	{request}	The authentication duration for a request.

Attribute	Type	Description	Examples	Presence
aspnetcore.authentication.scheme	string	The name of the authentication scheme.	Bearer; Cookies	Conditionally Required if the request did not end with an error
aspnetcore.authentication.result	string	The authentication result.	success; failure; none; _OTHER	Conditionally Required if the request did not end with an error
error.type	string	The full name of the exception type.	System.InvalidOperationException; Contoso.MyException	Conditionally Required if the request has ended with an error

aspnetcore.authentication.challenges

Name	Instrument Type	Unit	Description
aspnetcore.authentication.challenges	Counter	{request}	The total number of times a scheme is challenged.

Attribute	Type	Description	Examples	Presence
aspnetcore.authentication.scheme	string	The name of the authentication scheme.	Bearer; Cookies	Conditionally Required if the request did not end with an error
error.type	string	The full name of the exception type.	System.InvalidOperationException; Contoso.MyException	Conditionally Required if the request has ended with an error

aspnetcore.authentication.forbids

Name	Instrument Type	Unit	Description
aspnetcore.authentication.forbids	Counter	{request}	The total number of times an authenticated user attempts to access a resources they are not permitted to access.

Attribute	Type	Description	Examples	Presence
aspnetcore.authentication.scheme	string	The name of the authentication scheme.	Bearer; Cookies	Conditionally Required if the request did not end with an error
error.type	string	The full name of the exception type.	System.InvalidOperationException; Contoso.MyException	Conditionally Required if the request has ended with an error

aspnetcore.authentication.sign_ins

Name	Instrument Type	Unit	Description
aspnetcore.authentication.sign_ins	Counter	{request}	The total number of times a principal is signed in.

Attribute	Type	Description	Examples	Presence
aspnetcore.authentication.scheme	string	The name of the authentication scheme.	Bearer; Cookies	Conditionally Required if the request did not end with an error
error.type	string	The full name of the exception type.	System.InvalidOperationException; Contoso.MyException	Conditionally Required if the request has ended with an error

aspnetcore.authentication.sign_outs

Name	Instrument Type	Unit	Description
aspnetcore.authentication.sign_ins	Counter	{request}	The total number of times a scheme is signed out.

Attribute	Type	Description	Examples	Presence
aspnetcore.authentication.scheme	string	The name of the authentication scheme.	Bearer; Cookies	Conditionally Required if the request did not end with an error
error.type	string	The full name of the exception type.	System.InvalidOperationException; Contoso.MyException	Conditionally Required if the request has ended with an error

Microsoft.AspNetCore.Authorization

aspnetcore.authentication.requests

Name	Instrument Type	Unit	Description
aspnetcore.authentication.requests	Counter	{request}	The total number of requests for which authorization was attempted.

Attribute	Type	Description	Examples	Presence
user.is_authenticated	boolean	Whether the request came from an authenticated user	true	Required
aspnetcore.authorization.policy	string	The name of the authorization policy.	AtLeast21; EmployeeOnly	Conditionally required if an authorization policy is used
aspnetcore.authorization.result	string	Whether the authorization succeeded or failed.	success; failure	Conditionally Required if an exception is not thrown during authorization
error.type	string	The full name of the exception type.	System.InvalidOperationException; Contoso.MyException	Conditionally Required if the request has ended with an error

[dotnet-policy-service]

Thank you for submitting this for API review. This will be reviewed by @dotnet/aspnet-api-review at the next meeting of the ASP.NET Core API Review group. Please ensure you take a look at the API review process documentation and ensure that:

• The PR contains changes to the reference-assembly that describe the API change. Or, you have included a snippet of reference-assembly-style code that illustrates the API change.
• The PR describes the impact to users, both positive (useful new APIs) and negative (breaking changes).
• Someone is assigned to "champion" this change in the meeting, and they understand the impact and design of the change.