自提供指标

了解 Keycloak 提供的关键指标

这是使用指标进行故障排除指南的一部分。

先决条件

  • 需要为 Keycloak 启用指标。请参阅通过指标获取洞察指南了解更多详情。

  • 收集指标的监控系统。

指标

用户事件指标

用户事件指标默认禁用。请参阅使用事件指标监控用户活动,了解如何启用它们以及如何配置记录哪些标签。

指标 描述

keycloak_user_events_total

统计用户事件的发生次数。

标签

标签 client_ididp 默认禁用,以避免过高的基数。

realm

client_id

客户端 ID

idp

身份提供商

event

用户事件,例如 loginlogout。有关可用事件的概述,请参阅服务器管理指南中的事件类型

error

事件特定的错误,例如事件 logininvalid_user_credentials。如果没有发生错误,则为空字符串。

以下代码段是指标端点提供的响应示例

# HELP keycloak_user_events_total Keycloak user events
# TYPE keycloak_user_events_total counter
keycloak_user_events_total{client_id="security-admin-console",error="",event="code_to_token",idp="",realm="master",} 1.0
keycloak_user_events_total{client_id="security-admin-console",error="",event="login",idp="",realm="master",} 1.0
keycloak_user_events_total{client_id="security-admin-console",error="",event="logout",idp="",realm="master",} 1.0
keycloak_user_events_total{client_id="security-admin-console",error="invalid_user_credentials",event="login",idp="",realm="master",} 1.0

密码哈希

指标 描述

keycloak_credentials_password_hashing_validations_total

统计密码哈希验证次数。

标签

realm

algorithm

用于哈希密码的算法,例如 argon2

hashing_strength

表示哈希算法强度的字符串,例如,取决于算法的迭代次数。例如,Argon2id-1.3[m=7168,t=5,p=1]

outcome

密码验证的结果。可能的值

valid

密码正确

invalid

密码不正确

error

创建密码哈希时出错

要配置哪些标签可用,请为以下选项 spi-credential-keycloak-password-validations-counter-tags 提供逗号分隔的标签名称列表。默认情况下,所有标签均已启用。

以下代码段是指标端点提供的响应示例

# HELP keycloak_credentials_password_hashing_validations_total Password validations
# TYPE keycloak_credentials_password_hashing_validations_total counter
keycloak_credentials_password_hashing_validations_total{algorithm="argon2",hashing_strength="Argon2id-1.3[m=7168,t=5,p=1]",outcome="valid",realm="realm-0",} 39949.0

下一步

在此页