Ведение журналов – важный инструмент для отладки и мониторинга кода.
Cloud Functions позволяет использовать SDK для ведения журналов, специальный объект Google Cloud Logging или стандартный объект console для веб-разработки.
Запись журналов
Хотя SDK Cloud Functions logger рекомендуется для большинства ситуаций, вы можете выбрать один из других вариантов по следующим причинам:
- У вас есть база кода, и вы не хотите проводить рефакторинг из
console.log. - Вы знакомы с Cloud Logging (ранее – StackDriver Logging) и предпочитаете использовать этот сервис для ведения журналов.
Как использовать SDK для ведения журнала Cloud Functions
SDK регистратора Cloud Functions предоставляет стандартный интерфейс с API, похожим на операторы console.log, и поддерживает другие уровни ведения журнала.
Этот SDK позволяет регистрировать события со структурированными данными, что упрощает анализ и мониторинг.
SDK регистратора поддерживает записи в журнале в рамках импорта с подстановочными знаками. Пример:
const functions = require("firebase-functions/v1");
functions.logger.log("Hello from info. Here's an object:", someObj);
Вы также можете экспортировать отдельные данные. В этом примере показаны структурированные данные, прикрепленные к журналу в качестве последнего аргумента:
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'
});
- Команды
logger.log()имеют уровень ведения журнала INFO. - Команды
logger.info()имеют уровень ведения журнала INFO. - Команды
logger.warn()имеют уровень ведения журнала WARNING. logger.error()команд имеют уровень журнала ERROR.- Внутренние системные сообщения имеют уровень журнала DEBUG.
С помощью logger.write() вы можете добавлять записи в журнал с дополнительными уровнями серьезности: CRITICAL, ALERT и EMERGENCY. Подробнее о LogSeverity…
Специальные журналы Cloud Logging
Журналы Cloud Functions с SDK регистратора поддерживаются Cloud Logging. Вы можете использовать библиотеку Cloud Logging для Node.js, чтобы регистрировать события со структурированными данными, что упрощает анализ и мониторинг.
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);
Использование console.log
Для ведения журналов из функции рекомендуется использовать SDK регистратора для вашей платформы. В Node.js можно использовать стандартные вызовы JavaScript для ведения журналов, например console.log и console.error, но сначала необходимо запросить специальный модуль, чтобы исправить стандартные методы для правильной работы:
require("firebase-functions/logger/compat");
После того как вы подключите модуль совместимости, вы сможете использовать методы console.log() в своем коде:
exports.helloError = functions.https.onRequest((request, response) => {
console.log('I am a log entry!');
response.send('Hello World...');
});
- Команды
console.log()имеют уровень ведения журнала INFO. - Команды
console.info()имеют уровень ведения журнала INFO. console.warn()команд имеют уровень журнала ERROR.console.error()команд имеют уровень журнала ERROR.- Внутренние системные сообщения имеют уровень журнала DEBUG.
Просмотр журналов
Журналы для Cloud Functions можно просматривать в консоли Google Cloud, интерфейсе Cloud Logging или с помощью инструмента командной строки firebase.
Использование интерфейса командной строки Firebase
Чтобы посмотреть журналы с помощью инструмента firebase, используйте команду functions:log:
firebase functions:log
Чтобы посмотреть журналы для определенной функции, укажите ее название в качестве аргумента:
firebase functions:log --only <FUNCTION_NAME>
Чтобы узнать обо всех возможностях просмотра журналов, ознакомьтесь со справкой по functions:log:
firebase help functions:log
Использование консоли Google Cloud
Журналы функций можно просматривать в консоли Google Cloud.
Использование интерфейса Cloud Logging
Вы можете посмотреть журналы для Cloud Functions в интерфейсе Cloud Logging.
Анализ журналов
Cloud Logging предлагает мощный набор инструментов для анализа журналов, которые можно использовать для мониторинга Cloud Functions.
Диаграммы и оповещения
После того как вы создали показатели на основе данных журналов для отслеживания функций, вы можете создавать диаграммы и оповещения на основе этих показателей. Например, вы можете создать диаграмму для визуализации задержки во времени или создать оповещение, чтобы сообщить вам, если определенная ошибка возникает слишком часто.
Подробную информацию о том, как использовать показатели на основе данных журналов в диаграммах и правилах оповещений, можно найти в статье Создание диаграмм и оповещений.