La journalisation est un outil important pour le débogage et la surveillance du code. Cloud Functions vous offre la possibilité d'utiliser son SDK de journalisation, Google Cloud Logging personnalisé ou le standard d'objet console pour le développement pour le Web.
Rédaction de journaux
Bien que le SDK de l'enregistreur Cloud Functions soit recommandé dans la plupart des situations, vous pouvez choisir l'une des autres options pour les raisons suivantes :
- Vous disposez d'une base de code existante et préférez ne pas refactoriser à partir de
console.log. - Vous connaissez Cloud Logging (anciennement StackDriver logging) et préférez l'utiliser pour la journalisation personnalisée.
Utiliser le SDK de l'enregistreur Cloud Functions
Le SDK de l'enregistreur Cloud Functions fournit une interface standard dotée d'une API similaire aux instructions console.log et prend en charge d'autres niveaux de journalisation. Vous pouvez utiliser ce SDK pour enregistrer des événements avec des données structurées , permettant ainsi une analyse et une surveillance plus faciles.
Le SDK de l'enregistreur prend en charge les entrées de journal dans le cadre d'une importation générique. Par exemple:
const functions = require("firebase-functions");
functions.logger.log("Hello from info. Here's an object:", someObj);
Vous pouvez également utiliser des exportations individuelles. Cet exemple montre des données structurées attachées au journal comme 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 AVERTISSEMENT . - Les commandes
logger.error()ont le niveau de journalisation ERROR . - Les messages système internes ont le niveau de journalisation DEBUG .
Avec logger.write() , vous pouvez écrire des entrées de journal en plus des niveaux de gravité du journal CRITICAL , ALERT et EMERGENCY . Voir LogSeverity .
Journaux Cloud Logging personnalisés
Les journaux Cloud Functions avec le SDK logger sont sauvegardés par Cloud Logging . Vous pouvez utiliser la bibliothèque Cloud Logging pour Node.js pour consigner les événements avec des données structurées, facilitant ainsi 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);
Utilisation console.log
La solution recommandée pour la journalisation à partir d’une fonction consiste à utiliser le SDK logger pour votre plateforme. Avec Node.js, vous pouvez à la place utiliser des appels de journalisation JavaScript standard tels que console.log et console.error , mais vous devez d'abord avoir besoin d'un module spécial pour corriger les méthodes standard afin qu'elles fonctionnent correctement :
require("firebase-functions/logger/compat");
Une fois que vous avez requis le module de compatibilité du logger, 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...');
});
- 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 . - Les commandes
console.error()ont le niveau de journalisation ERROR . - Les messages système internes ont le niveau de journalisation DEBUG .
Affichage des journaux
Les journaux des fonctions Cloud sont visibles soit dans la console Google Cloud , dans l'interface utilisateur de Cloud Logging ou via l'outil de ligne de commande firebase .
Utiliser la CLI Firebase
Pour afficher les journaux avec l'outil firebase , utilisez la commande functions:log :
firebase functions:log
Pour afficher les journaux d'une fonction spécifique, fournissez le nom de la fonction comme argument :
firebase functions:log --only <FUNCTION_NAME>
Pour la gamme complète des options d'affichage des journaux, consultez l'aide pour functions:log :
firebase help functions:log
Utiliser la console Google Cloud
Vous pouvez afficher les journaux des fonctions dans la console Google Cloud .
Utiliser l'interface utilisateur de Cloud Logging
Vous pouvez afficher les journaux de Cloud Functions dans l'interface utilisateur de Cloud Logging.
Analyser les journaux
Cloud Logging propose une suite puissante d'outils d'analyse de journaux que vous pouvez utiliser pour surveiller vos fonctions Cloud.
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 basées sur ces métriques. Par exemple, vous pouvez créer un graphique pour visualiser la latence au fil du temps ou créer une alerte pour vous informer si une certaine erreur se produit trop souvent.
Reportez-vous à Création de graphiques et d'alertes pour obtenir des informations détaillées sur l'utilisation des métriques basées sur les journaux dans les graphiques et les stratégies d'alerte.