Riferimento a cron.xml per gli strumenti basati sull'SDK App Engine

Utilizza il file cron.yaml per definire le attività pianificate per la tua applicazione.

Per scoprire di più sulla pianificazione delle attività, incluso come testare, eseguire il deployment o eliminare Cron job, consulta Programmazione 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 principale dell'applicazione insieme a app.yaml: cron.yaml configura le attività pianificate per l'applicazione Java 8.

Definizioni dei cron job

Elemento Descrizione
description Facoltativo. La descrizione è visibile nella console Google Cloud e nell'interfaccia di amministrazione del server di sviluppo.
retry_parameters Facoltativo. Se il gestore delle richieste di un job cron restituisce un codice di stato HTTP non compreso nell'intervallo 200-299 (incluso), App Engine considera il job non riuscito. Per impostazione predefinita, i job non riusciti non vengono riprovati. Puoi eseguire nuovamente i job non riusciti includendo un blocco retry-parameters nel file di configurazione.

Per ulteriori informazioni, consulta la sezione Ripetizioni di Cron.

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

La stringa target è anteposta al nome host dell'app. it è solitamente il nome di un servizio. Il cron job verrà indirizzato del servizio denominato configurato per il traffico.

Se il nome del servizio specificato per target non è trovata, la richiesta Cron viene indirizzata default o alla versione dell'app installata configurate per ricevere il traffico.Per ulteriori informazioni sul routing, Modalità di routing delle richieste.

timezone timezone deve essere il nome di un fuso orario zoneinfo standard. Se non specifichi un fuso orario, i job vengono eseguiti in UTC (noto anche come GMT).
url Obbligatorio. Il campo url è solo un URL della tua applicazione. Se L'elemento url contiene i caratteri XML speciali &, <, > ' o ", devi eseguire il escape.

Definizione del cron job schedule

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

Intervalli inferiori al giorno

Utilizza un intervallo giornaliero secondario per eseguire un job più volte al giorno programmazione. Puoi definire un intervallo di fine o un intervallo di inizio:

  • Intervallo di fine: definisce il periodo di tempo che intercorre tra l'"ora di fine". di un job e all'avvio del job successivo, dove l'"ora di fine" è in cui il job viene completato volte di Google. 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 in questa pianificazione, il completamento alle 02:01, poi il job successivo attende 5 minuto e ricomincia alle 02:06.

  • Intervallo di inizio: definisce un intervallo di tempo regolare per il cron. per avviare ciascun job. A differenza del di fine, l'intervallo di inizio esegue ogni job indipendentemente quando il job precedente viene completato o scade. 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 viene eseguita un'istanza di un job maggiore dell'intervallo di tempo definito, il servizio Cron può saltare lavoro. Una singola ora di inizio nell'intervallo può essere saltata se il job precedente non è stato completato o se è scaduto il tempo.

    Esempio: per every 5 minutes from 10:00 to 14:00 pianificazione, l'esecuzione del primo job inizia 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 inferiore a un giorno o un intervallo personalizzato. Non puoi combinare e utilizzare elementi dei vari intervalli di testo. Di seguito è riportato un esempio di definizione di pianificazione non valida: <schedule>every 6 hours mon,wed,fri</schedule>.
  • Deve essere eseguita una sola istanza di un job alla volta. Il servizio Cron progettato per offrire "almeno una volta" la distribuzione dei dati; cioè se un job è pianificato, App Engine invia la richiesta di job almeno una volta. In alcuni rari è possibile che più istanze dello stesso job vengano richiesto, pertanto, il gestore delle richieste dovrebbe idempotente, e il tuo codice dovrebbe garantire che non ci siano effetti collaterali dannosi .

Formattazione del schedule

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

<schedule>[TYPE] [INTERVAL_VALUE] [INTERVAL_SCOPE]</schedule>

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

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

    Esempio: <schedule>every 12 hours</schedule>

  • [INTERVAL_VALUE]: un valore intero e l'unità corrispondente di nel 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 specifico entro il quale vuoi che vengano eseguiti i job, consulta la sintassi per l'intervallo di inizio o l'intervallo personalizzato.
Esempi di intervalli di tempo di fine
Utilizza i seguenti esempi per capire come definire le pianificazioni dei job che utilizzano un intervallo di ora di fine:
  • Viene eseguito ogni giorno alle 00:00 e attende 5 minuti tra le due per ogni job. Al termine di ogni job, il servizio Cron attende 5 minuti prima di eseguire il job successivo: 
    <schedule>every 5 minutes</schedule>
  • Inizia a funzionare ogni giorno alle 00:00 e attende 30 minuti tra ogni job. Al termine di ogni job, il servizio Cron attende 30 minuti prima di eseguire il job successivo: 
    <schedule>every 30 mins</schedule>
Intervallo di inizio
  • [TYPE]: gli intervalli giornalieri devono includere every .

    Esempio: <schedule>every 12 hours</schedule>

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

      Devi specificare i valori di tempo nel formato 24 ore, HH:MM, dove:

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

      Importante: [INTERVAL_VALUE] deve dividere 24 in un numero intero, altrimenti si verifica un errore. Valori validi per [INTERVAL_VALUE] include: 1, 2, 3, 4, 6 8, 12 o 24.

Esempi di intervalli di inizio
Utilizza i seguenti esempi per capire come definire il job programmazioni che utilizzano un intervallo di inizio:
  • In esecuzione ogni 5 minuti dalle 10:00 alle 14:00, tutti i giorni: 
    <schedule>every 5 minutes from 10:00 to 14:00</schedule>
  • Viene eseguito una volta ogni ora dalle 08:00 alle 16:00, ogni giorno: 
    <schedule>every 1 hours from 08:00 to 16:00</schedule>
  • Eseguito una volta ogni due ore, tutti i giorni a partire dalle ore 00:00: 
    <schedule>every 2 hours synchronized</schedule>
Intervallo personalizzato
  • [TYPE]: gli intervalli personalizzati possono includere every per definire un intervallo ripetitivo oppure puoi definire un intervallo elenco di giorni di un mese:
    • Per definire un intervallo ripetitivo, puoi utilizzare il metodo Prefisso every.

      Esempi: 

      <schedule>every day 00:00</schedule>
<schedule>every monday 09:00</schedule>

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

      Esempio: 

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

  • [INTERVAL_VALUE]: gli intervalli personalizzati includono un elenco dei i giorni specifici in cui vuoi eseguire il job. L'elenco deve essere definiti in un elenco separato da virgole e possono includere uno dei seguenti i 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 dei seguenti elementi valori abbreviati:
      • monday o mon
      • tuesday o tue
      • wednesday o wed
      • thursday o thu
      • friday o fri
      • saturday o sat
      • sunday o sun
      • Usa day per specificare tutti i giorni della settimana.

    Esempi: 

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

  • [INTERVAL_SCOPE]: specifica una clausola corrispondente al valore [INTERVAL_VALUE] specificato. Gli intervalli personalizzati possono includere of [MONTH], che specifica un solo mese in una anno o un elenco di più mesi separati da virgole. Devi anche definire un'ora specifica in cui vuoi che venga eseguito il job, ad esempio: of [MONTH] [HH:MM].

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

    • [MONTH]: devi specificare i mesi in un elenco separato da virgole e puoi 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 24 ore. HH:MM, dove:
      • HH sono numeri interi da 00 a 23.
      • MM sono numeri interi compresi tra 00 e 59.

      • Esempio: 

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

Esempi di intervalli personalizzati
Utilizza i seguenti esempi per capire come definire le pianificazioni dei job che utilizzano un intervallo personalizzato:
  • Viene eseguito ogni giorno alle ore 00:00: 
    <schedule>every day 00:00</schedule>
  • Eseguita ogni lunedì alle 09:00: 
    <schedule>every monday 09:00</schedule>
  • Verrà eseguita una volta il secondo mercoledì di marzo alle ore 17:00: 
    <schedule>2nd wednesday of march 17:00</schedule>
  • Viene pubblicato sei volte a maggio. Durante le prime due settimane, viene pubblicato una volta ogni lunedì, mercoledì e venerdì alle ore 10:00: 
    <schedule>1st,second mon,wed,fri of may 10:00</schedule>
  • Eseguita una volta alla settimana. Ogni sette 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</schedule>
  • Eseguita a settimane alterne. Il primo e il terzo lunedì di ogni mese, viene eseguito una volta alle 04:00: 
    <schedule>1st,third monday of month 04:00</schedule>
  • 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</schedule>
  • Viene eseguita una volta ogni trimestre. Il primo giorno di gennaio, aprile, luglio e ottobre viene eseguito una volta alle 00:00: 
    <schedule>1 of jan,april,july,oct 00:00</schedule>

Nuovi cron

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

Ecco un file cron.xml di esempio che contiene un singolo cron job configurato per riprova fino a cinque volte (valore predefinito) con un backoff iniziale di 2,5 secondi che raddoppia ogni volta.

<cronentries>
  <cron>
    <url>/retry</url>
    <description>Retry on jsdk</description>
    <schedule>every 10 minutes</schedule>
    <retry-parameters>
      <min-backoff-seconds>2.5</min-backoff-seconds>
      <max-doublings>5</max-doublings>
    </retry-parameters>
  </cron>
</cronentries>

Sintassi delle ripetizioni cron

I parametri di ripetizione sono descritti nella tabella seguente.

Elemento Descrizione
job_retry_limit Il numero massimo di nuovi tentativi per un cron job non riuscito non deve essere superato 5. Se specificato con job_age_limit, App Engine proverà di nuovo il cron job finché non vengono raggiunti entrambi i limiti. Se omesso dalla sezione il limite è impostato su 5 per impostazione predefinita.
job_age_limit Il limite di tempo per ritentare un job cron non riuscito, misurato dal primo avvio del job cron. Il valore è un numero seguito da un'unità di tempo, dove l'unità è s per i secondi, m per minuti, h per ore o d per giorni. Ad esempio, il valore 5d specifica un limite di cinque giorni dopo il primo tentativo di esecuzione del job cron. Se specificato con job_retry_limit, App Engine riprova il cron job fino a quando non vengono raggiunti entrambi i limiti.
min_backoff_seconds Numero minimo di secondi di attesa prima di riprovare un cron job dopo non riesce.
max_backoff_seconds Il numero massimo di secondi che devono trascorrere prima di riprovare un cron job dopo non riesce.
max_doublings Il numero massimo di volte in cui l'intervallo tra i tentativi di job cron non riusciti verrà 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

Questo e altri intestazioni vengono impostati internamente da App Engine. Se un client invia queste intestazioni, vengono rimosse dalla richiesta. Fanno eccezione le richieste dagli utenti che hanno eseguito l'accesso gli amministratori di app precedenti, possono impostare l'intestazione a scopo di test.

Indirizzo IP di origine

App Engine emette richieste cron dall'indirizzo IP 0.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.

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 ulteriori informazioni, consulta 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.

Supporto cron nel server di sviluppo

Il server di sviluppo non esegue automaticamente i cron job. Puoi utilizzare la modalità l'interfaccia cron o delle attività pianificate del desktop locale per attivare gli URL i tuoi job con curl o uno strumento simile.

Deployment di cron job

Puoi utilizzare gcloud CLI per eseguire il deployment dei tuoi cron job in App Engine.

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

gcloud

    gcloud app deploy cron.yaml

Maven

    mvn appengine:deployCron cron.yaml

Gradle

    gradle appengineDeployCron cron.yaml

IDE

Se utilizzi IntelliJ o Eclipse, seleziona i singoli file di configurazione da eseguire il deployment utilizzando il modulo di deployment.

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.

Supporto cron nella console Google Cloud

Console Google Cloud La pagina Code di attività contiene una scheda che mostra che eseguono cron job.

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