La journalisation est un outil important pour le débogage et la surveillance du code. Cloud Functions vous offre la possibilité d'utiliser le SDK logger pour Node.js ou Python , ou le standard d'objet console pour le développement pour le Web.
Cloud Logging est un service payant ; vous pourriez être facturé si vous dépassez le quota sans frais. Pour plus d'informations, consultez Tarifs Cloud Logging .
Rédaction de journaux
Utiliser le SDK de l'enregistreur Cloud Functions
Le SDK de l'enregistreur Cloud Functions fournit une interface standard pour signaler l'état des fonctions à Cloud Logging. 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.
Importer depuis le sous-package logger :
Noeud.js
// All available logging functions
const {
log,
info,
debug,
warn,
error,
write,
} = require("firebase-functions/logger");
Python
from firebase_functions import logger
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 commandes
logger.debug()ont le niveau de journalisation DEBUG .Les messages système internes ont le niveau de journalisation DEBUG .
Cet exemple illustre une fonction écrivant un journal de base :
Noeud.js
exports.helloWorld = onRequest((request, response) => {
// sends a log to Cloud Logging
log("Hello logs!");
response.send("Hello from Firebase!");
});
Python
@https_fn.on_request()
def hello_world(req: https_fn.Request) -> https_fn.Response:
# sends a log to Cloud Logging
logger.log("Hello logs!")
return https_fn.Response("Hello from Firebase!")
Utilisez différents niveaux de journalisation pour différents types de journaux dans votre code de fonction. Les données structurées peuvent être jointes à un journal comme dernier argument. Voici un exemple de la façon dont une fonction peut utiliser chaque type de journal :
Noeud.js
exports.getInspirationalQuote = onRequest(async (request, response) => {
const db = getFirestore();
const today = new Date();
const quoteOfTheMonthRef = db
.collection("quotes")
.doc(`${today.getFullYear()}`)
.collection("months")
.doc(`${today.getMonth()}`);
const DEFAULT_QUOTE =
"You miss 100% of the shots you don't take. -Wayne Gretzky";
let quote;
try {
const quoteOfTheMonthDocSnap = await quoteOfTheMonthRef.get();
// Attach relevant debugging information with debug()
debug("Monthly quote fetch result", {
docRef: quoteOfTheMonthRef.path,
exists: quoteOfTheMonthDocSnap.exists,
createTime: quoteOfTheMonthDocSnap.createTime,
});
if (quoteOfTheMonthDocSnap.exists) {
quote = quoteOfTheMonthDocSnap.data().text;
} else {
// Use warn() for lower-severity issues than error()
warn("Quote not found for month, sending default instead", {
docRef: quoteOfTheMonthRef.path,
dateRequested: today.toLocaleDateString("en-US"),
});
quote = DEFAULT_QUOTE;
}
} catch (err) {
// Attach an error object as the second argument
error("Unable to read quote from Firestore, sending default instead",
err);
quote = DEFAULT_QUOTE;
}
// Attach relevant structured data to any log
info("Sending a quote!", {quote: quote});
response.json({inspirationalQuote: quote});
});
Python
@https_fn.on_request()
def get_inspirational_quote(req: https_fn.Request) -> https_fn.Response:
firestore_client = firestore.client()
today = datetime.date.today()
quote_of_the_month_ref = (firestore_client.collection("quotes").doc(str(
today.year)).collection("months").doc(str(today.month)))
default_quote = "Python has been an important part of Google since the beginning, and remains so as the system grows and evolves."
quote = None
try:
quote_of_the_month = quote_of_the_month_ref.get()
# Attach relevant debugging information with debug()
logger.debug(
"Monthly quote fetch result",
docRef=quote_of_the_month.path,
exists=quote_of_the_month.exists,
createTime=quote_of_the_month.createTime,
)
if quote_of_the_month.exists:
quote = quote_of_the_month.to_dict()["text"]
else:
# Use warn() for lower-severity issues than error()
logger.warn(
"Quote not found for month, sending default instead",
doc_reference=quote_of_the_month.path,
date_requested=today.strftime("%Y-%m-%d"),
)
quote = default_quote
except:
e = sys.exc_info()[0]
# Attach an error object as the second argument
logger.error("Unable to read quote from Firestore, sending default instead", error=e)
quote = default_quote
# Attach relevant structured data to any log
logger.info("Sending a quote!", quote=quote)
return https_fn.Response("Hello from Firebase!")
Avec logger.write() , vous pouvez écrire des entrées de journal avec des niveaux de gravité de journal supplémentaires CRITICAL , ALERT et EMERGENCY . Voir LogSeverity .
Noeud.js
exports.appHasARegression = onRegressionAlertPublished((event) => {
write({
// write() lets you set additional severity levels
// beyond the built-in logger functions
severity: "EMERGENCY",
message: "Regression in production app",
issue: event.data.payload.issue,
lastOccurred: event.data.payload.resolveTime,
});
});
Python
@crashlytics_fn.on_regression_alert_published()
def app_has_regression(alert: crashlytics_fn.CrashlyticsRegressionAlertEvent) -> None:
logger.write(
severity="EMERGENCY",
message="Regression in production app",
issue=alert.data.payload.issue,
last_occurred=alert.data.payload.resolve_time,
)
print(alert)
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.