Referência do Sistema de Alertas

Este documento fornece informação completa sobre o sistema de alertas do Dashboard.PT. Aprende a configurar, gerir e personalizar alertas para os teus gráficos e dashboards.

Visão Geral dos Alertas

O sistema de alertas do Dashboard.PT permite-te monitorizar os teus dados e receber notificações quando determinadas condições forem cumpridas. Assim manténs-te informado sobre mudanças importantes ou limites nos teus dados sem teres de estar constantemente a consultar os teus dashboards.

Principais Funcionalidades:

  • Configurar alertas com base em vários tipos de condição
  • Receber notificações por email, SMS ou webhook
  • Definir períodos de espera para evitar excesso de notificações
  • Ver o histórico de alertas e os eventos despoletados
  • Personalizar o conteúdo e o formato das notificações

Tipos de Alerta e Condições

O Dashboard.PT suporta vários tipos de condições de alerta para responder a diferentes necessidades de monitorização.

Tipo de Condição Descrição Caso de Uso
Acima Despoleta quando os dados ultrapassam um valor especificado Limites de utilização de recursos, metas de desempenho
Abaixo Despoleta quando os dados descem abaixo de um valor especificado Níveis mínimos de serviço, níveis de stock
Igual Despoleta quando os dados coincidem com um valor específico Monitorização de estados específicos, deteção de eventos
Entre Despoleta quando os dados estão fora de um intervalo aceitável Controlo de qualidade, parâmetros de funcionamento
Variação Percentual Despoleta quando os dados variam numa determinada percentagem Picos ou quedas súbitas, mudanças de tendência

Períodos das Condições

Para certos tipos de condição, podes especificar um período de tempo para analisar os dados. Isto permite-te detetar tendências ou condições sustentadas, em vez de reagires a picos momentâneos.

Exemplos:

  • "Acima de 90% durante 5 pontos de dados consecutivos"
  • "Abaixo de 50 unidades durante mais de 30 minutos"
  • "Variou mais de 20% no espaço de 1 hora"

Métodos de Notificação

O Dashboard.PT oferece vários canais de notificação para garantir que recebes os alertas da forma mais conveniente.

Notificações por Email

Recebe notificações de alerta detalhadas no teu endereço de email. Inclui pré-visualizações dos gráficos e ligações de ação.

Notificações por SMS

Recebe mensagens de texto concisas para alertas críticos. Disponível nos planos STANDARD e superiores.

Integração por Webhook

Envia os dados dos alertas para os teus próprios sistemas ou para serviços de terceiros como o Slack, o Teams ou aplicações personalizadas.

Limites de Notificação

Os métodos de notificação podem estar limitados consoante o teu plano de subscrição. Consulta a página de Preços para mais detalhes.

Criar Alertas

Podes criar alertas a partir de qualquer gráfico do teu dashboard. Segue estes passos para configurar um novo alerta:

  1. Vai até ao Gráfico: Abre o dashboard que contém o gráfico que queres monitorizar.

  2. Acede às Definições de Alerta: Clica no menu de três pontos no canto superior direito do gráfico e seleciona "Criar Alerta".

  3. Configura as Condições do Alerta: Define a condição que vai despoletar o alerta.

    {
      "name": "High CPU Usage Alert",
      "condition_type": "above",
      "condition_value": 90,
      "condition_timeframe": 5, // Optional: number of data points
      "notify_email": true,
      "notify_sms": false,
      "notify_webhook": false
    }
  4. Define as Preferências de Notificação: Escolhe como queres ser notificado quando o alerta for despoletado.

  5. Configura Opções Avançadas (Opcional): Define períodos de espera, mensagens personalizadas ou outras opções.

  6. Guarda o Alerta: Clica em "Criar Alerta" para ativar a monitorização.

API de Alertas

A API de Alertas permite-te gerir as tuas configurações de alerta de forma programática.

Endpoint Method Descrição
/api/alerts GET Listar todos os alertas
/api/alerts POST Criar um novo alerta
/api/alerts/{id} GET Obter um alerta específico
/api/alerts/{id} PUT Atualizar um alerta
/api/alerts/{id} DELETE Eliminar um alerta
/api/alerts/history GET Obter o histórico de disparo de alertas

Criar Alerta

Exemplo de corpo do pedido:

{
  "graph_id": 123,
  "name": "Server CPU Alert",
  "condition_type": "above",
  "condition_value": 90,
  "condition_timeframe": 5,
  "notify_email": true,
  "notify_sms": false,
  "notify_webhook": true,
  "webhook_url": "https://example.com/webhook",
  "cooldown_minutes": 30
}

Integração por Webhook

As notificações por webhook permitem-te integrar os alertas com os teus próprios sistemas ou com serviços de terceiros.

Payload do Webhook

Quando um alerta é despoletado, o Dashboard.PT envia um pedido POST para o URL do teu webhook com um payload JSON:

{
  "alert_id": 456,
  "alert_name": "Server CPU Alert",
  "graph_id": 123,
  "graph_name": "Server CPU Usage",
  "dashboard_id": 789,
  "dashboard_name": "Server Monitoring",
  "condition_type": "above",
  "condition_value": 90,
  "triggered_value": 95.2,
  "triggered_at": "2023-09-15T14:22:30Z",
  "graph_url": "https://dashboard.pt/view-graph.php?id=123"
}

Exemplos de Integração

Os webhooks do Dashboard.PT podem ser facilmente integrados com serviços populares:

  • Slack através de Incoming Webhooks
  • Microsoft Teams através de Connectors
  • Discord através de Webhook URLs
  • Aplicações personalizadas ou sistemas de monitorização

Histórico de Alertas

O Dashboard.PT mantém um histórico de todos os alertas despoletados, permitindo-te rever incidentes passados e acompanhar padrões.

Consultar o Histórico de Alertas

Podes aceder ao histórico de alertas a partir da secção Alertas do teu dashboard. O histórico inclui:

  • Quando cada alerta foi despoletado
  • O valor dos dados que despoletou o alerta
  • Que métodos de notificação foram utilizados
  • Se as notificações foram entregues com sucesso

O histórico de alertas é conservado de acordo com a política de retenção de dados do teu plano de subscrição.

Boas Práticas

Segue estas recomendações para tirares o máximo partido do sistema de alertas do Dashboard.PT:

Define Limites Adequados

Configura limites que equilibrem a deteção de eventos importantes com a prevenção da fadiga de alertas. Tem em conta as variações normais dos teus dados ao definir os limites.

Usa os Períodos com Critério

Para métricas voláteis, usa períodos de tempo para garantir que os alertas só são despoletados quando as condições persistem, e não apenas em picos ou quedas momentâneas.

Define Períodos de Espera Adequados

Configura períodos de espera para evitar o excesso de notificações durante incidentes em curso. Diferentes tipos de alerta podem precisar de configurações de espera diferentes.

Prioriza os Métodos de Notificação

Usa o email para alertas de rotina, reserva o SMS para questões críticas e aproveita os webhooks para respostas automatizadas ou notificações à equipa.

Quer experimentar? O plano gratuito não tem limite de tempo.

Criar conta gratuita