Adicionar notificações de email e sistema para eventos de trabalho

  • Artigo

É possível monitorar as execuções de um trabalho e as tarefas que fazem parte desse trabalho configurando notificações quando uma execução inicia, é concluída com êxito, falha ou sua duração excede um limite configurado. As notificações podem ser enviadas para um ou mais endereços de email ou destinos do sistema, como Slack, Microsoft Teams, PagerDuty ou qualquer serviço baseado em webhook.

Configurar as notificações do sistema

Observação

  • Para cada trabalho ou tarefa, você pode configurar no máximo três destinos do sistema para cada tipo de evento de notificação.
  • Um administrador deve configurar os destinos do sistema. Os destinos do sistema são configurados selecionando Criar novo destino na caixa de diálogo Editar notificações do sistema ou na página de configurações de administração.
  • As notificações definidas no nível do trabalho não são enviadas quando as tarefas com falha são repetidas. Para receber uma notificação de falha após cada tarefa com falha (incluindo todas as tentativas com falha), use as notificações de tarefa. Para adicionar notificações do sistema para execuções de tarefas, clique em +Adicionar ao lado de Notificações no painel de tarefas ao adicionar ou editar uma tarefa de trabalho.
  • Um trabalho concluído em um estado Succeeded with failures é considerado em um estado bem-sucedido. Para receber alertas para trabalhos concluídos nesse estado, selecione Êxito ao configurar notificações.

As notificações do sistema se integram a ferramentas de notificação populares, incluindo:

Para adicionar uma ou mais notificações do sistema quando as execuções desse trabalho tiverem um evento notificável, como iniciar, concluir ou falhar um trabalho:

  1. No painel Detalhes do trabalho do seu trabalho, clique em Editar notificações.
  2. Clique em Adicionar Notificação e selecione um destino do sistema em Destino.
  3. Em Selecionar um destino do sistema, selecione um destino e clique na caixa de seleção de cada tipo de notificação a ser enviada a esse destino.
  4. Para adicionar outro destino, clique novamente em Adicionar notificação.
  5. Clique em Confirmar.

Importante

O conteúdo das mensagens do Slack e do Microsoft Teams poderá ser alterado em versões futuras. Você não deve implementar clientes ou processamentos que dependam de conteúdo ou formatação específicos dessas mensagens. Se for necessário um esquema ou uma formatação específica para as notificações, o Azure Databricks recomenda configurar um webhook definido pelo usuário.

Configurar notificações por email

Observação

  • As notificações definidas no nível do trabalho não são enviadas quando as tarefas com falha são repetidas. Para receber uma notificação de falha após cada tarefa com falha (incluindo todas as tentativas com falha), use as notificações de tarefa. Para adicionar notificações por email para execuções de tarefas, clique em +Adicionar ao lado de Notificações no painel de tarefas ao adicionar ou editar uma tarefa de trabalho.
  • Um trabalho concluído em um estado Succeeded with failures é considerado em um estado bem-sucedido. Para receber alertas para trabalhos concluídos nesse estado, selecione Êxito ao configurar notificações.

Para adicionar um ou mais endereços de email a serem notificados quando as execuções desse trabalho começarem, forem concluídas ou falharem:

  1. No painel Detalhes do trabalho do seu trabalho, clique em Editar notificações.
  2. Clique em Adicionar Notificação e selecione Endereço de email em Destino.
  3. Insira um endereço de email e clique na caixa de seleção de cada tipo de notificação para enviar para esse endereço.
  4. Para inserir outro endereço de email para notificação, clique novamente em Adicionar notificação.
  5. Clique em Confirmar.

É possível usar notificações por email para integrar-se a ferramentas como Amazon SES e SNS.

Configurar notificações para trabalhos de execução lenta ou atrasada

Se você tiver configurado uma duração esperada para um trabalho, poderá adicionar uma notificação por email ou pelo sistema se o trabalho exceder a duração configurada. Para receber uma notificação de trabalhos que excedam o limite de duração, clique na caixa de seleção Aviso de duração ao adicionar ou editar uma notificação.

Filtre as notificações de execuções ignoradas ou canceladas

Você pode reduzir o número de notificações enviadas filtrando notificações quando uma execução é ignorada ou cancelada. Para filtrar as notificações, verifique Silenciar notificações de execuções ignoradas ou Silenciar notificações de execuções canceladas ao adicionar ou modificar notificações de email ou notificações do sistema.

Observação

Selecionar Ativar mudo de notificações para execuções ignoradas ou Ativar mudo de notificações para execuções canceladas para um trabalho não filtra as notificações configuradas para tarefas de trabalho. Para filtrar todas as notificações de execuções ignoradas ou canceladas, também é necessário filtrar as notificações no nível da tarefa que você tenha configurado.

Payloads de webhooks HTTP

Se você estiver usando um webhook HTTP para enviar notificações, os exemplos a seguir são payloads enviados pelo Azure Databricks para o seu ponto de extremidade configurado.

Notificação para um evento de início de execução de trabalho:

{
  "event_type": "jobs.on_start",
  "workspace_id": "your_workspace_id",
  "run": {
    "run_id": "run_id"
  },
  "job": {
    "job_id": "job_id",
    "name": "job_name"
  }
}

Notificação para um evento de início de execução de tarefa:

{
  "event_type": "jobs.on_start",
  "workspace_id": "your_workspace_id",
  "task": {
    "task_key": "task_name"
  },
  "run": {
    "run_id": "run_id_of_task"
    "parent_run_id": "run_id_of_parent_job_run"
  },
  "job": {
    "job_id": "job_id",
    "name": "job_name"
  }
}

Ao configurar destinos, os webhooks podem ser configurados para os seguintes tipos de eventos:

Código do evento Quando será enviado?
jobs.on_start Uma execução iniciada.
jobs.on_success Uma execução é interrompida e é concluída com status de sucesso ou bem-sucedida com falhas.
jobs.on_failure Uma execução é interrompida em um estado sem êxito.
jobs.on_duration_warning_threshold_exceeded Uma execução está sendo realizada há mais tempo do que a duração esperada configurada.