Journalisation

Lorsque vous développez une application, vous souhaitez souvent enregistrer des informations pour vous aider à diagnostiquer les défauts 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 diffusé en temps réel, mais ne persiste que pendant une courte période.

• L'interface Cloud Logging de la console pour les développeurs, qui fournit des journaux conservés pendant plusieurs jours après leur création.

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

Ces éléments sont décrits dans les sections suivantes. En plus de ces mécanismes, vous pouvez également créer votre propre code de journalisation qui, par exemple, écrit des informations dans une feuille de calcul 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 diffusés 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 lors du développement et du débogage, et ne sont pas conservés très longtemps.

Prenons l'exemple de la fonction suivante :

utils/logging.gs

Afficher sur GitHub

/**
 * 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 "[e-mail]", les journaux suivants sont écrits :

[16-09-12 13:50:42:193 PDT] Emailing data row 2 to [e-mail]
[16-09-12 13:50:42:271 PDT] Row 2 data: Cost 103.24

Cloud Logging

Apps Script fournit également un accès partiel au service Cloud Logging de Google Cloud Platform (GCP). Si vous avez besoin d'une journalisation qui persiste pendant plusieurs jours ou d'une solution de journalisation plus complexe pour un environnement de production multi-utilisateur, Cloud Logging est le meilleur choix. Pour en savoir plus sur la conservation des données et les autres quotas, consultez Quotas et limites de Cloud Logging.

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

Remarque : Cloud Logging fournit un certain nombre de services au-delà du stockage des journaux, tels que les alertes et les métriques. Ces services ne sont pas disponibles dans Apps Script pour le moment.

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 exploiter pleinement Cloud Logging et ses fonctionnalités, utilisez un projet Google Cloud standard avec votre projet de script. Vous pouvez ainsi accéder aux journaux Cloud directement dans la console GCP et bénéficier de davantage d'options d'affichage et de filtrage.

Remarque : Si vous utilisez le moteur d'exécution Rhino, Cloud Logging n'est pas compatible avec le service Apps Script Logger. Utilisez plutôt le service console.

Lorsque vous enregistrez des journaux, il est recommandé de ne pas enregistrer d'informations personnelles sur l'utilisateur, telles que des adresses e-mail, pour respecter la confidentialité. Les journaux Cloud sont automatiquement associés à des clés d'utilisateur actif que vous pouvez utiliser pour localiser les messages de journaux d'un utilisateur spécifique si nécessaire.

Vous pouvez consigner des chaînes, des chaînes formatées et même des objets JSON à l'aide des fonctions fournies par le service console Apps Script.

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

utils/logging.gs

Afficher sur GitHub

/**
 * 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 d'utilisateur actif temporaires permettent d'identifier facilement les utilisateurs uniques dans les entrées des journaux Cloud sans révéler leur identité. Les clés sont spécifiques à chaque 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 d'utilisateur actif temporaires sont supérieures aux identifiants de connexion tels que les adresses e-mail, car :

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

Pour trouver les clés utilisateur actives temporaires dans vos entrées de journaux Cloud, affichez vos journaux Cloud dans la console Google Cloud. Vous ne pouvez le faire que si votre projet de script utilise un projet Google Cloud standard auquel vous avez accès. Une fois que vous avez ouvert le projet Google Cloud dans la console, sélectionnez une entrée de journal qui vous intéresse et développez-la pour afficher métadonnées > libellés > script.googleapis.com/user_key.

Vous pouvez également obtenir la clé d'utilisateur actif temporaire en appelant Session.getTemporaryActiveUserKey() dans votre script. Une façon d'utiliser cette méthode consiste à afficher 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 pour vous aider à identifier les journaux concernés.

Journalisation des exceptions

La journalisation des exceptions envoie les exceptions non traitées dans le code de votre projet de script à Cloud Logging, ainsi qu'une trace de 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 dépassé.

Vous pouvez également afficher les exceptions consigné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 anciens projets, procédez comme suit :

1. Ouvrez le projet de script.
2. Sur la gauche, cliquez sur Paramètres du projet .
3. Cochez la case Consigner 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 le message "Configurer Error Reporting" s'affiche, cela signifie que votre script n'a pas encore consigné d'exceptions. Aucune configuration n'est requise en plus de l'activation de la journalisation des exceptions.

Exigences de journalisation

Aucune exigence n'est requise pour utiliser le journal d'exécution intégré.

Vous pouvez afficher une version simplifiée des journaux Cloud dans le tableau de bord Apps Script. Toutefois, pour exploiter pleinement Cloud Logging et Error Reporting, 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.