Journalisation

Lorsque vous développez tout type d'application, vous souhaitez souvent consigner des informations pour faciliter le diagnostic des erreurs pendant le développement, identifier et diagnostiquer les problèmes des clients, et à d'autres fins.

Apps Script propose trois mécanismes de journalisation différents:

  • Le journal d'exécution Apps Script intégré. Ce journal est léger et est diffusé en temps réel, mais ne persiste que pendant une courte période.

  • Interface Cloud Logging de la Play Console, qui fournit des journaux conservés pendant plusieurs jours après leur création.

  • L'interface Error Reporting de la Play Console, qui collecte et enregistre les erreurs qui se produisent pendant l'exécution de votre script.

Ceux-ci sont décrits dans les sections suivantes. En plus de ces mécanismes, vous pouvez également créer votre propre code d'enregistreur qui, par exemple, écrit des informations dans une feuille de calcul de journalisation ou une base de données JDBC.

Utiliser le journal d'exécution Apps Script

Une approche de base de la journalisation dans Apps Script consiste à utiliser le journal d'exécution intégré. Pour afficher ces journaux, cliquez sur Journal d'exécution en haut de l'éditeur. Lorsque vous exécutez une fonction ou utilisez le débogueur, les journaux sont transmis en temps réel.

Vous pouvez utiliser les services de journalisation Logger ou console dans le journal d'exécution intégré.

Ces journaux sont destinés à des vérifications simples pendant le développement et le débogage. Ils ne persistent pas très longtemps.

Prenons l'exemple de la fonction suivante:

utils/logging.gs
/**
 * Logs Google Sheet information.
 * @param {number} rowNumber The spreadsheet row number.
 * @param {string} email The email to send with the row data.
 */
function emailDataRow(rowNumber, email) {
  console.log('Emailing data row ' + rowNumber + ' to ' + email);
  try {
    const sheet = SpreadsheetApp.getActiveSheet();
    const data = sheet.getDataRange().getValues();
    const rowData = data[rowNumber - 1].join(' ');
    console.log('Row ' + rowNumber + ' data: ' + rowData);
    MailApp.sendEmail(email, 'Data in row ' + rowNumber, rowData);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed with error %s', err.message);
  }
}

Lorsque ce script est exécuté avec les entrées "2" et "john@example.com", les journaux suivants sont écrits:

[16-09-12 13:50:42:193 PDT] Envoi par e-mail de la ligne 2 de données à john@example.com
[16-09-12 13:50:42:271 PDT] Données de ligne 2: Coût 103,24

Cloud Logging

Apps Script fournit également un accès partiel au service Cloud Logging de Google Cloud Platform (GCP). Lorsque vous avez besoin d'une journalisation qui persiste plusieurs jours ou que vous avez besoin d'une solution de journalisation plus complexe pour un environnement de production multi-utilisateur, Cloud Logging est l'option recommandée. Consultez la section Quotas et limites de Cloud Logging pour en savoir plus sur la conservation des données et d'autres informations sur les quotas.

Si vous avez besoin d'un quota de journalisation supérieur, vous pouvez envoyer une demande de quota Google Cloud Platform. Pour ce faire, vous devez avoir accès au projet Cloud Platform utilisé par votre script.

Utiliser Cloud Logging

Les journaux cloud sont associés au projet Google Cloud associé à votre script Apps Script. Vous pouvez afficher une version simplifiée de ces journaux dans le tableau de bord Apps Script.

Pour tirer pleinement parti de Cloud Logging et de ses fonctionnalités, utilisez un projet Google Cloud standard avec votre projet de script. Cela vous permet d'accéder aux journaux Cloud directement dans la console GCP et vous offre davantage d'options d'affichage et de filtrage.

Lors de la journalisation, il est recommandé d'éviter d'enregistrer des informations personnelles sur l'utilisateur, telles que des adresses e-mail. Les journaux cloud sont automatiquement libellés avec des clés utilisateur actives que vous pouvez utiliser pour localiser les messages de journal d'un utilisateur spécifique si nécessaire.

Vous pouvez consigner des chaînes, des chaînes mises en forme et même des objets JSON à l'aide des fonctions fournies par le service console d'Apps Script.

L'exemple suivant montre comment utiliser le service console pour consigner des informations dans Cloud Operations.

utils/logging.gs
/**
 * Logs the time taken to execute 'myFunction'.
 */
function measuringExecutionTime() {
  // A simple INFO log message, using sprintf() formatting.
  console.info('Timing the %s function (%d arguments)', 'myFunction', 1);

  // Log a JSON object at a DEBUG level. The log is labeled
  // with the message string in the log viewer, and the JSON content
  // is displayed in the expanded log structure under "jsonPayload".
  const parameters = {
    isValid: true,
    content: 'some string',
    timestamp: new Date()
  };
  console.log({message: 'Function Input', initialData: parameters});
  const label = 'myFunction() time'; // Labels the timing log entry.
  console.time(label); // Starts the timer.
  try {
    myFunction(parameters); // Function to time.
  } catch (e) {
    // Logs an ERROR message.
    console.error('myFunction() yielded an error: ' + e);
  }
  console.timeEnd(label); // Stops the timer, logs execution duration.
}

Clés utilisateur actives

Les clés utilisateur actives temporaires constituent un moyen pratique de détecter les utilisateurs uniques dans les entrées Cloud Log sans révéler leur identité. Les clés sont fournies par script et changent environ une fois par mois pour renforcer la sécurité si un utilisateur révèle son identité à un développeur, par exemple lorsqu'il signale un problème.

Les clés utilisateur actives temporaires sont supérieures à la journalisation des identifiants tels que les adresses e-mail, car:

  • Vous n'avez rien à ajouter à votre journalisation, ils existent déjà !
  • Elles ne nécessitent pas l'autorisation de l'utilisateur.
  • Elles protègent la confidentialité des utilisateurs.

Pour rechercher des clés utilisateur actives temporaires dans vos entrées Cloud Log, affichez vos journaux Cloud dans la console Google Cloud. Vous ne pouvez effectuer cette opération que si votre projet de script utilise un projet Google Cloud standard auquel vous avez accès. Une fois le projet Google Cloud ouvert dans la console, sélectionnez une entrée de journal qui vous intéresse et développez-la pour afficher metadata > labels > script.googleapis.com/user_key.

Vous pouvez également obtenir la clé utilisateur active temporaire en appelant Session.getTemporaryActiveUserKey() dans votre script. Une façon d'utiliser cette méthode consiste à présenter la clé à l'utilisateur pendant qu'il exécute votre script. Les utilisateurs peuvent ensuite choisir d'inclure leurs clés lorsqu'ils signalent des problèmes afin de vous aider à identifier les journaux pertinents.

Journalisation des exceptions

La journalisation des exceptions envoie à Cloud Logging les exceptions non gérées du code de votre projet de script, ainsi qu'une trace de la pile.

Pour afficher les journaux d'exceptions, procédez comme suit:

  1. Ouvrez le projet Apps Script.
  2. À gauche, cliquez sur Exécutions .
  3. En haut de la page, cliquez sur Ajouter un filtre > État.
  4. Cochez les cases Échec et Délai expiré.

Vous pouvez également afficher les exceptions enregistrées dans la console GCP si votre projet de script utilise un projet Google Cloud standard auquel vous avez accès.

Activer la journalisation des exceptions

La journalisation des exceptions est activée par défaut pour les nouveaux projets. Pour activer la journalisation des exceptions pour les projets plus anciens, procédez comme suit:

  1. Ouvrez le projet de script.
  2. Sur la gauche, cliquez sur Paramètres du projet .
  3. Cochez la case Journaliser les exceptions non détectées dans Cloud Operations.

Error Reporting

La journalisation des exceptions s'intègre automatiquement à Cloud Error Reporting, un service qui regroupe et affiche les erreurs générées dans votre script. Vous pouvez afficher vos rapports d'erreurs Cloud dans la console Google Cloud. Si vous êtes invité à "Configurer Error Reporting", cela signifie que votre script n'a pas encore enregistré d'exceptions. Aucune configuration n'est requise en dehors de l'activation de la journalisation des exceptions.

Configuration requise pour Logging

L'utilisation du journal d'exécution intégré n'est soumise à aucune condition.

Vous pouvez afficher une version simplifiée des journaux Cloud dans le tableau de bord Apps Script. Toutefois, pour tirer le meilleur parti de Cloud Logging et des rapports d'erreurs, vous devez avoir accès au projet GCP du script. Cela n'est possible que si votre projet de script utilise un projet Google Cloud standard.