ASP.NET Core 指标的语义约定
状态: 稳定
本文档定义了 ASP.NET Core 指标的语义约定。
服务器
路由
所有路由指标均由 Microsoft.AspNetCore.Routing 指标报告。
指标: aspnetcore.routing.match_attempts
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.routing.match_attempts | Counter | {match_attempt} | 尝试匹配到端点的请求数量。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Routing; 添加于: ASP.NET Core 8.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.routing.match_status | 必需 | 字符串 | 匹配结果 - 成功或失败 | success; failure | |
aspnetcore.routing.is_fallback | 当且仅当路由成功匹配时,条件必需。 | 布尔值 | 指示匹配的路由是否为回退路由的值。 | true | |
http.route | 当且仅当路由成功匹配时,条件必需。 | 字符串 | 请求的匹配路由模板。此项必须具有低基数,并包含所有静态路径段,动态路径段用占位符表示。 [1] | /users/:userID?; my-controller/my-action/{id?} |
[1] http.route: 当 HTTP 服务器框架不支持时,不得填充此项,因为路由属性应具有低基数,并且 URI 路径无法替代它。如果存在应用程序根目录,则应包含 应用程序根目录。
静态路径段是路由模板中具有固定、低基数值的ส่วน。这包括字面字符串,如 /users/,以及受限于有限、预定义值集合的占位符,例如 {controller} 或 {action}。
动态路径段是占位符,用于存储具有高基数且不受预定义列表约束的值,就像静态路径段一样。
仪器应使用相应 Web 框架提供的路由信息。它们应选择最精确的路由信息来源,并可以支持自定义路由格式。仪器应记录使用的格式和获取路由字符串的 API。
aspnetcore.routing.match_status 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 匹配失败 | |
success | 匹配成功 |
异常
异常指标由 Microsoft.AspNetCore.Diagnostics 指标报告。
指标: aspnetcore.diagnostics.exceptions
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.diagnostics.exceptions | Counter | {exception} | 由异常处理中间件捕获的异常数量。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Diagnostics; 添加于: ASP.NET Core 8.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.diagnostics.exception.result | 必需 | 字符串 | ASP.NET Core 异常中间件处理结果。 | handled; unhandled | |
error.type | 必需 | 字符串 | 异常类型的全名。 | System.OperationCanceledException; Contoso.MyException | |
aspnetcore.diagnostics.handler.type | 有条件地必需 [1] | 字符串 | 处理异常的 IExceptionHandler 实现的完整类型名称。 | Contoso.MyHandler |
[1] aspnetcore.diagnostics.handler.type: 仅当异常由此处理程序处理时。
aspnetcore.diagnostics.exception.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
aborted | 由于请求被中止,异常处理未运行。 | |
handled | 异常已由异常处理中间件处理。 | |
skipped | 由于响应已启动,异常处理被跳过。 | |
unhandled | 异常未由异常处理中间件处理。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
速率限制
所有速率限制指标均由 Microsoft.AspNetCore.RateLimiting 指标报告。
指标: aspnetcore.rate_limiting.active_request_leases
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.active_request_leases | UpDownCounter | {request} | 服务器上当前持有速率限制租约的活动请求数量。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.RateLimiting; 添加于: ASP.NET Core 8.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.policy | 有条件地必需 [1] | 字符串 | 速率限制策略名称。 | fixed; sliding; token |
[1] aspnetcore.rate_limiting.policy: 如果请求的匹配端点具有速率限制策略。
指标: aspnetcore.rate_limiting.request.lease.duration
此指标应使用 ExplicitBucketBoundaries [ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ] 进行指定。
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.request.lease.duration | Histogram | s | 服务器上请求持有的速率限制租约的持续时间。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.RateLimiting; 添加于: ASP.NET Core 8.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.policy | 有条件地必需 [1] | 字符串 | 速率限制策略名称。 | fixed; sliding; token |
[1] aspnetcore.rate_limiting.policy: 如果请求的匹配端点具有速率限制策略。
指标: aspnetcore.rate_limiting.queued_requests
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.queued_requests | UpDownCounter | {request} | 当前排队等待获取速率限制租约的请求数量。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.RateLimiting; 添加于: ASP.NET Core 8.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.policy | 有条件地必需 [1] | 字符串 | 速率限制策略名称。 | fixed; sliding; token |
[1] aspnetcore.rate_limiting.policy: 如果请求的匹配端点具有速率限制策略。
指标: aspnetcore.rate_limiting.request.time_in_queue
此指标应使用 ExplicitBucketBoundaries [ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ] 进行指定。
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.request.time_in_queue | Histogram | s | 请求在队列中等待获取速率限制租约所花费的时间。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.RateLimiting; 添加于: ASP.NET Core 8.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.result | 必需 | 字符串 | 速率限制结果,显示租约是否已获取或包含拒绝原因 | acquired; request_canceled | |
aspnetcore.rate_limiting.policy | 有条件地必需 [1] | 字符串 | 速率限制策略名称。 | fixed; sliding; token |
[1] aspnetcore.rate_limiting.policy: 如果请求的匹配端点具有速率限制策略。
aspnetcore.rate_limiting.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
acquired | 已获取租约 | |
endpoint_limiter | 租约请求被端点限制器拒绝 | |
global_limiter | 租约请求被全局限制器拒绝 | |
request_canceled | 租约请求已取消 |
指标: aspnetcore.rate_limiting.requests
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.requests | Counter | {request} | 尝试获取速率限制租约的请求数量。 [1] |
[1]: 请求可能是
- 被全局或端点速率限制策略拒绝
- 等待租约期间被取消。
指标名称: Microsoft.AspNetCore.RateLimiting; 添加于: ASP.NET Core 8.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.rate_limiting.result | 必需 | 字符串 | 速率限制结果,显示租约是否已获取或包含拒绝原因 | acquired; request_canceled | |
aspnetcore.rate_limiting.policy | 有条件地必需 [1] | 字符串 | 速率限制策略名称。 | fixed; sliding; token |
[1] aspnetcore.rate_limiting.policy: 如果请求的匹配端点具有速率限制策略。
aspnetcore.rate_limiting.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
acquired | 已获取租约 | |
endpoint_limiter | 租约请求被端点限制器拒绝 | |
global_limiter | 租约请求被全局限制器拒绝 | |
request_canceled | 租约请求已取消 |
内存池
所有内存池指标均由 Microsoft.AspNetCore.MemoryPool 指标报告。
指标: aspnetcore.memory_pool.pooled
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.memory_pool.pooled | UpDownCounter | 每个调用的最大内存使用量的分布。 | 当前池化并可供重用的字节数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.MemoryPool; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.memory_pool.owner | 有条件地必需 [1] | 字符串 | 使用内存池实例的库或子系统的名称。 | kestrel; iis |
[1] aspnetcore.memory_pool.owner: 如果在创建内存池时指定了所有者。
指标: aspnetcore.memory_pool.evicted
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.memory_pool.evicted | Counter | 每个调用的最大内存使用量的分布。 | 从内存池中逐出的总字节数。当空闲池化内存被回收时发生逐出。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.MemoryPool; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.memory_pool.owner | 有条件地必需 [1] | 字符串 | 使用内存池实例的库或子系统的名称。 | kestrel; iis |
[1] aspnetcore.memory_pool.owner: 如果在创建内存池时指定了所有者。
指标: aspnetcore.memory_pool.allocated
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.memory_pool.allocated | Counter | 每个调用的最大内存使用量的分布。 | 内存池分配的总字节数。当内存租用请求超过可用池化内存时发生分配。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.MemoryPool; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.memory_pool.owner | 有条件地必需 [1] | 字符串 | 使用内存池实例的库或子系统的名称。 | kestrel; iis |
[1] aspnetcore.memory_pool.owner: 如果在创建内存池时指定了所有者。
指标: aspnetcore.memory_pool.rented
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.memory_pool.rented | Counter | 每个调用的最大内存使用量的分布。 | 从内存池租用的总字节数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.MemoryPool; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.memory_pool.owner | 有条件地必需 [1] | 字符串 | 使用内存池实例的库或子系统的名称。 | kestrel; iis |
[1] aspnetcore.memory_pool.owner: 如果在创建内存池时指定了所有者。
身份验证
所有身份验证指标均由 Microsoft.AspNetCore.Authentication 指标报告。
指标: aspnetcore.authentication.authenticate.duration
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.authentication.authenticate.duration | Histogram | s | 请求的身份验证持续时间。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Authentication; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.result | 必需 | 字符串 | 身份验证操作的结果。 | success; failure | |
aspnetcore.authentication.scheme | 如果在身份验证期间指定了方案,则为条件必需。 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
aspnetcore.authentication.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 身份验证失败。 | |
无 | 未返回身份验证信息。 | |
success | 身份验证成功。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.authentication.challenges
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.authentication.challenges | Counter | {challenge} | 方案被挑战的总次数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Authentication; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.scheme | 如果在身份验证期间指定了方案,则为条件必需。 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.authentication.forbids
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.authentication.forbids | Counter | {forbid} | 经过身份验证的用户尝试访问其无权访问的资源的次数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Authentication; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.scheme | 如果在身份验证期间指定了方案,则为条件必需。 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.authentication.sign_ins
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.authentication.sign_ins | Counter | {sign_in} | 使用方案登录主体的总次数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Authentication; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.scheme | 如果在身份验证期间指定了方案,则为条件必需。 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.authentication.sign_outs
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.authentication.sign_outs | Counter | {sign_out} | 使用方案退出登录主体的总次数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Authentication; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.scheme | 如果在身份验证期间指定了方案,则为条件必需。 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
授权
所有授权指标均由 Microsoft.AspNetCore.Authorization 指标报告。
指标: aspnetcore.authorization.attempts
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.authorization.attempts | Counter | {attempt} | 授权尝试的总次数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Authorization; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.user.is_authenticated | 必需 | 布尔值 | 指示用户是否已通过身份验证的值。 | true | |
aspnetcore.authorization.policy | 如果指定了策略,则为条件必需。 | 字符串 | 授权策略的名称。 | RequireAdminRole | |
aspnetcore.authorization.result | 如果没有抛出异常,则为条件必需。 | 字符串 | 调用授权服务的结果。 | success; failure | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
aspnetcore.authorization.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 授权失败。 | |
success | 授权成功。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
标识
所有 ASP.NET Core Identity 指标均由 Microsoft.AspNetCore.Identity 指标报告。
指标: aspnetcore.identity.user.create.duration
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.user.create.duration | Histogram | s | 用户创建操作的持续时间。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
aspnetcore.identity.error_code | 如果失败的身份验证结果设置了错误,则为条件必需。 | 字符串 | 失败的身份验证操作的错误代码。 | DefaultError; PasswordMismatch | |
aspnetcore.identity.result | 如果没有抛出异常,则为条件必需。 | 字符串 | 身份验证操作的结果。 | success; failure | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名或身份验证错误代码。 | System.OperationCanceledException; PasswordMismatch |
aspnetcore.identity.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 身份验证操作失败。 | |
success | 身份验证操作成功。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.user.update.duration
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.user.update.duration | Histogram | s | 用户更新操作的持续时间。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.identity.user.update_type | 必需 | 字符串 | 用户更新类型。 | update; user_name; reset_password | |
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
aspnetcore.identity.error_code | 如果失败的身份验证结果设置了错误,则为条件必需。 | 字符串 | 失败的身份验证操作的错误代码。 | DefaultError; PasswordMismatch | |
aspnetcore.identity.result | 如果没有抛出异常,则为条件必需。 | 字符串 | 身份验证操作的结果。 | success; failure | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名或身份验证错误代码。 | System.OperationCanceledException; PasswordMismatch |
aspnetcore.identity.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 身份验证操作失败。 | |
success | 身份验证操作成功。 |
aspnetcore.identity.user.update_type 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 仪器仪表事先不知道的任何更新类型。 | |
access_failed | 记录了身份验证用户访问失败。 | |
add_claims | 添加了身份验证用户声明。 | |
add_login | 添加了身份验证用户登录。 | |
add_password | 添加了身份验证用户密码。 | |
add_to_roles | 将身份验证用户添加到角色。 | |
change_email | 更改了身份验证用户电子邮件。 | |
change_password | 更改了身份验证用户密码。 | |
change_phone_number | 更改了身份验证用户电话号码。 | |
confirm_email | 确认了身份验证用户电子邮件。 | |
generate_new_two_factor_recovery_codes | 生成了身份验证用户的新双因素恢复代码。 | |
password_rehash | 对身份验证用户密码进行了重新哈希。 | |
redeem_two_factor_recovery_code | 兑换了身份验证用户双因素恢复代码。 | |
remove_authentication_token | 移除了身份验证用户身份验证令牌。 | |
remove_claims | 移除了身份验证用户声明。 | |
remove_from_roles | 将身份验证用户从角色中移除。 | |
remove_login | 移除了身份验证用户登录。 | |
remove_passkey | 移除了身份验证用户通行密钥。 | |
remove_password | 移除了身份验证用户密码。 | |
replace_claim | 替换了身份验证用户声明。 | |
reset_access_failed_count | 重置了身份验证用户访问失败计数。 | |
reset_authenticator_key | 重置了身份验证用户身份验证器密钥。 | |
reset_password | 重置了身份验证用户密码。 | |
security_stamp | 更新了身份验证用户安全戳。 | |
set_authentication_token | 设置了身份验证用户身份验证令牌。 | |
set_email | 设置了身份验证用户电子邮件。 | |
set_lockout_enabled | 启用或禁用了身份验证用户锁定。 | |
set_lockout_end_date | 设置了身份验证用户锁定结束日期。 | |
set_passkey | 设置了身份验证用户通行密钥。 | |
set_phone_number | 设置了身份验证用户电话号码。 | |
set_two_factor_enabled | 启用或禁用了身份验证用户双因素身份验证。 | |
update | 更新了身份验证用户。 | |
user_name | 更新了身份验证用户名。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.user.delete.duration
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.user.delete.duration | Histogram | s | 用户删除操作的持续时间。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
aspnetcore.identity.error_code | 如果失败的身份验证结果设置了错误,则为条件必需。 | 字符串 | 失败的身份验证操作的错误代码。 | DefaultError; PasswordMismatch | |
aspnetcore.identity.result | 如果没有抛出异常,则为条件必需。 | 字符串 | 身份验证操作的结果。 | success; failure | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名或身份验证错误代码。 | System.OperationCanceledException; PasswordMismatch |
aspnetcore.identity.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 身份验证操作失败。 | |
success | 身份验证操作成功。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.user.check_password_attempts
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.user.check_password_attempts | Counter | {attempt} | 检查密码尝试的次数。仅检查密码是否有效,而不检查用户帐户是否处于可登录状态。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
aspnetcore.identity.password_check_result | 如果没有抛出异常,则为条件必需。 | 字符串 | 检查密码的结果。 | success; failure | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
aspnetcore.identity.password_check_result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 密码检查失败。 | |
password_missing | 由于用户缺少密码,密码检查无法继续。 | |
success | 密码检查成功。 | |
success_rehash_needed | 密码检查成功,但密码使用的是已弃用的算法编码,应重新哈希并更新。 | |
user_missing | 由于用户丢失,密码检查无法继续。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.user.generated_tokens
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.user.generated_tokens | Counter | {count} | 生成的令牌总数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.identity.token_purpose | 必需 | 字符串 | 令牌将用于什么。 | success; failure | |
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
aspnetcore.identity.token_purpose 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 仪器仪表事先不知道的任何令牌用途。 | |
change_email | 令牌用于更改用户电子邮件地址。 | |
change_phone_number | 令牌用于更改用户电话号码。 | |
email_confirmation | 令牌用于确认用户电子邮件地址。 | |
reset_password | 令牌用于重置用户密码。 | |
two_factor | 令牌用于更改用户双因素设置。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.user.verify_token_attempts
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.user.verify_token_attempts | Counter | {attempt} | 令牌验证尝试的总次数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.identity.token_purpose | 必需 | 字符串 | 令牌将用于什么。 | success; failure | |
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
aspnetcore.identity.token_verified | 如果没有抛出异常,则为条件必需。 | 字符串 | 令牌验证结果。 | success; failure | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
aspnetcore.identity.token_purpose 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 仪器仪表事先不知道的任何令牌用途。 | |
change_email | 令牌用于更改用户电子邮件地址。 | |
change_phone_number | 令牌用于更改用户电话号码。 | |
email_confirmation | 令牌用于确认用户电子邮件地址。 | |
reset_password | 令牌用于重置用户密码。 | |
two_factor | 令牌用于更改用户双因素设置。 |
aspnetcore.identity.token_verified 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 令牌验证失败。 | |
success | 令牌验证成功。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.sign_in.authenticate.duration
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.sign_in.authenticate.duration | Histogram | s | 身份验证尝试的持续时间。身份验证指标由 PasswordSignInAsync 和 TwoFactorSignInAsync 等登录方法记录。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.scheme | 必需 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
aspnetcore.identity.sign_in.type | 必需 | 字符串 | 身份验证类型。 | password; two_factor | |
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
aspnetcore.identity.sign_in.result | 如果没有抛出异常,则为条件必需。 | 字符串 | 登录结果是成功还是失败。 | password; two_factor | |
aspnetcore.sign_in.is_persistent | 如果没有抛出异常,则为条件必需。 | 布尔值 | 指示登录是否持久的标志。 | ||
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
aspnetcore.identity.sign_in.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 登录失败。 | |
locked_out | 用户被锁定。 | |
not_allowed | 不允许用户登录。 | |
requires_two_factor | 用户需要双因素身份验证才能登录。 | |
success | 登录成功。 |
aspnetcore.identity.sign_in.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
external | 使用以前注册的第三方登录进行身份验证。 | |
passkey | 使用通行密钥登录。 | |
password | 使用密码登录。 | |
two_factor | 使用双因素提供程序进行身份验证。 | |
two_factor_authenticator | 使用双因素身份验证器应用进行身份验证。 | |
two_factor_recovery_code | 使用双因素恢复代码进行身份验证。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.sign_in.check_password_attempts
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.sign_in.check_password_attempts | Counter | {attempt} | 检查密码尝试的总次数。检查帐户是否处于可登录状态以及密码是否有效,使用 UserManager.CheckPasswordAsync 方法。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
aspnetcore.identity.sign_in.result | 如果没有抛出异常,则为条件必需。 | 字符串 | 登录结果是成功还是失败。 | password; two_factor | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
aspnetcore.identity.sign_in.result 具有以下已知值列表。如果其中一个适用,则必须使用相应的默认值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
failure | 登录失败。 | |
locked_out | 用户被锁定。 | |
not_allowed | 不允许用户登录。 | |
requires_two_factor | 用户需要双因素身份验证才能登录。 | |
success | 登录成功。 |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.sign_in.sign_ins
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.sign_in.sign_ins | Counter | {sign_in} | 登录用户主体的调用总次数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.scheme | 必需 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
aspnetcore.sign_in.is_persistent | 如果没有抛出异常,则为条件必需。 | 布尔值 | 指示登录是否持久的标志。 | ||
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.sign_in.sign_outs
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.sign_in.sign_outs | Counter | {sign_out} | 退出登录用户主体的调用总次数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.scheme | 必需 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.sign_in.two_factor_clients_remembered
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.sign_in.two_factor_clients_remembered | Counter | {client} | 已记住的双因素客户端总数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.scheme | 必需 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |
指标: aspnetcore.identity.sign_in.two_factor_clients_forgotten
| 名称 | Instrument Type | Unit (UCUM) | 描述 | Stability | 实体关联 |
|---|---|---|---|---|---|
aspnetcore.identity.sign_in.two_factor_clients_forgotten | Counter | {client} | 已遗忘的双因素客户端总数。 [1] |
[1]: 指标名称: Microsoft.AspNetCore.Identity; 添加于: ASP.NET Core 10.0
Attributes
| 键 | Stability | 需求级别 | Value Type | 描述 | Example Values |
|---|---|---|---|---|---|
aspnetcore.authentication.scheme | 必需 | 字符串 | 标识特定身份验证处理程序的标识符。 | Cookies; Bearer; Identity.Application | |
aspnetcore.identity.user_type | 必需 | 字符串 | 身份用户类型的全名。 | Contoso.ContosoUser | |
error.type | 如果发生错误,则为条件必需。 | 字符串 | 异常类型的全名。 | System.OperationCanceledException |
error.type 具有以下已知值列表。如果其中一个适用,则必须使用相应的值;否则,可以使用自定义值。
| 值 | 描述 | Stability |
|---|---|---|
_OTHER | 当检测不到自定义值时使用的回退错误值。 |