Logs schreiben und aufrufen


Logging ist ein wichtiges Tool zum Debuggen und Überwachen von Code. Cloud Functions bietet Ihnen die Möglichkeit, das Logger SDK, benutzerdefinierte Google-Cloud Logging oder den console-Objektstandard für die Entwicklung im Web zu verwenden.

Logs schreiben

Das Cloud Functions Logger SDK wird in den meisten Fällen empfohlen. Unter folgenden Umständen können Sie jedoch eine der anderen Optionen auswählen:

  • Sie haben bereits eine Codebasis und möchten nicht von console.log aus umstrukturieren.
  • Sie sind mit Cloud Logging (früher StackDriver Logging) vertraut und möchten es für benutzerdefiniertes Logging verwenden.

Cloud Functions-Logger-SDK verwenden

Das Cloud Functions-Logger-SDK bietet eine Standardschnittstelle mit einer ähnlichen API wie console.log-Anweisungen und unterstützt andere Protokollebenen. Mit diesem SDK können Sie Ereignisse mit strukturierten Daten erfassen, um Analysen und Monitoring zu vereinfachen.

Das Logger SDK unterstützt Logeinträge im Rahmen eines Platzhalterimports. Beispiel:

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

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

Alternativ können Sie auch einzelne Exporte verwenden. In diesem Beispiel werden strukturierte Daten als letztes Argument an das Protokoll angehängt:

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'
});
  • logger.log()-Befehle haben die Logebene INFO.
  • logger.info()-Befehle haben die Logebene INFO.
  • logger.warn()-Befehle haben die Logebene WARNUNG.
  • logger.error()-Befehle haben die Logebene ERROR.
  • Interne Systemmeldungen haben die Logebene DEBUG.

Mit logger.write() können Sie Logeinträge mit den zusätzlichen Wichtigkeitsstufen CRITICAL, ALERT und EMERGENCY schreiben. Weitere Informationen finden Sie unter LogSeverity.

Benutzerdefinierte Cloud Logging-Protokolle

Cloud Functions-Protokolle mit dem Logger-SDK werden von Cloud Logging unterstützt. Mit der Cloud Logging-Bibliothek für Node.js können Sie Ereignisse mit strukturierten Daten protokollieren, was eine einfachere Analyse und Überwachung ermöglicht.

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

console.log verwenden

Wir empfehlen, für das Logging aus einer Funktion das Logger SDK für Ihre Plattform zu verwenden. Mit Node.js können Sie stattdessen standardmäßige JavaScript-Loggingaufrufe wie console.log und console.error verwenden. Sie müssen jedoch zuerst ein spezielles Modul anfordern, um die Standardmethoden zu patchen, damit sie richtig funktionieren:

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

Sobald Sie das Logger-Kompatibilitätsmodul erforderlich gemacht haben, können Sie console.log()-Methoden wie gewohnt in Ihrem Code verwenden:

exports.helloError = functions.https.onRequest((request, response) => {
  console.log('I am a log entry!');
  response.send('Hello World...');
});
index.js
  • console.log()-Befehle haben die Logebene INFO.
  • console.info()-Befehle haben die Logebene INFO.
  • console.warn()-Befehle haben die Logebene ERROR.
  • console.error()-Befehle haben die Logebene ERROR.
  • Interne Systemmeldungen haben die Logebene DEBUG.

Logs ansehen

Logs für Cloud Functions können entweder in der Google Cloud Console, in der Cloud Logging-Benutzeroberfläche oder über das firebase-Befehlszeilentool aufgerufen werden.

Mit der Firebase CLI

Wenn Sie Logs mit dem firebase-Tool aufrufen möchten, verwenden Sie den Befehl functions:log:

firebase functions:log

Wenn Sie Logs für eine bestimmte Funktion aufrufen möchten, geben Sie den Funktionsnamen als Argument an:

firebase functions:log --only <FUNCTION_NAME>

Informationen zu allen Loganzeigeoptionen finden Sie in der Hilfe zu functions:log:

firebase help functions:log

Google Cloud-Konsole verwenden

Sie können Logs für Funktionen in der Google Cloud Console aufrufen.

Cloud Logging-Benutzeroberfläche verwenden

Sie können sich Logs für Cloud Functions in der Cloud Logging-Benutzeroberfläche ansehen.

Logs analysieren

Cloud Logging bietet eine leistungsstarke Suite von Tools zur Protokollanalyse, mit denen Sie Ihre Cloud Functions im Blick behalten können.

Diagramme und Benachrichtigungen

Nachdem Sie logbasierte Messwerte zum Überwachen Ihrer Funktionen erstellt haben, können Sie Diagramme und Benachrichtigungen auf der Grundlage dieser Messwerte erstellen. Sie können beispielsweise ein Diagramm erstellen, um die Latenz im Zeitverlauf zu visualisieren, oder eine Benachrichtigung, die Sie informiert, wenn ein bestimmter Fehler zu oft auftritt.

Ausführliche Informationen zur Verwendung von logbasierten Messwerten in Diagrammen und Benachrichtigungsrichtlinien finden Sie unter Diagramme und Benachrichtigungen erstellen.