Écrire et afficher les journaux


La journalisation est un outil important pour déboguer et surveiller le code. Cloud Functions vous permet d'utiliser son SDK de journalisation, le Cloud Logging Google personnalisé ou la norme d'objet console pour le développement pour le Web.

Écrire des journaux

Bien que le SDK journaliseur Cloud Functions soit recommandé dans la plupart des cas, vous pouvez choisir l'une des autres options pour les raisons suivantes:

  • Vous disposez d'une base de code existante et vous préférez ne pas la refactoriser à partir de console.log.
  • Vous connaissez Cloud Logging (anciennement StackDriver Logging) et vous préférez l'utiliser pour la journalisation personnalisée.

Utiliser le SDK de l'enregistreur Cloud Functions

Le SDK du journal Cloud Functions fournit une interface standard dont l'API est semblable à celle des instructions console.log et qui prend en charge d'autres niveaux de journalisation. Vous pouvez utiliser ce SDK pour consigner des événements avec des données structurées, ce qui facilite l'analyse et la surveillance.

Le SDK du journal accepte les entrées de journal dans le cadre d'une importation avec caractère générique. Exemple :

  const functions = require("firebase-functions/v1");

  functions.logger.log("Hello from info. Here's an object:", someObj);

Vous pouvez également utiliser des exportations individuelles. Cet exemple illustre les données structurées associées au journal en tant que dernier argument:

const { warn } = require("firebase-functions/logger");


// Attach structured data to the log as the last argument.
warn("This is a 'WARNING' severity message with some metadata.", {
  key1: 'val1',
  key2: 'val2'
});
  • Les commandes logger.log() ont le niveau de journalisation INFO.
  • Les commandes logger.info() ont le niveau de journalisation INFO.
  • Les commandes logger.warn() ont le niveau de journalisation WARNING (AVERTISSEMENT).
  • Les commandes logger.error() ont le niveau de journalisation ERROR (ERREUR).
  • Les messages système internes ont le niveau de journalisation DEBUG.

Avec logger.write(), vous pouvez écrire des entrées de journal avec des niveaux de gravité de journalisation de CRITICAL, ALERT et EMERGENCY. Consultez LogSeverity.

Journaux Cloud Logging personnalisés

Les journaux Cloud Functions avec le SDK de journalisation sont pris en charge par Cloud Logging. Vous pouvez utiliser la bibliothèque Cloud Logging pour Node.js pour consigner des événements avec des données structurées, ce qui facilite l'analyse et la surveillance.

const { Logging } = require('@google-cloud/logging');

// ...

// Instantiate the logging SDK. The project ID will
// be automatically inferred from the Cloud Functions environment.
const logging = new Logging();
const log = logging.log('my-custom-log-name');

// This metadata is attached to each log entry. This specifies a fake
// Cloud Function called 'Custom Metrics' in order to make your custom
// log entries appear in the Cloud Functions logs viewer.
const METADATA = {
  resource: {
    type: 'cloud_function',
    labels: {
      function_name: 'CustomMetrics',
      region: 'us-central1'
    }
  }
};

// ...

// Data to write to the log. This can be a JSON object with any properties
// of the event you want to record.
const data = {
  event: 'my-event',
  value: 'foo-bar-baz',

  // Optional 'message' property will show up in the Firebase
  // console and other human-readable logging surfaces
  message: 'my-event: foo-bar-baz'
};

// Write to the log. The log.write() call returns a Promise if you want to
// make sure that the log was written successfully.
const entry = log.entry(METADATA, data);
log.write(entry);
index.js

Utiliser console.log

La solution recommandée pour la journalisation à partir d'une fonction consiste à utiliser le SDK de journalisation pour votre plate-forme. Avec Node.js, vous pouvez utiliser des appels de journalisation JavaScript standards tels que console.log et console.error. Toutefois, vous devez d'abord exiger un module spécial pour corriger les méthodes standards afin qu'elles fonctionnent correctement:

require("firebase-functions/logger/compat");

Une fois que vous avez requis le module de compatibilité de l'enregistreur, vous pouvez utiliser les méthodes console.log() comme d'habitude dans votre code:

exports.helloError = functions.https.onRequest((request, response) => {
  console.log('I am a log entry!');
  response.send('Hello World...');
});
index.js
  • Les commandes console.log() ont le niveau de journalisation INFO.
  • Les commandes console.info() ont le niveau de journalisation INFO.
  • Les commandes console.warn() ont le niveau de journalisation ERROR (ERREUR).
  • Les commandes console.error() ont le niveau de journalisation ERROR (ERREUR).
  • Les messages système internes ont le niveau de journalisation DEBUG.

Afficher les journaux

Les journaux de Cloud Functions sont visibles dans la console Google Cloud, l'interface utilisateur Cloud Logging ou via l'outil de ligne de commande firebase.

Utiliser la CLI Firebase

Pour afficher les journaux à l'aide de l'outil firebase, utilisez la commande functions:log:

firebase functions:log

Pour afficher les journaux d'une fonction spécifique, indiquez le nom de la fonction en tant qu'argument:

firebase functions:log --only <FUNCTION_NAME>

Pour consulter la liste complète des options d'affichage des journaux, consultez l'aide sur functions:log :

firebase help functions:log

Utiliser la console Google Cloud

Vous pouvez consulter les journaux des fonctions dans la console Google Cloud.

Utiliser l'UI Cloud Logging

Vous pouvez afficher les journaux de Cloud Functions dans l'interface utilisateur de Cloud Logging.

Analyser des journaux

Cloud Logging propose une suite puissante d'outils d'analyse des journaux que vous pouvez utiliser pour surveiller votre Cloud Functions.

Graphiques et alertes

Une fois que vous avez créé des métriques basées sur les journaux pour surveiller vos fonctions, vous pouvez créer des graphiques et des alertes en fonction de ces métriques. Par exemple, vous pouvez créer un graphique pour visualiser la latence au fil du temps ou une alerte pour vous avertir si une erreur donnée se produit trop souvent.

Pour en savoir plus sur l'utilisation des métriques basées sur les journaux dans les graphiques et les règles d'alerte, consultez Créer des graphiques et des alertes.