Pisz i przeglądaj dzienniki

Rejestrowanie jest ważnym narzędziem do debugowania i monitorowania kodu. Cloud Functions umożliwia korzystanie z pakietu SDK rejestratora, niestandardowego narzędzia Google Cloud Logging lub standardu obiektu console do programowania w Internecie.

Pisanie logów

Chociaż w większości sytuacji zalecany jest pakiet SDK rejestratora Cloud Functions, możesz wybrać jedną z pozostałych opcji z następujących powodów:

• Masz istniejącą bazę kodu i wolisz nie przeprowadzać refaktoryzacji z console.log .
• Znasz usługę Cloud Logging (dawniej rejestrowanie StackDriver) i wolisz używać jej do niestandardowego rejestrowania.

Korzystanie z pakietu SDK rejestratora Cloud Functions

Pakiet SDK rejestratora Cloud Functions udostępnia standardowy interfejs z interfejsem API podobnym do instrukcji console.log i obsługuje inne poziomy dzienników. Za pomocą tego pakietu SDK możesz rejestrować zdarzenia za pomocą uporządkowanych danych , co ułatwia analizę i monitorowanie.

Zestaw 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 skorzystać z eksportu indywidualnego. Ten przykład ilustruje uporządkowane dane dołączone do dziennika 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 dziennika INFO .
• Polecenia logger.info() mają poziom dziennika INFO .
• Polecenia logger.warn() mają poziom dziennika WARNING .
• Polecenia logger.error() mają poziom dziennika ERROR .
• Wewnętrzne komunikaty systemowe posiadają poziom dziennika DEBUG .

Za pomocą logger.write() możesz zapisywać wpisy dziennika, dodając 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);
index.js

Korzystanie z pliku console.log

Zalecanym rozwiązaniem do rejestrowania z funkcji jest użycie zestawu SDK rejestratora . Zamiast tego możesz użyć standardowych wywołań rejestrowania JavaScript, takich jak console.log i console.error , ale najpierw musisz potrzebować specjalnego modułu, aby załatać standardowe metody, aby działały poprawnie:

require("firebase-functions/logger/compat");

Gdy będziesz już potrzebował modułu zgodności z rejestratorem, możesz 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...');
});
index.js

• Polecenia console.log() mają poziom dziennika INFO .
• Polecenia console.info() mają poziom dziennika INFO .
• Polecenia console.warn() mają poziom dziennika ERROR .
• Polecenia console.error() mają poziom dziennika ERROR .
• Wewnętrzne komunikaty systemowe posiadają poziom dziennika DEBUG .

Przeglądanie logów

Dzienniki funkcji Cloud Functions można przeglądać w konsoli Google Cloud , 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 functions:log :

firebase functions:log

Aby wyświetlić logi dla określonej funkcji, podaj nazwę funkcji jako argument:

firebase functions:log --only <FUNCTION_NAME>

Pełny zakres opcji przeglądania logów znajdziesz w pomocy dla functions:log :

firebase help functions:log

Korzystanie z konsoli Google Cloud

Możesz przeglądać logi funkcji w Google Cloud Console .

Korzystanie z interfejsu użytkownika Cloud Logging

Dzienniki Cloud Functions możesz przeglądać w interfejsie Cloud Logging.

Analizowanie logów

Cloud Logging oferuje potężny zestaw narzędzi do analizy logów, których możesz używać do monitorowania Funkcji Cloud.

Wykresy i alerty

Po utworzeniu metryk opartych na dziennikach w celu monitorowania funkcji można tworzyć wykresy i alerty na podstawie tych metryk. Można na przykład utworzyć wykres wizualizujący opóźnienia w czasie lub utworzyć alert informujący o zbyt częstym występowaniu określonego błędu.

Szczegółowe informacje na temat używania metryk opartych na dziennikach na wykresach i zasadach tworzenia alertów można znaleźć w sekcji Tworzenie wykresów i alertów.