Pianificazione dei job con cron.yaml

Il servizio cron di App Engine consente di configurare attività programmate ricorrenti eseguite in orari specifici o a intervalli regolari. Queste attività sono comunemente chiamate cron job. Questi cron job vengono attivati automaticamente dal servizio cron di App Engine. Ad esempio, puoi utilizzarlo per inviare un'email con un report ogni giorno, per aggiornare alcuni dati memorizzati nella cache ogni 10 minuti o per aggiornare alcune informazioni di riepilogo una volta all'ora.

Un job cron richiama un URL utilizzando una richiesta HTTP GET soggetta agli stessi limiti di altre richieste HTTP.

Le applicazioni gratuite possono avere fino a 20 attività pianificate. Le applicazioni a pagamento possono avere fino a 250 attività pianificate.

Per eseguire il deployment o l'aggiornamento delle pianificazioni, il tuo account richiede uno dei seguenti ruoli Identity and Access Management:

• Proprietario
• Editor

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

Informazioni sul file di configurazione cron

Un file cron.yaml nella directory principale della tua applicazione (insieme a app.yaml) configura le attività pianificate per la tua applicazione Go 1.11. Di seguito è riportato un esempio di file cron.yaml:

cron:
- description: "daily summary job"
  url: /tasks/summary
  schedule: every 24 hours
- description: "monday morning mailout"
  url: /mail/weekly
  schedule: every monday 09:00
  timezone: Australia/NSW
- description: "new daily summary job"
  url: /tasks/summary
  schedule: every 24 hours
  target: beta

Il file cron.yaml utilizza la sintassi YAML e consiste in definizioni per ciascuno dei tuoi job cron. Una definizione di job deve avere un url e un schedule. Se vuoi, puoi anche specificare description, timezone, target e retry_parameters:

url

Obbligatorio. L'URL nell'app a cui vuoi che il servizio Cron invii le richieste di lavoro.

schedule

Obbligatorio. Definisce la pianificazione dell'esecuzione del job. Consulta la sintassi riportata di seguito.

description

(Facoltativo) Descrive il job cron, visibile dalla console Google Cloud e dall'interfaccia di amministrazione del server di sviluppo locale.

timezone

(Facoltativo) Il nome del fuso orario o "zoneinfo" da utilizzare per la pianificazione dei job. Se non specifichi un fuso orario, la programmazione utilizza UTC, conosciuto anche comeGMT.

target

(Facoltativo) Il nome di un servizio specifico nella tua app. Quando viene specificato target, il servizio Cron indirizza la richiesta di job a quel servizio nella tua app. Le richieste di job vengono inoltrate alle versioni del servizio specificato configurate per il traffico. Scopri come vengono instradate le richieste.

Considerazioni importanti per target:

• Se hai attivato la suddivisione del traffico, le richieste di job non verranno suddivise tra le versioni che hai configurato:
  • Suddivisione degli indirizzi IP: le richieste di job del servizio Cron vengono sempre inviate dallo stesso indirizzo IP e, di conseguenza, vengono indirizzate sempre alla stessa versione.
  • Suddivisione dei cookie: le richieste di job non includono un cookie con la richiesta e, pertanto, non vengono inoltrate ad altre versioni.
• Se utilizzi un file di invio, i job possono essere reindirizzati se lo stesso URL è configurato anche in dispatch.yaml. Ad esempio, se l'URL /tasks/hello_service2 è definito in entrambi i file cron.yaml e dispatch.yaml seguenti, le richieste di job vengono inviate a service2, anche se è specificato target: service1:

  cron.yaml:

  cron:
  - description: "test dispatch vs target"
    url: /tasks/hello_service2
    schedule: every 1 mins
    target: service1

  dispatch.yaml:

  dispatch:
  - url: '*/tasks/hello_service2'
    service: service2

retry_parameters

(Facoltativo) Specifica di riavviare i job non riusciti. Consulta la sintassi riportata di seguito.

Definizione del cron job schedule

I cron job vengono pianificati a intervalli ricorrenti e sono specificati utilizzando un semplice formato simile all'inglese. Puoi definire una pianificazione in modo che il job venga eseguito più volte al giorno oppure in giorni e mesi specifici.

Intervalli inferiori al giorno

Utilizza un intervallo inferiore a un giorno per eseguire un job più volte al giorno in base a una programmazione ripetitiva. Puoi definire un intervallo di fine o un intervallo di inizio:

• Intervallo di fine: definisce il tempo che intercorre tra l'"ora di fine" di un job e l'inizio del job successivo, dove l'"ora di fine" è il tempo in cui il job viene completato o times out . Il servizio Cron esegue i job in questo tipo di intervallo per l'intera giornata, a partire dalle 00:00, e attende la durata specificata tra ogni job.

  Esempio: per la pianificazione every 5 minutes, il job viene eseguito quotidianamente con un intervallo di 5 minuti. Se un'istanza di un job in esecuzione su questa pianificazione viene completata alle 02:01, il job successivo attende 5 minuti e ricomincia alle 02:06.

• Intervallo di inizio: definisce un intervallo di tempo regolare per l'avvio di ogni job da parte del servizio Cron. A differenza dell'intervallo di tempo di fine, l'intervallo di tempo di inizio esegue ogni job indipendentemente dal completamento o dal timeout del job precedente. Puoi impostare un intervallo di tempo entro il quale eseguire il job o eseguire i job 24 ore al giorno, a partire da00:00.

  Poiché l'ora di inizio di un job è rigorosa, se un'istanza di un job viene eseguita più a lungo dell'intervallo di tempo definito, il servizio Cron può saltare un job. Un'ora di inizio singola nell'intervallo può essere saltata se il job precedente non è stato completato o se il tempo scade.

  Esempio: per la pianificazione every 5 minutes from 10:00 to 14:00, il primo job inizia a essere eseguito alle ore 10:00 e poi ogni 5 minuti. Se il primo job viene eseguito per 7 minuti, il job 10:05 viene ignorato e, di conseguenza, il servizio Cron non esegue un'altra istanza di questo job fino a 10:10.

Intervallo personalizzato

Puoi utilizzare un intervallo personalizzato per definire una pianificazione in cui il job può essere eseguito una volta al giorno in uno o più giorni selezionati e in uno o più mesi selezionati. I job che vengono eseguiti in base a una pianificazione personalizzata vengono eseguiti tutto l'anno, solo all'ora specifica nei giorni e nei mesi selezionati.

Esempio: per la pianificazione 1,2,3 of month 07:00, il job viene eseguito una volta alle ore 07:00 nei primi tre giorni di ogni mese.

Considerazioni importanti per schedule:

• Devi decidere se utilizzare un intervallo giornaliero o personalizzato. Non puoi combinare e utilizzare elementi dei vari tipi di intervallo. Di seguito è riportato un esempio di definizione di pianificazione non valida: schedule: every 6 hours mon,wed,fri.
• In qualsiasi momento deve essere eseguita una sola istanza di un job. Il servizio Cron è progettato per fornire la consegna "almeno una volta", ovvero se un job è pianificato, App Engine invia la richiesta di job almeno una volta. In alcune rare circostanze è possibile che vengano richieste più istanze dello stesso job, pertanto il gestore delle richieste deve essere idempotente e il codice deve garantire che non si verifichino effetti collaterali dannosi in questo caso.

Formattazione del schedule

Per specificare quando viene eseguito il job, devi definire l'elemento schedule utilizzando la seguente sintassi:

schedule: [TYPE] [INTERVAL_VALUE] [INTERVAL_SCOPE]

Scegli un tipo di intervallo per definire l'elemento schedule:

Specifica dei nuovi tentativi

Se il gestore delle richieste di un job cron restituisce un codice di stato non compreso tra 200 e 299 (inclusi), App Engine considera il job non riuscito. Per impostazione predefinita, i job non riusciti non vengono riprovati. Puoi fare in modo che i job non riusciti vengano riprovati includendo un blocco retry_parameters nel file di configurazione.

Ecco un file cron.yaml di esempio che contiene un singolo job cron configurato per ritentare fino a cinque volte con un backoff iniziale di 2,5 secondi che raddoppia ogni volta.

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

Sintassi delle ripetizioni cron

I parametri di ripetizione sono descritti nella tabella seguente.

Convalida delle richieste cron

Ti consigliamo di verificare che le richieste agli URL cron provengano da App Engine e non da un'altra origine. Puoi farlo convalidando un'intestazione HTTP e l'indirizzo IP di origine della richiesta:

• Le richieste del servizio Cron conterranno la seguente intestazione HTTP:

  X-Appengine-Cron: true
  

  Questo e altri intestazioni vengono impostati internamente da App Engine. Se un client invia queste intestazioni, vengono rimosse dalla richiesta.

• App Engine invia richieste Cron dall'indirizzo IP0.1.0.2. Per i cron job creati con versioni precedenti di gcloud (precedente alla 326.0.0), le richieste di Cron provengono da 0.1.0.1.

Caricamento dei cron job

Per caricare i job cron, devi specificare cron.yaml come parametro nel seguente comando gcloud:

gcloud app deploy cron.yaml

Eliminazione dei cron job

Per eliminare tutti i cron job, modifica il file cron.yaml in modo che contenga solo:

cron:

Supporto di Cron nella console Google Cloud

Puoi controllare i cron job pianificati nella pagina Cron job della console Google Cloud.

Puoi anche visitare la pagina Log per vedere quando sono stati aggiunti o rimossi i job cron.