Ativar novas tentativas de funções orientadas a eventos
Neste documento, descrevemos como ativar a repetição de funções orientadas a eventos. A nova tentativa automática não está disponível para funções HTTP.
Semântica da nova tentativa
O Cloud Functions garante que uma função orientada a eventos seja executada pelo menos uma vez para cada evento emitido por uma fonte de eventos. Por padrão, se uma invocação de função terminar com um erro, a função não será chamada novamente e o evento será descartado. Quando você permite novas tentativas em uma função orientada a eventos, o Cloud Functions tenta invocar a função com falha novamente até que ela seja concluída com êxito ou a janela de novas tentativas expire.
Para as funções de 2ª geração, a janela de novas tentativas expira após 24 horas. Para funções de primeira geração, ela expira depois de sete dias. O Cloud Functions repete as funções orientadas a eventos recém-criadas usando uma estratégia de espera exponencial, com uma espera crescente entre 10 e 600 segundos. Essa política é aplicada a novas funções na primeira vez que você as implanta. Ela não é aplicada retroativamente às funções que foram implantadas primeiro, antes que as alterações descritas nesta nota de versão entrassem em vigor, mesmo que você reimplante as funções.
Quando novas tentativas não estão ativadas para uma função, que é o padrão, a função
sempre informa que foi executada com sucesso e os códigos de resposta 200 OK
podem
aparecer nos registros. Isso ocorre mesmo se a função encontrar um erro. Para
tornar claro quando sua função encontra um erro, informe erros
adequadamente.
Por que as funções orientadas a eventos não são concluídas?
Em raras ocasiões, uma função pode ser encerrada prematuramente devido a um erro interno e, por padrão, ela pode ser repetida automaticamente ou não.
Normalmente, uma função orientada a eventos pode não ser concluída com sucesso devido a erros gerados no próprio código da função. Os motivos para isso incluem o seguinte:
- A função contém um bug e o ambiente de execução gera uma exceção.
- A função não consegue acessar um endpoint de serviço ou expira durante a tentativa.
- A função gera uma exceção intencionalmente (por exemplo, quando há falha na validação de um parâmetro).
- Uma função Node.js retorna uma promessa rejeitada ou transmite um valor diferente de
null
para uma chamada de retorno.
Em qualquer um dos casos acima, a função para a execução por padrão e o evento é descartado. Para repetir a função em caso de erro, altere a política de nova tentativa padrão configurando a propriedade "Tentar novamente em caso de falha". Isso faz com que o evento seja repetido várias vezes até que a função seja concluída com êxito ou o tempo limite de nova tentativa expire.
Ativar ou desativar novas tentativas
Para ativar ou desativar novas tentativas, use a ferramenta de linha de comando gcloud
ou o console do Google Cloud. Por padrão, as novas tentativas estão desativadas.
Configurar novas tentativas na ferramenta de linha de comando gcloud
Para ativar novas tentativas através da ferramenta de linha de comando gcloud
, inclua a sinalização --retry
ao implantar sua função:
gcloud functions deploy FUNCTION_NAME --retry FLAGS...
Para desativar novas tentativas, reimplante a função sem a sinalização --retry
:
gcloud functions deploy FUNCTION_NAME FLAGS...
Configurar novas tentativas no console do Google Cloud
Se você estiver criando uma nova função, faça o seguinte:
- Na tela Criar função, selecione Adicionar gatilho e escolha o tipo de evento que atuará como um gatilho para a função.
- No painel Gatilho do Eventarc, marque a caixa de seleção Tentar novamente em caso de falha para ativar novas tentativas.
Se você estiver atualizando uma função atual, faça o seguinte:
- Na página Visão geral do Cloud Functions, clique no nome da função que você está atualizando a fim de abrir a tela Detalhes da função e escolha Editar na barra de menus para exibir os painéis de acionadores HTTPS e Eventarc.
- No painel Gatilho do Eventarc, clique no ícone de edição para editar as configurações do acionador.
- No painel Gatilho do Eventarc, marque ou desmarque a caixa de seleção Tentar novamente em caso de falha para ativar ou desativar novas tentativas.
Práticas recomendadas
Nesta seção, você verá as práticas recomendadas para o uso de novas tentativas.
Usar novas tentativas para lidar com erros transitórios
Como novas tentativas de executar a função são realizadas continuamente até a conclusão bem-sucedida, erros permanentes, como bugs, devem ser eliminados do código por meio de teste detalhado antes de ativá-las. As tentativas funcionam melhor para lidar com falhas intermitentes ou transitórias que têm alta probabilidade de serem solucionadas ao tentar novamente, como um endpoint de serviço ou tempo limite lentos.
Definir uma condição final para evitar loops infinitos de tentativas
A prática recomendada ao usar tentativas é proteger a função contra loop contínuo. Para isso, inclua uma condição final bem definida antes de a função iniciar o processamento. Essa técnica só funciona se sua função for iniciada com sucesso e puder avaliar a condição final.
Uma abordagem simples e eficaz é descartar eventos com carimbos de data/hora anteriores a um determinado momento. Isso ajuda a evitar o excesso de execuções quando as falhas são persistentes ou mais duradouras do que o esperado.
Por exemplo, este snippet de código descarta todos os eventos ocorridos há mais de 10 segundos:
Node.js
Python
Go
Java
C#
Ruby
PHP
Distinguir entre erros que podem ser tentados novamente e fatais
Se a função tiver novas tentativas ativadas, qualquer erro não processado acionará uma nova tentativa. Verifique se o código captura todos os erros que não precisam resultar em uma nova tentativa.
Node.js
Python
Go
Java
C#
Ruby
PHP
Tornar idempotentes as funções baseadas em eventos repetíveis
As funções orientadas a eventos que podem ser repetidas precisam ser idempotentes. Veja abaixo algumas diretrizes gerais para tornar essa função idempotente:
- Muitas APIs externas, como a Stripe, permitem que você forneça uma chave de idempotência como um parâmetro. Se estiver usando uma API como essa, utilize o código do evento como chave de idempotência.
- A idempotência funciona bem com a entrega do tipo "pelo menos uma vez" porque torna mais seguro tentar novamente. Dessa forma, para escrever um código confiável, a prática recomendada é combinar idempotência com tentativas.
- Verifique se o código é idempotente internamente. Por exemplo:
- Garanta que mutações possam ocorrer mais de uma vez sem alterar o resultado.
- Consulte o estado do banco de dados em uma transação antes de alterar o estado.
- Certifique-se de que todos os efeitos colaterais sejam idempotentes.
- Execute uma verificação transacional fora da função, independente do código. Por exemplo, mantenha a persistência de estado em algum local e registre que um determinado código de evento já foi processado.
- Lide com chamadas de função duplicadas fora de banda. Por exemplo, tenha um processo de limpeza que seja executado após chamadas de função duplicadas.
Configurar a política de repetição
Dependendo das necessidades da função do Cloud, é possível configurar a política de repetição diretamente. Isso permite que você configure qualquer combinação dos itens a seguir:
- reduzir a janela de novas tentativas de 7 dias para 10 minutos.
- alterar os tempos mínimo e máximo de espera da estratégia de nova tentativa com espera exponencial.
- alterar a estratégia de nova tentativa para tentar de novo imediatamente.
- configurar um tópico de mensagens inativas.
- definir um número máximo e mínimo de tentativas de entrega.
Para configurar a política de repetição:
- Escreva uma função HTTP.
- Use a API Pub/Sub para criar uma assinatura do Pub/Sub, especificando o URL da função como destino.
Consulte a documentação do Pub/Sub sobre como lidar com falhas para mais informações sobre como configurar o Pub/Sub diretamente.
Próximas etapas
- Como implantar o Cloud Functions.
- Como chamar funções de acionamento do Cloud Pub/Sub.
- Como chamar funções de acionamento do Cloud Storage.
- Tutorial do Cloud Functions com o Cloud Pub/Sub.
- Tutorial do Cloud Functions com o Cloud Storage.