Funktionen verwalten


Sie können Funktionen mit Firebase-CLI-Befehlen bereitstellen, löschen und ändern oder Laufzeitoptionen im Quellcode Ihrer Funktionen festlegen.

Funktionen bereitstellen

Führen Sie den folgenden Firebase-CLI-Befehl aus, um Funktionen bereitzustellen:

firebase deploy --only functions

Standardmäßig werden mit der Firebase-Befehlszeile alle Funktionen in Ihrer Quelle gleichzeitig bereitgestellt. Wenn Ihr Projekt mehr als fünf Funktionen enthält, empfehlen wir, das Flag --only mit bestimmten Funktionsnamen zu verwenden, um nur die Funktionen bereitzustellen, die Sie bearbeitet haben. Bestimmte Funktionen auf diese Weise bereitzustellen, beschleunigt den Bereitstellungsprozess und hilft Ihnen, Bereitstellungskontingente zu vermeiden. Beispiel:

firebase deploy --only functions:addMessage,functions:makeUppercase

Wenn Sie eine große Anzahl von Funktionen bereitstellen, überschreiten Sie möglicherweise das Standardkontingent und erhalten HTTP-Fehlermeldungen vom Typ 429 oder 500. Um dieses Problem zu beheben, stellen Sie Funktionen in Gruppen von maximal 10 Funktionen bereit.

Eine vollständige Liste der verfügbaren Befehle finden Sie in der Firebase-Befehlszeilenreferenz.

Standardmäßig sucht die Firebase-Befehlszeile im Ordner functions/ nach dem Quellcode. Alternativ können Sie Funktionen in Codebases oder mehreren Dateisätzen organisieren.

Bereitstellungsartefakte bereinigen

Im Rahmen der Bereitstellung von Funktionen werden Container-Images generiert und in Artifact Registry gespeichert. Diese Bilder sind nicht erforderlich, damit Ihre bereitgestellten Funktionen ausgeführt werden können. Cloud Functions ruft beim ersten Bereitstellen eine Kopie des Bildes ab und behält sie bei. Die gespeicherten Artefakte sind jedoch nicht erforderlich, damit die Funktion zur Laufzeit funktioniert.

Diese Container-Images sind zwar oft klein, können sich aber im Laufe der Zeit ansammeln und zu Ihren Speicherkosten beitragen. Möglicherweise möchten Sie sie für einen bestimmten Zeitraum beibehalten, wenn Sie die erstellten Artefakte prüfen oder Container-Schwachstellenscans ausführen möchten.

Um die Speicherkosten zu senken, können Sie mit der Firebase-Befehlszeile 14.0.0 und höher eine Artifact Registry-Bereinigungsrichtlinie für Repositories konfigurieren, in denen nach jeder Funktionsbereitstellung Bereitstellungsartefakte gespeichert werden.

Sie können eine Bereinigungsrichtlinie manuell mit dem Befehl functions:artifacts:setpolicy einrichten oder bearbeiten:

firebase functions:artifacts:setpolicy

Standardmäßig konfiguriert dieser Befehl Artifact Registry so, dass Container-Images, die älter als ein Tag sind, automatisch gelöscht werden. So wird ein angemessenes Gleichgewicht zwischen der Minimierung der Speicherkosten und der Möglichkeit, aktuelle Builds zu prüfen, erreicht.

Sie können den Aufbewahrungszeitraum mit der Option --days anpassen:

firebase functions:artifacts:setpolicy --days 7  # Delete images older than 7 days

Wenn Sie Funktionen in mehreren Regionen bereitstellen, können Sie mit der Option --location eine Bereinigungsrichtlinie für einen bestimmten Standort einrichten:

$ firebase functions:artifacts:setpolicy --location europe-west1

Bereinigung von Artefakten deaktivieren

Wenn Sie die Bereinigung von Bildern lieber manuell verwalten oder keine Bilder löschen lassen möchten, können Sie die Bereinigungsrichtlinien vollständig deaktivieren:

$ firebase functions:artifacts:setpolicy --none

Mit diesem Befehl wird jede vorhandene Bereinigungsrichtlinie entfernt, die von der Firebase CLI eingerichtet wurde. Außerdem wird verhindert, dass Firebase nach der Bereitstellung von Funktionen eine Bereinigungsrichtlinie einrichtet.

Funktionen löschen

Sie können zuvor bereitgestellte Funktionen auf folgende Arten löschen:

  • explizit in der Firebase CLI mit functions:delete
  • explizit in der Google Cloud-Konsole.
  • implizit, indem Sie die Funktion vor der Bereitstellung aus der Quelle entfernen.

Bei allen Löschvorgängen werden Sie aufgefordert, die Entfernung der Funktion aus der Produktion zu bestätigen.

Das explizite Löschen von Funktionen in der Firebase CLI unterstützt mehrere Argumente sowie Funktionsgruppen und ermöglicht es Ihnen, eine Funktion anzugeben, die in einer bestimmten Region ausgeführt wird. Sie können die Bestätigungsaufforderung auch überspringen.

# Delete all functions that match the specified name in all regions.
firebase functions:delete myFunction

# Delete a specified function running in a specific region.
firebase functions:delete myFunction --region us-east-1

# Delete more than one function
firebase functions:delete myFunction myOtherFunction

# Delete a specified functions group.
firebase functions:delete groupA

# Bypass the confirmation prompt.
firebase functions:delete myFunction --force

Bei der impliziten Funktionslöschung wird Ihre Quelle von firebase deploy geparst und alle Funktionen, die aus der Datei entfernt wurden, werden aus der Produktion entfernt.

Name, Region oder Trigger einer Funktion ändern

Wenn Sie Funktionen, die Produktions-Traffic verarbeiten, umbenennen oder die Region oder den Trigger für diese Funktionen ändern, folgen Sie der Anleitung in diesem Abschnitt, um zu vermeiden, dass Ereignisse während der Änderung verloren gehen. Bevor Sie diese Schritte ausführen, sollten Sie prüfen, ob Ihre Funktion idempotent ist, da während der Umstellung sowohl die neue als auch die alte Version Ihrer Funktion gleichzeitig ausgeführt werden.

Funktion umbenennen

Wenn Sie eine Funktion umbenennen möchten, erstellen Sie eine neue umbenannte Version der Funktion in Ihrer Quelle und führen Sie dann zwei separate Bereitstellungsbefehle aus. Mit dem ersten Befehl wird die neu benannte Funktion bereitgestellt und mit dem zweiten Befehl wird die zuvor bereitgestellte Version entfernt. Wenn Sie beispielsweise eine Node.js-Funktion mit dem Namen webhook in webhookNew ändern möchten, überarbeiten Sie den Code so:

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

// after
const functions = require('firebase-functions/v1');

exports.webhookNew = functions.https.onRequest((req, res) => {
    res.send("Hello");
});

Führen Sie dann die folgenden Befehle aus, um die neue Funktion bereitzustellen:

# Deploy new function called webhookNew
firebase deploy --only functions:webhookNew

# Wait until deployment is done; now both webhookNew and webhook are running

# Delete webhook
firebase functions:delete webhook

Region oder Regionen einer Funktion ändern

Wenn Sie die angegebenen Regionen für eine Funktion ändern, die Produktions-Traffic verarbeitet, können Sie Datenverlust verhindern, indem Sie die folgenden Schritte in der angegebenen Reihenfolge ausführen:

  1. Benennen Sie die Funktion um und ändern Sie die Region oder Regionen nach Bedarf.
  2. Stellen Sie die umbenannte Funktion bereit. Dadurch wird derselbe Code vorübergehend in beiden Regionen ausgeführt.
  3. Löschen Sie die vorherige Funktion.

Wenn Sie beispielsweise eine Funktion namens webhook haben, die sich derzeit in der Standardregion für Funktionen us-central1 befindet, und Sie sie zu asia-northeast1 migrieren möchten, müssen Sie zuerst den Quellcode ändern, um die Funktion umzubenennen und die Region zu überarbeiten.

// before
const functions = require('firebase-functions/v1');

exports.webhook = functions
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

// after
const functions = require('firebase-functions/v1');

exports.webhookAsia = functions
    .region('asia-northeast1')
    .https.onRequest((req, res) => {
            res.send("Hello");
    });

Stellen Sie die Funktion dann mit dem folgenden Befehl bereit:

firebase deploy --only functions:webhookAsia

Jetzt werden zwei identische Funktionen ausgeführt: webhook wird in us-central1 ausgeführt und webhookAsia in asia-northeast1.

Löschen Sie dann webhook:

firebase functions:delete webhook

Jetzt gibt es nur noch eine Funktion: webhookAsia, die in asia-northeast1 ausgeführt wird.

Triggertyp einer Funktion ändern

Im Laufe der Zeit kann es aus verschiedenen Gründen erforderlich sein, den Triggertyp einer Funktion zu ändern.Cloud Functions for Firebase Sie möchten beispielsweise von einem Firebase Realtime Database- oder Cloud Firestore-Ereignistyp zu einem anderen wechseln.

Der Ereignistyp einer Funktion kann nicht geändert werden, indem Sie nur den Quellcode ändern und firebase deploy ausführen. So ändern Sie den Auslösertyp einer Funktion, um Fehler zu vermeiden:

  1. Ändern Sie den Quellcode, um eine neue Funktion mit dem gewünschten Triggertyp einzufügen.
  2. Stellen Sie die Funktion bereit. Dadurch werden sowohl die alte als auch die neue Funktion vorübergehend ausgeführt.
  3. Löschen Sie die alte Funktion explizit aus der Produktion mit der Firebase-CLI.

Wenn Sie beispielsweise eine Node.js-Funktion mit dem Namen objectChanged haben, die den Legacy-Ereignistyp onChange verwendet, und Sie sie in onFinalize ändern möchten, benennen Sie die Funktion zuerst um und bearbeiten Sie sie dann so, dass sie den Ereignistyp onFinalize verwendet.

// before
const functions = require('firebase-functions/v1');

exports.objectChanged = functions.storage.object().onChange((object) => {
    return console.log('File name is: ', object.name);
});

// after
const functions = require('firebase-functions/v1');

exports.objectFinalized = functions.storage.object().onFinalize((object) => {
    return console.log('File name is: ', object.name);
});

Führen Sie dann die folgenden Befehle aus, um zuerst die neue Funktion zu erstellen, bevor Sie die alte Funktion löschen:

# Create new function objectFinalized
firebase deploy --only functions:objectFinalized

# Wait until deployment is done; now both objectChanged and objectFinalized are running

# Delete objectChanged
firebase functions:delete objectChanged

Laufzeitoptionen festlegen

Mit Cloud Functions for Firebase können Sie Laufzeitoptionen wie die Node.js-Laufzeitversion und das Timeout pro Funktion, die Speicherzuweisung und die Mindest-/Höchstanzahl von Funktionsinstanzen auswählen.

Als Best Practice sollten diese Optionen (mit Ausnahme der Node.js-Version) in einem Konfigurationsobjekt im Funktionscode festgelegt werden. Dieses RuntimeOptions-Objekt ist die Quelle der Wahrheit für die Laufzeitoptionen Ihrer Funktion und überschreibt Optionen, die über eine andere Methode festgelegt wurden (z. B. über die Google Cloud Console oder die gcloud CLI).

Wenn Sie in Ihrem Entwicklungsablauf Laufzeitoptionen manuell über die Google Cloud Console oder die gcloud CLI festlegen und nicht möchten, dass diese Werte bei jeder Bereitstellung überschrieben werden, setzen Sie die Option preserveExternalChanges auf true. Wenn diese Option auf true festgelegt ist, werden die in Ihrem Code festgelegten Laufzeitoptionen von Firebase mit den Einstellungen der aktuell bereitgestellten Version Ihrer Funktion zusammengeführt. Dabei gilt die folgende Priorität:

  1. Die Option ist im Funktionscode festgelegt: externe Änderungen werden überschrieben.
  2. Die Option ist im Funktionscode auf RESET_VALUE festgelegt: Externe Änderungen werden mit dem Standardwert überschrieben.
  3. Die Option ist nicht im Funktionscode festgelegt, sondern in der aktuell bereitgestellten Funktion: Verwenden Sie die in der bereitgestellten Funktion angegebene Option.

Die Verwendung der Option preserveExternalChanges: true ist für die meisten Szenarien nicht empfehlenswert, da Ihr Code nicht mehr die vollständige Quelle der Wahrheit für Laufzeitoptionen für Ihre Funktionen ist. Wenn Sie sie verwenden, sehen Sie sich die vollständige Konfiguration einer Funktion in der Google Cloud Console an oder verwenden Sie die gcloud CLI.

Node.js-Version festlegen

Das Firebase SDK für Cloud Functions ermöglicht die Auswahl einer Node.js-Laufzeit. Sie können alle Funktionen in einem Projekt ausschließlich in der Laufzeitumgebung ausführen, die einer dieser unterstützten Node.js-Versionen entspricht:

  • Node.js 20
  • Node.js 18 (verworfen)

Wichtige Informationen zum laufenden Support für diese Node.js-Versionen finden Sie im Supportzeitplan.

So legen Sie die Node.js-Version fest:

Sie können die Version im Feld engines in der Datei package.json festlegen, die während der Initialisierung in Ihrem Verzeichnis functions/ erstellt wurde. Wenn Sie beispielsweise nur Version 20 verwenden möchten, bearbeiten Sie diese Zeile in package.json:

  "engines": {"node": "20"}

Wenn Sie den Yarn-Paketmanager verwenden oder andere spezifische Anforderungen für das Feld engines haben, können Sie die Laufzeit für das Firebase SDK für Cloud Functions stattdessen in firebase.json festlegen:

  {
    "functions": {
      "runtime": "nodejs20"
    }
  }

In der CLI wird der in firebase.json festgelegte Wert bevorzugt gegenüber allen Werten oder Bereichen verwendet, die Sie separat in package.json festlegen.

Node.js-Laufzeit aktualisieren

So aktualisieren Sie die Node.js-Laufzeit:

  1. Ihr Projekt muss den Blaze-Tarif haben.
  2. Sie benötigen die Firebase CLI-Version 11.18.0 oder höher.
  3. Ändern Sie den Wert engines in der Datei package.json, die während der Initialisierung in Ihrem Verzeichnis functions/ erstellt wurde. Wenn Sie beispielsweise ein Upgrade von Version 16 auf Version 18 durchführen, sollte der Eintrag so aussehen: "engines": {"node": "18"}
  4. Optional können Sie Ihre Änderungen mit dem Firebase Local Emulator Suite testen.
  5. Stellen Sie alle Funktionen noch einmal bereit.

Skalierungsverhalten steuern

Standardmäßig skaliert Cloud Functions for Firebase die Anzahl der ausgeführten Instanzen basierend auf der Anzahl der eingehenden Anfragen. Bei geringem Traffic kann die Anzahl der Instanzen auf null reduziert werden. Wenn Ihre App jedoch eine geringere Latenz erfordert und Sie die Anzahl von Kaltstarts begrenzen möchten, können Sie dieses Standardverhalten ändern. Dazu geben Sie eine Mindestanzahl von Containerinstanzen an, die einsatzbereit sind und Anfragen bedienen können.

Sie können auch eine maximale Anzahl festlegen, um die Skalierung von Instanzen als Reaktion auf eingehende Anfragen zu begrenzen. Verwenden Sie diese Einstellung, um Ihre Kosten zu kontrollieren oder die Anzahl der Verbindungen zu einem Sicherungsdienst zu begrenzen, z. B. zu einer Datenbank.

Anzahl der Kaltstarts reduzieren

Um die Mindestanzahl von Instanzen für eine Funktion im Quellcode festzulegen, verwenden Sie die Methode runWith. Diese Methode akzeptiert ein JSON-Objekt, das der RuntimeOptions-Schnittstelle entspricht, die den Wert für minInstances definiert. Mit dieser Funktion werden beispielsweise mindestens 5 Instanzen aufrechterhalten:

exports.getAutocompleteResponse = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      minInstances: 5,
    })
    .https.onCall((data, context) => {
      // Autocomplete a user's search term
    });
index.js

Hier sind einige Dinge, die Sie bei der Festlegung eines Werts für minInstances beachten sollten:

  • Wenn Cloud Functions for Firebase Ihre App über Ihre Einstellung für minInstances skaliert, kommt es für jede Instanz über diesem Grenzwert zu einem Kaltstart.
  • Kaltstarts wirken sich am stärksten auf Apps mit unregelmäßigem Traffic aus. Wenn Ihre App Traffic-Spitzen aufweist und Sie einen minInstances-Wert festlegen, der hoch genug ist, um Kaltstarts bei jedem Traffic-Anstieg zu reduzieren, wird die Latenz deutlich verringert. Bei Apps mit konstantem Traffic wirken sich Kaltstarts wahrscheinlich nicht negativ auf die Leistung aus.

  • Das Festlegen einer Mindestanzahl von Instanzen kann für Produktionsumgebungen sinnvoll sein, sollte aber in Testumgebungen in der Regel vermieden werden. Wenn Sie in Ihrem Testprojekt auf null skalieren, aber trotzdem Kaltstarts in Ihrem Produktionsprojekt reduzieren möchten, können Sie minInstances basierend auf der Umgebungsvariable FIREBASE_CONFIG festlegen:

    // Get Firebase project id from `FIREBASE_CONFIG` environment variable
const envProjectId = JSON.parse(process.env.FIREBASE_CONFIG).projectId;

exports.renderProfilePage = functions
    .runWith({
      // Keep 5 instances warm for this latency-critical function
      // in production only. Default to 0 for test projects.
      minInstances: envProjectId === "my-production-project" ? 5 : 0,
    })
    .https.onRequest((req, res) => {
      // render some html
    });
    index.js

Maximale Anzahl von Instanzen für eine Funktion begrenzen

Verwenden Sie die Methode runWith, um die maximale Anzahl von Instanzen im Funktionsquellcode festzulegen. Diese Methode akzeptiert ein JSON-Objekt, das der Schnittstelle RuntimeOptions entspricht, in der Werte für maxInstances definiert sind. Mit dieser Funktion wird beispielsweise ein Limit von 100 Instanzen festgelegt, um eine hypothetische Legacy-Datenbank nicht zu überlasten:

exports.mirrorOrdersToLegacyDatabase = functions
    .runWith({
      // Legacy database only supports 100 simultaneous connections
      maxInstances: 100,
    })
    .firestore.document("orders/{orderId}")
    .onWrite((change, context) => {
      // Connect to legacy database
    });
index.js

Wenn eine HTTP-Funktion auf das Limit von maxInstances skaliert wird, werden neue Anfragen 30 Sekunden lang in die Warteschlange gestellt und dann mit dem Antwortcode 429 Too Many Requests abgelehnt, wenn bis dahin keine Instanz verfügbar ist.

Weitere Informationen zu Best Practices für die Verwendung von Einstellungen für maximale Instanzen finden Sie in diesen Best Practices für die Verwendung von maxInstances.

Zeitüberschreitung und Speicherzuweisung festlegen

In einigen Fällen gelten für Ihre Funktionen möglicherweise spezielle Anforderungen für einen langen Zeitüberschreitungswert oder eine große Speicherzuweisung. Sie können diese Werte entweder in der Google Cloud Console oder im Funktionsquellcode (nur Firebase) festlegen.

Um die Arbeitsspeicherzuweisung und das Zeitlimit im Quellcode der Funktion festzulegen, verwenden Sie den Parameter runWith, der im Firebase SDK für Cloud Functions 2.0.0 eingeführt wurde. Diese Laufzeitoption akzeptiert ein JSON-Objekt, das der Schnittstelle RuntimeOptions entspricht und Werte für timeoutSeconds und memory definiert. Diese Speicherfunktion verwendet beispielsweise 1 GB Arbeitsspeicher und läuft nach 300 Sekunden ab:

exports.convertLargeFile = functions
    .runWith({
      // Ensure the function has enough memory and time
      // to process large files
      timeoutSeconds: 300,
      memory: "1GB",
    })
    .storage.object()
    .onFinalize((object) => {
      // Do some complicated things that take a lot of memory and time
    });
index.js

Der Höchstwert für timeoutSeconds ist 540 oder 9 Minuten. Die Größe des Arbeitsspeichers, der einer Funktion zugewiesen wird, entspricht der für die Funktion zugewiesenen CPU, wie in dieser Liste der gültigen Werte für memory beschrieben:

  • 128MB – 200 MHz
  • 256MB – 400 MHz
  • 512MB – 800 MHz
  • 1GB – 1,4 GHz
  • 2GB – 2,4 GHz
  • 4GB – 4,8 GHz
  • 8GB – 4,8 GHz

So legen Sie die Speicherzuweisung und das Zeitlimit in der Google Cloud-Konsole fest:

  1. Wählen Sie in der Google Google Cloud Console im Menü auf der linken Seite Cloud Functions aus.
  2. Wählen Sie eine Funktion aus, indem Sie in der Funktionsliste auf ihren Namen klicken.
  3. Klicken Sie im oberen Menü auf das Symbol Bearbeiten.
  4. Wählen Sie im Drop-down-Menü Zugewiesener Speicher eine Speicherzuweisung aus.
  5. Klicken Sie auf Mehr, um die erweiterten Optionen aufzurufen, und geben Sie im Textfeld Zeitlimit eine Anzahl von Sekunden ein.
  6. Klicken Sie auf Speichern, um die Funktion zu aktualisieren.