Interroger les journaux d'erreur des modules complémentaires Google Workspace

Lorsqu'un module complémentaire Google Workspace publié renvoie une erreur, l'interface du module complémentaire renvoie un message générique "Une erreur s'est produite lors de l'exécution du module complémentaire". Toutefois, ces erreurs sont consignées dans l'explorateur de journaux Cloud.

Remarque : Pour Apps Script, si votre module complémentaire est déployé en tant que test, les erreurs sont signalées à la fois dans l'explorateur de journaux Cloud et dans l'interface du module complémentaire.

Par exemple, un déploiement de test de module complémentaire peut afficher un message d'erreur tel que TypeError: card.INVALIDFUNCTIONNAME is not a function [line: 33, function: getContextualAddOn, file: GetContextualAddOn] dans son interface.

Bien que les messages d'erreur comme celui-ci soient utiles, des informations supplémentaires sont disponibles dans l'explorateur de journaux. Nous vous recommandons d'interroger les journaux d'erreurs pour en savoir plus. Pour en savoir plus sur le test des déploiements de modules complémentaires, consultez Tester et déboguer les modules complémentaires Google Workspace.

Ce guide explique comment interroger les journaux d'erreurs des modules complémentaires dans l'explorateur de journaux Cloud Logging. Vous pourrez ainsi :

• Déterminez si les utilisateurs rencontrent des erreurs.
• Découvrez la fréquence des erreurs et celles qui se produisent le plus souvent.
• Lisez les messages d'erreur descriptifs qui vous aident à les résoudre.

Prérequis

Avant d'interroger les journaux d'erreurs des modules complémentaires :

• Activez l'API Cloud Logging dans le projet Google Cloud du module complémentaire. Pour activer une API, consultez Créer un projet Cloud et activer l'API.
• Publiez le module complémentaire sur Google Workspace Marketplace. Pour publier un module complémentaire sur le Marketplace, consultez Publier une application.

Interroger les journaux d'erreurs des modules complémentaires

Pour obtenir les journaux d'un module complémentaire :

1. Ouvrez Google Cloud Console.
2. À côté de "Google Cloud Platform", cliquez sur la flèche vers le bas  et sélectionnez le projet de module complémentaire.
3. En haut à gauche, cliquez sur Menu  > Journalisation. L'explorateur de journaux s'ouvre.

4. Pour les journaux d'erreurs des modules complémentaires, saisissez la requête suivante dans le générateur de requêtes :

   severity>=ERROR
   protoPayload.serviceName="gsuiteaddons.googleapis.com"
   

5. Pour afficher les erreurs récentes, cliquez sur Exécuter la requête. Pour afficher les erreurs au fur et à mesure qu'elles se produisent, cliquez sur Journaux de flux. Les journaux d'erreurs des modules complémentaires s'affichent dans le volet "Résultats de la requête".

Pour en savoir plus sur l'explorateur de journaux Cloud et sur la rédaction de requêtes, consultez les ressources suivantes :

• Utiliser l'explorateur de journaux
• Créer des requêtes

Activer ou désactiver la journalisation des erreurs

Par défaut, la journalisation des erreurs est activée. Lorsque la journalisation des erreurs est activée, le fichier manifeste contient les éléments suivants :

"exceptionLogging": "STACKDRIVER",

Pour désactiver la journalisation des erreurs, remplacez "exceptionLogging": "STACKDRIVER", par la ligne suivante dans le fichier manifeste :

// Disable error logging
"exceptionLogging": "NONE"

Pour réactiver la journalisation des erreurs, remplacez "exceptionLogging": "NONE" par "exceptionLogging": "STACKDRIVER",.

Remarques

Lorsque vous utilisez l'explorateur de journaux Cloud pour consulter les journaux d'erreurs des modules complémentaires, tenez compte des points suivants :

• Les modules complémentaires ne consignent que les erreurs dans l'explorateur de journaux. Les autres types de journaux ne sont pas enregistrés.
• Les messages d'erreur sont toujours rédigés en anglais.
• Cloud Logging entraîne des coûts. Pour en savoir plus sur les tarifs de Cloud Logging, consultez la page Tarifs de Google Cloud Observability.