Logs schreiben und aufrufen


Das Logging ist ein wichtiges Tool zum Debuggen und Überwachen von Code. Mit Cloud Functions haben Sie die Möglichkeit, das Logger-SDK, benutzerdefinierte Google-Cloud Logging oder das console-Objektstandard für die Webentwicklung zu verwenden.

Logs schreiben

Das Cloud Functions Logger-SDK wird zwar für die meisten Situationen empfohlen, aber aus den folgenden Gründen kann es sinnvoll sein, eine der anderen Optionen zu wählen:

  • Sie haben eine vorhandene Codebasis und möchten nicht von console.log aus refaktorieren.
  • Sie sind mit Cloud Logging (früher Stackdriver Logging) vertraut und bevorzugen es für benutzerdefiniertes Logging.

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 Protokollierungsstufen. Mit diesem SDK können Sie Ereignisse mit strukturierten Daten protokollieren, was die Analyse und Überwachung erleichtert.

Das Logger SDK unterstützt Logeinträge als Teil eines Platzhalterimports. Beispiel:

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

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

Alternativ können Sie einzelne Exporte verwenden. In diesem Beispiel werden strukturierte Daten als letztes Argument an das Log 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 WARNING.
  • 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 Schweregraden CRITICAL, ALERT und EMERGENCY schreiben. Weitere Informationen finden Sie unter LogSeverity.

Benutzerdefinierte Cloud Logging-Logs

Cloud Functions-Logs 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 die Analyse und das Monitoring erleichtert.

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

Die empfohlene Lösung für das Logging aus einer Funktion ist die Verwendung des Logger-SDK für Ihre Plattform. Mit Node.js können Sie stattdessen Standard-JavaScript-Logging-Aufrufe wie console.log und console.error verwenden. Sie müssen jedoch zuerst ein spezielles Modul einbinden, um die Standardmethoden zu patchen, damit sie richtig funktionieren:

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

Nachdem Sie das Logger-Kompatibilitätsmodul eingebunden haben, können Sie die 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-Konsole, 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-Konsole aufrufen.

Cloud Logging-Benutzeroberfläche verwenden

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

Logs analysieren

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

Diagramme und Benachrichtigungen

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

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