Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Surveiller les métriques reCAPTCHA
Ce document décrit les métriques reCAPTCHA émises par votre Identity Platform en raison de l'intégration d'Identity Platform à l'API reCAPTCHA Enterprise, et explique comment les afficher avec Cloud Monitoring.
Métriques reCAPTCHA
Une fois que vous avez configuré l'intégration d'Identity Platform avec l'API reCAPTCHA Enterprise et éventuellement activé reCAPTCHA SMS defense, vous pouvez surveiller les métriques reCAPTCHA émises par votre projet pour vous assurer que vos flux d'authentification sont protégés. Si le provisionnement de clés reCAPTCHA échoue ou si les comptes de service requis n'ont pas été créés, l'authentification reCAPTCHA échoue.
Si vous avez activé la protection contre les bots reCAPTCHA ou reCAPTCHA SMS defense en mode audit, la surveillance des métriques reCAPTCHA vous aidera à déterminer si vous pouvez activer l'application. Avant d'activer l'application, vous devez tenir compte des points suivants:
Si la majorité des requêtes récentes comportent des jetons valides et que le ratio des évaluations PASSED par rapport aux évaluations FAILED_AUDIT ou FAILED_ENFORCE est acceptable pour votre cas d'entreprise, envisagez d'activer l'application.
Si la majorité des requêtes récentes proviennent probablement de clients obsolètes, envisagez d'attendre que davantage d'utilisateurs mettent à jour leur application avant d'activer l'application. L'application de l'intégration d'Identity Platform à l'API reCAPTCHA Enterprise entraîne l'arrêt des versions précédentes de l'application qui ne sont pas intégrées à reCAPTCHA.
Pour vous assurer que les fonctionnalités d'intégration fonctionnent comme prévu, vous pouvez examiner les métriques suivantes que votre projet envoie à Cloud Monitoring.
Cette métrique suit les différents résultats renvoyés par reCAPTCHA. Un résultat est généré si un jeton est présent. Vous pouvez filtrer les évaluations suivantes:
PASSED: indique qu'une requête donnée est autorisée lorsque l'application est activée.
FAILED_AUDIT: indique qu'une requête donnée est refusée lorsque le mode d'audit reCAPTCHA est activé.
FAILED_ENFORCE: indique qu'une requête donnée est refusée lorsque le mode forcé reCAPTCHA est activé.
CLIENT_TYPE_MISSING: indique qu'un type de client est manquant pour une demande donnée lorsque l'application de reCAPTCHA est activée. Cette erreur se produit généralement si une requête a été envoyée à l'aide d'une version obsolète du SDK client qui n'est pas compatible avec reCAPTCHA.
KEYS_MISSING: indique qu'une requête donnée ne peut pas être validée, car Identity Platform ne peut pas récupérer de clés reCAPTCHA valides lorsque l'application de reCAPTCHA est activée.
Cette métrique suit le nombre et l'état des jetons reCAPTCHA reçus par le backend Identity Platform. Vous pouvez filtrer les états suivants:
VALID: indique que le jeton reCAPTCHA transmis est valide.
EXPIRED: indique que le jeton reCAPTCHA transmis a expiré. Un jeton expiré peut indiquer des problèmes de réseau client ou un usage abusif.
DUPLICATE: indique que le jeton reCAPTCHA transmis est un doublon. Un jeton en double peut indiquer des problèmes de réseau client ou une utilisation abusive.
INVALID: indique que le jeton reCAPTCHA transmis n'est pas valide. Un jeton non valide peut indiquer une utilisation abusive.
MISSING: indique que le jeton reCAPTCHA n'existe pas dans la requête donnée. La présence de jetons manquants peut indiquer qu'une application cliente est obsolète.
UNCHECKED: indique que le jeton reCAPTCHA n'a pas été vérifié en raison d'évaluations CLIENT_TYPE_MISSING ou KEYS_MISSING.
Si votre application a été déployée avec succès auprès des utilisateurs, vous verrez du trafic avec des jetons valides. Le nombre de jetons valides est probablement proportionnel au nombre d'utilisateurs qui utilisent votre application mise à jour.
Cette métrique suit la distribution des scores reCAPTCHA. Cela peut vous aider à définir les plages de scores optimales pour la configuration de votre protection contre les robots.
Cette métrique suit la distribution du score de risque de la défense reCAPTCHA par SMS pour un projet Identity Platform donné. Cela peut vous aider à définir les plages de scores optimales pour la configuration de reCAPTCHA SMS defense.
Afficher les métriques reCAPTCHA
Pour afficher les métriques reCAPTCHA avec Cloud Monitoring, procédez comme suit:
Dans la Google Cloud console, accédez à la page Explorateur de métriques.
Dans Sélectionner une métrique, saisissez Locataire Identity Toolkit. Si vous utilisez la multi-propriété, vous pouvez afficher les métriques pour chaque locataire, ainsi que pour le projet parent, en laissant tenant_name vide.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/04 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/04 (UTC)."],[[["\u003cp\u003eThis document details how to monitor reCAPTCHA metrics emitted by Identity Platform after integrating with the reCAPTCHA Enterprise API, including optional SMS toll fraud protection.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eidentitytoolkit.googleapis.com/recaptcha/verdict_count\u003c/code\u003e metric tracks verdicts like \u003ccode\u003ePASSED\u003c/code\u003e, \u003ccode\u003eFAILED_AUDIT\u003c/code\u003e, \u003ccode\u003eFAILED_ENFORCE\u003c/code\u003e, \u003ccode\u003eCLIENT_TYPE_MISSING\u003c/code\u003e, and \u003ccode\u003eKEYS_MISSING\u003c/code\u003e, which indicate the success or failure of reCAPTCHA checks.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eidentitytoolkit.googleapis.com/recaptcha/token_count\u003c/code\u003e metric tracks the status of reCAPTCHA tokens received, including \u003ccode\u003eVALID\u003c/code\u003e, \u003ccode\u003eEXPIRED\u003c/code\u003e, \u003ccode\u003eDUPLICATE\u003c/code\u003e, \u003ccode\u003eINVALID\u003c/code\u003e, \u003ccode\u003eMISSING\u003c/code\u003e, and \u003ccode\u003eUNCHECKED\u003c/code\u003e statuses.\u003c/p\u003e\n"],["\u003cp\u003eMonitoring \u003ccode\u003eidentitytoolkit.googleapis.com/recaptcha/risk_scores\u003c/code\u003e and \u003ccode\u003eidentitytoolkit.googleapis.com/recaptcha/sms_tf_risk_scores\u003c/code\u003e helps define optimal score ranges for bot and SMS toll fraud protection configurations.\u003c/p\u003e\n"],["\u003cp\u003eTo view these metrics, you can access the Metrics Explorer in the Google Cloud console and search for "Identity Toolkit Tenant".\u003c/p\u003e\n"]]],[],null,["# Monitor reCAPTCHA metrics\n=========================\n\nThis document describes the reCAPTCHA metrics that your\nIdentity Platform emits as a result of the Identity Platform integration with the reCAPTCHA Enterprise API and how to\nview them with Cloud Monitoring.\n\nreCAPTCHA metrics\n-----------------\n\nAfter you [set up the\nIdentity Platform integration with the reCAPTCHA Enterprise API](/identity-platform/docs/recaptcha-enterprise), and\noptionally, [enable\nreCAPTCHA SMS defense](/identity-platform/docs/recaptcha-tfp), you\ncan monitor the reCAPTCHA metrics your project emits to ensure\nthat your authentication flows are protected. If reCAPTCHA\nkey provisioning fails or if required service accounts weren't created,\nreCAPTCHA authentication fails open.\n\nIf you've enabled reCAPTCHA bot protection or reCAPTCHA SMS defense in\naudit mode, monitoring the reCAPTCHA metrics will help you\ndetermine if you can enable enforcement. You should consider the following\nbefore enabling enforcement:\n\n- If the majority of recent requests have valid tokens and the ratio of `PASSED` to `FAILED_AUDIT` or `FAILED_ENFORCE` verdicts is acceptable for your business case, consider enabling enforcement.\n- If a majority of the recent requests are likely from outdated clients, consider waiting for more users to update their app before enabling enforcement. Enforcing Identity Platform integration with the reCAPTCHA Enterprise API breaks prior app versions that are not integrated with reCAPTCHA.\n\nTo ensure that the integration features are working as intended, you can examine\nthe following metrics your project emits to Cloud Monitoring.\n\n### `identitytoolkit.googleapis.com/recaptcha/verdict_count`\n\nThis metric tracks the different verdicts returned by reCAPTCHA. A\nverdict is generated if a token is present. You can filter on the following\nverdicts:\n\n- `PASSED`: Indicates that a given request is allowed when enforcement is enabled.\n- `FAILED_AUDIT`: Indicates that a given request is denied when reCAPTCHA audit mode is enabled.\n- `FAILED_ENFORCE`: Indicates that a given request is denied when reCAPTCHA enforcement mode is enabled.\n- `CLIENT_TYPE_MISSING`: Indicates that a given request has a missing client type when reCAPTCHA enforcement is enabled. This error typically occurs if a request was sent using an outdated client SDK version that does not have reCAPTCHA support.\n- `KEYS_MISSING`: Indicates that a given request can't be verified because Identity Platform can't retrieve valid reCAPTCHA keys when reCAPTCHA enforcement is enabled.\n\nTo modify your score ranges to change the ratio of passed-to-failed verdicts,\nsee [Enable reCAPTCHA bot protection](/identity-platform/docs/recaptcha-enterprise#enable).\n\n### `identitytoolkit.googleapis.com/recaptcha/token_count`\n\nThis metric tracks the number and status of reCAPTCHA tokens received\nby the Identity Platform backend. You can filter on the following statuses:\n\n- `VALID`: Indicates that the reCAPTCHA token passed in is valid.\n- `EXPIRED`: Indicates that the reCAPTCHA token passed in has expired. An expired token might indicate client network issues or abuse.\n- `DUPLICATE`: Indicates that the reCAPTCHA token passed in is a duplicate. A duplicate token might indicate client network issues or abuse.\n- `INVALID`: Indicates that the reCAPTCHA token passed in is invalid. An invalid token might indicate abuse.\n- `MISSING`: Indicates that the reCAPTCHA token doesn't exist in the given request. Missing tokens might indicate an outdated client app.\n- `UNCHECKED`: Indicates that the reCAPTCHA token was not checked due to `CLIENT_TYPE_MISSING` or `KEYS_MISSING` verdicts.\n\nIf your app rolled out successfully to users, you will see traffic with valid\ntokens. The number of valid tokens is likely proportional to the number of users\nwho are using your updated app.\n\n### `identitytoolkit.googleapis.com/recaptcha/risk_scores`\n\nThis metric tracks the reCAPTCHA score distribution. This can\nhelp you define the optimal score ranges for your bot protection configuration.\n\n### `identitytoolkit.googleapis.com/recaptcha/sms_tf_risk_scores`\n\nThis metric tracks the reCAPTCHA SMS defense risk score\ndistribution for a particular Identity Platform project. This can help you define the optimal score ranges for your reCAPTCHA SMS defense configuration.\n\nView reCAPTCHA metrics\n----------------------\n\nTo view the reCAPTCHA metrics with Cloud Monitoring, do the\nfollowing:\n\n1. In the Google Cloud console, go to the **Metrics explorer** page.\n\n [Go to Metrics explorer](https://console.cloud.google.com/monitoring/metrics-explorer)\n2. From **Select a metric** , enter **Identity Toolkit Tenant** . If you are\n using multi-tenancy, you can view metrics for each tenant, as well as the\n parent project, by leaving `tenant_name` empty.\n\nWhat's next\n-----------\n\n- Learn how to [troubleshoot common\n issues](/identity-platform/docs/recaptcha-troubleshooting) with the reCAPTCHA integration."]]
