Riferimento queue.yaml

ID regione

L'elemento REGION_ID è un codice abbreviato che Google assegna in base alla regione selezionata quando crei l'app. Il codice non corrisponde a un paese o a una provincia, anche se alcuni ID regione possono sembrare simili ai codici di paesi e province di uso comune. Per le app create dopo febbraio 2020, REGION_ID.r è incluso negli URL di App Engine. Per le app esistenti create prima di questa data, l' ID regione è facoltativo nell'URL.

Scopri di più sugli ID regione.

Il file di configurazione queue.yaml viene utilizzato per creare e configurare quasi tutte le code di attività (push o pull) utilizzate dall'app. Tutte le app App Engine includono una coda in modalità push preconfigurata automaticamente denominata default. Sebbene tu non crei la coda default, puoi aggiungere altre code o modificare la configurazione della coda default utilizzando il file queue.yaml.

Per configurare le code push, puoi utilizzare queue.yaml o i metodi di gestione delle code di Cloud Tasks, ma non entrambi contemporaneamente. La combinazione del metodo di caricamento queue.yaml con i metodi di gestione delle code può produrre risultati imprevisti e non è consigliata.

Per configurare le code pull, devi utilizzare il file queue.yaml. Cloud Tasks non supporta le code pull.

Esempio

Di seguito è riportato un esempio di base che definisce una coda denominata e sostituisce la frequenza di elaborazione predefinita:

queue:
- name: my-push-queue
  rate: 1/s

Di seguito è riportato un esempio più complesso di una configurazione queue.yaml che mostra come configurare il numero di tentativi di attività e modificare la frequenza di elaborazione predefinita.

queue:
- name: fooqueue
  rate: 1/s
  retry_parameters:
    task_retry_limit: 7
    task_age_limit: 2d
- name: barqueue
  rate: 1/s
  retry_parameters:
    min_backoff_seconds: 10
    max_backoff_seconds: 200
    max_doublings: 0
- name: bazqueue
  rate: 1/s
  retry_parameters:
    min_backoff_seconds: 10
    max_backoff_seconds: 200
    max_doublings: 3

Sintassi

Il file queue.yaml è un file YAML la cui direttiva root è queue. Questa direttiva contiene zero o più code denominate. Ogni definizione di coda può specificare i seguenti elementi:

Elemento Descrizione
bucket_size (code push)

Facoltativo. Una coda di attività utilizza l'algoritmo del bucket di token per controllare la frequenza di esecuzione delle attività. Ogni coda denominata ha un token bucket che contiene token, fino al massimo specificato dal valore bucket_size. Ogni volta che l'applicazione esegue un'attività, un token viene rimosso dal bucket. Continui a elaborare le attività nella coda finché il bucket della coda non esaurisce i token. App Engine ricarica continuamente il bucket con nuovi token in base alla frequenza specificata per la coda.

La dimensione del bucket limita la velocità di elaborazione della coda quando sono presenti molte attività nella coda e la frequenza è elevata. Il valore massimo per la dimensione del bucket è 500. In questo modo, puoi avere una frequenza elevata in modo che l'elaborazione inizi poco dopo l'inserimento di un'attività nella coda, ma puoi comunque limitare l'utilizzo delle risorse quando molte attività vengono inserite nella coda in un breve periodo di tempo.

Se non specifichi bucket_size per una coda, il valore predefinito è 5. Ti consigliamo di impostare un valore più elevato perché la dimensione predefinita potrebbe essere troppo piccola per molti casi d'uso. Ad esempio, puoi determinare la dimensione del bucket in base alla frequenza di elaborazione.

Per ulteriori informazioni su questo elemento, consulta la descrizione comparativa di max_burst_size

nel riferimento API Cloud Tasks.
max_concurrent_requests (code push)

Facoltativo. Imposta il numero massimo di attività che possono essere eseguite contemporaneamente dalla coda specificata. Il valore è un numero intero. Per impostazione predefinita, il limite è di 1000 attività per coda. Il limite superiore consigliato è di 5000 attività per coda. Tieni presente che le code potrebbero aumentare lentamente quando vengono create per la prima volta o se sono inattive da un po' di tempo.

La limitazione del numero di attività simultanee ti consente di controllare meglio la frequenza di esecuzione della coda e può impedire l'esecuzione di troppe attività contemporaneamente. Può anche impedire la contesa del datastore e rendere disponibili le risorse per altre code o per l'elaborazione online.

Per ulteriori informazioni su questo elemento, consulta la descrizione comparativa di max_concurrent_dispatches nel riferimento API Cloud Tasks.

mode

Facoltativo. Identifica la modalità della coda. Per impostazione predefinita, questa impostazione è push che identifica una coda come coda in modalità push. Per utilizzare le code pull, imposta la modalità su pull.

name

Obbligatorio. Il nome della coda. Questo è il nome che specifichi quando chiami QueueFactory.getQueue().

Il nome di una coda può contenere lettere maiuscole e minuscole, numeri e trattini. La lunghezza massima del nome di una coda è di 100 caratteri.

Tutte le app hanno una coda in modalità push denominata default. Questa coda ha una frequenza preimpostata di 5 attività al secondo. Tieni presente che questa coda predefinita non viene visualizzatain the Google Cloud console la prima volta che viene utilizzata o configurata. Puoi configurare la coda predefinita, inclusa la modifica della frequenza predefinita, definendo una coda denominata `default` nel file queue.yaml.

rate (code push)

Obbligatorio. La frequenza con cui le attività vengono elaborate in questa coda. Il valore è un numero seguito da una barra e da un'unità di tempo, dove l'unità è s per secondi, m per minuti, h per ore o d per giorni. Ad esempio, il valore 5/m indica che le attività verranno elaborate a una frequenza di 5 volte al minuto. Il valore massimo per rate è 500/s.

Se il numero è 0 (ad esempio 0/s), la coda è considerata "in pausa" e non vengono elaborate attività.

Per ulteriori informazioni su questo elemento, consulta la descrizione comparativa di max_dispatches_per_second nel riferimento API Cloud Tasks.

retry_parameters

Facoltativo. Configura i tentativi di ripetizione per le attività non riuscite nelle code push. Questa aggiunta ti consente di specificare il numero massimo di tentativi di ripetizione per le attività non riuscite in una coda specifica. Puoi anche impostare un limite di tempo per i tentativi di ripetizione e controllare l'intervallo tra i tentativi.

I parametri di ripetizione possono contenere i seguenti sottoelementi:

task_retry_limit
Il numero di tentativi. Ad esempio, se 0 viene specificato e l'attività non riesce, l'attività non viene ripetuta affatto. Se viene specificato 1 e l'attività non riesce, l'attività viene ripetuta una volta. Se questo parametro non è specificato, l'attività viene ripetuta indefinitamente. Se task_retry_limit viene specificato con task_age_limit, l'attività viene ripetuta fino al raggiungimento di entrambi i limiti.
task_age_limit (code push)
Il limite di tempo per ripetere un'attività non riuscita, misurato dal momento in cui l'attività è stata eseguita per la prima volta. Il valore è un numero seguito da un'unità di tempo, dove l'unità è s per secondi, m per minuti, h per ore o d per giorni. Ad esempio, il valore 5d specifica un limite di cinque giorni dopo il primo tentativo di esecuzione dell'attività. Se questo parametro non è specificato, l'attività viene ripetuta indefinitamente. Se specificato con task_retry_limit, App Engine ripete l'attività fino al raggiungimento di entrambi i limiti.
min_backoff_seconds (code push)
Il numero minimo di secondi da attendere prima di ripetere un'attività dopo che non è riuscita. Il valore predefinito è 0.1.
max_backoff_seconds (code push)
Il numero massimo di secondi da attendere prima di ripetere un'attività dopo che non è riuscita. Il valore predefinito è 3600.
max_doublings (code push)
Il numero massimo di volte in cui l'intervallo tra i tentativi di ripetizione delle attività non riuscite verrà raddoppiato prima che l'aumento diventi costante. La costante è: 2**max_doublings * min_backoff_seconds. Il valore predefinito è 16.
target (code push)

Facoltativo. Una stringa che nomina un servizio/una versione, una versione frontend o un backend, su cui eseguire tutte le attività inserite nella coda. Il valore predefinito è la stringa vuota.

La stringa viene anteposta al nome di dominio dell'app durante la creazione della richiesta HTTP per un'attività. Ad esempio, se l'ID app è my-app e imposti la destinazione su my-version-dot-my-service, il nome host dell'URL verrà impostato su my-version-dot-my-service-dot-my-app.REGION_ID.r.appspot.com.

Se la destinazione non è specificata, le attività vengono richiamate nella stessa versione dell'applicazione in cui sono state inserite nella coda. Pertanto, se hai inserito un' attività nella coda dalla versione predefinita dell'applicazione senza specificare una destinazione nella coda, l'attività viene richiamata nella versione predefinita dell'applicazione. Tieni presente che se la versione predefinita dell'applicazione cambia tra il momento in cui l'attività viene inserita nella coda e il momento in cui viene eseguita, l'attività verrà eseguita nella nuova versione predefinita.

Se utilizzi i servizi insieme a un file di invio, la richiesta HTTP dell'attività potrebbe essere intercettata e reindirizzata a un altro servizio.

I seguenti elementi possono essere specificati per tutte le code all'interno di un'app:

Elemento Descrizione
total_storage_limit

Facoltativo. Una stringa che sostituisce il limite di spazio di archiviazione della quota predefinita disponibile per lo spazio di archiviazione della coda di attività (100 M). Ad esempio:

          total_storage_limit: 1.2G
          queue:
            - name: fooqueue

Questa quota fa parte della quota di spazio di archiviazione totale dell'applicazione (inclusa la quota del datastore e dell'archivio BLOB).

Se non viene specificato alcun suffisso, il numero specificato viene interpretato come byte. Sono supportati i seguenti suffissi:

  • B (byte)
  • K (kilobyte)
  • M (megabyte)
  • G (gigabyte)
  • T (terabyte)

total_storage_limit supera lo spazio di archiviazione su disco totale disponibile per un'applicazione, il limite viene limitato allo spazio di archiviazione disponibile.

Eseguire il deployment del file di configurazione della coda

Il file queue.yaml deve risiedere nella directory root o nella directory che definisce il servizio predefinito.

Per eseguire il deployment del file di configurazione della coda, esegui il comando seguente:

gcloud app deploy queue.yaml

Eliminare le code

Per eliminare una coda:

  1. Rimuovi la definizione della coda dal file queue.yaml.

  2. Carica la modifica nel file queue.yaml.

    gcloud app deploy queue.yaml

  3. Elimina la coda nella Google Cloud console, seleziona la coda e fai clic su Elimina coda:

    Vai alla pagina Code di attività

Se elimini una coda dalla Google Cloud console, devi attendere 7 giorni prima di ricrearla con lo stesso nome.