监控 reCAPTCHA 指标

本文档介绍了 Identity Platform 与 reCAPTCHA Enterprise API 集成后，Identity Platform 发出的 reCAPTCHA 指标，以及如何使用 Cloud Monitoring 查看这些指标。

reCAPTCHA 指标

设置 Identity Platform 与 reCAPTCHA Enterprise API 的集成，并视需要启用 reCAPTCHA SMS defense 后，您可以监控项目发出的 reCAPTCHA 指标，以确保身份验证流程受到保护。如果 reCAPTCHA 密钥预配失败，或者未创建所需的服务账号，则 reCAPTCHA 身份验证会故障开放。

如果您已在审核模式下为电子邮件密码身份验证流程启用 reCAPTCHA 机器人防护，则监控 reCAPTCHA 指标有助于您确定是否可以启用强制执行。在启用强制执行之前，您应考虑以下事项：

  • 如果大多数近期请求都具有有效令牌，并且 PASSED 与 FAILED_AUDIT 或 FAILED_ENFORCE 判定的比率对于您的业务用例而言是可以接受的，请考虑启用强制执行。
  • 如果近期请求中有很大一部分可能来自已过时的客户端，请考虑等待更多用户更新应用之后，再启用强制执行。强制执行 Identity Platform 与 reCAPTCHA Enterprise API 的集成会破坏未与 reCAPTCHA 集成的先前应用版本。

为确保集成功能按预期运行，您可以检查项目向 Cloud Monitoring 发出的以下指标。

identitytoolkit.googleapis.com/recaptcha/verdict_count

此指标会跟踪 reCAPTCHA 返回的不同判定结果。如果存在令牌，系统会生成判定结果。您可以按以下判定结果进行过滤：

  • PASSED：表示在启用强制执行时，允许执行给定请求。
  • FAILED_AUDIT：表示在启用 reCAPTCHA 审核模式时，给定的电子邮件密码身份验证请求将被拒绝。
  • FAILED_ENFORCE：表示启用 reCAPTCHA 强制执行后，给定请求会被拒绝。
  • CLIENT_TYPE_MISSING：表示在启用 reCAPTCHA 强制执行时，给定请求缺少客户端类型。如果请求是使用不支持 reCAPTCHA 的过时客户端 SDK 版本发送的，通常会发生此错误。
  • KEYS_MISSING：表示无法验证给定请求，因为在启用 reCAPTCHA 强制执行时，Identity Platform 无法检索有效的 reCAPTCHA 密钥。

如需修改分数范围以更改通过与失败判定的比例，请参阅启用 reCAPTCHA 漫游器防护。

identitytoolkit.googleapis.com/recaptcha/token_count

此指标跟踪 Identity Platform 后端收到的 reCAPTCHA 令牌的数量和状态。您可以按以下状态进行过滤：

  • VALID：表示传入的 reCAPTCHA 令牌有效。
  • EXPIRED：表示传入的 reCAPTCHA 令牌已过期。令牌过期可能表示客户端存在网络问题或滥用行为。
  • DUPLICATE：表示传入的 reCAPTCHA 令牌是重复的。重复的令牌可能表示客户端存在网络问题或滥用行为。
  • INVALID：表示传入的 reCAPTCHA 令牌无效。令牌无效可能表示存在滥用行为。
  • MISSING：表示给定请求中不存在 reCAPTCHA 令牌。缺少令牌可能表示客户端应用已过时。
  • UNCHECKED：表示由于 CLIENT_TYPE_MISSING 或 KEYS_MISSING 判定，未检查 reCAPTCHA 令牌。

如果您的应用已成功向用户发布，您会看到带有有效令牌的流量。有效令牌的数量可能与使用更新后应用的用户数量成正比。

identitytoolkit.googleapis.com/recaptcha/risk_scores

此指标跟踪 reCAPTCHA 得分分布。这有助于您为漫游器防护配置定义最佳得分范围。

identitytoolkit.googleapis.com/recaptcha/sms_tf_risk_scores

此指标用于跟踪特定 Identity Platform 项目的 reCAPTCHA SMS defense 风险评分分布。这有助于您为 reCAPTCHA SMS defense 配置定义最佳得分范围。

查看 reCAPTCHA 指标

如需使用 Cloud Monitoring 查看 reCAPTCHA 指标，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 Metrics Explorer 页面。

    转到 Metrics Explorer

  2. 在选择指标中，输入 Identity Toolkit Tenant。如果您使用的是多租户，则可以将 tenant_name 留空，以查看每个租户以及父级项目的指标。

后续步骤