Monitorando webhooks
Quando os webhooks são configurados, eles muitas vezes compõem uma parte central dos fluxos de usuários. As falhas do Webhook não são significativas para um usuário, por isso as falhas do webhook são registradas, mas não são retornadas ao usuário quando elas ocorrem. Para visualizar falhas do webhook, as APIs webhooks stats devem ser recuperadas.
As APIs webhook stats possibilitam obter uma análise detalhada do uso de um webhooks. A usabilidade dessas estatísticas é ampla.
O monitoramento das estatísticas pode ajudar com as seguintes tarefas.
- Detectando e corrigindo falhas em URLs específicas.
- Monitorando a latência entre o Verify e os terminais de webhook configurados
Quando falhas são detectadas, o ID de solicitação de webhook da falha é registrado junto com o erro gerado pelo mecanismo de webhooks. Essa mensagem de erro, juntamente com o ID da solicitação, deve ser usada para correlacionar os logs de solicitação no sistema externo para fazer a triagem e resolver a falha.
Observação: as estatísticas são atualizadas periodicamente e podem mudar a cada cinco segundos.
Funcionamento em um piscar de olhos
Também existe uma API health, que usa os detalhes das estatísticas para oferecer uma visão simplificada do funcionamento do webhook.
Esta API retorna um dos valores a seguir.
no-data- Nenhuma informação estatística está disponível para este webhook. Nunca foi usado ou não foi usado nos últimos sete dias.
down- Todas as URLs configuradas deste webhook que anteriormente conectadas com sucesso agora têm um erro.
recovered- Pelo menos uma URL que teve uma falha de conexão, agora se conecta com sucesso.
marginal- Uma URL está funcionando consistentemente, outras URLS estão falhando.
good- Não existe nenhum erro.