Boas práticas para alertas

Aprenda boas práticas para utilizar alertas na Digibee Integration Platform.

Neste documento, você aprenderá algumas boas práticas que ajudam a organizar, identificar e entender melhor os seus alertas na Digibee Integration Platform.

Nomeie seus alertas corretamente

A lista de alertas exibe informações como o nome do alerta, o pipeline e o status. No entanto, quando os alertas são recebidos, apenas o nome é exibido. Para identificar o tipo de alerta com mais agilidade, inclua as seguintes informações no nome do alerta:

• Nome do realm

• Nome do pipeline (escrito como uma única palavra)

• Tipo de métrica (somente as iniciais, por exemplo, “MNF” para “Mensagem Na Fila”)

• Ambiente do pipeline (test ou prod)

• Versão do pipeline

• Severidade do alerta (low, medium ou high)

Separe cada item do nome usando apenas hífens ( - ). Nenhum outro caractere é permitido.

Exemplo

Veja abaixo como deve ser a estrutura:

Estrutura: realm-pipeline-metric-ambiente-versão-severidade

Nome do alerta: digibee-projectxyz-MIQ-prod-v1-medium

Estabeleça limites (threshold) realistas

Ao configurar alertas, é essencial escolher limites (thresholds) realistas para evitar excesso de notificações que dificultam a identificação de alertas realmente importantes. Um limite muito baixo, por exemplo, pode gerar alertas constantes, mesmo quando o pipeline está se comportando como esperado.

• Use seus dados como base: Analise o comportamento recente da métrica antes de definir um threshold. Por exemplo, se a métrica normalmente varia entre 8 e 12 segundos, configurar um alerta para 9 segundos provavelmente vai gerar notificações frequentes sem indicar um problema real.

• Considere variações naturais: Pipelines frequentemente apresentam flutuações normais de desempenho. Certifique-se de que os alertas sejam acionados apenas quando houver uma variação significativa.

• Evite threholds muito rigorosos: Valores muito próximos da média do tempo de execução tendem a gerar alertas contínuos. Escolha limites que reflitam situações excepcionais.

• Revise os limites regularmente: Conforme a carga de trabalho, infraestrutura ou comportamento das integrações muda, os limites podem precisar ser ajustados.

Use mensagens de alerta para obter informações rapidamente

Uma boa mensagem de alerta ajuda você a identificar rapidamente o que está acontecendo, onde está o problema e quais critérios foram violados sem a necessidade de investigações adicionais. Mensagens vagas podem atrasar o diagnóstico e aumentar o tempo de resposta a incidentes, exigindo acesso a logs ou dashboards para descobrir o que realmente aconteceu.