Creazione di attività push

In questa pagina viene descritto come creare attività e inserirle nelle code in modalità push. Quando vuoi elaborare un'attività, devi creare un nuovo oggetto attività e posizionarlo su una coda. Puoi specificare esplicitamente il servizio e il gestore che elaborano l'attività e, facoltativamente, passare al gestore i dati specifici dell'attività. Puoi anche perfezionare la configurazione dell'attività, ad esempio pianificare un momento futuro in cui deve essere eseguita o limitare il numero di tentativi dell'attività in caso di errore.

Creazione di una nuova attività

Per creare e accodare un'attività, chiama la funzione taskqueue.add(). Il codice seguente crea un'attività che ha come target il servizio denominato worker e richiama il relativo gestore impostando l'URL /update-counter:

class EnqueueTaskHandler(webapp2.RequestHandler):
    def post(self):
        amount = int(self.request.get('amount'))

        task = taskqueue.add(
            url='/update_counter',
            target='worker',
            params={'amount': amount})

        self.response.write(
            'Task {} enqueued, ETA {}.'.format(task.name, task.eta))

In alternativa, puoi creare un oggetto Task e chiamare il relativo metodo add().

Specifica del servizio worker

Quando un'attività viene scollegata dalla coda, il servizio coda di attività la invia a un servizio worker. Ogni attività ha un target e un URL, che determinano quale servizio e gestore eseguiranno l'attività.

target

La destinazione specifica il servizio che riceverà la richiesta HTTP per eseguire l'attività. È una stringa che specifica un servizio, una versione o un'istanza in uno qualsiasi dei moduli canonici. I moduli più utilizzati sono:

    service
    version.service
    instance.version.service

La stringa di destinazione è anteposta al nome di dominio dell'app. Esistono tre modi per impostare la destinazione per un'attività:

  • Dichiara la destinazione quando crei l'attività. Puoi impostare il target in modo esplicito utilizzando il parametro target nella funzione taskqueue.add(). Vedi l'esempio riportato sopra.

  • Includi un'istruzione target quando definisci una coda in queue.yaml, come nella definizione di queue-blue. Tutte le attività aggiunte a una coda con target utilizzeranno quella destinazione, anche se all'attività è stata assegnata una destinazione diversa al momento della creazione.

  • Se non viene specificata alcuna destinazione in base a uno dei due metodi precedenti, la destinazione dell'attività sarà la versione del servizio che la mette in coda. Tieni presente che se accoda un'attività dal servizio e dalla versione predefiniti in questo modo e la versione predefinita cambia prima dell'esecuzione, l'attività verrà eseguita nella nuova versione predefinita.

url

url seleziona uno dei gestori nel servizio di destinazione, che eseguirà l'attività.

url deve corrispondere a uno dei pattern URL del gestore nel servizio di destinazione. url può includere parametri di ricerca se il metodo specificato nell'attività è GET o PULL. Se url non viene specificato, viene utilizzato l'URL predefinito /_ah/queue/[QUEUE_NAME], dove [QUEUE_NAME] è il nome della coda dell'attività.

Passaggio di dati al gestore

Puoi passare i dati al gestore come parametri di ricerca nell'URL dell'attività, ma solo se il metodo specificato nell'attività è GET o PULL.

Per aggiungere dati a un'attività, puoi anche utilizzare uno qualsiasi dei seguenti campi:

  • payload, che fornisce i dati dell'attività nel corpo della richiesta HTTP.
  • params

Queste tre chiamate sono equivalenti:

taskqueue.add(method=GET, url='/update-counter?key=blue', target='worker')
taskqueue.add(url='/update-counter', params={'key': 'blue'}, target='worker')
taskqueue.add(url='/update-counter', payload="{'key': 'blue'}", target='worker')

Assegnare un nome a un'attività

Quando crei una nuova attività, App Engine assegna all'attività un nome univoco per impostazione predefinita. Tuttavia, puoi assegnare il tuo nome a un'attività utilizzando il parametro name. Un vantaggio dell'assegnazione di nomi personalizzati alle attività è che le attività denominate vengono deduplicate, il che significa che puoi utilizzare i nomi per garantire che un'attività venga aggiunta una sola volta. La deduplicazione continua per 9 giorni dopo il completamento o l'eliminazione dell'attività.

Tieni presente che la logica di deduplicazione introduce un overhead significativo delle prestazioni, con un conseguente aumento delle latenze e dei tassi di errore associati alle attività con nome. Questi costi possono essere aumentati notevolmente se i nomi delle attività sono sequenziali, ad esempio per i timestamp. Se assegni nomi personalizzati, ti consigliamo di utilizzare un prefisso ben distribuito per i nomi delle attività, ad esempio un hash dei contenuti.

Se assegni nomi personalizzati alle attività, tieni presente che la lunghezza massima del nome è 500 caratteri e che può contenere lettere maiuscole e minuscole, numeri trattini bassi e trattini.

taskqueue.add(url='/url/path', name='first-try')

Aggiunta di attività in modo asincrono

Per impostazione predefinita, le chiamate che aggiungono attività alle code sono sincrone. Nella maggior parte degli scenari, le chiamate sincrone funzionano correttamente. L'aggiunta di un'attività a una coda in genere è un'operazione rapida. Una piccola percentuale di operazioni di aggiunta delle attività può richiedere molto più tempo, ma il tempo medio per aggiungere un'attività è inferiore a 5 ms.

L'aggiunta di operazioni di attività a code diverse non può essere raggruppata in batch. Di conseguenza, l'API Task Queue fornisce anche chiamate asincrone che offrono la possibilità di aggiungere queste attività in parallelo, riducendo ulteriormente la latenza. Ciò è utile se stai creando un'applicazione sensibile alla latenza estremamente elevata che deve eseguire contemporaneamente diverse operazioni di aggiunta di attività a code diverse.

Se vuoi effettuare chiamate asincrone a una coda di attività, utilizza i metodi asincroni forniti dalla classe Queue e un oggetto RPC. Richiama get_result() sull'oggetto RPC restituito per forzare il completamento della richiesta. Quando aggiungi attività in modo asincrono a una transazione, devi chiamare get_result() sull'oggetto RPC prima di eseguire il commit della transazione per assicurarti che la richiesta sia terminata.

Coda delle attività nelle transazioni di Cloud Datastore

Puoi accodare un'attività nell'ambito di una transazione Datastore, in modo che l'attività venga accodata solo in coda e se il commit della transazione viene eseguito correttamente. Le attività aggiunte in una transazione sono considerate parte della stessa e hanno lo stesso livello di isolamento e coerenza.

Un'applicazione non può inserire più di cinque attività transazionali nelle code di attività durante una singola transazione. Le attività transazionali non devono avere nomi specificati dall'utente.

Il seguente esempio di codice mostra come inserire attività transazionali in una coda in modalità push come parte di una transazione Datastore:

from google.appengine.api import taskqueue
from google.appengine.ext import ndb

@ndb.transactional
def do_something_in_transaction():
  taskqueue.add(url='/path/to/my/worker', transactional=True)
  #...

do_something_in_transaction()

Utilizzo della libreria di attività differite invece di un servizio worker

Configurare un gestore per ogni attività distinta (come descritto nelle sezioni precedenti) può risultare difficile, così come la serializzazione e la deserializzazione di argomenti complessi dell'attività, in particolare se ci sono molte attività diverse ma piccole che vuoi eseguire nella coda. L'SDK Python include una libreria (google.appengine.ext.deferred) che mostra una semplice funzione che ti consente di saltare tutto il lavoro di configurazione di gestori di attività dedicati e di serializzare e deserializzare i parametri.

Per utilizzare questa libreria, devi aggiungere l'elemento deferred integrato in app.yaml. Per saperne di più, consulta la sezione Gestori integrati del riferimento app.yaml.

Per utilizzare la libreria deferred, non devi fare altro che passare la funzione e i relativi argomenti a deferred.defer():

import logging

from google.appengine.ext import deferred

def do_something_expensive(a, b, c=None):
    logging.info("Doing something expensive!")
    # Do your work here

# Somewhere else
deferred.defer(do_something_expensive, "Hello, world!", 42, True)

La libreria deferred pacchettizza la chiamata alla funzione e i relativi argomenti, quindi la aggiunge alla coda di attività. Quando l'attività viene eseguita, la libreria deferred esegue do_something_expensive("Hello, world!", 42, True).

Lavorare con le attività in un'applicazione multi-tenant

Per impostazione predefinita, le code in modalità push utilizzano lo spazio dei nomi attuale impostato nello spazio dei nomi al momento della creazione dell'attività. Se l'applicazione utilizza la multitenancy, consulta l'articolo sull'API Python 2 degli spazi dei nomi.

Passaggi successivi