Journalisation

Lorsque vous développez un type d'application, vous souhaitez souvent consigner des informations pour diagnostiquer les 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.

• L'interface Cloud Logging de la console du développeur, qui fournit des journaux qui persistent pendant de nombreux jours après leur création.

• L'interface Error Reporting (Signalement d'erreurs) de la console du développeur, qui collecte et enregistre les erreurs qui se produisent pendant 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 de journalisation.

Utiliser le journal d'exécution Apps Script

Une approche de base pour 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 persistent pas très longtemps.

Prenons l'exemple suivant:

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] Envoi par e-mail de la ligne 2 des données à [e-mail]
[16-09-12 13:50:42:271 PDT] Données de la 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 pendant plusieurs jours ou d'une solution de journalisation plus complexe pour un environnement de production multi-utilisateur, Cloud Logging est la solution privilégiée. Pour en savoir plus sur la conservation des données et d'autres informations sur les quotas, consultez la section Quotas et limites de Cloud Logging.

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

Remarque :Cloud Logging fournit un certain nombre de services en plus du stockage des journaux, tels que les alertes et les métriques. Pour le moment, ces services ne sont pas disponibles dans Apps Script.

Utiliser Cloud Logging

Les journaux Cloud sont associés au projet Google Cloud associé à votre 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 plus d'options de visualisation et de filtrage.

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

Lors de la journalisation, il est recommandé de ne pas enregistrer d'informations personnelles sur l'utilisateur, telles que des adresses e-mail. Les journaux Cloud sont automatiquement associés à 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 formatées 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

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 utilisateur actives temporaires permettent de repérer facilement les utilisateurs uniques dans les entrées de journal Cloud sans révéler leur identité. Les clés sont définies 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 d'utilisateur actif temporaires sont supérieures aux identifiants de journalisation tels que les adresses e-mail, car:

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

Pour rechercher des clés utilisateur actives temporaires dans vos entrées de journal 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 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 à afficher la clé à l'utilisateur lorsqu'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 pertinents.

Journalisation des exceptions

La journalisation des exceptions envoie les exceptions non gérées dans le code de votre projet de script à Cloud Logging, avec une trace de la pile.

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

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

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 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 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 rassemble et affiche les erreurs générées dans votre script. Vous pouvez afficher vos rapports d'erreur Cloud dans la console Google Cloud. Si vous êtes invité à "Configurer Error Reporting", cela signifie que votre script n'a encore enregistré aucune exception. Aucune configuration n'est requise en plus de l'activation de la journalisation des exceptions.

Exigences concernant la 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 le signalement d'erreurs, vous devez disposer d'un accès au projet GCP du script. Cela n'est possible que si votre projet de script utilise un projet Google Cloud standard.