Logowanie to ważne narzędzie do debugowania i monitorowania kodu.
Cloud Functions daje możliwość korzystania z pakietu SDK do logowania, niestandardowego Cloud Logging Google lub standardu obiektu console do tworzenia aplikacji internetowych.
Zapisuję dzienniki
Chociaż pakiet SDK Cloud Functions logger jest zalecany w większości sytuacji, możesz wybrać jedną z innych opcji z tych powodów:
- Masz już bazę kodu i nie chcesz jej refaktoryzować z
console.log. - Znasz Cloud Logging (dawniej StackDriver Logging) i wolisz używać tej usługi do niestandardowego logowania.
Korzystanie z pakietu SDK Cloud Functions do logowania
Pakiet SDK do logowania Cloud Functions udostępnia standardowy interfejs, który ma interfejs API podobny do instrukcji console.log i obsługuje inne poziomy logowania.
Za pomocą tego pakietu SDK możesz rejestrować zdarzenia z uporządkowanymi danymi, co ułatwia analizę i monitorowanie.
Pakiet SDK loggera obsługuje wpisy logu w ramach importu z użyciem symbolu wieloznacznego. Przykład:
const functions = require("firebase-functions/v1");
functions.logger.log("Hello from info. Here's an object:", someObj);
Możesz też użyć eksportów indywidualnych. Ten przykład pokazuje dane strukturalne dołączone do logu jako ostatni 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'
});
- Polecenia
logger.log()mają poziom logowania INFO. - Polecenia
logger.info()mają poziom logowania INFO. - Polecenia
logger.warn()mają poziom logowania WARNING. - Polecenia
logger.error()mają poziom logu ERROR. - Wewnętrzne komunikaty systemowe mają poziom logowania DEBUG.
W logger.write() możesz zapisywać wpisy logu z dodatkowymi poziomami ważności: CRITICAL, ALERT i EMERGENCY. Zobacz LogSeverity.
Logi niestandardowe Cloud Logging
Logi Cloud Functions z pakietu SDK loggera są obsługiwane przez Cloud Logging. Możesz użyć biblioteki Cloud Logging dla Node.js, aby rejestrować zdarzenia z danymi ustrukturyzowanymi, co ułatwia analizę i monitorowanie.
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);
Jak korzystać z aplikacji console.log
Zalecanym rozwiązaniem do logowania z funkcji jest użycie pakietu SDK loggera dla Twojej platformy. W Node.js możesz zamiast tego używać standardowych wywołań logowania JavaScript, takich jak console.log i console.error, ale najpierw musisz zażądać specjalnego modułu, aby zastosować poprawki do standardowych metod, aby działały prawidłowo:
require("firebase-functions/logger/compat");
Po zażądaniu modułu zgodności z loggerem możesz używać metod console.log() w kodzie w zwykły sposób:
exports.helloError = functions.https.onRequest((request, response) => {
console.log('I am a log entry!');
response.send('Hello World...');
});
- Polecenia
console.log()mają poziom logowania INFO. - Polecenia
console.info()mają poziom logowania INFO. - Polecenia
console.warn()mają poziom logu ERROR. - Polecenia
console.error()mają poziom logu ERROR. - Wewnętrzne komunikaty systemowe mają poziom logowania DEBUG.
Wyświetlanie logów
Logi dla Cloud Functions można wyświetlić w konsoli Google Cloud, interfejsie Cloud Logging lub za pomocą narzędzia wiersza poleceń firebase.
Korzystanie z wiersza poleceń Firebase
Aby wyświetlić logi za pomocą narzędzia firebase, użyj polecenia functions:log:
firebase functions:log
Aby wyświetlić logi konkretnej funkcji, podaj jej nazwę jako argument:
firebase functions:log --only <FUNCTION_NAME>
Pełną listę opcji wyświetlania logów znajdziesz w pomocy dotyczącej functions:log:
firebase help functions:log
Korzystanie z konsoli Google Cloud
Logi funkcji możesz wyświetlać w konsoli Google Cloud.
Korzystanie z interfejsu Cloud Logging
Możesz wyświetlić logi dla Cloud Functions w interfejsie Cloud Logging.
Analizowanie logów
Cloud Logging oferuje zaawansowany zestaw narzędzi do analizy logów, których możesz używać do monitorowania Cloud Functions.
Wykresy i alerty
Po utworzeniu wskaźników opartych na logach do monitorowania funkcji możesz tworzyć wykresy i alerty na podstawie tych wskaźników. Możesz na przykład utworzyć wykres, aby zwizualizować czas oczekiwania, lub alert, który powiadomi Cię, jeśli dany błąd będzie występował zbyt często.
Szczegółowe informacje o tym, jak używać wskaźników opartych na logach na wykresach i w zasadach tworzenia alertów, znajdziesz w artykule o tworzeniu wykresów i alertów.