Monitorize as métricas do reCAPTCHA

Este documento descreve as métricas do reCAPTCHA que a Identity Platform emite como resultado da integração da Identity Platform com a API reCAPTCHA Enterprise e como as ver 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 defesa por SMS do reCAPTCHA, pode monitorizar as métricas do reCAPTCHA que o seu projeto emite para garantir que os fluxos de autenticação estão protegidos. Se o aprovisionamento da chave do reCAPTCHA falhar ou se as contas de serviço necessárias não tiverem sido criadas, a autenticação do reCAPTCHA falha.

Se ativou a proteção contra bots do reCAPTCHA ou a defesa por SMS do reCAPTCHA no modo de auditoria, a monitorização das métricas do reCAPTCHA ajuda a determinar se pode ativar a aplicação. Deve considerar o seguinte antes de ativar a aplicação:

  • Se a maioria dos pedidos recentes tiver tokens válidos e a proporção de veredictos PASSED para FAILED_AUDIT ou FAILED_ENFORCE for aceitável para o seu caso empresarial, pondere ativar a aplicação.
  • Se a maioria dos pedidos recentes for provavelmente de clientes desatualizados, considere aguardar que mais utilizadores atualizem a respetiva app antes de ativar a aplicação. A aplicação da integração da Identity Platform com a API reCAPTCHA Enterprise interrompe as versões anteriores da app que não estão integradas com o reCAPTCHA.

Para garantir que as funcionalidades de integração estão a funcionar conforme esperado, pode examinar as seguintes métricas que o seu projeto emite para o Cloud Monitoring.

identitytoolkit.googleapis.com/recaptcha/verdict_count

Esta métrica acompanha os diferentes veredictos devolvidos pelo reCAPTCHA. É gerado um veredito se estiver presente um token. Pode filtrar os seguintes veredictos:

  • PASSED: indica que um determinado pedido é permitido quando a aplicação é ativada.
  • FAILED_AUDIT: indica que um determinado pedido é recusado quando o modo de auditoria do reCAPTCHA está ativado.
  • FAILED_ENFORCE: indica que um determinado pedido é recusado quando o modo de aplicação do reCAPTCHA está ativado.
  • CLIENT_TYPE_MISSING: indica que um determinado pedido tem um tipo de cliente em falta quando a aplicação do reCAPTCHA está ativada. Este erro ocorre normalmente se um pedido tiver sido enviado através de uma versão desatualizada do SDK do cliente que não tem suporte do reCAPTCHA.
  • KEYS_MISSING: indica que não é possível validar um determinado pedido porque o Identity Platform não consegue obter chaves reCAPTCHA válidas quando a aplicação do reCAPTCHA está ativada.

Para modificar os intervalos de pontuação de modo a alterar a proporção de veredictos aprovados para reprovados, consulte o artigo Ative a proteção contra bots do reCAPTCHA.

identitytoolkit.googleapis.com/recaptcha/token_count

Esta métrica monitoriza o número e o estado dos tokens do reCAPTCHA recebidos pelo back-end da Identity Platform. Pode filtrar pelos seguintes estados:

  • VALID: indica que o token reCAPTCHA transmitido é válido.
  • EXPIRED: indica que o token reCAPTCHA transmitido expirou. Um token expirado pode indicar problemas de rede do cliente ou abuso.
  • DUPLICATE: indica que o token reCAPTCHA transmitido é um duplicado. Um token duplicado pode indicar problemas de rede do cliente ou abuso.
  • 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 no pedido especificado. A falta de tokens pode indicar uma app de cliente desatualizada.
  • UNCHECKED: indica que o token reCAPTCHA não foi verificado devido a veredictos CLIENT_TYPE_MISSING ou KEYS_MISSING.

Se a implementação da sua app para os utilizadores for bem-sucedida, verá tráfego com tokens válidos. O número de tokens válidos é provavelmente proporcional ao número de utilizadores que estão a usar a sua app atualizada.

identitytoolkit.googleapis.com/recaptcha/risk_scores

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

identitytoolkit.googleapis.com/recaptcha/sms_tf_risk_scores

Esta métrica acompanha a distribuição da pontuação de risco da defesa por SMS do reCAPTCHA para um projeto específico da Identity Platform. Isto pode ajudar a definir os intervalos de pontuação ideais para a configuração de defesa por SMS do reCAPTCHA.

Veja as métricas do reCAPTCHA

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

  1. Na Google Cloud consola, aceda à página Explorador de métricas.

    Aceda ao explorador de métricas

  2. Em Selecionar uma métrica, introduza Inquilino do Identity Toolkit. Se estiver a usar a funcionalidade multi-inquilino, pode ver as métricas de cada inquilino, bem como do projeto principal, deixando tenant_name vazio.

O que se segue?