Gatilho do Cloud Scheduler

Aviso: o Application Integration já está disponível para seu projeto do Google Cloud. Agora é possível usar a Apigee Integration e o Application Integration no mesmo projeto do Google Cloud. Saiba mais

O gatilho do Cloud Scheduler permite programar suas execuções de integração para períodos definidos ou intervalos regulares em várias regiões.

Os gatilhos do Cloud Scheduler aproveitam os serviços do Cloud Scheduler para fornecer um programador de cron jobs totalmente gerenciado e de nível empresarial na integração da Apigee. Com esse gatilho, agora é possível gerenciar todos os cron jobs criados na sua integração, tanto a partir da IU de integração da Apigee quanto do painel do Cloud Scheduler. Além disso, o gatilho do Cloud Scheduler também permite implantar cron jobs entre regiões para programar as execuções de integração.

Por exemplo, se você tiver provisionado sua integração no us-central1, pode usar o gatilho do Cloud Scheduler para implantar um cron job no asia-east1 (ou qualquer uma das regiões compatíveis do Google Cloud para o Cloud Scheduler) para chamar o endpoint de integração em us-central1.

Importante: cobranças separadas serão aplicadas ao uso dos serviços do Cloud Scheduler na sua integração. Você será cobrado com base no número de cron jobs criados usando o gatilho do Cloud Scheduler na integração da Apigee. Para mais informações sobre as cobranças do Cloud Scheduler, consulte Preços do Cloud Scheduler.

Antes de começar

Execute as seguintes tarefas no projeto do Google Cloud antes de configurar o gatilho do Cloud Scheduler:

1. Ative a API Cloud Scheduler (cloudscheduler.googleapis.com).

   Ativação da API Cloud Scheduler

2. Confirme se você tem uma conta de serviço do Google com o papel de invocador de integração da Apigee atribuído. Se você não tiver uma conta de serviço, crie uma e atribua o papel de invocador de integração da Apigee a ela.

   Para informações sobre como criar e gerenciar contas de serviço, consulte Como criar e gerenciar contas de serviço.

   Para informações sobre os papéis predefinidos de integração da Apigee, consulte Papéis predefinidos do IAM.

Adicionar o gatilho do Cloud Scheduler

Para adicionar um gatilho do Cloud Scheduler à sua integração, siga estas etapas:

1. Na IU da Apigee, selecione sua organização da Apigee.
2. Clique em Desenvolver > Integrações.
3. Selecione uma integração existente ou clique em Criar integração.

   Caso você esteja criando uma nova integração, siga estas etapas:

   1. Digite um nome e uma descrição na caixa de diálogo Criar integração.
   2. Selecione uma Região para a integração na lista de regiões compatíveis.
   3. Clique em Criar.

   Isso abre a integração na página do designer de integração.

4. Na barra de navegação do designer de integração, clique em +Adicionar uma tarefa/gatilho > Gatilhos para ver a lista de gatilhos disponíveis.
5. Clique e coloque o elemento gatilho do Cloud Scheduler no editor de integração.

Configurar o gatilho do Cloud Scheduler

Para configurar um gatilho do Cloud Scheduler, execute as seguintes etapas:

1. Clique no elemento gatilho do Cloud Scheduler no editor de integração para abrir o painel de configuração do gatilho.

   Especifique a programação do gatilho do Cloud Scheduler usando uma das seguintes opções:

   • Básico: use a interface do usuário para configurar a programação do cron job.
   • Avançado: use uma expressão unix-cron para configurar a programação do cron job.
2. (Para a opção "Básico") Selecione a guia Básico e faça o seguinte nos campos indicados:
   1. Períodos: selecione os intervalos em que a integração precisa ser executada.
      • Executar em um horário específico: selecione esta opção para executar a integração em um momento específico.
      • Repetir por hora: selecione essa opção para executar a integração repetidamente por hora.
      • Repetir por minuto: selecione esta opção para executar a integração repetidamente de acordo com o número especificado de minutos
   2. Dias: selecione os dias em que a integração deve ser executada. Você pode executar a integração todos os dias, em dias específicos da semana ou em um determinado dia do mês.
   3. Meses: selecione os meses em que a integração deve ser executada. É possível executar a integração todo mês ou durante meses específicos.
3. (Para a opção "Avançado") selecione a guia Avançado e especifique a programação do cron job usando uma expressão cron.

   A expressão cron tem cinco valores que precisam ser especificados na seguinte ordem:

   1. Minuto (0-59)
   2. Hora (0-23)
   3. Dia do mês (1-31)
   4. Mês, um dos seguintes valores:
      • Um número de 1-a 12
      • Uma abreviação de três letras do mês (por exemplo, jan, fev e mar)
   5. Dia da semana, um dos seguintes valores:
      • Um número de 0 a 6, com domingo como 0
      • Uma abreviação de três letras do dia (por exemplo, seg, ter, quar)

   Por exemplo, para executar a integração no primeiro dia de cada mês, use a expressão cron * * 1 * *.

   Para mais informações, consulte Configurar programações de cron job.

4. Região: selecione a região em que o job do Cloud Scheduler será implantado.
5. E-mail da conta de serviço: insira o endereço de e-mail da conta de serviço do Google criada.

Saída do gatilho

Para cada gatilho do Cloud Scheduler que é configurado e publicado na sua versão de integração, a integração da Apigee cria um novo job do Cloud Scheduler no projeto do Google Cloud.

Um job do Cloud Scheduler é criado usando a seguinte convenção de nomenclatura para evitar erros de duplicação de jobs:

    INTEGRATION_NAME__VINTEGRATION_VERSION__CLOUD_SCHEDULER_TRIGGER_NUMBER
    

Exemplo: DemoIntegration__V1__1

Acionar registros

Um gatilho do Cloud Scheduler gera registros no início e no final de cada execução de integração. É possível visualizar os registros do gatilho do Cloud Scheduler na página Explorador de registros do Cloud Logging:

1. No console do Google Cloud, acesse a página do Cloud Scheduler.

   Acessar o Cloud Scheduler

2. Localize o job do Cloud Scheduler e clique em Visualizar na coluna Registros.

   A página Explorador de registros do Cloud Logging é exibida com os registros gerados pelo gatilho do Cloud Scheduler.

Observação: a integração da Apigee não armazena nem coleta registros gerados pelo gatilho do Cloud Scheduler. Esses registros são armazenados no projeto do Google Cloud e só podem ser acessados na página Explorador de registros do Cloud Logging.

Editar um gatilho do Cloud Scheduler

Integração com a Apigee

Aviso: editar um gatilho do Cloud Scheduler da integração da Apigee substituirá o cron job atual por um novo em uma nova versão de integração.

Para editar o gatilho do Cloud Scheduler da integração da Apigee, siga estas etapas:

1. Na IU da Apigee, selecione sua organização da Apigee.
2. Clique em Desenvolver > Integrações.
3. Selecione a integração que você quer editar.
4. No editor de integração, clique no menu suspenso Versão e selecione a versão de integração que contém o gatilho do Cloud Scheduler que você quer editar.
5. Cancelar publicação e ativar a edição se a versão da integração selecionada estiver publicada (em estado ativo).
6. Clique no elemento gatilho do Cloud Scheduler no editor de integração para abrir o painel de configuração do gatilho.
7. Modifique as configurações de job do Cloud Scheduler como quiser.

Cloud Scheduler

É possível editar o gatilho do Cloud Scheduler modificando a configuração do job no Cloud Scheduler:

1. No Console do Google Cloud, acesse o Cloud Scheduler.

   Acessar o Cloud Scheduler

2. Selecione o job do Cloud Scheduler para editar.
3. Clique em Editar.
4. Modifique as configurações de job do Cloud Scheduler como quiser.

Observação: editar um job do Cloud Scheduler não altera o estado da versão de integração de destino.

Pausar, retomar e copiar um job do Cloud Scheduler

A integração da Apigee não é compatível com operações de pausa, retomada e cópia para um job do Cloud Scheduler criado com o gatilho do Cloud Scheduler.

O gatilho do Cloud Scheduler gerará um erro no painel de configuração do gatilho se você pausar manualmente a execução de um job no Cloud Scheduler.

Consulte mais informações sobre as mensagens de erro do gatilho do Cloud Scheduler em Resolver problemas do gatilho do Cloud Scheduler. Para informações sobre como pausar e retomar um cron job usando o Cloud Scheduler, consulte Pausar ou retomar um job.

Excluir um job do Cloud Scheduler

É possível excluir um job do Cloud Scheduler na integração da Apigee ou no Cloud Scheduler.

Integração com a Apigee

Para excluir um job do Cloud Scheduler na integração da Apigee, siga estas etapas:

1. Na IU da Apigee, selecione sua organização da Apigee.
2. Clique em Desenvolver > Integrações.
3. Selecione a integração que você quer editar.
4. No editor de integração, clique no menu suspenso Versão e selecione a versão de integração que contém o gatilho do Cloud Scheduler que você quer excluir.
5. Cancele a publicação da versão de integração selecionada.

   O job do Cloud Scheduler para a versão de integração correspondente é excluído.

Cloud Scheduler

Para excluir um job do Cloud Scheduler no Cloud Scheduler, siga as seguintes etapas:

1. No Console do Google Cloud, acesse o Cloud Scheduler.

   Acessar o Cloud Scheduler

2. Selecione o job do Cloud Scheduler a ser excluído.
3. Clique em Excluir.

   O job do Cloud Scheduler para a versão de integração correspondente é excluído.

Observação:

• Excluir um job do Cloud Scheduler no Cloud Scheduler não exclui o gatilho do Cloud Scheduler na sua integração da Apigee.
• O gatilho do Cloud Scheduler na sua integração gera um erro no painel de configuração do gatilho se um job do Cloud Scheduler for excluído usando o Cloud Scheduler. Consulte mais informações sobre as mensagens de erro do gatilho do Cloud Scheduler em Resolver problemas do gatilho do Cloud Scheduler.

Práticas recomendadas

Como prática recomendada, cancele a publicação de todos os gatilhos do Cloud Scheduler quando não forem mais necessários. Se você deixar um gatilho redundante do Cloud Scheduler publicado, o gatilho continuará invocando a integração automaticamente, o que pode gerar cobranças de faturamento adicionais.

Solução de problemas do gatilho do Cloud Scheduler

A tabela a seguir descreve os erros que você pode encontrar no gatilho do Cloud Scheduler e as causas correspondentes deles.

Local do erro	Ocorrência de erro	Mensagem de erro	Causas possíveis	Resolução
Painel de configuração do gatilho > Mensagem de erro	Quando o job do Cloud Scheduler interrompe a execução da integração	The configured Cloud Scheduler job CLOUD_SCHEDULER_JOB doesn’t exist. It might be deleted from your Google Cloud project.	O job do Cloud Scheduler é excluído usando o Cloud Scheduler.	Crie uma versão de integração para substituir o job do Cloud Scheduler.
		The configured Cloud Scheduler job CLOUD_SCHEDULER_JOB is PAUSED. You must RESUME the job from your Google Cloud project.	O job do Cloud Scheduler é pausado usando o Cloud Scheduler.	Retomar o job do Cloud Scheduler no Cloud Scheduler.
		The configured Cloud Scheduler job CLOUD_SCHEDULER_JOB is DISABLED due to an internal system error.	Verifique os registros do gatilho para identificar o problema.	Crie uma versão de integração para substituir o job do Cloud Scheduler.
		The configured Cloud Scheduler job CLOUD_SCHEDULER_JOB is in an UPDATE_FAILED state due to a failed CloudScheduler.UpdateJob operation.	A conta de serviço fornecida não tem as permissões necessárias do IAM.	Para recuperar um job desse estado, repita a operação CloudScheduler.UpdateJob até que uma resposta bem-sucedida seja recebida.
		The last execution of the Cloud Scheduler job CLOUD_SCHEDULER_JOB failed due to CLOUD_SCHEDULER_JOB_ISSUE. Learn more.	CLOUD_SCHEDULER_JOB_ISSUE	Não relevante