Como agendar tarefas com cron para PHP

Com o Cron Service do App Engine, você configura tarefas programadas regularmente que operam em horários definidos ou em intervalos regulares. Essas tarefas são normalmente conhecidas como cron jobs. Esses cron jobs são iniciados automaticamente pelo App Engine Cron Service. Por exemplo, use um cron job para enviar um relatório de e-mail diariamente, para atualizar dados armazenados em cache a cada 10 minutos ou para atualizar informações de resumo uma vez a cada hora.

O cron job faz uma solicitação HTTP GET programada para o endpoint especificado no mesmo aplicativo em que o cron job está configurado. O gerenciador desse endpoint executa a lógica quando ele é chamado.

O Cron Service do App Engine não pode ser usado para chamar endpoints da Web fora do aplicativo host do App Engine. Ela não pode ser usada para chamar endpoints do App Engine de outros apps além do app host.

Uma solicitação de cron job está sujeita aos mesmos limites das filas de tarefas push.

Antes de começar

Para implantar ou atualizar programações, sua conta requer uma das seguintes funções do IAM:

• Proprietário
• Editor

Defina a permissão na página do IAM no Console do Google Cloud.

Como criar um cron job

1. Crie o arquivo cron.yaml no diretório raiz do aplicativo (ao lado de app.yaml).

2. Adicione uma ou mais entradas <cron> ao arquivo e defina os elementos necessários para o job, incluindo os elementos <url> e <schedule> obrigatórios. Revise a sintaxe e as opções do cron.yaml para mais detalhes sobre os elementos do arquivo cron.yaml.

   Este é um exemplo da criação de um cron job básico executado diariamente:

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

   A especificação do destino é opcional e é o nome de um serviço/uma versão. Se estiver presente, o destino será precedido pelo nome do host do aplicativo, fazendo com que o job seja roteado para esse serviço/essa versão. Se nenhum destino for especificado, o job será executado nas versões do serviço default que estão configuradas para o tráfego.

3. Crie um gerenciador para o URL do cron job. O gerenciador precisa executar todas as tarefas que você quiser agendar. O gerenciador precisa responder com um código de status HTTP entre 200 e 299 (inclusive) para indicar o êxito. Outros códigos de status podem ser retornados e usados para a repetição do cron job.

Como testar cron jobs no servidor de desenvolvimento

O servidor de desenvolvimento local não executa automaticamente os cron jobs. Faça solicitações diretamente no URL do cron job para testar a funcionalidade. Use o cron job local ou a interface das tarefas programadas para acionar os URLs dos jobs com curl ou uma ferramenta similar.

É possível usar a interface de administração do servidor de desenvolvimento local para visualizar seus cron jobs em http://localhost:8000/cron.

Como repetir cron jobs com falha

Se o gerenciador da solicitação de um cron job retornar um código de status que não esteja no intervalo entre 200 e 299 (inclusive), o App Engine considerará que o job falhou. Por padrão, os jobs com falha não são repetidos a menos que um código de status 503 seja retornado. Nesse caso, ocorre uma nova tentativa a cada minuto até que a falha seja eliminada ou sejam retornados códigos de status entre 200 e 299.

Para definir que os jobs com falha sejam repetidos:

1. Inclua um bloco retry_parameters no arquivo cron.yaml.

2. Escolha e defina os parâmetros de repetição no bloco retry_parameters.

   Por exemplo, o arquivo de amostra cron.yaml inclui um único cron job que está configurado para fazer no máximo cinco tentativas (padrão) com uma espera inicial de 2,5 segundos que dobra a cada vez.

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

Saiba mais sobre as opções de repetição do cron.

Como implantar cron jobs

Para implantar os cron jobs especificados no arquivo de configuração cron.yaml, execute o seguinte comando:

gcloud app deploy cron.yaml

Como excluir todos os cron jobs

Para excluir todos os cron jobs:

1. Edite o conteúdo do arquivo cron.yaml para:

   cron:
   

2. Implante o arquivo cron.yaml no App Engine.

Como proteger URLs para cron

Um manipulador do cron é um manipulador normal definido em app.yaml. Impeça que usuários acessem URLs usados por tarefas agendadas restringindo o acesso somente a contas de administrador. As tarefas agendadas podem acessar URLs somente de administrador. Restrinja um URL adicionando login: admin na configuração do gerenciador no app.yaml.

Um possível exemplo teria a seguinte aparência no app.yaml:

runtime: php55
api_version: 1

handlers:
- url: /report/weekly
  script: weekly.php
  login: admin

Observação: embora os cron jobs possam usar caminhos de URL restritos com login: admin, eles não podem usar caminhos de URL restritos com login: required porque as tarefas programadas pelo cron não são executadas como usuário. A restrição admin é atendida pela inclusão do cabeçalho X-Appengine-Cron descrito abaixo.

Para saber mais informações, veja como exigir o status de login ou administrador na referência do app.yaml.

Para testar um cron job, faça login como administrador e acesse o URL do gerenciador no navegador.

Solicitações do serviço Cron também contêm um cabeçalho HTTP:

X-Appengine-Cron: true

O cabeçalho X-Appengine-Cron é definido internamente pelo App Engine. Se o gerenciador de solicitação encontrar esse cabeçalho, ele terá certeza de que a solicitação vem do cron. Se o cabeçalho estiver presente em uma solicitação de usuário externo no aplicativo, ele será removido, exceto em solicitações de administradores registrados do aplicativo, que têm autorização para definir o cabeçalho para fins de teste.

O App Engine emite solicitações de cron usando o endereço IP 0.1.0.2. Para jobs do cron criados com versões anteriores do gcloud (anteriores a 326.0.0), as solicitações do Cron virão de 0.1.0.1.

Como chamar os Google Cloud Endpoints

Não é possível especificar um Google Cloud Endpoint no campo url de um cron job. Se você quiser que o cron job chame um Google Cloud Endpoint, envie uma solicitação para um destino que seja veiculada por um gerenciador no aplicativo e chame o método e a classe do endpoint a partir do código do gerenciador.

Como visualizar cron jobs no console do Google Cloud

É possível visualizar os cron jobs programados na guia Cron Jobs do App Engine no Cloud Scheduler.

Você também pode ver os registros para saber quando os cron jobs foram adicionados ou removidos.

Saiba mais

Para informações detalhadas sobre como definir cron jobs, consulte a referência do cron.yaml.