Zapisywanie i wyświetlanie logów

Logowanie to ważne narzędzie do debugowania i monitorowania kodu. Cloud Functions umożliwia korzystanie z pakietu SDK rejestratora, niestandardowego pakietu Google Cloud Logging lub standardu obiektów console do programowania w internecie.

Zapisuję dzienniki

Chociaż w większości przypadków sprawdza się pakiet SDK logger Cloud Functions, możesz wybrać jedną z innych opcji z tych powodów:

• Masz już bazę kodu i nie chcesz refaktoryzować wersji console.log.
• Znasz 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 to standardowy interfejs mający interfejs podobny do instrukcji console.log oraz obsługuje inne poziomy logu. Za pomocą tego pakietu SDK możesz rejestrować zdarzenia za pomocą uporządkowanych danych, ułatwiając analizę i monitorowanie.

Pakiet SDK rejestratora obsługuje wpisy logu w ramach importu 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ć pojedynczych eksportów. W tym przykładzie pokazano 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 logowania WARNING.
• Polecenia logger.error() mają poziom logu ERROR.
• Wewnętrzne komunikaty systemowe mają poziom logu DEBUG.

logger.write() umożliwia zapisywanie wpisów logu i dodatkowych poziomów ważności logów CRITICAL, ALERT i EMERGENCY. Zobacz Poziom ważności logu.

Niestandardowe logi Cloud Logging

Logi Cloud Functions za pomocą pakietu SDK dzienników obsługują 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);
index.js

Jak korzystać z aplikacji console.log

Zalecanym rozwiązaniem w przypadku logowania z funkcji jest użycie na swojej platformie pakietu SDK rejestrującego. W Node.js możesz zamiast tego używać standardowych wywołań logowania JavaScriptu, np. console.log i console.error, ale najpierw potrzebujesz specjalnego modułu, by zainstalować poprawki standardowych metod, aby działały prawidłowo:

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

Gdy wymagany jest moduł zgodności rejestrujących, możesz używać metod console.log() w zwykłym 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 logu INFO.
• Polecenia console.info() mają poziom logu INFO.
• Polecenia console.warn() mają poziom logu ERROR.
• Polecenia console.error() mają poziom logu ERROR.
• Wewnętrzne komunikaty systemowe mają poziom logu DEBUG.

Wyświetlanie logów

Logi Cloud Functions można wyświetlać 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 dotyczące konkretnej funkcji, podaj jej nazwę jako argument:

firebase functions:log --only <FUNCTION_NAME>

Aby poznać wszystkie opcje wyświetlania logów, wyświetl pomoc do functions:log:

firebase help functions:log

W konsoli Google Cloud

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

Korzystanie z interfejsu Cloud Logging

Logi Cloud Functions możesz wyświetlać w interfejsie Cloud Logging.

Analizuję logi

Usługa Cloud Logging zapewnia zaawansowany zestaw narzędzi do analizy logów, których można 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żesz na przykład utworzyć wykres, aby wizualizować czas oczekiwania w czasie, lub utworzyć alert informujący o tym, że dany błąd występuje zbyt często.

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.