Referência do cron.yaml para a CLI gcloud

Use o arquivo cron.yaml para definir tarefas programadas no seu aplicativo.

Para saber mais sobre como programar tarefas, incluindo instruções de teste, implantação ou exclusão de cron jobs, consulte Como programar tarefas com o Cron.

Exemplo

A seguir, um exemplo de arquivo 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

Sintaxe

Definições de cron jobs

# 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

Como definir o cron job schedule

Os cron jobs são programados em intervalos recorrentes e especificados usando um formato simples semelhante ao inglês. É possível definir uma programação para que o job seja executado diversas vezes por dia ou em dias e meses determinados.

Intervalos subdiários

Use um intervalo subdiário para executar um job diversas vezes por dia em uma programação repetitiva. É possível definir um intervalo para o horário de término ou de início:

• Intervalo de horário de término: define o período entre o horário de término de um job e o horário de início do próximo, em que o horário de término é o momento da conclusão ou expiração do job. O serviço Cron executa jobs nesse tipo de intervalo durante 24 horas começando à 00:00 e cumpre o período especificado entre cada job.

  Exemplo: para a programação every 5 minutes, o job é executado diariamente usando um intervalo de 5 minutos. Se a instância de um job em execução nessa programação for concluída às 2h01, o próximo job aguardará cinco minutos e recomeçará às 2h06.

• Intervalo de horário de início: define um intervalo de tempo regular para o serviço Cron iniciar cada job. Ao contrário do intervalo de horário de término, o de horário de início executa cada job sem considerar quando o job anterior é concluído ou expira. É possível configurar um intervalo de tempo para a execução do job ou executar jobs 24 horas por dia, começando às 00:00.

  Como o horário de início de um job é rigoroso, quando a execução de uma instância dele é superior ao intervalo de tempo definido, o serviço Cron ignora o job. No intervalo, um horário de início individual será ignorado caso o job anterior não tenha sido concluído ou tenha expirado .

  Exemplo: para a programação every 5 minutes from 10:00 to 14:00, o primeiro job começa a ser executado em 10:00 e a cada cinco minutos depois disso. Se esse primeiro job for executado por sete minutos, o job de 10:05 será ignorado e, portanto, o serviço Cron não executará outra instância desse job até 10:10.

Intervalo personalizado

É possível usar um intervalo personalizado para definir uma programação em que o job seja executado uma vez por dia em um ou mais dias e em um ou mais meses selecionados. Os jobs que fazem parte de uma programação personalizada são executados durante todo o ano, apenas no horário específico, nos dias e meses selecionados.

Exemplo: para a programação 1,2,3 of month 07:00, o job é executado uma vez em 07:00 nos três primeiros dias de cada mês.

Considerações importantes sobre schedule:

• É preciso decidir entre usar um intervalo subdiário ou personalizado. Não é possível misturar nem usar elementos dos diversos tipos de intervalos. Veja a seguir um exemplo de uma definição de programação inválida: schedule: every 6 hours mon,wed,fri.
• Só é possível executar uma instância do job por vez. O serviço Cron foi projetado para fornecer a entrega "pelo menos uma vez". Ou seja, quando um job está programado, o App Engine envia a solicitação dele pelo menos uma vez. Em raras circunstâncias, é possível que sejam solicitadas diversas instâncias do mesmo job. Se isso acontecer, será necessário que o gerenciador de solicitações seja idempotente (em inglês) e que o código garanta que não haja efeitos colaterais prejudiciais.

Como formatar o schedule

Para especificar quando o job é executado, defina o elemento schedule usando a seguinte sintaxe:

schedule: [TYPE] [INTERVAL_VALUE] [INTERVAL_SCOPE]

Escolha um tipo de intervalo para definir seu elemento schedule:

Novas tentativas do cron

Se o gerenciador da solicitação de um cron job retorna um código de status que não está no intervalo entre 200 e 299, o App Engine considera que o job falhou. Por padrão, os jobs com falha não são executados novamente. É possível fazer com que os jobs com falha sejam repetidos, incluindo um bloco retry_parameters no seu arquivo de configuração.

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

Sintaxe das novas tentativas do cron

Veja descrições sobre os parâmetros das novas tentativas na tabela abaixo:

Solicitações do Cron

Cabeçalhos de solicitação

As solicitações do Cron Service também contêm um cabeçalho HTTP:

X-Appengine-Cron: true

Esse e outros cabeçalhos são definidos internamente pelo App Engine. Se um cliente enviar esses cabeçalhos, eles serão removidos da solicitação. Como exceção, temos as solicitações de administradores conectados de apps legados, com autorização para configurar o cabeçalho para fins de testes.

Endereço IP de origem

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.

Tempo limite da solicitação

O tempo limite da solicitação cron depende do tipo de escalonamento configurado para o aplicativo:

Escalonamento automático

O tempo limite da solicitação é de 10 minutos.

Escalonamento básico e manual

Tempo limite da solicitação de 24 horas.

Para mais informações, consulte Como as instâncias são gerenciadas.

Limites

Os aplicativos gratuitos podem ter até 20 tarefas programadas. e os pagos podem ter até 250.

Suporte para o Cron no servidor de desenvolvimento

O servidor de desenvolvimento não executa os cron jobs automaticamente. Use o cron local ou interface de tarefas programadas para acionar os URLs dos jobs com a ferramenta curl ou similar.

Como implantar cron jobs

É possível usar a CLI gcloud para implantar os cron jobs no App Engine. Também é possível implantar com os plug-ins do Maven ou Gradle do App Engine. Outras opções são IntelliJ ou Eclipse.

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

    gcloud app deploy cron.yaml

    mvn appengine:deployCron cron.yaml

    gradle appengineDeployCron 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.

Suporte ao cron no console do Google Cloud

A página Filas de tarefas do Console do Google Cloud tem uma guia que mostra as tarefas que estão executando cron jobs.

Acesse também a página Registros para ver quando os cron jobs foram adicionados ou removidos.