semantic-conventions/docs/registry/attributes/aspnetcore.md

16 KiB

Aspnetcore

ASP.NET Core Attributes

ASP.NET Core attributes

Attribute Type Description Examples Stability
aspnetcore.authentication_scheme string The authentication scheme to sign in with. Identity.Application Development
aspnetcore.diagnostics.exception.result string ASP.NET Core exception middleware handling result. handled; unhandled Stable
aspnetcore.diagnostics.handler.type string Full type name of the IExceptionHandler implementation that handled the exception. Contoso.MyHandler Stable
aspnetcore.identity.error_code string The error code for a failed identity operation. DefaultError; PasswordMismatch Development
aspnetcore.identity.password_check_result string The result from checking the password. success; failure Development
aspnetcore.identity.result string The result of the identity operation. success; failure Development
aspnetcore.identity.sign_in.result string Whether the sign in result was success or failure. password; two_factor Development
aspnetcore.identity.sign_in.type string The authentication type. password; two_factor Development
aspnetcore.identity.token_purpose string What the token will be used for. success; failure Development
aspnetcore.identity.token_verified string The result of token verification. success; failure Development
aspnetcore.identity.user.update_type string The user update type. update; user_name; reset_password Development
aspnetcore.identity.user_type string The full name of the identity user type. Contoso.ContosoUser Development
aspnetcore.rate_limiting.policy string Rate limiting policy name. fixed; sliding; token Stable
aspnetcore.rate_limiting.result string Rate-limiting result, shows whether the lease was acquired or contains a rejection reason acquired; request_canceled Stable
aspnetcore.request.is_unhandled boolean Flag indicating if request was handled by the application pipeline. true Stable
aspnetcore.routing.is_fallback boolean A value that indicates whether the matched route is a fallback route. true Stable
aspnetcore.routing.match_status string Match result - success or failure success; failure Stable
aspnetcore.sign_in.is_persistent boolean A flag indicating whether the sign in is persistent. Development

aspnetcore.diagnostics.exception.result has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
aborted Exception handling didn't run because the request was aborted. Stable
handled Exception was handled by the exception handling middleware. Stable
skipped Exception handling was skipped because the response had started. Stable
unhandled Exception was not handled by the exception handling middleware. Stable

aspnetcore.identity.password_check_result has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
failure Password check failed. Development
password_missing Password check couldn't proceed because the password was missing from the user. Development
success Password check was successful. Development
success_rehash_needed Password check was successful however the password was encoded using a deprecated algorithm and should be rehashed and updated. Development
user_missing Password check couldn't proceed because the user was missing. Development

aspnetcore.identity.result has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
failure Identity operation failed. Development
success Identity operation was successful. Development

aspnetcore.identity.sign_in.result has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
failure Sign in failed. Development
locked_out User is locked out. Development
not_allowed User is not allowed to sign in. Development
requires_two_factor User requires two factory authentication to sign in. Development
success Sign in was successful. Development

aspnetcore.identity.sign_in.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
external Sign in with a previously registered third-party login. Development
passkey Sign in with passkey. Development
password Sign in with password. Development
two_factor Sign in with a two factor provider. Development
two_factor_authenticator Sign in with two factor authenticator app. Development
two_factor_recovery_code Sign in with two factory recovery code. Development

aspnetcore.identity.token_purpose has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
_OTHER Any token purpose that the instrumentation has no prior knowledge of. Development
change_email The token is for changing the user email address. Development
change_phone_number The token is for changing a user phone number. Development
email_confirmation The token is for confirming user email address. Development
reset_password The token is for resetting a user password. Development
two_factor The token is for changing user two factor settings. Development

aspnetcore.identity.token_verified has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
failure Token verification failed. Development
success Token verification was successful. Development

aspnetcore.identity.user.update_type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
_OTHER Any update type that the instrumentation has no prior knowledge of. Development
access_failed Identity user access failure recorded. Development
add_claims Identity user claims added. Development
add_login Identity user login added. Development
add_password Identity user password added. Development
add_to_roles Identity user added to roles. Development
change_email Identity user email changed. Development
change_password Identity user password changed. Development
change_phone_number Identity user phone number changed. Development
confirm_email Identity user email confirmed. Development
generate_new_two_factor_recovery_codes Identity user new two-factor recovery codes generated. Development
password_rehash Identity user password rehashed. Development
redeem_two_factor_recovery_code Identity user two-factor recovery code redeemed. Development
remove_authentication_token Identity user authentication token removed. Development
remove_claims Identity user claims removed. Development
remove_from_roles Identity user removed from roles. Development
remove_login Identity user login removed. Development
remove_passkey Identity user passkey removed. Development
remove_password Identity user password removed. Development
replace_claim Identity user claim replaced. Development
reset_access_failed_count Identity user access failure count reset. Development
reset_authenticator_key Identity user authenticator key reset. Development
reset_password Identity user password reset. Development
security_stamp Identity user security stamp updated. Development
set_authentication_token Identity user authentication token set. Development
set_email Identity user email set. Development
set_lockout_enabled Identity user lockout enabled or disabled. Development
set_lockout_end_date Identity user lockout end date set. Development
set_passkey Identity user passkey set. Development
set_phone_number Identity user phone number set. Development
set_two_factor_enabled Identity user two-factor authentication enabled or disabled. Development
update Identity user updated. Development
user_name Identity user name updated. Development

aspnetcore.rate_limiting.result has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
acquired Lease was acquired Stable
endpoint_limiter Lease request was rejected by the endpoint limiter Stable
global_limiter Lease request was rejected by the global limiter Stable
request_canceled Lease request was canceled Stable

aspnetcore.routing.match_status has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value Description Stability
failure Match failed Stable
success Match succeeded Stable