Accoda le funzioni con Cloud Tasks


Le funzioni delle code di attività sfruttano Google Cloud Tasks per eseguire app che richiedono molto tempo, risorse o larghezza di banda limitate in modo asincrono al di fuori del flusso principale dell'applicazione.

Ad esempio, immagina di voler creare backup di un grande insieme di attualmente ospitati su un'API con un limite di frequenza. Per essere un un consumatore responsabile dell'API, devi rispettarne i limiti di frequenza. Inoltre, questo tipo di job a lunga esecuzione potrebbe essere vulnerabile a errori dovuti a timeout e limiti di memoria.

Per ridurre questa complessità, puoi scrivere una funzione di coda di attività che stabilisca per le opzioni dell'attività come scheduleTime e dispatchDeadline, poi passa il in una coda in Cloud Tasks. Cloud Tasks è stato progettato specificamente per garantire un efficace controllo della congestione e nuovi criteri per questo tipo di operazioni.

L'SDK Firebase per Cloud Functions for Firebase versione 3.20.1 e successive è interoperabile con Firebase Admin SDK versione 10.2.0 e successive per supportare le funzioni di coda di attività.

L'utilizzo delle funzioni di coda di attività con Firebase può comportare addebiti per l'elaborazioneCloud Tasks. Per ulteriori informazioni, consulta la pagina relativa ai prezzi di Cloud Tasks.

Creare funzioni di coda di attività

Per utilizzare le funzioni di coda di attività, segui questo flusso di lavoro:

  1. Scrivi una funzione di coda di attività utilizzando l'SDK Firebase per Cloud Functions.
  2. Testa la funzione attivandola con una richiesta HTTP.
  3. Esegui il deployment della funzione con l'interfaccia a riga di comando Firebase. Quando esegui il deployment dell'attività funzione di coda per la prima volta, l'interfaccia a riga di comando creerà una coda di attività in Cloud Tasks con opzioni (limitazione di frequenza e nuovo tentativo) specificate nel codice sorgente.
  4. Aggiungi attività alla coda di attività appena creata, passando i parametri per impostare una pianificazione di esecuzione, se necessario. Puoi farlo scrivendo il codice utilizzando Admin SDK e eseguendone il deployment in Cloud Functions for Firebase.

Scrittura funzioni coda di attività

Utilizza onDispatch per iniziare a scrivere funzioni delle code di attività. Un'importante parte della scrittura di una funzione coda di attività consiste nell'impostare i nuovi tentativi in coda e che limita la configurazione. Gli esempi di codice in questa pagina sono basati su un'app che imposta che esegue il backup di tutte le immagini Immagine del giorno astronomica:

Configura le funzioni della coda di attività

Le funzioni delle code di attività sono dotate di un ricco insieme di impostazioni di configurazione per controllare con precisione i limiti di frequenza e il comportamento dei nuovi tentativi di una coda di attività:

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: ogni attività nella coda viene automaticamente nuovi tentativi per 5 volte. Ciò aiuta a mitigare gli errori temporanei come o un'interruzione temporanea del servizio di un servizio esterno che dipende.
  • retryConfig.minBackoffSeconds=60: viene riprovata ogni attività per almeno 60 secondi a parte ogni tentativo. Ciò fornisce un ampio margine tra un tentativo e l'altro per evitare di esaurire i 5 nuovi tentativi troppo rapidamente.
  • rateLimits.maxConcurrentDispatch=6: al massimo vengono inviate 6 attività a un in un determinato momento. Ciò contribuisce a garantire un flusso costante di richieste all'oggetto sottostante e aiuta a ridurre il numero di istanze attive e avvii a freddo.

Testare le funzioni della coda di attività

Nella maggior parte dei casi, l'emulatore Cloud Functions è il modo migliore per testare l'attività funzioni di coda. Consulta la documentazione di Emulator Suite per scoprire come utilizzare la tua app per l'emulazione delle funzioni delle code di attività.

Inoltre, le funzioni di coda di attività sono esposte in modo semplice Funzioni HTTP in Firebase Local Emulator Suite. Puoi testare una funzione di un'attività emulata inviando un messaggio POST HTTP richiesta con un payload di dati JSON:

 # 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

Esegui il deployment delle funzioni di coda di attività

Esegui il deployment della funzione coda di attività utilizzando l'interfaccia a riga di comando di Firebase:

$ firebase deploy --only functions:backupApod

Quando esegui il deployment di una funzione coda di attività per la prima volta, l'interfaccia a riga di comando crea una coda di attività in Cloud Tasks con opzioni (limitazione di frequenza e nuovo tentativo) specificato nel codice sorgente.

Se si verificano errori relativi alle autorizzazioni durante il deployment delle funzioni, assicurati che i ruoli IAM appropriati vengono assegnate all'utente che esegue i comandi di deployment.

Accoda le funzioni della coda di attività

Le funzioni coda di attività possono essere accodate in Cloud Tasks da un come Cloud Functions for Firebase utilizzando Firebase Admin SDK in Node.js. Se non hai mai utilizzato Admin SDK, consulta Per iniziare, aggiungi Firebase a un server.

In un flusso tipico, Admin SDK crea una nuova attività, la inserisce in coda Cloud Tasks e imposta la configurazione per l'attività:

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: il codice campione cerca di distribuire l'esecuzione di mediante l'associazione di un ritardo di ennesimo minuto per l'attività N-esimo. Questo si traduce in un trigger di ~ 1 attività/minuto. Tieni presente che puoi anche utilizzare scheduleTime se vuoi che Cloud Tasks attiri un'attività in un momento specifico.
  • dispatchDeadlineSeconds: durata massima Cloud Tasks attenderà il completamento di un'attività. Cloud Tasks riproverà l'attività dopo il nuovo tentativo configurazione della coda o fino al raggiungimento di questa scadenza. Nell'esempio, la coda è configurata per ripetere l'attività fino a cinque volte, ma l'attività annullato automaticamente se l'intero processo (inclusi i nuovi tentativi) richiede più di cinque minuti.

Risoluzione dei problemi

Cloud Tasks">Attiva il logging di Cloud Tasks

I log da Cloud Tasks contengono informazioni diagnostiche utili come della richiesta associata a un'attività. Per impostazione predefinita, i log di Cloud Tasks sono disattivati a causa dell'elevato volume di log che possono potenzialmente generare nel tuo progetto. Ti consigliamo di attivare i log di debug mentre sviluppa e debug attivamente le funzioni della coda delle attività. Consulta Attivazione in corso il logging.

Autorizzazioni IAM

Potresti vedere PERMISSION DENIED di errori quando accodi le attività o quando Cloud Tasks cerca di richiamare le funzioni della coda di attività. Assicurati che il progetto ha le seguenti associazioni IAM:

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

  • L'identità utilizzata per mettere in coda le attività in Cloud Tasks deve disporre dell'autorizzazione per utilizzare l'account di servizio associato a un'attività in Cloud Tasks.

    Nell'esempio, questo è l'account di servizio predefinito App Engine.

Consulta la documentazione di Google Cloud IAM per istruzioni su come aggiungere l'account di servizio predefinito App Engine in qualità di utente dell'account di servizio predefinito App Engine.

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