KEPLIN Docs

Alertas por email

Ligar os avisos, escolher os destinatários, e afinar os limiares a partir dos quais a plataforma avisa que alguma coisa correu mal.

O Radar conta o que se passa a quem abrir o ecrã. Os alertas fazem o contrário: avisam sem ninguém ter de olhar. É a diferença entre saber que uma app esteve em baixo e saber que está.

Configuram-se todos no mesmo sítio — Definições, na barra lateral, na zona de administração — e valem para toda a plataforma, não por app.

Nota

Estas definições são de quem administra a instalação. Com perfil de developer, o menu Definições não aparece.

Ligar os avisos

  1. Abre Definições na barra lateral.
  2. No painel Trabalho de fundo — "O que corre sozinho enquanto ninguém está a olhar. Desligar não apaga nada — só pára." — encontra a linha Avisos por email.
  3. Liga o interruptor. A ajuda ao lado diz o que está em jogo: "Avisa quando algo passa dos limites em baixo. Sem isto, só sabes quando abrires o ecrã."
  4. Desce até ao fim da página e clica em Gravar. A confirmação diz "Definições guardadas."

O painel Trabalho de fundo, com o interruptor Avisos por email
O painel Trabalho de fundo, com o interruptor Avisos por email

No mesmo painel estão outros três interruptores que valem a pena conhecer, porque metade dos "alertas que não chegam" vem de um deles estar desligado:

Interruptor O que faz
Agendador Corre os agendamentos, os relatórios agendados e os temporizadores dos workflows.
Índice de observabilidade Leva o que as apps registam para o índice central e aplica os prazos de retenção de cada app. Desligado, os ecrãs mostram dados velhos.
Notificações em tempo real Servidor de tempo real das notificações. Sem ele, as notificações entregam-se na próxima visita.

Para onde vão os avisos

O painel Email dos avisos — "O servidor por onde saem os avisos da plataforma. É distinto do email de cada app." — tem o servidor de saída e os destinatários.

O painel Email dos avisos, com o servidor de saída e os destinatários
O painel Email dos avisos, com o servidor de saída e os destinatários

Campo O que é
Servidor O endereço do servidor de email de saída.
Porta A porta dele.
TLS implícito "Ligado normalmente na porta 465. Nas outras, a ligação é elevada depois de abrir."
Utilizador A conta de autenticação no servidor.
Palavra-passe "Fica cifrada e nunca volta a este ecrã. Deixar em branco mantém a que lá está."
Remetente O endereço de quem envia. É obrigatório.
Destinatários Quem recebe.

O campo Destinatários tem uma nota que resolve um problema de manutenção: "Separados por vírgula. Em branco, avisa os administradores activos — uma lista que se mantém sozinha."

Dica

Deixa os Destinatários em branco. A lista de administradores activos actualiza-se sozinha quando alguém entra ou sai da equipa; uma lista escrita à mão fica desactualizada no dia em que alguém muda de emprego — e ninguém se lembra dela.

O estado da palavra-passe aparece por baixo do campo: Definida — escreve para trocar ou Por definir.

A partir de quando avisar

O painel A partir de quando avisar — "Os valores em baixo são os de origem." — tem os limiares. Um alerta dispara quando um destes valores for ultrapassado dentro da janela de tempo.

O painel A partir de quando avisar, com os limiares e a janela
O painel A partir de quando avisar, com os limiares e a janela

Limiar O que mede Nota
Erros de API (%) "Percentagem de chamadas falhadas, por app." Conta-se app a app, não na soma de todas.
Pedidos mínimos Quantas chamadas são precisas para a percentagem contar "Abaixo disto a percentagem não diz nada: 1 erro em 3 são 33%."
Scripts falhados Quantas execuções de scripts podem falhar antes de avisar
Atraso da fila (s) Quanto pode a fila do índice atrasar-se "Enquanto a fila estiver atrasada, os ecrãs mostram dados velhos."
Disco livre (%) Abaixo de que percentagem de disco livre se avisa
Janela (min) O período em que tudo isto é contado "Período em que os números acima são contados."

Os Pedidos mínimos são o campo mais importante e o mais esquecido. Sem ele, uma app com pouco tráfego dispara alertas o dia todo: três chamadas, uma falhada, 33% de erro. Com ele, a percentagem só conta quando há chamadas que cheguem para ela significar alguma coisa.

Como escolher os valores

Não há números universais, mas há um método que funciona:

  1. Deixa a plataforma correr uma semana com os valores de origem.
  2. Abre ObservabilidadeVisão geral com o período em 7d e olha para a Taxa de erro e a Resposta (p95) reais.
  3. Põe o limiar de Erros de API (%) um pouco acima do que é normal nessa instalação — o objectivo é apanhar o anormal, não confirmar o normal.
  4. Ajusta os Pedidos mínimos ao tráfego da app mais calma.

Atenção

Um limiar demasiado apertado é pior do que nenhum. Alertas que disparam todos os dias deixam de ser lidos ao fim de uma semana — e o dia em que o importante chegar, vai chegar ao meio dos outros.

Confirmar que os alertas estão mesmo a funcionar

A secção Estado da Observabilidade tem, no topo, uma frase que diz a verdade sobre os alertas nesta instalação. É o sítio para confirmar depois de mexer nas definições.

O aviso do estado dos alertas, no topo da secção Estado da Observabilidade
O aviso do estado dos alertas, no topo da secção Estado da Observabilidade

São três frases possíveis:

O que lá está O que significa
"Alertas ligados: avisa os administradores acima de 5% de erros, a partir de 20 pedidos." Tudo a funcionar — e com os teus limiares à vista.
"Os alertas estão desligados. Ninguém é avisado quando algo corre mal — esta página só conta o que se passa a quem a abrir." Falta ligar Avisos por email.
"Alertas ligados, mas sem envio de email: … Os alarmes são registados e ninguém é avisado." O aviso dispara, mas não sai — falta configurar o servidor de email.

A terceira é a mais traiçoeira, porque tudo parece configurado. Se a vires, volta ao painel Email dos avisos e completa o que falta.

Sessões e limites

Ainda nas Definições, o painel Sessões e limites — "Valem para toda a plataforma." — tem dois valores que não são alertas mas costumam ser procurados ao mesmo tempo:

  • Duração da sessão (h) — "Uma sessão activa renova-se sozinha; isto é o tempo de inactividade que a expira."
  • Ficheiro máximo (MB) — o tamanho máximo de um ficheiro carregado.

Porque não vejo…?

  • …alertas a chegar, com tudo ligado? Confirma o painel Estado: se disser "sem envio de email", falta o servidor de saída. Se disser "desligados", falta gravar.
  • …o painel Trabalho de fundo? Estás nas definições de uma app, não nas da plataforma. As da plataforma abrem-se pelo menu Definições da barra lateral.
  • …os meus limiares a valer? Sem Gravar no fim da página, nada é guardado. A confirmação é "Definições guardadas."
  • …alertas por app? Não existem: os limiares são da plataforma. O que é por app é a rotação de registos, nas definições de cada uma.