Zapisywanie i wyświetlanie logów


Logowanie jest ważnym narzędziem do debugowania i monitorowania kodu. Do tworzenia aplikacji internetowych w Cloud Functions można używać pakietu SDK rejestrującego, niestandardowego pakietu Google Cloud Logging lub standardu obiektów console.

Zapisywanie logów

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

  • Masz już bazę kodu i nie chcesz korzystać z refaktoryzacji z usługi console.log.
  • Znasz już usługę Cloud Logging (dawniej StackDriver) i wolisz używać jej do logowania niestandardowego.

Korzystanie z pakietu SDK rejestratora Cloud Functions

Pakiet SDK rejestratora Cloud Functions ma standardowy interfejs, który ma interfejs API podobny do instrukcji console.log i obsługuje inne poziomy logu. Za pomocą tego pakietu SDK możesz rejestrować zdarzenia za pomocą uporządkowanych danych, co ułatwia analizę i monitorowanie.

Pakiet SDK rejestratora obsługuje wpisy logu w ramach importu przy użyciu symboli wieloznacznych. Przykład:

  const functions = require("firebase-functions");

  functions.logger.log("Hello from info. Here's an object:", someObj);

Możesz też użyć poszczególnych eksportów. Ten przykład pokazuje uporządkowane dane 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 logu INFO.
  • Polecenia logger.info() mają poziom logu INFO.
  • Polecenia logger.warn() mają poziom rejestrowania WARNING.
  • Polecenia logger.error() mają poziom rejestrowania ERROR.
  • Wewnętrzne komunikaty systemowe mają poziom rejestrowania DEBUG.

Dzięki logger.write() możesz zapisywać dodatkowe poziomy ważności logu wpisów logu o poziomach CRITICAL, ALERT i EMERGENCY. Zobacz LogSeverity.

Niestandardowe logi Cloud Logging

Logi Cloud Functions z pakietem SDK rejestratora są obsługiwane przez Cloud Logging. Możesz użyć biblioteki Cloud Logging dla Node.js, aby rejestrować zdarzenia 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);

Jak korzystać z aplikacji console.log

Zalecanym rozwiązaniem do logowania z funkcji jest użycie na platformie pakietu SDK rejestratora. W środowisku Node.js możesz zamiast tego używać standardowych wywołań logowania JavaScript, takich jak console.log i console.error, ale najpierw musisz skonfigurować specjalny moduł, żeby poprawić standardowe metody:

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

Gdy wymagany moduł zgodności rejestratora będzie potrzebny, możesz w zwykły sposób używać w kodzie metod console.log():

exports.helloError = functions.https.onRequest((request, response) => {
  console.log('I am a log entry!');
  response.send('Hello World...');
});
  • Polecenia console.log() mają poziom logu INFO.
  • Polecenia console.info() mają poziom logu INFO.
  • Polecenia console.warn() mają poziom rejestrowania ERROR.
  • Polecenia console.error() mają poziom rejestrowania ERROR.
  • Wewnętrzne komunikaty systemowe mają poziom rejestrowania DEBUG.

Wyświetlanie logów

Logi Cloud Functions można wyświetlać w konsoli Google Cloud, interfejsie użytkownika 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>

Aby uzyskać pełny zakres opcji wyświetlania logów, zapoznaj się z pomocą dotyczącą functions:log:

firebase help functions:log

Przy użyciu konsoli Google Cloud

Logi funkcji możesz wyświetlać w konsoli Google Cloud.

Korzystanie z interfejsu użytkownika Cloud Logging

Możesz wyświetlać logi Cloud Functions w interfejsie Cloud Logging.

Analizuję logi

Cloud Logging udostępnia zaawansowany zestaw narzędzi do analizy logów, których możesz używać do monitorowania funkcji w Cloud Functions.

Wykresy i alerty

Po utworzeniu wskaźników opartych na logach do monitorowania funkcji możesz tworzyć na ich podstawie wykresy i alerty. Można np. utworzyć wykres przedstawiający czas oczekiwania na przestrzeni czasu lub utworzyć alert informujący o zbyt częstym wystąpieniu danego błędu.

Szczegółowe informacje o korzystaniu ze wskaźników opartych na logach na wykresach i w zasadach tworzenia alertów znajdziesz w artykule Tworzenie wykresów i alertów.