La télémétrie de diagnostic et l'analyse des erreurs vous permettent d'identifier et de résoudre les échecs de requêtes dans les API Google et les Cloud de Confiance by S3NS API. Vous pouvez inspecter les métriques d'utilisation des API, les journaux côté client, Cloud Audit Logs et les réponses d'erreur structurées pour diagnostiquer les causes fondamentales dans vos applications.
Arrière-plan
Les API Google sont des API en réseau fournies par les services Google. Les applications peuvent accéder aux API Google via JSON HTTP et gRPC à partir de différents environnements. Nous recommandons aux développeurs d'utiliser les bibliothèques clientes fournies par Google dans leurs applications. Ces bibliothèques mettent en œuvre une logique récurrente, telle que l'authentification et la pagination de listes, ce qui réduit considérablement les coûts de développement et les erreurs courantes.
Pour en savoir plus, consultez la section Présentation des bibliothèques clientes.
Premiers pas
Si vous n'avez jamais utilisé les API Google, suivez la
page Premiers pas pour effectuer les
étapes de préparation de votre application. Vous devez d'abord utiliser la commande curl -v pour envoyer des requêtes de test aux API Google que vous souhaitez utiliser.
Elle vous permet de tester les API Google sans écrire de code.
Vous pouvez souvent résoudre de nombreux problèmes avant même de commencer à développer réellement des applications.
Pour plus d'informations, consultez le Guide de démarrage.
Dépannage à l'aide des métriques
Les API Google fournissent des métriques d'API sans frais qui couvrent les aspects courants de l'utilisation des API, y compris le nombre de requêtes, les erreurs, les latences, ainsi que les tailles des requêtes et des réponses. Elles fournissent des mesures précises en termes d'applications et d'emplacements. Les développeurs peuvent découvrir une utilisation anormale des API et identifier les causes fondamentales potentielles. Par exemple, des erreurs 400 plus élevées peut signifier qu'une application récemment mise à jour présente des bugs logiques, ou que des tailles de requête et de réponse plus élevées peuvent ralentir les performances de l'application.
Pour en savoir plus, consultez la section Surveiller l'utilisation des API.
Dépannage à l'aide des journaux
Pour des raisons de sécurité et de confidentialité, les API Google ne fournissent généralement pas de journaux d'API aux développeurs d'applications. Nous recommandons vivement aux développeurs d'applications de consigner les erreurs d'API côté client. Vous pouvez consigner les erreurs dans un espace de stockage local ou dans une API de journalisation distante, telle que l'API Cloud Logging.
Les journaux contiennent généralement plus d'informations sur les erreurs que sur les métriques, telles que les messages d'erreur et les détails des erreurs. Ils sont extrêmement utiles et souvent nécessaires pour résoudre les problèmes liés à des erreurs d'API. Lorsque les développeurs remarquent un problème concernant leur utilisation de l'API, ils peuvent interroger les journaux pour rechercher les messages d'erreur et les détails des erreurs, et utiliser les informations pour résoudre les erreurs ou contacter l'assistance.
Cloud Audit Logs
Pour les activités sensibles en termes de sécurité, les produits Google Cloud peuvent générer des journaux d'audit contenant des informations détaillées sur les activités. Ils constituent une excellente source d'informations pour résoudre les problèmes liés à votre utilisation des API Google Cloud. Par exemple, VPC Service Controls fonctionnalité d'essai à sec génère des journaux d'audit permettant aux administrateurs d'évaluer les prochaines modifications de la règle.
Pour en savoir plus, consultez la page Journaux d'audit Cloud.
Résoudre les erreurs
Si vous rencontrez des problèmes avec votre utilisation des API Google et que vous avez trouvé les métriques et les journaux correspondants, vous pouvez suivre la page Erreurs du Guide de conception d'API pour résoudre les erreurs.
En général, chaque erreur d'API comporte trois informations, le code d'erreur, le message d'erreur et les détails de l'erreur :
- Le code d'erreur permet aux applications de gérer l'erreur au niveau supérieur, comme une nouvelle tentative après les erreurs
503ou une réauthentification des utilisateurs après les erreurs401. Le message d'erreur permet aux développeurs d'applications de comprendre l'erreur et de corriger leur logique d'application.
Les détails de l'erreur contiennent des informations supplémentaires que les applications peuvent utiliser pour gérer l'erreur de manière automatisée.
Pour en savoir plus, consultez la page Erreurs.