Monitorar as métricas do reCAPTCHA

Este documento descreve as métricas do reCAPTCHA que o Identity Platform emite como resultado da integração do Identity Platform com a API reCAPTCHA Enterprise e como visualizá-las com o Cloud Monitoring.

Métricas do reCAPTCHA

Depois de configurar a integração da Identity Platform com a API reCAPTCHA Enterprise e, opcionalmente, ativar a proteção contra fraudes de SMS do reCAPTCHA, você poderá monitorar as métricas do reCAPTCHA emitidas pelo seu projeto para garantir que os fluxos de autenticação estejam protegidos. Se o provisionamento de chaves reCAPTCHA falhar ou se as contas de serviço necessárias não forem criadas, a autenticação reCAPTCHA vai falhar.

Se você ativou a proteção contra bots do reCAPTCHA ou a proteção contra fraudes de cobrança por SMS no modo de auditoria, o monitoramento das métricas do reCAPTCHA vai ajudar você a determinar se é possível ativar a aplicação. Considere o seguinte antes de ativar a aplicação:

  • Se a maioria das solicitações recentes tiver tokens válidos e a proporção de vereditos PASSED para FAILED_AUDIT ou FAILED_ENFORCE for aceitável para sua empresa, ative a aplicação.
  • Se a maioria das solicitações recentes for de clientes desatualizados, espere que mais usuários atualizem o app antes de ativar a aplicação. Ativar a integração da plataforma de identidade com a API reCAPTCHA Enterprise quebra versões anteriores do app que não estão integradas ao reCAPTCHA.

Para garantir que os recursos de integração estejam funcionando conforme o esperado, examine as métricas a seguir que seu projeto emite para o Cloud Monitoring.

identitytoolkit.googleapis.com/recaptcha/verdict_count

Essa métrica rastreia os diferentes vereditos retornados pelo reCAPTCHA. Um veredito será gerado se um token estiver presente. É possível filtrar os seguintes veredictos:

  • PASSED: indica que uma determinada solicitação é permitida quando a aplicação é ativada.
  • FAILED_AUDIT: indica que uma solicitação foi negada quando o modo de auditoria do reCAPTCHA está ativado.
  • FAILED_ENFORCE: indica que uma solicitação foi negada quando o modo de aplicação do reCAPTCHA está ativado.
  • CLIENT_TYPE_MISSING: indica que uma determinada solicitação tem um tipo de cliente ausente quando a aplicação do reCAPTCHA está ativada. Esse erro normalmente ocorre quando uma solicitação é enviada usando uma versão desatualizada do SDK do cliente que não tem suporte ao reCAPTCHA.
  • KEYS_MISSING: indica que uma determinada solicitação não pode ser verificada porque o Identity Platform não consegue recuperar chaves reCAPTCHA válidas quando a aplicação do reCAPTCHA está ativada.

Para modificar os intervalos de pontuação e mudar a proporção de vereditos de sucesso e de falha, consulte Ativar a proteção contra bots do reCAPTCHA.

identitytoolkit.googleapis.com/recaptcha/token_count

Essa métrica rastreia o número e o status dos tokens reCAPTCHA recebidos pelo back-end do Identity Platform. É possível filtrar pelos seguintes status:

  • VALID: indica que o token reCAPTCHA transmitido é válido.
  • EXPIRED: indica que o token reCAPTCHA transmitido expirou. Um token expirado pode indicar abuso ou problemas de rede do cliente.
  • DUPLICATE: indica que o token reCAPTCHA transmitido é um duplicado. Um token duplicado pode indicar abuso ou problemas de rede do cliente.
  • INVALID: indica que o token reCAPTCHA transmitido é inválido. Um token inválido pode indicar abuso.
  • MISSING: indica que o token reCAPTCHA não existe na solicitação especificada. Tokens ausentes podem indicar um app cliente desatualizado.
  • UNCHECKED: indica que o token reCAPTCHA não foi verificado devido a vereditos CLIENT_TYPE_MISSING ou KEYS_MISSING.

Se o app foi lançado para os usuários, você vai notar tráfego com tokens válidos. O número de tokens válidos provavelmente é proporcional ao número de usuários que estão usando o app atualizado.

identitytoolkit.googleapis.com/recaptcha/risk_scores

Essa métrica rastreia a distribuição da pontuação do reCAPTCHA. Isso pode ajudar a definir os intervalos de pontuação ideais para a configuração da proteção contra bots.

identitytoolkit.googleapis.com/recaptcha/sms_tf_risk_scores

Essa métrica rastreia a distribuição da pontuação de risco de proteção contra fraudes de pedágio por SMS em um projeto específico do Identity Platform. Isso pode ajudar a definir os intervalos de pontuação ideais para a configuração da proteção contra fraudes de cobrança por SMS.

Conferir as métricas do reCAPTCHA

Para conferir as métricas do reCAPTCHA com o Cloud Monitoring, faça o seguinte:

  1. No Console do Google Cloud, acesse a página do Metrics Explorer.

    Acessar o Metrics Explorer

  2. Em Selecionar uma métrica, insira Identity Toolkit Tenant. Se você estiver usando a multilocação, poderá conferir as métricas de cada locatário, bem como do projeto pai, deixando tenant_name vazio.

A seguir