Utilizza Gestione delle code oQueue.yaml

Questa pagina spiega le differenze tra l'utilizzo dell'API Cloud Tasks per gestire le code e il caricamento di un file Cloud Tasks queue.yaml per raggiungere lo stesso scopo. Inoltre, descrive alcune delle insidie dei meccanismi di combinazione e come affrontare problemi comuni.

Introduzione

L'API Cloud Tasks fornisce un'interfaccia indipendente da App Engine al servizio Coda di attività di App Engine. Come parte di questa interfaccia, offre la possibilità di gestire le code, anche tramite la console o il comando gcloud. Le code create dall'API Cloud Tasks sono accessibili dall'SDK di App Engine e viceversa. Per mantenere la compatibilità, è possibile utilizzare il file di configurazione utilizzato dall'SDK di App Engine, queue.yaml, anche per creare e configurare le code da utilizzare tramite l'API Cloud Tasks. Tuttavia, la combinazione della configurazione tramite file con la configurazione tramite l'API Cloud Tasks può produrre conseguenze impreviste.

Insidie legate alla combinazione di queue.yaml con i metodi di gestione delle code di Cloud Tasks

Per il servizio sottostante,i file queue.yaml sono definitivi. Il caricamento di un queue.yaml che omette le code esistenti nel progetto, indipendentemente da come sono state create, ne determina la disattivazione o la messa in pausa. Pertanto, se utilizzi l'API Cloud Tasks per chiamare CreateQueue o UpdateQueue e poi carichi un file queue.yaml che li omette, le code che sono state create nelle chiamate Cloud Tasks vengono disabilitate.

Considera il seguente scenario:

  1. Chiama CreateQueue per creare una coda denominata "cloud-tasks-queue".

  2. Carica un file queue.yaml con il seguente contenuto:

    queue:
- name: queue-yaml-queue

Qual è lo stato attuale delle code in questo progetto? La coda denominata "cloud-tasks-queue" e qualsiasi altra coda esistente in precedenza sono in stato DISABLED, mentre la coda denominata "queue-yaml-queue" è in stato RUNNING.

Questo comportamento potrebbe sorprenderti se crei code tramite l'API Cloud Tasks. Le istruzioni riportate di seguito spiegano come ripristinare una coda disabilitata.

Analogamente, se una coda è disabilitata nell'API Cloud Tasks, ma in seguito viene visualizzata in un file queue.yaml caricato, la coda viene ripresa.

Se una coda viene eliminata con il metodo DeleteQueue e in seguito viene visualizzata in un file queue.yaml, il caricamento di queue.yaml può non riuscire perché non è consentito riutilizzare i nomi delle code per diversi giorni dopo l'eliminazione.

best practice

Se non hai mai utilizzato Cloud Tasks o App Engine, utilizza esclusivamente l'API Cloud Tasks per gestire le code ed evitare del tutto l'uso di queue.yaml. I metodi di gestione delle code di Cloud Tasks offrono agli utenti una maggiore scelta per la creazione, l'aggiornamento e l'eliminazione delle code.

Tuttavia, se sei un utente queue.yaml esistente, considera di passare ai metodi di gestione delle code solo se conosci gli insidie di combinare queue.yaml con i metodi di gestione delle code di Cloud Tasks.

Per impedire agli utenti di combinare i metodi di gestione delle attività, un'opzione consiste nel creare un'app web o uno strumento a riga di comando che tutti gli utenti devono utilizzare per creare, aggiornare ed eliminare le code. Se lo strumento utilizza i metodi di gestione delle code di Cloud Tasks o queue.yaml è un dettaglio di implementazione dello strumento di cui gli utenti non devono preoccuparsi. Se agli utenti è richiesto di utilizzare lo strumento, puoi garantire che non vi sarà alcuna combinazione involontaria dei metodi di gestione delle code di Cloud Tasks e dell'utilizzo di queue.yaml. Per forzare l'utilizzo di questo strumento, puoi concedere i ruoli di amministratore delle code allo strumento e richiedere agli utenti di eseguire l'autenticazione per utilizzarlo. Per scoprire di più sulla gestione degli accessi, consulta Configurazione delle code sicure.

Debug

Puoi esaminare gli audit log delle attività di amministrazione del progetto per recuperare la cronologia delle modifiche alla configurazione delle code, incluse le creazioni, gli aggiornamenti e le eliminazioni delle code:

    gcloud logging read \
      'protoPayload.methodName=
       (com.google.appengine.legacy.queue_created OR
        com.google.appengine.legacy.queue_updated OR
        google.cloud.tasks.v2.CloudTasks.CreateQueue OR
        google.cloud.tasks.v2.CloudTasks.UpdateQueue OR
        google.cloud.tasks.v2.CloudTasks.DeleteQueue)'

Ad esempio, se una coda esistente viene disabilitata da un caricamento queue.yaml, nell'audit log verrà visualizzato il messaggio "Coda disabilitata '[QUEUE_NAME]'" nell'audit log con il metodo com.google.appengine.legacy.queue_updated.

Come riprendere una coda disattivata da un caricamento di queue.yaml

Se combini queue.yaml con i metodi di gestione delle code di Cloud Tasks, il caricamento di un file queue.yaml potrebbe disattivare accidentalmente una coda creata tramite l'API Cloud Tasks.

Per riprendere la coda, puoi chiamare ResumeQueue in coda o aggiungerla a queue.yaml ed eseguire il caricamento. Tieni presente che, se in precedenza hai impostato un'elaborazione personalizzata rate nella configurazione di queue.yaml per la coda, ResumeQueue reimposta la coda sul valore predefinito rate. Ciò si riflette nel campo maxDispatchesPerSecond della risposta a ResumeQueue.

Quote

Se utilizzi queue.yaml per creare le tue code, per impostazione predefinita puoi creare un massimo di 100 code. Le code create utilizzando l'API Cloud Tasks hanno un massimo predefinito di 1000 code. Come in altri casi, la combinazione dei metodi dell'API queue.yaml e di Cloud Tasks può produrre risultati inaspettati. Supponi, ad esempio, di creare alcune code utilizzando queue.yaml e di ottenere un aumento della quota fino a 2000, ad esempio. Se successivamente utilizzi il metodo API Cloud Tasks per creare ulteriori code, otterrai errori di quota. Per risolvere il problema, invia una richiesta utilizzando Modifica quote nella pagina Quote della console Google Cloud.

Informazioni aggiuntive sui metodi di gestione delle code di Cloud Tasks

Configurazione della coda e ritardo di avvio della coda

L'applicazione delle modifiche alla configurazione della coda può richiedere diversi minuti. Ad esempio, dopo aver chiamato CreateQueue o UpdateQueue, potrebbero trascorrere alcuni minuti prima di poter chiamare CreateTask su quella coda.

Cloud Tasks e la coda di App Engine default

Alla coda App Engine denominata "default" viene assegnato un trattamento speciale nell'SDK di App Engine e nell'API Cloud Tasks.

Se la coda default non esiste già, viene creata nelle seguenti situazioni:

  1. Quando un'attività viene aggiunta per la prima volta alla coda default utilizzando l'SDK App Engine.
  2. Quando viene caricato un file queue.yaml che specifica una coda default.
  3. Quando viene richiamata CreateQueue o UpdateQueue per creare la coda default.

Per preservare la compatibilità con App Engine, Cloud Tasks applica le seguenti restrizioni:

  1. Se viene creata una coda denominata "default", deve essere una coda che utilizza le attività di App Engine.
  2. Una volta creata, gli utenti non possono eliminare la coda default.

Nell'API Cloud Tasks, quanto segue si applica anche alla coda default:

  1. L'API Cloud Tasks non crea automaticamente la coda default o qualsiasi altra coda.
  2. Come per qualsiasi altra coda, la chiamata a GetQueue nella coda default genera un errore di tipo "non trovato" se la chiamata viene effettuata prima della creazione della coda.
  3. Allo stesso modo, la coda default non viene visualizzata nell'output di ListQueues prima della creazione.
  4. La configurazione della coda default può essere modificata con la chiamata UpdateQueue.

Passaggi successivi