Rejestrowanie jest ważnym narzędziem do debugowania i monitorowania kodu. Cloud Functions umożliwia korzystanie z pakietu SDK rejestratora, niestandardowego Google Cloud Logging lub standardu obiektów console do tworzenia aplikacji internetowych.
Zapisywanie dzienników
Chociaż pakiet SDK rejestratora Cloud Functions jest zalecany w większości sytuacji, możesz wybrać jedną z innych opcji z następujących powodów:
- Masz istniejącą bazę kodu i wolisz nie refaktoryzować z
console.log. - Znasz Cloud Logging (dawniej StackDriver logging) i wolisz używać go do rejestrowania niestandardowego.
Korzystanie z pakietu SDK rejestratora Cloud Functions
Zestaw SDK rejestratora Cloud Functions udostępnia standardowy interfejs, który ma podobne interfejsy API do instrukcji console.log i obsługuje inne poziomy rejestrowania. Możesz używać tego pakietu SDK do rejestrowania zdarzeń za pomocą uporządkowanych danych , co ułatwia analizę i monitorowanie.
Pakiet SDK rejestratora obsługuje wpisy dziennika w ramach importu symboli wieloznacznych. Na przykład:
const functions = require("firebase-functions");
functions.logger.log("Hello from info. Here's an object:", someObj);
Alternatywnie możesz użyć pojedynczych eksportów. Ten przykład ilustruje uporządkowane dane dołączone do dziennika jako ostatni argument:
const { warn } = require("firebase-functions/lib/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()mają poziom dziennika INFO . -
logger.info()mają poziom dziennika INFO . -
logger.warn()mają poziom protokołu ERROR . -
logger.error()mają poziom dziennika ERROR . - Wewnętrzne komunikaty systemowe mają poziom dziennika DEBUG .
Za pomocą logger.write() , możesz pisać wpisy w dzienniku, aby dodać poziomy ważności dziennika: CRITICAL , ALERT i EMERGENCY . Zobacz LogSeverity .
Niestandardowe dzienniki Cloud Logging
Dzienniki Cloud Functions z pakietem SDK rejestratora są obsługiwane przez Cloud Logging . Możesz użyć biblioteki Cloud Logging dla Node.js do rejestrowania zdarzeń za pomocą uporządkowanych danych, 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);
Korzystanie console.log
Zalecanym rozwiązaniem do logowania z funkcji jest użycie SDK loggera . Zamiast tego możesz użyć standardowych wywołań rejestrowania JavaScript, takich jak console.log i console.error , ale najpierw potrzebujesz specjalnego modułu, aby załatać standardowe metody, aby działały poprawnie:
require("firebase-functions/lib/logger/compat");
Po zażądaniu modułu zgodności rejestratora można normalnie używać metod console.log() w swoim kodzie:
exports.helloError = functions.https.onRequest((request, response) => {
console.log('I am a log entry!');
response.send('Hello World...');
});
- Polecenia
console.log()mają poziom dziennika INFO . - Polecenia
console.info()mają poziom dziennika INFO . - Polecenia
console.warn()mają poziom protokołu ERROR . - Polecenia
console.error()mają poziom dziennika ERROR . - Wewnętrzne komunikaty systemowe mają poziom dziennika DEBUG .
Przeglądanie dzienników
Dzienniki Cloud Functions można przeglądać w Google Cloud Console , interfejsie użytkownika Cloud Logging lub za pomocą narzędzia wiersza poleceń firebase .
Korzystanie z interfejsu wiersza polecenia Firebase
Aby wyświetlić logi za pomocą narzędzia firebase , użyj polecenia functions:log :
firebase functions:log
Aby wyświetlić logi dla określonej funkcji, podaj nazwę funkcji jako argument:
firebase functions:log --only <FUNCTION_NAME>
Aby zapoznać się z pełnym zakresem opcji przeglądania dziennika, zapoznaj się z pomocą dla functions:log :
firebase help functions:log
Korzystanie z konsoli Google Cloud
Możesz przeglądać dzienniki funkcji w Google Cloud Console .
Korzystanie z interfejsu użytkownika Cloud Logging
Możesz przeglądać dzienniki Cloud Functions w interfejsie użytkownika Cloud Logging.
Analizowanie logów
Cloud Logging oferuje potężny zestaw narzędzi do analizy logów, których można używać do monitorowania funkcji Cloud Functions. Narzędzia te są szczególnie przydatne w połączeniu z rejestrowaniem niestandardowym .
Metryki oparte na logach
W interfejsie użytkownika Cloud Logging użyj pola filtru zaawansowanego, aby zawęzić zakres dziennika do funkcji, którą chcesz przeanalizować, a następnie kliknij opcję Prześlij filtr , aby przefiltrować dzienniki. Na przykład możesz analizować tylko logi z jednej funkcji:
resource.type="cloud_function"
resource.labels.function_name="myCloudFunction"
resource.labels.region="us-central1"
Jeśli rejestrujesz zdarzenia za pomocą niestandardowych ładunków JSON, możesz filtrować za pomocą podanych kluczy i wartości:
resource.type="cloud_function"
resource.labels.function_name="CustomMetrics"
jsonPayload.event="my-event"
Po przefiltrowaniu dzienników możesz je przeanalizować, korzystając ze wskaźników opartych na dziennikach . Kliknij przycisk Utwórz metrykę , aby otworzyć edytor metryk i wybierz typ metryki:
- Metryki liczników: zliczają wpisy dziennika pasujące do filtra. Na przykład możesz policzyć, ile razy wystąpiło określone zdarzenie.
- Metryki dystrybucji: gromadzą dane liczbowe z wpisów dziennika, które pasują do filtra. Na przykład możesz śledzić opóźnienia niektórych operacji w swoich funkcjach.
W przypadku dzienników tekstowych, takich jak te wynikające z funkcji console.log() w funkcjach, można wyodrębnić wartości i etykiety z pola textPayload za pomocą wyrażeń regularnych. W przypadku dzienników niestandardowych z ustrukturyzowanymi danymi możesz uzyskać bezpośredni dostęp do danych w polu jsonPayload .
Wykresy i alerty
Po utworzeniu metryk opartych na dziennikach w celu monitorowania funkcji możesz tworzyć wykresy i alerty na podstawie tych metryk. Na przykład możesz utworzyć wykres, aby zwizualizować opóźnienie w czasie, lub utworzyć alert informujący o tym, że dany błąd występuje zbyt często.
Zobacz Tworzenie wykresów i alertów, aby uzyskać szczegółowe informacje na temat korzystania z metryk opartych na dziennikach w wykresach i zasadach alertów.