Pianificazione delle attività con Cron per PHP

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

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

Impossibile 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 App Engine endpoint di altre app oltre all'app host.

Una richiesta di job cron è soggetta agli stessi limiti previsti per le code di attività push.

Prima di iniziare

Per eseguire il deployment o l'aggiornamento delle pianificazioni, il tuo account richiede uno dei seguenti ruoli IAM:

  • Proprietario
  • Editor

Puoi impostare l'autorizzazione nella Pagina IAM nella console Google Cloud.

Creazione di un cron job

  1. Crea il file cron.yaml nella directory principale del tuo 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> obbligatori. Esamina la sintassi di cron.yaml e opzioni 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/una versione. Se presente, il target viene anteposto al nome host dell'app, in modo che il job venga indirizzato a quel servizio/a quella versione. Se non viene specificato alcun target, il job verrà eseguito nelle versioni del default servizio configurate per il traffico.

  3. Crea un gestore per l'URL del cron job. L'handler deve eseguire tutte le attività che vuoi pianificare. Il gestore deve rispondere con un codice di stato HTTP tra 200 e 299 (inclusi) per indicare il successo. Altri codici di stato possono e può essere utilizzato per riprova il cron job.

Testare i cron job nel server di sviluppo

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

Puoi utilizzare l'interfaccia di amministrazione del server di sviluppo locale per visualizzare i 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 il job come non riuscito. Per impostazione predefinita, i job non riusciti non vengono ritentati a meno che non venga restituito un codice di stato 503, nel qual caso viene ripetuto ogni minuto fino a quando non riesce o restituisce un codice di stato 200-299.

Per impostare i job non riusciti in modo che vengano riprovati:

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

  2. Scegli e imposta il parametro riprova parametri nel Blocco retry_parameters.

    Ad esempio, questo file cron.yaml di esempio contiene un singolo cron job che è configurata 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 ripetizione di cron.

Eseguire il deployment dei cron job

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

gcloud app deploy cron.yaml

Eliminazione di tutti i cron job

Per eliminare tutti i cron job:

  1. Modifica i contenuti del cron.yaml file in modo da:

    cron:

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

Protezione degli URL per cron

Un gestore cron è solo un normale gestore definito in app.yaml. Puoi impedire agli utenti di accedere agli URL utilizzati dalle attività pianificate limitando l'accesso a Google Workspace for Education. Le attività pianificate possono accedere agli URL solo per amministratori. Puoi limitare un URL aggiungendo login: admin alla configurazione dell'handler in app.yaml.

Un esempio potrebbe essere il seguente in app.yaml:

runtime: php55
api_version: 1

handlers:
- url: /report/weekly
  script: weekly.php
  login: admin
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 browser.

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

X-Appengine-Cron: true

L'intestazione X-Appengine-Cron viene impostata internamente da App Engine. Se il gestore delle richieste trova questa intestazione, può considerare attendibile che la richiesta sia una richiesta di cron. Se l'intestazione è presente nella richiesta di un utente esterno alla tua app, vengono eliminati, ad eccezione delle richieste da parte di amministratori che hanno eseguito l'accesso a cui è consentito 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 (prima del 326.0.0), le richieste cron provenienti da 0.1.0.1.

Chiamata a Google Cloud Endpoints

Non puoi specificare un endpoint Google Cloud in il campo url di un cron job. Se vuoi che il tuo cron job chiami un endpoint Google Cloud, inviare una richiesta a una destinazione pubblicata da un gestore la tua app e chiama la classe e il metodo dell'endpoint dal codice gestore.

Visualizzazione dei cron job nella console Google Cloud

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

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

Scopri di più

Consulta le informazioni dettagliate sulla definizione dei cron job nel file cron.yaml Riferimento.