Pianificazione delle attività con Cron per Python 2

Il servizio Cron di App Engine consente di configurare attività programmate regolarmente che operano in orari o a intervalli regolari definiti. Queste attività sono comunemente note come cron job. Questi cron job vengono attivati automaticamente dal servizio cron di App Engine. Ad esempio, puoi utilizzare un cron job per inviare un report per email su base giornaliera, per aggiornare alcuni dati memorizzati nella cache ogni 10 minuti o per aggiornare le informazioni di riepilogo una volta all'ora.

Un cron job invia una richiesta GET HTTP pianificata all'endpoint specificato nella stessa app in cui è configurato il cron job. Il gestore dell'endpoint esegue la logica quando viene chiamato.

Non è possibile utilizzare il servizio Cron di App Engine per chiamare endpoint web al di fuori dell'app host di App Engine. Non può essere utilizzato per chiamare gli endpoint di App Engine da altre app oltre all'app host.

Una richiesta cron job è soggetta agli stessi limiti delle code di attività push.

Prima di iniziare

Per eseguire il deployment o aggiornare le pianificazioni, il tuo account richiede uno dei seguenti ruoli IAM:

• Owner
• Editor

Puoi impostare l'autorizzazione nella pagina IAM della console Google Cloud.

Creazione di un cron job

1. Crea il file cron.yaml nella directory root dell'applicazione (insieme a app.yaml).

2. Aggiungi una o più voci <cron> al file e definisci gli elementi necessari per il job, inclusi gli elementi <url> e <schedule> richiesti. Esamina la sintassi e le opzioni di cron.yaml per ulteriori dettagli sugli elementi del file cron.yaml.

   L'esempio seguente crea un cron job di base che viene eseguito ogni giorno:

   cron:
   - description: "daily summary job"
     url: /tasks/summary
     target: beta
     schedule: every 24 hours
   

   La specifica di destinazione è facoltativa ed è il nome di un servizio o di una versione. Se presente, il target viene anteposto al nome host dell'app e il job viene indirizzato a quel servizio/versione. Se non viene specificata alcuna destinazione, il job verrà eseguito nelle versioni del servizio default configurate per il traffico.

3. Crea un gestore per l'URL del cron job. Il gestore deve eseguire tutte le attività che vuoi pianificare. Il gestore deve rispondere con un codice di stato HTTP compreso tra 200 e 299 (inclusi) per indicare l'esito positivo. Altri codici di stato possono essere restituiti e possono essere utilizzati per riprovare il cron job.

Test dei cron job nel server di sviluppo

Il server di sviluppo locale non esegue automaticamente i cron job. Puoi effettuare richieste direttamente all'URL del cron job per testare la funzionalità. Puoi utilizzare l'interfaccia cron locale o delle attività pianificate per attivare gli URL dei tuoi job con curl o uno strumento simile.

Puoi utilizzare l'interfaccia di amministrazione del server di sviluppo locale per visualizzare i tuoi cron job all'indirizzo http://localhost:8000/cron.

Nuovi cron job non riusciti

Se il gestore di richieste di un cron job restituisce un codice di stato non compreso nell'intervallo 200-299 (inclusi), App Engine considera che il job non è riuscito. Per impostazione predefinita, i job non riusciti non vengono tentati di nuovo a meno che non venga restituito un codice di stato 503. In questo caso, viene ripetuto ogni minuto fino a quando non riesce o restituisce un codice di stato 200-299.

Per impostare di nuovo i job non riusciti:

1. Includi un blocco retry_parameters nel file cron.yaml.

2. Scegli e imposta i parametri del nuovo tentativo nel blocco retry_parameters.

   Ad esempio, questo file cron.yaml di esempio contiene un singolo cron job configurato per riprovare fino a cinque volte (impostazione predefinita) con un backoff iniziale di 2,5 secondi che raddoppia ogni volta.

   cron:
   - description: "retry demo"
     url: /retry
     schedule: every 10 mins
     retry_parameters:
       min_backoff_seconds: 2.5
       max_doublings: 5
   

Scopri di più sulle opzioni di nuovo tentativo cron.

Deployment di cron job

Per eseguire il deployment dei cron job specificati nel file di configurazione cron.yaml, esegui questo comando:

gcloud app deploy cron.yaml

Eliminazione di tutti i cron job

Per eliminare tutti i cron job:

1. Modifica i contenuti del file cron.yaml per:

   cron:
   

2. Esegui il deployment del file cron.yaml in App Engine.

Protezione degli URL per cron

Un gestore cron è semplicemente un normale gestore definito in app.yaml. Puoi impedire agli utenti di accedere agli URL utilizzati dalle attività pianificate limitando l'accesso agli account amministratore. Le attività pianificate possono accedere agli URL riservati agli amministratori. Puoi limitare un URL aggiungendo login: admin alla configurazione del gestore in app.yaml.

Un esempio potrebbe avere il seguente aspetto in app.yaml:

runtime: python27
api_version: 1

handlers:
- url: /report/weekly
  script: reports.app
  login: admin

Nota: sebbene i cron job possano utilizzare percorsi URL limitati con login: admin, non possono utilizzare percorsi URL limitati con login: required perché le attività cron pianificate non vengono eseguite come qualsiasi utente. La limitazione di admin è soddisfatta dall'inclusione dell'intestazione X-Appengine-Cron descritta di seguito.

Per ulteriori informazioni su come richiedere lo stato di accesso o di amministratore, consulta la documentazione di riferimento di app.yaml.

Per testare un cron job, accedi come amministratore e visita l'URL del gestore nel tuo browser.

Le richieste del servizio cron conterranno anche un'intestazione HTTP:

X-Appengine-Cron: true

L'intestazione X-Appengine-Cron è impostata internamente da App Engine. Se il tuo gestore di richieste trova questa intestazione, può considerare attendibile la richiesta come richiesta cron. Se l'intestazione è presente in una richiesta di un utente esterno alla tua app, viene rimossa, ad eccezione delle richieste degli amministratori dell'applicazione che hanno eseguito l'accesso, che sono autorizzate a impostare l'intestazione a scopo di test.

App Engine emette richieste cron dall'indirizzo IP 0.1.0.2. Per i cron job creati con versioni precedenti di gcloud (precedenti alla 326.0.0), le richieste cron proverranno da 0.1.0.1.

Chiamata a Google Cloud Endpoints

Non puoi specificare un endpoint Google Cloud nel campo url di un cron job. Se vuoi che il tuo cron job chiami un endpoint Google Cloud, invia una richiesta a una destinazione gestita da un gestore nell'app, quindi chiama la classe e il metodo dell'endpoint dal codice del gestore.

Visualizzazione dei cron job nella console Google Cloud

Puoi visualizzare i cron job pianificati nella scheda cron job di App Engine di Cloud Scheduler.

Puoi anche visualizzare i log per vedere quando sono stati aggiunti o rimossi i cron job.

Scopri di più

Consulta informazioni dettagliate sulla definizione dei cron job nel riferimento cron.yaml.