O log é uma ferramenta importante para depuração e monitoramento de código. O Cloud Functions oferece a opção de usar o SDK do logger, o Google Cloud Logging personalizado ou o padrão de objeto console
para desenvolvimento para a web.
Escrevendo registros
Embora o SDK do criador de logs do Cloud Functions seja recomendado para a maioria das situações, você pode escolher uma das outras opções por estes motivos:
- Você tem uma base de código existente e prefere não refatorar
console.log
. - Você conhece o Cloud Logging (antigo StackDriver Logging) e prefere usá-lo para registros personalizados.
Como usar o SDK do agente de log do Cloud Functions
O SDK do agente de log do Cloud Functions fornece uma interface padrão que tem uma API semelhante às instruções console.log
e oferece suporte a outros níveis de log. Você pode usar este SDK para registrar eventos com dados estruturados , facilitando a análise e o monitoramento.
O SDK do criador de logs oferece suporte a entradas de log como parte de uma importação curinga. Por exemplo:
const functions = require("firebase-functions");
functions.logger.log("Hello from info. Here's an object:", someObj);
Alternativamente, você pode usar exportações individuais. Este exemplo demonstra dados estruturados anexados ao log como último argumento:
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'
});
- Os comandos
logger.log()
possuem o nível de log INFO . - Os comandos
logger.info()
possuem o nível de log INFO . - Os comandos
logger.warn()
possuem o nível de log WARNING . - Os comandos
logger.error()
possuem o nível de log ERROR . - As mensagens internas do sistema possuem o nível de log DEBUG .
Com logger.write()
, você pode gravar entradas de log com níveis de gravidade adicionais de CRITICAL
, ALERT
e EMERGENCY
. Consulte LogSeverity .
Registros personalizados do Cloud Logging
Os registros do Cloud Functions com o SDK do logger são apoiados pelo Cloud Logging . Você pode usar a biblioteca Cloud Logging para Node.js para registrar eventos com dados estruturados, facilitando a análise e o monitoramento.
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);
Usando console.log
A solução recomendada para registrar em log de uma função é usar o SDK do logger para sua plataforma. Com o Node.js, você pode usar chamadas de log JavaScript padrão, como console.log
e console.error
, mas primeiro você precisa exigir um módulo especial para corrigir os métodos padrão para funcionar corretamente:
require("firebase-functions/logger/compat");
Depois de solicitar o módulo de compatibilidade do logger, você pode usar os métodos console.log()
normalmente em seu código:
exports.helloError = functions.https.onRequest((request, response) => {
console.log('I am a log entry!');
response.send('Hello World...');
});
- Os comandos
console.log()
possuem o nível de log INFO . - Os comandos
console.info()
possuem o nível de log INFO . - Os comandos
console.warn()
possuem o nível de log ERROR . - Os comandos
console.error()
possuem o nível de log ERROR . - As mensagens internas do sistema possuem o nível de log DEBUG .
Visualizando registros
Os registros do Cloud Functions podem ser visualizados no console do Google Cloud , na IU do Cloud Logging ou por meio da ferramenta de linha de comando firebase
.
Usando a CLI do Firebase
Para visualizar logs com a ferramenta firebase
, use o comando functions:log
:
firebase functions:log
Para visualizar os logs de uma função específica, forneça o nome da função como argumento:
firebase functions:log --only <FUNCTION_NAME>
Para conhecer todas as opções de visualização de log, consulte a ajuda de functions:log
:
firebase help functions:log
Como usar o console do Google Cloud
Você pode visualizar registros de funções no console do Google Cloud .
Como usar a IU do Cloud Logging
É possível visualizar registros do Cloud Functions na IU do Cloud Logging.
Analisando registros
O Cloud Logging oferece um conjunto avançado de ferramentas de análise de registros que você pode usar para monitorar o Cloud Functions.
Gráficos e alertas
Depois de criar métricas baseadas em logs para monitorar suas funções, você poderá criar gráficos e alertas com base nessas métricas. Por exemplo, você pode criar um gráfico para visualizar a latência ao longo do tempo ou criar um alerta para informar se um determinado erro ocorre com muita frequência.
Consulte Criação de gráficos e alertas para obter informações detalhadas sobre como usar métricas baseadas em logs em gráficos e políticas de alertas.