Zapisywanie i wyświetlanie logów

Logowanie to ważne narzędzie do debugowania i monitorowania kodu. Cloud Functions umożliwia wykorzystanie pakietu SDK rejestrującego, niestandardowego pakietu SDK, Cloud Logging lub standard obiektów console do programowania do aplikacji internetowych.

Zapisuję dzienniki

Podczas gdy rejestrator Cloud Functions Pakiet SDK jest zalecany w większości przypadków, możesz wybrać jedną z pozostałych opcji z następujących powodów:

• Masz już bazę kodu i nie chcesz refaktoryzować wersji console.log.
• Znasz usługę Cloud Logging (dawniej StackDriver Logging) i preferujesz aby używać go do rejestrowania niestandardowego.

Korzystanie z pakietu SDK rejestratora Cloud Functions

Pakiet SDK rejestratora Cloud Functions to standardowy interfejs z funkcją 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 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. Ten przykład pokazuje, 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 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 oraz poziomów ważności logów. z CRITICAL, ALERT i EMERGENCY. Zobacz Poziom ważności logu.

Niestandardowe logi Cloud Logging

Logi Cloud Functions za pomocą pakietu SDK rejestrującego 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

Jak korzystać z aplikacji console.log

Zalecanym rozwiązaniem w przypadku logowania z funkcji jest użycie pakietu SDK rejestratora dla Twojej platformy. W Node.js możesz zamiast tego używać standardowego logowania JavaScriptu takich jak console.log i console.error, ale najpierw musisz skonfigurować specjalny, który zawiera poprawki standardowych metod, aby działały prawidłowo:

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

Gdy jest wymagany moduł zgodności rejestrujący, możesz używać console.log() metod jak zwykle w 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świetlić w Google Cloud Console, interfejsu 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

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

Analizuję logi

Cloud Logging to zaawansowany zestaw narzędzi do analizy logów, których używasz do monitorowania funkcji w 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 pozwalający zwizualizować czas oczekiwania w czasie lub utworzyć alert z powiadomieniem jeśli dany błąd występuje zbyt często.

Szczegółowe informacje na ten temat znajdziesz w artykule Tworzenie wykresów i alertów. aby używać wskaźników opartych na logach w wykresach i zasadach tworzenia alertów.