update_date: 06/01/2023
Google Cloud vous fournit les outils nécessaires pour surveiller la fiabilité de vos projets avec Google Cloud Monitoring et déboguer les problèmes à l'aide des journaux d'erreurs Google Cloud Logging. Chaque fois qu'un échec se produit lors du traitement des intents utilisateur, le pipeline Google Home Analytics enregistre cet échec dans vos métriques et publie un journal d'erreurs dans les journaux de votre projet.
La résolution de ces erreurs s'effectue en deux étapes:
- Surveillez l'état de vos projets avec les métriques pour la maison connectée.
- Examinez les problèmes en consultant les descriptions d'erreurs détaillées dans les journaux d'erreurs.
Erreurs de surveillance
Vous pouvez utiliser des Google Cloud Monitoring dashboard pour accéder aux métriques de votre projet. Certains graphiques clés sont particulièrement utiles pour surveiller la qualité et déboguer:
- Le graphique Success Rate (Taux de réussite) est le premier à démarrer lorsque vous surveillez la fiabilité de vos projets. Les baisses dans ce graphique peuvent indiquer une panne d'une partie ou de l'ensemble de votre base d'utilisateurs. Nous vous recommandons de surveiller attentivement ce graphique afin de détecter toute irrégularité après chaque modification ou mise à jour de votre projet.
- Les graphiques de répartition des erreurs sont particulièrement utiles pour résoudre les problèmes liés à vos intégrations. Pour chaque erreur mise en surbrillance dans votre graphique de pourcentage de réussite, un code d'erreur s'affiche dans la répartition des erreurs. Vous pouvez consulter les erreurs signalées par Google Home platform et les résoudre dans le tableau ci-dessous.
Codes d'erreur de la plate-forme
Voici quelques codes d'erreur courants que vous pouvez voir dans les journaux de votre projet afin d'identifier les problèmes détectés par Google Home platform. Veuillez consulter le tableau suivant pour en savoir plus sur le dépannage.
| Code d'erreur | Description |
|---|---|
BACKEND_FAILURE_URL_ERROR |
Google a reçu de votre service un code d'erreur HTTP 4xx autre que 401.
Utilisez requestId dans la journalisation GCP pour consulter les journaux de votre service de maison connectée.
|
BACKEND_FAILURE_URL_TIMEOUT |
La requête de Google a expiré lors de la tentative de connexion à votre service.
Vérifiez que votre service est en ligne, qu'il accepte les connexions et qu'il n'est pas en surcapacité. Vérifiez également que l'appareil cible est allumé, en ligne et synchronisé. |
BACKEND_FAILURE_URL_UNREACHABLE |
Google a reçu un code d'erreur HTTP 5xx de la part de votre service.
Utilisez requestId dans la journalisation GCP pour consulter les journaux de votre service de maison connectée.
|
DEVICE_NOT_FOUND |
L'appareil n'existe pas du côté du service partenaire.
Cela indique généralement un échec de synchronisation des données ou une condition de concurrence. |
GAL_BAD_3P_RESPONSE |
Google ne peut pas analyser la réponse de votre service d'association de comptes en raison d'un format ou de valeurs non valides dans la charge utile.
Utilisez requestId dans la journalisation GCP pour vérifier les journaux d'erreurs dans votre service d'association de comptes.
|
GAL_INTERNAL |
Une erreur interne Google s'est produite lorsque Google a essayé de récupérer un jeton d'accès.
Si vous constatez une augmentation du taux de cette erreur dans GCP Logging, contactez-nous pour en savoir plus. |
GAL_INVALID_ARGUMENT |
Une erreur interne Google s'est produite lorsque Google a essayé de récupérer un jeton d'accès.
Si vous constatez une augmentation du taux de cette erreur dans GCP Logging, contactez-nous pour en savoir plus. |
GAL_NOT_FOUND |
Les jetons d'accès et les jetons d'actualisation de l'utilisateur stockés dans Google ne sont plus valides et ne peuvent plus être actualisés. L'utilisateur doit associer de nouveau son compte pour continuer à utiliser votre service.
Si vous constatez une augmentation du taux de cette erreur dans GCP Logging, contactez-nous pour en savoir plus. |
GAL_PERMISSION_DENIED |
Une erreur interne Google s'est produite lorsque le partage de jetons n'est pas autorisé.
Si vous constatez une augmentation du taux de cette erreur dans GCP Logging, contactez-nous pour en savoir plus. |
GAL_REFRESH_IN_PROGRESS |
Le jeton d'accès de l'utilisateur a expiré, et une autre tentative d'actualisation simultanée est déjà en cours.
Cela n'est pas un problème, et aucune action n'est requise. |
INVALID_AUTH_TOKEN |
Google a reçu un code d'erreur HTTP 401 de la part de votre service.
Le jeton d'accès n'a pas expiré, mais votre service l'a invalidé. Utilisez requestId dans GCP Logging pour consulter les journaux du service de maison connectée.
|
INVALID_JSON |
Impossible d'analyser ou de comprendre la réponse JSON.
Vérifiez que la structure de votre réponse JSON ne contient pas de syntaxe non valide, telle que des crochets non concordants, des virgules manquantes ou des caractères non valides. |
OPEN_AUTH_FAILURE |
Le jeton d'accès de l'utilisateur a expiré et Google ne peut pas l'actualiser, ou Google a reçu un code d'erreur HTTP 401 de la part de votre service.
Si vous constatez une augmentation du taux de ce code, vérifiez s'il y a également une augmentation du taux d'erreurs liées aux intents de maison connectée ou aux requêtes de jetons d'actualisation. |
PARTNER_RESPONSE_INVALID_ERROR_CODE |
La réponse indique un code d'erreur non reconnu.
Si la réponse à votre requête indique une erreur, veillez à en utiliser une fournie par nos codes d'erreur compatibles. |
PARTNER_RESPONSE_INVALID_PAYLOAD |
Impossible d'analyser le champ payload de la réponse en tant qu'objet JSON.
Vérifiez que le champ de charge utile de votre réponse à la requête comporte des crochets correspondants et qu'il est correctement structuré en tant que champ JSON. |
PARTNER_RESPONSE_INVALID_STATUS |
La réponse n'indique pas un état ou indique un état incorrect.
Les réponses aux requêtes de traitement des intents doivent indiquer un état avec SUCCESS, OFFLINE, ERROR, EXCEPTIONS. Pour en savoir plus, consultez la page sur la
gestion des erreurs et des exceptions.
|
PARTNER_RESPONSE_MISSING_COMMANDS_AND_DEVICES |
Un ou plusieurs intents présents dans la requête sont manquants dans la réponse.
Vérifiez que la réponse d'exécution est correctement structurée et que les résultats de tous les intents de la requête figurent dans votre réponse. |
PARTNER_RESPONSE_MISSING_DEVICE |
Un ou plusieurs appareils présents dans la requête ne figurent pas dans la réponse.
Vérifiez que votre réponse d'exécution est correctement structurée et que tous les ID d'appareil de la requête figurent dans votre réponse. |
PARTNER_RESPONSE_MISSING_PAYLOAD |
La réponse ne contient pas de champ payload.
Veillez à inclure un champ de charge utile dans la réponse à votre requête. Pour en savoir plus sur la création correcte d'une réponse d'exécution, |
PARTNER_RESPONSE_NOT_OBJECT |
Impossible d'analyser la réponse en tant qu'objet JSON.
Vérifiez que tous les champs de la réponse à votre requête ne contiennent pas de caractères non souhaités, de parenthèses non concordantes ou d'erreurs de mise en forme. Il est possible que certains caractères Unicode ne soient pas acceptés. Assurez-vous également que votre réponse est correctement structurée en tant qu'objet JSON. |
PROTOCOL_ERROR |
Échec du traitement de la demande.
Utilisez requestId dans Google Cloud Logging pour consulter les journaux du service de maison connectée.
|
RESPONSE_TIMEOUT |
La requête a expiré en attendant la réponse.
Le délai avant expiration pour l'envoi d'une réponse est de 9 secondes à compter de la date d'envoi de la requête. Veillez à envoyer une réponse dans ce délai. |
RESPONSE_UNAVAILABLE |
Aucune réponse n'est reçue, ou la réponse n'indique pas d'état.
Les réponses aux requêtes de traitement des intents doivent être structurées en fonction de la documentation sur la maison connectée et indiquer leur état. |
TRANSIENT_ERROR |
Une erreur temporaire est une erreur qui se résout d'elle-même.
Le plus souvent, ces erreurs se manifestent par l'abandon de la connexion à un appareil ou à un service. De même, il est impossible d'ouvrir de nouvelles connexions à un serveur. |
Journaux sur les recherches
Une fois que vous maîtrisez la surveillance de vos intégrations à l'aide de métriques, l'étape suivante consiste à résoudre des erreurs spécifiques à l'aide de Cloud Logging. Un journal d'erreurs est une entrée de type JSON contenant des champs contenant des informations utiles telles que l'heure, le code d'erreur et des détails sur l'intent de maison connectée d'origine.
Plusieurs systèmes au sein de Google Cloud envoient en permanence des journaux à votre projet. Vous devez écrire des requêtes pour filtrer vos journaux et trouver celles dont vous avez besoin. Les requêtes peuvent être basées sur une période, une ressource, une gravité des journaux ou des entrées personnalisées.
Vous pouvez utiliser les boutons de requête pour créer vos filtres personnalisés.
Pour spécifier une période, cliquez sur le bouton de sélection de la période et choisissez l'une des options fournies. Cette action permet de filtrer les journaux et d'afficher ceux qui sont générés au cours de la période sélectionnée.
Pour spécifier une ressource, cliquez sur le menu déroulant Ressource, puis sélectionnez Projet d'action de l'Assistant Google. Un filtre est alors ajouté à votre requête pour afficher les journaux provenant de votre projet.
Utilisez le bouton Gravité pour filtrer par niveau de gravité (Urgence, Informations, Débogage, etc.).
Vous pouvez également utiliser le champ "Requête" de Logs Explorer pour saisir des entrées personnalisées. Le moteur de requêtes utilisé par ce champ accepte à la fois les requêtes de base telles que la correspondance de chaînes et les types de requêtes plus avancés, y compris les comparateurs (<, >=, !=) et les opérateurs booléens (AND, OR, NOT).
Par exemple, l'entrée personnalisée ci-dessous renvoyait des erreurs provenant d'un type d'appareil LIGHT:
resource.type = "assistant_action_project" AND severity = ERROR AND jsonPayload.executionLog.executionResults.actionResults.device.deviceType = "LIGHT"
Consultez la bibliothèque de requêtes pour trouver d'autres exemples d'interrogation efficace de journaux.
Tester les correctifs
Une fois que vous avez identifié les erreurs et appliqué les mises à jour pour les corriger, nous vous recommandons de tester vos corrections de manière approfondie avec Google Home Test Suite. Nous fournissons un guide de l'utilisateur sur l'utilisation de Test Suite, qui vous aide à tester efficacement vos modifications.
Ressources d'apprentissage
Ce document explique comment résoudre les erreurs liées à une action pour la maison connectée. Vous pouvez également consulter nos ateliers de programmation pour en savoir plus sur le débogage:
- Atelier de programmation sur le débogage pour la maison connectée : guide de démarrage rapide pour déboguer l'intégration au cloud de la maison connectée.
- Atelier de programmation sur le débogage de la maison connectée : guide de démarrage rapide pour déboguer l'intégration locale de la maison connectée.