Interroger les journaux d'erreurs pour les modules complémentaires Google Workspace

Lorsqu'un module complémentaire publié de Google Workspace renvoie une erreur, l'interface renvoie un message générique indiquant qu'un problème est survenu lors de l'exécution du module. Toutefois, ces erreurs sont consignées dans l'explorateur de journaux Google Cloud.

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

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

Prérequis

Avant d'interroger les journaux des 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 et activer l'API.
  • Publiez le module complémentaire sur Google Workspace Marketplace. Pour publier un module complémentaire sur Marketplace, consultez l'article Publier une application.

Journaux d'erreurs du module complémentaire Query

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

  1. Ouvrez la console Google Cloud.
  2. À côté de "Google Cloud Platform", cliquez sur la flèche vers le bas , puis 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 voir les erreurs récentes, cliquez sur Exécuter la requête. Pour afficher les erreurs à mesure qu'elles se produisent, cliquez sur Diffuser les journaux. 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 Google Cloud et écrire des requêtes, consultez les ressources suivantes:

Activer ou désactiver la journalisation des erreurs

Par défaut, la journalisation des erreurs est activée. Si vous souhaitez désactiver la journalisation des erreurs, ajoutez la ligne suivante au fichier manifeste de votre module complémentaire:

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

Pour réactiver la journalisation des erreurs, supprimez la ligne exceptionLogging du fichier manifeste du module complémentaire.

Points à prendre en compte

Lorsque vous utilisez des journaux d'erreurs de modules complémentaires dans l'explorateur de journaux Google Cloud, 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 frais. Pour en savoir plus sur les tarifs de Cloud Logging, consultez les tarifs de la suite Google Cloud Operations.