El registro es una herramienta importante para depurar y monitorear el código. Cloud Functions te ofrece la opción de usar el SDK del registrador para Node.js o Python , o el estándar de objetos console para desarrollar para la web.
Cloud Logging es un servicio de pago; Es posible que se le facture si excede la cuota sin costo. Para obtener más información, consulte Precios de Cloud Logging .
Registros de escritura
Uso del SDK del registrador de Cloud Functions
El SDK del registrador de Cloud Functions proporciona una interfaz estándar para informar el estado de las funciones a Cloud Logging. Puede utilizar este SDK para registrar eventos con datos estructurados , lo que permite un análisis y un seguimiento más sencillos.
Importar desde el subpaquete logger :
Nodo.js
// All available logging functions
const {
log,
info,
debug,
warn,
error,
write,
} = require("firebase-functions/logger");
Pitón
from firebase_functions import logger
Los comandos
logger.log()tienen el nivel de registro INFO .Los comandos
logger.info()tienen el nivel de registro INFO .Los comandos
logger.warn()tienen el nivel de registro WARNING .Los comandos
logger.error()tienen el nivel de registro ERROR .Los comandos
logger.debug()tienen el nivel de registro DEBUG .Los mensajes internos del sistema tienen el nivel de registro DEBUG .
Este ejemplo demuestra una función que escribe un registro básico:
Nodo.js
exports.helloWorld = onRequest((request, response) => {
// sends a log to Cloud Logging
log("Hello logs!");
response.send("Hello from Firebase!");
});
Pitón
@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!")
Utilice diferentes niveles de registro para diferentes tipos de registro en su código de función. Los datos estructurados se pueden adjuntar a un registro como último argumento. A continuación se muestra un ejemplo de cómo una función puede utilizar cada tipo de registro:
Nodo.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});
});
Pitón
@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!")
Con logger.write() , puede escribir entradas de registro con niveles de gravedad de registro adicionales de CRITICAL , ALERT y EMERGENCY . Consulte LogSeverity .
Nodo.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,
});
});
Pitón
@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)
Usando console.log
La solución recomendada para iniciar sesión desde una función es utilizar el SDK del registrador para su plataforma. Con Node.js, puedes usar llamadas de registro de JavaScript estándar como console.log y console.error , pero primero necesitas un módulo especial para parchear los métodos estándar para que funcionen correctamente:
require("firebase-functions/logger/compat");
Una vez que haya requerido el módulo de compatibilidad del registrador, puede usar los métodos console.log() como de costumbre en su código:
exports.helloError = functions.https.onRequest((request, response) => {
console.log('I am a log entry!');
response.send('Hello World...');
});
- Los comandos
console.log()tienen el nivel de registro INFO . - Los comandos
console.info()tienen el nivel de registro INFO . - Los comandos
console.warn()tienen el nivel de registro ERROR . - Los comandos
console.error()tienen el nivel de registro ERROR . - Los mensajes internos del sistema tienen el nivel de registro DEBUG .
Ver registros
Los registros de Cloud Functions se pueden ver en la consola de Google Cloud , en la interfaz de usuario de Cloud Logging o mediante la herramienta de línea de comandos firebase .
Usando la CLI de Firebase
Para ver registros con la herramienta firebase , use el comando functions:log :
firebase functions:log
Para ver registros de una función específica, proporcione el nombre de la función como argumento:
firebase functions:log --only <FUNCTION_NAME>
Para conocer la gama completa de opciones de visualización de registros, consulte la ayuda de functions:log :
firebase help functions:log
Usando la consola de Google Cloud
Puedes ver registros de funciones en la consola de Google Cloud .
Uso de la interfaz de usuario de registro en la nube
Puede ver registros de Cloud Functions en la interfaz de usuario de Cloud Logging.
Analizando registros
Cloud Logging ofrece un potente conjunto de herramientas de análisis de registros que puede utilizar para monitorear sus funciones en la nube.
Gráficos y alertas
Una vez que haya creado métricas basadas en registros para monitorear sus funciones, puede crear gráficos y alertas basadas en estas métricas. Por ejemplo, puede crear un gráfico para visualizar la latencia a lo largo del tiempo o crear una alerta para informarle si un determinado error ocurre con demasiada frecuencia.
Consulte Creación de gráficos y alertas para obtener información detallada sobre cómo utilizar métricas basadas en registros en gráficos y políticas de alertas.