第 3 章 使用事件指标监控用户活动
事件指标提供红帽构建的 Keycloak 实例中用户活动的聚合视图。
目前,只捕获用户事件的指标。例如,您可以监控执行的登录、登录失败或令牌刷新的数量。
指标使用标准指标端点公开,您可以在您自己的指标集合系统中使用它来创建仪表板和警报。
指标报告为每个红帽构建的 Keycloak 实例的计数器。计数器会在实例重启时重置。如果您在一个集群中运行多个实例,则需要从所有实例收集指标并聚合它们以为每个集群视图获取。
3.1. 启用事件指标 复制链接链接已复制到粘贴板!
要开始收集事件指标,请启用指标并启用用户事件的指标。
以下显示了所需的启动参数:
bin/kc.[sh|bat] start --metrics-enabled=true --event-metrics-user-enabled=true ...
bin/kc.[sh|bat] start --metrics-enabled=true --event-metrics-user-enabled=true ...
默认情况下,每个域都有单独的指标。要按客户端和身份提供程序划分指标,您可以使用配置选项 event-metrics-user-tags
添加这些指标维度。这对带有少量客户端和 IDP 的安装很有用。对于有大量客户端或 IDP 的安装,我们不建议这样做,因为它会增加红帽构建的 Keycloak 的内存用量,因为它会增加监控系统的负载。
下面显示了如何配置红帽构建的 Keycloak,以破坏所有三个指标维度的指标:
bin/kc.[sh|bat] start ... --event-metrics-user-tags=realm,idp,clientId ...
bin/kc.[sh|bat] start ... --event-metrics-user-tags=realm,idp,clientId ...
您可以限制红帽构建的 Keycloak 将公开指标的事件。有关可用 事件概述,请参阅有关事件类型的服务器管理指南。
以下示例将收集的事件限制为 LOGIN
和 LOGOUT
事件:
bin/kc.[sh|bat] start ... --event-metrics-user-events=login,logout ...
bin/kc.[sh|bat] start ... --event-metrics-user-events=login,logout ...
有关收集的指标描述,请参阅 自助提供的指标。