Riferimento cron.yaml

Utilizza il file cron.yaml per definire le attività pianificate per l'applicazione.

Per ulteriori informazioni sulla pianificazione delle attività, tra cui come testare, eseguire il deployment o eliminare i job Cron, consulta Pianificazione delle attività con Cron.

Esempio

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

Sintassi

Il file cron.yaml deve trovarsi nella directory root dell'applicazione, oltre che in app.yaml: cron.yaml configura le attività pianificate per l'applicazione Python 2.

Per ulteriori informazioni sul formato YAML, consulta il sito web YAML.

Definizioni di cron job

Elemento Descrizione
description Facoltativo. La descrizione è visibile nella console Google Cloud e nell'interfaccia di amministrazione del server di sviluppo. Racchiudi il valore della descrizione tra virgolette.
retry_parameters Facoltativo. Se il gestore di richieste di un cron job restituisce un codice di stato HTTP non compreso nell'intervallo 200-299 (incluso), App Engine considera il job come non riuscito. Per impostazione predefinita, i job non riusciti non vengono tentati di nuovo. Puoi causare un nuovo tentativo dei job non riusciti includendo un blocco dei parametri per i nuovi tentativi nel file di configurazione.

Consulta la sezione Nuovi tentativi di crono per ulteriori informazioni.

schedule Obbligatorio. Definisce la pianificazione dell'esecuzione del cron job; consulta la sintassi di seguito.
target

La stringa target viene anteposta al nome host dell'app. Di solito è il nome di un servizio. Il cron job verrà instradato alla versione del servizio denominato configurato per il traffico.

Se il nome del servizio specificato per target non viene trovato, la richiesta cron viene instradata al servizio default o alla versione dell'app configurata per ricevere traffico.Per saperne di più sul routing, consulta Come vengono instradate le richieste.

Se utilizzi un file di invio, il job potrebbe essere reindirizzato. Ad esempio, dati i seguenti file cron.yaml e dispatch.yaml, il job verrà eseguito in service2, anche se il suo 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
timezone timezone deve essere il nome di un nome del fuso orario zoneinfo standard. Se non specifichi un fuso orario, la programmazione sarà in UTC (noto anche come GMT).
url Obbligatorio. Il campo url specifica un URL nella tua applicazione che verrà richiamato dal servizio cron. Per ulteriori informazioni, consulta Protezione degli URL per il cron.

Definizione del cron job schedule

I cron job vengono pianificati su intervalli ricorrenti e vengono specificati utilizzando un semplice formato di tipo inglese. Puoi definire una pianificazione in modo che il job venga eseguito più volte al giorno o in giorni e mesi specifici.

Intervalli subgiornalieri

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

  • Intervallo di fine: definisce il tempo tra l'"ora di fine" di un job e l'inizio del job successivo, dove l'"ora di fine" è l'ora in cui il job viene completato o il timeout. Il servizio Cron esegue job in questo tipo di intervallo nell'arco di 24 ore, a partire da 00:00, e attende la durata specificata tra ogni job.

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

  • Intervallo di inizio: definisce un intervallo di tempo regolare entro il quale il servizio cron deve avviare ogni job. A differenza dell'intervallo di tempo di fine, quest'ultimo esegue ogni job indipendentemente dal momento in cui il job precedente viene completato o scade. Puoi impostare un intervallo di tempo entro il quale vuoi che il job venga eseguito, o job 24 ore al giorno, a partire da 00:00.

    Poiché l'ora di inizio di un job è rigida, se un'istanza di un job viene eseguita più a lungo dell'intervallo di tempo definito, il servizio cron può ignorare un job. Una singola ora di inizio nell'intervallo può essere saltata se il job precedente non è stato completato o se è scaduto.

    Esempio: per la pianificazione every 5 minutes from 10:00 to 14:00, il primo job viene 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, pertanto, il servizio cron non esegue un'altra istanza di questo job fino al giorno 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 eseguiti con una pianificazione personalizzata vengono eseguiti tutto l'anno, solo in un momento specifico 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 vuoi utilizzare un intervallo subgiornaliero o un intervallo 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.
  • Deve essere eseguita una sola istanza di un job in qualsiasi momento. Il servizio Cron è progettato per fornire la distribuzione "at least once", ovvero, se un job è pianificato, App Engine invia la richiesta del job almeno una volta. In alcune rare circostanze, è possibile che vengano richieste più istanze dello stesso job. Di conseguenza, il gestore delle richieste deve essere idempotente e il codice deve garantire che non ci siano effetti collaterali dannosi in questo caso.

Formattazione di schedule

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

schedule: [TYPE] [INTERVAL_VALUE] [INTERVAL_SCOPE]

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

Intervallo di tempo di fine
  • [TYPE]: gli intervalli giornalieri devono includere il prefisso every.

    Esempio: schedule: every 12 hours

  • [INTERVAL_VALUE]: un valore intero e la corrispondente unità di tempo. Valori validi per l'unità di tempo:
    • minutes o mins
    • hours
  • [INTERVAL_SCOPE]: non applicabile. Per impostare un'ora di inizio o un intervallo di tempo specifico entro cui eseguire i job, consulta la sintassi per Intervallo di inizio o Intervallo personalizzato.
Esempi di intervallo di tempo di fine
Utilizza i seguenti esempi per aiutarti a comprendere come definire le pianificazioni dei job che utilizzano un intervallo di tempo di fine:
  • Viene eseguita ogni giorno alle 00:00 e attende 5 minuti tra un job e l'altro. Al termine di ogni job, il servizio cron attende 5 minuti prima di eseguire il job successivo:
    schedule: every 5 minutes
  • Viene eseguita ogni giorno alle 00:00 e attende 30 minuti tra un job e l'altro. Al termine di ogni job, il servizio cron attende 30 minuti prima di eseguire il job successivo:
    schedule: every 30 mins
Intervallo di inizio
  • [TYPE]: gli intervalli giornalieri devono includere il prefisso every.

    Esempio: schedule: every 12 hours

  • [INTERVAL_VALUE]: un valore intero e la corrispondente unità di tempo. Valori validi per l'unità di tempo:
    • minutes o mins
    • hours
  • [INTERVAL_SCOPE] Specifica una clausola che corrisponde a [INTERVAL_VALUE]. Puoi definire un intervallo di tempo personalizzato o utilizzare l'opzione synchronized di 24 ore.
    • Includi la clausola from [HH:MM] to [HH:MM] per definire un'ora di inizio e un intervallo specifici entro i quali vuoi eseguire i job.

      Devi specificare i valori dell'ora nel formato di 24 ore, HH:MM, dove:

      • HH sono numeri interi da 00 a 23.
      • MM sono numeri interi da 00 a 59.
    • Utilizza synchronized per specificare un intervallo di tempo di 24 ore (from 00:00 to 23:59) diviso uniformemente per il valore [INTERVAL_VALUE].

      Importante: l'intervallo [INTERVAL_VALUE] deve dividere 24 in un numero intero, altrimenti si verifica un errore. I valori validi per [INTERVAL_VALUE] includono: 1, 2, 3, 4, 6, 8, 12 o 24.

Esempi di intervallo di tempo di inizio
Utilizza i seguenti esempi per aiutarti a comprendere come definire le pianificazioni dei job che utilizzano un intervallo di tempo di inizio:
  • Eseguita ogni 5 minuti dalle 10:00 alle 14:00, tutti i giorni:
    schedule: every 5 minutes from 10:00 to 14:00
  • Viene eseguito una volta all'ora dalle 08:00 alle 16:00, tutti i giorni:
    schedule: every 1 hours from 08:00 to 16:00
  • Viene eseguito una volta ogni due ore, ogni giorno a partire dalle ore 00:00:
    schedule: every 2 hours synchronized
Intervallo personalizzato
  • [TIPO]: gli intervalli personalizzati possono includere il prefisso every per definire un intervallo ripetitivo oppure puoi definire un elenco specifico di giorni in un mese:
    • Per definire un intervallo ripetitivo puoi utilizzare il prefisso every.

      Esempi:

      schedule: every day 00:00
      schedule: every monday 09:00

    • Per definire giorni specifici, devi utilizzare i numeri ordinali. I valori validi sono dal primo giorno di un mese fino al numero massimo di giorni in quel mese, ad esempio:
      • 1st o first
      • 2nd o second
      • 3rd o third
      • E fino a: 31st o thirtyfirst

      Esempio:

      schedule: 1st,3rd tuesday
      schedule: 2nd,third wednesday of month 09:00

  • [INTERVAL_VALUE]: gli intervalli personalizzati includono un elenco dei giorni specifici in cui vuoi eseguire il job. L'elenco deve essere definito in un elenco separato da virgole e può includere uno dei seguenti valori:
    • Il valore intero del giorno del mese fino a un massimo di 31 giorni, ad esempio:
      • 1
      • 2
      • 3
      • E fino a: 31
    • Il nome del giorno in una combinazione di uno dei seguenti valori lunghi o abbreviati:
      • monday o mon
      • tuesday o tue
      • wednesday o wed
      • thursday o thu
      • friday o fri
      • saturday o sat
      • sunday o sun
      • Utilizza day per specificare tutti i giorni della settimana.

    Esempi:

    schedule: 2nd monday,thu
    schedule: 1,8,15,22 of month 09:00
    schedule: 1st mon,wednesday,thu of sep,oct,nov 17:00

  • [INTERVAL_SCOPE]: specifica una clausola corrispondente all'intervallo [INTERVAL_VALUE] specificato. Gli intervalli personalizzati possono includere la clausola of [MONTH], che specifica un singolo mese di un anno, o un elenco separato da virgole di mesi multipli. Devi anche definire un momento specifico entro cui vuoi eseguire il job, ad esempio: of [MONTH] [HH:MM].

    Per impostazione predefinita, se la clausola of è esclusa, l'intervallo personalizzato viene eseguito ogni mese.

    • [MESE]: devi specificare i mesi in un elenco separato da virgole e includere una combinazione dei seguenti valori lunghi o abbreviati:
      • january o jan
      • february o feb
      • march o mar
      • april o apr
      • may
      • june o jun
      • july o jul
      • august o aug
      • september o sep
      • october o oct
      • november o nov
      • december o dec
      • Utilizza month per specificare tutti i mesi dell'anno.
    • [HH:MM]: devi specificare i valori dell'ora nel formato a 24 ore, HH:MM, dove:
      • HH sono numeri interi da 00 a 23.
      • MM sono numeri interi da 00 a 59.
    • Esempio:

      schedule: 1st monday of sep,oct,nov 09:00
      schedule: 1 of jan,april,july,oct 00:00

Esempi di intervalli personalizzati
Utilizza i seguenti esempi per aiutarti a comprendere come definire le pianificazioni dei job che utilizzano un intervallo personalizzato:
  • Eseguito ogni giorno alle 00:00:
    schedule: every day 00:00
  • Ogni lunedì alle 09:00:
    schedule: every monday 09:00
  • Viene eseguita una volta il secondo mercoledì di marzo alle 17:00:
    schedule: 2nd wednesday of march 17:00
  • Viene eseguita sei volte a maggio. Durante le prime due settimane, viene eseguita una volta ogni lunedì, mercoledì e venerdì alle 10:00:
    schedule: 1st,second mon,wed,fri of may 10:00
  • Eseguita una volta alla settimana. Ogni 7 giorni a partire dal primo giorno di ogni mese, viene eseguita una volta alle 09:00:
    schedule: 1,8,15,22 of month 09:00
  • Eseguita ogni due settimane. Il primo e il terzo lunedì di ogni mese, viene eseguita una volta alle 04:00:
    schedule: 1st,third monday of month 04:00
  • Viene eseguito tre volte all'anno. Il primo lunedì di settembre, ottobre e novembre viene eseguito una volta alle 09:00:
    schedule: 1st monday of sep,oct,nov 09:00
  • Viene eseguita una volta ogni trimestre. Il primo giorno di gennaio, aprile, luglio e ottobre viene eseguita una volta alle 00:00:
    schedule: 1 of jan,april,july,oct 00:00

Nuovi tentativi cron

Se il gestore di richieste di un cron job restituisce un codice di stato non compreso nell'intervallo 200-299 (incluso), App Engine considera il job come non riuscito. Per impostazione predefinita, i job non riusciti non vengono tentati di nuovo. Puoi causare un nuovo tentativo dei job non riusciti includendo un blocco retry_parameters nel file di configurazione.

Ecco un file cron.yaml di esempio che contiene un singolo job cron configurato per un massimo di cinque tentativi (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

Sintassi dei nuovi tentativi cron

I parametri per i nuovi tentativi sono descritti nella tabella seguente.

Elemento Descrizione
job_retry_limit Il numero massimo di tentativi per un cron job non riuscito non deve superare 5. Se specificato con job_age_limit, App Engine tenta di nuovo il cron job fino al raggiungimento di entrambi i limiti. Se omesso dai parametri, il limite è impostato su 5 per impostazione predefinita.
job_age_limit Il limite di tempo per riprovare un cron job non riuscito, misurato dalla prima esecuzione del cron job. Il valore è un numero seguito da un'unità di tempo, dove l'unità è s per i secondi, m per i minuti, h per le ore o d per i giorni. Ad esempio, il valore 5d specifica un limite di cinque giorni dopo il primo tentativo di esecuzione del cron job. Se specificato con job_retry_limit, App Engine riprova il cron job fino al raggiungimento di entrambi i limiti.
min_backoff_seconds Il numero minimo di secondi di attesa prima di riprovare un cron job non riuscito.
max_backoff_seconds Il numero massimo di secondi di attesa prima di riprovare un cron job non riuscito.
max_doublings Il numero massimo di volte in cui l'intervallo tra i nuovi tentativi di cron job non riusciti sarà raddoppiato prima che l'aumento diventi costante. La costante è: 2**(max_doublings - 1) * min_backoff.

Richieste cron

Intestazioni delle richieste

Le richieste del servizio cron conterranno un'intestazione HTTP:

X-Appengine-Cron: true

Questa e altre intestazioni vengono impostate internamente da App Engine. Se un client invia queste intestazioni, vengono rimosse dalla richiesta. Fanno eccezione le richieste da parte degli amministratori delle app legacy che hanno eseguito l'accesso e che sono autorizzati a impostare l'intestazione a fini di test.

Indirizzo IP di origine

App Engine genera richieste cron provenienti dall'indirizzo IP 0.1.0.2. Per i cron job creati con versioni precedenti di gcloud (antecedenti alla versione 326.0.0), le richieste cron provengono da 0.1.0.1.

Timeout richiesta

Il timeout della richiesta cron dipende dal tipo di scalabilità configurato per la tua app:

Scalabilità automatica
Timeout della richiesta di 10 minuti.
Scalabilità di base e scalabilità manuale
Timeout della richiesta di 24 ore.

Per saperne di più, vedi Come vengono gestite le istanze.

Limiti

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