Funktionen mit Cloud Tasks in die Warteschlange stellen


Funktionen für Aufgabenwarteschlangen nutzen Google Cloud Tasks damit deine App zeit-, ressourcen- oder bandbreitenintensiv ist asynchron, also außerhalb Ihres Hauptanwendungsablaufs, ausgeführt werden.

Stellen Sie sich beispielsweise vor, Sie möchten Sicherungen eines großen Satzes von Images erstellen. -Dateien, die derzeit in einer API mit Ratenbegrenzung gehostet werden. Um ein Nutzer dieser API verantwortlich sind, müssen Sie deren Ratenbegrenzungen einhalten. Außerdem Diese Art von lang andauernden Jobs könnte aufgrund von Zeitüberschreitungen und Arbeitsspeicherlimits.

Um diese Komplexität zu verringern, können Sie eine Aufgabenwarteschlangenfunktion schreiben, wie scheduleTime und dispatchDeadline und gibt dann das an eine Warteschlange in Cloud Tasks übergeben. Das Cloud Tasks für eine effektive Überlastungskontrolle und Wiederholungsrichtlinien für diese Arten von Vorgängen.

Das Firebase SDK für die Interoperabilität von Cloud Functions for Firebase ab Version 3.20.1 mit Firebase Admin SDK v10.2.0 und höher, um Warteschlangenfunktionen zu unterstützen.

Die Verwendung von Aufgabenwarteschlangen-Funktionen mit Firebase kann zu Kosten für Cloud Tasks wird verarbeitet. Weitere Informationen finden Sie unter Cloud Tasks-Preise .

Funktionen für Aufgabenwarteschlangen erstellen

Gehen Sie folgendermaßen vor, um Funktionen für Aufgabenwarteschlangen zu verwenden:

  1. Mit dem Firebase SDK für Cloud Functions eine Task-Warteschlangenfunktion schreiben
  2. Testen Sie die Funktion, indem Sie sie mit einer HTTP-Anfrage auslösen.
  3. Stellen Sie die Funktion mit der Firebase-Befehlszeile bereit. Beim Bereitstellen der Aufgabe Warteschlangenfunktion zum ersten Mal verwendet, erstellt die Befehlszeile Aufgabenwarteschlange in Cloud Tasks mit Optionen (Ratenbegrenzung und Wiederholungsversuch), die im Quellcode angegeben sind.
  4. Fügen Sie der neu erstellten Aufgabenwarteschlange Aufgaben hinzu und geben Sie bei Bedarf Parameter für die Einrichtung eines Ausführungszeitplans an. Sie erreichen dies, indem Sie den Code mithilfe von Admin SDK und Bereitstellen in Cloud Functions for Firebase.

Aufgabenwarteschlangenfunktionen schreiben

Mit onDispatch können Sie Funktionen für Aufgabenwarteschlangen schreiben. Eine wichtige gehört zum Schreiben einer Aufgabenwarteschlangenfunktion das Festlegen von Wiederholungsversuchen und Rate einschränken können. Codebeispiele auf dieser Seite basieren auf einer App, die einen Dienst, der alle Bilder der NASA Astronomiebild des Tages:

Funktionen der Aufgabenwarteschlange konfigurieren

Funktionen für Aufgabenwarteschlangen enthalten leistungsstarke Konfigurationseinstellungen können Sie Ratenbegrenzungen und das Wiederholungsverhalten einer Aufgabenwarteschlange genau steuern:

exports.backupApod = functions
    .runWith( {secrets: ["NASA_API_KEY"]})
    .tasks.taskQueue({
      retryConfig: {
        maxAttempts: 5,
        minBackoffSeconds: 60,
      },
      rateLimits: {
        maxConcurrentDispatches: 6,
      },
    }).onDispatch(async (data) => {
index.js
  • retryConfig.maxAttempts=5: Jede Aufgabe in der Aufgabenwarteschlange wird automatisch bis zu fünfmal versucht. So lassen sich vorübergehende Fehler wie Netzwerkfehler oder vorübergehende Dienstunterbrechungen eines abhängigen externen Dienstes abmildern.
  • retryConfig.minBackoffSeconds=60: Jede Aufgabe wird mindestens 60 Sekunden wiederholt. abgesehen von jedem Versuch. Dadurch entsteht ein großer Puffer zwischen den damit wir die fünf Wiederholungsversuche nicht zu schnell erschöpfen.
  • rateLimits.maxConcurrentDispatch=6: Es werden maximal 6 Aufgaben in einem Schritt zu einer bestimmten Zeit. Dadurch wird ein stetiger Strom von Anfragen an die zugrunde liegende und reduziert die Anzahl aktiver Instanzen und Kaltstarts.

Funktionen der Aufgabenwarteschlange testen

In den meisten Fällen eignet sich der Cloud Functions-Emulator am besten, um Funktionen für Aufgabenwarteschlangen zu testen. In der Emulator Suite-Dokumentation erfahren Sie, wie Sie Ihre App für die Emulation von Funktionen in Aufgabenwarteschlangen instrumentieren.

Außerdem sind Aufgabenwarteschlangen-Funktionen HTTP-Funktionen in Firebase Local Emulator Suite. Sie können eine emulierte Aufgabenfunktion testen, indem Sie eine HTTP-POST-Anfrage senden. mit einer JSON-Datennutzlast anfordern:

 # start the Firebase Emulators
 firebase emulators:start

 # trigger the emulated task queue function
 curl \
  -X POST                                            # An HTTP POST request...
  -H "content-type: application/json" \              # ... with a JSON body
  http://localhost:$PORT/$PROJECT_ID/$REGION/$NAME \ # ... to function url
  -d '{"data": { ... some data .... }}'              # ... with JSON encoded data

Funktionen für Aufgabenwarteschlangen bereitstellen

Task-Queue-Funktion mit der Firebase CLI bereitstellen:

$ firebase deploy --only functions:backupApod

Wenn Sie eine Task-Queue-Funktion zum ersten Mal bereitstellen, erstellt die Befehlszeile eine Task-Queue in Cloud Tasks mit den Optionen „Ratenbegrenzung“ und „Wiederholen“, die im Quellcode angegeben sind.

Wenn beim Bereitstellen von Funktionen Berechtigungsfehler auftreten, prüfen Sie, ob dem Nutzer, der die Bereitstellungsbefehle ausführt, die entsprechenden IAM-Rollen zugewiesen sind.

Funktionen für Aufgabenwarteschlangen in Warteschlange

Aufgabenwarteschlangen-Funktionen können in Cloud Tasks von einem vertrauenswürdigen wie Cloud Functions for Firebase mit dem Firebase Admin SDK für Node.js Wenn Sie noch keine Erfahrung mit Admin SDKs haben, lesen Sie den Hilfeartikel Fügen Sie Firebase einem Server hinzu.

In einem typischen Ablauf erstellt Admin SDK eine neue Aufgabe und fügt sie in die Warteschlange ein. Cloud Tasks und legt die Konfiguration für die Aufgabe fest:

exports.enqueueBackupTasks = functions.https.onRequest(
async (_request, response) => {
  const queue = getFunctions().taskQueue("backupApod");
  const enqueues = [];
  for (let i = 0; i <= 10; i += 1) {
    // Enqueue each task with i*60 seconds delay. Our task queue function
    // should process ~1 task/min.
    const scheduleDelaySeconds = i * 60 
    enqueues.push(
        queue.enqueue(
          { id: `task-${i}` },
          {
            scheduleDelaySeconds,
            dispatchDeadlineSeconds: 60 * 5 // 5 minutes
          },
        ),
    );
  }
  await Promise.all(enqueues);
  response.sendStatus(200);

});
  • scheduleDelaySeconds: Der Beispielcode versucht, die Ausführung von durch Zuordnen einer Verzögerung von N-ten Minuten für die N-te Aufgabe. Das entspricht etwa einer Aufgabe pro Minute. Sie können auch scheduleTime verwenden, wenn Cloud Tasks eine Aufgabe zu einer bestimmten Zeit auslösen soll.
  • dispatchDeadlineSeconds: Maximale Zeitdauer Cloud Tasks wartet zu erledigen. Bei Cloud Tasks wird die Aufgabe gemäß der Wiederholungskonfiguration der Warteschlange oder bis zu diesem Termin wiederholt. Im Beispiel Die Warteschlange ist so konfiguriert, dass die Aufgabe bis zu fünfmal wiederholt wird, aber die Aufgabe ist automatisch abgebrochen, wenn der gesamte Vorgang (einschließlich Wiederholungsversuche) dauert mehr als 5 Minuten.

Fehlerbehebung

Cloud Tasks">Cloud Tasks-Logging aktivieren

Logs von Cloud Tasks enthalten nützliche Diagnoseinformationen, z. B.: Status der Anfrage, die einer Aufgabe zugeordnet ist. Standardmäßig sind Logs von Cloud Tasks deaktiviert, da sie möglicherweise eine große Menge an Logs für Ihr Projekt generieren. Wir empfehlen, die Fehlerbehebungsprotokolle zu aktivieren während Sie Ihre Aufgabenwarteschlangen-Funktionen aktiv entwickeln und Fehler beheben. Weitere Informationen finden Sie unter Wird eingeschaltet Logging

IAM-Berechtigungen

Möglicherweise werden PERMISSION DENIED-Fehler angezeigt, wenn Aufgaben in die Warteschlange gestellt werden oder Cloud Tasks versucht, die Funktionen der Aufgabenwarteschlange aufzurufen. Achten Sie darauf, dass die Projekt hat die folgenden IAM-Bindungen:

  • Die Identität, mit der Aufgaben in Cloud Tasks eingereiht werden, benötigt die IAM-Berechtigung cloudtasks.tasks.create.

    Im Beispiel ist das das App Engine-Standarddienstkonto.

gcloud projects add-iam-policy-binding $PROJECT_ID \
  --member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
  --role=roles/cloudtasks.enqueuer

  • Die Identität, die verwendet wird, um Aufgaben in Cloud Tasks in die Warteschlange zu stellen, benötigt eine Berechtigung , um das Dienstkonto zu verwenden, das mit einer Aufgabe in Cloud Tasks verknüpft ist.

    Im Beispiel ist dies das App Engine-Standarddienstkonto.

Siehe Google Cloud IAM-Dokumentation für Anweisungen zum Hinzufügen des App Engine-Standarddienstkontos als Nutzer des Standarddienstkontos App Engine.

  • Die zum Auslösen der Aufgabenwarteschlangenfunktion verwendete Identität muss Berechtigung „cloudfunctions.functions.invoke“.

    Im Beispiel ist dies das App Engine-Standarddienstkonto

gcloud functions add-iam-policy-binding $FUNCTION_NAME \
  --region=us-central1 \
  --member=serviceAccount:${PROJECT_ID}@appspot.gserviceaccount.com \
  --role=roles/cloudfunctions.invoker