> For the complete documentation index, see [llms.txt](https://wiki.datadike.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.datadike.com/pt/sonar/administration/automation/alerts.md).

# Alertas e modelos de alerta

Trate os alertas de dispositivos em atraso, checks e tarefas com falha, e configure modelos de alerta: canais, severidades, reenvios, ações, exclusões e onde os modelos se aplicam.

## O que é e quando usar

O SONAR gera um alerta em três situações:

| Tipo             | Gerado quando                                                                                  | Severidade                                                                                           |
| ---------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| **Availability** | Um dispositivo não se comunica com o SONAR há mais tempo que o seu **Overdue after (minutes)** | **Error**                                                                                            |
| **Check**        | Um check falha pelo seu **Number of consecutive failures before alert**                        | Vem do check (veja [Checks](https://wiki.datadike.com/pt/sonar/administration/automation/checks.md)) |
| **Task**         | Uma tarefa automatizada termina com um código de retorno diferente de zero                     | A **Alert Severity** da tarefa                                                                       |

Cada alerta pode aparecer no painel, ser enviado por e-mail e por SMS, e pode iniciar uma ação (um script no dispositivo ou um webhook). Um **modelo de alerta** decide quem é notificado, para quais severidades, com que frequência e qual ação é executada; ele é atribuído globalmente, a um cliente, a um site ou a uma política de automação.

Use esta página para acompanhar os alertas no dia a dia e para desenhar os modelos que os encaminham.

## Antes de começar

* Um papel com **List Alerts** para ver os alertas e **Manage Alerts** para resolvê-los e adiá-los; **List Alert Templates** e **Manage Alert Templates** para os modelos. Essas permissões ficam no grupo **Alerts** de **Admin Center › Roles**.
* Para e-mail, o servidor de e-mail definido em **Admin Center › Settings › Mail Server**; para SMS, a aba **SMS**. Veja [Notificações por e-mail e SMS](https://wiki.datadike.com/pt/sonar/administration/settings/email-and-sms.md).
* Para ações de webhook, o webhook criado em **Admin Center › Settings › Web Hooks**. Veja [Webhooks](https://wiki.datadike.com/pt/sonar/administration/settings/webhooks.md).
* Para ações de script, o script em **Management › Scripts**.

## Como os canais são definidos

Para cada alerta, o SONAR combina três camadas:

1. **As configurações do próprio item.** Um dispositivo tem **Get overdue email alerts**, **Get overdue sms alerts** e **Get overdue dashboard alerts** em **Edit › General**. Checks e tarefas têm as colunas **SMS Alert**, **Email Alert** e **Dashboard Alert** nas abas **CHECKS** e **TASKS** do dispositivo.
2. **O modelo de alerta que se aplica ao dispositivo.** As chaves **Email**, **Text** e **Dashboard** dele têm três posições: ligada (sempre notificar, sobrepondo-se ao item), no meio (**Not configured**: usar a configuração do item) e desligada (nunca notificar, sobrepondo-se ao item). Quando um modelo se sobrepõe a um check ou a uma tarefa, a coluna mostra `Setting is overridden by alert template: <name>`. Para checks e tarefas, o modelo também filtra por severidade (**Only email on alert severity**, **Only text on alert severity**, **Only show dashboard alert on severity**).
3. **A chave global de severidade.** Em **Admin Center › Settings › General**, **Receive notifications on:** **Informational Alerts** e **Warning Alerts** decidem se os alertas dessas severidades chegam a ser enviados por e-mail, por SMS ou a um webhook. Os alertas de erro são sempre elegíveis.

O e-mail e o SMS vão para os **Email recipients** e os **SMS recipients** do modelo quando eles estão definidos; caso contrário, para os destinatários globais das abas **Mail Server** e **SMS**.

Um dispositivo em modo de manutenção (**Enable Maintenance Mode** no menu de ações dele) não gera novos alertas. Use-o para trabalhos planejados.

## Passos

### Acompanhar os alertas

1. Clique no sino do cabeçalho. **NOTIFICATIONS** mostra quantos alertas estão abertos e alguns deles, cada um com **Snooze alert** e **Resolve alert**. O sino se atualiza mais ou menos a cada minuto.
2. Clique em **VIEW ALL** para abrir a visão geral **Alerts**.
3. Filtre por **Clients**, **Severity** e **Time** (de **1 Day Ago** a **1 Year Ago**, ou **Everything**), marque **Include snoozed** ou **Include resolved** se necessário e clique em **Search**. A visão geral abre com os alertas abertos dos últimos 30 dias.
4. Trate um alerta com os botões da coluna **Actions** dele, ou marque vários e use **Snooze selected** ou **Resolve selected**. **Resolve all** resolve todos os alertas não resolvidos carregados pela busca atual.

| Ação                                                                       | O que faz                                                                                                                                                              |
| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Resolve alert**                                                          | Fecha o alerta. Se o problema continuar, a próxima falha gera um novo alerta. Uma resolução manual não envia notificações de resolução nem executa a ação de resolução |
| **Snooze alert**                                                           | Pergunta `How many days to snooze alert?` e oculta o alerta do sino e da visão geral (a menos que **Include snoozed** esteja marcado) por esse número de dias          |
| **Unsnooze alert**                                                         | Volta a listar um alerta adiado imediatamente                                                                                                                          |
| **Show failure action run results** / **Show resolved action run results** | Mostra o resultado da ação executada pelo modelo: última execução, tempo de execução, código de retorno e saída                                                        |

Os alertas também se fecham sozinhos: quando o check volta a passar, quando a tarefa tem sucesso na execução seguinte ou quando um dispositivo em atraso volta a se comunicar. Redefinir um check (**Reset Check Status**) também resolve o alerta dele.

### Criar um modelo de alerta

1. Clique em **Alerts** no cabeçalho. O painel **Alert Templates** se abre.
2. Clique em **New**. **Add Alert Template** abre em **General Settings**.
3. Preencha **Name** e deixe **Enabled** ligado. Se quiser, defina **Email From address** e adicione destinatários com **Add email** e **Add sms number** (números de SMS no formato E.164, por exemplo `+15555550100`).
4. Clique em **Next**. Em **Alert Actions**, escolha a ação a executar quando um alerta é gerado (**Alert Failure Settings**) e quando ele se resolve (**Alert Resolved Settings**), ou deixe o script vazio para não ter ação. Em **Run actions only on**, mantenha ligados apenas os tipos de alerta a que a ação se destina: **Agents**, **Checks**, **Tasks**.
5. Clique em **Next**. Em **Agent Overdue Settings**, defina as chaves **Email**, **Text** e **Dashboard** para os dispositivos em atraso, **Alert again if not resolved after (days)**, e se deve enviar **Email** ou **Text** quando o dispositivo voltar a ficar online.
6. Clique em **Next**. Em **Check Settings**, defina as mesmas chaves para os checks com falha, os filtros de severidade, o intervalo de reenvio e as notificações de resolução.
7. Clique em **Next**. Em **Automated Task Settings**, faça o mesmo para as tarefas com falha.
8. Clique em **Submit**. A confirmação diz `Alert Template created!`

{% hint style="info" %}
Uma ação de script é executada no dispositivo por meio do agente dele, por isso serve para os alertas de check e de tarefa. Um dispositivo em atraso, por definição, não pode ser alcançado: para os alertas de atraso, use um webhook e mantenha **Agents** desligado em **Run actions only on** quando a ação de falha for um script.
{% endhint %}

### Atribuir o modelo

Um modelo não faz nada até ser atribuído:

* **Globalmente**: **Admin Center › Settings › General**, seção **Defaults**, campo **Alert Template**.
* **A um cliente ou a um site**: na lista **CLIENTS** da barra lateral, clique com o botão direito no cliente ou no site e escolha **Assign Alert Template**; depois, escolha o modelo em **Client Alert Template** ou **Site Alert Template** e clique em **Submit**.
* **A uma política de automação**: em **Management › Automations**, clique em **Assign Alert Template** (ou **Modify Alert Template**) na linha da política.

Um dispositivo usa um único modelo: o primeiro encontrado nesta ordem.

1. O modelo da política do próprio dispositivo
2. O modelo da política do site
3. O modelo do site
4. O modelo da política do cliente
5. O modelo do cliente
6. O modelo global
7. O modelo da política padrão

Os modelos desativados e os modelos que deixam o dispositivo de fora são ignorados.

### Definir exclusões de clientes, sites, dispositivos ou tipos de dispositivo

1. No painel **Alert Templates**, clique em **Exclusions (N)** no modelo, ou clique nele com o botão direito e escolha **Alert Exclusions**.
2. Preencha **Excluded Clients**, **Excluded Sites** e **Excluded Agents**, ou marque **Exclude Workstations** ou **Exclude Servers**.
3. Clique em **Save**. Um dispositivo deixado de fora passa para o modelo seguinte na ordem acima.

### Ativar, desativar, editar ou excluir um modelo

Use a chave no início da linha para ativá-lo ou desativá-lo. Clique duas vezes no modelo, ou clique nele com o botão direito, para usar **Edit** ou **Delete**. **Applied (N)** lista as políticas, os clientes e os sites que o usam.

## O que você deve ver

O painel **Alert Templates** lista cada modelo com a sua chave, marcas em **Agent alert settings**, **Check alert settings** e **Task alert settings** quando essas etapas estão configuradas, o nome, um selo **Default** para o modelo global, **Applied (N)**, **Exclusions (N)** e os nomes das ações dele.

A visão geral **Alerts** mostra **Time**, **Client**, **Site**, **Agent**, **Type**, **Severity**, **Message** e **Actions**, além de **Resolved On** quando os alertas resolvidos estão incluídos. As mensagens dizem, por exemplo, `WS-0001 in CLIENT-A, SITE-01 is overdue.`, `WS-0001 has a diskspace check: <description> that failed.` ou `WS-0001 has task: <name> that failed.`

## Como verificar se funcionou

1. Abra um dispositivo coberto pelo modelo e escolha **Edit** no menu de ações dele. A aba **Automation Policies** mostra o **Alert Template** efetivo.
2. Faça um check falhar de propósito (veja [Checks](https://wiki.datadike.com/pt/sonar/administration/automation/checks.md), "Como verificar se funcionou"). Depois do número configurado de falhas, o alerta aparece no sino e na visão geral se o canal do painel se aplicar, e o e-mail ou o SMS chega se esses canais se aplicarem.
3. Se o modelo tiver uma ação de falha, abra o alerta na visão geral e use **Show failure action run results**. Para uma ação de script, a aba **HISTORY** do dispositivo também mostra a execução.
4. Corrija a causa e execute os checks de novo. O alerta se fecha, as notificações de resolução são enviadas se estiverem ativadas e **Show resolved action run results** aparece quando uma ação de resolução foi executada.
5. Em **Reports & Audits › Audits**, a criação e a alteração de um modelo são registradas como **Add Object** e **Modify Object**.

## Erros comuns

| Sintoma                                                                      | Causa                                                                                                                                                      | Correção                                                                                        |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `Name needs to be set`                                                       | O modelo não tem nome                                                                                                                                      | Preencha **Name** em **General Settings**                                                       |
| `Failure script timeout is required` / `Resolved script timeout is required` | Uma ação de script sem tempo limite                                                                                                                        | Informe o tempo limite em segundos                                                              |
| `Periodic days must be 0 or greater`                                         | Intervalo de reenvio negativo                                                                                                                              | Informe 0 (sem reenvio) ou mais                                                                 |
| Nenhum e-mail para alertas de aviso ou informativos                          | **Receive notifications on:** não inclui essa severidade, ou o **Only email on alert severity** do modelo a deixa de fora                                  | Marque a severidade em **Admin Center › Settings › General**, ou adicione-a ao filtro do modelo |
| Nenhum e-mail chega                                                          | O dispositivo, o check ou a tarefa não tem o canal de e-mail e o **Email** do modelo está em **Not configured**, ou o servidor de e-mail não está definido | Ative o canal no item ou ligue **Email** no modelo; teste o servidor de e-mail                  |
| O modelo não tem efeito em um dispositivo                                    | Ele está desativado, não está atribuído onde o dispositivo o herda, o dispositivo foi deixado de fora, ou um modelo anterior na ordem se aplica            | Confira **Edit › Automation Policies › Alert Template** no dispositivo                          |
| **Snooze selected** e **Resolve selected** estão desativados                 | Nenhum alerta está marcado, ou **Include resolved** está ligado                                                                                            | Marque alertas e desmarque **Include resolved**                                                 |
| Um alerta volta depois de **Resolve alert**                                  | O check ou a tarefa continua falhando                                                                                                                      | Corrija a causa, ou redefina o check depois de corrigi-la                                       |
| Nenhum alerta para um dispositivo                                            | Ele está em modo de manutenção                                                                                                                             | Use **Disable Maintenance Mode** no menu de ações dele                                          |

## Referência de campos

### General Settings

| Campo              | O que faz                                                                  | Padrão |
| ------------------ | -------------------------------------------------------------------------- | ------ |
| Name               | Identifica o modelo. Obrigatório                                           | Vazio  |
| Enabled            | O modelo tem efeito onde for atribuído                                     | Ligado |
| Email From address | Endereço do remetente dos e-mails deste modelo, em vez do global           | Vazio  |
| Email recipients   | Substituem os destinatários de e-mail globais para os alertas deste modelo | Nenhum |
| SMS recipients     | Substituem os destinatários de SMS globais. Formato E.164                  | Nenhum |

### Alert Actions

| Campo                                                                | O que faz                                                                                                                                               | Padrão                  |
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| Action type (failure and resolved)                                   | **Run script on Agent** executa um script da biblioteca no dispositivo. **Send a Web Hook** chama um webhook de **Admin Center › Settings › Web Hooks** | **Run script on Agent** |
| Failure script / Resolved Script                                     | Script executado quando o alerta é gerado / resolvido. É executado uma vez por alerta                                                                   | Nenhum                  |
| Failure script arguments / Resolved script arguments                 | Argumentos do script. Aceitam [variáveis de script](https://wiki.datadike.com/pt/sonar/reference/script-variables.md), inclusive valores do alerta      | Os padrões do script    |
| Failure script environment vars / Resolved action environment vars   | Variáveis de ambiente, no formato `KEY=VALUE`                                                                                                           | Os padrões do script    |
| Failure script timeout (seconds) / Resolved script timeout (seconds) | Tempo máximo de execução                                                                                                                                | O padrão do script      |
| Failure Web Hook                                                     | Webhook chamado quando o alerta é gerado                                                                                                                | Nenhum                  |
| Resolved Web Hook                                                    | Webhook chamado quando o alerta se resolve sozinho. Use-o junto com um **Failure Web Hook**                                                             | Nenhum                  |
| Run actions only on                                                  | Tipos de alerta que executam as ações: **Agents** (dispositivos em atraso), **Checks**, **Tasks**                                                       | Todos ligados           |

### Agent Overdue Settings, Check Settings, Automated Task Settings

| Campo                                             | O que faz                                                                                                                                                 | Padrão                               |
| ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| Email / Text / Dashboard (Alert Failure Settings) | Ligado: sempre notificar neste canal. No meio (**Not configured**): usar a configuração do dispositivo, do check ou da tarefa. Desligado: nunca notificar | **Not configured**                   |
| Only email on alert severity                      | Checks e tarefas. Severidades enviadas por e-mail                                                                                                         | **Error** e **Warning** quando vazio |
| Only text on alert severity                       | Checks e tarefas. Severidades enviadas por SMS                                                                                                            | **Error** e **Warning** quando vazio |
| Only show dashboard alert on severity             | Checks e tarefas. Severidades exibidas no painel                                                                                                          | As três quando vazio                 |
| Alert again if not resolved after (days)          | Reenvia o e-mail e o SMS enquanto o alerta continuar aberto. 0 envia uma vez                                                                              | 0                                    |
| Email / Text (Alert Resolved Settings)            | Envia uma notificação quando o alerta se resolve sozinho                                                                                                  | Desligado                            |

### Alert Exclusions

| Campo                                               | O que faz                                          |
| --------------------------------------------------- | -------------------------------------------------- |
| Excluded Clients / Excluded Sites / Excluded Agents | O modelo não se aplica a esses dispositivos        |
| Exclude Workstations / Exclude Servers              | O modelo não se aplica aos dispositivos desse tipo |

### Configurações de atraso do dispositivo (Edit › General)

| Campo                                                                            | O que faz                                                                                                               |
| -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| Offline after (minutes)                                                          | Tempo sem contato depois do qual o dispositivo aparece como offline. 2 ou mais                                          |
| Overdue after (minutes)                                                          | Tempo sem contato depois do qual o dispositivo fica em atraso e um alerta de disponibilidade pode ser gerado. 3 ou mais |
| Get overdue email alerts / Get overdue sms alerts / Get overdue dashboard alerts | Os canais do próprio dispositivo para os alertas de disponibilidade                                                     |

## Páginas relacionadas

* [Checks](https://wiki.datadike.com/pt/sonar/administration/automation/checks.md)
* [Tarefas automatizadas](https://wiki.datadike.com/pt/sonar/administration/automation/automated-tasks.md)
* [Políticas de automação](https://wiki.datadike.com/pt/sonar/administration/automation/automation-policies.md)
* [Notificações por e-mail e SMS](https://wiki.datadike.com/pt/sonar/administration/settings/email-and-sms.md)
* [Webhooks](https://wiki.datadike.com/pt/sonar/administration/settings/webhooks.md)
